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, 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 ensure_echo_area_buffers (void);
778 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
779 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
780 static int with_echo_area_buffer (struct window
*, int,
781 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
782 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
783 static void clear_garbaged_frames (void);
784 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
785 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
786 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
787 static int display_echo_area (struct window
*);
788 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
789 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static Lisp_Object
unwind_redisplay (Lisp_Object
);
791 static int string_char_and_length (const unsigned char *, int *);
792 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
794 static int compute_window_start_on_continuation_line (struct window
*);
795 static Lisp_Object
safe_eval_handler (Lisp_Object
);
796 static void insert_left_trunc_glyphs (struct it
*);
797 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
799 static void extend_face_to_end_of_line (struct it
*);
800 static int append_space_for_newline (struct it
*, int);
801 static int cursor_row_fully_visible_p (struct window
*, int, int);
802 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
803 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
804 static int trailing_whitespace_p (EMACS_INT
);
805 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
,
806 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 (int);
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 int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, 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, 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, 0);
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
, 1);
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, 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, 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
7735 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7736 NEED_Y_P is zero, IT->current_y will be left unchanged.
7738 Further optimization ideas: If we would know that IT->f doesn't use
7739 a face with proportional font, we could be faster for
7740 truncate-lines nil. */
7743 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7746 /* The commented-out optimization uses vmotion on terminals. This
7747 gives bad results, because elements like it->what, on which
7748 callers such as pos_visible_p rely, aren't updated. */
7749 /* struct position pos;
7750 if (!FRAME_WINDOW_P (it->f))
7752 struct text_pos textpos;
7754 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7755 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7756 reseat (it, textpos, 1);
7757 it->vpos += pos.vpos;
7758 it->current_y += pos.vpos;
7764 /* DVPOS == 0 means move to the start of the screen line. */
7765 move_it_vertically_backward (it
, 0);
7766 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7767 /* Let next call to line_bottom_y calculate real line height */
7772 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7773 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7774 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7779 EMACS_INT start_charpos
, i
;
7781 /* Start at the beginning of the screen line containing IT's
7782 position. This may actually move vertically backwards,
7783 in case of overlays, so adjust dvpos accordingly. */
7785 move_it_vertically_backward (it
, 0);
7788 /* Go back -DVPOS visible lines and reseat the iterator there. */
7789 start_charpos
= IT_CHARPOS (*it
);
7790 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7791 back_to_previous_visible_line_start (it
);
7792 reseat (it
, it
->current
.pos
, 1);
7794 /* Move further back if we end up in a string or an image. */
7795 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7797 /* First try to move to start of display line. */
7799 move_it_vertically_backward (it
, 0);
7801 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7803 /* If start of line is still in string or image,
7804 move further back. */
7805 back_to_previous_visible_line_start (it
);
7806 reseat (it
, it
->current
.pos
, 1);
7810 it
->current_x
= it
->hpos
= 0;
7812 /* Above call may have moved too far if continuation lines
7813 are involved. Scan forward and see if it did. */
7815 it2
.vpos
= it2
.current_y
= 0;
7816 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7817 it
->vpos
-= it2
.vpos
;
7818 it
->current_y
-= it2
.current_y
;
7819 it
->current_x
= it
->hpos
= 0;
7821 /* If we moved too far back, move IT some lines forward. */
7822 if (it2
.vpos
> -dvpos
)
7824 int delta
= it2
.vpos
+ dvpos
;
7826 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7827 /* Move back again if we got too far ahead. */
7828 if (IT_CHARPOS (*it
) >= start_charpos
)
7834 /* Return 1 if IT points into the middle of a display vector. */
7837 in_display_vector_p (struct it
*it
)
7839 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7840 && it
->current
.dpvec_index
> 0
7841 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7845 /***********************************************************************
7847 ***********************************************************************/
7850 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7854 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7856 Lisp_Object args
[3];
7857 Lisp_Object msg
, fmt
;
7860 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7863 /* Do nothing if called asynchronously. Inserting text into
7864 a buffer may call after-change-functions and alike and
7865 that would means running Lisp asynchronously. */
7866 if (handling_signal
)
7870 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7872 args
[0] = fmt
= build_string (format
);
7875 msg
= Fformat (3, args
);
7877 len
= SBYTES (msg
) + 1;
7878 SAFE_ALLOCA (buffer
, char *, len
);
7879 memcpy (buffer
, SDATA (msg
), len
);
7881 message_dolog (buffer
, len
- 1, 1, 0);
7888 /* Output a newline in the *Messages* buffer if "needs" one. */
7891 message_log_maybe_newline (void)
7893 if (message_log_need_newline
)
7894 message_dolog ("", 0, 1, 0);
7898 /* Add a string M of length NBYTES to the message log, optionally
7899 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7900 nonzero, means interpret the contents of M as multibyte. This
7901 function calls low-level routines in order to bypass text property
7902 hooks, etc. which might not be safe to run.
7904 This may GC (insert may run before/after change hooks),
7905 so the buffer M must NOT point to a Lisp string. */
7908 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7910 const unsigned char *msg
= (const unsigned char *) m
;
7912 if (!NILP (Vmemory_full
))
7915 if (!NILP (Vmessage_log_max
))
7917 struct buffer
*oldbuf
;
7918 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7919 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7920 EMACS_INT point_at_end
= 0;
7921 EMACS_INT zv_at_end
= 0;
7922 Lisp_Object old_deactivate_mark
, tem
;
7923 struct gcpro gcpro1
;
7925 old_deactivate_mark
= Vdeactivate_mark
;
7926 oldbuf
= current_buffer
;
7927 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7928 BVAR (current_buffer
, undo_list
) = Qt
;
7930 oldpoint
= message_dolog_marker1
;
7931 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7932 oldbegv
= message_dolog_marker2
;
7933 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7934 oldzv
= message_dolog_marker3
;
7935 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7936 GCPRO1 (old_deactivate_mark
);
7944 BEGV_BYTE
= BEG_BYTE
;
7947 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7949 /* Insert the string--maybe converting multibyte to single byte
7950 or vice versa, so that all the text fits the buffer. */
7952 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7958 /* Convert a multibyte string to single-byte
7959 for the *Message* buffer. */
7960 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7962 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7963 work
[0] = (ASCII_CHAR_P (c
)
7965 : multibyte_char_to_unibyte (c
));
7966 insert_1_both (work
, 1, 1, 1, 0, 0);
7969 else if (! multibyte
7970 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7974 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7975 /* Convert a single-byte string to multibyte
7976 for the *Message* buffer. */
7977 for (i
= 0; i
< nbytes
; i
++)
7980 MAKE_CHAR_MULTIBYTE (c
);
7981 char_bytes
= CHAR_STRING (c
, str
);
7982 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7986 insert_1 (m
, nbytes
, 1, 0, 0);
7990 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7991 unsigned long int dups
;
7992 insert_1 ("\n", 1, 1, 0, 0);
7994 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7996 this_bol_byte
= PT_BYTE
;
7998 /* See if this line duplicates the previous one.
7999 If so, combine duplicates. */
8002 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8004 prev_bol_byte
= PT_BYTE
;
8006 dups
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8007 this_bol
, this_bol_byte
);
8010 del_range_both (prev_bol
, prev_bol_byte
,
8011 this_bol
, this_bol_byte
, 0);
8017 /* If you change this format, don't forget to also
8018 change message_log_check_duplicate. */
8019 sprintf (dupstr
, " [%lu times]", dups
);
8020 duplen
= strlen (dupstr
);
8021 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8022 insert_1 (dupstr
, duplen
, 1, 0, 1);
8027 /* If we have more than the desired maximum number of lines
8028 in the *Messages* buffer now, delete the oldest ones.
8029 This is safe because we don't have undo in this buffer. */
8031 if (NATNUMP (Vmessage_log_max
))
8033 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8034 -XFASTINT (Vmessage_log_max
) - 1, 0);
8035 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8038 BEGV
= XMARKER (oldbegv
)->charpos
;
8039 BEGV_BYTE
= marker_byte_position (oldbegv
);
8048 ZV
= XMARKER (oldzv
)->charpos
;
8049 ZV_BYTE
= marker_byte_position (oldzv
);
8053 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8055 /* We can't do Fgoto_char (oldpoint) because it will run some
8057 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8058 XMARKER (oldpoint
)->bytepos
);
8061 unchain_marker (XMARKER (oldpoint
));
8062 unchain_marker (XMARKER (oldbegv
));
8063 unchain_marker (XMARKER (oldzv
));
8065 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8066 set_buffer_internal (oldbuf
);
8068 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8069 message_log_need_newline
= !nlflag
;
8070 Vdeactivate_mark
= old_deactivate_mark
;
8075 /* We are at the end of the buffer after just having inserted a newline.
8076 (Note: We depend on the fact we won't be crossing the gap.)
8077 Check to see if the most recent message looks a lot like the previous one.
8078 Return 0 if different, 1 if the new one should just replace it, or a
8079 value N > 1 if we should also append " [N times]". */
8081 static unsigned long int
8082 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8083 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8086 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8088 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8089 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8091 for (i
= 0; i
< len
; i
++)
8093 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8101 if (*p1
++ == ' ' && *p1
++ == '[')
8104 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8105 if (strncmp (pend
, " times]\n", 8) == 0)
8112 /* Display an echo area message M with a specified length of NBYTES
8113 bytes. The string may include null characters. If M is 0, clear
8114 out any existing message, and let the mini-buffer text show
8117 This may GC, so the buffer M must NOT point to a Lisp string. */
8120 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8122 /* First flush out any partial line written with print. */
8123 message_log_maybe_newline ();
8125 message_dolog (m
, nbytes
, 1, multibyte
);
8126 message2_nolog (m
, nbytes
, multibyte
);
8130 /* The non-logging counterpart of message2. */
8133 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8135 struct frame
*sf
= SELECTED_FRAME ();
8136 message_enable_multibyte
= multibyte
;
8138 if (FRAME_INITIAL_P (sf
))
8140 if (noninteractive_need_newline
)
8141 putc ('\n', stderr
);
8142 noninteractive_need_newline
= 0;
8144 fwrite (m
, nbytes
, 1, stderr
);
8145 if (cursor_in_echo_area
== 0)
8146 fprintf (stderr
, "\n");
8149 /* A null message buffer means that the frame hasn't really been
8150 initialized yet. Error messages get reported properly by
8151 cmd_error, so this must be just an informative message; toss it. */
8152 else if (INTERACTIVE
8153 && sf
->glyphs_initialized_p
8154 && FRAME_MESSAGE_BUF (sf
))
8156 Lisp_Object mini_window
;
8159 /* Get the frame containing the mini-buffer
8160 that the selected frame is using. */
8161 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8162 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8164 FRAME_SAMPLE_VISIBILITY (f
);
8165 if (FRAME_VISIBLE_P (sf
)
8166 && ! FRAME_VISIBLE_P (f
))
8167 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8171 set_message (m
, Qnil
, nbytes
, multibyte
);
8172 if (minibuffer_auto_raise
)
8173 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8176 clear_message (1, 1);
8178 do_pending_window_change (0);
8179 echo_area_display (1);
8180 do_pending_window_change (0);
8181 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8182 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8187 /* Display an echo area message M with a specified length of NBYTES
8188 bytes. The string may include null characters. If M is not a
8189 string, clear out any existing message, and let the mini-buffer
8192 This function cancels echoing. */
8195 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8197 struct gcpro gcpro1
;
8200 clear_message (1,1);
8203 /* First flush out any partial line written with print. */
8204 message_log_maybe_newline ();
8210 SAFE_ALLOCA (buffer
, char *, nbytes
);
8211 memcpy (buffer
, SDATA (m
), nbytes
);
8212 message_dolog (buffer
, nbytes
, 1, multibyte
);
8215 message3_nolog (m
, nbytes
, multibyte
);
8221 /* The non-logging version of message3.
8222 This does not cancel echoing, because it is used for echoing.
8223 Perhaps we need to make a separate function for echoing
8224 and make this cancel echoing. */
8227 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8229 struct frame
*sf
= SELECTED_FRAME ();
8230 message_enable_multibyte
= multibyte
;
8232 if (FRAME_INITIAL_P (sf
))
8234 if (noninteractive_need_newline
)
8235 putc ('\n', stderr
);
8236 noninteractive_need_newline
= 0;
8238 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8239 if (cursor_in_echo_area
== 0)
8240 fprintf (stderr
, "\n");
8243 /* A null message buffer means that the frame hasn't really been
8244 initialized yet. Error messages get reported properly by
8245 cmd_error, so this must be just an informative message; toss it. */
8246 else if (INTERACTIVE
8247 && sf
->glyphs_initialized_p
8248 && FRAME_MESSAGE_BUF (sf
))
8250 Lisp_Object mini_window
;
8254 /* Get the frame containing the mini-buffer
8255 that the selected frame is using. */
8256 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8257 frame
= XWINDOW (mini_window
)->frame
;
8260 FRAME_SAMPLE_VISIBILITY (f
);
8261 if (FRAME_VISIBLE_P (sf
)
8262 && !FRAME_VISIBLE_P (f
))
8263 Fmake_frame_visible (frame
);
8265 if (STRINGP (m
) && SCHARS (m
) > 0)
8267 set_message (NULL
, m
, nbytes
, multibyte
);
8268 if (minibuffer_auto_raise
)
8269 Fraise_frame (frame
);
8270 /* Assume we are not echoing.
8271 (If we are, echo_now will override this.) */
8272 echo_message_buffer
= Qnil
;
8275 clear_message (1, 1);
8277 do_pending_window_change (0);
8278 echo_area_display (1);
8279 do_pending_window_change (0);
8280 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8281 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8286 /* Display a null-terminated echo area message M. If M is 0, clear
8287 out any existing message, and let the mini-buffer text show through.
8289 The buffer M must continue to exist until after the echo area gets
8290 cleared or some other message gets displayed there. Do not pass
8291 text that is stored in a Lisp string. Do not pass text in a buffer
8292 that was alloca'd. */
8295 message1 (const char *m
)
8297 message2 (m
, (m
? strlen (m
) : 0), 0);
8301 /* The non-logging counterpart of message1. */
8304 message1_nolog (const char *m
)
8306 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8309 /* Display a message M which contains a single %s
8310 which gets replaced with STRING. */
8313 message_with_string (const char *m
, Lisp_Object string
, int log
)
8315 CHECK_STRING (string
);
8321 if (noninteractive_need_newline
)
8322 putc ('\n', stderr
);
8323 noninteractive_need_newline
= 0;
8324 fprintf (stderr
, m
, SDATA (string
));
8325 if (!cursor_in_echo_area
)
8326 fprintf (stderr
, "\n");
8330 else if (INTERACTIVE
)
8332 /* The frame whose minibuffer we're going to display the message on.
8333 It may be larger than the selected frame, so we need
8334 to use its buffer, not the selected frame's buffer. */
8335 Lisp_Object mini_window
;
8336 struct frame
*f
, *sf
= SELECTED_FRAME ();
8338 /* Get the frame containing the minibuffer
8339 that the selected frame is using. */
8340 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8341 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8343 /* A null message buffer means that the frame hasn't really been
8344 initialized yet. Error messages get reported properly by
8345 cmd_error, so this must be just an informative message; toss it. */
8346 if (FRAME_MESSAGE_BUF (f
))
8348 Lisp_Object args
[2], msg
;
8349 struct gcpro gcpro1
, gcpro2
;
8351 args
[0] = build_string (m
);
8352 args
[1] = msg
= string
;
8353 GCPRO2 (args
[0], msg
);
8356 msg
= Fformat (2, args
);
8359 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8361 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8365 /* Print should start at the beginning of the message
8366 buffer next time. */
8367 message_buf_print
= 0;
8373 /* Dump an informative message to the minibuf. If M is 0, clear out
8374 any existing message, and let the mini-buffer text show through. */
8377 vmessage (const char *m
, va_list ap
)
8383 if (noninteractive_need_newline
)
8384 putc ('\n', stderr
);
8385 noninteractive_need_newline
= 0;
8386 vfprintf (stderr
, m
, ap
);
8387 if (cursor_in_echo_area
== 0)
8388 fprintf (stderr
, "\n");
8392 else if (INTERACTIVE
)
8394 /* The frame whose mini-buffer we're going to display the message
8395 on. It may be larger than the selected frame, so we need to
8396 use its buffer, not the selected frame's buffer. */
8397 Lisp_Object mini_window
;
8398 struct frame
*f
, *sf
= SELECTED_FRAME ();
8400 /* Get the frame containing the mini-buffer
8401 that the selected frame is using. */
8402 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8403 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8405 /* A null message buffer means that the frame hasn't really been
8406 initialized yet. Error messages get reported properly by
8407 cmd_error, so this must be just an informative message; toss
8409 if (FRAME_MESSAGE_BUF (f
))
8415 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8416 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8418 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8423 /* Print should start at the beginning of the message
8424 buffer next time. */
8425 message_buf_print
= 0;
8431 message (const char *m
, ...)
8440 /* The non-logging version of message. */
8443 message_nolog (const char *m
, ...)
8445 Lisp_Object old_log_max
;
8448 old_log_max
= Vmessage_log_max
;
8449 Vmessage_log_max
= Qnil
;
8451 Vmessage_log_max
= old_log_max
;
8456 /* Display the current message in the current mini-buffer. This is
8457 only called from error handlers in process.c, and is not time
8461 update_echo_area (void)
8463 if (!NILP (echo_area_buffer
[0]))
8466 string
= Fcurrent_message ();
8467 message3 (string
, SBYTES (string
),
8468 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8473 /* Make sure echo area buffers in `echo_buffers' are live.
8474 If they aren't, make new ones. */
8477 ensure_echo_area_buffers (void)
8481 for (i
= 0; i
< 2; ++i
)
8482 if (!BUFFERP (echo_buffer
[i
])
8483 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8486 Lisp_Object old_buffer
;
8489 old_buffer
= echo_buffer
[i
];
8490 sprintf (name
, " *Echo Area %d*", i
);
8491 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8492 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8493 /* to force word wrap in echo area -
8494 it was decided to postpone this*/
8495 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8497 for (j
= 0; j
< 2; ++j
)
8498 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8499 echo_area_buffer
[j
] = echo_buffer
[i
];
8504 /* Call FN with args A1..A4 with either the current or last displayed
8505 echo_area_buffer as current buffer.
8507 WHICH zero means use the current message buffer
8508 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8509 from echo_buffer[] and clear it.
8511 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8512 suitable buffer from echo_buffer[] and clear it.
8514 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8515 that the current message becomes the last displayed one, make
8516 choose a suitable buffer for echo_area_buffer[0], and clear it.
8518 Value is what FN returns. */
8521 with_echo_area_buffer (struct window
*w
, int which
,
8522 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8523 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8526 int this_one
, the_other
, clear_buffer_p
, rc
;
8527 int count
= SPECPDL_INDEX ();
8529 /* If buffers aren't live, make new ones. */
8530 ensure_echo_area_buffers ();
8535 this_one
= 0, the_other
= 1;
8537 this_one
= 1, the_other
= 0;
8540 this_one
= 0, the_other
= 1;
8543 /* We need a fresh one in case the current echo buffer equals
8544 the one containing the last displayed echo area message. */
8545 if (!NILP (echo_area_buffer
[this_one
])
8546 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8547 echo_area_buffer
[this_one
] = Qnil
;
8550 /* Choose a suitable buffer from echo_buffer[] is we don't
8552 if (NILP (echo_area_buffer
[this_one
]))
8554 echo_area_buffer
[this_one
]
8555 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8556 ? echo_buffer
[the_other
]
8557 : echo_buffer
[this_one
]);
8561 buffer
= echo_area_buffer
[this_one
];
8563 /* Don't get confused by reusing the buffer used for echoing
8564 for a different purpose. */
8565 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8568 record_unwind_protect (unwind_with_echo_area_buffer
,
8569 with_echo_area_buffer_unwind_data (w
));
8571 /* Make the echo area buffer current. Note that for display
8572 purposes, it is not necessary that the displayed window's buffer
8573 == current_buffer, except for text property lookup. So, let's
8574 only set that buffer temporarily here without doing a full
8575 Fset_window_buffer. We must also change w->pointm, though,
8576 because otherwise an assertions in unshow_buffer fails, and Emacs
8578 set_buffer_internal_1 (XBUFFER (buffer
));
8582 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8585 BVAR (current_buffer
, undo_list
) = Qt
;
8586 BVAR (current_buffer
, read_only
) = Qnil
;
8587 specbind (Qinhibit_read_only
, Qt
);
8588 specbind (Qinhibit_modification_hooks
, Qt
);
8590 if (clear_buffer_p
&& Z
> BEG
)
8593 xassert (BEGV
>= BEG
);
8594 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8596 rc
= fn (a1
, a2
, a3
, a4
);
8598 xassert (BEGV
>= BEG
);
8599 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8601 unbind_to (count
, Qnil
);
8606 /* Save state that should be preserved around the call to the function
8607 FN called in with_echo_area_buffer. */
8610 with_echo_area_buffer_unwind_data (struct window
*w
)
8613 Lisp_Object vector
, tmp
;
8615 /* Reduce consing by keeping one vector in
8616 Vwith_echo_area_save_vector. */
8617 vector
= Vwith_echo_area_save_vector
;
8618 Vwith_echo_area_save_vector
= Qnil
;
8621 vector
= Fmake_vector (make_number (7), Qnil
);
8623 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8624 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8625 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8629 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8630 ASET (vector
, i
, w
->buffer
); ++i
;
8631 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8632 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8637 for (; i
< end
; ++i
)
8638 ASET (vector
, i
, Qnil
);
8641 xassert (i
== ASIZE (vector
));
8646 /* Restore global state from VECTOR which was created by
8647 with_echo_area_buffer_unwind_data. */
8650 unwind_with_echo_area_buffer (Lisp_Object vector
)
8652 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8653 Vdeactivate_mark
= AREF (vector
, 1);
8654 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8656 if (WINDOWP (AREF (vector
, 3)))
8659 Lisp_Object buffer
, charpos
, bytepos
;
8661 w
= XWINDOW (AREF (vector
, 3));
8662 buffer
= AREF (vector
, 4);
8663 charpos
= AREF (vector
, 5);
8664 bytepos
= AREF (vector
, 6);
8667 set_marker_both (w
->pointm
, buffer
,
8668 XFASTINT (charpos
), XFASTINT (bytepos
));
8671 Vwith_echo_area_save_vector
= vector
;
8676 /* Set up the echo area for use by print functions. MULTIBYTE_P
8677 non-zero means we will print multibyte. */
8680 setup_echo_area_for_printing (int multibyte_p
)
8682 /* If we can't find an echo area any more, exit. */
8683 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8686 ensure_echo_area_buffers ();
8688 if (!message_buf_print
)
8690 /* A message has been output since the last time we printed.
8691 Choose a fresh echo area buffer. */
8692 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8693 echo_area_buffer
[0] = echo_buffer
[1];
8695 echo_area_buffer
[0] = echo_buffer
[0];
8697 /* Switch to that buffer and clear it. */
8698 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8699 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8703 int count
= SPECPDL_INDEX ();
8704 specbind (Qinhibit_read_only
, Qt
);
8705 /* Note that undo recording is always disabled. */
8707 unbind_to (count
, Qnil
);
8709 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8711 /* Set up the buffer for the multibyteness we need. */
8713 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8714 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8716 /* Raise the frame containing the echo area. */
8717 if (minibuffer_auto_raise
)
8719 struct frame
*sf
= SELECTED_FRAME ();
8720 Lisp_Object mini_window
;
8721 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8722 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8725 message_log_maybe_newline ();
8726 message_buf_print
= 1;
8730 if (NILP (echo_area_buffer
[0]))
8732 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8733 echo_area_buffer
[0] = echo_buffer
[1];
8735 echo_area_buffer
[0] = echo_buffer
[0];
8738 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8740 /* Someone switched buffers between print requests. */
8741 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8742 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8748 /* Display an echo area message in window W. Value is non-zero if W's
8749 height is changed. If display_last_displayed_message_p is
8750 non-zero, display the message that was last displayed, otherwise
8751 display the current message. */
8754 display_echo_area (struct window
*w
)
8756 int i
, no_message_p
, window_height_changed_p
, count
;
8758 /* Temporarily disable garbage collections while displaying the echo
8759 area. This is done because a GC can print a message itself.
8760 That message would modify the echo area buffer's contents while a
8761 redisplay of the buffer is going on, and seriously confuse
8763 count
= inhibit_garbage_collection ();
8765 /* If there is no message, we must call display_echo_area_1
8766 nevertheless because it resizes the window. But we will have to
8767 reset the echo_area_buffer in question to nil at the end because
8768 with_echo_area_buffer will sets it to an empty buffer. */
8769 i
= display_last_displayed_message_p
? 1 : 0;
8770 no_message_p
= NILP (echo_area_buffer
[i
]);
8772 window_height_changed_p
8773 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8774 display_echo_area_1
,
8775 (EMACS_INT
) w
, Qnil
, 0, 0);
8778 echo_area_buffer
[i
] = Qnil
;
8780 unbind_to (count
, Qnil
);
8781 return window_height_changed_p
;
8785 /* Helper for display_echo_area. Display the current buffer which
8786 contains the current echo area message in window W, a mini-window,
8787 a pointer to which is passed in A1. A2..A4 are currently not used.
8788 Change the height of W so that all of the message is displayed.
8789 Value is non-zero if height of W was changed. */
8792 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8794 struct window
*w
= (struct window
*) a1
;
8796 struct text_pos start
;
8797 int window_height_changed_p
= 0;
8799 /* Do this before displaying, so that we have a large enough glyph
8800 matrix for the display. If we can't get enough space for the
8801 whole text, display the last N lines. That works by setting w->start. */
8802 window_height_changed_p
= resize_mini_window (w
, 0);
8804 /* Use the starting position chosen by resize_mini_window. */
8805 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8808 clear_glyph_matrix (w
->desired_matrix
);
8809 XSETWINDOW (window
, w
);
8810 try_window (window
, start
, 0);
8812 return window_height_changed_p
;
8816 /* Resize the echo area window to exactly the size needed for the
8817 currently displayed message, if there is one. If a mini-buffer
8818 is active, don't shrink it. */
8821 resize_echo_area_exactly (void)
8823 if (BUFFERP (echo_area_buffer
[0])
8824 && WINDOWP (echo_area_window
))
8826 struct window
*w
= XWINDOW (echo_area_window
);
8828 Lisp_Object resize_exactly
;
8830 if (minibuf_level
== 0)
8831 resize_exactly
= Qt
;
8833 resize_exactly
= Qnil
;
8835 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8836 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8839 ++windows_or_buffers_changed
;
8840 ++update_mode_lines
;
8841 redisplay_internal (0);
8847 /* Callback function for with_echo_area_buffer, when used from
8848 resize_echo_area_exactly. A1 contains a pointer to the window to
8849 resize, EXACTLY non-nil means resize the mini-window exactly to the
8850 size of the text displayed. A3 and A4 are not used. Value is what
8851 resize_mini_window returns. */
8854 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8856 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8860 /* Resize mini-window W to fit the size of its contents. EXACT_P
8861 means size the window exactly to the size needed. Otherwise, it's
8862 only enlarged until W's buffer is empty.
8864 Set W->start to the right place to begin display. If the whole
8865 contents fit, start at the beginning. Otherwise, start so as
8866 to make the end of the contents appear. This is particularly
8867 important for y-or-n-p, but seems desirable generally.
8869 Value is non-zero if the window height has been changed. */
8872 resize_mini_window (struct window
*w
, int exact_p
)
8874 struct frame
*f
= XFRAME (w
->frame
);
8875 int window_height_changed_p
= 0;
8877 xassert (MINI_WINDOW_P (w
));
8879 /* By default, start display at the beginning. */
8880 set_marker_both (w
->start
, w
->buffer
,
8881 BUF_BEGV (XBUFFER (w
->buffer
)),
8882 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8884 /* Don't resize windows while redisplaying a window; it would
8885 confuse redisplay functions when the size of the window they are
8886 displaying changes from under them. Such a resizing can happen,
8887 for instance, when which-func prints a long message while
8888 we are running fontification-functions. We're running these
8889 functions with safe_call which binds inhibit-redisplay to t. */
8890 if (!NILP (Vinhibit_redisplay
))
8893 /* Nil means don't try to resize. */
8894 if (NILP (Vresize_mini_windows
)
8895 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8898 if (!FRAME_MINIBUF_ONLY_P (f
))
8901 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8902 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8903 int height
, max_height
;
8904 int unit
= FRAME_LINE_HEIGHT (f
);
8905 struct text_pos start
;
8906 struct buffer
*old_current_buffer
= NULL
;
8908 if (current_buffer
!= XBUFFER (w
->buffer
))
8910 old_current_buffer
= current_buffer
;
8911 set_buffer_internal (XBUFFER (w
->buffer
));
8914 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8916 /* Compute the max. number of lines specified by the user. */
8917 if (FLOATP (Vmax_mini_window_height
))
8918 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8919 else if (INTEGERP (Vmax_mini_window_height
))
8920 max_height
= XINT (Vmax_mini_window_height
);
8922 max_height
= total_height
/ 4;
8924 /* Correct that max. height if it's bogus. */
8925 max_height
= max (1, max_height
);
8926 max_height
= min (total_height
, max_height
);
8928 /* Find out the height of the text in the window. */
8929 if (it
.line_wrap
== TRUNCATE
)
8934 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8935 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8936 height
= it
.current_y
+ last_height
;
8938 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8939 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8940 height
= (height
+ unit
- 1) / unit
;
8943 /* Compute a suitable window start. */
8944 if (height
> max_height
)
8946 height
= max_height
;
8947 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8948 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8949 start
= it
.current
.pos
;
8952 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8953 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8955 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8957 /* Let it grow only, until we display an empty message, in which
8958 case the window shrinks again. */
8959 if (height
> WINDOW_TOTAL_LINES (w
))
8961 int old_height
= WINDOW_TOTAL_LINES (w
);
8962 freeze_window_starts (f
, 1);
8963 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8964 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8966 else if (height
< WINDOW_TOTAL_LINES (w
)
8967 && (exact_p
|| BEGV
== ZV
))
8969 int old_height
= WINDOW_TOTAL_LINES (w
);
8970 freeze_window_starts (f
, 0);
8971 shrink_mini_window (w
);
8972 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8977 /* Always resize to exact size needed. */
8978 if (height
> WINDOW_TOTAL_LINES (w
))
8980 int old_height
= WINDOW_TOTAL_LINES (w
);
8981 freeze_window_starts (f
, 1);
8982 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8983 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8985 else if (height
< WINDOW_TOTAL_LINES (w
))
8987 int old_height
= WINDOW_TOTAL_LINES (w
);
8988 freeze_window_starts (f
, 0);
8989 shrink_mini_window (w
);
8993 freeze_window_starts (f
, 1);
8994 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8997 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9001 if (old_current_buffer
)
9002 set_buffer_internal (old_current_buffer
);
9005 return window_height_changed_p
;
9009 /* Value is the current message, a string, or nil if there is no
9013 current_message (void)
9017 if (!BUFFERP (echo_area_buffer
[0]))
9021 with_echo_area_buffer (0, 0, current_message_1
,
9022 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9024 echo_area_buffer
[0] = Qnil
;
9032 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9034 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9037 *msg
= make_buffer_string (BEG
, Z
, 1);
9044 /* Push the current message on Vmessage_stack for later restauration
9045 by restore_message. Value is non-zero if the current message isn't
9046 empty. This is a relatively infrequent operation, so it's not
9047 worth optimizing. */
9053 msg
= current_message ();
9054 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9055 return STRINGP (msg
);
9059 /* Restore message display from the top of Vmessage_stack. */
9062 restore_message (void)
9066 xassert (CONSP (Vmessage_stack
));
9067 msg
= XCAR (Vmessage_stack
);
9069 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9071 message3_nolog (msg
, 0, 0);
9075 /* Handler for record_unwind_protect calling pop_message. */
9078 pop_message_unwind (Lisp_Object dummy
)
9084 /* Pop the top-most entry off Vmessage_stack. */
9089 xassert (CONSP (Vmessage_stack
));
9090 Vmessage_stack
= XCDR (Vmessage_stack
);
9094 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9095 exits. If the stack is not empty, we have a missing pop_message
9099 check_message_stack (void)
9101 if (!NILP (Vmessage_stack
))
9106 /* Truncate to NCHARS what will be displayed in the echo area the next
9107 time we display it---but don't redisplay it now. */
9110 truncate_echo_area (EMACS_INT nchars
)
9113 echo_area_buffer
[0] = Qnil
;
9114 /* A null message buffer means that the frame hasn't really been
9115 initialized yet. Error messages get reported properly by
9116 cmd_error, so this must be just an informative message; toss it. */
9117 else if (!noninteractive
9119 && !NILP (echo_area_buffer
[0]))
9121 struct frame
*sf
= SELECTED_FRAME ();
9122 if (FRAME_MESSAGE_BUF (sf
))
9123 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9128 /* Helper function for truncate_echo_area. Truncate the current
9129 message to at most NCHARS characters. */
9132 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9134 if (BEG
+ nchars
< Z
)
9135 del_range (BEG
+ nchars
, Z
);
9137 echo_area_buffer
[0] = Qnil
;
9142 /* Set the current message to a substring of S or STRING.
9144 If STRING is a Lisp string, set the message to the first NBYTES
9145 bytes from STRING. NBYTES zero means use the whole string. If
9146 STRING is multibyte, the message will be displayed multibyte.
9148 If S is not null, set the message to the first LEN bytes of S. LEN
9149 zero means use the whole string. MULTIBYTE_P non-zero means S is
9150 multibyte. Display the message multibyte in that case.
9152 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9153 to t before calling set_message_1 (which calls insert).
9157 set_message (const char *s
, Lisp_Object string
,
9158 EMACS_INT nbytes
, int multibyte_p
)
9160 message_enable_multibyte
9161 = ((s
&& multibyte_p
)
9162 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9164 with_echo_area_buffer (0, -1, set_message_1
,
9165 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9166 message_buf_print
= 0;
9167 help_echo_showing_p
= 0;
9171 /* Helper function for set_message. Arguments have the same meaning
9172 as there, with A1 corresponding to S and A2 corresponding to STRING
9173 This function is called with the echo area buffer being
9177 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9179 const char *s
= (const char *) a1
;
9180 const unsigned char *msg
= (const unsigned char *) s
;
9181 Lisp_Object string
= a2
;
9183 /* Change multibyteness of the echo buffer appropriately. */
9184 if (message_enable_multibyte
9185 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9186 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9188 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9189 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9190 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9192 /* Insert new message at BEG. */
9193 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9195 if (STRINGP (string
))
9200 nbytes
= SBYTES (string
);
9201 nchars
= string_byte_to_char (string
, nbytes
);
9203 /* This function takes care of single/multibyte conversion. We
9204 just have to ensure that the echo area buffer has the right
9205 setting of enable_multibyte_characters. */
9206 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9211 nbytes
= strlen (s
);
9213 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9215 /* Convert from multi-byte to single-byte. */
9220 /* Convert a multibyte string to single-byte. */
9221 for (i
= 0; i
< nbytes
; i
+= n
)
9223 c
= string_char_and_length (msg
+ i
, &n
);
9224 work
[0] = (ASCII_CHAR_P (c
)
9226 : multibyte_char_to_unibyte (c
));
9227 insert_1_both (work
, 1, 1, 1, 0, 0);
9230 else if (!multibyte_p
9231 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9233 /* Convert from single-byte to multi-byte. */
9236 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9238 /* Convert a single-byte string to multibyte. */
9239 for (i
= 0; i
< nbytes
; i
++)
9242 MAKE_CHAR_MULTIBYTE (c
);
9243 n
= CHAR_STRING (c
, str
);
9244 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9248 insert_1 (s
, nbytes
, 1, 0, 0);
9255 /* Clear messages. CURRENT_P non-zero means clear the current
9256 message. LAST_DISPLAYED_P non-zero means clear the message
9260 clear_message (int current_p
, int last_displayed_p
)
9264 echo_area_buffer
[0] = Qnil
;
9265 message_cleared_p
= 1;
9268 if (last_displayed_p
)
9269 echo_area_buffer
[1] = Qnil
;
9271 message_buf_print
= 0;
9274 /* Clear garbaged frames.
9276 This function is used where the old redisplay called
9277 redraw_garbaged_frames which in turn called redraw_frame which in
9278 turn called clear_frame. The call to clear_frame was a source of
9279 flickering. I believe a clear_frame is not necessary. It should
9280 suffice in the new redisplay to invalidate all current matrices,
9281 and ensure a complete redisplay of all windows. */
9284 clear_garbaged_frames (void)
9288 Lisp_Object tail
, frame
;
9289 int changed_count
= 0;
9291 FOR_EACH_FRAME (tail
, frame
)
9293 struct frame
*f
= XFRAME (frame
);
9295 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9299 Fredraw_frame (frame
);
9300 f
->force_flush_display_p
= 1;
9302 clear_current_matrices (f
);
9311 ++windows_or_buffers_changed
;
9316 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9317 is non-zero update selected_frame. Value is non-zero if the
9318 mini-windows height has been changed. */
9321 echo_area_display (int update_frame_p
)
9323 Lisp_Object mini_window
;
9326 int window_height_changed_p
= 0;
9327 struct frame
*sf
= SELECTED_FRAME ();
9329 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9330 w
= XWINDOW (mini_window
);
9331 f
= XFRAME (WINDOW_FRAME (w
));
9333 /* Don't display if frame is invisible or not yet initialized. */
9334 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9337 #ifdef HAVE_WINDOW_SYSTEM
9338 /* When Emacs starts, selected_frame may be the initial terminal
9339 frame. If we let this through, a message would be displayed on
9341 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9343 #endif /* HAVE_WINDOW_SYSTEM */
9345 /* Redraw garbaged frames. */
9347 clear_garbaged_frames ();
9349 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9351 echo_area_window
= mini_window
;
9352 window_height_changed_p
= display_echo_area (w
);
9353 w
->must_be_updated_p
= 1;
9355 /* Update the display, unless called from redisplay_internal.
9356 Also don't update the screen during redisplay itself. The
9357 update will happen at the end of redisplay, and an update
9358 here could cause confusion. */
9359 if (update_frame_p
&& !redisplaying_p
)
9363 /* If the display update has been interrupted by pending
9364 input, update mode lines in the frame. Due to the
9365 pending input, it might have been that redisplay hasn't
9366 been called, so that mode lines above the echo area are
9367 garbaged. This looks odd, so we prevent it here. */
9368 if (!display_completed
)
9369 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9371 if (window_height_changed_p
9372 /* Don't do this if Emacs is shutting down. Redisplay
9373 needs to run hooks. */
9374 && !NILP (Vrun_hooks
))
9376 /* Must update other windows. Likewise as in other
9377 cases, don't let this update be interrupted by
9379 int count
= SPECPDL_INDEX ();
9380 specbind (Qredisplay_dont_pause
, Qt
);
9381 windows_or_buffers_changed
= 1;
9382 redisplay_internal (0);
9383 unbind_to (count
, Qnil
);
9385 else if (FRAME_WINDOW_P (f
) && n
== 0)
9387 /* Window configuration is the same as before.
9388 Can do with a display update of the echo area,
9389 unless we displayed some mode lines. */
9390 update_single_window (w
, 1);
9391 FRAME_RIF (f
)->flush_display (f
);
9394 update_frame (f
, 1, 1);
9396 /* If cursor is in the echo area, make sure that the next
9397 redisplay displays the minibuffer, so that the cursor will
9398 be replaced with what the minibuffer wants. */
9399 if (cursor_in_echo_area
)
9400 ++windows_or_buffers_changed
;
9403 else if (!EQ (mini_window
, selected_window
))
9404 windows_or_buffers_changed
++;
9406 /* Last displayed message is now the current message. */
9407 echo_area_buffer
[1] = echo_area_buffer
[0];
9408 /* Inform read_char that we're not echoing. */
9409 echo_message_buffer
= Qnil
;
9411 /* Prevent redisplay optimization in redisplay_internal by resetting
9412 this_line_start_pos. This is done because the mini-buffer now
9413 displays the message instead of its buffer text. */
9414 if (EQ (mini_window
, selected_window
))
9415 CHARPOS (this_line_start_pos
) = 0;
9417 return window_height_changed_p
;
9422 /***********************************************************************
9423 Mode Lines and Frame Titles
9424 ***********************************************************************/
9426 /* A buffer for constructing non-propertized mode-line strings and
9427 frame titles in it; allocated from the heap in init_xdisp and
9428 resized as needed in store_mode_line_noprop_char. */
9430 static char *mode_line_noprop_buf
;
9432 /* The buffer's end, and a current output position in it. */
9434 static char *mode_line_noprop_buf_end
;
9435 static char *mode_line_noprop_ptr
;
9437 #define MODE_LINE_NOPROP_LEN(start) \
9438 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9441 MODE_LINE_DISPLAY
= 0,
9447 /* Alist that caches the results of :propertize.
9448 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9449 static Lisp_Object mode_line_proptrans_alist
;
9451 /* List of strings making up the mode-line. */
9452 static Lisp_Object mode_line_string_list
;
9454 /* Base face property when building propertized mode line string. */
9455 static Lisp_Object mode_line_string_face
;
9456 static Lisp_Object mode_line_string_face_prop
;
9459 /* Unwind data for mode line strings */
9461 static Lisp_Object Vmode_line_unwind_vector
;
9464 format_mode_line_unwind_data (struct buffer
*obuf
,
9468 Lisp_Object vector
, tmp
;
9470 /* Reduce consing by keeping one vector in
9471 Vwith_echo_area_save_vector. */
9472 vector
= Vmode_line_unwind_vector
;
9473 Vmode_line_unwind_vector
= Qnil
;
9476 vector
= Fmake_vector (make_number (8), Qnil
);
9478 ASET (vector
, 0, make_number (mode_line_target
));
9479 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9480 ASET (vector
, 2, mode_line_string_list
);
9481 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9482 ASET (vector
, 4, mode_line_string_face
);
9483 ASET (vector
, 5, mode_line_string_face_prop
);
9486 XSETBUFFER (tmp
, obuf
);
9489 ASET (vector
, 6, tmp
);
9490 ASET (vector
, 7, owin
);
9496 unwind_format_mode_line (Lisp_Object vector
)
9498 mode_line_target
= XINT (AREF (vector
, 0));
9499 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9500 mode_line_string_list
= AREF (vector
, 2);
9501 if (! EQ (AREF (vector
, 3), Qt
))
9502 mode_line_proptrans_alist
= AREF (vector
, 3);
9503 mode_line_string_face
= AREF (vector
, 4);
9504 mode_line_string_face_prop
= AREF (vector
, 5);
9506 if (!NILP (AREF (vector
, 7)))
9507 /* Select window before buffer, since it may change the buffer. */
9508 Fselect_window (AREF (vector
, 7), Qt
);
9510 if (!NILP (AREF (vector
, 6)))
9512 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9513 ASET (vector
, 6, Qnil
);
9516 Vmode_line_unwind_vector
= vector
;
9521 /* Store a single character C for the frame title in mode_line_noprop_buf.
9522 Re-allocate mode_line_noprop_buf if necessary. */
9525 store_mode_line_noprop_char (char c
)
9527 /* If output position has reached the end of the allocated buffer,
9528 double the buffer's size. */
9529 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9531 int len
= MODE_LINE_NOPROP_LEN (0);
9532 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9533 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9534 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9535 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9538 *mode_line_noprop_ptr
++ = c
;
9542 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9543 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9544 characters that yield more columns than PRECISION; PRECISION <= 0
9545 means copy the whole string. Pad with spaces until FIELD_WIDTH
9546 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9547 pad. Called from display_mode_element when it is used to build a
9551 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9553 const unsigned char *str
= (const unsigned char *) string
;
9555 EMACS_INT dummy
, nbytes
;
9557 /* Copy at most PRECISION chars from STR. */
9558 nbytes
= strlen (string
);
9559 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9561 store_mode_line_noprop_char (*str
++);
9563 /* Fill up with spaces until FIELD_WIDTH reached. */
9564 while (field_width
> 0
9567 store_mode_line_noprop_char (' ');
9574 /***********************************************************************
9576 ***********************************************************************/
9578 #ifdef HAVE_WINDOW_SYSTEM
9580 /* Set the title of FRAME, if it has changed. The title format is
9581 Vicon_title_format if FRAME is iconified, otherwise it is
9582 frame_title_format. */
9585 x_consider_frame_title (Lisp_Object frame
)
9587 struct frame
*f
= XFRAME (frame
);
9589 if (FRAME_WINDOW_P (f
)
9590 || FRAME_MINIBUF_ONLY_P (f
)
9591 || f
->explicit_name
)
9593 /* Do we have more than one visible frame on this X display? */
9600 int count
= SPECPDL_INDEX ();
9602 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9604 Lisp_Object other_frame
= XCAR (tail
);
9605 struct frame
*tf
= XFRAME (other_frame
);
9608 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9609 && !FRAME_MINIBUF_ONLY_P (tf
)
9610 && !EQ (other_frame
, tip_frame
)
9611 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9615 /* Set global variable indicating that multiple frames exist. */
9616 multiple_frames
= CONSP (tail
);
9618 /* Switch to the buffer of selected window of the frame. Set up
9619 mode_line_target so that display_mode_element will output into
9620 mode_line_noprop_buf; then display the title. */
9621 record_unwind_protect (unwind_format_mode_line
,
9622 format_mode_line_unwind_data
9623 (current_buffer
, selected_window
, 0));
9625 Fselect_window (f
->selected_window
, Qt
);
9626 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9627 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9629 mode_line_target
= MODE_LINE_TITLE
;
9630 title_start
= MODE_LINE_NOPROP_LEN (0);
9631 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9632 NULL
, DEFAULT_FACE_ID
);
9633 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9634 len
= MODE_LINE_NOPROP_LEN (title_start
);
9635 title
= mode_line_noprop_buf
+ title_start
;
9636 unbind_to (count
, Qnil
);
9638 /* Set the title only if it's changed. This avoids consing in
9639 the common case where it hasn't. (If it turns out that we've
9640 already wasted too much time by walking through the list with
9641 display_mode_element, then we might need to optimize at a
9642 higher level than this.) */
9643 if (! STRINGP (f
->name
)
9644 || SBYTES (f
->name
) != len
9645 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9646 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9650 #endif /* not HAVE_WINDOW_SYSTEM */
9655 /***********************************************************************
9657 ***********************************************************************/
9660 /* Prepare for redisplay by updating menu-bar item lists when
9661 appropriate. This can call eval. */
9664 prepare_menu_bars (void)
9667 struct gcpro gcpro1
, gcpro2
;
9669 Lisp_Object tooltip_frame
;
9671 #ifdef HAVE_WINDOW_SYSTEM
9672 tooltip_frame
= tip_frame
;
9674 tooltip_frame
= Qnil
;
9677 /* Update all frame titles based on their buffer names, etc. We do
9678 this before the menu bars so that the buffer-menu will show the
9679 up-to-date frame titles. */
9680 #ifdef HAVE_WINDOW_SYSTEM
9681 if (windows_or_buffers_changed
|| update_mode_lines
)
9683 Lisp_Object tail
, frame
;
9685 FOR_EACH_FRAME (tail
, frame
)
9688 if (!EQ (frame
, tooltip_frame
)
9689 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9690 x_consider_frame_title (frame
);
9693 #endif /* HAVE_WINDOW_SYSTEM */
9695 /* Update the menu bar item lists, if appropriate. This has to be
9696 done before any actual redisplay or generation of display lines. */
9697 all_windows
= (update_mode_lines
9698 || buffer_shared
> 1
9699 || windows_or_buffers_changed
);
9702 Lisp_Object tail
, frame
;
9703 int count
= SPECPDL_INDEX ();
9704 /* 1 means that update_menu_bar has run its hooks
9705 so any further calls to update_menu_bar shouldn't do so again. */
9706 int menu_bar_hooks_run
= 0;
9708 record_unwind_save_match_data ();
9710 FOR_EACH_FRAME (tail
, frame
)
9714 /* Ignore tooltip frame. */
9715 if (EQ (frame
, tooltip_frame
))
9718 /* If a window on this frame changed size, report that to
9719 the user and clear the size-change flag. */
9720 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9722 Lisp_Object functions
;
9724 /* Clear flag first in case we get an error below. */
9725 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9726 functions
= Vwindow_size_change_functions
;
9727 GCPRO2 (tail
, functions
);
9729 while (CONSP (functions
))
9731 if (!EQ (XCAR (functions
), Qt
))
9732 call1 (XCAR (functions
), frame
);
9733 functions
= XCDR (functions
);
9739 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9740 #ifdef HAVE_WINDOW_SYSTEM
9741 update_tool_bar (f
, 0);
9744 if (windows_or_buffers_changed
9746 ns_set_doc_edited (f
, Fbuffer_modified_p
9747 (XWINDOW (f
->selected_window
)->buffer
));
9752 unbind_to (count
, Qnil
);
9756 struct frame
*sf
= SELECTED_FRAME ();
9757 update_menu_bar (sf
, 1, 0);
9758 #ifdef HAVE_WINDOW_SYSTEM
9759 update_tool_bar (sf
, 1);
9765 /* Update the menu bar item list for frame F. This has to be done
9766 before we start to fill in any display lines, because it can call
9769 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9771 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9772 already ran the menu bar hooks for this redisplay, so there
9773 is no need to run them again. The return value is the
9774 updated value of this flag, to pass to the next call. */
9777 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9780 register struct window
*w
;
9782 /* If called recursively during a menu update, do nothing. This can
9783 happen when, for instance, an activate-menubar-hook causes a
9785 if (inhibit_menubar_update
)
9788 window
= FRAME_SELECTED_WINDOW (f
);
9789 w
= XWINDOW (window
);
9791 if (FRAME_WINDOW_P (f
)
9793 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9794 || defined (HAVE_NS) || defined (USE_GTK)
9795 FRAME_EXTERNAL_MENU_BAR (f
)
9797 FRAME_MENU_BAR_LINES (f
) > 0
9799 : FRAME_MENU_BAR_LINES (f
) > 0)
9801 /* If the user has switched buffers or windows, we need to
9802 recompute to reflect the new bindings. But we'll
9803 recompute when update_mode_lines is set too; that means
9804 that people can use force-mode-line-update to request
9805 that the menu bar be recomputed. The adverse effect on
9806 the rest of the redisplay algorithm is about the same as
9807 windows_or_buffers_changed anyway. */
9808 if (windows_or_buffers_changed
9809 /* This used to test w->update_mode_line, but we believe
9810 there is no need to recompute the menu in that case. */
9811 || update_mode_lines
9812 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9813 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9814 != !NILP (w
->last_had_star
))
9815 || ((!NILP (Vtransient_mark_mode
)
9816 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9817 != !NILP (w
->region_showing
)))
9819 struct buffer
*prev
= current_buffer
;
9820 int count
= SPECPDL_INDEX ();
9822 specbind (Qinhibit_menubar_update
, Qt
);
9824 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9825 if (save_match_data
)
9826 record_unwind_save_match_data ();
9827 if (NILP (Voverriding_local_map_menu_flag
))
9829 specbind (Qoverriding_terminal_local_map
, Qnil
);
9830 specbind (Qoverriding_local_map
, Qnil
);
9835 /* Run the Lucid hook. */
9836 safe_run_hooks (Qactivate_menubar_hook
);
9838 /* If it has changed current-menubar from previous value,
9839 really recompute the menu-bar from the value. */
9840 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9841 call0 (Qrecompute_lucid_menubar
);
9843 safe_run_hooks (Qmenu_bar_update_hook
);
9848 XSETFRAME (Vmenu_updating_frame
, f
);
9849 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9851 /* Redisplay the menu bar in case we changed it. */
9852 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9853 || defined (HAVE_NS) || defined (USE_GTK)
9854 if (FRAME_WINDOW_P (f
))
9856 #if defined (HAVE_NS)
9857 /* All frames on Mac OS share the same menubar. So only
9858 the selected frame should be allowed to set it. */
9859 if (f
== SELECTED_FRAME ())
9861 set_frame_menubar (f
, 0, 0);
9864 /* On a terminal screen, the menu bar is an ordinary screen
9865 line, and this makes it get updated. */
9866 w
->update_mode_line
= Qt
;
9867 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9868 /* In the non-toolkit version, the menu bar is an ordinary screen
9869 line, and this makes it get updated. */
9870 w
->update_mode_line
= Qt
;
9871 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9873 unbind_to (count
, Qnil
);
9874 set_buffer_internal_1 (prev
);
9883 /***********************************************************************
9885 ***********************************************************************/
9887 #ifdef HAVE_WINDOW_SYSTEM
9890 Nominal cursor position -- where to draw output.
9891 HPOS and VPOS are window relative glyph matrix coordinates.
9892 X and Y are window relative pixel coordinates. */
9894 struct cursor_pos output_cursor
;
9898 Set the global variable output_cursor to CURSOR. All cursor
9899 positions are relative to updated_window. */
9902 set_output_cursor (struct cursor_pos
*cursor
)
9904 output_cursor
.hpos
= cursor
->hpos
;
9905 output_cursor
.vpos
= cursor
->vpos
;
9906 output_cursor
.x
= cursor
->x
;
9907 output_cursor
.y
= cursor
->y
;
9912 Set a nominal cursor position.
9914 HPOS and VPOS are column/row positions in a window glyph matrix. X
9915 and Y are window text area relative pixel positions.
9917 If this is done during an update, updated_window will contain the
9918 window that is being updated and the position is the future output
9919 cursor position for that window. If updated_window is null, use
9920 selected_window and display the cursor at the given position. */
9923 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9927 /* If updated_window is not set, work on selected_window. */
9931 w
= XWINDOW (selected_window
);
9933 /* Set the output cursor. */
9934 output_cursor
.hpos
= hpos
;
9935 output_cursor
.vpos
= vpos
;
9936 output_cursor
.x
= x
;
9937 output_cursor
.y
= y
;
9939 /* If not called as part of an update, really display the cursor.
9940 This will also set the cursor position of W. */
9941 if (updated_window
== NULL
)
9944 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9945 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9946 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9951 #endif /* HAVE_WINDOW_SYSTEM */
9954 /***********************************************************************
9956 ***********************************************************************/
9958 #ifdef HAVE_WINDOW_SYSTEM
9960 /* Where the mouse was last time we reported a mouse event. */
9962 FRAME_PTR last_mouse_frame
;
9964 /* Tool-bar item index of the item on which a mouse button was pressed
9967 int last_tool_bar_item
;
9971 update_tool_bar_unwind (Lisp_Object frame
)
9973 selected_frame
= frame
;
9977 /* Update the tool-bar item list for frame F. This has to be done
9978 before we start to fill in any display lines. Called from
9979 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9980 and restore it here. */
9983 update_tool_bar (struct frame
*f
, int save_match_data
)
9985 #if defined (USE_GTK) || defined (HAVE_NS)
9986 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9988 int do_update
= WINDOWP (f
->tool_bar_window
)
9989 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9997 window
= FRAME_SELECTED_WINDOW (f
);
9998 w
= XWINDOW (window
);
10000 /* If the user has switched buffers or windows, we need to
10001 recompute to reflect the new bindings. But we'll
10002 recompute when update_mode_lines is set too; that means
10003 that people can use force-mode-line-update to request
10004 that the menu bar be recomputed. The adverse effect on
10005 the rest of the redisplay algorithm is about the same as
10006 windows_or_buffers_changed anyway. */
10007 if (windows_or_buffers_changed
10008 || !NILP (w
->update_mode_line
)
10009 || update_mode_lines
10010 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10011 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10012 != !NILP (w
->last_had_star
))
10013 || ((!NILP (Vtransient_mark_mode
)
10014 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10015 != !NILP (w
->region_showing
)))
10017 struct buffer
*prev
= current_buffer
;
10018 int count
= SPECPDL_INDEX ();
10019 Lisp_Object frame
, new_tool_bar
;
10020 int new_n_tool_bar
;
10021 struct gcpro gcpro1
;
10023 /* Set current_buffer to the buffer of the selected
10024 window of the frame, so that we get the right local
10026 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10028 /* Save match data, if we must. */
10029 if (save_match_data
)
10030 record_unwind_save_match_data ();
10032 /* Make sure that we don't accidentally use bogus keymaps. */
10033 if (NILP (Voverriding_local_map_menu_flag
))
10035 specbind (Qoverriding_terminal_local_map
, Qnil
);
10036 specbind (Qoverriding_local_map
, Qnil
);
10039 GCPRO1 (new_tool_bar
);
10041 /* We must temporarily set the selected frame to this frame
10042 before calling tool_bar_items, because the calculation of
10043 the tool-bar keymap uses the selected frame (see
10044 `tool-bar-make-keymap' in tool-bar.el). */
10045 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10046 XSETFRAME (frame
, f
);
10047 selected_frame
= frame
;
10049 /* Build desired tool-bar items from keymaps. */
10050 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10053 /* Redisplay the tool-bar if we changed it. */
10054 if (new_n_tool_bar
!= f
->n_tool_bar_items
10055 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10057 /* Redisplay that happens asynchronously due to an expose event
10058 may access f->tool_bar_items. Make sure we update both
10059 variables within BLOCK_INPUT so no such event interrupts. */
10061 f
->tool_bar_items
= new_tool_bar
;
10062 f
->n_tool_bar_items
= new_n_tool_bar
;
10063 w
->update_mode_line
= Qt
;
10069 unbind_to (count
, Qnil
);
10070 set_buffer_internal_1 (prev
);
10076 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10077 F's desired tool-bar contents. F->tool_bar_items must have
10078 been set up previously by calling prepare_menu_bars. */
10081 build_desired_tool_bar_string (struct frame
*f
)
10083 int i
, size
, size_needed
;
10084 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10085 Lisp_Object image
, plist
, props
;
10087 image
= plist
= props
= Qnil
;
10088 GCPRO3 (image
, plist
, props
);
10090 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10091 Otherwise, make a new string. */
10093 /* The size of the string we might be able to reuse. */
10094 size
= (STRINGP (f
->desired_tool_bar_string
)
10095 ? SCHARS (f
->desired_tool_bar_string
)
10098 /* We need one space in the string for each image. */
10099 size_needed
= f
->n_tool_bar_items
;
10101 /* Reuse f->desired_tool_bar_string, if possible. */
10102 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10103 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10104 make_number (' '));
10107 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10108 Fremove_text_properties (make_number (0), make_number (size
),
10109 props
, f
->desired_tool_bar_string
);
10112 /* Put a `display' property on the string for the images to display,
10113 put a `menu_item' property on tool-bar items with a value that
10114 is the index of the item in F's tool-bar item vector. */
10115 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10117 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10119 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10120 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10121 int hmargin
, vmargin
, relief
, idx
, end
;
10123 /* If image is a vector, choose the image according to the
10125 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10126 if (VECTORP (image
))
10130 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10131 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10134 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10135 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10137 xassert (ASIZE (image
) >= idx
);
10138 image
= AREF (image
, idx
);
10143 /* Ignore invalid image specifications. */
10144 if (!valid_image_p (image
))
10147 /* Display the tool-bar button pressed, or depressed. */
10148 plist
= Fcopy_sequence (XCDR (image
));
10150 /* Compute margin and relief to draw. */
10151 relief
= (tool_bar_button_relief
>= 0
10152 ? tool_bar_button_relief
10153 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10154 hmargin
= vmargin
= relief
;
10156 if (INTEGERP (Vtool_bar_button_margin
)
10157 && XINT (Vtool_bar_button_margin
) > 0)
10159 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10160 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10162 else if (CONSP (Vtool_bar_button_margin
))
10164 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10165 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10166 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10168 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10169 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10170 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10173 if (auto_raise_tool_bar_buttons_p
)
10175 /* Add a `:relief' property to the image spec if the item is
10179 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10186 /* If image is selected, display it pressed, i.e. with a
10187 negative relief. If it's not selected, display it with a
10189 plist
= Fplist_put (plist
, QCrelief
,
10191 ? make_number (-relief
)
10192 : make_number (relief
)));
10197 /* Put a margin around the image. */
10198 if (hmargin
|| vmargin
)
10200 if (hmargin
== vmargin
)
10201 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10203 plist
= Fplist_put (plist
, QCmargin
,
10204 Fcons (make_number (hmargin
),
10205 make_number (vmargin
)));
10208 /* If button is not enabled, and we don't have special images
10209 for the disabled state, make the image appear disabled by
10210 applying an appropriate algorithm to it. */
10211 if (!enabled_p
&& idx
< 0)
10212 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10214 /* Put a `display' text property on the string for the image to
10215 display. Put a `menu-item' property on the string that gives
10216 the start of this item's properties in the tool-bar items
10218 image
= Fcons (Qimage
, plist
);
10219 props
= list4 (Qdisplay
, image
,
10220 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10222 /* Let the last image hide all remaining spaces in the tool bar
10223 string. The string can be longer than needed when we reuse a
10224 previous string. */
10225 if (i
+ 1 == f
->n_tool_bar_items
)
10226 end
= SCHARS (f
->desired_tool_bar_string
);
10229 Fadd_text_properties (make_number (i
), make_number (end
),
10230 props
, f
->desired_tool_bar_string
);
10238 /* Display one line of the tool-bar of frame IT->f.
10240 HEIGHT specifies the desired height of the tool-bar line.
10241 If the actual height of the glyph row is less than HEIGHT, the
10242 row's height is increased to HEIGHT, and the icons are centered
10243 vertically in the new height.
10245 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10246 count a final empty row in case the tool-bar width exactly matches
10251 display_tool_bar_line (struct it
*it
, int height
)
10253 struct glyph_row
*row
= it
->glyph_row
;
10254 int max_x
= it
->last_visible_x
;
10255 struct glyph
*last
;
10257 prepare_desired_row (row
);
10258 row
->y
= it
->current_y
;
10260 /* Note that this isn't made use of if the face hasn't a box,
10261 so there's no need to check the face here. */
10262 it
->start_of_box_run_p
= 1;
10264 while (it
->current_x
< max_x
)
10266 int x
, n_glyphs_before
, i
, nglyphs
;
10267 struct it it_before
;
10269 /* Get the next display element. */
10270 if (!get_next_display_element (it
))
10272 /* Don't count empty row if we are counting needed tool-bar lines. */
10273 if (height
< 0 && !it
->hpos
)
10278 /* Produce glyphs. */
10279 n_glyphs_before
= row
->used
[TEXT_AREA
];
10282 PRODUCE_GLYPHS (it
);
10284 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10286 x
= it_before
.current_x
;
10287 while (i
< nglyphs
)
10289 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10291 if (x
+ glyph
->pixel_width
> max_x
)
10293 /* Glyph doesn't fit on line. Backtrack. */
10294 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10296 /* If this is the only glyph on this line, it will never fit on the
10297 tool-bar, so skip it. But ensure there is at least one glyph,
10298 so we don't accidentally disable the tool-bar. */
10299 if (n_glyphs_before
== 0
10300 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10306 x
+= glyph
->pixel_width
;
10310 /* Stop at line ends. */
10311 if (ITERATOR_AT_END_OF_LINE_P (it
))
10314 set_iterator_to_next (it
, 1);
10319 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10321 /* Use default face for the border below the tool bar.
10323 FIXME: When auto-resize-tool-bars is grow-only, there is
10324 no additional border below the possibly empty tool-bar lines.
10325 So to make the extra empty lines look "normal", we have to
10326 use the tool-bar face for the border too. */
10327 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10328 it
->face_id
= DEFAULT_FACE_ID
;
10330 extend_face_to_end_of_line (it
);
10331 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10332 last
->right_box_line_p
= 1;
10333 if (last
== row
->glyphs
[TEXT_AREA
])
10334 last
->left_box_line_p
= 1;
10336 /* Make line the desired height and center it vertically. */
10337 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10339 /* Don't add more than one line height. */
10340 height
%= FRAME_LINE_HEIGHT (it
->f
);
10341 it
->max_ascent
+= height
/ 2;
10342 it
->max_descent
+= (height
+ 1) / 2;
10345 compute_line_metrics (it
);
10347 /* If line is empty, make it occupy the rest of the tool-bar. */
10348 if (!row
->displays_text_p
)
10350 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10351 row
->visible_height
= row
->height
;
10352 row
->ascent
= row
->phys_ascent
= 0;
10353 row
->extra_line_spacing
= 0;
10356 row
->full_width_p
= 1;
10357 row
->continued_p
= 0;
10358 row
->truncated_on_left_p
= 0;
10359 row
->truncated_on_right_p
= 0;
10361 it
->current_x
= it
->hpos
= 0;
10362 it
->current_y
+= row
->height
;
10368 /* Max tool-bar height. */
10370 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10371 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10373 /* Value is the number of screen lines needed to make all tool-bar
10374 items of frame F visible. The number of actual rows needed is
10375 returned in *N_ROWS if non-NULL. */
10378 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10380 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10382 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10383 the desired matrix, so use (unused) mode-line row as temporary row to
10384 avoid destroying the first tool-bar row. */
10385 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10387 /* Initialize an iterator for iteration over
10388 F->desired_tool_bar_string in the tool-bar window of frame F. */
10389 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10390 it
.first_visible_x
= 0;
10391 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10392 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10394 while (!ITERATOR_AT_END_P (&it
))
10396 clear_glyph_row (temp_row
);
10397 it
.glyph_row
= temp_row
;
10398 display_tool_bar_line (&it
, -1);
10400 clear_glyph_row (temp_row
);
10402 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10404 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10406 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10410 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10412 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10413 (Lisp_Object frame
)
10420 frame
= selected_frame
;
10422 CHECK_FRAME (frame
);
10423 f
= XFRAME (frame
);
10425 if (WINDOWP (f
->tool_bar_window
)
10426 || (w
= XWINDOW (f
->tool_bar_window
),
10427 WINDOW_TOTAL_LINES (w
) > 0))
10429 update_tool_bar (f
, 1);
10430 if (f
->n_tool_bar_items
)
10432 build_desired_tool_bar_string (f
);
10433 nlines
= tool_bar_lines_needed (f
, NULL
);
10437 return make_number (nlines
);
10441 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10442 height should be changed. */
10445 redisplay_tool_bar (struct frame
*f
)
10449 struct glyph_row
*row
;
10451 #if defined (USE_GTK) || defined (HAVE_NS)
10452 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10453 update_frame_tool_bar (f
);
10457 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10458 do anything. This means you must start with tool-bar-lines
10459 non-zero to get the auto-sizing effect. Or in other words, you
10460 can turn off tool-bars by specifying tool-bar-lines zero. */
10461 if (!WINDOWP (f
->tool_bar_window
)
10462 || (w
= XWINDOW (f
->tool_bar_window
),
10463 WINDOW_TOTAL_LINES (w
) == 0))
10466 /* Set up an iterator for the tool-bar window. */
10467 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10468 it
.first_visible_x
= 0;
10469 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10470 row
= it
.glyph_row
;
10472 /* Build a string that represents the contents of the tool-bar. */
10473 build_desired_tool_bar_string (f
);
10474 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10476 if (f
->n_tool_bar_rows
== 0)
10480 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10481 nlines
!= WINDOW_TOTAL_LINES (w
)))
10484 int old_height
= WINDOW_TOTAL_LINES (w
);
10486 XSETFRAME (frame
, f
);
10487 Fmodify_frame_parameters (frame
,
10488 Fcons (Fcons (Qtool_bar_lines
,
10489 make_number (nlines
)),
10491 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10493 clear_glyph_matrix (w
->desired_matrix
);
10494 fonts_changed_p
= 1;
10500 /* Display as many lines as needed to display all tool-bar items. */
10502 if (f
->n_tool_bar_rows
> 0)
10504 int border
, rows
, height
, extra
;
10506 if (INTEGERP (Vtool_bar_border
))
10507 border
= XINT (Vtool_bar_border
);
10508 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10509 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10510 else if (EQ (Vtool_bar_border
, Qborder_width
))
10511 border
= f
->border_width
;
10517 rows
= f
->n_tool_bar_rows
;
10518 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10519 extra
= it
.last_visible_y
- border
- height
* rows
;
10521 while (it
.current_y
< it
.last_visible_y
)
10524 if (extra
> 0 && rows
-- > 0)
10526 h
= (extra
+ rows
- 1) / rows
;
10529 display_tool_bar_line (&it
, height
+ h
);
10534 while (it
.current_y
< it
.last_visible_y
)
10535 display_tool_bar_line (&it
, 0);
10538 /* It doesn't make much sense to try scrolling in the tool-bar
10539 window, so don't do it. */
10540 w
->desired_matrix
->no_scrolling_p
= 1;
10541 w
->must_be_updated_p
= 1;
10543 if (!NILP (Vauto_resize_tool_bars
))
10545 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10546 int change_height_p
= 0;
10548 /* If we couldn't display everything, change the tool-bar's
10549 height if there is room for more. */
10550 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10551 && it
.current_y
< max_tool_bar_height
)
10552 change_height_p
= 1;
10554 row
= it
.glyph_row
- 1;
10556 /* If there are blank lines at the end, except for a partially
10557 visible blank line at the end that is smaller than
10558 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10559 if (!row
->displays_text_p
10560 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10561 change_height_p
= 1;
10563 /* If row displays tool-bar items, but is partially visible,
10564 change the tool-bar's height. */
10565 if (row
->displays_text_p
10566 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10567 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10568 change_height_p
= 1;
10570 /* Resize windows as needed by changing the `tool-bar-lines'
10571 frame parameter. */
10572 if (change_height_p
)
10575 int old_height
= WINDOW_TOTAL_LINES (w
);
10577 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10579 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10580 && !f
->minimize_tool_bar_window_p
)
10581 ? (nlines
> old_height
)
10582 : (nlines
!= old_height
));
10583 f
->minimize_tool_bar_window_p
= 0;
10585 if (change_height_p
)
10587 XSETFRAME (frame
, f
);
10588 Fmodify_frame_parameters (frame
,
10589 Fcons (Fcons (Qtool_bar_lines
,
10590 make_number (nlines
)),
10592 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10594 clear_glyph_matrix (w
->desired_matrix
);
10595 f
->n_tool_bar_rows
= nrows
;
10596 fonts_changed_p
= 1;
10603 f
->minimize_tool_bar_window_p
= 0;
10608 /* Get information about the tool-bar item which is displayed in GLYPH
10609 on frame F. Return in *PROP_IDX the index where tool-bar item
10610 properties start in F->tool_bar_items. Value is zero if
10611 GLYPH doesn't display a tool-bar item. */
10614 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10620 /* This function can be called asynchronously, which means we must
10621 exclude any possibility that Fget_text_property signals an
10623 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10624 charpos
= max (0, charpos
);
10626 /* Get the text property `menu-item' at pos. The value of that
10627 property is the start index of this item's properties in
10628 F->tool_bar_items. */
10629 prop
= Fget_text_property (make_number (charpos
),
10630 Qmenu_item
, f
->current_tool_bar_string
);
10631 if (INTEGERP (prop
))
10633 *prop_idx
= XINT (prop
);
10643 /* Get information about the tool-bar item at position X/Y on frame F.
10644 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10645 the current matrix of the tool-bar window of F, or NULL if not
10646 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10647 item in F->tool_bar_items. Value is
10649 -1 if X/Y is not on a tool-bar item
10650 0 if X/Y is on the same item that was highlighted before.
10654 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10655 int *hpos
, int *vpos
, int *prop_idx
)
10657 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10658 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10661 /* Find the glyph under X/Y. */
10662 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10663 if (*glyph
== NULL
)
10666 /* Get the start of this tool-bar item's properties in
10667 f->tool_bar_items. */
10668 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10671 /* Is mouse on the highlighted item? */
10672 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10673 && *vpos
>= hlinfo
->mouse_face_beg_row
10674 && *vpos
<= hlinfo
->mouse_face_end_row
10675 && (*vpos
> hlinfo
->mouse_face_beg_row
10676 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10677 && (*vpos
< hlinfo
->mouse_face_end_row
10678 || *hpos
< hlinfo
->mouse_face_end_col
10679 || hlinfo
->mouse_face_past_end
))
10687 Handle mouse button event on the tool-bar of frame F, at
10688 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10689 0 for button release. MODIFIERS is event modifiers for button
10693 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10694 unsigned int modifiers
)
10696 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10697 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10698 int hpos
, vpos
, prop_idx
;
10699 struct glyph
*glyph
;
10700 Lisp_Object enabled_p
;
10702 /* If not on the highlighted tool-bar item, return. */
10703 frame_to_window_pixel_xy (w
, &x
, &y
);
10704 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10707 /* If item is disabled, do nothing. */
10708 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10709 if (NILP (enabled_p
))
10714 /* Show item in pressed state. */
10715 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10716 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10717 last_tool_bar_item
= prop_idx
;
10721 Lisp_Object key
, frame
;
10722 struct input_event event
;
10723 EVENT_INIT (event
);
10725 /* Show item in released state. */
10726 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10727 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10729 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10731 XSETFRAME (frame
, f
);
10732 event
.kind
= TOOL_BAR_EVENT
;
10733 event
.frame_or_window
= frame
;
10735 kbd_buffer_store_event (&event
);
10737 event
.kind
= TOOL_BAR_EVENT
;
10738 event
.frame_or_window
= frame
;
10740 event
.modifiers
= modifiers
;
10741 kbd_buffer_store_event (&event
);
10742 last_tool_bar_item
= -1;
10747 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10748 tool-bar window-relative coordinates X/Y. Called from
10749 note_mouse_highlight. */
10752 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10754 Lisp_Object window
= f
->tool_bar_window
;
10755 struct window
*w
= XWINDOW (window
);
10756 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10757 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10759 struct glyph
*glyph
;
10760 struct glyph_row
*row
;
10762 Lisp_Object enabled_p
;
10764 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10765 int mouse_down_p
, rc
;
10767 /* Function note_mouse_highlight is called with negative X/Y
10768 values when mouse moves outside of the frame. */
10769 if (x
<= 0 || y
<= 0)
10771 clear_mouse_face (hlinfo
);
10775 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10778 /* Not on tool-bar item. */
10779 clear_mouse_face (hlinfo
);
10783 /* On same tool-bar item as before. */
10784 goto set_help_echo
;
10786 clear_mouse_face (hlinfo
);
10788 /* Mouse is down, but on different tool-bar item? */
10789 mouse_down_p
= (dpyinfo
->grabbed
10790 && f
== last_mouse_frame
10791 && FRAME_LIVE_P (f
));
10793 && last_tool_bar_item
!= prop_idx
)
10796 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10797 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10799 /* If tool-bar item is not enabled, don't highlight it. */
10800 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10801 if (!NILP (enabled_p
))
10803 /* Compute the x-position of the glyph. In front and past the
10804 image is a space. We include this in the highlighted area. */
10805 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10806 for (i
= x
= 0; i
< hpos
; ++i
)
10807 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10809 /* Record this as the current active region. */
10810 hlinfo
->mouse_face_beg_col
= hpos
;
10811 hlinfo
->mouse_face_beg_row
= vpos
;
10812 hlinfo
->mouse_face_beg_x
= x
;
10813 hlinfo
->mouse_face_beg_y
= row
->y
;
10814 hlinfo
->mouse_face_past_end
= 0;
10816 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10817 hlinfo
->mouse_face_end_row
= vpos
;
10818 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10819 hlinfo
->mouse_face_end_y
= row
->y
;
10820 hlinfo
->mouse_face_window
= window
;
10821 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10823 /* Display it as active. */
10824 show_mouse_face (hlinfo
, draw
);
10825 hlinfo
->mouse_face_image_state
= draw
;
10830 /* Set help_echo_string to a help string to display for this tool-bar item.
10831 XTread_socket does the rest. */
10832 help_echo_object
= help_echo_window
= Qnil
;
10833 help_echo_pos
= -1;
10834 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10835 if (NILP (help_echo_string
))
10836 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10839 #endif /* HAVE_WINDOW_SYSTEM */
10843 /************************************************************************
10844 Horizontal scrolling
10845 ************************************************************************/
10847 static int hscroll_window_tree (Lisp_Object
);
10848 static int hscroll_windows (Lisp_Object
);
10850 /* For all leaf windows in the window tree rooted at WINDOW, set their
10851 hscroll value so that PT is (i) visible in the window, and (ii) so
10852 that it is not within a certain margin at the window's left and
10853 right border. Value is non-zero if any window's hscroll has been
10857 hscroll_window_tree (Lisp_Object window
)
10859 int hscrolled_p
= 0;
10860 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10861 int hscroll_step_abs
= 0;
10862 double hscroll_step_rel
= 0;
10864 if (hscroll_relative_p
)
10866 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10867 if (hscroll_step_rel
< 0)
10869 hscroll_relative_p
= 0;
10870 hscroll_step_abs
= 0;
10873 else if (INTEGERP (Vhscroll_step
))
10875 hscroll_step_abs
= XINT (Vhscroll_step
);
10876 if (hscroll_step_abs
< 0)
10877 hscroll_step_abs
= 0;
10880 hscroll_step_abs
= 0;
10882 while (WINDOWP (window
))
10884 struct window
*w
= XWINDOW (window
);
10886 if (WINDOWP (w
->hchild
))
10887 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10888 else if (WINDOWP (w
->vchild
))
10889 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10890 else if (w
->cursor
.vpos
>= 0)
10893 int text_area_width
;
10894 struct glyph_row
*current_cursor_row
10895 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10896 struct glyph_row
*desired_cursor_row
10897 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10898 struct glyph_row
*cursor_row
10899 = (desired_cursor_row
->enabled_p
10900 ? desired_cursor_row
10901 : current_cursor_row
);
10903 text_area_width
= window_box_width (w
, TEXT_AREA
);
10905 /* Scroll when cursor is inside this scroll margin. */
10906 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10908 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10909 && ((XFASTINT (w
->hscroll
)
10910 && w
->cursor
.x
<= h_margin
)
10911 || (cursor_row
->enabled_p
10912 && cursor_row
->truncated_on_right_p
10913 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10917 struct buffer
*saved_current_buffer
;
10921 /* Find point in a display of infinite width. */
10922 saved_current_buffer
= current_buffer
;
10923 current_buffer
= XBUFFER (w
->buffer
);
10925 if (w
== XWINDOW (selected_window
))
10929 pt
= marker_position (w
->pointm
);
10930 pt
= max (BEGV
, pt
);
10934 /* Move iterator to pt starting at cursor_row->start in
10935 a line with infinite width. */
10936 init_to_row_start (&it
, w
, cursor_row
);
10937 it
.last_visible_x
= INFINITY
;
10938 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10939 current_buffer
= saved_current_buffer
;
10941 /* Position cursor in window. */
10942 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10943 hscroll
= max (0, (it
.current_x
10944 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10945 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10946 : (text_area_width
/ 2))))
10947 / FRAME_COLUMN_WIDTH (it
.f
);
10948 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10950 if (hscroll_relative_p
)
10951 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10954 wanted_x
= text_area_width
10955 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10958 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10962 if (hscroll_relative_p
)
10963 wanted_x
= text_area_width
* hscroll_step_rel
10966 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10969 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10971 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10973 /* Don't call Fset_window_hscroll if value hasn't
10974 changed because it will prevent redisplay
10976 if (XFASTINT (w
->hscroll
) != hscroll
)
10978 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10979 w
->hscroll
= make_number (hscroll
);
10988 /* Value is non-zero if hscroll of any leaf window has been changed. */
10989 return hscrolled_p
;
10993 /* Set hscroll so that cursor is visible and not inside horizontal
10994 scroll margins for all windows in the tree rooted at WINDOW. See
10995 also hscroll_window_tree above. Value is non-zero if any window's
10996 hscroll has been changed. If it has, desired matrices on the frame
10997 of WINDOW are cleared. */
11000 hscroll_windows (Lisp_Object window
)
11002 int hscrolled_p
= hscroll_window_tree (window
);
11004 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11005 return hscrolled_p
;
11010 /************************************************************************
11012 ************************************************************************/
11014 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11015 to a non-zero value. This is sometimes handy to have in a debugger
11020 /* First and last unchanged row for try_window_id. */
11022 int debug_first_unchanged_at_end_vpos
;
11023 int debug_last_unchanged_at_beg_vpos
;
11025 /* Delta vpos and y. */
11027 int debug_dvpos
, debug_dy
;
11029 /* Delta in characters and bytes for try_window_id. */
11031 EMACS_INT debug_delta
, debug_delta_bytes
;
11033 /* Values of window_end_pos and window_end_vpos at the end of
11036 EMACS_INT debug_end_vpos
;
11038 /* Append a string to W->desired_matrix->method. FMT is a printf
11039 format string. A1...A9 are a supplement for a variable-length
11040 argument list. If trace_redisplay_p is non-zero also printf the
11041 resulting string to stderr. */
11044 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11047 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11050 char *method
= w
->desired_matrix
->method
;
11051 int len
= strlen (method
);
11052 int size
= sizeof w
->desired_matrix
->method
;
11053 int remaining
= size
- len
- 1;
11055 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11056 if (len
&& remaining
)
11059 --remaining
, ++len
;
11062 strncpy (method
+ len
, buffer
, remaining
);
11064 if (trace_redisplay_p
)
11065 fprintf (stderr
, "%p (%s): %s\n",
11067 ((BUFFERP (w
->buffer
)
11068 && STRINGP (XBUFFER (w
->buffer
)->name
))
11069 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11074 #endif /* GLYPH_DEBUG */
11077 /* Value is non-zero if all changes in window W, which displays
11078 current_buffer, are in the text between START and END. START is a
11079 buffer position, END is given as a distance from Z. Used in
11080 redisplay_internal for display optimization. */
11083 text_outside_line_unchanged_p (struct window
*w
,
11084 EMACS_INT start
, EMACS_INT end
)
11086 int unchanged_p
= 1;
11088 /* If text or overlays have changed, see where. */
11089 if (XFASTINT (w
->last_modified
) < MODIFF
11090 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11092 /* Gap in the line? */
11093 if (GPT
< start
|| Z
- GPT
< end
)
11096 /* Changes start in front of the line, or end after it? */
11098 && (BEG_UNCHANGED
< start
- 1
11099 || END_UNCHANGED
< end
))
11102 /* If selective display, can't optimize if changes start at the
11103 beginning of the line. */
11105 && INTEGERP (BVAR (current_buffer
, selective_display
))
11106 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11107 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11110 /* If there are overlays at the start or end of the line, these
11111 may have overlay strings with newlines in them. A change at
11112 START, for instance, may actually concern the display of such
11113 overlay strings as well, and they are displayed on different
11114 lines. So, quickly rule out this case. (For the future, it
11115 might be desirable to implement something more telling than
11116 just BEG/END_UNCHANGED.) */
11119 if (BEG
+ BEG_UNCHANGED
== start
11120 && overlay_touches_p (start
))
11122 if (END_UNCHANGED
== end
11123 && overlay_touches_p (Z
- end
))
11127 /* Under bidi reordering, adding or deleting a character in the
11128 beginning of a paragraph, before the first strong directional
11129 character, can change the base direction of the paragraph (unless
11130 the buffer specifies a fixed paragraph direction), which will
11131 require to redisplay the whole paragraph. It might be worthwhile
11132 to find the paragraph limits and widen the range of redisplayed
11133 lines to that, but for now just give up this optimization. */
11134 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11135 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11139 return unchanged_p
;
11143 /* Do a frame update, taking possible shortcuts into account. This is
11144 the main external entry point for redisplay.
11146 If the last redisplay displayed an echo area message and that message
11147 is no longer requested, we clear the echo area or bring back the
11148 mini-buffer if that is in use. */
11153 redisplay_internal (0);
11158 overlay_arrow_string_or_property (Lisp_Object var
)
11162 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11165 return Voverlay_arrow_string
;
11168 /* Return 1 if there are any overlay-arrows in current_buffer. */
11170 overlay_arrow_in_current_buffer_p (void)
11174 for (vlist
= Voverlay_arrow_variable_list
;
11176 vlist
= XCDR (vlist
))
11178 Lisp_Object var
= XCAR (vlist
);
11181 if (!SYMBOLP (var
))
11183 val
= find_symbol_value (var
);
11185 && current_buffer
== XMARKER (val
)->buffer
)
11192 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11196 overlay_arrows_changed_p (void)
11200 for (vlist
= Voverlay_arrow_variable_list
;
11202 vlist
= XCDR (vlist
))
11204 Lisp_Object var
= XCAR (vlist
);
11205 Lisp_Object val
, pstr
;
11207 if (!SYMBOLP (var
))
11209 val
= find_symbol_value (var
);
11210 if (!MARKERP (val
))
11212 if (! EQ (COERCE_MARKER (val
),
11213 Fget (var
, Qlast_arrow_position
))
11214 || ! (pstr
= overlay_arrow_string_or_property (var
),
11215 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11221 /* Mark overlay arrows to be updated on next redisplay. */
11224 update_overlay_arrows (int up_to_date
)
11228 for (vlist
= Voverlay_arrow_variable_list
;
11230 vlist
= XCDR (vlist
))
11232 Lisp_Object var
= XCAR (vlist
);
11234 if (!SYMBOLP (var
))
11237 if (up_to_date
> 0)
11239 Lisp_Object val
= find_symbol_value (var
);
11240 Fput (var
, Qlast_arrow_position
,
11241 COERCE_MARKER (val
));
11242 Fput (var
, Qlast_arrow_string
,
11243 overlay_arrow_string_or_property (var
));
11245 else if (up_to_date
< 0
11246 || !NILP (Fget (var
, Qlast_arrow_position
)))
11248 Fput (var
, Qlast_arrow_position
, Qt
);
11249 Fput (var
, Qlast_arrow_string
, Qt
);
11255 /* Return overlay arrow string to display at row.
11256 Return integer (bitmap number) for arrow bitmap in left fringe.
11257 Return nil if no overlay arrow. */
11260 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11264 for (vlist
= Voverlay_arrow_variable_list
;
11266 vlist
= XCDR (vlist
))
11268 Lisp_Object var
= XCAR (vlist
);
11271 if (!SYMBOLP (var
))
11274 val
= find_symbol_value (var
);
11277 && current_buffer
== XMARKER (val
)->buffer
11278 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11280 if (FRAME_WINDOW_P (it
->f
)
11281 /* FIXME: if ROW->reversed_p is set, this should test
11282 the right fringe, not the left one. */
11283 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11285 #ifdef HAVE_WINDOW_SYSTEM
11286 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11289 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11290 return make_number (fringe_bitmap
);
11293 return make_number (-1); /* Use default arrow bitmap */
11295 return overlay_arrow_string_or_property (var
);
11302 /* Return 1 if point moved out of or into a composition. Otherwise
11303 return 0. PREV_BUF and PREV_PT are the last point buffer and
11304 position. BUF and PT are the current point buffer and position. */
11307 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11308 struct buffer
*buf
, EMACS_INT pt
)
11310 EMACS_INT start
, end
;
11312 Lisp_Object buffer
;
11314 XSETBUFFER (buffer
, buf
);
11315 /* Check a composition at the last point if point moved within the
11317 if (prev_buf
== buf
)
11320 /* Point didn't move. */
11323 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11324 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11325 && COMPOSITION_VALID_P (start
, end
, prop
)
11326 && start
< prev_pt
&& end
> prev_pt
)
11327 /* The last point was within the composition. Return 1 iff
11328 point moved out of the composition. */
11329 return (pt
<= start
|| pt
>= end
);
11332 /* Check a composition at the current point. */
11333 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11334 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11335 && COMPOSITION_VALID_P (start
, end
, prop
)
11336 && start
< pt
&& end
> pt
);
11340 /* Reconsider the setting of B->clip_changed which is displayed
11344 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11346 if (b
->clip_changed
11347 && !NILP (w
->window_end_valid
)
11348 && w
->current_matrix
->buffer
== b
11349 && w
->current_matrix
->zv
== BUF_ZV (b
)
11350 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11351 b
->clip_changed
= 0;
11353 /* If display wasn't paused, and W is not a tool bar window, see if
11354 point has been moved into or out of a composition. In that case,
11355 we set b->clip_changed to 1 to force updating the screen. If
11356 b->clip_changed has already been set to 1, we can skip this
11358 if (!b
->clip_changed
11359 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11363 if (w
== XWINDOW (selected_window
))
11366 pt
= marker_position (w
->pointm
);
11368 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11369 || pt
!= XINT (w
->last_point
))
11370 && check_point_in_composition (w
->current_matrix
->buffer
,
11371 XINT (w
->last_point
),
11372 XBUFFER (w
->buffer
), pt
))
11373 b
->clip_changed
= 1;
11378 /* Select FRAME to forward the values of frame-local variables into C
11379 variables so that the redisplay routines can access those values
11383 select_frame_for_redisplay (Lisp_Object frame
)
11385 Lisp_Object tail
, tem
;
11386 Lisp_Object old
= selected_frame
;
11387 struct Lisp_Symbol
*sym
;
11389 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11391 selected_frame
= frame
;
11394 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11395 if (CONSP (XCAR (tail
))
11396 && (tem
= XCAR (XCAR (tail
)),
11398 && (sym
= indirect_variable (XSYMBOL (tem
)),
11399 sym
->redirect
== SYMBOL_LOCALIZED
)
11400 && sym
->val
.blv
->frame_local
)
11401 /* Use find_symbol_value rather than Fsymbol_value
11402 to avoid an error if it is void. */
11403 find_symbol_value (tem
);
11404 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11408 #define STOP_POLLING \
11409 do { if (! polling_stopped_here) stop_polling (); \
11410 polling_stopped_here = 1; } while (0)
11412 #define RESUME_POLLING \
11413 do { if (polling_stopped_here) start_polling (); \
11414 polling_stopped_here = 0; } while (0)
11417 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11418 response to any user action; therefore, we should preserve the echo
11419 area. (Actually, our caller does that job.) Perhaps in the future
11420 avoid recentering windows if it is not necessary; currently that
11421 causes some problems. */
11424 redisplay_internal (int preserve_echo_area
)
11426 struct window
*w
= XWINDOW (selected_window
);
11430 int must_finish
= 0;
11431 struct text_pos tlbufpos
, tlendpos
;
11432 int number_of_visible_frames
;
11435 int polling_stopped_here
= 0;
11436 Lisp_Object old_frame
= selected_frame
;
11438 /* Non-zero means redisplay has to consider all windows on all
11439 frames. Zero means, only selected_window is considered. */
11440 int consider_all_windows_p
;
11442 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11444 /* No redisplay if running in batch mode or frame is not yet fully
11445 initialized, or redisplay is explicitly turned off by setting
11446 Vinhibit_redisplay. */
11447 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11448 || !NILP (Vinhibit_redisplay
))
11451 /* Don't examine these until after testing Vinhibit_redisplay.
11452 When Emacs is shutting down, perhaps because its connection to
11453 X has dropped, we should not look at them at all. */
11454 fr
= XFRAME (w
->frame
);
11455 sf
= SELECTED_FRAME ();
11457 if (!fr
->glyphs_initialized_p
)
11460 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11461 if (popup_activated ())
11465 /* I don't think this happens but let's be paranoid. */
11466 if (redisplaying_p
)
11469 /* Record a function that resets redisplaying_p to its old value
11470 when we leave this function. */
11471 count
= SPECPDL_INDEX ();
11472 record_unwind_protect (unwind_redisplay
,
11473 Fcons (make_number (redisplaying_p
), selected_frame
));
11475 specbind (Qinhibit_free_realized_faces
, Qnil
);
11478 Lisp_Object tail
, frame
;
11480 FOR_EACH_FRAME (tail
, frame
)
11482 struct frame
*f
= XFRAME (frame
);
11483 f
->already_hscrolled_p
= 0;
11488 /* Remember the currently selected window. */
11491 if (!EQ (old_frame
, selected_frame
)
11492 && FRAME_LIVE_P (XFRAME (old_frame
)))
11493 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11494 selected_frame and selected_window to be temporarily out-of-sync so
11495 when we come back here via `goto retry', we need to resync because we
11496 may need to run Elisp code (via prepare_menu_bars). */
11497 select_frame_for_redisplay (old_frame
);
11500 reconsider_clip_changes (w
, current_buffer
);
11501 last_escape_glyph_frame
= NULL
;
11502 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11503 last_glyphless_glyph_frame
= NULL
;
11504 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11506 /* If new fonts have been loaded that make a glyph matrix adjustment
11507 necessary, do it. */
11508 if (fonts_changed_p
)
11510 adjust_glyphs (NULL
);
11511 ++windows_or_buffers_changed
;
11512 fonts_changed_p
= 0;
11515 /* If face_change_count is non-zero, init_iterator will free all
11516 realized faces, which includes the faces referenced from current
11517 matrices. So, we can't reuse current matrices in this case. */
11518 if (face_change_count
)
11519 ++windows_or_buffers_changed
;
11521 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11522 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11524 /* Since frames on a single ASCII terminal share the same
11525 display area, displaying a different frame means redisplay
11526 the whole thing. */
11527 windows_or_buffers_changed
++;
11528 SET_FRAME_GARBAGED (sf
);
11530 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11532 FRAME_TTY (sf
)->previous_frame
= sf
;
11535 /* Set the visible flags for all frames. Do this before checking
11536 for resized or garbaged frames; they want to know if their frames
11537 are visible. See the comment in frame.h for
11538 FRAME_SAMPLE_VISIBILITY. */
11540 Lisp_Object tail
, frame
;
11542 number_of_visible_frames
= 0;
11544 FOR_EACH_FRAME (tail
, frame
)
11546 struct frame
*f
= XFRAME (frame
);
11548 FRAME_SAMPLE_VISIBILITY (f
);
11549 if (FRAME_VISIBLE_P (f
))
11550 ++number_of_visible_frames
;
11551 clear_desired_matrices (f
);
11555 /* Notice any pending interrupt request to change frame size. */
11556 do_pending_window_change (1);
11558 /* do_pending_window_change could change the selected_window due to
11559 frame resizing which makes the selected window too small. */
11560 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11563 reconsider_clip_changes (w
, current_buffer
);
11566 /* Clear frames marked as garbaged. */
11567 if (frame_garbaged
)
11568 clear_garbaged_frames ();
11570 /* Build menubar and tool-bar items. */
11571 if (NILP (Vmemory_full
))
11572 prepare_menu_bars ();
11574 if (windows_or_buffers_changed
)
11575 update_mode_lines
++;
11577 /* Detect case that we need to write or remove a star in the mode line. */
11578 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11580 w
->update_mode_line
= Qt
;
11581 if (buffer_shared
> 1)
11582 update_mode_lines
++;
11585 /* Avoid invocation of point motion hooks by `current_column' below. */
11586 count1
= SPECPDL_INDEX ();
11587 specbind (Qinhibit_point_motion_hooks
, Qt
);
11589 /* If %c is in the mode line, update it if needed. */
11590 if (!NILP (w
->column_number_displayed
)
11591 /* This alternative quickly identifies a common case
11592 where no change is needed. */
11593 && !(PT
== XFASTINT (w
->last_point
)
11594 && XFASTINT (w
->last_modified
) >= MODIFF
11595 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11596 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11597 w
->update_mode_line
= Qt
;
11599 unbind_to (count1
, Qnil
);
11601 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11603 /* The variable buffer_shared is set in redisplay_window and
11604 indicates that we redisplay a buffer in different windows. See
11606 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11607 || cursor_type_changed
);
11609 /* If specs for an arrow have changed, do thorough redisplay
11610 to ensure we remove any arrow that should no longer exist. */
11611 if (overlay_arrows_changed_p ())
11612 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11614 /* Normally the message* functions will have already displayed and
11615 updated the echo area, but the frame may have been trashed, or
11616 the update may have been preempted, so display the echo area
11617 again here. Checking message_cleared_p captures the case that
11618 the echo area should be cleared. */
11619 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11620 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11621 || (message_cleared_p
11622 && minibuf_level
== 0
11623 /* If the mini-window is currently selected, this means the
11624 echo-area doesn't show through. */
11625 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11627 int window_height_changed_p
= echo_area_display (0);
11630 /* If we don't display the current message, don't clear the
11631 message_cleared_p flag, because, if we did, we wouldn't clear
11632 the echo area in the next redisplay which doesn't preserve
11634 if (!display_last_displayed_message_p
)
11635 message_cleared_p
= 0;
11637 if (fonts_changed_p
)
11639 else if (window_height_changed_p
)
11641 consider_all_windows_p
= 1;
11642 ++update_mode_lines
;
11643 ++windows_or_buffers_changed
;
11645 /* If window configuration was changed, frames may have been
11646 marked garbaged. Clear them or we will experience
11647 surprises wrt scrolling. */
11648 if (frame_garbaged
)
11649 clear_garbaged_frames ();
11652 else if (EQ (selected_window
, minibuf_window
)
11653 && (current_buffer
->clip_changed
11654 || XFASTINT (w
->last_modified
) < MODIFF
11655 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11656 && resize_mini_window (w
, 0))
11658 /* Resized active mini-window to fit the size of what it is
11659 showing if its contents might have changed. */
11661 /* FIXME: this causes all frames to be updated, which seems unnecessary
11662 since only the current frame needs to be considered. This function needs
11663 to be rewritten with two variables, consider_all_windows and
11664 consider_all_frames. */
11665 consider_all_windows_p
= 1;
11666 ++windows_or_buffers_changed
;
11667 ++update_mode_lines
;
11669 /* If window configuration was changed, frames may have been
11670 marked garbaged. Clear them or we will experience
11671 surprises wrt scrolling. */
11672 if (frame_garbaged
)
11673 clear_garbaged_frames ();
11677 /* If showing the region, and mark has changed, we must redisplay
11678 the whole window. The assignment to this_line_start_pos prevents
11679 the optimization directly below this if-statement. */
11680 if (((!NILP (Vtransient_mark_mode
)
11681 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11682 != !NILP (w
->region_showing
))
11683 || (!NILP (w
->region_showing
)
11684 && !EQ (w
->region_showing
,
11685 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11686 CHARPOS (this_line_start_pos
) = 0;
11688 /* Optimize the case that only the line containing the cursor in the
11689 selected window has changed. Variables starting with this_ are
11690 set in display_line and record information about the line
11691 containing the cursor. */
11692 tlbufpos
= this_line_start_pos
;
11693 tlendpos
= this_line_end_pos
;
11694 if (!consider_all_windows_p
11695 && CHARPOS (tlbufpos
) > 0
11696 && NILP (w
->update_mode_line
)
11697 && !current_buffer
->clip_changed
11698 && !current_buffer
->prevent_redisplay_optimizations_p
11699 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11700 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11701 /* Make sure recorded data applies to current buffer, etc. */
11702 && this_line_buffer
== current_buffer
11703 && current_buffer
== XBUFFER (w
->buffer
)
11704 && NILP (w
->force_start
)
11705 && NILP (w
->optional_new_start
)
11706 /* Point must be on the line that we have info recorded about. */
11707 && PT
>= CHARPOS (tlbufpos
)
11708 && PT
<= Z
- CHARPOS (tlendpos
)
11709 /* All text outside that line, including its final newline,
11710 must be unchanged. */
11711 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11712 CHARPOS (tlendpos
)))
11714 if (CHARPOS (tlbufpos
) > BEGV
11715 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11716 && (CHARPOS (tlbufpos
) == ZV
11717 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11718 /* Former continuation line has disappeared by becoming empty. */
11720 else if (XFASTINT (w
->last_modified
) < MODIFF
11721 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11722 || MINI_WINDOW_P (w
))
11724 /* We have to handle the case of continuation around a
11725 wide-column character (see the comment in indent.c around
11728 For instance, in the following case:
11730 -------- Insert --------
11731 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11732 J_I_ ==> J_I_ `^^' are cursors.
11736 As we have to redraw the line above, we cannot use this
11740 int line_height_before
= this_line_pixel_height
;
11742 /* Note that start_display will handle the case that the
11743 line starting at tlbufpos is a continuation line. */
11744 start_display (&it
, w
, tlbufpos
);
11746 /* Implementation note: It this still necessary? */
11747 if (it
.current_x
!= this_line_start_x
)
11750 TRACE ((stderr
, "trying display optimization 1\n"));
11751 w
->cursor
.vpos
= -1;
11752 overlay_arrow_seen
= 0;
11753 it
.vpos
= this_line_vpos
;
11754 it
.current_y
= this_line_y
;
11755 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11756 display_line (&it
);
11758 /* If line contains point, is not continued,
11759 and ends at same distance from eob as before, we win. */
11760 if (w
->cursor
.vpos
>= 0
11761 /* Line is not continued, otherwise this_line_start_pos
11762 would have been set to 0 in display_line. */
11763 && CHARPOS (this_line_start_pos
)
11764 /* Line ends as before. */
11765 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11766 /* Line has same height as before. Otherwise other lines
11767 would have to be shifted up or down. */
11768 && this_line_pixel_height
== line_height_before
)
11770 /* If this is not the window's last line, we must adjust
11771 the charstarts of the lines below. */
11772 if (it
.current_y
< it
.last_visible_y
)
11774 struct glyph_row
*row
11775 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11776 EMACS_INT delta
, delta_bytes
;
11778 /* We used to distinguish between two cases here,
11779 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11780 when the line ends in a newline or the end of the
11781 buffer's accessible portion. But both cases did
11782 the same, so they were collapsed. */
11784 - CHARPOS (tlendpos
)
11785 - MATRIX_ROW_START_CHARPOS (row
));
11786 delta_bytes
= (Z_BYTE
11787 - BYTEPOS (tlendpos
)
11788 - MATRIX_ROW_START_BYTEPOS (row
));
11790 increment_matrix_positions (w
->current_matrix
,
11791 this_line_vpos
+ 1,
11792 w
->current_matrix
->nrows
,
11793 delta
, delta_bytes
);
11796 /* If this row displays text now but previously didn't,
11797 or vice versa, w->window_end_vpos may have to be
11799 if ((it
.glyph_row
- 1)->displays_text_p
)
11801 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11802 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11804 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11805 && this_line_vpos
> 0)
11806 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11807 w
->window_end_valid
= Qnil
;
11809 /* Update hint: No need to try to scroll in update_window. */
11810 w
->desired_matrix
->no_scrolling_p
= 1;
11813 *w
->desired_matrix
->method
= 0;
11814 debug_method_add (w
, "optimization 1");
11816 #ifdef HAVE_WINDOW_SYSTEM
11817 update_window_fringes (w
, 0);
11824 else if (/* Cursor position hasn't changed. */
11825 PT
== XFASTINT (w
->last_point
)
11826 /* Make sure the cursor was last displayed
11827 in this window. Otherwise we have to reposition it. */
11828 && 0 <= w
->cursor
.vpos
11829 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11833 do_pending_window_change (1);
11834 /* If selected_window changed, redisplay again. */
11835 if (WINDOWP (selected_window
)
11836 && (w
= XWINDOW (selected_window
)) != sw
)
11839 /* We used to always goto end_of_redisplay here, but this
11840 isn't enough if we have a blinking cursor. */
11841 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11842 goto end_of_redisplay
;
11846 /* If highlighting the region, or if the cursor is in the echo area,
11847 then we can't just move the cursor. */
11848 else if (! (!NILP (Vtransient_mark_mode
)
11849 && !NILP (BVAR (current_buffer
, mark_active
)))
11850 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11851 || highlight_nonselected_windows
)
11852 && NILP (w
->region_showing
)
11853 && NILP (Vshow_trailing_whitespace
)
11854 && !cursor_in_echo_area
)
11857 struct glyph_row
*row
;
11859 /* Skip from tlbufpos to PT and see where it is. Note that
11860 PT may be in invisible text. If so, we will end at the
11861 next visible position. */
11862 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11863 NULL
, DEFAULT_FACE_ID
);
11864 it
.current_x
= this_line_start_x
;
11865 it
.current_y
= this_line_y
;
11866 it
.vpos
= this_line_vpos
;
11868 /* The call to move_it_to stops in front of PT, but
11869 moves over before-strings. */
11870 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11872 if (it
.vpos
== this_line_vpos
11873 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11876 xassert (this_line_vpos
== it
.vpos
);
11877 xassert (this_line_y
== it
.current_y
);
11878 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11880 *w
->desired_matrix
->method
= 0;
11881 debug_method_add (w
, "optimization 3");
11890 /* Text changed drastically or point moved off of line. */
11891 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11894 CHARPOS (this_line_start_pos
) = 0;
11895 consider_all_windows_p
|= buffer_shared
> 1;
11896 ++clear_face_cache_count
;
11897 #ifdef HAVE_WINDOW_SYSTEM
11898 ++clear_image_cache_count
;
11901 /* Build desired matrices, and update the display. If
11902 consider_all_windows_p is non-zero, do it for all windows on all
11903 frames. Otherwise do it for selected_window, only. */
11905 if (consider_all_windows_p
)
11907 Lisp_Object tail
, frame
;
11909 FOR_EACH_FRAME (tail
, frame
)
11910 XFRAME (frame
)->updated_p
= 0;
11912 /* Recompute # windows showing selected buffer. This will be
11913 incremented each time such a window is displayed. */
11916 FOR_EACH_FRAME (tail
, frame
)
11918 struct frame
*f
= XFRAME (frame
);
11920 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11922 if (! EQ (frame
, selected_frame
))
11923 /* Select the frame, for the sake of frame-local
11925 select_frame_for_redisplay (frame
);
11927 /* Mark all the scroll bars to be removed; we'll redeem
11928 the ones we want when we redisplay their windows. */
11929 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11930 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11932 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11933 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11935 /* The X error handler may have deleted that frame. */
11936 if (!FRAME_LIVE_P (f
))
11939 /* Any scroll bars which redisplay_windows should have
11940 nuked should now go away. */
11941 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11942 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11944 /* If fonts changed, display again. */
11945 /* ??? rms: I suspect it is a mistake to jump all the way
11946 back to retry here. It should just retry this frame. */
11947 if (fonts_changed_p
)
11950 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11952 /* See if we have to hscroll. */
11953 if (!f
->already_hscrolled_p
)
11955 f
->already_hscrolled_p
= 1;
11956 if (hscroll_windows (f
->root_window
))
11960 /* Prevent various kinds of signals during display
11961 update. stdio is not robust about handling
11962 signals, which can cause an apparent I/O
11964 if (interrupt_input
)
11965 unrequest_sigio ();
11968 /* Update the display. */
11969 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11970 pending
|= update_frame (f
, 0, 0);
11976 if (!EQ (old_frame
, selected_frame
)
11977 && FRAME_LIVE_P (XFRAME (old_frame
)))
11978 /* We played a bit fast-and-loose above and allowed selected_frame
11979 and selected_window to be temporarily out-of-sync but let's make
11980 sure this stays contained. */
11981 select_frame_for_redisplay (old_frame
);
11982 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11986 /* Do the mark_window_display_accurate after all windows have
11987 been redisplayed because this call resets flags in buffers
11988 which are needed for proper redisplay. */
11989 FOR_EACH_FRAME (tail
, frame
)
11991 struct frame
*f
= XFRAME (frame
);
11994 mark_window_display_accurate (f
->root_window
, 1);
11995 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11996 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12001 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12003 Lisp_Object mini_window
;
12004 struct frame
*mini_frame
;
12006 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12007 /* Use list_of_error, not Qerror, so that
12008 we catch only errors and don't run the debugger. */
12009 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12011 redisplay_window_error
);
12013 /* Compare desired and current matrices, perform output. */
12016 /* If fonts changed, display again. */
12017 if (fonts_changed_p
)
12020 /* Prevent various kinds of signals during display update.
12021 stdio is not robust about handling signals,
12022 which can cause an apparent I/O error. */
12023 if (interrupt_input
)
12024 unrequest_sigio ();
12027 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12029 if (hscroll_windows (selected_window
))
12032 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12033 pending
= update_frame (sf
, 0, 0);
12036 /* We may have called echo_area_display at the top of this
12037 function. If the echo area is on another frame, that may
12038 have put text on a frame other than the selected one, so the
12039 above call to update_frame would not have caught it. Catch
12041 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12042 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12044 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12046 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12047 pending
|= update_frame (mini_frame
, 0, 0);
12048 if (!pending
&& hscroll_windows (mini_window
))
12053 /* If display was paused because of pending input, make sure we do a
12054 thorough update the next time. */
12057 /* Prevent the optimization at the beginning of
12058 redisplay_internal that tries a single-line update of the
12059 line containing the cursor in the selected window. */
12060 CHARPOS (this_line_start_pos
) = 0;
12062 /* Let the overlay arrow be updated the next time. */
12063 update_overlay_arrows (0);
12065 /* If we pause after scrolling, some rows in the current
12066 matrices of some windows are not valid. */
12067 if (!WINDOW_FULL_WIDTH_P (w
)
12068 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12069 update_mode_lines
= 1;
12073 if (!consider_all_windows_p
)
12075 /* This has already been done above if
12076 consider_all_windows_p is set. */
12077 mark_window_display_accurate_1 (w
, 1);
12079 /* Say overlay arrows are up to date. */
12080 update_overlay_arrows (1);
12082 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12083 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12086 update_mode_lines
= 0;
12087 windows_or_buffers_changed
= 0;
12088 cursor_type_changed
= 0;
12091 /* Start SIGIO interrupts coming again. Having them off during the
12092 code above makes it less likely one will discard output, but not
12093 impossible, since there might be stuff in the system buffer here.
12094 But it is much hairier to try to do anything about that. */
12095 if (interrupt_input
)
12099 /* If a frame has become visible which was not before, redisplay
12100 again, so that we display it. Expose events for such a frame
12101 (which it gets when becoming visible) don't call the parts of
12102 redisplay constructing glyphs, so simply exposing a frame won't
12103 display anything in this case. So, we have to display these
12104 frames here explicitly. */
12107 Lisp_Object tail
, frame
;
12110 FOR_EACH_FRAME (tail
, frame
)
12112 int this_is_visible
= 0;
12114 if (XFRAME (frame
)->visible
)
12115 this_is_visible
= 1;
12116 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12117 if (XFRAME (frame
)->visible
)
12118 this_is_visible
= 1;
12120 if (this_is_visible
)
12124 if (new_count
!= number_of_visible_frames
)
12125 windows_or_buffers_changed
++;
12128 /* Change frame size now if a change is pending. */
12129 do_pending_window_change (1);
12131 /* If we just did a pending size change, or have additional
12132 visible frames, or selected_window changed, redisplay again. */
12133 if ((windows_or_buffers_changed
&& !pending
)
12134 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12137 /* Clear the face and image caches.
12139 We used to do this only if consider_all_windows_p. But the cache
12140 needs to be cleared if a timer creates images in the current
12141 buffer (e.g. the test case in Bug#6230). */
12143 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12145 clear_face_cache (0);
12146 clear_face_cache_count
= 0;
12149 #ifdef HAVE_WINDOW_SYSTEM
12150 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12152 clear_image_caches (Qnil
);
12153 clear_image_cache_count
= 0;
12155 #endif /* HAVE_WINDOW_SYSTEM */
12158 unbind_to (count
, Qnil
);
12163 /* Redisplay, but leave alone any recent echo area message unless
12164 another message has been requested in its place.
12166 This is useful in situations where you need to redisplay but no
12167 user action has occurred, making it inappropriate for the message
12168 area to be cleared. See tracking_off and
12169 wait_reading_process_output for examples of these situations.
12171 FROM_WHERE is an integer saying from where this function was
12172 called. This is useful for debugging. */
12175 redisplay_preserve_echo_area (int from_where
)
12177 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12179 if (!NILP (echo_area_buffer
[1]))
12181 /* We have a previously displayed message, but no current
12182 message. Redisplay the previous message. */
12183 display_last_displayed_message_p
= 1;
12184 redisplay_internal (1);
12185 display_last_displayed_message_p
= 0;
12188 redisplay_internal (1);
12190 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12191 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12192 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12196 /* Function registered with record_unwind_protect in
12197 redisplay_internal. Reset redisplaying_p to the value it had
12198 before redisplay_internal was called, and clear
12199 prevent_freeing_realized_faces_p. It also selects the previously
12200 selected frame, unless it has been deleted (by an X connection
12201 failure during redisplay, for example). */
12204 unwind_redisplay (Lisp_Object val
)
12206 Lisp_Object old_redisplaying_p
, old_frame
;
12208 old_redisplaying_p
= XCAR (val
);
12209 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12210 old_frame
= XCDR (val
);
12211 if (! EQ (old_frame
, selected_frame
)
12212 && FRAME_LIVE_P (XFRAME (old_frame
)))
12213 select_frame_for_redisplay (old_frame
);
12218 /* Mark the display of window W as accurate or inaccurate. If
12219 ACCURATE_P is non-zero mark display of W as accurate. If
12220 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12221 redisplay_internal is called. */
12224 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12226 if (BUFFERP (w
->buffer
))
12228 struct buffer
*b
= XBUFFER (w
->buffer
);
12231 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12232 w
->last_overlay_modified
12233 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12235 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12239 b
->clip_changed
= 0;
12240 b
->prevent_redisplay_optimizations_p
= 0;
12242 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12243 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12244 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12245 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12247 w
->current_matrix
->buffer
= b
;
12248 w
->current_matrix
->begv
= BUF_BEGV (b
);
12249 w
->current_matrix
->zv
= BUF_ZV (b
);
12251 w
->last_cursor
= w
->cursor
;
12252 w
->last_cursor_off_p
= w
->cursor_off_p
;
12254 if (w
== XWINDOW (selected_window
))
12255 w
->last_point
= make_number (BUF_PT (b
));
12257 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12263 w
->window_end_valid
= w
->buffer
;
12264 w
->update_mode_line
= Qnil
;
12269 /* Mark the display of windows in the window tree rooted at WINDOW as
12270 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12271 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12272 be redisplayed the next time redisplay_internal is called. */
12275 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12279 for (; !NILP (window
); window
= w
->next
)
12281 w
= XWINDOW (window
);
12282 mark_window_display_accurate_1 (w
, accurate_p
);
12284 if (!NILP (w
->vchild
))
12285 mark_window_display_accurate (w
->vchild
, accurate_p
);
12286 if (!NILP (w
->hchild
))
12287 mark_window_display_accurate (w
->hchild
, accurate_p
);
12292 update_overlay_arrows (1);
12296 /* Force a thorough redisplay the next time by setting
12297 last_arrow_position and last_arrow_string to t, which is
12298 unequal to any useful value of Voverlay_arrow_... */
12299 update_overlay_arrows (-1);
12304 /* Return value in display table DP (Lisp_Char_Table *) for character
12305 C. Since a display table doesn't have any parent, we don't have to
12306 follow parent. Do not call this function directly but use the
12307 macro DISP_CHAR_VECTOR. */
12310 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12314 if (ASCII_CHAR_P (c
))
12317 if (SUB_CHAR_TABLE_P (val
))
12318 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12324 XSETCHAR_TABLE (table
, dp
);
12325 val
= char_table_ref (table
, c
);
12334 /***********************************************************************
12336 ***********************************************************************/
12338 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12341 redisplay_windows (Lisp_Object window
)
12343 while (!NILP (window
))
12345 struct window
*w
= XWINDOW (window
);
12347 if (!NILP (w
->hchild
))
12348 redisplay_windows (w
->hchild
);
12349 else if (!NILP (w
->vchild
))
12350 redisplay_windows (w
->vchild
);
12351 else if (!NILP (w
->buffer
))
12353 displayed_buffer
= XBUFFER (w
->buffer
);
12354 /* Use list_of_error, not Qerror, so that
12355 we catch only errors and don't run the debugger. */
12356 internal_condition_case_1 (redisplay_window_0
, window
,
12358 redisplay_window_error
);
12366 redisplay_window_error (Lisp_Object ignore
)
12368 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12373 redisplay_window_0 (Lisp_Object window
)
12375 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12376 redisplay_window (window
, 0);
12381 redisplay_window_1 (Lisp_Object window
)
12383 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12384 redisplay_window (window
, 1);
12389 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12390 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12391 which positions recorded in ROW differ from current buffer
12394 Return 0 if cursor is not on this row, 1 otherwise. */
12397 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12398 struct glyph_matrix
*matrix
,
12399 EMACS_INT delta
, EMACS_INT delta_bytes
,
12402 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12403 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12404 struct glyph
*cursor
= NULL
;
12405 /* The last known character position in row. */
12406 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12408 EMACS_INT pt_old
= PT
- delta
;
12409 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12410 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12411 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12412 /* A glyph beyond the edge of TEXT_AREA which we should never
12414 struct glyph
*glyphs_end
= end
;
12415 /* Non-zero means we've found a match for cursor position, but that
12416 glyph has the avoid_cursor_p flag set. */
12417 int match_with_avoid_cursor
= 0;
12418 /* Non-zero means we've seen at least one glyph that came from a
12420 int string_seen
= 0;
12421 /* Largest and smalles buffer positions seen so far during scan of
12423 EMACS_INT bpos_max
= pos_before
;
12424 EMACS_INT bpos_min
= pos_after
;
12425 /* Last buffer position covered by an overlay string with an integer
12426 `cursor' property. */
12427 EMACS_INT bpos_covered
= 0;
12429 /* Skip over glyphs not having an object at the start and the end of
12430 the row. These are special glyphs like truncation marks on
12431 terminal frames. */
12432 if (row
->displays_text_p
)
12434 if (!row
->reversed_p
)
12437 && INTEGERP (glyph
->object
)
12438 && glyph
->charpos
< 0)
12440 x
+= glyph
->pixel_width
;
12444 && INTEGERP ((end
- 1)->object
)
12445 /* CHARPOS is zero for blanks and stretch glyphs
12446 inserted by extend_face_to_end_of_line. */
12447 && (end
- 1)->charpos
<= 0)
12449 glyph_before
= glyph
- 1;
12456 /* If the glyph row is reversed, we need to process it from back
12457 to front, so swap the edge pointers. */
12458 glyphs_end
= end
= glyph
- 1;
12459 glyph
+= row
->used
[TEXT_AREA
] - 1;
12461 while (glyph
> end
+ 1
12462 && INTEGERP (glyph
->object
)
12463 && glyph
->charpos
< 0)
12466 x
-= glyph
->pixel_width
;
12468 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12470 /* By default, in reversed rows we put the cursor on the
12471 rightmost (first in the reading order) glyph. */
12472 for (g
= end
+ 1; g
< glyph
; g
++)
12473 x
+= g
->pixel_width
;
12475 && INTEGERP ((end
+ 1)->object
)
12476 && (end
+ 1)->charpos
<= 0)
12478 glyph_before
= glyph
+ 1;
12482 else if (row
->reversed_p
)
12484 /* In R2L rows that don't display text, put the cursor on the
12485 rightmost glyph. Case in point: an empty last line that is
12486 part of an R2L paragraph. */
12488 /* Avoid placing the cursor on the last glyph of the row, where
12489 on terminal frames we hold the vertical border between
12490 adjacent windows. */
12491 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12492 && !WINDOW_RIGHTMOST_P (w
)
12493 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12495 x
= -1; /* will be computed below, at label compute_x */
12498 /* Step 1: Try to find the glyph whose character position
12499 corresponds to point. If that's not possible, find 2 glyphs
12500 whose character positions are the closest to point, one before
12501 point, the other after it. */
12502 if (!row
->reversed_p
)
12503 while (/* not marched to end of glyph row */
12505 /* glyph was not inserted by redisplay for internal purposes */
12506 && !INTEGERP (glyph
->object
))
12508 if (BUFFERP (glyph
->object
))
12510 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12512 if (glyph
->charpos
> bpos_max
)
12513 bpos_max
= glyph
->charpos
;
12514 if (glyph
->charpos
< bpos_min
)
12515 bpos_min
= glyph
->charpos
;
12516 if (!glyph
->avoid_cursor_p
)
12518 /* If we hit point, we've found the glyph on which to
12519 display the cursor. */
12522 match_with_avoid_cursor
= 0;
12525 /* See if we've found a better approximation to
12526 POS_BEFORE or to POS_AFTER. Note that we want the
12527 first (leftmost) glyph of all those that are the
12528 closest from below, and the last (rightmost) of all
12529 those from above. */
12530 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12532 pos_before
= glyph
->charpos
;
12533 glyph_before
= glyph
;
12535 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12537 pos_after
= glyph
->charpos
;
12538 glyph_after
= glyph
;
12541 else if (dpos
== 0)
12542 match_with_avoid_cursor
= 1;
12544 else if (STRINGP (glyph
->object
))
12546 Lisp_Object chprop
;
12547 EMACS_INT glyph_pos
= glyph
->charpos
;
12549 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12551 if (INTEGERP (chprop
))
12553 bpos_covered
= bpos_max
+ XINT (chprop
);
12554 /* If the `cursor' property covers buffer positions up
12555 to and including point, we should display cursor on
12556 this glyph. Note that overlays and text properties
12557 with string values stop bidi reordering, so every
12558 buffer position to the left of the string is always
12559 smaller than any position to the right of the
12560 string. Therefore, if a `cursor' property on one
12561 of the string's characters has an integer value, we
12562 will break out of the loop below _before_ we get to
12563 the position match above. IOW, integer values of
12564 the `cursor' property override the "exact match for
12565 point" strategy of positioning the cursor. */
12566 /* Implementation note: bpos_max == pt_old when, e.g.,
12567 we are in an empty line, where bpos_max is set to
12568 MATRIX_ROW_START_CHARPOS, see above. */
12569 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12578 x
+= glyph
->pixel_width
;
12581 else if (glyph
> end
) /* row is reversed */
12582 while (!INTEGERP (glyph
->object
))
12584 if (BUFFERP (glyph
->object
))
12586 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12588 if (glyph
->charpos
> bpos_max
)
12589 bpos_max
= glyph
->charpos
;
12590 if (glyph
->charpos
< bpos_min
)
12591 bpos_min
= glyph
->charpos
;
12592 if (!glyph
->avoid_cursor_p
)
12596 match_with_avoid_cursor
= 0;
12599 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12601 pos_before
= glyph
->charpos
;
12602 glyph_before
= glyph
;
12604 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12606 pos_after
= glyph
->charpos
;
12607 glyph_after
= glyph
;
12610 else if (dpos
== 0)
12611 match_with_avoid_cursor
= 1;
12613 else if (STRINGP (glyph
->object
))
12615 Lisp_Object chprop
;
12616 EMACS_INT glyph_pos
= glyph
->charpos
;
12618 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12620 if (INTEGERP (chprop
))
12622 bpos_covered
= bpos_max
+ XINT (chprop
);
12623 /* If the `cursor' property covers buffer positions up
12624 to and including point, we should display cursor on
12626 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12635 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12637 x
--; /* can't use any pixel_width */
12640 x
-= glyph
->pixel_width
;
12643 /* Step 2: If we didn't find an exact match for point, we need to
12644 look for a proper place to put the cursor among glyphs between
12645 GLYPH_BEFORE and GLYPH_AFTER. */
12646 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12647 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12648 && bpos_covered
< pt_old
)
12650 /* An empty line has a single glyph whose OBJECT is zero and
12651 whose CHARPOS is the position of a newline on that line.
12652 Note that on a TTY, there are more glyphs after that, which
12653 were produced by extend_face_to_end_of_line, but their
12654 CHARPOS is zero or negative. */
12656 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12657 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12659 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12661 EMACS_INT ellipsis_pos
;
12663 /* Scan back over the ellipsis glyphs. */
12664 if (!row
->reversed_p
)
12666 ellipsis_pos
= (glyph
- 1)->charpos
;
12667 while (glyph
> row
->glyphs
[TEXT_AREA
]
12668 && (glyph
- 1)->charpos
== ellipsis_pos
)
12669 glyph
--, x
-= glyph
->pixel_width
;
12670 /* That loop always goes one position too far, including
12671 the glyph before the ellipsis. So scan forward over
12673 x
+= glyph
->pixel_width
;
12676 else /* row is reversed */
12678 ellipsis_pos
= (glyph
+ 1)->charpos
;
12679 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12680 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12681 glyph
++, x
+= glyph
->pixel_width
;
12682 x
-= glyph
->pixel_width
;
12686 else if (match_with_avoid_cursor
12687 /* A truncated row may not include PT among its
12688 character positions. Setting the cursor inside the
12689 scroll margin will trigger recalculation of hscroll
12690 in hscroll_window_tree. */
12691 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12692 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12693 /* Zero-width characters produce no glyphs. */
12696 && (row
->reversed_p
12697 ? glyph_after
> glyphs_end
12698 : glyph_after
< glyphs_end
)))
12700 cursor
= glyph_after
;
12703 else if (string_seen
)
12705 int incr
= row
->reversed_p
? -1 : +1;
12707 /* Need to find the glyph that came out of a string which is
12708 present at point. That glyph is somewhere between
12709 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12710 positioned between POS_BEFORE and POS_AFTER in the
12712 struct glyph
*stop
= glyph_after
;
12713 EMACS_INT pos
= pos_before
;
12716 for (glyph
= glyph_before
+ incr
;
12717 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12720 /* Any glyphs that come from the buffer are here because
12721 of bidi reordering. Skip them, and only pay
12722 attention to glyphs that came from some string. */
12723 if (STRINGP (glyph
->object
))
12728 str
= glyph
->object
;
12729 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12730 if (tem
== 0 /* from overlay */
12733 /* If the string from which this glyph came is
12734 found in the buffer at point, then we've
12735 found the glyph we've been looking for. If
12736 it comes from an overlay (tem == 0), and it
12737 has the `cursor' property on one of its
12738 glyphs, record that glyph as a candidate for
12739 displaying the cursor. (As in the
12740 unidirectional version, we will display the
12741 cursor on the last candidate we find.) */
12742 if (tem
== 0 || tem
== pt_old
)
12744 /* The glyphs from this string could have
12745 been reordered. Find the one with the
12746 smallest string position. Or there could
12747 be a character in the string with the
12748 `cursor' property, which means display
12749 cursor on that character's glyph. */
12750 EMACS_INT strpos
= glyph
->charpos
;
12755 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12756 && EQ (glyph
->object
, str
);
12760 EMACS_INT gpos
= glyph
->charpos
;
12762 cprop
= Fget_char_property (make_number (gpos
),
12770 if (tem
&& glyph
->charpos
< strpos
)
12772 strpos
= glyph
->charpos
;
12781 pos
= tem
+ 1; /* don't find previous instances */
12783 /* This string is not what we want; skip all of the
12784 glyphs that came from it. */
12785 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12786 && EQ (glyph
->object
, str
))
12793 /* If we reached the end of the line, and END was from a string,
12794 the cursor is not on this line. */
12796 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12797 && STRINGP (end
->object
)
12798 && row
->continued_p
)
12804 if (cursor
!= NULL
)
12810 /* Need to compute x that corresponds to GLYPH. */
12811 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12813 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12815 x
+= g
->pixel_width
;
12819 /* ROW could be part of a continued line, which, under bidi
12820 reordering, might have other rows whose start and end charpos
12821 occlude point. Only set w->cursor if we found a better
12822 approximation to the cursor position than we have from previously
12823 examined candidate rows belonging to the same continued line. */
12824 if (/* we already have a candidate row */
12825 w
->cursor
.vpos
>= 0
12826 /* that candidate is not the row we are processing */
12827 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12828 /* the row we are processing is part of a continued line */
12829 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12830 /* Make sure cursor.vpos specifies a row whose start and end
12831 charpos occlude point. This is because some callers of this
12832 function leave cursor.vpos at the row where the cursor was
12833 displayed during the last redisplay cycle. */
12834 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12835 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12838 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12840 /* Don't consider glyphs that are outside TEXT_AREA. */
12841 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12843 /* Keep the candidate whose buffer position is the closest to
12845 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12846 w
->cursor
.hpos
>= 0
12847 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12848 && BUFFERP (g1
->object
)
12849 && (g1
->charpos
== pt_old
/* an exact match always wins */
12850 || (BUFFERP (glyph
->object
)
12851 && eabs (g1
->charpos
- pt_old
)
12852 < eabs (glyph
->charpos
- pt_old
))))
12854 /* If this candidate gives an exact match, use that. */
12855 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12856 /* Otherwise, keep the candidate that comes from a row
12857 spanning less buffer positions. This may win when one or
12858 both candidate positions are on glyphs that came from
12859 display strings, for which we cannot compare buffer
12861 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12862 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12863 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12866 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12868 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12869 w
->cursor
.y
= row
->y
+ dy
;
12871 if (w
== XWINDOW (selected_window
))
12873 if (!row
->continued_p
12874 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12877 this_line_buffer
= XBUFFER (w
->buffer
);
12879 CHARPOS (this_line_start_pos
)
12880 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12881 BYTEPOS (this_line_start_pos
)
12882 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12884 CHARPOS (this_line_end_pos
)
12885 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12886 BYTEPOS (this_line_end_pos
)
12887 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12889 this_line_y
= w
->cursor
.y
;
12890 this_line_pixel_height
= row
->height
;
12891 this_line_vpos
= w
->cursor
.vpos
;
12892 this_line_start_x
= row
->x
;
12895 CHARPOS (this_line_start_pos
) = 0;
12902 /* Run window scroll functions, if any, for WINDOW with new window
12903 start STARTP. Sets the window start of WINDOW to that position.
12905 We assume that the window's buffer is really current. */
12907 static INLINE
struct text_pos
12908 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12910 struct window
*w
= XWINDOW (window
);
12911 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12913 if (current_buffer
!= XBUFFER (w
->buffer
))
12916 if (!NILP (Vwindow_scroll_functions
))
12918 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12919 make_number (CHARPOS (startp
)));
12920 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12921 /* In case the hook functions switch buffers. */
12922 if (current_buffer
!= XBUFFER (w
->buffer
))
12923 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12930 /* Make sure the line containing the cursor is fully visible.
12931 A value of 1 means there is nothing to be done.
12932 (Either the line is fully visible, or it cannot be made so,
12933 or we cannot tell.)
12935 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12936 is higher than window.
12938 A value of 0 means the caller should do scrolling
12939 as if point had gone off the screen. */
12942 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12944 struct glyph_matrix
*matrix
;
12945 struct glyph_row
*row
;
12948 if (!make_cursor_line_fully_visible_p
)
12951 /* It's not always possible to find the cursor, e.g, when a window
12952 is full of overlay strings. Don't do anything in that case. */
12953 if (w
->cursor
.vpos
< 0)
12956 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12957 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12959 /* If the cursor row is not partially visible, there's nothing to do. */
12960 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12963 /* If the row the cursor is in is taller than the window's height,
12964 it's not clear what to do, so do nothing. */
12965 window_height
= window_box_height (w
);
12966 if (row
->height
>= window_height
)
12968 if (!force_p
|| MINI_WINDOW_P (w
)
12969 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12976 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12977 non-zero means only WINDOW is redisplayed in redisplay_internal.
12978 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12979 in redisplay_window to bring a partially visible line into view in
12980 the case that only the cursor has moved.
12982 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12983 last screen line's vertical height extends past the end of the screen.
12987 1 if scrolling succeeded
12989 0 if scrolling didn't find point.
12991 -1 if new fonts have been loaded so that we must interrupt
12992 redisplay, adjust glyph matrices, and try again. */
12998 SCROLLING_NEED_LARGER_MATRICES
13002 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13003 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13004 int temp_scroll_step
, int last_line_misfit
)
13006 struct window
*w
= XWINDOW (window
);
13007 struct frame
*f
= XFRAME (w
->frame
);
13008 struct text_pos pos
, startp
;
13010 int this_scroll_margin
, scroll_max
, rc
, height
;
13011 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13012 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13013 Lisp_Object aggressive
;
13014 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13017 debug_method_add (w
, "try_scrolling");
13020 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13022 /* Compute scroll margin height in pixels. We scroll when point is
13023 within this distance from the top or bottom of the window. */
13024 if (scroll_margin
> 0)
13025 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13026 * FRAME_LINE_HEIGHT (f
);
13028 this_scroll_margin
= 0;
13030 /* Force arg_scroll_conservatively to have a reasonable value, to avoid
13031 overflow while computing how much to scroll. Note that the user
13032 can supply scroll-conservatively equal to `most-positive-fixnum',
13033 which can be larger than INT_MAX. */
13034 if (arg_scroll_conservatively
> scroll_limit
)
13036 arg_scroll_conservatively
= scroll_limit
;
13037 scroll_max
= INT_MAX
;
13039 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13040 /* Compute how much we should try to scroll maximally to bring
13041 point into view. */
13042 scroll_max
= (max (scroll_step
,
13043 max (arg_scroll_conservatively
, temp_scroll_step
))
13044 * FRAME_LINE_HEIGHT (f
));
13045 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13046 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13047 /* We're trying to scroll because of aggressive scrolling but no
13048 scroll_step is set. Choose an arbitrary one. */
13049 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13055 /* Decide whether to scroll down. */
13056 if (PT
> CHARPOS (startp
))
13058 int scroll_margin_y
;
13060 /* Compute the pixel ypos of the scroll margin, then move it to
13061 either that ypos or PT, whichever comes first. */
13062 start_display (&it
, w
, startp
);
13063 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13064 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13065 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13066 (MOVE_TO_POS
| MOVE_TO_Y
));
13068 if (PT
> CHARPOS (it
.current
.pos
))
13070 int y0
= line_bottom_y (&it
);
13071 /* Compute how many pixels below window bottom to stop searching
13072 for PT. This avoids costly search for PT that is far away if
13073 the user limited scrolling by a small number of lines, but
13074 always finds PT if arg_scroll_conservatively is set to a large
13075 number, such as most-positive-fixnum. */
13076 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13078 slack
>= INT_MAX
- it
.last_visible_y
13080 : it
.last_visible_y
+ slack
;
13082 /* Compute the distance from the scroll margin to PT or to
13083 the scroll limit, whichever comes first. This should
13084 include the height of the cursor line, to make that line
13086 move_it_to (&it
, PT
, -1, y_to_move
,
13087 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13088 dy
= line_bottom_y (&it
) - y0
;
13090 if (dy
> scroll_max
)
13091 return SCROLLING_FAILED
;
13099 /* Point is in or below the bottom scroll margin, so move the
13100 window start down. If scrolling conservatively, move it just
13101 enough down to make point visible. If scroll_step is set,
13102 move it down by scroll_step. */
13103 if (arg_scroll_conservatively
)
13105 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13106 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13107 else if (scroll_step
|| temp_scroll_step
)
13108 amount_to_scroll
= scroll_max
;
13111 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13112 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13113 if (NUMBERP (aggressive
))
13115 double float_amount
= XFLOATINT (aggressive
) * height
;
13116 amount_to_scroll
= float_amount
;
13117 if (amount_to_scroll
== 0 && float_amount
> 0)
13118 amount_to_scroll
= 1;
13122 if (amount_to_scroll
<= 0)
13123 return SCROLLING_FAILED
;
13125 start_display (&it
, w
, startp
);
13126 if (scroll_max
< INT_MAX
)
13127 move_it_vertically (&it
, amount_to_scroll
);
13130 /* Extra precision for users who set scroll-conservatively
13131 to most-positive-fixnum: make sure the amount we scroll
13132 the window start is never less than amount_to_scroll,
13133 which was computed as distance from window bottom to
13134 point. This matters when lines at window top and lines
13135 below window bottom have different height. */
13136 struct it it1
= it
;
13137 /* We use a temporary it1 because line_bottom_y can modify
13138 its argument, if it moves one line down; see there. */
13139 int start_y
= line_bottom_y (&it1
);
13142 move_it_by_lines (&it
, 1, 1);
13144 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13147 /* If STARTP is unchanged, move it down another screen line. */
13148 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13149 move_it_by_lines (&it
, 1, 1);
13150 startp
= it
.current
.pos
;
13154 struct text_pos scroll_margin_pos
= startp
;
13156 /* See if point is inside the scroll margin at the top of the
13158 if (this_scroll_margin
)
13160 start_display (&it
, w
, startp
);
13161 move_it_vertically (&it
, this_scroll_margin
);
13162 scroll_margin_pos
= it
.current
.pos
;
13165 if (PT
< CHARPOS (scroll_margin_pos
))
13167 /* Point is in the scroll margin at the top of the window or
13168 above what is displayed in the window. */
13171 /* Compute the vertical distance from PT to the scroll
13172 margin position. Give up if distance is greater than
13174 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13175 start_display (&it
, w
, pos
);
13177 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13178 it
.last_visible_y
, -1,
13179 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13180 dy
= it
.current_y
- y0
;
13181 if (dy
> scroll_max
)
13182 return SCROLLING_FAILED
;
13184 /* Compute new window start. */
13185 start_display (&it
, w
, startp
);
13187 if (arg_scroll_conservatively
)
13189 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13190 else if (scroll_step
|| temp_scroll_step
)
13191 amount_to_scroll
= scroll_max
;
13194 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13195 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13196 if (NUMBERP (aggressive
))
13198 double float_amount
= XFLOATINT (aggressive
) * height
;
13199 amount_to_scroll
= float_amount
;
13200 if (amount_to_scroll
== 0 && float_amount
> 0)
13201 amount_to_scroll
= 1;
13205 if (amount_to_scroll
<= 0)
13206 return SCROLLING_FAILED
;
13208 move_it_vertically_backward (&it
, amount_to_scroll
);
13209 startp
= it
.current
.pos
;
13213 /* Run window scroll functions. */
13214 startp
= run_window_scroll_functions (window
, startp
);
13216 /* Display the window. Give up if new fonts are loaded, or if point
13218 if (!try_window (window
, startp
, 0))
13219 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13220 else if (w
->cursor
.vpos
< 0)
13222 clear_glyph_matrix (w
->desired_matrix
);
13223 rc
= SCROLLING_FAILED
;
13227 /* Maybe forget recorded base line for line number display. */
13228 if (!just_this_one_p
13229 || current_buffer
->clip_changed
13230 || BEG_UNCHANGED
< CHARPOS (startp
))
13231 w
->base_line_number
= Qnil
;
13233 /* If cursor ends up on a partially visible line,
13234 treat that as being off the bottom of the screen. */
13235 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13236 /* It's possible that the cursor is on the first line of the
13237 buffer, which is partially obscured due to a vscroll
13238 (Bug#7537). In that case, avoid looping forever . */
13239 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13241 clear_glyph_matrix (w
->desired_matrix
);
13242 ++extra_scroll_margin_lines
;
13245 rc
= SCROLLING_SUCCESS
;
13252 /* Compute a suitable window start for window W if display of W starts
13253 on a continuation line. Value is non-zero if a new window start
13256 The new window start will be computed, based on W's width, starting
13257 from the start of the continued line. It is the start of the
13258 screen line with the minimum distance from the old start W->start. */
13261 compute_window_start_on_continuation_line (struct window
*w
)
13263 struct text_pos pos
, start_pos
;
13264 int window_start_changed_p
= 0;
13266 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13268 /* If window start is on a continuation line... Window start may be
13269 < BEGV in case there's invisible text at the start of the
13270 buffer (M-x rmail, for example). */
13271 if (CHARPOS (start_pos
) > BEGV
13272 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13275 struct glyph_row
*row
;
13277 /* Handle the case that the window start is out of range. */
13278 if (CHARPOS (start_pos
) < BEGV
)
13279 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13280 else if (CHARPOS (start_pos
) > ZV
)
13281 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13283 /* Find the start of the continued line. This should be fast
13284 because scan_buffer is fast (newline cache). */
13285 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13286 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13287 row
, DEFAULT_FACE_ID
);
13288 reseat_at_previous_visible_line_start (&it
);
13290 /* If the line start is "too far" away from the window start,
13291 say it takes too much time to compute a new window start. */
13292 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13293 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13295 int min_distance
, distance
;
13297 /* Move forward by display lines to find the new window
13298 start. If window width was enlarged, the new start can
13299 be expected to be > the old start. If window width was
13300 decreased, the new window start will be < the old start.
13301 So, we're looking for the display line start with the
13302 minimum distance from the old window start. */
13303 pos
= it
.current
.pos
;
13304 min_distance
= INFINITY
;
13305 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13306 distance
< min_distance
)
13308 min_distance
= distance
;
13309 pos
= it
.current
.pos
;
13310 move_it_by_lines (&it
, 1, 0);
13313 /* Set the window start there. */
13314 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13315 window_start_changed_p
= 1;
13319 return window_start_changed_p
;
13323 /* Try cursor movement in case text has not changed in window WINDOW,
13324 with window start STARTP. Value is
13326 CURSOR_MOVEMENT_SUCCESS if successful
13328 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13330 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13331 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13332 we want to scroll as if scroll-step were set to 1. See the code.
13334 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13335 which case we have to abort this redisplay, and adjust matrices
13340 CURSOR_MOVEMENT_SUCCESS
,
13341 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13342 CURSOR_MOVEMENT_MUST_SCROLL
,
13343 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13347 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13349 struct window
*w
= XWINDOW (window
);
13350 struct frame
*f
= XFRAME (w
->frame
);
13351 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13354 if (inhibit_try_cursor_movement
)
13358 /* Handle case where text has not changed, only point, and it has
13359 not moved off the frame. */
13360 if (/* Point may be in this window. */
13361 PT
>= CHARPOS (startp
)
13362 /* Selective display hasn't changed. */
13363 && !current_buffer
->clip_changed
13364 /* Function force-mode-line-update is used to force a thorough
13365 redisplay. It sets either windows_or_buffers_changed or
13366 update_mode_lines. So don't take a shortcut here for these
13368 && !update_mode_lines
13369 && !windows_or_buffers_changed
13370 && !cursor_type_changed
13371 /* Can't use this case if highlighting a region. When a
13372 region exists, cursor movement has to do more than just
13374 && !(!NILP (Vtransient_mark_mode
)
13375 && !NILP (BVAR (current_buffer
, mark_active
)))
13376 && NILP (w
->region_showing
)
13377 && NILP (Vshow_trailing_whitespace
)
13378 /* Right after splitting windows, last_point may be nil. */
13379 && INTEGERP (w
->last_point
)
13380 /* This code is not used for mini-buffer for the sake of the case
13381 of redisplaying to replace an echo area message; since in
13382 that case the mini-buffer contents per se are usually
13383 unchanged. This code is of no real use in the mini-buffer
13384 since the handling of this_line_start_pos, etc., in redisplay
13385 handles the same cases. */
13386 && !EQ (window
, minibuf_window
)
13387 /* When splitting windows or for new windows, it happens that
13388 redisplay is called with a nil window_end_vpos or one being
13389 larger than the window. This should really be fixed in
13390 window.c. I don't have this on my list, now, so we do
13391 approximately the same as the old redisplay code. --gerd. */
13392 && INTEGERP (w
->window_end_vpos
)
13393 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13394 && (FRAME_WINDOW_P (f
)
13395 || !overlay_arrow_in_current_buffer_p ()))
13397 int this_scroll_margin
, top_scroll_margin
;
13398 struct glyph_row
*row
= NULL
;
13401 debug_method_add (w
, "cursor movement");
13404 /* Scroll if point within this distance from the top or bottom
13405 of the window. This is a pixel value. */
13406 if (scroll_margin
> 0)
13408 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13409 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13412 this_scroll_margin
= 0;
13414 top_scroll_margin
= this_scroll_margin
;
13415 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13416 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13418 /* Start with the row the cursor was displayed during the last
13419 not paused redisplay. Give up if that row is not valid. */
13420 if (w
->last_cursor
.vpos
< 0
13421 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13422 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13425 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13426 if (row
->mode_line_p
)
13428 if (!row
->enabled_p
)
13429 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13432 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13434 int scroll_p
= 0, must_scroll
= 0;
13435 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13437 if (PT
> XFASTINT (w
->last_point
))
13439 /* Point has moved forward. */
13440 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13441 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13443 xassert (row
->enabled_p
);
13447 /* If the end position of a row equals the start
13448 position of the next row, and PT is at that position,
13449 we would rather display cursor in the next line. */
13450 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13451 && MATRIX_ROW_END_CHARPOS (row
) == PT
13452 && row
< w
->current_matrix
->rows
13453 + w
->current_matrix
->nrows
- 1
13454 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13455 && !cursor_row_p (row
))
13458 /* If within the scroll margin, scroll. Note that
13459 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13460 the next line would be drawn, and that
13461 this_scroll_margin can be zero. */
13462 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13463 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13464 /* Line is completely visible last line in window
13465 and PT is to be set in the next line. */
13466 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13467 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13468 && !row
->ends_at_zv_p
13469 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13472 else if (PT
< XFASTINT (w
->last_point
))
13474 /* Cursor has to be moved backward. Note that PT >=
13475 CHARPOS (startp) because of the outer if-statement. */
13476 while (!row
->mode_line_p
13477 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13478 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13479 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13480 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13481 row
> w
->current_matrix
->rows
13482 && (row
-1)->ends_in_newline_from_string_p
))))
13483 && (row
->y
> top_scroll_margin
13484 || CHARPOS (startp
) == BEGV
))
13486 xassert (row
->enabled_p
);
13490 /* Consider the following case: Window starts at BEGV,
13491 there is invisible, intangible text at BEGV, so that
13492 display starts at some point START > BEGV. It can
13493 happen that we are called with PT somewhere between
13494 BEGV and START. Try to handle that case. */
13495 if (row
< w
->current_matrix
->rows
13496 || row
->mode_line_p
)
13498 row
= w
->current_matrix
->rows
;
13499 if (row
->mode_line_p
)
13503 /* Due to newlines in overlay strings, we may have to
13504 skip forward over overlay strings. */
13505 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13506 && MATRIX_ROW_END_CHARPOS (row
) == PT
13507 && !cursor_row_p (row
))
13510 /* If within the scroll margin, scroll. */
13511 if (row
->y
< top_scroll_margin
13512 && CHARPOS (startp
) != BEGV
)
13517 /* Cursor did not move. So don't scroll even if cursor line
13518 is partially visible, as it was so before. */
13519 rc
= CURSOR_MOVEMENT_SUCCESS
;
13522 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13523 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13525 /* if PT is not in the glyph row, give up. */
13526 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13529 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13530 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13532 /* If rows are bidi-reordered and point moved, back up
13533 until we find a row that does not belong to a
13534 continuation line. This is because we must consider
13535 all rows of a continued line as candidates for the
13536 new cursor positioning, since row start and end
13537 positions change non-linearly with vertical position
13539 /* FIXME: Revisit this when glyph ``spilling'' in
13540 continuation lines' rows is implemented for
13541 bidi-reordered rows. */
13542 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13544 xassert (row
->enabled_p
);
13546 /* If we hit the beginning of the displayed portion
13547 without finding the first row of a continued
13549 if (row
<= w
->current_matrix
->rows
)
13551 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13559 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13560 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13561 && make_cursor_line_fully_visible_p
)
13563 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13564 && !row
->ends_at_zv_p
13565 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13566 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13567 else if (row
->height
> window_box_height (w
))
13569 /* If we end up in a partially visible line, let's
13570 make it fully visible, except when it's taller
13571 than the window, in which case we can't do much
13574 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13578 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13579 if (!cursor_row_fully_visible_p (w
, 0, 1))
13580 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13582 rc
= CURSOR_MOVEMENT_SUCCESS
;
13586 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13587 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13588 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13590 /* With bidi-reordered rows, there could be more than
13591 one candidate row whose start and end positions
13592 occlude point. We need to let set_cursor_from_row
13593 find the best candidate. */
13594 /* FIXME: Revisit this when glyph ``spilling'' in
13595 continuation lines' rows is implemented for
13596 bidi-reordered rows. */
13601 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13602 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13603 && cursor_row_p (row
))
13604 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13606 /* As soon as we've found the first suitable row
13607 whose ends_at_zv_p flag is set, we are done. */
13609 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13611 rc
= CURSOR_MOVEMENT_SUCCESS
;
13616 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13617 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13618 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13619 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13620 /* If we didn't find any candidate rows, or exited the
13621 loop before all the candidates were examined, signal
13622 to the caller that this method failed. */
13623 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13624 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13625 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13627 rc
= CURSOR_MOVEMENT_SUCCESS
;
13633 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13635 rc
= CURSOR_MOVEMENT_SUCCESS
;
13640 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13641 && MATRIX_ROW_START_CHARPOS (row
) == PT
13642 && cursor_row_p (row
));
13651 set_vertical_scroll_bar (struct window
*w
)
13653 EMACS_INT start
, end
, whole
;
13655 /* Calculate the start and end positions for the current window.
13656 At some point, it would be nice to choose between scrollbars
13657 which reflect the whole buffer size, with special markers
13658 indicating narrowing, and scrollbars which reflect only the
13661 Note that mini-buffers sometimes aren't displaying any text. */
13662 if (!MINI_WINDOW_P (w
)
13663 || (w
== XWINDOW (minibuf_window
)
13664 && NILP (echo_area_buffer
[0])))
13666 struct buffer
*buf
= XBUFFER (w
->buffer
);
13667 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13668 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13669 /* I don't think this is guaranteed to be right. For the
13670 moment, we'll pretend it is. */
13671 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13675 if (whole
< (end
- start
))
13676 whole
= end
- start
;
13679 start
= end
= whole
= 0;
13681 /* Indicate what this scroll bar ought to be displaying now. */
13682 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13683 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13684 (w
, end
- start
, whole
, start
);
13688 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13689 selected_window is redisplayed.
13691 We can return without actually redisplaying the window if
13692 fonts_changed_p is nonzero. In that case, redisplay_internal will
13696 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13698 struct window
*w
= XWINDOW (window
);
13699 struct frame
*f
= XFRAME (w
->frame
);
13700 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13701 struct buffer
*old
= current_buffer
;
13702 struct text_pos lpoint
, opoint
, startp
;
13703 int update_mode_line
;
13706 /* Record it now because it's overwritten. */
13707 int current_matrix_up_to_date_p
= 0;
13708 int used_current_matrix_p
= 0;
13709 /* This is less strict than current_matrix_up_to_date_p.
13710 It indictes that the buffer contents and narrowing are unchanged. */
13711 int buffer_unchanged_p
= 0;
13712 int temp_scroll_step
= 0;
13713 int count
= SPECPDL_INDEX ();
13715 int centering_position
= -1;
13716 int last_line_misfit
= 0;
13717 EMACS_INT beg_unchanged
, end_unchanged
;
13719 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13722 /* W must be a leaf window here. */
13723 xassert (!NILP (w
->buffer
));
13725 *w
->desired_matrix
->method
= 0;
13729 reconsider_clip_changes (w
, buffer
);
13731 /* Has the mode line to be updated? */
13732 update_mode_line
= (!NILP (w
->update_mode_line
)
13733 || update_mode_lines
13734 || buffer
->clip_changed
13735 || buffer
->prevent_redisplay_optimizations_p
);
13737 if (MINI_WINDOW_P (w
))
13739 if (w
== XWINDOW (echo_area_window
)
13740 && !NILP (echo_area_buffer
[0]))
13742 if (update_mode_line
)
13743 /* We may have to update a tty frame's menu bar or a
13744 tool-bar. Example `M-x C-h C-h C-g'. */
13745 goto finish_menu_bars
;
13747 /* We've already displayed the echo area glyphs in this window. */
13748 goto finish_scroll_bars
;
13750 else if ((w
!= XWINDOW (minibuf_window
)
13751 || minibuf_level
== 0)
13752 /* When buffer is nonempty, redisplay window normally. */
13753 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13754 /* Quail displays non-mini buffers in minibuffer window.
13755 In that case, redisplay the window normally. */
13756 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13758 /* W is a mini-buffer window, but it's not active, so clear
13760 int yb
= window_text_bottom_y (w
);
13761 struct glyph_row
*row
;
13764 for (y
= 0, row
= w
->desired_matrix
->rows
;
13766 y
+= row
->height
, ++row
)
13767 blank_row (w
, row
, y
);
13768 goto finish_scroll_bars
;
13771 clear_glyph_matrix (w
->desired_matrix
);
13774 /* Otherwise set up data on this window; select its buffer and point
13776 /* Really select the buffer, for the sake of buffer-local
13778 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13780 current_matrix_up_to_date_p
13781 = (!NILP (w
->window_end_valid
)
13782 && !current_buffer
->clip_changed
13783 && !current_buffer
->prevent_redisplay_optimizations_p
13784 && XFASTINT (w
->last_modified
) >= MODIFF
13785 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13787 /* Run the window-bottom-change-functions
13788 if it is possible that the text on the screen has changed
13789 (either due to modification of the text, or any other reason). */
13790 if (!current_matrix_up_to_date_p
13791 && !NILP (Vwindow_text_change_functions
))
13793 safe_run_hooks (Qwindow_text_change_functions
);
13797 beg_unchanged
= BEG_UNCHANGED
;
13798 end_unchanged
= END_UNCHANGED
;
13800 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13802 specbind (Qinhibit_point_motion_hooks
, Qt
);
13805 = (!NILP (w
->window_end_valid
)
13806 && !current_buffer
->clip_changed
13807 && XFASTINT (w
->last_modified
) >= MODIFF
13808 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13810 /* When windows_or_buffers_changed is non-zero, we can't rely on
13811 the window end being valid, so set it to nil there. */
13812 if (windows_or_buffers_changed
)
13814 /* If window starts on a continuation line, maybe adjust the
13815 window start in case the window's width changed. */
13816 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13817 compute_window_start_on_continuation_line (w
);
13819 w
->window_end_valid
= Qnil
;
13822 /* Some sanity checks. */
13823 CHECK_WINDOW_END (w
);
13824 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13826 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13829 /* If %c is in mode line, update it if needed. */
13830 if (!NILP (w
->column_number_displayed
)
13831 /* This alternative quickly identifies a common case
13832 where no change is needed. */
13833 && !(PT
== XFASTINT (w
->last_point
)
13834 && XFASTINT (w
->last_modified
) >= MODIFF
13835 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13836 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13837 update_mode_line
= 1;
13839 /* Count number of windows showing the selected buffer. An indirect
13840 buffer counts as its base buffer. */
13841 if (!just_this_one_p
)
13843 struct buffer
*current_base
, *window_base
;
13844 current_base
= current_buffer
;
13845 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13846 if (current_base
->base_buffer
)
13847 current_base
= current_base
->base_buffer
;
13848 if (window_base
->base_buffer
)
13849 window_base
= window_base
->base_buffer
;
13850 if (current_base
== window_base
)
13854 /* Point refers normally to the selected window. For any other
13855 window, set up appropriate value. */
13856 if (!EQ (window
, selected_window
))
13858 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13859 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13863 new_pt_byte
= BEGV_BYTE
;
13864 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13866 else if (new_pt
> (ZV
- 1))
13869 new_pt_byte
= ZV_BYTE
;
13870 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13873 /* We don't use SET_PT so that the point-motion hooks don't run. */
13874 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13877 /* If any of the character widths specified in the display table
13878 have changed, invalidate the width run cache. It's true that
13879 this may be a bit late to catch such changes, but the rest of
13880 redisplay goes (non-fatally) haywire when the display table is
13881 changed, so why should we worry about doing any better? */
13882 if (current_buffer
->width_run_cache
)
13884 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13886 if (! disptab_matches_widthtab (disptab
,
13887 XVECTOR (BVAR (current_buffer
, width_table
))))
13889 invalidate_region_cache (current_buffer
,
13890 current_buffer
->width_run_cache
,
13892 recompute_width_table (current_buffer
, disptab
);
13896 /* If window-start is screwed up, choose a new one. */
13897 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13900 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13902 /* If someone specified a new starting point but did not insist,
13903 check whether it can be used. */
13904 if (!NILP (w
->optional_new_start
)
13905 && CHARPOS (startp
) >= BEGV
13906 && CHARPOS (startp
) <= ZV
)
13908 w
->optional_new_start
= Qnil
;
13909 start_display (&it
, w
, startp
);
13910 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13911 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13912 if (IT_CHARPOS (it
) == PT
)
13913 w
->force_start
= Qt
;
13914 /* IT may overshoot PT if text at PT is invisible. */
13915 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13916 w
->force_start
= Qt
;
13921 /* Handle case where place to start displaying has been specified,
13922 unless the specified location is outside the accessible range. */
13923 if (!NILP (w
->force_start
)
13924 || w
->frozen_window_start_p
)
13926 /* We set this later on if we have to adjust point. */
13929 w
->force_start
= Qnil
;
13931 w
->window_end_valid
= Qnil
;
13933 /* Forget any recorded base line for line number display. */
13934 if (!buffer_unchanged_p
)
13935 w
->base_line_number
= Qnil
;
13937 /* Redisplay the mode line. Select the buffer properly for that.
13938 Also, run the hook window-scroll-functions
13939 because we have scrolled. */
13940 /* Note, we do this after clearing force_start because
13941 if there's an error, it is better to forget about force_start
13942 than to get into an infinite loop calling the hook functions
13943 and having them get more errors. */
13944 if (!update_mode_line
13945 || ! NILP (Vwindow_scroll_functions
))
13947 update_mode_line
= 1;
13948 w
->update_mode_line
= Qt
;
13949 startp
= run_window_scroll_functions (window
, startp
);
13952 w
->last_modified
= make_number (0);
13953 w
->last_overlay_modified
= make_number (0);
13954 if (CHARPOS (startp
) < BEGV
)
13955 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13956 else if (CHARPOS (startp
) > ZV
)
13957 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13959 /* Redisplay, then check if cursor has been set during the
13960 redisplay. Give up if new fonts were loaded. */
13961 /* We used to issue a CHECK_MARGINS argument to try_window here,
13962 but this causes scrolling to fail when point begins inside
13963 the scroll margin (bug#148) -- cyd */
13964 if (!try_window (window
, startp
, 0))
13966 w
->force_start
= Qt
;
13967 clear_glyph_matrix (w
->desired_matrix
);
13968 goto need_larger_matrices
;
13971 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13973 /* If point does not appear, try to move point so it does
13974 appear. The desired matrix has been built above, so we
13975 can use it here. */
13976 new_vpos
= window_box_height (w
) / 2;
13979 if (!cursor_row_fully_visible_p (w
, 0, 0))
13981 /* Point does appear, but on a line partly visible at end of window.
13982 Move it back to a fully-visible line. */
13983 new_vpos
= window_box_height (w
);
13986 /* If we need to move point for either of the above reasons,
13987 now actually do it. */
13990 struct glyph_row
*row
;
13992 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13993 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13996 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13997 MATRIX_ROW_START_BYTEPOS (row
));
13999 if (w
!= XWINDOW (selected_window
))
14000 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14001 else if (current_buffer
== old
)
14002 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14004 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14006 /* If we are highlighting the region, then we just changed
14007 the region, so redisplay to show it. */
14008 if (!NILP (Vtransient_mark_mode
)
14009 && !NILP (BVAR (current_buffer
, mark_active
)))
14011 clear_glyph_matrix (w
->desired_matrix
);
14012 if (!try_window (window
, startp
, 0))
14013 goto need_larger_matrices
;
14018 debug_method_add (w
, "forced window start");
14023 /* Handle case where text has not changed, only point, and it has
14024 not moved off the frame, and we are not retrying after hscroll.
14025 (current_matrix_up_to_date_p is nonzero when retrying.) */
14026 if (current_matrix_up_to_date_p
14027 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14028 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14032 case CURSOR_MOVEMENT_SUCCESS
:
14033 used_current_matrix_p
= 1;
14036 case CURSOR_MOVEMENT_MUST_SCROLL
:
14037 goto try_to_scroll
;
14043 /* If current starting point was originally the beginning of a line
14044 but no longer is, find a new starting point. */
14045 else if (!NILP (w
->start_at_line_beg
)
14046 && !(CHARPOS (startp
) <= BEGV
14047 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14050 debug_method_add (w
, "recenter 1");
14055 /* Try scrolling with try_window_id. Value is > 0 if update has
14056 been done, it is -1 if we know that the same window start will
14057 not work. It is 0 if unsuccessful for some other reason. */
14058 else if ((tem
= try_window_id (w
)) != 0)
14061 debug_method_add (w
, "try_window_id %d", tem
);
14064 if (fonts_changed_p
)
14065 goto need_larger_matrices
;
14069 /* Otherwise try_window_id has returned -1 which means that we
14070 don't want the alternative below this comment to execute. */
14072 else if (CHARPOS (startp
) >= BEGV
14073 && CHARPOS (startp
) <= ZV
14074 && PT
>= CHARPOS (startp
)
14075 && (CHARPOS (startp
) < ZV
14076 /* Avoid starting at end of buffer. */
14077 || CHARPOS (startp
) == BEGV
14078 || (XFASTINT (w
->last_modified
) >= MODIFF
14079 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14082 /* If first window line is a continuation line, and window start
14083 is inside the modified region, but the first change is before
14084 current window start, we must select a new window start.
14086 However, if this is the result of a down-mouse event (e.g. by
14087 extending the mouse-drag-overlay), we don't want to select a
14088 new window start, since that would change the position under
14089 the mouse, resulting in an unwanted mouse-movement rather
14090 than a simple mouse-click. */
14091 if (NILP (w
->start_at_line_beg
)
14092 && NILP (do_mouse_tracking
)
14093 && CHARPOS (startp
) > BEGV
14094 && CHARPOS (startp
) > BEG
+ beg_unchanged
14095 && CHARPOS (startp
) <= Z
- end_unchanged
14096 /* Even if w->start_at_line_beg is nil, a new window may
14097 start at a line_beg, since that's how set_buffer_window
14098 sets it. So, we need to check the return value of
14099 compute_window_start_on_continuation_line. (See also
14101 && XMARKER (w
->start
)->buffer
== current_buffer
14102 && compute_window_start_on_continuation_line (w
))
14104 w
->force_start
= Qt
;
14105 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14110 debug_method_add (w
, "same window start");
14113 /* Try to redisplay starting at same place as before.
14114 If point has not moved off frame, accept the results. */
14115 if (!current_matrix_up_to_date_p
14116 /* Don't use try_window_reusing_current_matrix in this case
14117 because a window scroll function can have changed the
14119 || !NILP (Vwindow_scroll_functions
)
14120 || MINI_WINDOW_P (w
)
14121 || !(used_current_matrix_p
14122 = try_window_reusing_current_matrix (w
)))
14124 IF_DEBUG (debug_method_add (w
, "1"));
14125 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14126 /* -1 means we need to scroll.
14127 0 means we need new matrices, but fonts_changed_p
14128 is set in that case, so we will detect it below. */
14129 goto try_to_scroll
;
14132 if (fonts_changed_p
)
14133 goto need_larger_matrices
;
14135 if (w
->cursor
.vpos
>= 0)
14137 if (!just_this_one_p
14138 || current_buffer
->clip_changed
14139 || BEG_UNCHANGED
< CHARPOS (startp
))
14140 /* Forget any recorded base line for line number display. */
14141 w
->base_line_number
= Qnil
;
14143 if (!cursor_row_fully_visible_p (w
, 1, 0))
14145 clear_glyph_matrix (w
->desired_matrix
);
14146 last_line_misfit
= 1;
14148 /* Drop through and scroll. */
14153 clear_glyph_matrix (w
->desired_matrix
);
14158 w
->last_modified
= make_number (0);
14159 w
->last_overlay_modified
= make_number (0);
14161 /* Redisplay the mode line. Select the buffer properly for that. */
14162 if (!update_mode_line
)
14164 update_mode_line
= 1;
14165 w
->update_mode_line
= Qt
;
14168 /* Try to scroll by specified few lines. */
14169 if ((scroll_conservatively
14170 || emacs_scroll_step
14171 || temp_scroll_step
14172 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14173 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14174 && CHARPOS (startp
) >= BEGV
14175 && CHARPOS (startp
) <= ZV
)
14177 /* The function returns -1 if new fonts were loaded, 1 if
14178 successful, 0 if not successful. */
14179 int ss
= try_scrolling (window
, just_this_one_p
,
14180 scroll_conservatively
,
14182 temp_scroll_step
, last_line_misfit
);
14185 case SCROLLING_SUCCESS
:
14188 case SCROLLING_NEED_LARGER_MATRICES
:
14189 goto need_larger_matrices
;
14191 case SCROLLING_FAILED
:
14199 /* Finally, just choose place to start which centers point */
14202 if (centering_position
< 0)
14203 centering_position
= window_box_height (w
) / 2;
14206 debug_method_add (w
, "recenter");
14209 /* w->vscroll = 0; */
14211 /* Forget any previously recorded base line for line number display. */
14212 if (!buffer_unchanged_p
)
14213 w
->base_line_number
= Qnil
;
14215 /* Move backward half the height of the window. */
14216 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14217 it
.current_y
= it
.last_visible_y
;
14218 move_it_vertically_backward (&it
, centering_position
);
14219 xassert (IT_CHARPOS (it
) >= BEGV
);
14221 /* The function move_it_vertically_backward may move over more
14222 than the specified y-distance. If it->w is small, e.g. a
14223 mini-buffer window, we may end up in front of the window's
14224 display area. Start displaying at the start of the line
14225 containing PT in this case. */
14226 if (it
.current_y
<= 0)
14228 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14229 move_it_vertically_backward (&it
, 0);
14233 it
.current_x
= it
.hpos
= 0;
14235 /* Set startp here explicitly in case that helps avoid an infinite loop
14236 in case the window-scroll-functions functions get errors. */
14237 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14239 /* Run scroll hooks. */
14240 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14242 /* Redisplay the window. */
14243 if (!current_matrix_up_to_date_p
14244 || windows_or_buffers_changed
14245 || cursor_type_changed
14246 /* Don't use try_window_reusing_current_matrix in this case
14247 because it can have changed the buffer. */
14248 || !NILP (Vwindow_scroll_functions
)
14249 || !just_this_one_p
14250 || MINI_WINDOW_P (w
)
14251 || !(used_current_matrix_p
14252 = try_window_reusing_current_matrix (w
)))
14253 try_window (window
, startp
, 0);
14255 /* If new fonts have been loaded (due to fontsets), give up. We
14256 have to start a new redisplay since we need to re-adjust glyph
14258 if (fonts_changed_p
)
14259 goto need_larger_matrices
;
14261 /* If cursor did not appear assume that the middle of the window is
14262 in the first line of the window. Do it again with the next line.
14263 (Imagine a window of height 100, displaying two lines of height
14264 60. Moving back 50 from it->last_visible_y will end in the first
14266 if (w
->cursor
.vpos
< 0)
14268 if (!NILP (w
->window_end_valid
)
14269 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14271 clear_glyph_matrix (w
->desired_matrix
);
14272 move_it_by_lines (&it
, 1, 0);
14273 try_window (window
, it
.current
.pos
, 0);
14275 else if (PT
< IT_CHARPOS (it
))
14277 clear_glyph_matrix (w
->desired_matrix
);
14278 move_it_by_lines (&it
, -1, 0);
14279 try_window (window
, it
.current
.pos
, 0);
14283 /* Not much we can do about it. */
14287 /* Consider the following case: Window starts at BEGV, there is
14288 invisible, intangible text at BEGV, so that display starts at
14289 some point START > BEGV. It can happen that we are called with
14290 PT somewhere between BEGV and START. Try to handle that case. */
14291 if (w
->cursor
.vpos
< 0)
14293 struct glyph_row
*row
= w
->current_matrix
->rows
;
14294 if (row
->mode_line_p
)
14296 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14299 if (!cursor_row_fully_visible_p (w
, 0, 0))
14301 /* If vscroll is enabled, disable it and try again. */
14305 clear_glyph_matrix (w
->desired_matrix
);
14309 /* If centering point failed to make the whole line visible,
14310 put point at the top instead. That has to make the whole line
14311 visible, if it can be done. */
14312 if (centering_position
== 0)
14315 clear_glyph_matrix (w
->desired_matrix
);
14316 centering_position
= 0;
14322 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14323 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14324 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14327 /* Display the mode line, if we must. */
14328 if ((update_mode_line
14329 /* If window not full width, must redo its mode line
14330 if (a) the window to its side is being redone and
14331 (b) we do a frame-based redisplay. This is a consequence
14332 of how inverted lines are drawn in frame-based redisplay. */
14333 || (!just_this_one_p
14334 && !FRAME_WINDOW_P (f
)
14335 && !WINDOW_FULL_WIDTH_P (w
))
14336 /* Line number to display. */
14337 || INTEGERP (w
->base_line_pos
)
14338 /* Column number is displayed and different from the one displayed. */
14339 || (!NILP (w
->column_number_displayed
)
14340 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14341 /* This means that the window has a mode line. */
14342 && (WINDOW_WANTS_MODELINE_P (w
)
14343 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14345 display_mode_lines (w
);
14347 /* If mode line height has changed, arrange for a thorough
14348 immediate redisplay using the correct mode line height. */
14349 if (WINDOW_WANTS_MODELINE_P (w
)
14350 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14352 fonts_changed_p
= 1;
14353 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14354 = DESIRED_MODE_LINE_HEIGHT (w
);
14357 /* If header line height has changed, arrange for a thorough
14358 immediate redisplay using the correct header line height. */
14359 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14360 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14362 fonts_changed_p
= 1;
14363 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14364 = DESIRED_HEADER_LINE_HEIGHT (w
);
14367 if (fonts_changed_p
)
14368 goto need_larger_matrices
;
14371 if (!line_number_displayed
14372 && !BUFFERP (w
->base_line_pos
))
14374 w
->base_line_pos
= Qnil
;
14375 w
->base_line_number
= Qnil
;
14380 /* When we reach a frame's selected window, redo the frame's menu bar. */
14381 if (update_mode_line
14382 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14384 int redisplay_menu_p
= 0;
14385 int redisplay_tool_bar_p
= 0;
14387 if (FRAME_WINDOW_P (f
))
14389 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14390 || defined (HAVE_NS) || defined (USE_GTK)
14391 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14393 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14397 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14399 if (redisplay_menu_p
)
14400 display_menu_bar (w
);
14402 #ifdef HAVE_WINDOW_SYSTEM
14403 if (FRAME_WINDOW_P (f
))
14405 #if defined (USE_GTK) || defined (HAVE_NS)
14406 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14408 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14409 && (FRAME_TOOL_BAR_LINES (f
) > 0
14410 || !NILP (Vauto_resize_tool_bars
));
14413 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14415 ignore_mouse_drag_p
= 1;
14421 #ifdef HAVE_WINDOW_SYSTEM
14422 if (FRAME_WINDOW_P (f
)
14423 && update_window_fringes (w
, (just_this_one_p
14424 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14425 || w
->pseudo_window_p
)))
14429 if (draw_window_fringes (w
, 1))
14430 x_draw_vertical_border (w
);
14434 #endif /* HAVE_WINDOW_SYSTEM */
14436 /* We go to this label, with fonts_changed_p nonzero,
14437 if it is necessary to try again using larger glyph matrices.
14438 We have to redeem the scroll bar even in this case,
14439 because the loop in redisplay_internal expects that. */
14440 need_larger_matrices
:
14442 finish_scroll_bars
:
14444 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14446 /* Set the thumb's position and size. */
14447 set_vertical_scroll_bar (w
);
14449 /* Note that we actually used the scroll bar attached to this
14450 window, so it shouldn't be deleted at the end of redisplay. */
14451 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14452 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14455 /* Restore current_buffer and value of point in it. The window
14456 update may have changed the buffer, so first make sure `opoint'
14457 is still valid (Bug#6177). */
14458 if (CHARPOS (opoint
) < BEGV
)
14459 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14460 else if (CHARPOS (opoint
) > ZV
)
14461 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14463 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14465 set_buffer_internal_1 (old
);
14466 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14467 shorter. This can be caused by log truncation in *Messages*. */
14468 if (CHARPOS (lpoint
) <= ZV
)
14469 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14471 unbind_to (count
, Qnil
);
14475 /* Build the complete desired matrix of WINDOW with a window start
14476 buffer position POS.
14478 Value is 1 if successful. It is zero if fonts were loaded during
14479 redisplay which makes re-adjusting glyph matrices necessary, and -1
14480 if point would appear in the scroll margins.
14481 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14482 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14486 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14488 struct window
*w
= XWINDOW (window
);
14490 struct glyph_row
*last_text_row
= NULL
;
14491 struct frame
*f
= XFRAME (w
->frame
);
14493 /* Make POS the new window start. */
14494 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14496 /* Mark cursor position as unknown. No overlay arrow seen. */
14497 w
->cursor
.vpos
= -1;
14498 overlay_arrow_seen
= 0;
14500 /* Initialize iterator and info to start at POS. */
14501 start_display (&it
, w
, pos
);
14503 /* Display all lines of W. */
14504 while (it
.current_y
< it
.last_visible_y
)
14506 if (display_line (&it
))
14507 last_text_row
= it
.glyph_row
- 1;
14508 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14512 /* Don't let the cursor end in the scroll margins. */
14513 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14514 && !MINI_WINDOW_P (w
))
14516 int this_scroll_margin
;
14518 if (scroll_margin
> 0)
14520 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14521 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14524 this_scroll_margin
= 0;
14526 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14527 && w
->cursor
.y
< this_scroll_margin
14528 && CHARPOS (pos
) > BEGV
14529 && IT_CHARPOS (it
) < ZV
)
14530 /* rms: considering make_cursor_line_fully_visible_p here
14531 seems to give wrong results. We don't want to recenter
14532 when the last line is partly visible, we want to allow
14533 that case to be handled in the usual way. */
14534 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14536 w
->cursor
.vpos
= -1;
14537 clear_glyph_matrix (w
->desired_matrix
);
14542 /* If bottom moved off end of frame, change mode line percentage. */
14543 if (XFASTINT (w
->window_end_pos
) <= 0
14544 && Z
!= IT_CHARPOS (it
))
14545 w
->update_mode_line
= Qt
;
14547 /* Set window_end_pos to the offset of the last character displayed
14548 on the window from the end of current_buffer. Set
14549 window_end_vpos to its row number. */
14552 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14553 w
->window_end_bytepos
14554 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14556 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14558 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14559 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14560 ->displays_text_p
);
14564 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14565 w
->window_end_pos
= make_number (Z
- ZV
);
14566 w
->window_end_vpos
= make_number (0);
14569 /* But that is not valid info until redisplay finishes. */
14570 w
->window_end_valid
= Qnil
;
14576 /************************************************************************
14577 Window redisplay reusing current matrix when buffer has not changed
14578 ************************************************************************/
14580 /* Try redisplay of window W showing an unchanged buffer with a
14581 different window start than the last time it was displayed by
14582 reusing its current matrix. Value is non-zero if successful.
14583 W->start is the new window start. */
14586 try_window_reusing_current_matrix (struct window
*w
)
14588 struct frame
*f
= XFRAME (w
->frame
);
14589 struct glyph_row
*bottom_row
;
14592 struct text_pos start
, new_start
;
14593 int nrows_scrolled
, i
;
14594 struct glyph_row
*last_text_row
;
14595 struct glyph_row
*last_reused_text_row
;
14596 struct glyph_row
*start_row
;
14597 int start_vpos
, min_y
, max_y
;
14600 if (inhibit_try_window_reusing
)
14604 if (/* This function doesn't handle terminal frames. */
14605 !FRAME_WINDOW_P (f
)
14606 /* Don't try to reuse the display if windows have been split
14608 || windows_or_buffers_changed
14609 || cursor_type_changed
)
14612 /* Can't do this if region may have changed. */
14613 if ((!NILP (Vtransient_mark_mode
)
14614 && !NILP (BVAR (current_buffer
, mark_active
)))
14615 || !NILP (w
->region_showing
)
14616 || !NILP (Vshow_trailing_whitespace
))
14619 /* If top-line visibility has changed, give up. */
14620 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14621 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14624 /* Give up if old or new display is scrolled vertically. We could
14625 make this function handle this, but right now it doesn't. */
14626 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14627 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14630 /* The variable new_start now holds the new window start. The old
14631 start `start' can be determined from the current matrix. */
14632 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14633 start
= start_row
->minpos
;
14634 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14636 /* Clear the desired matrix for the display below. */
14637 clear_glyph_matrix (w
->desired_matrix
);
14639 if (CHARPOS (new_start
) <= CHARPOS (start
))
14641 /* Don't use this method if the display starts with an ellipsis
14642 displayed for invisible text. It's not easy to handle that case
14643 below, and it's certainly not worth the effort since this is
14644 not a frequent case. */
14645 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14648 IF_DEBUG (debug_method_add (w
, "twu1"));
14650 /* Display up to a row that can be reused. The variable
14651 last_text_row is set to the last row displayed that displays
14652 text. Note that it.vpos == 0 if or if not there is a
14653 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14654 start_display (&it
, w
, new_start
);
14655 w
->cursor
.vpos
= -1;
14656 last_text_row
= last_reused_text_row
= NULL
;
14658 while (it
.current_y
< it
.last_visible_y
14659 && !fonts_changed_p
)
14661 /* If we have reached into the characters in the START row,
14662 that means the line boundaries have changed. So we
14663 can't start copying with the row START. Maybe it will
14664 work to start copying with the following row. */
14665 while (IT_CHARPOS (it
) > CHARPOS (start
))
14667 /* Advance to the next row as the "start". */
14669 start
= start_row
->minpos
;
14670 /* If there are no more rows to try, or just one, give up. */
14671 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14672 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14673 || CHARPOS (start
) == ZV
)
14675 clear_glyph_matrix (w
->desired_matrix
);
14679 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14681 /* If we have reached alignment,
14682 we can copy the rest of the rows. */
14683 if (IT_CHARPOS (it
) == CHARPOS (start
))
14686 if (display_line (&it
))
14687 last_text_row
= it
.glyph_row
- 1;
14690 /* A value of current_y < last_visible_y means that we stopped
14691 at the previous window start, which in turn means that we
14692 have at least one reusable row. */
14693 if (it
.current_y
< it
.last_visible_y
)
14695 struct glyph_row
*row
;
14697 /* IT.vpos always starts from 0; it counts text lines. */
14698 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14700 /* Find PT if not already found in the lines displayed. */
14701 if (w
->cursor
.vpos
< 0)
14703 int dy
= it
.current_y
- start_row
->y
;
14705 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14706 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14708 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14709 dy
, nrows_scrolled
);
14712 clear_glyph_matrix (w
->desired_matrix
);
14717 /* Scroll the display. Do it before the current matrix is
14718 changed. The problem here is that update has not yet
14719 run, i.e. part of the current matrix is not up to date.
14720 scroll_run_hook will clear the cursor, and use the
14721 current matrix to get the height of the row the cursor is
14723 run
.current_y
= start_row
->y
;
14724 run
.desired_y
= it
.current_y
;
14725 run
.height
= it
.last_visible_y
- it
.current_y
;
14727 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14730 FRAME_RIF (f
)->update_window_begin_hook (w
);
14731 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14732 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14733 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14737 /* Shift current matrix down by nrows_scrolled lines. */
14738 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14739 rotate_matrix (w
->current_matrix
,
14741 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14744 /* Disable lines that must be updated. */
14745 for (i
= 0; i
< nrows_scrolled
; ++i
)
14746 (start_row
+ i
)->enabled_p
= 0;
14748 /* Re-compute Y positions. */
14749 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14750 max_y
= it
.last_visible_y
;
14751 for (row
= start_row
+ nrows_scrolled
;
14755 row
->y
= it
.current_y
;
14756 row
->visible_height
= row
->height
;
14758 if (row
->y
< min_y
)
14759 row
->visible_height
-= min_y
- row
->y
;
14760 if (row
->y
+ row
->height
> max_y
)
14761 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14762 row
->redraw_fringe_bitmaps_p
= 1;
14764 it
.current_y
+= row
->height
;
14766 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14767 last_reused_text_row
= row
;
14768 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14772 /* Disable lines in the current matrix which are now
14773 below the window. */
14774 for (++row
; row
< bottom_row
; ++row
)
14775 row
->enabled_p
= row
->mode_line_p
= 0;
14778 /* Update window_end_pos etc.; last_reused_text_row is the last
14779 reused row from the current matrix containing text, if any.
14780 The value of last_text_row is the last displayed line
14781 containing text. */
14782 if (last_reused_text_row
)
14784 w
->window_end_bytepos
14785 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14787 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14789 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14790 w
->current_matrix
));
14792 else if (last_text_row
)
14794 w
->window_end_bytepos
14795 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14797 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14799 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14803 /* This window must be completely empty. */
14804 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14805 w
->window_end_pos
= make_number (Z
- ZV
);
14806 w
->window_end_vpos
= make_number (0);
14808 w
->window_end_valid
= Qnil
;
14810 /* Update hint: don't try scrolling again in update_window. */
14811 w
->desired_matrix
->no_scrolling_p
= 1;
14814 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14818 else if (CHARPOS (new_start
) > CHARPOS (start
))
14820 struct glyph_row
*pt_row
, *row
;
14821 struct glyph_row
*first_reusable_row
;
14822 struct glyph_row
*first_row_to_display
;
14824 int yb
= window_text_bottom_y (w
);
14826 /* Find the row starting at new_start, if there is one. Don't
14827 reuse a partially visible line at the end. */
14828 first_reusable_row
= start_row
;
14829 while (first_reusable_row
->enabled_p
14830 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14831 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14832 < CHARPOS (new_start
)))
14833 ++first_reusable_row
;
14835 /* Give up if there is no row to reuse. */
14836 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14837 || !first_reusable_row
->enabled_p
14838 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14839 != CHARPOS (new_start
)))
14842 /* We can reuse fully visible rows beginning with
14843 first_reusable_row to the end of the window. Set
14844 first_row_to_display to the first row that cannot be reused.
14845 Set pt_row to the row containing point, if there is any. */
14847 for (first_row_to_display
= first_reusable_row
;
14848 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14849 ++first_row_to_display
)
14851 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14852 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14853 pt_row
= first_row_to_display
;
14856 /* Start displaying at the start of first_row_to_display. */
14857 xassert (first_row_to_display
->y
< yb
);
14858 init_to_row_start (&it
, w
, first_row_to_display
);
14860 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14862 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14864 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14865 + WINDOW_HEADER_LINE_HEIGHT (w
));
14867 /* Display lines beginning with first_row_to_display in the
14868 desired matrix. Set last_text_row to the last row displayed
14869 that displays text. */
14870 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14871 if (pt_row
== NULL
)
14872 w
->cursor
.vpos
= -1;
14873 last_text_row
= NULL
;
14874 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14875 if (display_line (&it
))
14876 last_text_row
= it
.glyph_row
- 1;
14878 /* If point is in a reused row, adjust y and vpos of the cursor
14882 w
->cursor
.vpos
-= nrows_scrolled
;
14883 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14886 /* Give up if point isn't in a row displayed or reused. (This
14887 also handles the case where w->cursor.vpos < nrows_scrolled
14888 after the calls to display_line, which can happen with scroll
14889 margins. See bug#1295.) */
14890 if (w
->cursor
.vpos
< 0)
14892 clear_glyph_matrix (w
->desired_matrix
);
14896 /* Scroll the display. */
14897 run
.current_y
= first_reusable_row
->y
;
14898 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14899 run
.height
= it
.last_visible_y
- run
.current_y
;
14900 dy
= run
.current_y
- run
.desired_y
;
14905 FRAME_RIF (f
)->update_window_begin_hook (w
);
14906 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14907 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14908 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14912 /* Adjust Y positions of reused rows. */
14913 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14914 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14915 max_y
= it
.last_visible_y
;
14916 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14919 row
->visible_height
= row
->height
;
14920 if (row
->y
< min_y
)
14921 row
->visible_height
-= min_y
- row
->y
;
14922 if (row
->y
+ row
->height
> max_y
)
14923 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14924 row
->redraw_fringe_bitmaps_p
= 1;
14927 /* Scroll the current matrix. */
14928 xassert (nrows_scrolled
> 0);
14929 rotate_matrix (w
->current_matrix
,
14931 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14934 /* Disable rows not reused. */
14935 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14936 row
->enabled_p
= 0;
14938 /* Point may have moved to a different line, so we cannot assume that
14939 the previous cursor position is valid; locate the correct row. */
14942 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14943 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14947 w
->cursor
.y
= row
->y
;
14949 if (row
< bottom_row
)
14951 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14952 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14954 /* Can't use this optimization with bidi-reordered glyph
14955 rows, unless cursor is already at point. */
14956 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14958 if (!(w
->cursor
.hpos
>= 0
14959 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
14960 && BUFFERP (glyph
->object
)
14961 && glyph
->charpos
== PT
))
14966 && (!BUFFERP (glyph
->object
)
14967 || glyph
->charpos
< PT
);
14971 w
->cursor
.x
+= glyph
->pixel_width
;
14976 /* Adjust window end. A null value of last_text_row means that
14977 the window end is in reused rows which in turn means that
14978 only its vpos can have changed. */
14981 w
->window_end_bytepos
14982 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14984 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14986 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14991 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14994 w
->window_end_valid
= Qnil
;
14995 w
->desired_matrix
->no_scrolling_p
= 1;
14998 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15008 /************************************************************************
15009 Window redisplay reusing current matrix when buffer has changed
15010 ************************************************************************/
15012 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15013 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15014 EMACS_INT
*, EMACS_INT
*);
15015 static struct glyph_row
*
15016 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15017 struct glyph_row
*);
15020 /* Return the last row in MATRIX displaying text. If row START is
15021 non-null, start searching with that row. IT gives the dimensions
15022 of the display. Value is null if matrix is empty; otherwise it is
15023 a pointer to the row found. */
15025 static struct glyph_row
*
15026 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15027 struct glyph_row
*start
)
15029 struct glyph_row
*row
, *row_found
;
15031 /* Set row_found to the last row in IT->w's current matrix
15032 displaying text. The loop looks funny but think of partially
15035 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15036 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15038 xassert (row
->enabled_p
);
15040 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15049 /* Return the last row in the current matrix of W that is not affected
15050 by changes at the start of current_buffer that occurred since W's
15051 current matrix was built. Value is null if no such row exists.
15053 BEG_UNCHANGED us the number of characters unchanged at the start of
15054 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15055 first changed character in current_buffer. Characters at positions <
15056 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15057 when the current matrix was built. */
15059 static struct glyph_row
*
15060 find_last_unchanged_at_beg_row (struct window
*w
)
15062 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15063 struct glyph_row
*row
;
15064 struct glyph_row
*row_found
= NULL
;
15065 int yb
= window_text_bottom_y (w
);
15067 /* Find the last row displaying unchanged text. */
15068 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15069 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15070 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15073 if (/* If row ends before first_changed_pos, it is unchanged,
15074 except in some case. */
15075 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15076 /* When row ends in ZV and we write at ZV it is not
15078 && !row
->ends_at_zv_p
15079 /* When first_changed_pos is the end of a continued line,
15080 row is not unchanged because it may be no longer
15082 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15083 && (row
->continued_p
15084 || row
->exact_window_width_line_p
)))
15087 /* Stop if last visible row. */
15088 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15096 /* Find the first glyph row in the current matrix of W that is not
15097 affected by changes at the end of current_buffer since the
15098 time W's current matrix was built.
15100 Return in *DELTA the number of chars by which buffer positions in
15101 unchanged text at the end of current_buffer must be adjusted.
15103 Return in *DELTA_BYTES the corresponding number of bytes.
15105 Value is null if no such row exists, i.e. all rows are affected by
15108 static struct glyph_row
*
15109 find_first_unchanged_at_end_row (struct window
*w
,
15110 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15112 struct glyph_row
*row
;
15113 struct glyph_row
*row_found
= NULL
;
15115 *delta
= *delta_bytes
= 0;
15117 /* Display must not have been paused, otherwise the current matrix
15118 is not up to date. */
15119 eassert (!NILP (w
->window_end_valid
));
15121 /* A value of window_end_pos >= END_UNCHANGED means that the window
15122 end is in the range of changed text. If so, there is no
15123 unchanged row at the end of W's current matrix. */
15124 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15127 /* Set row to the last row in W's current matrix displaying text. */
15128 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15130 /* If matrix is entirely empty, no unchanged row exists. */
15131 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15133 /* The value of row is the last glyph row in the matrix having a
15134 meaningful buffer position in it. The end position of row
15135 corresponds to window_end_pos. This allows us to translate
15136 buffer positions in the current matrix to current buffer
15137 positions for characters not in changed text. */
15139 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15140 EMACS_INT Z_BYTE_old
=
15141 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15142 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15143 struct glyph_row
*first_text_row
15144 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15146 *delta
= Z
- Z_old
;
15147 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15149 /* Set last_unchanged_pos to the buffer position of the last
15150 character in the buffer that has not been changed. Z is the
15151 index + 1 of the last character in current_buffer, i.e. by
15152 subtracting END_UNCHANGED we get the index of the last
15153 unchanged character, and we have to add BEG to get its buffer
15155 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15156 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15158 /* Search backward from ROW for a row displaying a line that
15159 starts at a minimum position >= last_unchanged_pos_old. */
15160 for (; row
> first_text_row
; --row
)
15162 /* This used to abort, but it can happen.
15163 It is ok to just stop the search instead here. KFS. */
15164 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15167 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15172 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15178 /* Make sure that glyph rows in the current matrix of window W
15179 reference the same glyph memory as corresponding rows in the
15180 frame's frame matrix. This function is called after scrolling W's
15181 current matrix on a terminal frame in try_window_id and
15182 try_window_reusing_current_matrix. */
15185 sync_frame_with_window_matrix_rows (struct window
*w
)
15187 struct frame
*f
= XFRAME (w
->frame
);
15188 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15190 /* Preconditions: W must be a leaf window and full-width. Its frame
15191 must have a frame matrix. */
15192 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15193 xassert (WINDOW_FULL_WIDTH_P (w
));
15194 xassert (!FRAME_WINDOW_P (f
));
15196 /* If W is a full-width window, glyph pointers in W's current matrix
15197 have, by definition, to be the same as glyph pointers in the
15198 corresponding frame matrix. Note that frame matrices have no
15199 marginal areas (see build_frame_matrix). */
15200 window_row
= w
->current_matrix
->rows
;
15201 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15202 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15203 while (window_row
< window_row_end
)
15205 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15206 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15208 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15209 frame_row
->glyphs
[TEXT_AREA
] = start
;
15210 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15211 frame_row
->glyphs
[LAST_AREA
] = end
;
15213 /* Disable frame rows whose corresponding window rows have
15214 been disabled in try_window_id. */
15215 if (!window_row
->enabled_p
)
15216 frame_row
->enabled_p
= 0;
15218 ++window_row
, ++frame_row
;
15223 /* Find the glyph row in window W containing CHARPOS. Consider all
15224 rows between START and END (not inclusive). END null means search
15225 all rows to the end of the display area of W. Value is the row
15226 containing CHARPOS or null. */
15229 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15230 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15232 struct glyph_row
*row
= start
;
15233 struct glyph_row
*best_row
= NULL
;
15234 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15237 /* If we happen to start on a header-line, skip that. */
15238 if (row
->mode_line_p
)
15241 if ((end
&& row
>= end
) || !row
->enabled_p
)
15244 last_y
= window_text_bottom_y (w
) - dy
;
15248 /* Give up if we have gone too far. */
15249 if (end
&& row
>= end
)
15251 /* This formerly returned if they were equal.
15252 I think that both quantities are of a "last plus one" type;
15253 if so, when they are equal, the row is within the screen. -- rms. */
15254 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15257 /* If it is in this row, return this row. */
15258 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15259 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15260 /* The end position of a row equals the start
15261 position of the next row. If CHARPOS is there, we
15262 would rather display it in the next line, except
15263 when this line ends in ZV. */
15264 && !row
->ends_at_zv_p
15265 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15266 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15270 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15271 || (!best_row
&& !row
->continued_p
))
15273 /* In bidi-reordered rows, there could be several rows
15274 occluding point, all of them belonging to the same
15275 continued line. We need to find the row which fits
15276 CHARPOS the best. */
15277 for (g
= row
->glyphs
[TEXT_AREA
];
15278 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15281 if (!STRINGP (g
->object
))
15283 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15285 mindif
= eabs (g
->charpos
- charpos
);
15287 /* Exact match always wins. */
15294 else if (best_row
&& !row
->continued_p
)
15301 /* Try to redisplay window W by reusing its existing display. W's
15302 current matrix must be up to date when this function is called,
15303 i.e. window_end_valid must not be nil.
15307 1 if display has been updated
15308 0 if otherwise unsuccessful
15309 -1 if redisplay with same window start is known not to succeed
15311 The following steps are performed:
15313 1. Find the last row in the current matrix of W that is not
15314 affected by changes at the start of current_buffer. If no such row
15317 2. Find the first row in W's current matrix that is not affected by
15318 changes at the end of current_buffer. Maybe there is no such row.
15320 3. Display lines beginning with the row + 1 found in step 1 to the
15321 row found in step 2 or, if step 2 didn't find a row, to the end of
15324 4. If cursor is not known to appear on the window, give up.
15326 5. If display stopped at the row found in step 2, scroll the
15327 display and current matrix as needed.
15329 6. Maybe display some lines at the end of W, if we must. This can
15330 happen under various circumstances, like a partially visible line
15331 becoming fully visible, or because newly displayed lines are displayed
15332 in smaller font sizes.
15334 7. Update W's window end information. */
15337 try_window_id (struct window
*w
)
15339 struct frame
*f
= XFRAME (w
->frame
);
15340 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15341 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15342 struct glyph_row
*last_unchanged_at_beg_row
;
15343 struct glyph_row
*first_unchanged_at_end_row
;
15344 struct glyph_row
*row
;
15345 struct glyph_row
*bottom_row
;
15348 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15350 struct text_pos start_pos
;
15352 int first_unchanged_at_end_vpos
= 0;
15353 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15354 struct text_pos start
;
15355 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15358 if (inhibit_try_window_id
)
15362 /* This is handy for debugging. */
15364 #define GIVE_UP(X) \
15366 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15370 #define GIVE_UP(X) return 0
15373 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15375 /* Don't use this for mini-windows because these can show
15376 messages and mini-buffers, and we don't handle that here. */
15377 if (MINI_WINDOW_P (w
))
15380 /* This flag is used to prevent redisplay optimizations. */
15381 if (windows_or_buffers_changed
|| cursor_type_changed
)
15384 /* Verify that narrowing has not changed.
15385 Also verify that we were not told to prevent redisplay optimizations.
15386 It would be nice to further
15387 reduce the number of cases where this prevents try_window_id. */
15388 if (current_buffer
->clip_changed
15389 || current_buffer
->prevent_redisplay_optimizations_p
)
15392 /* Window must either use window-based redisplay or be full width. */
15393 if (!FRAME_WINDOW_P (f
)
15394 && (!FRAME_LINE_INS_DEL_OK (f
)
15395 || !WINDOW_FULL_WIDTH_P (w
)))
15398 /* Give up if point is known NOT to appear in W. */
15399 if (PT
< CHARPOS (start
))
15402 /* Another way to prevent redisplay optimizations. */
15403 if (XFASTINT (w
->last_modified
) == 0)
15406 /* Verify that window is not hscrolled. */
15407 if (XFASTINT (w
->hscroll
) != 0)
15410 /* Verify that display wasn't paused. */
15411 if (NILP (w
->window_end_valid
))
15414 /* Can't use this if highlighting a region because a cursor movement
15415 will do more than just set the cursor. */
15416 if (!NILP (Vtransient_mark_mode
)
15417 && !NILP (BVAR (current_buffer
, mark_active
)))
15420 /* Likewise if highlighting trailing whitespace. */
15421 if (!NILP (Vshow_trailing_whitespace
))
15424 /* Likewise if showing a region. */
15425 if (!NILP (w
->region_showing
))
15428 /* Can't use this if overlay arrow position and/or string have
15430 if (overlay_arrows_changed_p ())
15433 /* When word-wrap is on, adding a space to the first word of a
15434 wrapped line can change the wrap position, altering the line
15435 above it. It might be worthwhile to handle this more
15436 intelligently, but for now just redisplay from scratch. */
15437 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15440 /* Under bidi reordering, adding or deleting a character in the
15441 beginning of a paragraph, before the first strong directional
15442 character, can change the base direction of the paragraph (unless
15443 the buffer specifies a fixed paragraph direction), which will
15444 require to redisplay the whole paragraph. It might be worthwhile
15445 to find the paragraph limits and widen the range of redisplayed
15446 lines to that, but for now just give up this optimization and
15447 redisplay from scratch. */
15448 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15449 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15452 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15453 only if buffer has really changed. The reason is that the gap is
15454 initially at Z for freshly visited files. The code below would
15455 set end_unchanged to 0 in that case. */
15456 if (MODIFF
> SAVE_MODIFF
15457 /* This seems to happen sometimes after saving a buffer. */
15458 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15460 if (GPT
- BEG
< BEG_UNCHANGED
)
15461 BEG_UNCHANGED
= GPT
- BEG
;
15462 if (Z
- GPT
< END_UNCHANGED
)
15463 END_UNCHANGED
= Z
- GPT
;
15466 /* The position of the first and last character that has been changed. */
15467 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15468 last_changed_charpos
= Z
- END_UNCHANGED
;
15470 /* If window starts after a line end, and the last change is in
15471 front of that newline, then changes don't affect the display.
15472 This case happens with stealth-fontification. Note that although
15473 the display is unchanged, glyph positions in the matrix have to
15474 be adjusted, of course. */
15475 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15476 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15477 && ((last_changed_charpos
< CHARPOS (start
)
15478 && CHARPOS (start
) == BEGV
)
15479 || (last_changed_charpos
< CHARPOS (start
) - 1
15480 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15482 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15483 struct glyph_row
*r0
;
15485 /* Compute how many chars/bytes have been added to or removed
15486 from the buffer. */
15487 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15488 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15489 Z_delta
= Z
- Z_old
;
15490 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15492 /* Give up if PT is not in the window. Note that it already has
15493 been checked at the start of try_window_id that PT is not in
15494 front of the window start. */
15495 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15498 /* If window start is unchanged, we can reuse the whole matrix
15499 as is, after adjusting glyph positions. No need to compute
15500 the window end again, since its offset from Z hasn't changed. */
15501 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15502 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15503 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15504 /* PT must not be in a partially visible line. */
15505 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15506 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15508 /* Adjust positions in the glyph matrix. */
15509 if (Z_delta
|| Z_delta_bytes
)
15511 struct glyph_row
*r1
15512 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15513 increment_matrix_positions (w
->current_matrix
,
15514 MATRIX_ROW_VPOS (r0
, current_matrix
),
15515 MATRIX_ROW_VPOS (r1
, current_matrix
),
15516 Z_delta
, Z_delta_bytes
);
15519 /* Set the cursor. */
15520 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15522 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15529 /* Handle the case that changes are all below what is displayed in
15530 the window, and that PT is in the window. This shortcut cannot
15531 be taken if ZV is visible in the window, and text has been added
15532 there that is visible in the window. */
15533 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15534 /* ZV is not visible in the window, or there are no
15535 changes at ZV, actually. */
15536 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15537 || first_changed_charpos
== last_changed_charpos
))
15539 struct glyph_row
*r0
;
15541 /* Give up if PT is not in the window. Note that it already has
15542 been checked at the start of try_window_id that PT is not in
15543 front of the window start. */
15544 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15547 /* If window start is unchanged, we can reuse the whole matrix
15548 as is, without changing glyph positions since no text has
15549 been added/removed in front of the window end. */
15550 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15551 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15552 /* PT must not be in a partially visible line. */
15553 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15554 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15556 /* We have to compute the window end anew since text
15557 could have been added/removed after it. */
15559 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15560 w
->window_end_bytepos
15561 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15563 /* Set the cursor. */
15564 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15566 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15573 /* Give up if window start is in the changed area.
15575 The condition used to read
15577 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15579 but why that was tested escapes me at the moment. */
15580 if (CHARPOS (start
) >= first_changed_charpos
15581 && CHARPOS (start
) <= last_changed_charpos
)
15584 /* Check that window start agrees with the start of the first glyph
15585 row in its current matrix. Check this after we know the window
15586 start is not in changed text, otherwise positions would not be
15588 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15589 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15592 /* Give up if the window ends in strings. Overlay strings
15593 at the end are difficult to handle, so don't try. */
15594 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15595 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15598 /* Compute the position at which we have to start displaying new
15599 lines. Some of the lines at the top of the window might be
15600 reusable because they are not displaying changed text. Find the
15601 last row in W's current matrix not affected by changes at the
15602 start of current_buffer. Value is null if changes start in the
15603 first line of window. */
15604 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15605 if (last_unchanged_at_beg_row
)
15607 /* Avoid starting to display in the moddle of a character, a TAB
15608 for instance. This is easier than to set up the iterator
15609 exactly, and it's not a frequent case, so the additional
15610 effort wouldn't really pay off. */
15611 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15612 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15613 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15614 --last_unchanged_at_beg_row
;
15616 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15619 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15621 start_pos
= it
.current
.pos
;
15623 /* Start displaying new lines in the desired matrix at the same
15624 vpos we would use in the current matrix, i.e. below
15625 last_unchanged_at_beg_row. */
15626 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15628 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15629 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15631 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15635 /* There are no reusable lines at the start of the window.
15636 Start displaying in the first text line. */
15637 start_display (&it
, w
, start
);
15638 it
.vpos
= it
.first_vpos
;
15639 start_pos
= it
.current
.pos
;
15642 /* Find the first row that is not affected by changes at the end of
15643 the buffer. Value will be null if there is no unchanged row, in
15644 which case we must redisplay to the end of the window. delta
15645 will be set to the value by which buffer positions beginning with
15646 first_unchanged_at_end_row have to be adjusted due to text
15648 first_unchanged_at_end_row
15649 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15650 IF_DEBUG (debug_delta
= delta
);
15651 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15653 /* Set stop_pos to the buffer position up to which we will have to
15654 display new lines. If first_unchanged_at_end_row != NULL, this
15655 is the buffer position of the start of the line displayed in that
15656 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15657 that we don't stop at a buffer position. */
15659 if (first_unchanged_at_end_row
)
15661 xassert (last_unchanged_at_beg_row
== NULL
15662 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15664 /* If this is a continuation line, move forward to the next one
15665 that isn't. Changes in lines above affect this line.
15666 Caution: this may move first_unchanged_at_end_row to a row
15667 not displaying text. */
15668 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15669 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15670 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15671 < it
.last_visible_y
))
15672 ++first_unchanged_at_end_row
;
15674 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15675 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15676 >= it
.last_visible_y
))
15677 first_unchanged_at_end_row
= NULL
;
15680 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15682 first_unchanged_at_end_vpos
15683 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15684 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15687 else if (last_unchanged_at_beg_row
== NULL
)
15693 /* Either there is no unchanged row at the end, or the one we have
15694 now displays text. This is a necessary condition for the window
15695 end pos calculation at the end of this function. */
15696 xassert (first_unchanged_at_end_row
== NULL
15697 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15699 debug_last_unchanged_at_beg_vpos
15700 = (last_unchanged_at_beg_row
15701 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15703 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15705 #endif /* GLYPH_DEBUG != 0 */
15708 /* Display new lines. Set last_text_row to the last new line
15709 displayed which has text on it, i.e. might end up as being the
15710 line where the window_end_vpos is. */
15711 w
->cursor
.vpos
= -1;
15712 last_text_row
= NULL
;
15713 overlay_arrow_seen
= 0;
15714 while (it
.current_y
< it
.last_visible_y
15715 && !fonts_changed_p
15716 && (first_unchanged_at_end_row
== NULL
15717 || IT_CHARPOS (it
) < stop_pos
))
15719 if (display_line (&it
))
15720 last_text_row
= it
.glyph_row
- 1;
15723 if (fonts_changed_p
)
15727 /* Compute differences in buffer positions, y-positions etc. for
15728 lines reused at the bottom of the window. Compute what we can
15730 if (first_unchanged_at_end_row
15731 /* No lines reused because we displayed everything up to the
15732 bottom of the window. */
15733 && it
.current_y
< it
.last_visible_y
)
15736 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15738 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15739 run
.current_y
= first_unchanged_at_end_row
->y
;
15740 run
.desired_y
= run
.current_y
+ dy
;
15741 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15745 delta
= delta_bytes
= dvpos
= dy
15746 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15747 first_unchanged_at_end_row
= NULL
;
15749 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15752 /* Find the cursor if not already found. We have to decide whether
15753 PT will appear on this window (it sometimes doesn't, but this is
15754 not a very frequent case.) This decision has to be made before
15755 the current matrix is altered. A value of cursor.vpos < 0 means
15756 that PT is either in one of the lines beginning at
15757 first_unchanged_at_end_row or below the window. Don't care for
15758 lines that might be displayed later at the window end; as
15759 mentioned, this is not a frequent case. */
15760 if (w
->cursor
.vpos
< 0)
15762 /* Cursor in unchanged rows at the top? */
15763 if (PT
< CHARPOS (start_pos
)
15764 && last_unchanged_at_beg_row
)
15766 row
= row_containing_pos (w
, PT
,
15767 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15768 last_unchanged_at_beg_row
+ 1, 0);
15770 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15773 /* Start from first_unchanged_at_end_row looking for PT. */
15774 else if (first_unchanged_at_end_row
)
15776 row
= row_containing_pos (w
, PT
- delta
,
15777 first_unchanged_at_end_row
, NULL
, 0);
15779 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15780 delta_bytes
, dy
, dvpos
);
15783 /* Give up if cursor was not found. */
15784 if (w
->cursor
.vpos
< 0)
15786 clear_glyph_matrix (w
->desired_matrix
);
15791 /* Don't let the cursor end in the scroll margins. */
15793 int this_scroll_margin
, cursor_height
;
15795 this_scroll_margin
= max (0, scroll_margin
);
15796 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15797 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15798 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15800 if ((w
->cursor
.y
< this_scroll_margin
15801 && CHARPOS (start
) > BEGV
)
15802 /* Old redisplay didn't take scroll margin into account at the bottom,
15803 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15804 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15805 ? cursor_height
+ this_scroll_margin
15806 : 1)) > it
.last_visible_y
)
15808 w
->cursor
.vpos
= -1;
15809 clear_glyph_matrix (w
->desired_matrix
);
15814 /* Scroll the display. Do it before changing the current matrix so
15815 that xterm.c doesn't get confused about where the cursor glyph is
15817 if (dy
&& run
.height
)
15821 if (FRAME_WINDOW_P (f
))
15823 FRAME_RIF (f
)->update_window_begin_hook (w
);
15824 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15825 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15826 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15830 /* Terminal frame. In this case, dvpos gives the number of
15831 lines to scroll by; dvpos < 0 means scroll up. */
15833 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15834 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15835 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15836 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15837 + window_internal_height (w
));
15839 #if defined (HAVE_GPM) || defined (MSDOS)
15840 x_clear_window_mouse_face (w
);
15842 /* Perform the operation on the screen. */
15845 /* Scroll last_unchanged_at_beg_row to the end of the
15846 window down dvpos lines. */
15847 set_terminal_window (f
, end
);
15849 /* On dumb terminals delete dvpos lines at the end
15850 before inserting dvpos empty lines. */
15851 if (!FRAME_SCROLL_REGION_OK (f
))
15852 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15854 /* Insert dvpos empty lines in front of
15855 last_unchanged_at_beg_row. */
15856 ins_del_lines (f
, from
, dvpos
);
15858 else if (dvpos
< 0)
15860 /* Scroll up last_unchanged_at_beg_vpos to the end of
15861 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15862 set_terminal_window (f
, end
);
15864 /* Delete dvpos lines in front of
15865 last_unchanged_at_beg_vpos. ins_del_lines will set
15866 the cursor to the given vpos and emit |dvpos| delete
15868 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15870 /* On a dumb terminal insert dvpos empty lines at the
15872 if (!FRAME_SCROLL_REGION_OK (f
))
15873 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15876 set_terminal_window (f
, 0);
15882 /* Shift reused rows of the current matrix to the right position.
15883 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15885 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15886 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15889 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15890 bottom_vpos
, dvpos
);
15891 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15894 else if (dvpos
> 0)
15896 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15897 bottom_vpos
, dvpos
);
15898 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15899 first_unchanged_at_end_vpos
+ dvpos
, 0);
15902 /* For frame-based redisplay, make sure that current frame and window
15903 matrix are in sync with respect to glyph memory. */
15904 if (!FRAME_WINDOW_P (f
))
15905 sync_frame_with_window_matrix_rows (w
);
15907 /* Adjust buffer positions in reused rows. */
15908 if (delta
|| delta_bytes
)
15909 increment_matrix_positions (current_matrix
,
15910 first_unchanged_at_end_vpos
+ dvpos
,
15911 bottom_vpos
, delta
, delta_bytes
);
15913 /* Adjust Y positions. */
15915 shift_glyph_matrix (w
, current_matrix
,
15916 first_unchanged_at_end_vpos
+ dvpos
,
15919 if (first_unchanged_at_end_row
)
15921 first_unchanged_at_end_row
+= dvpos
;
15922 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15923 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15924 first_unchanged_at_end_row
= NULL
;
15927 /* If scrolling up, there may be some lines to display at the end of
15929 last_text_row_at_end
= NULL
;
15932 /* Scrolling up can leave for example a partially visible line
15933 at the end of the window to be redisplayed. */
15934 /* Set last_row to the glyph row in the current matrix where the
15935 window end line is found. It has been moved up or down in
15936 the matrix by dvpos. */
15937 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15938 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15940 /* If last_row is the window end line, it should display text. */
15941 xassert (last_row
->displays_text_p
);
15943 /* If window end line was partially visible before, begin
15944 displaying at that line. Otherwise begin displaying with the
15945 line following it. */
15946 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15948 init_to_row_start (&it
, w
, last_row
);
15949 it
.vpos
= last_vpos
;
15950 it
.current_y
= last_row
->y
;
15954 init_to_row_end (&it
, w
, last_row
);
15955 it
.vpos
= 1 + last_vpos
;
15956 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15960 /* We may start in a continuation line. If so, we have to
15961 get the right continuation_lines_width and current_x. */
15962 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15963 it
.hpos
= it
.current_x
= 0;
15965 /* Display the rest of the lines at the window end. */
15966 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15967 while (it
.current_y
< it
.last_visible_y
15968 && !fonts_changed_p
)
15970 /* Is it always sure that the display agrees with lines in
15971 the current matrix? I don't think so, so we mark rows
15972 displayed invalid in the current matrix by setting their
15973 enabled_p flag to zero. */
15974 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15975 if (display_line (&it
))
15976 last_text_row_at_end
= it
.glyph_row
- 1;
15980 /* Update window_end_pos and window_end_vpos. */
15981 if (first_unchanged_at_end_row
15982 && !last_text_row_at_end
)
15984 /* Window end line if one of the preserved rows from the current
15985 matrix. Set row to the last row displaying text in current
15986 matrix starting at first_unchanged_at_end_row, after
15988 xassert (first_unchanged_at_end_row
->displays_text_p
);
15989 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15990 first_unchanged_at_end_row
);
15991 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15993 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15994 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15996 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15997 xassert (w
->window_end_bytepos
>= 0);
15998 IF_DEBUG (debug_method_add (w
, "A"));
16000 else if (last_text_row_at_end
)
16003 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16004 w
->window_end_bytepos
16005 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16007 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16008 xassert (w
->window_end_bytepos
>= 0);
16009 IF_DEBUG (debug_method_add (w
, "B"));
16011 else if (last_text_row
)
16013 /* We have displayed either to the end of the window or at the
16014 end of the window, i.e. the last row with text is to be found
16015 in the desired matrix. */
16017 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16018 w
->window_end_bytepos
16019 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16021 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16022 xassert (w
->window_end_bytepos
>= 0);
16024 else if (first_unchanged_at_end_row
== NULL
16025 && last_text_row
== NULL
16026 && last_text_row_at_end
== NULL
)
16028 /* Displayed to end of window, but no line containing text was
16029 displayed. Lines were deleted at the end of the window. */
16030 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16031 int vpos
= XFASTINT (w
->window_end_vpos
);
16032 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16033 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16036 row
== NULL
&& vpos
>= first_vpos
;
16037 --vpos
, --current_row
, --desired_row
)
16039 if (desired_row
->enabled_p
)
16041 if (desired_row
->displays_text_p
)
16044 else if (current_row
->displays_text_p
)
16048 xassert (row
!= NULL
);
16049 w
->window_end_vpos
= make_number (vpos
+ 1);
16050 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16051 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16052 xassert (w
->window_end_bytepos
>= 0);
16053 IF_DEBUG (debug_method_add (w
, "C"));
16058 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16059 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16061 /* Record that display has not been completed. */
16062 w
->window_end_valid
= Qnil
;
16063 w
->desired_matrix
->no_scrolling_p
= 1;
16071 /***********************************************************************
16072 More debugging support
16073 ***********************************************************************/
16077 void dump_glyph_row (struct glyph_row
*, int, int);
16078 void dump_glyph_matrix (struct glyph_matrix
*, int);
16079 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16082 /* Dump the contents of glyph matrix MATRIX on stderr.
16084 GLYPHS 0 means don't show glyph contents.
16085 GLYPHS 1 means show glyphs in short form
16086 GLYPHS > 1 means show glyphs in long form. */
16089 dump_glyph_matrix (matrix
, glyphs
)
16090 struct glyph_matrix
*matrix
;
16094 for (i
= 0; i
< matrix
->nrows
; ++i
)
16095 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16099 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16100 the glyph row and area where the glyph comes from. */
16103 dump_glyph (row
, glyph
, area
)
16104 struct glyph_row
*row
;
16105 struct glyph
*glyph
;
16108 if (glyph
->type
== CHAR_GLYPH
)
16111 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16112 glyph
- row
->glyphs
[TEXT_AREA
],
16115 (BUFFERP (glyph
->object
)
16117 : (STRINGP (glyph
->object
)
16120 glyph
->pixel_width
,
16122 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16126 glyph
->left_box_line_p
,
16127 glyph
->right_box_line_p
);
16129 else if (glyph
->type
== STRETCH_GLYPH
)
16132 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16133 glyph
- row
->glyphs
[TEXT_AREA
],
16136 (BUFFERP (glyph
->object
)
16138 : (STRINGP (glyph
->object
)
16141 glyph
->pixel_width
,
16145 glyph
->left_box_line_p
,
16146 glyph
->right_box_line_p
);
16148 else if (glyph
->type
== IMAGE_GLYPH
)
16151 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16152 glyph
- row
->glyphs
[TEXT_AREA
],
16155 (BUFFERP (glyph
->object
)
16157 : (STRINGP (glyph
->object
)
16160 glyph
->pixel_width
,
16164 glyph
->left_box_line_p
,
16165 glyph
->right_box_line_p
);
16167 else if (glyph
->type
== COMPOSITE_GLYPH
)
16170 " %5d %4c %6d %c %3d 0x%05x",
16171 glyph
- row
->glyphs
[TEXT_AREA
],
16174 (BUFFERP (glyph
->object
)
16176 : (STRINGP (glyph
->object
)
16179 glyph
->pixel_width
,
16181 if (glyph
->u
.cmp
.automatic
)
16184 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16185 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16187 glyph
->left_box_line_p
,
16188 glyph
->right_box_line_p
);
16193 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16194 GLYPHS 0 means don't show glyph contents.
16195 GLYPHS 1 means show glyphs in short form
16196 GLYPHS > 1 means show glyphs in long form. */
16199 dump_glyph_row (row
, vpos
, glyphs
)
16200 struct glyph_row
*row
;
16205 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16206 fprintf (stderr
, "======================================================================\n");
16208 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16209 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16211 MATRIX_ROW_START_CHARPOS (row
),
16212 MATRIX_ROW_END_CHARPOS (row
),
16213 row
->used
[TEXT_AREA
],
16214 row
->contains_overlapping_glyphs_p
,
16216 row
->truncated_on_left_p
,
16217 row
->truncated_on_right_p
,
16219 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16220 row
->displays_text_p
,
16223 row
->ends_in_middle_of_char_p
,
16224 row
->starts_in_middle_of_char_p
,
16230 row
->visible_height
,
16233 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16234 row
->end
.overlay_string_index
,
16235 row
->continuation_lines_width
);
16236 fprintf (stderr
, "%9d %5d\n",
16237 CHARPOS (row
->start
.string_pos
),
16238 CHARPOS (row
->end
.string_pos
));
16239 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16240 row
->end
.dpvec_index
);
16247 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16249 struct glyph
*glyph
= row
->glyphs
[area
];
16250 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16252 /* Glyph for a line end in text. */
16253 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16256 if (glyph
< glyph_end
)
16257 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16259 for (; glyph
< glyph_end
; ++glyph
)
16260 dump_glyph (row
, glyph
, area
);
16263 else if (glyphs
== 1)
16267 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16269 char *s
= (char *) alloca (row
->used
[area
] + 1);
16272 for (i
= 0; i
< row
->used
[area
]; ++i
)
16274 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16275 if (glyph
->type
== CHAR_GLYPH
16276 && glyph
->u
.ch
< 0x80
16277 && glyph
->u
.ch
>= ' ')
16278 s
[i
] = glyph
->u
.ch
;
16284 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16290 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16291 Sdump_glyph_matrix
, 0, 1, "p",
16292 doc
: /* Dump the current matrix of the selected window to stderr.
16293 Shows contents of glyph row structures. With non-nil
16294 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16295 glyphs in short form, otherwise show glyphs in long form. */)
16296 (Lisp_Object glyphs
)
16298 struct window
*w
= XWINDOW (selected_window
);
16299 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16301 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16302 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16303 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16304 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16305 fprintf (stderr
, "=============================================\n");
16306 dump_glyph_matrix (w
->current_matrix
,
16307 NILP (glyphs
) ? 0 : XINT (glyphs
));
16312 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16313 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16316 struct frame
*f
= XFRAME (selected_frame
);
16317 dump_glyph_matrix (f
->current_matrix
, 1);
16322 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16323 doc
: /* Dump glyph row ROW to stderr.
16324 GLYPH 0 means don't dump glyphs.
16325 GLYPH 1 means dump glyphs in short form.
16326 GLYPH > 1 or omitted means dump glyphs in long form. */)
16327 (Lisp_Object row
, Lisp_Object glyphs
)
16329 struct glyph_matrix
*matrix
;
16332 CHECK_NUMBER (row
);
16333 matrix
= XWINDOW (selected_window
)->current_matrix
;
16335 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16336 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16338 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16343 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16344 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16345 GLYPH 0 means don't dump glyphs.
16346 GLYPH 1 means dump glyphs in short form.
16347 GLYPH > 1 or omitted means dump glyphs in long form. */)
16348 (Lisp_Object row
, Lisp_Object glyphs
)
16350 struct frame
*sf
= SELECTED_FRAME ();
16351 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16354 CHECK_NUMBER (row
);
16356 if (vpos
>= 0 && vpos
< m
->nrows
)
16357 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16358 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16363 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16364 doc
: /* Toggle tracing of redisplay.
16365 With ARG, turn tracing on if and only if ARG is positive. */)
16369 trace_redisplay_p
= !trace_redisplay_p
;
16372 arg
= Fprefix_numeric_value (arg
);
16373 trace_redisplay_p
= XINT (arg
) > 0;
16380 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16381 doc
: /* Like `format', but print result to stderr.
16382 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16383 (size_t nargs
, Lisp_Object
*args
)
16385 Lisp_Object s
= Fformat (nargs
, args
);
16386 fprintf (stderr
, "%s", SDATA (s
));
16390 #endif /* GLYPH_DEBUG */
16394 /***********************************************************************
16395 Building Desired Matrix Rows
16396 ***********************************************************************/
16398 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16399 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16401 static struct glyph_row
*
16402 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16404 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16405 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16406 struct buffer
*old
= current_buffer
;
16407 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16408 int arrow_len
= SCHARS (overlay_arrow_string
);
16409 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16410 const unsigned char *p
;
16413 int n_glyphs_before
;
16415 set_buffer_temp (buffer
);
16416 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16417 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16418 SET_TEXT_POS (it
.position
, 0, 0);
16420 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16422 while (p
< arrow_end
)
16424 Lisp_Object face
, ilisp
;
16426 /* Get the next character. */
16428 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16431 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16432 if (! ASCII_CHAR_P (it
.c
))
16433 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16437 /* Get its face. */
16438 ilisp
= make_number (p
- arrow_string
);
16439 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16440 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16442 /* Compute its width, get its glyphs. */
16443 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16444 SET_TEXT_POS (it
.position
, -1, -1);
16445 PRODUCE_GLYPHS (&it
);
16447 /* If this character doesn't fit any more in the line, we have
16448 to remove some glyphs. */
16449 if (it
.current_x
> it
.last_visible_x
)
16451 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16456 set_buffer_temp (old
);
16457 return it
.glyph_row
;
16461 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16462 glyphs are only inserted for terminal frames since we can't really
16463 win with truncation glyphs when partially visible glyphs are
16464 involved. Which glyphs to insert is determined by
16465 produce_special_glyphs. */
16468 insert_left_trunc_glyphs (struct it
*it
)
16470 struct it truncate_it
;
16471 struct glyph
*from
, *end
, *to
, *toend
;
16473 xassert (!FRAME_WINDOW_P (it
->f
));
16475 /* Get the truncation glyphs. */
16477 truncate_it
.current_x
= 0;
16478 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16479 truncate_it
.glyph_row
= &scratch_glyph_row
;
16480 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16481 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16482 truncate_it
.object
= make_number (0);
16483 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16485 /* Overwrite glyphs from IT with truncation glyphs. */
16486 if (!it
->glyph_row
->reversed_p
)
16488 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16489 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16490 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16491 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16496 /* There may be padding glyphs left over. Overwrite them too. */
16497 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16499 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16505 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16509 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16510 that back to front. */
16511 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16512 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16513 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16514 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16516 while (from
>= end
&& to
>= toend
)
16518 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16521 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16522 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16523 while (from
>= end
&& to
>= toend
)
16528 /* Need to free some room before prepending additional
16530 int move_by
= from
- end
+ 1;
16531 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16532 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16534 for ( ; g
>= g0
; g
--)
16536 while (from
>= end
)
16538 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16544 /* Compute the pixel height and width of IT->glyph_row.
16546 Most of the time, ascent and height of a display line will be equal
16547 to the max_ascent and max_height values of the display iterator
16548 structure. This is not the case if
16550 1. We hit ZV without displaying anything. In this case, max_ascent
16551 and max_height will be zero.
16553 2. We have some glyphs that don't contribute to the line height.
16554 (The glyph row flag contributes_to_line_height_p is for future
16555 pixmap extensions).
16557 The first case is easily covered by using default values because in
16558 these cases, the line height does not really matter, except that it
16559 must not be zero. */
16562 compute_line_metrics (struct it
*it
)
16564 struct glyph_row
*row
= it
->glyph_row
;
16566 if (FRAME_WINDOW_P (it
->f
))
16568 int i
, min_y
, max_y
;
16570 /* The line may consist of one space only, that was added to
16571 place the cursor on it. If so, the row's height hasn't been
16573 if (row
->height
== 0)
16575 if (it
->max_ascent
+ it
->max_descent
== 0)
16576 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16577 row
->ascent
= it
->max_ascent
;
16578 row
->height
= it
->max_ascent
+ it
->max_descent
;
16579 row
->phys_ascent
= it
->max_phys_ascent
;
16580 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16581 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16584 /* Compute the width of this line. */
16585 row
->pixel_width
= row
->x
;
16586 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16587 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16589 xassert (row
->pixel_width
>= 0);
16590 xassert (row
->ascent
>= 0 && row
->height
> 0);
16592 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16593 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16595 /* If first line's physical ascent is larger than its logical
16596 ascent, use the physical ascent, and make the row taller.
16597 This makes accented characters fully visible. */
16598 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16599 && row
->phys_ascent
> row
->ascent
)
16601 row
->height
+= row
->phys_ascent
- row
->ascent
;
16602 row
->ascent
= row
->phys_ascent
;
16605 /* Compute how much of the line is visible. */
16606 row
->visible_height
= row
->height
;
16608 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16609 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16611 if (row
->y
< min_y
)
16612 row
->visible_height
-= min_y
- row
->y
;
16613 if (row
->y
+ row
->height
> max_y
)
16614 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16618 row
->pixel_width
= row
->used
[TEXT_AREA
];
16619 if (row
->continued_p
)
16620 row
->pixel_width
-= it
->continuation_pixel_width
;
16621 else if (row
->truncated_on_right_p
)
16622 row
->pixel_width
-= it
->truncation_pixel_width
;
16623 row
->ascent
= row
->phys_ascent
= 0;
16624 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16625 row
->extra_line_spacing
= 0;
16628 /* Compute a hash code for this row. */
16632 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16633 for (i
= 0; i
< row
->used
[area
]; ++i
)
16634 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16635 + row
->glyphs
[area
][i
].u
.val
16636 + row
->glyphs
[area
][i
].face_id
16637 + row
->glyphs
[area
][i
].padding_p
16638 + (row
->glyphs
[area
][i
].type
<< 2));
16641 it
->max_ascent
= it
->max_descent
= 0;
16642 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16646 /* Append one space to the glyph row of iterator IT if doing a
16647 window-based redisplay. The space has the same face as
16648 IT->face_id. Value is non-zero if a space was added.
16650 This function is called to make sure that there is always one glyph
16651 at the end of a glyph row that the cursor can be set on under
16652 window-systems. (If there weren't such a glyph we would not know
16653 how wide and tall a box cursor should be displayed).
16655 At the same time this space let's a nicely handle clearing to the
16656 end of the line if the row ends in italic text. */
16659 append_space_for_newline (struct it
*it
, int default_face_p
)
16661 if (FRAME_WINDOW_P (it
->f
))
16663 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16665 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16666 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16668 /* Save some values that must not be changed.
16669 Must save IT->c and IT->len because otherwise
16670 ITERATOR_AT_END_P wouldn't work anymore after
16671 append_space_for_newline has been called. */
16672 enum display_element_type saved_what
= it
->what
;
16673 int saved_c
= it
->c
, saved_len
= it
->len
;
16674 int saved_char_to_display
= it
->char_to_display
;
16675 int saved_x
= it
->current_x
;
16676 int saved_face_id
= it
->face_id
;
16677 struct text_pos saved_pos
;
16678 Lisp_Object saved_object
;
16681 saved_object
= it
->object
;
16682 saved_pos
= it
->position
;
16684 it
->what
= IT_CHARACTER
;
16685 memset (&it
->position
, 0, sizeof it
->position
);
16686 it
->object
= make_number (0);
16687 it
->c
= it
->char_to_display
= ' ';
16690 if (default_face_p
)
16691 it
->face_id
= DEFAULT_FACE_ID
;
16692 else if (it
->face_before_selective_p
)
16693 it
->face_id
= it
->saved_face_id
;
16694 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16695 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16697 PRODUCE_GLYPHS (it
);
16699 it
->override_ascent
= -1;
16700 it
->constrain_row_ascent_descent_p
= 0;
16701 it
->current_x
= saved_x
;
16702 it
->object
= saved_object
;
16703 it
->position
= saved_pos
;
16704 it
->what
= saved_what
;
16705 it
->face_id
= saved_face_id
;
16706 it
->len
= saved_len
;
16708 it
->char_to_display
= saved_char_to_display
;
16717 /* Extend the face of the last glyph in the text area of IT->glyph_row
16718 to the end of the display line. Called from display_line. If the
16719 glyph row is empty, add a space glyph to it so that we know the
16720 face to draw. Set the glyph row flag fill_line_p. If the glyph
16721 row is R2L, prepend a stretch glyph to cover the empty space to the
16722 left of the leftmost glyph. */
16725 extend_face_to_end_of_line (struct it
*it
)
16728 struct frame
*f
= it
->f
;
16730 /* If line is already filled, do nothing. Non window-system frames
16731 get a grace of one more ``pixel'' because their characters are
16732 1-``pixel'' wide, so they hit the equality too early. This grace
16733 is needed only for R2L rows that are not continued, to produce
16734 one extra blank where we could display the cursor. */
16735 if (it
->current_x
>= it
->last_visible_x
16736 + (!FRAME_WINDOW_P (f
)
16737 && it
->glyph_row
->reversed_p
16738 && !it
->glyph_row
->continued_p
))
16741 /* Face extension extends the background and box of IT->face_id
16742 to the end of the line. If the background equals the background
16743 of the frame, we don't have to do anything. */
16744 if (it
->face_before_selective_p
)
16745 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16747 face
= FACE_FROM_ID (f
, it
->face_id
);
16749 if (FRAME_WINDOW_P (f
)
16750 && it
->glyph_row
->displays_text_p
16751 && face
->box
== FACE_NO_BOX
16752 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16754 && !it
->glyph_row
->reversed_p
)
16757 /* Set the glyph row flag indicating that the face of the last glyph
16758 in the text area has to be drawn to the end of the text area. */
16759 it
->glyph_row
->fill_line_p
= 1;
16761 /* If current character of IT is not ASCII, make sure we have the
16762 ASCII face. This will be automatically undone the next time
16763 get_next_display_element returns a multibyte character. Note
16764 that the character will always be single byte in unibyte
16766 if (!ASCII_CHAR_P (it
->c
))
16768 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16771 if (FRAME_WINDOW_P (f
))
16773 /* If the row is empty, add a space with the current face of IT,
16774 so that we know which face to draw. */
16775 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16777 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16778 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16779 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16781 #ifdef HAVE_WINDOW_SYSTEM
16782 if (it
->glyph_row
->reversed_p
)
16784 /* Prepend a stretch glyph to the row, such that the
16785 rightmost glyph will be drawn flushed all the way to the
16786 right margin of the window. The stretch glyph that will
16787 occupy the empty space, if any, to the left of the
16789 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16790 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16791 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16793 int row_width
, stretch_ascent
, stretch_width
;
16794 struct text_pos saved_pos
;
16795 int saved_face_id
, saved_avoid_cursor
;
16797 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16798 row_width
+= g
->pixel_width
;
16799 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16800 if (stretch_width
> 0)
16803 (((it
->ascent
+ it
->descent
)
16804 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16805 saved_pos
= it
->position
;
16806 memset (&it
->position
, 0, sizeof it
->position
);
16807 saved_avoid_cursor
= it
->avoid_cursor_p
;
16808 it
->avoid_cursor_p
= 1;
16809 saved_face_id
= it
->face_id
;
16810 /* The last row's stretch glyph should get the default
16811 face, to avoid painting the rest of the window with
16812 the region face, if the region ends at ZV. */
16813 if (it
->glyph_row
->ends_at_zv_p
)
16814 it
->face_id
= DEFAULT_FACE_ID
;
16816 it
->face_id
= face
->id
;
16817 append_stretch_glyph (it
, make_number (0), stretch_width
,
16818 it
->ascent
+ it
->descent
, stretch_ascent
);
16819 it
->position
= saved_pos
;
16820 it
->avoid_cursor_p
= saved_avoid_cursor
;
16821 it
->face_id
= saved_face_id
;
16824 #endif /* HAVE_WINDOW_SYSTEM */
16828 /* Save some values that must not be changed. */
16829 int saved_x
= it
->current_x
;
16830 struct text_pos saved_pos
;
16831 Lisp_Object saved_object
;
16832 enum display_element_type saved_what
= it
->what
;
16833 int saved_face_id
= it
->face_id
;
16835 saved_object
= it
->object
;
16836 saved_pos
= it
->position
;
16838 it
->what
= IT_CHARACTER
;
16839 memset (&it
->position
, 0, sizeof it
->position
);
16840 it
->object
= make_number (0);
16841 it
->c
= it
->char_to_display
= ' ';
16843 /* The last row's blank glyphs should get the default face, to
16844 avoid painting the rest of the window with the region face,
16845 if the region ends at ZV. */
16846 if (it
->glyph_row
->ends_at_zv_p
)
16847 it
->face_id
= DEFAULT_FACE_ID
;
16849 it
->face_id
= face
->id
;
16851 PRODUCE_GLYPHS (it
);
16853 while (it
->current_x
<= it
->last_visible_x
)
16854 PRODUCE_GLYPHS (it
);
16856 /* Don't count these blanks really. It would let us insert a left
16857 truncation glyph below and make us set the cursor on them, maybe. */
16858 it
->current_x
= saved_x
;
16859 it
->object
= saved_object
;
16860 it
->position
= saved_pos
;
16861 it
->what
= saved_what
;
16862 it
->face_id
= saved_face_id
;
16867 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16868 trailing whitespace. */
16871 trailing_whitespace_p (EMACS_INT charpos
)
16873 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16876 while (bytepos
< ZV_BYTE
16877 && (c
= FETCH_CHAR (bytepos
),
16878 c
== ' ' || c
== '\t'))
16881 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16883 if (bytepos
!= PT_BYTE
)
16890 /* Highlight trailing whitespace, if any, in ROW. */
16893 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16895 int used
= row
->used
[TEXT_AREA
];
16899 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16900 struct glyph
*glyph
= start
+ used
- 1;
16902 if (row
->reversed_p
)
16904 /* Right-to-left rows need to be processed in the opposite
16905 direction, so swap the edge pointers. */
16907 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16910 /* Skip over glyphs inserted to display the cursor at the
16911 end of a line, for extending the face of the last glyph
16912 to the end of the line on terminals, and for truncation
16913 and continuation glyphs. */
16914 if (!row
->reversed_p
)
16916 while (glyph
>= start
16917 && glyph
->type
== CHAR_GLYPH
16918 && INTEGERP (glyph
->object
))
16923 while (glyph
<= start
16924 && glyph
->type
== CHAR_GLYPH
16925 && INTEGERP (glyph
->object
))
16929 /* If last glyph is a space or stretch, and it's trailing
16930 whitespace, set the face of all trailing whitespace glyphs in
16931 IT->glyph_row to `trailing-whitespace'. */
16932 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16933 && BUFFERP (glyph
->object
)
16934 && (glyph
->type
== STRETCH_GLYPH
16935 || (glyph
->type
== CHAR_GLYPH
16936 && glyph
->u
.ch
== ' '))
16937 && trailing_whitespace_p (glyph
->charpos
))
16939 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16943 if (!row
->reversed_p
)
16945 while (glyph
>= start
16946 && BUFFERP (glyph
->object
)
16947 && (glyph
->type
== STRETCH_GLYPH
16948 || (glyph
->type
== CHAR_GLYPH
16949 && glyph
->u
.ch
== ' ')))
16950 (glyph
--)->face_id
= face_id
;
16954 while (glyph
<= start
16955 && BUFFERP (glyph
->object
)
16956 && (glyph
->type
== STRETCH_GLYPH
16957 || (glyph
->type
== CHAR_GLYPH
16958 && glyph
->u
.ch
== ' ')))
16959 (glyph
++)->face_id
= face_id
;
16966 /* Value is non-zero if glyph row ROW should be
16967 used to hold the cursor. */
16970 cursor_row_p (struct glyph_row
*row
)
16974 if (PT
== CHARPOS (row
->end
.pos
))
16976 /* Suppose the row ends on a string.
16977 Unless the row is continued, that means it ends on a newline
16978 in the string. If it's anything other than a display string
16979 (e.g. a before-string from an overlay), we don't want the
16980 cursor there. (This heuristic seems to give the optimal
16981 behavior for the various types of multi-line strings.) */
16982 if (CHARPOS (row
->end
.string_pos
) >= 0)
16984 if (row
->continued_p
)
16988 /* Check for `display' property. */
16989 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16990 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16991 struct glyph
*glyph
;
16994 for (glyph
= end
; glyph
>= beg
; --glyph
)
16995 if (STRINGP (glyph
->object
))
16998 = Fget_char_property (make_number (PT
),
17002 && display_prop_string_p (prop
, glyph
->object
));
17007 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17009 /* If the row ends in middle of a real character,
17010 and the line is continued, we want the cursor here.
17011 That's because CHARPOS (ROW->end.pos) would equal
17012 PT if PT is before the character. */
17013 if (!row
->ends_in_ellipsis_p
)
17014 result
= row
->continued_p
;
17016 /* If the row ends in an ellipsis, then
17017 CHARPOS (ROW->end.pos) will equal point after the
17018 invisible text. We want that position to be displayed
17019 after the ellipsis. */
17022 /* If the row ends at ZV, display the cursor at the end of that
17023 row instead of at the start of the row below. */
17024 else if (row
->ends_at_zv_p
)
17035 /* Push the display property PROP so that it will be rendered at the
17036 current position in IT. Return 1 if PROP was successfully pushed,
17040 push_display_prop (struct it
*it
, Lisp_Object prop
)
17044 if (STRINGP (prop
))
17046 if (SCHARS (prop
) == 0)
17053 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17054 it
->current
.overlay_string_index
= -1;
17055 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17056 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17057 it
->method
= GET_FROM_STRING
;
17058 it
->stop_charpos
= 0;
17060 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17062 it
->method
= GET_FROM_STRETCH
;
17065 #ifdef HAVE_WINDOW_SYSTEM
17066 else if (IMAGEP (prop
))
17068 it
->what
= IT_IMAGE
;
17069 it
->image_id
= lookup_image (it
->f
, prop
);
17070 it
->method
= GET_FROM_IMAGE
;
17072 #endif /* HAVE_WINDOW_SYSTEM */
17075 pop_it (it
); /* bogus display property, give up */
17082 /* Return the character-property PROP at the current position in IT. */
17085 get_it_property (struct it
*it
, Lisp_Object prop
)
17087 Lisp_Object position
;
17089 if (STRINGP (it
->object
))
17090 position
= make_number (IT_STRING_CHARPOS (*it
));
17091 else if (BUFFERP (it
->object
))
17092 position
= make_number (IT_CHARPOS (*it
));
17096 return Fget_char_property (position
, prop
, it
->object
);
17099 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17102 handle_line_prefix (struct it
*it
)
17104 Lisp_Object prefix
;
17105 if (it
->continuation_lines_width
> 0)
17107 prefix
= get_it_property (it
, Qwrap_prefix
);
17109 prefix
= Vwrap_prefix
;
17113 prefix
= get_it_property (it
, Qline_prefix
);
17115 prefix
= Vline_prefix
;
17117 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17119 /* If the prefix is wider than the window, and we try to wrap
17120 it, it would acquire its own wrap prefix, and so on till the
17121 iterator stack overflows. So, don't wrap the prefix. */
17122 it
->line_wrap
= TRUNCATE
;
17123 it
->avoid_cursor_p
= 1;
17129 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17130 only for R2L lines from display_line, when it decides that too many
17131 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17134 unproduce_glyphs (struct it
*it
, int n
)
17136 struct glyph
*glyph
, *end
;
17138 xassert (it
->glyph_row
);
17139 xassert (it
->glyph_row
->reversed_p
);
17140 xassert (it
->area
== TEXT_AREA
);
17141 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17143 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17144 n
= it
->glyph_row
->used
[TEXT_AREA
];
17145 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17146 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17147 for ( ; glyph
< end
; glyph
++)
17148 glyph
[-n
] = *glyph
;
17151 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17152 and ROW->maxpos. */
17154 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17155 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17156 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17158 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17159 lines' rows is implemented for bidi-reordered rows. */
17161 /* ROW->minpos is the value of min_pos, the minimal buffer position
17164 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17166 /* We didn't find _any_ valid buffer positions in any of the
17167 glyphs, so we must trust the iterator's computed positions. */
17168 row
->minpos
= row
->start
.pos
;
17171 max_pos
= CHARPOS (it
->current
.pos
);
17172 max_bpos
= BYTEPOS (it
->current
.pos
);
17175 /* Here are the various use-cases for ending the row, and the
17176 corresponding values for ROW->maxpos:
17178 Line ends in a newline from buffer eol_pos + 1
17179 Line is continued from buffer max_pos + 1
17180 Line is truncated on right it->current.pos
17181 Line ends in a newline from string max_pos
17182 Line is continued from string max_pos
17183 Line is continued from display vector max_pos
17184 Line is entirely from a string min_pos == max_pos
17185 Line is entirely from a display vector min_pos == max_pos
17186 Line that ends at ZV ZV
17188 If you discover other use-cases, please add them here as
17190 if (row
->ends_at_zv_p
)
17191 row
->maxpos
= it
->current
.pos
;
17192 else if (row
->used
[TEXT_AREA
])
17194 if (row
->ends_in_newline_from_string_p
)
17195 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17196 else if (CHARPOS (it
->eol_pos
) > 0)
17197 SET_TEXT_POS (row
->maxpos
,
17198 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17199 else if (row
->continued_p
)
17201 /* If max_pos is different from IT's current position, it
17202 means IT->method does not belong to the display element
17203 at max_pos. However, it also means that the display
17204 element at max_pos was displayed in its entirety on this
17205 line, which is equivalent to saying that the next line
17206 starts at the next buffer position. */
17207 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17208 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17211 INC_BOTH (max_pos
, max_bpos
);
17212 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17215 else if (row
->truncated_on_right_p
)
17216 /* display_line already called reseat_at_next_visible_line_start,
17217 which puts the iterator at the beginning of the next line, in
17218 the logical order. */
17219 row
->maxpos
= it
->current
.pos
;
17220 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17221 /* A line that is entirely from a string/image/stretch... */
17222 row
->maxpos
= row
->minpos
;
17227 row
->maxpos
= it
->current
.pos
;
17230 /* Construct the glyph row IT->glyph_row in the desired matrix of
17231 IT->w from text at the current position of IT. See dispextern.h
17232 for an overview of struct it. Value is non-zero if
17233 IT->glyph_row displays text, as opposed to a line displaying ZV
17237 display_line (struct it
*it
)
17239 struct glyph_row
*row
= it
->glyph_row
;
17240 Lisp_Object overlay_arrow_string
;
17242 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17243 int wrap_row_used
= -1;
17244 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17245 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17246 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17247 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17248 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17250 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17251 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17253 /* We always start displaying at hpos zero even if hscrolled. */
17254 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17256 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17257 >= it
->w
->desired_matrix
->nrows
)
17259 it
->w
->nrows_scale_factor
++;
17260 fonts_changed_p
= 1;
17264 /* Is IT->w showing the region? */
17265 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17267 /* Clear the result glyph row and enable it. */
17268 prepare_desired_row (row
);
17270 row
->y
= it
->current_y
;
17271 row
->start
= it
->start
;
17272 row
->continuation_lines_width
= it
->continuation_lines_width
;
17273 row
->displays_text_p
= 1;
17274 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17275 it
->starts_in_middle_of_char_p
= 0;
17277 /* Arrange the overlays nicely for our purposes. Usually, we call
17278 display_line on only one line at a time, in which case this
17279 can't really hurt too much, or we call it on lines which appear
17280 one after another in the buffer, in which case all calls to
17281 recenter_overlay_lists but the first will be pretty cheap. */
17282 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17284 /* Move over display elements that are not visible because we are
17285 hscrolled. This may stop at an x-position < IT->first_visible_x
17286 if the first glyph is partially visible or if we hit a line end. */
17287 if (it
->current_x
< it
->first_visible_x
)
17289 this_line_min_pos
= row
->start
.pos
;
17290 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17291 MOVE_TO_POS
| MOVE_TO_X
);
17292 /* Record the smallest positions seen while we moved over
17293 display elements that are not visible. This is needed by
17294 redisplay_internal for optimizing the case where the cursor
17295 stays inside the same line. The rest of this function only
17296 considers positions that are actually displayed, so
17297 RECORD_MAX_MIN_POS will not otherwise record positions that
17298 are hscrolled to the left of the left edge of the window. */
17299 min_pos
= CHARPOS (this_line_min_pos
);
17300 min_bpos
= BYTEPOS (this_line_min_pos
);
17304 /* We only do this when not calling `move_it_in_display_line_to'
17305 above, because move_it_in_display_line_to calls
17306 handle_line_prefix itself. */
17307 handle_line_prefix (it
);
17310 /* Get the initial row height. This is either the height of the
17311 text hscrolled, if there is any, or zero. */
17312 row
->ascent
= it
->max_ascent
;
17313 row
->height
= it
->max_ascent
+ it
->max_descent
;
17314 row
->phys_ascent
= it
->max_phys_ascent
;
17315 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17316 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17318 /* Utility macro to record max and min buffer positions seen until now. */
17319 #define RECORD_MAX_MIN_POS(IT) \
17322 if (IT_CHARPOS (*(IT)) < min_pos) \
17324 min_pos = IT_CHARPOS (*(IT)); \
17325 min_bpos = IT_BYTEPOS (*(IT)); \
17327 if (IT_CHARPOS (*(IT)) > max_pos) \
17329 max_pos = IT_CHARPOS (*(IT)); \
17330 max_bpos = IT_BYTEPOS (*(IT)); \
17335 /* Loop generating characters. The loop is left with IT on the next
17336 character to display. */
17339 int n_glyphs_before
, hpos_before
, x_before
;
17341 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17343 /* Retrieve the next thing to display. Value is zero if end of
17345 if (!get_next_display_element (it
))
17347 /* Maybe add a space at the end of this line that is used to
17348 display the cursor there under X. Set the charpos of the
17349 first glyph of blank lines not corresponding to any text
17351 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17352 row
->exact_window_width_line_p
= 1;
17353 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17354 || row
->used
[TEXT_AREA
] == 0)
17356 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17357 row
->displays_text_p
= 0;
17359 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17360 && (!MINI_WINDOW_P (it
->w
)
17361 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17362 row
->indicate_empty_line_p
= 1;
17365 it
->continuation_lines_width
= 0;
17366 row
->ends_at_zv_p
= 1;
17367 /* A row that displays right-to-left text must always have
17368 its last face extended all the way to the end of line,
17369 even if this row ends in ZV, because we still write to
17370 the screen left to right. */
17371 if (row
->reversed_p
)
17372 extend_face_to_end_of_line (it
);
17376 /* Now, get the metrics of what we want to display. This also
17377 generates glyphs in `row' (which is IT->glyph_row). */
17378 n_glyphs_before
= row
->used
[TEXT_AREA
];
17381 /* Remember the line height so far in case the next element doesn't
17382 fit on the line. */
17383 if (it
->line_wrap
!= TRUNCATE
)
17385 ascent
= it
->max_ascent
;
17386 descent
= it
->max_descent
;
17387 phys_ascent
= it
->max_phys_ascent
;
17388 phys_descent
= it
->max_phys_descent
;
17390 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17392 if (IT_DISPLAYING_WHITESPACE (it
))
17398 wrap_row_used
= row
->used
[TEXT_AREA
];
17399 wrap_row_ascent
= row
->ascent
;
17400 wrap_row_height
= row
->height
;
17401 wrap_row_phys_ascent
= row
->phys_ascent
;
17402 wrap_row_phys_height
= row
->phys_height
;
17403 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17404 wrap_row_min_pos
= min_pos
;
17405 wrap_row_min_bpos
= min_bpos
;
17406 wrap_row_max_pos
= max_pos
;
17407 wrap_row_max_bpos
= max_bpos
;
17413 PRODUCE_GLYPHS (it
);
17415 /* If this display element was in marginal areas, continue with
17417 if (it
->area
!= TEXT_AREA
)
17419 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17420 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17421 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17422 row
->phys_height
= max (row
->phys_height
,
17423 it
->max_phys_ascent
+ it
->max_phys_descent
);
17424 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17425 it
->max_extra_line_spacing
);
17426 set_iterator_to_next (it
, 1);
17430 /* Does the display element fit on the line? If we truncate
17431 lines, we should draw past the right edge of the window. If
17432 we don't truncate, we want to stop so that we can display the
17433 continuation glyph before the right margin. If lines are
17434 continued, there are two possible strategies for characters
17435 resulting in more than 1 glyph (e.g. tabs): Display as many
17436 glyphs as possible in this line and leave the rest for the
17437 continuation line, or display the whole element in the next
17438 line. Original redisplay did the former, so we do it also. */
17439 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17440 hpos_before
= it
->hpos
;
17443 if (/* Not a newline. */
17445 /* Glyphs produced fit entirely in the line. */
17446 && it
->current_x
< it
->last_visible_x
)
17448 it
->hpos
+= nglyphs
;
17449 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17450 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17451 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17452 row
->phys_height
= max (row
->phys_height
,
17453 it
->max_phys_ascent
+ it
->max_phys_descent
);
17454 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17455 it
->max_extra_line_spacing
);
17456 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17457 row
->x
= x
- it
->first_visible_x
;
17458 /* Record the maximum and minimum buffer positions seen so
17459 far in glyphs that will be displayed by this row. */
17461 RECORD_MAX_MIN_POS (it
);
17466 struct glyph
*glyph
;
17468 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17470 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17471 new_x
= x
+ glyph
->pixel_width
;
17473 if (/* Lines are continued. */
17474 it
->line_wrap
!= TRUNCATE
17475 && (/* Glyph doesn't fit on the line. */
17476 new_x
> it
->last_visible_x
17477 /* Or it fits exactly on a window system frame. */
17478 || (new_x
== it
->last_visible_x
17479 && FRAME_WINDOW_P (it
->f
))))
17481 /* End of a continued line. */
17484 || (new_x
== it
->last_visible_x
17485 && FRAME_WINDOW_P (it
->f
)))
17487 /* Current glyph is the only one on the line or
17488 fits exactly on the line. We must continue
17489 the line because we can't draw the cursor
17490 after the glyph. */
17491 row
->continued_p
= 1;
17492 it
->current_x
= new_x
;
17493 it
->continuation_lines_width
+= new_x
;
17495 /* Record the maximum and minimum buffer
17496 positions seen so far in glyphs that will be
17497 displayed by this row. */
17499 RECORD_MAX_MIN_POS (it
);
17500 if (i
== nglyphs
- 1)
17502 /* If line-wrap is on, check if a previous
17503 wrap point was found. */
17504 if (wrap_row_used
> 0
17505 /* Even if there is a previous wrap
17506 point, continue the line here as
17507 usual, if (i) the previous character
17508 was a space or tab AND (ii) the
17509 current character is not. */
17511 || IT_DISPLAYING_WHITESPACE (it
)))
17514 set_iterator_to_next (it
, 1);
17515 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17517 if (!get_next_display_element (it
))
17519 row
->exact_window_width_line_p
= 1;
17520 it
->continuation_lines_width
= 0;
17521 row
->continued_p
= 0;
17522 row
->ends_at_zv_p
= 1;
17524 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17526 row
->continued_p
= 0;
17527 row
->exact_window_width_line_p
= 1;
17532 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17533 && !FRAME_WINDOW_P (it
->f
))
17535 /* A padding glyph that doesn't fit on this line.
17536 This means the whole character doesn't fit
17538 if (row
->reversed_p
)
17539 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17540 - n_glyphs_before
);
17541 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17543 /* Fill the rest of the row with continuation
17544 glyphs like in 20.x. */
17545 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17546 < row
->glyphs
[1 + TEXT_AREA
])
17547 produce_special_glyphs (it
, IT_CONTINUATION
);
17549 row
->continued_p
= 1;
17550 it
->current_x
= x_before
;
17551 it
->continuation_lines_width
+= x_before
;
17553 /* Restore the height to what it was before the
17554 element not fitting on the line. */
17555 it
->max_ascent
= ascent
;
17556 it
->max_descent
= descent
;
17557 it
->max_phys_ascent
= phys_ascent
;
17558 it
->max_phys_descent
= phys_descent
;
17560 else if (wrap_row_used
> 0)
17563 if (row
->reversed_p
)
17564 unproduce_glyphs (it
,
17565 row
->used
[TEXT_AREA
] - wrap_row_used
);
17567 it
->continuation_lines_width
+= wrap_x
;
17568 row
->used
[TEXT_AREA
] = wrap_row_used
;
17569 row
->ascent
= wrap_row_ascent
;
17570 row
->height
= wrap_row_height
;
17571 row
->phys_ascent
= wrap_row_phys_ascent
;
17572 row
->phys_height
= wrap_row_phys_height
;
17573 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17574 min_pos
= wrap_row_min_pos
;
17575 min_bpos
= wrap_row_min_bpos
;
17576 max_pos
= wrap_row_max_pos
;
17577 max_bpos
= wrap_row_max_bpos
;
17578 row
->continued_p
= 1;
17579 row
->ends_at_zv_p
= 0;
17580 row
->exact_window_width_line_p
= 0;
17581 it
->continuation_lines_width
+= x
;
17583 /* Make sure that a non-default face is extended
17584 up to the right margin of the window. */
17585 extend_face_to_end_of_line (it
);
17587 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17589 /* A TAB that extends past the right edge of the
17590 window. This produces a single glyph on
17591 window system frames. We leave the glyph in
17592 this row and let it fill the row, but don't
17593 consume the TAB. */
17594 it
->continuation_lines_width
+= it
->last_visible_x
;
17595 row
->ends_in_middle_of_char_p
= 1;
17596 row
->continued_p
= 1;
17597 glyph
->pixel_width
= it
->last_visible_x
- x
;
17598 it
->starts_in_middle_of_char_p
= 1;
17602 /* Something other than a TAB that draws past
17603 the right edge of the window. Restore
17604 positions to values before the element. */
17605 if (row
->reversed_p
)
17606 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17607 - (n_glyphs_before
+ i
));
17608 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17610 /* Display continuation glyphs. */
17611 if (!FRAME_WINDOW_P (it
->f
))
17612 produce_special_glyphs (it
, IT_CONTINUATION
);
17613 row
->continued_p
= 1;
17615 it
->current_x
= x_before
;
17616 it
->continuation_lines_width
+= x
;
17617 extend_face_to_end_of_line (it
);
17619 if (nglyphs
> 1 && i
> 0)
17621 row
->ends_in_middle_of_char_p
= 1;
17622 it
->starts_in_middle_of_char_p
= 1;
17625 /* Restore the height to what it was before the
17626 element not fitting on the line. */
17627 it
->max_ascent
= ascent
;
17628 it
->max_descent
= descent
;
17629 it
->max_phys_ascent
= phys_ascent
;
17630 it
->max_phys_descent
= phys_descent
;
17635 else if (new_x
> it
->first_visible_x
)
17637 /* Increment number of glyphs actually displayed. */
17640 /* Record the maximum and minimum buffer positions
17641 seen so far in glyphs that will be displayed by
17644 RECORD_MAX_MIN_POS (it
);
17646 if (x
< it
->first_visible_x
)
17647 /* Glyph is partially visible, i.e. row starts at
17648 negative X position. */
17649 row
->x
= x
- it
->first_visible_x
;
17653 /* Glyph is completely off the left margin of the
17654 window. This should not happen because of the
17655 move_it_in_display_line at the start of this
17656 function, unless the text display area of the
17657 window is empty. */
17658 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17662 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17663 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17664 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17665 row
->phys_height
= max (row
->phys_height
,
17666 it
->max_phys_ascent
+ it
->max_phys_descent
);
17667 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17668 it
->max_extra_line_spacing
);
17670 /* End of this display line if row is continued. */
17671 if (row
->continued_p
|| row
->ends_at_zv_p
)
17676 /* Is this a line end? If yes, we're also done, after making
17677 sure that a non-default face is extended up to the right
17678 margin of the window. */
17679 if (ITERATOR_AT_END_OF_LINE_P (it
))
17681 int used_before
= row
->used
[TEXT_AREA
];
17683 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17685 /* Add a space at the end of the line that is used to
17686 display the cursor there. */
17687 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17688 append_space_for_newline (it
, 0);
17690 /* Extend the face to the end of the line. */
17691 extend_face_to_end_of_line (it
);
17693 /* Make sure we have the position. */
17694 if (used_before
== 0)
17695 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17697 /* Record the position of the newline, for use in
17699 it
->eol_pos
= it
->current
.pos
;
17701 /* Consume the line end. This skips over invisible lines. */
17702 set_iterator_to_next (it
, 1);
17703 it
->continuation_lines_width
= 0;
17707 /* Proceed with next display element. Note that this skips
17708 over lines invisible because of selective display. */
17709 set_iterator_to_next (it
, 1);
17711 /* If we truncate lines, we are done when the last displayed
17712 glyphs reach past the right margin of the window. */
17713 if (it
->line_wrap
== TRUNCATE
17714 && (FRAME_WINDOW_P (it
->f
)
17715 ? (it
->current_x
>= it
->last_visible_x
)
17716 : (it
->current_x
> it
->last_visible_x
)))
17718 /* Maybe add truncation glyphs. */
17719 if (!FRAME_WINDOW_P (it
->f
))
17723 if (!row
->reversed_p
)
17725 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17726 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17731 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17732 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17734 /* Remove any padding glyphs at the front of ROW, to
17735 make room for the truncation glyphs we will be
17736 adding below. The loop below always inserts at
17737 least one truncation glyph, so also remove the
17738 last glyph added to ROW. */
17739 unproduce_glyphs (it
, i
+ 1);
17740 /* Adjust i for the loop below. */
17741 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17744 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17746 row
->used
[TEXT_AREA
] = i
;
17747 produce_special_glyphs (it
, IT_TRUNCATION
);
17750 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17752 /* Don't truncate if we can overflow newline into fringe. */
17753 if (!get_next_display_element (it
))
17755 it
->continuation_lines_width
= 0;
17756 row
->ends_at_zv_p
= 1;
17757 row
->exact_window_width_line_p
= 1;
17760 if (ITERATOR_AT_END_OF_LINE_P (it
))
17762 row
->exact_window_width_line_p
= 1;
17763 goto at_end_of_line
;
17767 row
->truncated_on_right_p
= 1;
17768 it
->continuation_lines_width
= 0;
17769 reseat_at_next_visible_line_start (it
, 0);
17770 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17771 it
->hpos
= hpos_before
;
17772 it
->current_x
= x_before
;
17777 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17778 at the left window margin. */
17779 if (it
->first_visible_x
17780 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17782 if (!FRAME_WINDOW_P (it
->f
))
17783 insert_left_trunc_glyphs (it
);
17784 row
->truncated_on_left_p
= 1;
17787 /* Remember the position at which this line ends.
17789 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17790 cannot be before the call to find_row_edges below, since that is
17791 where these positions are determined. */
17792 row
->end
= it
->current
;
17795 row
->minpos
= row
->start
.pos
;
17796 row
->maxpos
= row
->end
.pos
;
17800 /* ROW->minpos and ROW->maxpos must be the smallest and
17801 `1 + the largest' buffer positions in ROW. But if ROW was
17802 bidi-reordered, these two positions can be anywhere in the
17803 row, so we must determine them now. */
17804 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17807 /* If the start of this line is the overlay arrow-position, then
17808 mark this glyph row as the one containing the overlay arrow.
17809 This is clearly a mess with variable size fonts. It would be
17810 better to let it be displayed like cursors under X. */
17811 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17812 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17813 !NILP (overlay_arrow_string
)))
17815 /* Overlay arrow in window redisplay is a fringe bitmap. */
17816 if (STRINGP (overlay_arrow_string
))
17818 struct glyph_row
*arrow_row
17819 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17820 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17821 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17822 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17823 struct glyph
*p2
, *end
;
17825 /* Copy the arrow glyphs. */
17826 while (glyph
< arrow_end
)
17829 /* Throw away padding glyphs. */
17831 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17832 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17838 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17843 xassert (INTEGERP (overlay_arrow_string
));
17844 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17846 overlay_arrow_seen
= 1;
17849 /* Compute pixel dimensions of this line. */
17850 compute_line_metrics (it
);
17852 /* Record whether this row ends inside an ellipsis. */
17853 row
->ends_in_ellipsis_p
17854 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17855 && it
->ellipsis_p
);
17857 /* Save fringe bitmaps in this row. */
17858 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17859 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17860 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17861 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17863 it
->left_user_fringe_bitmap
= 0;
17864 it
->left_user_fringe_face_id
= 0;
17865 it
->right_user_fringe_bitmap
= 0;
17866 it
->right_user_fringe_face_id
= 0;
17868 /* Maybe set the cursor. */
17869 cvpos
= it
->w
->cursor
.vpos
;
17871 /* In bidi-reordered rows, keep checking for proper cursor
17872 position even if one has been found already, because buffer
17873 positions in such rows change non-linearly with ROW->VPOS,
17874 when a line is continued. One exception: when we are at ZV,
17875 display cursor on the first suitable glyph row, since all
17876 the empty rows after that also have their position set to ZV. */
17877 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17878 lines' rows is implemented for bidi-reordered rows. */
17880 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17881 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17882 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17883 && cursor_row_p (row
))
17884 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17886 /* Highlight trailing whitespace. */
17887 if (!NILP (Vshow_trailing_whitespace
))
17888 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17890 /* Prepare for the next line. This line starts horizontally at (X
17891 HPOS) = (0 0). Vertical positions are incremented. As a
17892 convenience for the caller, IT->glyph_row is set to the next
17894 it
->current_x
= it
->hpos
= 0;
17895 it
->current_y
+= row
->height
;
17896 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17899 /* The next row should by default use the same value of the
17900 reversed_p flag as this one. set_iterator_to_next decides when
17901 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17902 the flag accordingly. */
17903 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17904 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17905 it
->start
= row
->end
;
17906 return row
->displays_text_p
;
17908 #undef RECORD_MAX_MIN_POS
17911 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17912 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17913 doc
: /* Return paragraph direction at point in BUFFER.
17914 Value is either `left-to-right' or `right-to-left'.
17915 If BUFFER is omitted or nil, it defaults to the current buffer.
17917 Paragraph direction determines how the text in the paragraph is displayed.
17918 In left-to-right paragraphs, text begins at the left margin of the window
17919 and the reading direction is generally left to right. In right-to-left
17920 paragraphs, text begins at the right margin and is read from right to left.
17922 See also `bidi-paragraph-direction'. */)
17923 (Lisp_Object buffer
)
17925 struct buffer
*buf
= current_buffer
;
17926 struct buffer
*old
= buf
;
17928 if (! NILP (buffer
))
17930 CHECK_BUFFER (buffer
);
17931 buf
= XBUFFER (buffer
);
17934 if (NILP (BVAR (buf
, bidi_display_reordering
)))
17935 return Qleft_to_right
;
17936 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
17937 return BVAR (buf
, bidi_paragraph_direction
);
17940 /* Determine the direction from buffer text. We could try to
17941 use current_matrix if it is up to date, but this seems fast
17942 enough as it is. */
17943 struct bidi_it itb
;
17944 EMACS_INT pos
= BUF_PT (buf
);
17945 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17948 set_buffer_temp (buf
);
17949 /* bidi_paragraph_init finds the base direction of the paragraph
17950 by searching forward from paragraph start. We need the base
17951 direction of the current or _previous_ paragraph, so we need
17952 to make sure we are within that paragraph. To that end, find
17953 the previous non-empty line. */
17954 if (pos
>= ZV
&& pos
> BEGV
)
17957 bytepos
= CHAR_TO_BYTE (pos
);
17959 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17960 || c
== ' ' || c
== '\t' || c
== '\f')
17962 if (bytepos
<= BEGV_BYTE
)
17967 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17970 itb
.bytepos
= bytepos
;
17972 itb
.separator_limit
= -1;
17973 itb
.paragraph_dir
= NEUTRAL_DIR
;
17975 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
17976 set_buffer_temp (old
);
17977 switch (itb
.paragraph_dir
)
17980 return Qleft_to_right
;
17983 return Qright_to_left
;
17993 /***********************************************************************
17995 ***********************************************************************/
17997 /* Redisplay the menu bar in the frame for window W.
17999 The menu bar of X frames that don't have X toolkit support is
18000 displayed in a special window W->frame->menu_bar_window.
18002 The menu bar of terminal frames is treated specially as far as
18003 glyph matrices are concerned. Menu bar lines are not part of
18004 windows, so the update is done directly on the frame matrix rows
18005 for the menu bar. */
18008 display_menu_bar (struct window
*w
)
18010 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18015 /* Don't do all this for graphical frames. */
18017 if (FRAME_W32_P (f
))
18020 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18026 if (FRAME_NS_P (f
))
18028 #endif /* HAVE_NS */
18030 #ifdef USE_X_TOOLKIT
18031 xassert (!FRAME_WINDOW_P (f
));
18032 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18033 it
.first_visible_x
= 0;
18034 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18035 #else /* not USE_X_TOOLKIT */
18036 if (FRAME_WINDOW_P (f
))
18038 /* Menu bar lines are displayed in the desired matrix of the
18039 dummy window menu_bar_window. */
18040 struct window
*menu_w
;
18041 xassert (WINDOWP (f
->menu_bar_window
));
18042 menu_w
= XWINDOW (f
->menu_bar_window
);
18043 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18045 it
.first_visible_x
= 0;
18046 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18050 /* This is a TTY frame, i.e. character hpos/vpos are used as
18052 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18054 it
.first_visible_x
= 0;
18055 it
.last_visible_x
= FRAME_COLS (f
);
18057 #endif /* not USE_X_TOOLKIT */
18059 if (! mode_line_inverse_video
)
18060 /* Force the menu-bar to be displayed in the default face. */
18061 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18063 /* Clear all rows of the menu bar. */
18064 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18066 struct glyph_row
*row
= it
.glyph_row
+ i
;
18067 clear_glyph_row (row
);
18068 row
->enabled_p
= 1;
18069 row
->full_width_p
= 1;
18072 /* Display all items of the menu bar. */
18073 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18074 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18076 Lisp_Object string
;
18078 /* Stop at nil string. */
18079 string
= AREF (items
, i
+ 1);
18083 /* Remember where item was displayed. */
18084 ASET (items
, i
+ 3, make_number (it
.hpos
));
18086 /* Display the item, pad with one space. */
18087 if (it
.current_x
< it
.last_visible_x
)
18088 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18089 SCHARS (string
) + 1, 0, 0, -1);
18092 /* Fill out the line with spaces. */
18093 if (it
.current_x
< it
.last_visible_x
)
18094 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18096 /* Compute the total height of the lines. */
18097 compute_line_metrics (&it
);
18102 /***********************************************************************
18104 ***********************************************************************/
18106 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18107 FORCE is non-zero, redisplay mode lines unconditionally.
18108 Otherwise, redisplay only mode lines that are garbaged. Value is
18109 the number of windows whose mode lines were redisplayed. */
18112 redisplay_mode_lines (Lisp_Object window
, int force
)
18116 while (!NILP (window
))
18118 struct window
*w
= XWINDOW (window
);
18120 if (WINDOWP (w
->hchild
))
18121 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18122 else if (WINDOWP (w
->vchild
))
18123 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18125 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18126 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18128 struct text_pos lpoint
;
18129 struct buffer
*old
= current_buffer
;
18131 /* Set the window's buffer for the mode line display. */
18132 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18133 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18135 /* Point refers normally to the selected window. For any
18136 other window, set up appropriate value. */
18137 if (!EQ (window
, selected_window
))
18139 struct text_pos pt
;
18141 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18142 if (CHARPOS (pt
) < BEGV
)
18143 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18144 else if (CHARPOS (pt
) > (ZV
- 1))
18145 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18147 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18150 /* Display mode lines. */
18151 clear_glyph_matrix (w
->desired_matrix
);
18152 if (display_mode_lines (w
))
18155 w
->must_be_updated_p
= 1;
18158 /* Restore old settings. */
18159 set_buffer_internal_1 (old
);
18160 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18170 /* Display the mode and/or header line of window W. Value is the
18171 sum number of mode lines and header lines displayed. */
18174 display_mode_lines (struct window
*w
)
18176 Lisp_Object old_selected_window
, old_selected_frame
;
18179 old_selected_frame
= selected_frame
;
18180 selected_frame
= w
->frame
;
18181 old_selected_window
= selected_window
;
18182 XSETWINDOW (selected_window
, w
);
18184 /* These will be set while the mode line specs are processed. */
18185 line_number_displayed
= 0;
18186 w
->column_number_displayed
= Qnil
;
18188 if (WINDOW_WANTS_MODELINE_P (w
))
18190 struct window
*sel_w
= XWINDOW (old_selected_window
);
18192 /* Select mode line face based on the real selected window. */
18193 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18194 BVAR (current_buffer
, mode_line_format
));
18198 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18200 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18201 BVAR (current_buffer
, header_line_format
));
18205 selected_frame
= old_selected_frame
;
18206 selected_window
= old_selected_window
;
18211 /* Display mode or header line of window W. FACE_ID specifies which
18212 line to display; it is either MODE_LINE_FACE_ID or
18213 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18214 display. Value is the pixel height of the mode/header line
18218 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18222 int count
= SPECPDL_INDEX ();
18224 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18225 /* Don't extend on a previously drawn mode-line.
18226 This may happen if called from pos_visible_p. */
18227 it
.glyph_row
->enabled_p
= 0;
18228 prepare_desired_row (it
.glyph_row
);
18230 it
.glyph_row
->mode_line_p
= 1;
18232 if (! mode_line_inverse_video
)
18233 /* Force the mode-line to be displayed in the default face. */
18234 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18236 record_unwind_protect (unwind_format_mode_line
,
18237 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18239 mode_line_target
= MODE_LINE_DISPLAY
;
18241 /* Temporarily make frame's keyboard the current kboard so that
18242 kboard-local variables in the mode_line_format will get the right
18244 push_kboard (FRAME_KBOARD (it
.f
));
18245 record_unwind_save_match_data ();
18246 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18249 unbind_to (count
, Qnil
);
18251 /* Fill up with spaces. */
18252 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18254 compute_line_metrics (&it
);
18255 it
.glyph_row
->full_width_p
= 1;
18256 it
.glyph_row
->continued_p
= 0;
18257 it
.glyph_row
->truncated_on_left_p
= 0;
18258 it
.glyph_row
->truncated_on_right_p
= 0;
18260 /* Make a 3D mode-line have a shadow at its right end. */
18261 face
= FACE_FROM_ID (it
.f
, face_id
);
18262 extend_face_to_end_of_line (&it
);
18263 if (face
->box
!= FACE_NO_BOX
)
18265 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18266 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18267 last
->right_box_line_p
= 1;
18270 return it
.glyph_row
->height
;
18273 /* Move element ELT in LIST to the front of LIST.
18274 Return the updated list. */
18277 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18279 register Lisp_Object tail
, prev
;
18280 register Lisp_Object tem
;
18284 while (CONSP (tail
))
18290 /* Splice out the link TAIL. */
18292 list
= XCDR (tail
);
18294 Fsetcdr (prev
, XCDR (tail
));
18296 /* Now make it the first. */
18297 Fsetcdr (tail
, list
);
18302 tail
= XCDR (tail
);
18306 /* Not found--return unchanged LIST. */
18310 /* Contribute ELT to the mode line for window IT->w. How it
18311 translates into text depends on its data type.
18313 IT describes the display environment in which we display, as usual.
18315 DEPTH is the depth in recursion. It is used to prevent
18316 infinite recursion here.
18318 FIELD_WIDTH is the number of characters the display of ELT should
18319 occupy in the mode line, and PRECISION is the maximum number of
18320 characters to display from ELT's representation. See
18321 display_string for details.
18323 Returns the hpos of the end of the text generated by ELT.
18325 PROPS is a property list to add to any string we encounter.
18327 If RISKY is nonzero, remove (disregard) any properties in any string
18328 we encounter, and ignore :eval and :propertize.
18330 The global variable `mode_line_target' determines whether the
18331 output is passed to `store_mode_line_noprop',
18332 `store_mode_line_string', or `display_string'. */
18335 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18336 Lisp_Object elt
, Lisp_Object props
, int risky
)
18338 int n
= 0, field
, prec
;
18343 elt
= build_string ("*too-deep*");
18347 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18351 /* A string: output it and check for %-constructs within it. */
18353 EMACS_INT offset
= 0;
18355 if (SCHARS (elt
) > 0
18356 && (!NILP (props
) || risky
))
18358 Lisp_Object oprops
, aelt
;
18359 oprops
= Ftext_properties_at (make_number (0), elt
);
18361 /* If the starting string's properties are not what
18362 we want, translate the string. Also, if the string
18363 is risky, do that anyway. */
18365 if (NILP (Fequal (props
, oprops
)) || risky
)
18367 /* If the starting string has properties,
18368 merge the specified ones onto the existing ones. */
18369 if (! NILP (oprops
) && !risky
)
18373 oprops
= Fcopy_sequence (oprops
);
18375 while (CONSP (tem
))
18377 oprops
= Fplist_put (oprops
, XCAR (tem
),
18378 XCAR (XCDR (tem
)));
18379 tem
= XCDR (XCDR (tem
));
18384 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18385 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18387 /* AELT is what we want. Move it to the front
18388 without consing. */
18390 mode_line_proptrans_alist
18391 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18397 /* If AELT has the wrong props, it is useless.
18398 so get rid of it. */
18400 mode_line_proptrans_alist
18401 = Fdelq (aelt
, mode_line_proptrans_alist
);
18403 elt
= Fcopy_sequence (elt
);
18404 Fset_text_properties (make_number (0), Flength (elt
),
18406 /* Add this item to mode_line_proptrans_alist. */
18407 mode_line_proptrans_alist
18408 = Fcons (Fcons (elt
, props
),
18409 mode_line_proptrans_alist
);
18410 /* Truncate mode_line_proptrans_alist
18411 to at most 50 elements. */
18412 tem
= Fnthcdr (make_number (50),
18413 mode_line_proptrans_alist
);
18415 XSETCDR (tem
, Qnil
);
18424 prec
= precision
- n
;
18425 switch (mode_line_target
)
18427 case MODE_LINE_NOPROP
:
18428 case MODE_LINE_TITLE
:
18429 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18431 case MODE_LINE_STRING
:
18432 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18434 case MODE_LINE_DISPLAY
:
18435 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18436 0, prec
, 0, STRING_MULTIBYTE (elt
));
18443 /* Handle the non-literal case. */
18445 while ((precision
<= 0 || n
< precision
)
18446 && SREF (elt
, offset
) != 0
18447 && (mode_line_target
!= MODE_LINE_DISPLAY
18448 || it
->current_x
< it
->last_visible_x
))
18450 EMACS_INT last_offset
= offset
;
18452 /* Advance to end of string or next format specifier. */
18453 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18456 if (offset
- 1 != last_offset
)
18458 EMACS_INT nchars
, nbytes
;
18460 /* Output to end of string or up to '%'. Field width
18461 is length of string. Don't output more than
18462 PRECISION allows us. */
18465 prec
= c_string_width (SDATA (elt
) + last_offset
,
18466 offset
- last_offset
, precision
- n
,
18469 switch (mode_line_target
)
18471 case MODE_LINE_NOPROP
:
18472 case MODE_LINE_TITLE
:
18473 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18475 case MODE_LINE_STRING
:
18477 EMACS_INT bytepos
= last_offset
;
18478 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18479 EMACS_INT endpos
= (precision
<= 0
18480 ? string_byte_to_char (elt
, offset
)
18481 : charpos
+ nchars
);
18483 n
+= store_mode_line_string (NULL
,
18484 Fsubstring (elt
, make_number (charpos
),
18485 make_number (endpos
)),
18489 case MODE_LINE_DISPLAY
:
18491 EMACS_INT bytepos
= last_offset
;
18492 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18494 if (precision
<= 0)
18495 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18496 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18498 STRING_MULTIBYTE (elt
));
18503 else /* c == '%' */
18505 EMACS_INT percent_position
= offset
;
18507 /* Get the specified minimum width. Zero means
18510 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18511 field
= field
* 10 + c
- '0';
18513 /* Don't pad beyond the total padding allowed. */
18514 if (field_width
- n
> 0 && field
> field_width
- n
)
18515 field
= field_width
- n
;
18517 /* Note that either PRECISION <= 0 or N < PRECISION. */
18518 prec
= precision
- n
;
18521 n
+= display_mode_element (it
, depth
, field
, prec
,
18522 Vglobal_mode_string
, props
,
18527 EMACS_INT bytepos
, charpos
;
18529 Lisp_Object string
;
18531 bytepos
= percent_position
;
18532 charpos
= (STRING_MULTIBYTE (elt
)
18533 ? string_byte_to_char (elt
, bytepos
)
18535 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18536 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18538 switch (mode_line_target
)
18540 case MODE_LINE_NOPROP
:
18541 case MODE_LINE_TITLE
:
18542 n
+= store_mode_line_noprop (spec
, field
, prec
);
18544 case MODE_LINE_STRING
:
18546 int len
= strlen (spec
);
18547 Lisp_Object tem
= make_string (spec
, len
);
18548 props
= Ftext_properties_at (make_number (charpos
), elt
);
18549 /* Should only keep face property in props */
18550 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18553 case MODE_LINE_DISPLAY
:
18555 int nglyphs_before
, nwritten
;
18557 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18558 nwritten
= display_string (spec
, string
, elt
,
18563 /* Assign to the glyphs written above the
18564 string where the `%x' came from, position
18568 struct glyph
*glyph
18569 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18573 for (i
= 0; i
< nwritten
; ++i
)
18575 glyph
[i
].object
= elt
;
18576 glyph
[i
].charpos
= charpos
;
18593 /* A symbol: process the value of the symbol recursively
18594 as if it appeared here directly. Avoid error if symbol void.
18595 Special case: if value of symbol is a string, output the string
18598 register Lisp_Object tem
;
18600 /* If the variable is not marked as risky to set
18601 then its contents are risky to use. */
18602 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18605 tem
= Fboundp (elt
);
18608 tem
= Fsymbol_value (elt
);
18609 /* If value is a string, output that string literally:
18610 don't check for % within it. */
18614 if (!EQ (tem
, elt
))
18616 /* Give up right away for nil or t. */
18626 register Lisp_Object car
, tem
;
18628 /* A cons cell: five distinct cases.
18629 If first element is :eval or :propertize, do something special.
18630 If first element is a string or a cons, process all the elements
18631 and effectively concatenate them.
18632 If first element is a negative number, truncate displaying cdr to
18633 at most that many characters. If positive, pad (with spaces)
18634 to at least that many characters.
18635 If first element is a symbol, process the cadr or caddr recursively
18636 according to whether the symbol's value is non-nil or nil. */
18638 if (EQ (car
, QCeval
))
18640 /* An element of the form (:eval FORM) means evaluate FORM
18641 and use the result as mode line elements. */
18646 if (CONSP (XCDR (elt
)))
18649 spec
= safe_eval (XCAR (XCDR (elt
)));
18650 n
+= display_mode_element (it
, depth
, field_width
- n
,
18651 precision
- n
, spec
, props
,
18655 else if (EQ (car
, QCpropertize
))
18657 /* An element of the form (:propertize ELT PROPS...)
18658 means display ELT but applying properties PROPS. */
18663 if (CONSP (XCDR (elt
)))
18664 n
+= display_mode_element (it
, depth
, field_width
- n
,
18665 precision
- n
, XCAR (XCDR (elt
)),
18666 XCDR (XCDR (elt
)), risky
);
18668 else if (SYMBOLP (car
))
18670 tem
= Fboundp (car
);
18674 /* elt is now the cdr, and we know it is a cons cell.
18675 Use its car if CAR has a non-nil value. */
18678 tem
= Fsymbol_value (car
);
18685 /* Symbol's value is nil (or symbol is unbound)
18686 Get the cddr of the original list
18687 and if possible find the caddr and use that. */
18691 else if (!CONSP (elt
))
18696 else if (INTEGERP (car
))
18698 register int lim
= XINT (car
);
18702 /* Negative int means reduce maximum width. */
18703 if (precision
<= 0)
18706 precision
= min (precision
, -lim
);
18710 /* Padding specified. Don't let it be more than
18711 current maximum. */
18713 lim
= min (precision
, lim
);
18715 /* If that's more padding than already wanted, queue it.
18716 But don't reduce padding already specified even if
18717 that is beyond the current truncation point. */
18718 field_width
= max (lim
, field_width
);
18722 else if (STRINGP (car
) || CONSP (car
))
18724 Lisp_Object halftail
= elt
;
18728 && (precision
<= 0 || n
< precision
))
18730 n
+= display_mode_element (it
, depth
,
18731 /* Do padding only after the last
18732 element in the list. */
18733 (! CONSP (XCDR (elt
))
18736 precision
- n
, XCAR (elt
),
18740 if ((len
& 1) == 0)
18741 halftail
= XCDR (halftail
);
18742 /* Check for cycle. */
18743 if (EQ (halftail
, elt
))
18752 elt
= build_string ("*invalid*");
18756 /* Pad to FIELD_WIDTH. */
18757 if (field_width
> 0 && n
< field_width
)
18759 switch (mode_line_target
)
18761 case MODE_LINE_NOPROP
:
18762 case MODE_LINE_TITLE
:
18763 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18765 case MODE_LINE_STRING
:
18766 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18768 case MODE_LINE_DISPLAY
:
18769 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18778 /* Store a mode-line string element in mode_line_string_list.
18780 If STRING is non-null, display that C string. Otherwise, the Lisp
18781 string LISP_STRING is displayed.
18783 FIELD_WIDTH is the minimum number of output glyphs to produce.
18784 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18785 with spaces. FIELD_WIDTH <= 0 means don't pad.
18787 PRECISION is the maximum number of characters to output from
18788 STRING. PRECISION <= 0 means don't truncate the string.
18790 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18791 properties to the string.
18793 PROPS are the properties to add to the string.
18794 The mode_line_string_face face property is always added to the string.
18798 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18799 int field_width
, int precision
, Lisp_Object props
)
18804 if (string
!= NULL
)
18806 len
= strlen (string
);
18807 if (precision
> 0 && len
> precision
)
18809 lisp_string
= make_string (string
, len
);
18811 props
= mode_line_string_face_prop
;
18812 else if (!NILP (mode_line_string_face
))
18814 Lisp_Object face
= Fplist_get (props
, Qface
);
18815 props
= Fcopy_sequence (props
);
18817 face
= mode_line_string_face
;
18819 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18820 props
= Fplist_put (props
, Qface
, face
);
18822 Fadd_text_properties (make_number (0), make_number (len
),
18823 props
, lisp_string
);
18827 len
= XFASTINT (Flength (lisp_string
));
18828 if (precision
> 0 && len
> precision
)
18831 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18834 if (!NILP (mode_line_string_face
))
18838 props
= Ftext_properties_at (make_number (0), lisp_string
);
18839 face
= Fplist_get (props
, Qface
);
18841 face
= mode_line_string_face
;
18843 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18844 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18846 lisp_string
= Fcopy_sequence (lisp_string
);
18849 Fadd_text_properties (make_number (0), make_number (len
),
18850 props
, lisp_string
);
18855 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18859 if (field_width
> len
)
18861 field_width
-= len
;
18862 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18864 Fadd_text_properties (make_number (0), make_number (field_width
),
18865 props
, lisp_string
);
18866 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18874 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18876 doc
: /* Format a string out of a mode line format specification.
18877 First arg FORMAT specifies the mode line format (see `mode-line-format'
18878 for details) to use.
18880 By default, the format is evaluated for the currently selected window.
18882 Optional second arg FACE specifies the face property to put on all
18883 characters for which no face is specified. The value nil means the
18884 default face. The value t means whatever face the window's mode line
18885 currently uses (either `mode-line' or `mode-line-inactive',
18886 depending on whether the window is the selected window or not).
18887 An integer value means the value string has no text
18890 Optional third and fourth args WINDOW and BUFFER specify the window
18891 and buffer to use as the context for the formatting (defaults
18892 are the selected window and the WINDOW's buffer). */)
18893 (Lisp_Object format
, Lisp_Object face
,
18894 Lisp_Object window
, Lisp_Object buffer
)
18899 struct buffer
*old_buffer
= NULL
;
18901 int no_props
= INTEGERP (face
);
18902 int count
= SPECPDL_INDEX ();
18904 int string_start
= 0;
18907 window
= selected_window
;
18908 CHECK_WINDOW (window
);
18909 w
= XWINDOW (window
);
18912 buffer
= w
->buffer
;
18913 CHECK_BUFFER (buffer
);
18915 /* Make formatting the modeline a non-op when noninteractive, otherwise
18916 there will be problems later caused by a partially initialized frame. */
18917 if (NILP (format
) || noninteractive
)
18918 return empty_unibyte_string
;
18923 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18924 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18925 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18926 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18927 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18928 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18929 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18932 if (XBUFFER (buffer
) != current_buffer
)
18933 old_buffer
= current_buffer
;
18935 /* Save things including mode_line_proptrans_alist,
18936 and set that to nil so that we don't alter the outer value. */
18937 record_unwind_protect (unwind_format_mode_line
,
18938 format_mode_line_unwind_data
18939 (old_buffer
, selected_window
, 1));
18940 mode_line_proptrans_alist
= Qnil
;
18942 Fselect_window (window
, Qt
);
18944 set_buffer_internal_1 (XBUFFER (buffer
));
18946 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18950 mode_line_target
= MODE_LINE_NOPROP
;
18951 mode_line_string_face_prop
= Qnil
;
18952 mode_line_string_list
= Qnil
;
18953 string_start
= MODE_LINE_NOPROP_LEN (0);
18957 mode_line_target
= MODE_LINE_STRING
;
18958 mode_line_string_list
= Qnil
;
18959 mode_line_string_face
= face
;
18960 mode_line_string_face_prop
18961 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18964 push_kboard (FRAME_KBOARD (it
.f
));
18965 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18970 len
= MODE_LINE_NOPROP_LEN (string_start
);
18971 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18975 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18976 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18977 empty_unibyte_string
);
18980 unbind_to (count
, Qnil
);
18984 /* Write a null-terminated, right justified decimal representation of
18985 the positive integer D to BUF using a minimal field width WIDTH. */
18988 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
18990 register char *p
= buf
;
18998 *p
++ = d
% 10 + '0';
19003 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19014 /* Write a null-terminated, right justified decimal and "human
19015 readable" representation of the nonnegative integer D to BUF using
19016 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19018 static const char power_letter
[] =
19032 pint2hrstr (char *buf
, int width
, int d
)
19034 /* We aim to represent the nonnegative integer D as
19035 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19038 /* -1 means: do not use TENTHS. */
19042 /* Length of QUOTIENT.TENTHS as a string. */
19048 if (1000 <= quotient
)
19050 /* Scale to the appropriate EXPONENT. */
19053 remainder
= quotient
% 1000;
19057 while (1000 <= quotient
);
19059 /* Round to nearest and decide whether to use TENTHS or not. */
19062 tenths
= remainder
/ 100;
19063 if (50 <= remainder
% 100)
19070 if (quotient
== 10)
19078 if (500 <= remainder
)
19080 if (quotient
< 999)
19091 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19092 if (tenths
== -1 && quotient
<= 99)
19099 p
= psuffix
= buf
+ max (width
, length
);
19101 /* Print EXPONENT. */
19102 *psuffix
++ = power_letter
[exponent
];
19105 /* Print TENTHS. */
19108 *--p
= '0' + tenths
;
19112 /* Print QUOTIENT. */
19115 int digit
= quotient
% 10;
19116 *--p
= '0' + digit
;
19118 while ((quotient
/= 10) != 0);
19120 /* Print leading spaces. */
19125 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19126 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19127 type of CODING_SYSTEM. Return updated pointer into BUF. */
19129 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19132 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19135 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19136 const unsigned char *eol_str
;
19138 /* The EOL conversion we are using. */
19139 Lisp_Object eoltype
;
19141 val
= CODING_SYSTEM_SPEC (coding_system
);
19144 if (!VECTORP (val
)) /* Not yet decided. */
19149 eoltype
= eol_mnemonic_undecided
;
19150 /* Don't mention EOL conversion if it isn't decided. */
19155 Lisp_Object eolvalue
;
19157 attrs
= AREF (val
, 0);
19158 eolvalue
= AREF (val
, 2);
19161 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19165 /* The EOL conversion that is normal on this system. */
19167 if (NILP (eolvalue
)) /* Not yet decided. */
19168 eoltype
= eol_mnemonic_undecided
;
19169 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19170 eoltype
= eol_mnemonic_undecided
;
19171 else /* eolvalue is Qunix, Qdos, or Qmac. */
19172 eoltype
= (EQ (eolvalue
, Qunix
)
19173 ? eol_mnemonic_unix
19174 : (EQ (eolvalue
, Qdos
) == 1
19175 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19181 /* Mention the EOL conversion if it is not the usual one. */
19182 if (STRINGP (eoltype
))
19184 eol_str
= SDATA (eoltype
);
19185 eol_str_len
= SBYTES (eoltype
);
19187 else if (CHARACTERP (eoltype
))
19189 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19190 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19195 eol_str
= invalid_eol_type
;
19196 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19198 memcpy (buf
, eol_str
, eol_str_len
);
19199 buf
+= eol_str_len
;
19205 /* Return a string for the output of a mode line %-spec for window W,
19206 generated by character C. FIELD_WIDTH > 0 means pad the string
19207 returned with spaces to that value. Return a Lisp string in
19208 *STRING if the resulting string is taken from that Lisp string.
19210 Note we operate on the current buffer for most purposes,
19211 the exception being w->base_line_pos. */
19213 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19215 static const char *
19216 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19217 Lisp_Object
*string
)
19220 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19221 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19222 struct buffer
*b
= current_buffer
;
19230 if (!NILP (BVAR (b
, read_only
)))
19232 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19237 /* This differs from %* only for a modified read-only buffer. */
19238 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19240 if (!NILP (BVAR (b
, read_only
)))
19245 /* This differs from %* in ignoring read-only-ness. */
19246 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19258 if (command_loop_level
> 5)
19260 p
= decode_mode_spec_buf
;
19261 for (i
= 0; i
< command_loop_level
; i
++)
19264 return decode_mode_spec_buf
;
19272 if (command_loop_level
> 5)
19274 p
= decode_mode_spec_buf
;
19275 for (i
= 0; i
< command_loop_level
; i
++)
19278 return decode_mode_spec_buf
;
19285 /* Let lots_of_dashes be a string of infinite length. */
19286 if (mode_line_target
== MODE_LINE_NOPROP
||
19287 mode_line_target
== MODE_LINE_STRING
)
19289 if (field_width
<= 0
19290 || field_width
> sizeof (lots_of_dashes
))
19292 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19293 decode_mode_spec_buf
[i
] = '-';
19294 decode_mode_spec_buf
[i
] = '\0';
19295 return decode_mode_spec_buf
;
19298 return lots_of_dashes
;
19302 obj
= BVAR (b
, name
);
19306 /* %c and %l are ignored in `frame-title-format'.
19307 (In redisplay_internal, the frame title is drawn _before_ the
19308 windows are updated, so the stuff which depends on actual
19309 window contents (such as %l) may fail to render properly, or
19310 even crash emacs.) */
19311 if (mode_line_target
== MODE_LINE_TITLE
)
19315 EMACS_INT col
= current_column ();
19316 w
->column_number_displayed
= make_number (col
);
19317 pint2str (decode_mode_spec_buf
, field_width
, col
);
19318 return decode_mode_spec_buf
;
19322 #ifndef SYSTEM_MALLOC
19324 if (NILP (Vmemory_full
))
19327 return "!MEM FULL! ";
19334 /* %F displays the frame name. */
19335 if (!NILP (f
->title
))
19336 return SSDATA (f
->title
);
19337 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19338 return SSDATA (f
->name
);
19342 obj
= BVAR (b
, filename
);
19347 EMACS_INT size
= ZV
- BEGV
;
19348 pint2str (decode_mode_spec_buf
, field_width
, size
);
19349 return decode_mode_spec_buf
;
19354 EMACS_INT size
= ZV
- BEGV
;
19355 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19356 return decode_mode_spec_buf
;
19361 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19362 int topline
, nlines
, height
;
19365 /* %c and %l are ignored in `frame-title-format'. */
19366 if (mode_line_target
== MODE_LINE_TITLE
)
19369 startpos
= XMARKER (w
->start
)->charpos
;
19370 startpos_byte
= marker_byte_position (w
->start
);
19371 height
= WINDOW_TOTAL_LINES (w
);
19373 /* If we decided that this buffer isn't suitable for line numbers,
19374 don't forget that too fast. */
19375 if (EQ (w
->base_line_pos
, w
->buffer
))
19377 /* But do forget it, if the window shows a different buffer now. */
19378 else if (BUFFERP (w
->base_line_pos
))
19379 w
->base_line_pos
= Qnil
;
19381 /* If the buffer is very big, don't waste time. */
19382 if (INTEGERP (Vline_number_display_limit
)
19383 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19385 w
->base_line_pos
= Qnil
;
19386 w
->base_line_number
= Qnil
;
19390 if (INTEGERP (w
->base_line_number
)
19391 && INTEGERP (w
->base_line_pos
)
19392 && XFASTINT (w
->base_line_pos
) <= startpos
)
19394 line
= XFASTINT (w
->base_line_number
);
19395 linepos
= XFASTINT (w
->base_line_pos
);
19396 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19401 linepos
= BUF_BEGV (b
);
19402 linepos_byte
= BUF_BEGV_BYTE (b
);
19405 /* Count lines from base line to window start position. */
19406 nlines
= display_count_lines (linepos
, linepos_byte
,
19410 topline
= nlines
+ line
;
19412 /* Determine a new base line, if the old one is too close
19413 or too far away, or if we did not have one.
19414 "Too close" means it's plausible a scroll-down would
19415 go back past it. */
19416 if (startpos
== BUF_BEGV (b
))
19418 w
->base_line_number
= make_number (topline
);
19419 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19421 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19422 || linepos
== BUF_BEGV (b
))
19424 EMACS_INT limit
= BUF_BEGV (b
);
19425 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19426 EMACS_INT position
;
19427 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19429 if (startpos
- distance
> limit
)
19431 limit
= startpos
- distance
;
19432 limit_byte
= CHAR_TO_BYTE (limit
);
19435 nlines
= display_count_lines (startpos
, startpos_byte
,
19437 - (height
* 2 + 30),
19439 /* If we couldn't find the lines we wanted within
19440 line_number_display_limit_width chars per line,
19441 give up on line numbers for this window. */
19442 if (position
== limit_byte
&& limit
== startpos
- distance
)
19444 w
->base_line_pos
= w
->buffer
;
19445 w
->base_line_number
= Qnil
;
19449 w
->base_line_number
= make_number (topline
- nlines
);
19450 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19453 /* Now count lines from the start pos to point. */
19454 nlines
= display_count_lines (startpos
, startpos_byte
,
19455 PT_BYTE
, PT
, &junk
);
19457 /* Record that we did display the line number. */
19458 line_number_displayed
= 1;
19460 /* Make the string to show. */
19461 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19462 return decode_mode_spec_buf
;
19465 char* p
= decode_mode_spec_buf
;
19466 int pad
= field_width
- 2;
19472 return decode_mode_spec_buf
;
19478 obj
= BVAR (b
, mode_name
);
19482 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19488 EMACS_INT pos
= marker_position (w
->start
);
19489 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19491 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19493 if (pos
<= BUF_BEGV (b
))
19498 else if (pos
<= BUF_BEGV (b
))
19502 if (total
> 1000000)
19503 /* Do it differently for a large value, to avoid overflow. */
19504 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19506 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19507 /* We can't normally display a 3-digit number,
19508 so get us a 2-digit number that is close. */
19511 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19512 return decode_mode_spec_buf
;
19516 /* Display percentage of size above the bottom of the screen. */
19519 EMACS_INT toppos
= marker_position (w
->start
);
19520 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19521 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19523 if (botpos
>= BUF_ZV (b
))
19525 if (toppos
<= BUF_BEGV (b
))
19532 if (total
> 1000000)
19533 /* Do it differently for a large value, to avoid overflow. */
19534 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19536 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19537 /* We can't normally display a 3-digit number,
19538 so get us a 2-digit number that is close. */
19541 if (toppos
<= BUF_BEGV (b
))
19542 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19544 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19545 return decode_mode_spec_buf
;
19550 /* status of process */
19551 obj
= Fget_buffer_process (Fcurrent_buffer ());
19553 return "no process";
19555 obj
= Fsymbol_name (Fprocess_status (obj
));
19561 int count
= inhibit_garbage_collection ();
19562 Lisp_Object val
= call1 (intern ("file-remote-p"),
19563 BVAR (current_buffer
, directory
));
19564 unbind_to (count
, Qnil
);
19572 case 't': /* indicate TEXT or BINARY */
19576 /* coding-system (not including end-of-line format) */
19578 /* coding-system (including end-of-line type) */
19580 int eol_flag
= (c
== 'Z');
19581 char *p
= decode_mode_spec_buf
;
19583 if (! FRAME_WINDOW_P (f
))
19585 /* No need to mention EOL here--the terminal never needs
19586 to do EOL conversion. */
19587 p
= decode_mode_spec_coding (CODING_ID_NAME
19588 (FRAME_KEYBOARD_CODING (f
)->id
),
19590 p
= decode_mode_spec_coding (CODING_ID_NAME
19591 (FRAME_TERMINAL_CODING (f
)->id
),
19594 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19597 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19598 #ifdef subprocesses
19599 obj
= Fget_buffer_process (Fcurrent_buffer ());
19600 if (PROCESSP (obj
))
19602 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19604 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19607 #endif /* subprocesses */
19610 return decode_mode_spec_buf
;
19617 return SSDATA (obj
);
19624 /* Count up to COUNT lines starting from START / START_BYTE.
19625 But don't go beyond LIMIT_BYTE.
19626 Return the number of lines thus found (always nonnegative).
19628 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19631 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19632 EMACS_INT limit_byte
, int count
,
19633 EMACS_INT
*byte_pos_ptr
)
19635 register unsigned char *cursor
;
19636 unsigned char *base
;
19638 register int ceiling
;
19639 register unsigned char *ceiling_addr
;
19640 int orig_count
= count
;
19642 /* If we are not in selective display mode,
19643 check only for newlines. */
19644 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19645 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19649 while (start_byte
< limit_byte
)
19651 ceiling
= BUFFER_CEILING_OF (start_byte
);
19652 ceiling
= min (limit_byte
- 1, ceiling
);
19653 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19654 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19657 if (selective_display
)
19658 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19661 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19664 if (cursor
!= ceiling_addr
)
19668 start_byte
+= cursor
- base
+ 1;
19669 *byte_pos_ptr
= start_byte
;
19673 if (++cursor
== ceiling_addr
)
19679 start_byte
+= cursor
- base
;
19684 while (start_byte
> limit_byte
)
19686 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19687 ceiling
= max (limit_byte
, ceiling
);
19688 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19689 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19692 if (selective_display
)
19693 while (--cursor
!= ceiling_addr
19694 && *cursor
!= '\n' && *cursor
!= 015)
19697 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19700 if (cursor
!= ceiling_addr
)
19704 start_byte
+= cursor
- base
+ 1;
19705 *byte_pos_ptr
= start_byte
;
19706 /* When scanning backwards, we should
19707 not count the newline posterior to which we stop. */
19708 return - orig_count
- 1;
19714 /* Here we add 1 to compensate for the last decrement
19715 of CURSOR, which took it past the valid range. */
19716 start_byte
+= cursor
- base
+ 1;
19720 *byte_pos_ptr
= limit_byte
;
19723 return - orig_count
+ count
;
19724 return orig_count
- count
;
19730 /***********************************************************************
19732 ***********************************************************************/
19734 /* Display a NUL-terminated string, starting with index START.
19736 If STRING is non-null, display that C string. Otherwise, the Lisp
19737 string LISP_STRING is displayed. There's a case that STRING is
19738 non-null and LISP_STRING is not nil. It means STRING is a string
19739 data of LISP_STRING. In that case, we display LISP_STRING while
19740 ignoring its text properties.
19742 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19743 FACE_STRING. Display STRING or LISP_STRING with the face at
19744 FACE_STRING_POS in FACE_STRING:
19746 Display the string in the environment given by IT, but use the
19747 standard display table, temporarily.
19749 FIELD_WIDTH is the minimum number of output glyphs to produce.
19750 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19751 with spaces. If STRING has more characters, more than FIELD_WIDTH
19752 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19754 PRECISION is the maximum number of characters to output from
19755 STRING. PRECISION < 0 means don't truncate the string.
19757 This is roughly equivalent to printf format specifiers:
19759 FIELD_WIDTH PRECISION PRINTF
19760 ----------------------------------------
19766 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19767 display them, and < 0 means obey the current buffer's value of
19768 enable_multibyte_characters.
19770 Value is the number of columns displayed. */
19773 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19774 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19775 int field_width
, int precision
, int max_x
, int multibyte
)
19777 int hpos_at_start
= it
->hpos
;
19778 int saved_face_id
= it
->face_id
;
19779 struct glyph_row
*row
= it
->glyph_row
;
19781 /* Initialize the iterator IT for iteration over STRING beginning
19782 with index START. */
19783 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19784 precision
, field_width
, multibyte
);
19785 if (string
&& STRINGP (lisp_string
))
19786 /* LISP_STRING is the one returned by decode_mode_spec. We should
19787 ignore its text properties. */
19788 it
->stop_charpos
= -1;
19790 /* If displaying STRING, set up the face of the iterator
19791 from LISP_STRING, if that's given. */
19792 if (STRINGP (face_string
))
19798 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19799 0, it
->region_beg_charpos
,
19800 it
->region_end_charpos
,
19801 &endptr
, it
->base_face_id
, 0);
19802 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19803 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19806 /* Set max_x to the maximum allowed X position. Don't let it go
19807 beyond the right edge of the window. */
19809 max_x
= it
->last_visible_x
;
19811 max_x
= min (max_x
, it
->last_visible_x
);
19813 /* Skip over display elements that are not visible. because IT->w is
19815 if (it
->current_x
< it
->first_visible_x
)
19816 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19817 MOVE_TO_POS
| MOVE_TO_X
);
19819 row
->ascent
= it
->max_ascent
;
19820 row
->height
= it
->max_ascent
+ it
->max_descent
;
19821 row
->phys_ascent
= it
->max_phys_ascent
;
19822 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19823 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19825 /* This condition is for the case that we are called with current_x
19826 past last_visible_x. */
19827 while (it
->current_x
< max_x
)
19829 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19831 /* Get the next display element. */
19832 if (!get_next_display_element (it
))
19835 /* Produce glyphs. */
19836 x_before
= it
->current_x
;
19837 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19838 PRODUCE_GLYPHS (it
);
19840 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19843 while (i
< nglyphs
)
19845 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19847 if (it
->line_wrap
!= TRUNCATE
19848 && x
+ glyph
->pixel_width
> max_x
)
19850 /* End of continued line or max_x reached. */
19851 if (CHAR_GLYPH_PADDING_P (*glyph
))
19853 /* A wide character is unbreakable. */
19854 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19855 it
->current_x
= x_before
;
19859 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19864 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19866 /* Glyph is at least partially visible. */
19868 if (x
< it
->first_visible_x
)
19869 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19873 /* Glyph is off the left margin of the display area.
19874 Should not happen. */
19878 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19879 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19880 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19881 row
->phys_height
= max (row
->phys_height
,
19882 it
->max_phys_ascent
+ it
->max_phys_descent
);
19883 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19884 it
->max_extra_line_spacing
);
19885 x
+= glyph
->pixel_width
;
19889 /* Stop if max_x reached. */
19893 /* Stop at line ends. */
19894 if (ITERATOR_AT_END_OF_LINE_P (it
))
19896 it
->continuation_lines_width
= 0;
19900 set_iterator_to_next (it
, 1);
19902 /* Stop if truncating at the right edge. */
19903 if (it
->line_wrap
== TRUNCATE
19904 && it
->current_x
>= it
->last_visible_x
)
19906 /* Add truncation mark, but don't do it if the line is
19907 truncated at a padding space. */
19908 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19910 if (!FRAME_WINDOW_P (it
->f
))
19914 if (it
->current_x
> it
->last_visible_x
)
19916 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19917 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19919 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19921 row
->used
[TEXT_AREA
] = ii
;
19922 produce_special_glyphs (it
, IT_TRUNCATION
);
19925 produce_special_glyphs (it
, IT_TRUNCATION
);
19927 it
->glyph_row
->truncated_on_right_p
= 1;
19933 /* Maybe insert a truncation at the left. */
19934 if (it
->first_visible_x
19935 && IT_CHARPOS (*it
) > 0)
19937 if (!FRAME_WINDOW_P (it
->f
))
19938 insert_left_trunc_glyphs (it
);
19939 it
->glyph_row
->truncated_on_left_p
= 1;
19942 it
->face_id
= saved_face_id
;
19944 /* Value is number of columns displayed. */
19945 return it
->hpos
- hpos_at_start
;
19950 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19951 appears as an element of LIST or as the car of an element of LIST.
19952 If PROPVAL is a list, compare each element against LIST in that
19953 way, and return 1/2 if any element of PROPVAL is found in LIST.
19954 Otherwise return 0. This function cannot quit.
19955 The return value is 2 if the text is invisible but with an ellipsis
19956 and 1 if it's invisible and without an ellipsis. */
19959 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19961 register Lisp_Object tail
, proptail
;
19963 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19965 register Lisp_Object tem
;
19967 if (EQ (propval
, tem
))
19969 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19970 return NILP (XCDR (tem
)) ? 1 : 2;
19973 if (CONSP (propval
))
19975 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19977 Lisp_Object propelt
;
19978 propelt
= XCAR (proptail
);
19979 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19981 register Lisp_Object tem
;
19983 if (EQ (propelt
, tem
))
19985 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19986 return NILP (XCDR (tem
)) ? 1 : 2;
19994 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19995 doc
: /* Non-nil if the property makes the text invisible.
19996 POS-OR-PROP can be a marker or number, in which case it is taken to be
19997 a position in the current buffer and the value of the `invisible' property
19998 is checked; or it can be some other value, which is then presumed to be the
19999 value of the `invisible' property of the text of interest.
20000 The non-nil value returned can be t for truly invisible text or something
20001 else if the text is replaced by an ellipsis. */)
20002 (Lisp_Object pos_or_prop
)
20005 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20006 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20008 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20009 return (invis
== 0 ? Qnil
20011 : make_number (invis
));
20014 /* Calculate a width or height in pixels from a specification using
20015 the following elements:
20018 NUM - a (fractional) multiple of the default font width/height
20019 (NUM) - specifies exactly NUM pixels
20020 UNIT - a fixed number of pixels, see below.
20021 ELEMENT - size of a display element in pixels, see below.
20022 (NUM . SPEC) - equals NUM * SPEC
20023 (+ SPEC SPEC ...) - add pixel values
20024 (- SPEC SPEC ...) - subtract pixel values
20025 (- SPEC) - negate pixel value
20028 INT or FLOAT - a number constant
20029 SYMBOL - use symbol's (buffer local) variable binding.
20032 in - pixels per inch *)
20033 mm - pixels per 1/1000 meter *)
20034 cm - pixels per 1/100 meter *)
20035 width - width of current font in pixels.
20036 height - height of current font in pixels.
20038 *) using the ratio(s) defined in display-pixels-per-inch.
20042 left-fringe - left fringe width in pixels
20043 right-fringe - right fringe width in pixels
20045 left-margin - left margin width in pixels
20046 right-margin - right margin width in pixels
20048 scroll-bar - scroll-bar area width in pixels
20052 Pixels corresponding to 5 inches:
20055 Total width of non-text areas on left side of window (if scroll-bar is on left):
20056 '(space :width (+ left-fringe left-margin scroll-bar))
20058 Align to first text column (in header line):
20059 '(space :align-to 0)
20061 Align to middle of text area minus half the width of variable `my-image'
20062 containing a loaded image:
20063 '(space :align-to (0.5 . (- text my-image)))
20065 Width of left margin minus width of 1 character in the default font:
20066 '(space :width (- left-margin 1))
20068 Width of left margin minus width of 2 characters in the current font:
20069 '(space :width (- left-margin (2 . width)))
20071 Center 1 character over left-margin (in header line):
20072 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20074 Different ways to express width of left fringe plus left margin minus one pixel:
20075 '(space :width (- (+ left-fringe left-margin) (1)))
20076 '(space :width (+ left-fringe left-margin (- (1))))
20077 '(space :width (+ left-fringe left-margin (-1)))
20081 #define NUMVAL(X) \
20082 ((INTEGERP (X) || FLOATP (X)) \
20087 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20088 struct font
*font
, int width_p
, int *align_to
)
20092 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20093 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20096 return OK_PIXELS (0);
20098 xassert (FRAME_LIVE_P (it
->f
));
20100 if (SYMBOLP (prop
))
20102 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20104 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20106 if (unit
[0] == 'i' && unit
[1] == 'n')
20108 else if (unit
[0] == 'm' && unit
[1] == 'm')
20110 else if (unit
[0] == 'c' && unit
[1] == 'm')
20117 #ifdef HAVE_WINDOW_SYSTEM
20118 if (FRAME_WINDOW_P (it
->f
)
20120 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20121 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20123 return OK_PIXELS (ppi
/ pixels
);
20126 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20127 || (CONSP (Vdisplay_pixels_per_inch
)
20129 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20130 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20132 return OK_PIXELS (ppi
/ pixels
);
20138 #ifdef HAVE_WINDOW_SYSTEM
20139 if (EQ (prop
, Qheight
))
20140 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20141 if (EQ (prop
, Qwidth
))
20142 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20144 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20145 return OK_PIXELS (1);
20148 if (EQ (prop
, Qtext
))
20149 return OK_PIXELS (width_p
20150 ? window_box_width (it
->w
, TEXT_AREA
)
20151 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20153 if (align_to
&& *align_to
< 0)
20156 if (EQ (prop
, Qleft
))
20157 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20158 if (EQ (prop
, Qright
))
20159 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20160 if (EQ (prop
, Qcenter
))
20161 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20162 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20163 if (EQ (prop
, Qleft_fringe
))
20164 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20165 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20166 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20167 if (EQ (prop
, Qright_fringe
))
20168 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20169 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20170 : window_box_right_offset (it
->w
, TEXT_AREA
));
20171 if (EQ (prop
, Qleft_margin
))
20172 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20173 if (EQ (prop
, Qright_margin
))
20174 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20175 if (EQ (prop
, Qscroll_bar
))
20176 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20178 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20179 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20180 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20185 if (EQ (prop
, Qleft_fringe
))
20186 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20187 if (EQ (prop
, Qright_fringe
))
20188 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20189 if (EQ (prop
, Qleft_margin
))
20190 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20191 if (EQ (prop
, Qright_margin
))
20192 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20193 if (EQ (prop
, Qscroll_bar
))
20194 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20197 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20200 if (INTEGERP (prop
) || FLOATP (prop
))
20202 int base_unit
= (width_p
20203 ? FRAME_COLUMN_WIDTH (it
->f
)
20204 : FRAME_LINE_HEIGHT (it
->f
));
20205 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20210 Lisp_Object car
= XCAR (prop
);
20211 Lisp_Object cdr
= XCDR (prop
);
20215 #ifdef HAVE_WINDOW_SYSTEM
20216 if (FRAME_WINDOW_P (it
->f
)
20217 && valid_image_p (prop
))
20219 int id
= lookup_image (it
->f
, prop
);
20220 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20222 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20225 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20231 while (CONSP (cdr
))
20233 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20234 font
, width_p
, align_to
))
20237 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20242 if (EQ (car
, Qminus
))
20244 return OK_PIXELS (pixels
);
20247 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20250 if (INTEGERP (car
) || FLOATP (car
))
20253 pixels
= XFLOATINT (car
);
20255 return OK_PIXELS (pixels
);
20256 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20257 font
, width_p
, align_to
))
20258 return OK_PIXELS (pixels
* fact
);
20269 /***********************************************************************
20271 ***********************************************************************/
20273 #ifdef HAVE_WINDOW_SYSTEM
20278 dump_glyph_string (s
)
20279 struct glyph_string
*s
;
20281 fprintf (stderr
, "glyph string\n");
20282 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20283 s
->x
, s
->y
, s
->width
, s
->height
);
20284 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20285 fprintf (stderr
, " hl = %d\n", s
->hl
);
20286 fprintf (stderr
, " left overhang = %d, right = %d\n",
20287 s
->left_overhang
, s
->right_overhang
);
20288 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20289 fprintf (stderr
, " extends to end of line = %d\n",
20290 s
->extends_to_end_of_line_p
);
20291 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20292 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20295 #endif /* GLYPH_DEBUG */
20297 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20298 of XChar2b structures for S; it can't be allocated in
20299 init_glyph_string because it must be allocated via `alloca'. W
20300 is the window on which S is drawn. ROW and AREA are the glyph row
20301 and area within the row from which S is constructed. START is the
20302 index of the first glyph structure covered by S. HL is a
20303 face-override for drawing S. */
20306 #define OPTIONAL_HDC(hdc) HDC hdc,
20307 #define DECLARE_HDC(hdc) HDC hdc;
20308 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20309 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20312 #ifndef OPTIONAL_HDC
20313 #define OPTIONAL_HDC(hdc)
20314 #define DECLARE_HDC(hdc)
20315 #define ALLOCATE_HDC(hdc, f)
20316 #define RELEASE_HDC(hdc, f)
20320 init_glyph_string (struct glyph_string
*s
,
20322 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20323 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20325 memset (s
, 0, sizeof *s
);
20327 s
->f
= XFRAME (w
->frame
);
20331 s
->display
= FRAME_X_DISPLAY (s
->f
);
20332 s
->window
= FRAME_X_WINDOW (s
->f
);
20333 s
->char2b
= char2b
;
20337 s
->first_glyph
= row
->glyphs
[area
] + start
;
20338 s
->height
= row
->height
;
20339 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20340 s
->ybase
= s
->y
+ row
->ascent
;
20344 /* Append the list of glyph strings with head H and tail T to the list
20345 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20348 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20349 struct glyph_string
*h
, struct glyph_string
*t
)
20363 /* Prepend the list of glyph strings with head H and tail T to the
20364 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20368 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20369 struct glyph_string
*h
, struct glyph_string
*t
)
20383 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20384 Set *HEAD and *TAIL to the resulting list. */
20387 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20388 struct glyph_string
*s
)
20390 s
->next
= s
->prev
= NULL
;
20391 append_glyph_string_lists (head
, tail
, s
, s
);
20395 /* Get face and two-byte form of character C in face FACE_ID on frame
20396 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20397 means we want to display multibyte text. DISPLAY_P non-zero means
20398 make sure that X resources for the face returned are allocated.
20399 Value is a pointer to a realized face that is ready for display if
20400 DISPLAY_P is non-zero. */
20402 static INLINE
struct face
*
20403 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20404 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20406 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20410 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20412 if (code
!= FONT_INVALID_CODE
)
20413 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20415 STORE_XCHAR2B (char2b
, 0, 0);
20418 /* Make sure X resources of the face are allocated. */
20419 #ifdef HAVE_X_WINDOWS
20423 xassert (face
!= NULL
);
20424 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20431 /* Get face and two-byte form of character glyph GLYPH on frame F.
20432 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20433 a pointer to a realized face that is ready for display. */
20435 static INLINE
struct face
*
20436 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20437 XChar2b
*char2b
, int *two_byte_p
)
20441 xassert (glyph
->type
== CHAR_GLYPH
);
20442 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20451 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20452 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20454 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20456 if (code
!= FONT_INVALID_CODE
)
20457 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20459 STORE_XCHAR2B (char2b
, 0, 0);
20462 /* Make sure X resources of the face are allocated. */
20463 xassert (face
!= NULL
);
20464 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20469 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20470 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20473 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20477 if (CHAR_BYTE8_P (c
))
20478 code
= CHAR_TO_BYTE8 (c
);
20480 code
= font
->driver
->encode_char (font
, c
);
20482 if (code
== FONT_INVALID_CODE
)
20484 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20489 /* Fill glyph string S with composition components specified by S->cmp.
20491 BASE_FACE is the base face of the composition.
20492 S->cmp_from is the index of the first component for S.
20494 OVERLAPS non-zero means S should draw the foreground only, and use
20495 its physical height for clipping. See also draw_glyphs.
20497 Value is the index of a component not in S. */
20500 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20504 /* For all glyphs of this composition, starting at the offset
20505 S->cmp_from, until we reach the end of the definition or encounter a
20506 glyph that requires the different face, add it to S. */
20511 s
->for_overlaps
= overlaps
;
20514 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20516 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20520 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20523 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20524 s
->char2b
+ i
, 1, 1);
20530 s
->font
= s
->face
->font
;
20532 else if (s
->face
!= face
)
20540 /* All glyph strings for the same composition has the same width,
20541 i.e. the width set for the first component of the composition. */
20542 s
->width
= s
->first_glyph
->pixel_width
;
20544 /* If the specified font could not be loaded, use the frame's
20545 default font, but record the fact that we couldn't load it in
20546 the glyph string so that we can draw rectangles for the
20547 characters of the glyph string. */
20548 if (s
->font
== NULL
)
20550 s
->font_not_found_p
= 1;
20551 s
->font
= FRAME_FONT (s
->f
);
20554 /* Adjust base line for subscript/superscript text. */
20555 s
->ybase
+= s
->first_glyph
->voffset
;
20557 /* This glyph string must always be drawn with 16-bit functions. */
20564 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20565 int start
, int end
, int overlaps
)
20567 struct glyph
*glyph
, *last
;
20568 Lisp_Object lgstring
;
20571 s
->for_overlaps
= overlaps
;
20572 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20573 last
= s
->row
->glyphs
[s
->area
] + end
;
20574 s
->cmp_id
= glyph
->u
.cmp
.id
;
20575 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20576 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20577 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20578 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20579 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20581 while (glyph
< last
20582 && glyph
->u
.cmp
.automatic
20583 && glyph
->u
.cmp
.id
== s
->cmp_id
20584 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20585 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20587 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20589 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20590 unsigned code
= LGLYPH_CODE (lglyph
);
20592 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20594 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20595 return glyph
- s
->row
->glyphs
[s
->area
];
20599 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20600 See the comment of fill_glyph_string for arguments.
20601 Value is the index of the first glyph not in S. */
20605 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20606 int start
, int end
, int overlaps
)
20608 struct glyph
*glyph
, *last
;
20611 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20612 s
->for_overlaps
= overlaps
;
20613 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20614 last
= s
->row
->glyphs
[s
->area
] + end
;
20615 voffset
= glyph
->voffset
;
20616 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20617 s
->font
= s
->face
->font
;
20619 s
->width
= glyph
->pixel_width
;
20621 while (glyph
< last
20622 && glyph
->type
== GLYPHLESS_GLYPH
20623 && glyph
->voffset
== voffset
20624 && glyph
->face_id
== face_id
)
20627 s
->width
+= glyph
->pixel_width
;
20630 s
->ybase
+= voffset
;
20631 return glyph
- s
->row
->glyphs
[s
->area
];
20635 /* Fill glyph string S from a sequence of character glyphs.
20637 FACE_ID is the face id of the string. START is the index of the
20638 first glyph to consider, END is the index of the last + 1.
20639 OVERLAPS non-zero means S should draw the foreground only, and use
20640 its physical height for clipping. See also draw_glyphs.
20642 Value is the index of the first glyph not in S. */
20645 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20646 int start
, int end
, int overlaps
)
20648 struct glyph
*glyph
, *last
;
20650 int glyph_not_available_p
;
20652 xassert (s
->f
== XFRAME (s
->w
->frame
));
20653 xassert (s
->nchars
== 0);
20654 xassert (start
>= 0 && end
> start
);
20656 s
->for_overlaps
= overlaps
;
20657 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20658 last
= s
->row
->glyphs
[s
->area
] + end
;
20659 voffset
= glyph
->voffset
;
20660 s
->padding_p
= glyph
->padding_p
;
20661 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20663 while (glyph
< last
20664 && glyph
->type
== CHAR_GLYPH
20665 && glyph
->voffset
== voffset
20666 /* Same face id implies same font, nowadays. */
20667 && glyph
->face_id
== face_id
20668 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20672 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20673 s
->char2b
+ s
->nchars
,
20675 s
->two_byte_p
= two_byte_p
;
20677 xassert (s
->nchars
<= end
- start
);
20678 s
->width
+= glyph
->pixel_width
;
20679 if (glyph
++->padding_p
!= s
->padding_p
)
20683 s
->font
= s
->face
->font
;
20685 /* If the specified font could not be loaded, use the frame's font,
20686 but record the fact that we couldn't load it in
20687 S->font_not_found_p so that we can draw rectangles for the
20688 characters of the glyph string. */
20689 if (s
->font
== NULL
|| glyph_not_available_p
)
20691 s
->font_not_found_p
= 1;
20692 s
->font
= FRAME_FONT (s
->f
);
20695 /* Adjust base line for subscript/superscript text. */
20696 s
->ybase
+= voffset
;
20698 xassert (s
->face
&& s
->face
->gc
);
20699 return glyph
- s
->row
->glyphs
[s
->area
];
20703 /* Fill glyph string S from image glyph S->first_glyph. */
20706 fill_image_glyph_string (struct glyph_string
*s
)
20708 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20709 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20711 s
->slice
= s
->first_glyph
->slice
.img
;
20712 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20713 s
->font
= s
->face
->font
;
20714 s
->width
= s
->first_glyph
->pixel_width
;
20716 /* Adjust base line for subscript/superscript text. */
20717 s
->ybase
+= s
->first_glyph
->voffset
;
20721 /* Fill glyph string S from a sequence of stretch glyphs.
20723 ROW is the glyph row in which the glyphs are found, AREA is the
20724 area within the row. START is the index of the first glyph to
20725 consider, END is the index of the last + 1.
20727 Value is the index of the first glyph not in S. */
20730 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20731 enum glyph_row_area area
, int start
, int end
)
20733 struct glyph
*glyph
, *last
;
20734 int voffset
, face_id
;
20736 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20738 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20739 last
= s
->row
->glyphs
[s
->area
] + end
;
20740 face_id
= glyph
->face_id
;
20741 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20742 s
->font
= s
->face
->font
;
20743 s
->width
= glyph
->pixel_width
;
20745 voffset
= glyph
->voffset
;
20749 && glyph
->type
== STRETCH_GLYPH
20750 && glyph
->voffset
== voffset
20751 && glyph
->face_id
== face_id
);
20753 s
->width
+= glyph
->pixel_width
;
20755 /* Adjust base line for subscript/superscript text. */
20756 s
->ybase
+= voffset
;
20758 /* The case that face->gc == 0 is handled when drawing the glyph
20759 string by calling PREPARE_FACE_FOR_DISPLAY. */
20761 return glyph
- s
->row
->glyphs
[s
->area
];
20764 static struct font_metrics
*
20765 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20767 static struct font_metrics metrics
;
20768 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20770 if (! font
|| code
== FONT_INVALID_CODE
)
20772 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20777 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20778 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20779 assumed to be zero. */
20782 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20784 *left
= *right
= 0;
20786 if (glyph
->type
== CHAR_GLYPH
)
20790 struct font_metrics
*pcm
;
20792 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20793 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20795 if (pcm
->rbearing
> pcm
->width
)
20796 *right
= pcm
->rbearing
- pcm
->width
;
20797 if (pcm
->lbearing
< 0)
20798 *left
= -pcm
->lbearing
;
20801 else if (glyph
->type
== COMPOSITE_GLYPH
)
20803 if (! glyph
->u
.cmp
.automatic
)
20805 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20807 if (cmp
->rbearing
> cmp
->pixel_width
)
20808 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20809 if (cmp
->lbearing
< 0)
20810 *left
= - cmp
->lbearing
;
20814 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20815 struct font_metrics metrics
;
20817 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20818 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20819 if (metrics
.rbearing
> metrics
.width
)
20820 *right
= metrics
.rbearing
- metrics
.width
;
20821 if (metrics
.lbearing
< 0)
20822 *left
= - metrics
.lbearing
;
20828 /* Return the index of the first glyph preceding glyph string S that
20829 is overwritten by S because of S's left overhang. Value is -1
20830 if no glyphs are overwritten. */
20833 left_overwritten (struct glyph_string
*s
)
20837 if (s
->left_overhang
)
20840 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20841 int first
= s
->first_glyph
- glyphs
;
20843 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20844 x
-= glyphs
[i
].pixel_width
;
20855 /* Return the index of the first glyph preceding glyph string S that
20856 is overwriting S because of its right overhang. Value is -1 if no
20857 glyph in front of S overwrites S. */
20860 left_overwriting (struct glyph_string
*s
)
20863 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20864 int first
= s
->first_glyph
- glyphs
;
20868 for (i
= first
- 1; i
>= 0; --i
)
20871 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20874 x
-= glyphs
[i
].pixel_width
;
20881 /* Return the index of the last glyph following glyph string S that is
20882 overwritten by S because of S's right overhang. Value is -1 if
20883 no such glyph is found. */
20886 right_overwritten (struct glyph_string
*s
)
20890 if (s
->right_overhang
)
20893 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20894 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20895 int end
= s
->row
->used
[s
->area
];
20897 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20898 x
+= glyphs
[i
].pixel_width
;
20907 /* Return the index of the last glyph following glyph string S that
20908 overwrites S because of its left overhang. Value is negative
20909 if no such glyph is found. */
20912 right_overwriting (struct glyph_string
*s
)
20915 int end
= s
->row
->used
[s
->area
];
20916 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20917 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20921 for (i
= first
; i
< end
; ++i
)
20924 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20927 x
+= glyphs
[i
].pixel_width
;
20934 /* Set background width of glyph string S. START is the index of the
20935 first glyph following S. LAST_X is the right-most x-position + 1
20936 in the drawing area. */
20939 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20941 /* If the face of this glyph string has to be drawn to the end of
20942 the drawing area, set S->extends_to_end_of_line_p. */
20944 if (start
== s
->row
->used
[s
->area
]
20945 && s
->area
== TEXT_AREA
20946 && ((s
->row
->fill_line_p
20947 && (s
->hl
== DRAW_NORMAL_TEXT
20948 || s
->hl
== DRAW_IMAGE_RAISED
20949 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20950 || s
->hl
== DRAW_MOUSE_FACE
))
20951 s
->extends_to_end_of_line_p
= 1;
20953 /* If S extends its face to the end of the line, set its
20954 background_width to the distance to the right edge of the drawing
20956 if (s
->extends_to_end_of_line_p
)
20957 s
->background_width
= last_x
- s
->x
+ 1;
20959 s
->background_width
= s
->width
;
20963 /* Compute overhangs and x-positions for glyph string S and its
20964 predecessors, or successors. X is the starting x-position for S.
20965 BACKWARD_P non-zero means process predecessors. */
20968 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20974 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20975 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20985 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20986 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20996 /* The following macros are only called from draw_glyphs below.
20997 They reference the following parameters of that function directly:
20998 `w', `row', `area', and `overlap_p'
20999 as well as the following local variables:
21000 `s', `f', and `hdc' (in W32) */
21003 /* On W32, silently add local `hdc' variable to argument list of
21004 init_glyph_string. */
21005 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21006 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21008 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21009 init_glyph_string (s, char2b, w, row, area, start, hl)
21012 /* Add a glyph string for a stretch glyph to the list of strings
21013 between HEAD and TAIL. START is the index of the stretch glyph in
21014 row area AREA of glyph row ROW. END is the index of the last glyph
21015 in that glyph row area. X is the current output position assigned
21016 to the new glyph string constructed. HL overrides that face of the
21017 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21018 is the right-most x-position of the drawing area. */
21020 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21021 and below -- keep them on one line. */
21022 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21025 s = (struct glyph_string *) alloca (sizeof *s); \
21026 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21027 START = fill_stretch_glyph_string (s, row, area, START, END); \
21028 append_glyph_string (&HEAD, &TAIL, s); \
21034 /* Add a glyph string for an image glyph to the list of strings
21035 between HEAD and TAIL. START is the index of the image glyph in
21036 row area AREA of glyph row ROW. END is the index of the last glyph
21037 in that glyph row area. X is the current output position assigned
21038 to the new glyph string constructed. HL overrides that face of the
21039 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21040 is the right-most x-position of the drawing area. */
21042 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21045 s = (struct glyph_string *) alloca (sizeof *s); \
21046 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21047 fill_image_glyph_string (s); \
21048 append_glyph_string (&HEAD, &TAIL, s); \
21055 /* Add a glyph string for a sequence of character glyphs to the list
21056 of strings between HEAD and TAIL. START is the index of the first
21057 glyph in row area AREA of glyph row ROW that is part of the new
21058 glyph string. END is the index of the last glyph in that glyph row
21059 area. X is the current output position assigned to the new glyph
21060 string constructed. HL overrides that face of the glyph; e.g. it
21061 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21062 right-most x-position of the drawing area. */
21064 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21070 face_id = (row)->glyphs[area][START].face_id; \
21072 s = (struct glyph_string *) alloca (sizeof *s); \
21073 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21074 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21075 append_glyph_string (&HEAD, &TAIL, s); \
21077 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21082 /* Add a glyph string for a composite sequence to the list of strings
21083 between HEAD and TAIL. START is the index of the first glyph in
21084 row area AREA of glyph row ROW that is part of the new glyph
21085 string. END is the index of the last glyph in that glyph row area.
21086 X is the current output position assigned to the new glyph string
21087 constructed. HL overrides that face of the glyph; e.g. it is
21088 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21089 x-position of the drawing area. */
21091 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21093 int face_id = (row)->glyphs[area][START].face_id; \
21094 struct face *base_face = FACE_FROM_ID (f, face_id); \
21095 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21096 struct composition *cmp = composition_table[cmp_id]; \
21098 struct glyph_string *first_s IF_LINT (= NULL); \
21101 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21103 /* Make glyph_strings for each glyph sequence that is drawable by \
21104 the same face, and append them to HEAD/TAIL. */ \
21105 for (n = 0; n < cmp->glyph_len;) \
21107 s = (struct glyph_string *) alloca (sizeof *s); \
21108 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21109 append_glyph_string (&(HEAD), &(TAIL), s); \
21115 n = fill_composite_glyph_string (s, base_face, overlaps); \
21123 /* Add a glyph string for a glyph-string sequence to the list of strings
21124 between HEAD and TAIL. */
21126 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21130 Lisp_Object gstring; \
21132 face_id = (row)->glyphs[area][START].face_id; \
21133 gstring = (composition_gstring_from_id \
21134 ((row)->glyphs[area][START].u.cmp.id)); \
21135 s = (struct glyph_string *) alloca (sizeof *s); \
21136 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21137 * LGSTRING_GLYPH_LEN (gstring)); \
21138 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21139 append_glyph_string (&(HEAD), &(TAIL), s); \
21141 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21145 /* Add a glyph string for a sequence of glyphless character's glyphs
21146 to the list of strings between HEAD and TAIL. The meanings of
21147 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21149 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21154 face_id = (row)->glyphs[area][START].face_id; \
21156 s = (struct glyph_string *) alloca (sizeof *s); \
21157 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21158 append_glyph_string (&HEAD, &TAIL, s); \
21160 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21166 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21167 of AREA of glyph row ROW on window W between indices START and END.
21168 HL overrides the face for drawing glyph strings, e.g. it is
21169 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21170 x-positions of the drawing area.
21172 This is an ugly monster macro construct because we must use alloca
21173 to allocate glyph strings (because draw_glyphs can be called
21174 asynchronously). */
21176 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21179 HEAD = TAIL = NULL; \
21180 while (START < END) \
21182 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21183 switch (first_glyph->type) \
21186 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21190 case COMPOSITE_GLYPH: \
21191 if (first_glyph->u.cmp.automatic) \
21192 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21195 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21199 case STRETCH_GLYPH: \
21200 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21204 case IMAGE_GLYPH: \
21205 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21209 case GLYPHLESS_GLYPH: \
21210 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21220 set_glyph_string_background_width (s, START, LAST_X); \
21227 /* Draw glyphs between START and END in AREA of ROW on window W,
21228 starting at x-position X. X is relative to AREA in W. HL is a
21229 face-override with the following meaning:
21231 DRAW_NORMAL_TEXT draw normally
21232 DRAW_CURSOR draw in cursor face
21233 DRAW_MOUSE_FACE draw in mouse face.
21234 DRAW_INVERSE_VIDEO draw in mode line face
21235 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21236 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21238 If OVERLAPS is non-zero, draw only the foreground of characters and
21239 clip to the physical height of ROW. Non-zero value also defines
21240 the overlapping part to be drawn:
21242 OVERLAPS_PRED overlap with preceding rows
21243 OVERLAPS_SUCC overlap with succeeding rows
21244 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21245 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21247 Value is the x-position reached, relative to AREA of W. */
21250 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21251 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21252 enum draw_glyphs_face hl
, int overlaps
)
21254 struct glyph_string
*head
, *tail
;
21255 struct glyph_string
*s
;
21256 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21257 int i
, j
, x_reached
, last_x
, area_left
= 0;
21258 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21261 ALLOCATE_HDC (hdc
, f
);
21263 /* Let's rather be paranoid than getting a SEGV. */
21264 end
= min (end
, row
->used
[area
]);
21265 start
= max (0, start
);
21266 start
= min (end
, start
);
21268 /* Translate X to frame coordinates. Set last_x to the right
21269 end of the drawing area. */
21270 if (row
->full_width_p
)
21272 /* X is relative to the left edge of W, without scroll bars
21274 area_left
= WINDOW_LEFT_EDGE_X (w
);
21275 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21279 area_left
= window_box_left (w
, area
);
21280 last_x
= area_left
+ window_box_width (w
, area
);
21284 /* Build a doubly-linked list of glyph_string structures between
21285 head and tail from what we have to draw. Note that the macro
21286 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21287 the reason we use a separate variable `i'. */
21289 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21291 x_reached
= tail
->x
+ tail
->background_width
;
21295 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21296 the row, redraw some glyphs in front or following the glyph
21297 strings built above. */
21298 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21300 struct glyph_string
*h
, *t
;
21301 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21302 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21303 int check_mouse_face
= 0;
21306 /* If mouse highlighting is on, we may need to draw adjacent
21307 glyphs using mouse-face highlighting. */
21308 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21310 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21312 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21313 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21315 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21317 check_mouse_face
= 1;
21318 mouse_beg_col
= (row
== mouse_beg_row
)
21319 ? hlinfo
->mouse_face_beg_col
: 0;
21320 mouse_end_col
= (row
== mouse_end_row
)
21321 ? hlinfo
->mouse_face_end_col
21322 : row
->used
[TEXT_AREA
];
21326 /* Compute overhangs for all glyph strings. */
21327 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21328 for (s
= head
; s
; s
= s
->next
)
21329 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21331 /* Prepend glyph strings for glyphs in front of the first glyph
21332 string that are overwritten because of the first glyph
21333 string's left overhang. The background of all strings
21334 prepended must be drawn because the first glyph string
21336 i
= left_overwritten (head
);
21339 enum draw_glyphs_face overlap_hl
;
21341 /* If this row contains mouse highlighting, attempt to draw
21342 the overlapped glyphs with the correct highlight. This
21343 code fails if the overlap encompasses more than one glyph
21344 and mouse-highlight spans only some of these glyphs.
21345 However, making it work perfectly involves a lot more
21346 code, and I don't know if the pathological case occurs in
21347 practice, so we'll stick to this for now. --- cyd */
21348 if (check_mouse_face
21349 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21350 overlap_hl
= DRAW_MOUSE_FACE
;
21352 overlap_hl
= DRAW_NORMAL_TEXT
;
21355 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21356 overlap_hl
, dummy_x
, last_x
);
21358 compute_overhangs_and_x (t
, head
->x
, 1);
21359 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21363 /* Prepend glyph strings for glyphs in front of the first glyph
21364 string that overwrite that glyph string because of their
21365 right overhang. For these strings, only the foreground must
21366 be drawn, because it draws over the glyph string at `head'.
21367 The background must not be drawn because this would overwrite
21368 right overhangs of preceding glyphs for which no glyph
21370 i
= left_overwriting (head
);
21373 enum draw_glyphs_face overlap_hl
;
21375 if (check_mouse_face
21376 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21377 overlap_hl
= DRAW_MOUSE_FACE
;
21379 overlap_hl
= DRAW_NORMAL_TEXT
;
21382 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21383 overlap_hl
, dummy_x
, last_x
);
21384 for (s
= h
; s
; s
= s
->next
)
21385 s
->background_filled_p
= 1;
21386 compute_overhangs_and_x (t
, head
->x
, 1);
21387 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21390 /* Append glyphs strings for glyphs following the last glyph
21391 string tail that are overwritten by tail. The background of
21392 these strings has to be drawn because tail's foreground draws
21394 i
= right_overwritten (tail
);
21397 enum draw_glyphs_face overlap_hl
;
21399 if (check_mouse_face
21400 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21401 overlap_hl
= DRAW_MOUSE_FACE
;
21403 overlap_hl
= DRAW_NORMAL_TEXT
;
21405 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21406 overlap_hl
, x
, last_x
);
21407 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21408 we don't have `end = i;' here. */
21409 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21410 append_glyph_string_lists (&head
, &tail
, h
, t
);
21414 /* Append glyph strings for glyphs following the last glyph
21415 string tail that overwrite tail. The foreground of such
21416 glyphs has to be drawn because it writes into the background
21417 of tail. The background must not be drawn because it could
21418 paint over the foreground of following glyphs. */
21419 i
= right_overwriting (tail
);
21422 enum draw_glyphs_face overlap_hl
;
21423 if (check_mouse_face
21424 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21425 overlap_hl
= DRAW_MOUSE_FACE
;
21427 overlap_hl
= DRAW_NORMAL_TEXT
;
21430 i
++; /* We must include the Ith glyph. */
21431 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21432 overlap_hl
, x
, last_x
);
21433 for (s
= h
; s
; s
= s
->next
)
21434 s
->background_filled_p
= 1;
21435 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21436 append_glyph_string_lists (&head
, &tail
, h
, t
);
21438 if (clip_head
|| clip_tail
)
21439 for (s
= head
; s
; s
= s
->next
)
21441 s
->clip_head
= clip_head
;
21442 s
->clip_tail
= clip_tail
;
21446 /* Draw all strings. */
21447 for (s
= head
; s
; s
= s
->next
)
21448 FRAME_RIF (f
)->draw_glyph_string (s
);
21451 /* When focus a sole frame and move horizontally, this sets on_p to 0
21452 causing a failure to erase prev cursor position. */
21453 if (area
== TEXT_AREA
21454 && !row
->full_width_p
21455 /* When drawing overlapping rows, only the glyph strings'
21456 foreground is drawn, which doesn't erase a cursor
21460 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21461 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21462 : (tail
? tail
->x
+ tail
->background_width
: x
));
21466 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21467 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21471 /* Value is the x-position up to which drawn, relative to AREA of W.
21472 This doesn't include parts drawn because of overhangs. */
21473 if (row
->full_width_p
)
21474 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21476 x_reached
-= area_left
;
21478 RELEASE_HDC (hdc
, f
);
21483 /* Expand row matrix if too narrow. Don't expand if area
21486 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21488 if (!fonts_changed_p \
21489 && (it->glyph_row->glyphs[area] \
21490 < it->glyph_row->glyphs[area + 1])) \
21492 it->w->ncols_scale_factor++; \
21493 fonts_changed_p = 1; \
21497 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21498 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21501 append_glyph (struct it
*it
)
21503 struct glyph
*glyph
;
21504 enum glyph_row_area area
= it
->area
;
21506 xassert (it
->glyph_row
);
21507 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21509 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21510 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21512 /* If the glyph row is reversed, we need to prepend the glyph
21513 rather than append it. */
21514 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21518 /* Make room for the additional glyph. */
21519 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21521 glyph
= it
->glyph_row
->glyphs
[area
];
21523 glyph
->charpos
= CHARPOS (it
->position
);
21524 glyph
->object
= it
->object
;
21525 if (it
->pixel_width
> 0)
21527 glyph
->pixel_width
= it
->pixel_width
;
21528 glyph
->padding_p
= 0;
21532 /* Assure at least 1-pixel width. Otherwise, cursor can't
21533 be displayed correctly. */
21534 glyph
->pixel_width
= 1;
21535 glyph
->padding_p
= 1;
21537 glyph
->ascent
= it
->ascent
;
21538 glyph
->descent
= it
->descent
;
21539 glyph
->voffset
= it
->voffset
;
21540 glyph
->type
= CHAR_GLYPH
;
21541 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21542 glyph
->multibyte_p
= it
->multibyte_p
;
21543 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21544 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21545 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21546 || it
->phys_descent
> it
->descent
);
21547 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21548 glyph
->face_id
= it
->face_id
;
21549 glyph
->u
.ch
= it
->char_to_display
;
21550 glyph
->slice
.img
= null_glyph_slice
;
21551 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21554 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21555 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21557 glyph
->bidi_type
= it
->bidi_it
.type
;
21561 glyph
->resolved_level
= 0;
21562 glyph
->bidi_type
= UNKNOWN_BT
;
21564 ++it
->glyph_row
->used
[area
];
21567 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21570 /* Store one glyph for the composition IT->cmp_it.id in
21571 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21575 append_composite_glyph (struct it
*it
)
21577 struct glyph
*glyph
;
21578 enum glyph_row_area area
= it
->area
;
21580 xassert (it
->glyph_row
);
21582 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21583 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21585 /* If the glyph row is reversed, we need to prepend the glyph
21586 rather than append it. */
21587 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21591 /* Make room for the new glyph. */
21592 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21594 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21596 glyph
->charpos
= it
->cmp_it
.charpos
;
21597 glyph
->object
= it
->object
;
21598 glyph
->pixel_width
= it
->pixel_width
;
21599 glyph
->ascent
= it
->ascent
;
21600 glyph
->descent
= it
->descent
;
21601 glyph
->voffset
= it
->voffset
;
21602 glyph
->type
= COMPOSITE_GLYPH
;
21603 if (it
->cmp_it
.ch
< 0)
21605 glyph
->u
.cmp
.automatic
= 0;
21606 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21607 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21611 glyph
->u
.cmp
.automatic
= 1;
21612 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21613 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21614 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21616 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21617 glyph
->multibyte_p
= it
->multibyte_p
;
21618 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21619 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21620 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21621 || it
->phys_descent
> it
->descent
);
21622 glyph
->padding_p
= 0;
21623 glyph
->glyph_not_available_p
= 0;
21624 glyph
->face_id
= it
->face_id
;
21625 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21628 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21629 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21631 glyph
->bidi_type
= it
->bidi_it
.type
;
21633 ++it
->glyph_row
->used
[area
];
21636 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21640 /* Change IT->ascent and IT->height according to the setting of
21644 take_vertical_position_into_account (struct it
*it
)
21648 if (it
->voffset
< 0)
21649 /* Increase the ascent so that we can display the text higher
21651 it
->ascent
-= it
->voffset
;
21653 /* Increase the descent so that we can display the text lower
21655 it
->descent
+= it
->voffset
;
21660 /* Produce glyphs/get display metrics for the image IT is loaded with.
21661 See the description of struct display_iterator in dispextern.h for
21662 an overview of struct display_iterator. */
21665 produce_image_glyph (struct it
*it
)
21669 int glyph_ascent
, crop
;
21670 struct glyph_slice slice
;
21672 xassert (it
->what
== IT_IMAGE
);
21674 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21676 /* Make sure X resources of the face is loaded. */
21677 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21679 if (it
->image_id
< 0)
21681 /* Fringe bitmap. */
21682 it
->ascent
= it
->phys_ascent
= 0;
21683 it
->descent
= it
->phys_descent
= 0;
21684 it
->pixel_width
= 0;
21689 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21691 /* Make sure X resources of the image is loaded. */
21692 prepare_image_for_display (it
->f
, img
);
21694 slice
.x
= slice
.y
= 0;
21695 slice
.width
= img
->width
;
21696 slice
.height
= img
->height
;
21698 if (INTEGERP (it
->slice
.x
))
21699 slice
.x
= XINT (it
->slice
.x
);
21700 else if (FLOATP (it
->slice
.x
))
21701 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21703 if (INTEGERP (it
->slice
.y
))
21704 slice
.y
= XINT (it
->slice
.y
);
21705 else if (FLOATP (it
->slice
.y
))
21706 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21708 if (INTEGERP (it
->slice
.width
))
21709 slice
.width
= XINT (it
->slice
.width
);
21710 else if (FLOATP (it
->slice
.width
))
21711 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21713 if (INTEGERP (it
->slice
.height
))
21714 slice
.height
= XINT (it
->slice
.height
);
21715 else if (FLOATP (it
->slice
.height
))
21716 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21718 if (slice
.x
>= img
->width
)
21719 slice
.x
= img
->width
;
21720 if (slice
.y
>= img
->height
)
21721 slice
.y
= img
->height
;
21722 if (slice
.x
+ slice
.width
>= img
->width
)
21723 slice
.width
= img
->width
- slice
.x
;
21724 if (slice
.y
+ slice
.height
> img
->height
)
21725 slice
.height
= img
->height
- slice
.y
;
21727 if (slice
.width
== 0 || slice
.height
== 0)
21730 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21732 it
->descent
= slice
.height
- glyph_ascent
;
21734 it
->descent
+= img
->vmargin
;
21735 if (slice
.y
+ slice
.height
== img
->height
)
21736 it
->descent
+= img
->vmargin
;
21737 it
->phys_descent
= it
->descent
;
21739 it
->pixel_width
= slice
.width
;
21741 it
->pixel_width
+= img
->hmargin
;
21742 if (slice
.x
+ slice
.width
== img
->width
)
21743 it
->pixel_width
+= img
->hmargin
;
21745 /* It's quite possible for images to have an ascent greater than
21746 their height, so don't get confused in that case. */
21747 if (it
->descent
< 0)
21752 if (face
->box
!= FACE_NO_BOX
)
21754 if (face
->box_line_width
> 0)
21757 it
->ascent
+= face
->box_line_width
;
21758 if (slice
.y
+ slice
.height
== img
->height
)
21759 it
->descent
+= face
->box_line_width
;
21762 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21763 it
->pixel_width
+= eabs (face
->box_line_width
);
21764 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21765 it
->pixel_width
+= eabs (face
->box_line_width
);
21768 take_vertical_position_into_account (it
);
21770 /* Automatically crop wide image glyphs at right edge so we can
21771 draw the cursor on same display row. */
21772 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21773 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21775 it
->pixel_width
-= crop
;
21776 slice
.width
-= crop
;
21781 struct glyph
*glyph
;
21782 enum glyph_row_area area
= it
->area
;
21784 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21785 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21787 glyph
->charpos
= CHARPOS (it
->position
);
21788 glyph
->object
= it
->object
;
21789 glyph
->pixel_width
= it
->pixel_width
;
21790 glyph
->ascent
= glyph_ascent
;
21791 glyph
->descent
= it
->descent
;
21792 glyph
->voffset
= it
->voffset
;
21793 glyph
->type
= IMAGE_GLYPH
;
21794 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21795 glyph
->multibyte_p
= it
->multibyte_p
;
21796 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21797 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21798 glyph
->overlaps_vertically_p
= 0;
21799 glyph
->padding_p
= 0;
21800 glyph
->glyph_not_available_p
= 0;
21801 glyph
->face_id
= it
->face_id
;
21802 glyph
->u
.img_id
= img
->id
;
21803 glyph
->slice
.img
= slice
;
21804 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21807 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21808 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21810 glyph
->bidi_type
= it
->bidi_it
.type
;
21812 ++it
->glyph_row
->used
[area
];
21815 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21820 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21821 of the glyph, WIDTH and HEIGHT are the width and height of the
21822 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21825 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21826 int width
, int height
, int ascent
)
21828 struct glyph
*glyph
;
21829 enum glyph_row_area area
= it
->area
;
21831 xassert (ascent
>= 0 && ascent
<= height
);
21833 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21834 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21836 /* If the glyph row is reversed, we need to prepend the glyph
21837 rather than append it. */
21838 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21842 /* Make room for the additional glyph. */
21843 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21845 glyph
= it
->glyph_row
->glyphs
[area
];
21847 glyph
->charpos
= CHARPOS (it
->position
);
21848 glyph
->object
= object
;
21849 glyph
->pixel_width
= width
;
21850 glyph
->ascent
= ascent
;
21851 glyph
->descent
= height
- ascent
;
21852 glyph
->voffset
= it
->voffset
;
21853 glyph
->type
= STRETCH_GLYPH
;
21854 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21855 glyph
->multibyte_p
= it
->multibyte_p
;
21856 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21857 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21858 glyph
->overlaps_vertically_p
= 0;
21859 glyph
->padding_p
= 0;
21860 glyph
->glyph_not_available_p
= 0;
21861 glyph
->face_id
= it
->face_id
;
21862 glyph
->u
.stretch
.ascent
= ascent
;
21863 glyph
->u
.stretch
.height
= height
;
21864 glyph
->slice
.img
= null_glyph_slice
;
21865 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21868 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21869 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21871 glyph
->bidi_type
= it
->bidi_it
.type
;
21875 glyph
->resolved_level
= 0;
21876 glyph
->bidi_type
= UNKNOWN_BT
;
21878 ++it
->glyph_row
->used
[area
];
21881 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21885 /* Produce a stretch glyph for iterator IT. IT->object is the value
21886 of the glyph property displayed. The value must be a list
21887 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21890 1. `:width WIDTH' specifies that the space should be WIDTH *
21891 canonical char width wide. WIDTH may be an integer or floating
21894 2. `:relative-width FACTOR' specifies that the width of the stretch
21895 should be computed from the width of the first character having the
21896 `glyph' property, and should be FACTOR times that width.
21898 3. `:align-to HPOS' specifies that the space should be wide enough
21899 to reach HPOS, a value in canonical character units.
21901 Exactly one of the above pairs must be present.
21903 4. `:height HEIGHT' specifies that the height of the stretch produced
21904 should be HEIGHT, measured in canonical character units.
21906 5. `:relative-height FACTOR' specifies that the height of the
21907 stretch should be FACTOR times the height of the characters having
21908 the glyph property.
21910 Either none or exactly one of 4 or 5 must be present.
21912 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21913 of the stretch should be used for the ascent of the stretch.
21914 ASCENT must be in the range 0 <= ASCENT <= 100. */
21917 produce_stretch_glyph (struct it
*it
)
21919 /* (space :width WIDTH :height HEIGHT ...) */
21920 Lisp_Object prop
, plist
;
21921 int width
= 0, height
= 0, align_to
= -1;
21922 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21925 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21926 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21928 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21930 /* List should start with `space'. */
21931 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21932 plist
= XCDR (it
->object
);
21934 /* Compute the width of the stretch. */
21935 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21936 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21938 /* Absolute width `:width WIDTH' specified and valid. */
21939 zero_width_ok_p
= 1;
21942 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21945 /* Relative width `:relative-width FACTOR' specified and valid.
21946 Compute the width of the characters having the `glyph'
21949 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21952 if (it
->multibyte_p
)
21953 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21956 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21957 if (! ASCII_CHAR_P (it2
.c
))
21958 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21961 it2
.glyph_row
= NULL
;
21962 it2
.what
= IT_CHARACTER
;
21963 x_produce_glyphs (&it2
);
21964 width
= NUMVAL (prop
) * it2
.pixel_width
;
21966 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21967 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21969 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21970 align_to
= (align_to
< 0
21972 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21973 else if (align_to
< 0)
21974 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21975 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21976 zero_width_ok_p
= 1;
21979 /* Nothing specified -> width defaults to canonical char width. */
21980 width
= FRAME_COLUMN_WIDTH (it
->f
);
21982 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21985 /* Compute height. */
21986 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21987 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21990 zero_height_ok_p
= 1;
21992 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21994 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21996 height
= FONT_HEIGHT (font
);
21998 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22001 /* Compute percentage of height used for ascent. If
22002 `:ascent ASCENT' is present and valid, use that. Otherwise,
22003 derive the ascent from the font in use. */
22004 if (prop
= Fplist_get (plist
, QCascent
),
22005 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22006 ascent
= height
* NUMVAL (prop
) / 100.0;
22007 else if (!NILP (prop
)
22008 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22009 ascent
= min (max (0, (int)tem
), height
);
22011 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22013 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22014 && it
->current_x
+ width
> it
->last_visible_x
)
22015 width
= it
->last_visible_x
- it
->current_x
- 1;
22017 if (width
> 0 && height
> 0 && it
->glyph_row
)
22019 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22020 if (!STRINGP (object
))
22021 object
= it
->w
->buffer
;
22022 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22025 it
->pixel_width
= width
;
22026 it
->ascent
= it
->phys_ascent
= ascent
;
22027 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22028 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22030 take_vertical_position_into_account (it
);
22033 /* Calculate line-height and line-spacing properties.
22034 An integer value specifies explicit pixel value.
22035 A float value specifies relative value to current face height.
22036 A cons (float . face-name) specifies relative value to
22037 height of specified face font.
22039 Returns height in pixels, or nil. */
22043 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22044 int boff
, int override
)
22046 Lisp_Object face_name
= Qnil
;
22047 int ascent
, descent
, height
;
22049 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22054 face_name
= XCAR (val
);
22056 if (!NUMBERP (val
))
22057 val
= make_number (1);
22058 if (NILP (face_name
))
22060 height
= it
->ascent
+ it
->descent
;
22065 if (NILP (face_name
))
22067 font
= FRAME_FONT (it
->f
);
22068 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22070 else if (EQ (face_name
, Qt
))
22079 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22081 return make_number (-1);
22083 face
= FACE_FROM_ID (it
->f
, face_id
);
22086 return make_number (-1);
22087 boff
= font
->baseline_offset
;
22088 if (font
->vertical_centering
)
22089 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22092 ascent
= FONT_BASE (font
) + boff
;
22093 descent
= FONT_DESCENT (font
) - boff
;
22097 it
->override_ascent
= ascent
;
22098 it
->override_descent
= descent
;
22099 it
->override_boff
= boff
;
22102 height
= ascent
+ descent
;
22106 height
= (int)(XFLOAT_DATA (val
) * height
);
22107 else if (INTEGERP (val
))
22108 height
*= XINT (val
);
22110 return make_number (height
);
22114 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22115 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22116 and only if this is for a character for which no font was found.
22118 If the display method (it->glyphless_method) is
22119 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22120 length of the acronym or the hexadecimal string, UPPER_XOFF and
22121 UPPER_YOFF are pixel offsets for the upper part of the string,
22122 LOWER_XOFF and LOWER_YOFF are for the lower part.
22124 For the other display methods, LEN through LOWER_YOFF are zero. */
22127 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22128 short upper_xoff
, short upper_yoff
,
22129 short lower_xoff
, short lower_yoff
)
22131 struct glyph
*glyph
;
22132 enum glyph_row_area area
= it
->area
;
22134 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22135 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22137 /* If the glyph row is reversed, we need to prepend the glyph
22138 rather than append it. */
22139 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22143 /* Make room for the additional glyph. */
22144 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22146 glyph
= it
->glyph_row
->glyphs
[area
];
22148 glyph
->charpos
= CHARPOS (it
->position
);
22149 glyph
->object
= it
->object
;
22150 glyph
->pixel_width
= it
->pixel_width
;
22151 glyph
->ascent
= it
->ascent
;
22152 glyph
->descent
= it
->descent
;
22153 glyph
->voffset
= it
->voffset
;
22154 glyph
->type
= GLYPHLESS_GLYPH
;
22155 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22156 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22157 glyph
->u
.glyphless
.len
= len
;
22158 glyph
->u
.glyphless
.ch
= it
->c
;
22159 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22160 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22161 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22162 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22163 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22164 glyph
->multibyte_p
= it
->multibyte_p
;
22165 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22166 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22167 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22168 || it
->phys_descent
> it
->descent
);
22169 glyph
->padding_p
= 0;
22170 glyph
->glyph_not_available_p
= 0;
22171 glyph
->face_id
= face_id
;
22172 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22175 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22176 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22178 glyph
->bidi_type
= it
->bidi_it
.type
;
22180 ++it
->glyph_row
->used
[area
];
22183 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22187 /* Produce a glyph for a glyphless character for iterator IT.
22188 IT->glyphless_method specifies which method to use for displaying
22189 the character. See the description of enum
22190 glyphless_display_method in dispextern.h for the detail.
22192 FOR_NO_FONT is nonzero if and only if this is for a character for
22193 which no font was found. ACRONYM, if non-nil, is an acronym string
22194 for the character. */
22197 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22202 int base_width
, base_height
, width
, height
;
22203 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22206 /* Get the metrics of the base font. We always refer to the current
22208 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22209 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22210 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22211 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22212 base_height
= it
->ascent
+ it
->descent
;
22213 base_width
= font
->average_width
;
22215 /* Get a face ID for the glyph by utilizing a cache (the same way as
22216 doen for `escape-glyph' in get_next_display_element). */
22217 if (it
->f
== last_glyphless_glyph_frame
22218 && it
->face_id
== last_glyphless_glyph_face_id
)
22220 face_id
= last_glyphless_glyph_merged_face_id
;
22224 /* Merge the `glyphless-char' face into the current face. */
22225 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22226 last_glyphless_glyph_frame
= it
->f
;
22227 last_glyphless_glyph_face_id
= it
->face_id
;
22228 last_glyphless_glyph_merged_face_id
= face_id
;
22231 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22233 it
->pixel_width
= THIN_SPACE_WIDTH
;
22235 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22237 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22239 width
= CHAR_WIDTH (it
->c
);
22242 else if (width
> 4)
22244 it
->pixel_width
= base_width
* width
;
22246 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22252 unsigned int code
[6];
22254 int ascent
, descent
;
22255 struct font_metrics metrics_upper
, metrics_lower
;
22257 face
= FACE_FROM_ID (it
->f
, face_id
);
22258 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22259 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22261 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22263 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22264 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22265 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22269 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22270 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22273 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22274 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22275 upper_len
= (len
+ 1) / 2;
22276 font
->driver
->text_extents (font
, code
, upper_len
,
22278 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22283 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22284 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22285 upper_xoff
= upper_yoff
= 2; /* the typical case */
22286 if (base_width
>= width
)
22288 /* Align the upper to the left, the lower to the right. */
22289 it
->pixel_width
= base_width
;
22290 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22294 /* Center the shorter one. */
22295 it
->pixel_width
= width
;
22296 if (metrics_upper
.width
>= metrics_lower
.width
)
22297 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22300 /* FIXME: This code doesn't look right. It formerly was
22301 missing the "lower_xoff = 0;", which couldn't have
22302 been right since it left lower_xoff uninitialized. */
22304 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22308 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22309 top, bottom, and between upper and lower strings. */
22310 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22311 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22312 /* Center vertically.
22313 H:base_height, D:base_descent
22314 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22316 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22317 descent = D - H/2 + h/2;
22318 lower_yoff = descent - 2 - ld;
22319 upper_yoff = lower_yoff - la - 1 - ud; */
22320 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22321 descent
= it
->descent
- (base_height
- height
) / 2;
22322 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22323 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22324 - metrics_upper
.descent
);
22325 /* Don't make the height shorter than the base height. */
22326 if (height
> base_height
)
22328 it
->ascent
= ascent
;
22329 it
->descent
= descent
;
22333 it
->phys_ascent
= it
->ascent
;
22334 it
->phys_descent
= it
->descent
;
22336 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22337 upper_xoff
, upper_yoff
,
22338 lower_xoff
, lower_yoff
);
22340 take_vertical_position_into_account (it
);
22345 Produce glyphs/get display metrics for the display element IT is
22346 loaded with. See the description of struct it in dispextern.h
22347 for an overview of struct it. */
22350 x_produce_glyphs (struct it
*it
)
22352 int extra_line_spacing
= it
->extra_line_spacing
;
22354 it
->glyph_not_available_p
= 0;
22356 if (it
->what
== IT_CHARACTER
)
22359 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22360 struct font
*font
= face
->font
;
22361 struct font_metrics
*pcm
= NULL
;
22362 int boff
; /* baseline offset */
22366 /* When no suitable font is found, display this character by
22367 the method specified in the first extra slot of
22368 Vglyphless_char_display. */
22369 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22371 xassert (it
->what
== IT_GLYPHLESS
);
22372 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22376 boff
= font
->baseline_offset
;
22377 if (font
->vertical_centering
)
22378 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22380 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22386 if (it
->override_ascent
>= 0)
22388 it
->ascent
= it
->override_ascent
;
22389 it
->descent
= it
->override_descent
;
22390 boff
= it
->override_boff
;
22394 it
->ascent
= FONT_BASE (font
) + boff
;
22395 it
->descent
= FONT_DESCENT (font
) - boff
;
22398 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22400 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22401 if (pcm
->width
== 0
22402 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22408 it
->phys_ascent
= pcm
->ascent
+ boff
;
22409 it
->phys_descent
= pcm
->descent
- boff
;
22410 it
->pixel_width
= pcm
->width
;
22414 it
->glyph_not_available_p
= 1;
22415 it
->phys_ascent
= it
->ascent
;
22416 it
->phys_descent
= it
->descent
;
22417 it
->pixel_width
= font
->space_width
;
22420 if (it
->constrain_row_ascent_descent_p
)
22422 if (it
->descent
> it
->max_descent
)
22424 it
->ascent
+= it
->descent
- it
->max_descent
;
22425 it
->descent
= it
->max_descent
;
22427 if (it
->ascent
> it
->max_ascent
)
22429 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22430 it
->ascent
= it
->max_ascent
;
22432 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22433 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22434 extra_line_spacing
= 0;
22437 /* If this is a space inside a region of text with
22438 `space-width' property, change its width. */
22439 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22441 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22443 /* If face has a box, add the box thickness to the character
22444 height. If character has a box line to the left and/or
22445 right, add the box line width to the character's width. */
22446 if (face
->box
!= FACE_NO_BOX
)
22448 int thick
= face
->box_line_width
;
22452 it
->ascent
+= thick
;
22453 it
->descent
+= thick
;
22458 if (it
->start_of_box_run_p
)
22459 it
->pixel_width
+= thick
;
22460 if (it
->end_of_box_run_p
)
22461 it
->pixel_width
+= thick
;
22464 /* If face has an overline, add the height of the overline
22465 (1 pixel) and a 1 pixel margin to the character height. */
22466 if (face
->overline_p
)
22467 it
->ascent
+= overline_margin
;
22469 if (it
->constrain_row_ascent_descent_p
)
22471 if (it
->ascent
> it
->max_ascent
)
22472 it
->ascent
= it
->max_ascent
;
22473 if (it
->descent
> it
->max_descent
)
22474 it
->descent
= it
->max_descent
;
22477 take_vertical_position_into_account (it
);
22479 /* If we have to actually produce glyphs, do it. */
22484 /* Translate a space with a `space-width' property
22485 into a stretch glyph. */
22486 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22487 / FONT_HEIGHT (font
));
22488 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22489 it
->ascent
+ it
->descent
, ascent
);
22494 /* If characters with lbearing or rbearing are displayed
22495 in this line, record that fact in a flag of the
22496 glyph row. This is used to optimize X output code. */
22497 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22498 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22500 if (! stretched_p
&& it
->pixel_width
== 0)
22501 /* We assure that all visible glyphs have at least 1-pixel
22503 it
->pixel_width
= 1;
22505 else if (it
->char_to_display
== '\n')
22507 /* A newline has no width, but we need the height of the
22508 line. But if previous part of the line sets a height,
22509 don't increase that height */
22511 Lisp_Object height
;
22512 Lisp_Object total_height
= Qnil
;
22514 it
->override_ascent
= -1;
22515 it
->pixel_width
= 0;
22518 height
= get_it_property (it
, Qline_height
);
22519 /* Split (line-height total-height) list */
22521 && CONSP (XCDR (height
))
22522 && NILP (XCDR (XCDR (height
))))
22524 total_height
= XCAR (XCDR (height
));
22525 height
= XCAR (height
);
22527 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22529 if (it
->override_ascent
>= 0)
22531 it
->ascent
= it
->override_ascent
;
22532 it
->descent
= it
->override_descent
;
22533 boff
= it
->override_boff
;
22537 it
->ascent
= FONT_BASE (font
) + boff
;
22538 it
->descent
= FONT_DESCENT (font
) - boff
;
22541 if (EQ (height
, Qt
))
22543 if (it
->descent
> it
->max_descent
)
22545 it
->ascent
+= it
->descent
- it
->max_descent
;
22546 it
->descent
= it
->max_descent
;
22548 if (it
->ascent
> it
->max_ascent
)
22550 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22551 it
->ascent
= it
->max_ascent
;
22553 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22554 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22555 it
->constrain_row_ascent_descent_p
= 1;
22556 extra_line_spacing
= 0;
22560 Lisp_Object spacing
;
22562 it
->phys_ascent
= it
->ascent
;
22563 it
->phys_descent
= it
->descent
;
22565 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22566 && face
->box
!= FACE_NO_BOX
22567 && face
->box_line_width
> 0)
22569 it
->ascent
+= face
->box_line_width
;
22570 it
->descent
+= face
->box_line_width
;
22573 && XINT (height
) > it
->ascent
+ it
->descent
)
22574 it
->ascent
= XINT (height
) - it
->descent
;
22576 if (!NILP (total_height
))
22577 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22580 spacing
= get_it_property (it
, Qline_spacing
);
22581 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22583 if (INTEGERP (spacing
))
22585 extra_line_spacing
= XINT (spacing
);
22586 if (!NILP (total_height
))
22587 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22591 else /* i.e. (it->char_to_display == '\t') */
22593 if (font
->space_width
> 0)
22595 int tab_width
= it
->tab_width
* font
->space_width
;
22596 int x
= it
->current_x
+ it
->continuation_lines_width
;
22597 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22599 /* If the distance from the current position to the next tab
22600 stop is less than a space character width, use the
22601 tab stop after that. */
22602 if (next_tab_x
- x
< font
->space_width
)
22603 next_tab_x
+= tab_width
;
22605 it
->pixel_width
= next_tab_x
- x
;
22607 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22608 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22612 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22613 it
->ascent
+ it
->descent
, it
->ascent
);
22618 it
->pixel_width
= 0;
22623 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22625 /* A static composition.
22627 Note: A composition is represented as one glyph in the
22628 glyph matrix. There are no padding glyphs.
22630 Important note: pixel_width, ascent, and descent are the
22631 values of what is drawn by draw_glyphs (i.e. the values of
22632 the overall glyphs composed). */
22633 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22634 int boff
; /* baseline offset */
22635 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22636 int glyph_len
= cmp
->glyph_len
;
22637 struct font
*font
= face
->font
;
22641 /* If we have not yet calculated pixel size data of glyphs of
22642 the composition for the current face font, calculate them
22643 now. Theoretically, we have to check all fonts for the
22644 glyphs, but that requires much time and memory space. So,
22645 here we check only the font of the first glyph. This may
22646 lead to incorrect display, but it's very rare, and C-l
22647 (recenter-top-bottom) can correct the display anyway. */
22648 if (! cmp
->font
|| cmp
->font
!= font
)
22650 /* Ascent and descent of the font of the first character
22651 of this composition (adjusted by baseline offset).
22652 Ascent and descent of overall glyphs should not be less
22653 than these, respectively. */
22654 int font_ascent
, font_descent
, font_height
;
22655 /* Bounding box of the overall glyphs. */
22656 int leftmost
, rightmost
, lowest
, highest
;
22657 int lbearing
, rbearing
;
22658 int i
, width
, ascent
, descent
;
22659 int left_padded
= 0, right_padded
= 0;
22662 struct font_metrics
*pcm
;
22663 int font_not_found_p
;
22666 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22667 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22669 if (glyph_len
< cmp
->glyph_len
)
22671 for (i
= 0; i
< glyph_len
; i
++)
22673 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22675 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22680 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22681 : IT_CHARPOS (*it
));
22682 /* If no suitable font is found, use the default font. */
22683 font_not_found_p
= font
== NULL
;
22684 if (font_not_found_p
)
22686 face
= face
->ascii_face
;
22689 boff
= font
->baseline_offset
;
22690 if (font
->vertical_centering
)
22691 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22692 font_ascent
= FONT_BASE (font
) + boff
;
22693 font_descent
= FONT_DESCENT (font
) - boff
;
22694 font_height
= FONT_HEIGHT (font
);
22696 cmp
->font
= (void *) font
;
22699 if (! font_not_found_p
)
22701 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22702 &char2b
, it
->multibyte_p
, 0);
22703 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22706 /* Initialize the bounding box. */
22709 width
= pcm
->width
;
22710 ascent
= pcm
->ascent
;
22711 descent
= pcm
->descent
;
22712 lbearing
= pcm
->lbearing
;
22713 rbearing
= pcm
->rbearing
;
22717 width
= font
->space_width
;
22718 ascent
= FONT_BASE (font
);
22719 descent
= FONT_DESCENT (font
);
22726 lowest
= - descent
+ boff
;
22727 highest
= ascent
+ boff
;
22729 if (! font_not_found_p
22730 && font
->default_ascent
22731 && CHAR_TABLE_P (Vuse_default_ascent
)
22732 && !NILP (Faref (Vuse_default_ascent
,
22733 make_number (it
->char_to_display
))))
22734 highest
= font
->default_ascent
+ boff
;
22736 /* Draw the first glyph at the normal position. It may be
22737 shifted to right later if some other glyphs are drawn
22739 cmp
->offsets
[i
* 2] = 0;
22740 cmp
->offsets
[i
* 2 + 1] = boff
;
22741 cmp
->lbearing
= lbearing
;
22742 cmp
->rbearing
= rbearing
;
22744 /* Set cmp->offsets for the remaining glyphs. */
22745 for (i
++; i
< glyph_len
; i
++)
22747 int left
, right
, btm
, top
;
22748 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22750 struct face
*this_face
;
22754 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22755 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22756 font
= this_face
->font
;
22762 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22763 &char2b
, it
->multibyte_p
, 0);
22764 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22767 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22770 width
= pcm
->width
;
22771 ascent
= pcm
->ascent
;
22772 descent
= pcm
->descent
;
22773 lbearing
= pcm
->lbearing
;
22774 rbearing
= pcm
->rbearing
;
22775 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22777 /* Relative composition with or without
22778 alternate chars. */
22779 left
= (leftmost
+ rightmost
- width
) / 2;
22780 btm
= - descent
+ boff
;
22781 if (font
->relative_compose
22782 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22783 || NILP (Faref (Vignore_relative_composition
,
22784 make_number (ch
)))))
22787 if (- descent
>= font
->relative_compose
)
22788 /* One extra pixel between two glyphs. */
22790 else if (ascent
<= 0)
22791 /* One extra pixel between two glyphs. */
22792 btm
= lowest
- 1 - ascent
- descent
;
22797 /* A composition rule is specified by an integer
22798 value that encodes global and new reference
22799 points (GREF and NREF). GREF and NREF are
22800 specified by numbers as below:
22802 0---1---2 -- ascent
22806 9--10--11 -- center
22808 ---3---4---5--- baseline
22810 6---7---8 -- descent
22812 int rule
= COMPOSITION_RULE (cmp
, i
);
22813 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22815 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22816 grefx
= gref
% 3, nrefx
= nref
% 3;
22817 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22819 xoff
= font_height
* (xoff
- 128) / 256;
22821 yoff
= font_height
* (yoff
- 128) / 256;
22824 + grefx
* (rightmost
- leftmost
) / 2
22825 - nrefx
* width
/ 2
22828 btm
= ((grefy
== 0 ? highest
22830 : grefy
== 2 ? lowest
22831 : (highest
+ lowest
) / 2)
22832 - (nrefy
== 0 ? ascent
+ descent
22833 : nrefy
== 1 ? descent
- boff
22835 : (ascent
+ descent
) / 2)
22839 cmp
->offsets
[i
* 2] = left
;
22840 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22842 /* Update the bounding box of the overall glyphs. */
22845 right
= left
+ width
;
22846 if (left
< leftmost
)
22848 if (right
> rightmost
)
22851 top
= btm
+ descent
+ ascent
;
22857 if (cmp
->lbearing
> left
+ lbearing
)
22858 cmp
->lbearing
= left
+ lbearing
;
22859 if (cmp
->rbearing
< left
+ rbearing
)
22860 cmp
->rbearing
= left
+ rbearing
;
22864 /* If there are glyphs whose x-offsets are negative,
22865 shift all glyphs to the right and make all x-offsets
22869 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22870 cmp
->offsets
[i
* 2] -= leftmost
;
22871 rightmost
-= leftmost
;
22872 cmp
->lbearing
-= leftmost
;
22873 cmp
->rbearing
-= leftmost
;
22876 if (left_padded
&& cmp
->lbearing
< 0)
22878 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22879 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22880 rightmost
-= cmp
->lbearing
;
22881 cmp
->rbearing
-= cmp
->lbearing
;
22884 if (right_padded
&& rightmost
< cmp
->rbearing
)
22886 rightmost
= cmp
->rbearing
;
22889 cmp
->pixel_width
= rightmost
;
22890 cmp
->ascent
= highest
;
22891 cmp
->descent
= - lowest
;
22892 if (cmp
->ascent
< font_ascent
)
22893 cmp
->ascent
= font_ascent
;
22894 if (cmp
->descent
< font_descent
)
22895 cmp
->descent
= font_descent
;
22899 && (cmp
->lbearing
< 0
22900 || cmp
->rbearing
> cmp
->pixel_width
))
22901 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22903 it
->pixel_width
= cmp
->pixel_width
;
22904 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22905 it
->descent
= it
->phys_descent
= cmp
->descent
;
22906 if (face
->box
!= FACE_NO_BOX
)
22908 int thick
= face
->box_line_width
;
22912 it
->ascent
+= thick
;
22913 it
->descent
+= thick
;
22918 if (it
->start_of_box_run_p
)
22919 it
->pixel_width
+= thick
;
22920 if (it
->end_of_box_run_p
)
22921 it
->pixel_width
+= thick
;
22924 /* If face has an overline, add the height of the overline
22925 (1 pixel) and a 1 pixel margin to the character height. */
22926 if (face
->overline_p
)
22927 it
->ascent
+= overline_margin
;
22929 take_vertical_position_into_account (it
);
22930 if (it
->ascent
< 0)
22932 if (it
->descent
< 0)
22936 append_composite_glyph (it
);
22938 else if (it
->what
== IT_COMPOSITION
)
22940 /* A dynamic (automatic) composition. */
22941 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22942 Lisp_Object gstring
;
22943 struct font_metrics metrics
;
22945 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22947 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22950 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22951 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22952 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22953 it
->descent
= it
->phys_descent
= metrics
.descent
;
22954 if (face
->box
!= FACE_NO_BOX
)
22956 int thick
= face
->box_line_width
;
22960 it
->ascent
+= thick
;
22961 it
->descent
+= thick
;
22966 if (it
->start_of_box_run_p
)
22967 it
->pixel_width
+= thick
;
22968 if (it
->end_of_box_run_p
)
22969 it
->pixel_width
+= thick
;
22971 /* If face has an overline, add the height of the overline
22972 (1 pixel) and a 1 pixel margin to the character height. */
22973 if (face
->overline_p
)
22974 it
->ascent
+= overline_margin
;
22975 take_vertical_position_into_account (it
);
22976 if (it
->ascent
< 0)
22978 if (it
->descent
< 0)
22982 append_composite_glyph (it
);
22984 else if (it
->what
== IT_GLYPHLESS
)
22985 produce_glyphless_glyph (it
, 0, Qnil
);
22986 else if (it
->what
== IT_IMAGE
)
22987 produce_image_glyph (it
);
22988 else if (it
->what
== IT_STRETCH
)
22989 produce_stretch_glyph (it
);
22992 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22993 because this isn't true for images with `:ascent 100'. */
22994 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22995 if (it
->area
== TEXT_AREA
)
22996 it
->current_x
+= it
->pixel_width
;
22998 if (extra_line_spacing
> 0)
23000 it
->descent
+= extra_line_spacing
;
23001 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23002 it
->max_extra_line_spacing
= extra_line_spacing
;
23005 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23006 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23007 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23008 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23012 Output LEN glyphs starting at START at the nominal cursor position.
23013 Advance the nominal cursor over the text. The global variable
23014 updated_window contains the window being updated, updated_row is
23015 the glyph row being updated, and updated_area is the area of that
23016 row being updated. */
23019 x_write_glyphs (struct glyph
*start
, int len
)
23023 xassert (updated_window
&& updated_row
);
23026 /* Write glyphs. */
23028 hpos
= start
- updated_row
->glyphs
[updated_area
];
23029 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23030 updated_row
, updated_area
,
23032 DRAW_NORMAL_TEXT
, 0);
23034 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23035 if (updated_area
== TEXT_AREA
23036 && updated_window
->phys_cursor_on_p
23037 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23038 && updated_window
->phys_cursor
.hpos
>= hpos
23039 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23040 updated_window
->phys_cursor_on_p
= 0;
23044 /* Advance the output cursor. */
23045 output_cursor
.hpos
+= len
;
23046 output_cursor
.x
= x
;
23051 Insert LEN glyphs from START at the nominal cursor position. */
23054 x_insert_glyphs (struct glyph
*start
, int len
)
23058 int line_height
, shift_by_width
, shifted_region_width
;
23059 struct glyph_row
*row
;
23060 struct glyph
*glyph
;
23061 int frame_x
, frame_y
;
23064 xassert (updated_window
&& updated_row
);
23066 w
= updated_window
;
23067 f
= XFRAME (WINDOW_FRAME (w
));
23069 /* Get the height of the line we are in. */
23071 line_height
= row
->height
;
23073 /* Get the width of the glyphs to insert. */
23074 shift_by_width
= 0;
23075 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23076 shift_by_width
+= glyph
->pixel_width
;
23078 /* Get the width of the region to shift right. */
23079 shifted_region_width
= (window_box_width (w
, updated_area
)
23084 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23085 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23087 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23088 line_height
, shift_by_width
);
23090 /* Write the glyphs. */
23091 hpos
= start
- row
->glyphs
[updated_area
];
23092 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23094 DRAW_NORMAL_TEXT
, 0);
23096 /* Advance the output cursor. */
23097 output_cursor
.hpos
+= len
;
23098 output_cursor
.x
+= shift_by_width
;
23104 Erase the current text line from the nominal cursor position
23105 (inclusive) to pixel column TO_X (exclusive). The idea is that
23106 everything from TO_X onward is already erased.
23108 TO_X is a pixel position relative to updated_area of
23109 updated_window. TO_X == -1 means clear to the end of this area. */
23112 x_clear_end_of_line (int to_x
)
23115 struct window
*w
= updated_window
;
23116 int max_x
, min_y
, max_y
;
23117 int from_x
, from_y
, to_y
;
23119 xassert (updated_window
&& updated_row
);
23120 f
= XFRAME (w
->frame
);
23122 if (updated_row
->full_width_p
)
23123 max_x
= WINDOW_TOTAL_WIDTH (w
);
23125 max_x
= window_box_width (w
, updated_area
);
23126 max_y
= window_text_bottom_y (w
);
23128 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23129 of window. For TO_X > 0, truncate to end of drawing area. */
23135 to_x
= min (to_x
, max_x
);
23137 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23139 /* Notice if the cursor will be cleared by this operation. */
23140 if (!updated_row
->full_width_p
)
23141 notice_overwritten_cursor (w
, updated_area
,
23142 output_cursor
.x
, -1,
23144 MATRIX_ROW_BOTTOM_Y (updated_row
));
23146 from_x
= output_cursor
.x
;
23148 /* Translate to frame coordinates. */
23149 if (updated_row
->full_width_p
)
23151 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23152 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23156 int area_left
= window_box_left (w
, updated_area
);
23157 from_x
+= area_left
;
23161 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23162 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23163 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23165 /* Prevent inadvertently clearing to end of the X window. */
23166 if (to_x
> from_x
&& to_y
> from_y
)
23169 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23170 to_x
- from_x
, to_y
- from_y
);
23175 #endif /* HAVE_WINDOW_SYSTEM */
23179 /***********************************************************************
23181 ***********************************************************************/
23183 /* Value is the internal representation of the specified cursor type
23184 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23185 of the bar cursor. */
23187 static enum text_cursor_kinds
23188 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23190 enum text_cursor_kinds type
;
23195 if (EQ (arg
, Qbox
))
23196 return FILLED_BOX_CURSOR
;
23198 if (EQ (arg
, Qhollow
))
23199 return HOLLOW_BOX_CURSOR
;
23201 if (EQ (arg
, Qbar
))
23208 && EQ (XCAR (arg
), Qbar
)
23209 && INTEGERP (XCDR (arg
))
23210 && XINT (XCDR (arg
)) >= 0)
23212 *width
= XINT (XCDR (arg
));
23216 if (EQ (arg
, Qhbar
))
23219 return HBAR_CURSOR
;
23223 && EQ (XCAR (arg
), Qhbar
)
23224 && INTEGERP (XCDR (arg
))
23225 && XINT (XCDR (arg
)) >= 0)
23227 *width
= XINT (XCDR (arg
));
23228 return HBAR_CURSOR
;
23231 /* Treat anything unknown as "hollow box cursor".
23232 It was bad to signal an error; people have trouble fixing
23233 .Xdefaults with Emacs, when it has something bad in it. */
23234 type
= HOLLOW_BOX_CURSOR
;
23239 /* Set the default cursor types for specified frame. */
23241 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23246 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23247 FRAME_CURSOR_WIDTH (f
) = width
;
23249 /* By default, set up the blink-off state depending on the on-state. */
23251 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23254 FRAME_BLINK_OFF_CURSOR (f
)
23255 = get_specified_cursor_type (XCDR (tem
), &width
);
23256 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23259 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23263 #ifdef HAVE_WINDOW_SYSTEM
23265 /* Return the cursor we want to be displayed in window W. Return
23266 width of bar/hbar cursor through WIDTH arg. Return with
23267 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23268 (i.e. if the `system caret' should track this cursor).
23270 In a mini-buffer window, we want the cursor only to appear if we
23271 are reading input from this window. For the selected window, we
23272 want the cursor type given by the frame parameter or buffer local
23273 setting of cursor-type. If explicitly marked off, draw no cursor.
23274 In all other cases, we want a hollow box cursor. */
23276 static enum text_cursor_kinds
23277 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23278 int *active_cursor
)
23280 struct frame
*f
= XFRAME (w
->frame
);
23281 struct buffer
*b
= XBUFFER (w
->buffer
);
23282 int cursor_type
= DEFAULT_CURSOR
;
23283 Lisp_Object alt_cursor
;
23284 int non_selected
= 0;
23286 *active_cursor
= 1;
23289 if (cursor_in_echo_area
23290 && FRAME_HAS_MINIBUF_P (f
)
23291 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23293 if (w
== XWINDOW (echo_area_window
))
23295 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23297 *width
= FRAME_CURSOR_WIDTH (f
);
23298 return FRAME_DESIRED_CURSOR (f
);
23301 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23304 *active_cursor
= 0;
23308 /* Detect a nonselected window or nonselected frame. */
23309 else if (w
!= XWINDOW (f
->selected_window
)
23310 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23312 *active_cursor
= 0;
23314 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23320 /* Never display a cursor in a window in which cursor-type is nil. */
23321 if (NILP (BVAR (b
, cursor_type
)))
23324 /* Get the normal cursor type for this window. */
23325 if (EQ (BVAR (b
, cursor_type
), Qt
))
23327 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23328 *width
= FRAME_CURSOR_WIDTH (f
);
23331 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23333 /* Use cursor-in-non-selected-windows instead
23334 for non-selected window or frame. */
23337 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23338 if (!EQ (Qt
, alt_cursor
))
23339 return get_specified_cursor_type (alt_cursor
, width
);
23340 /* t means modify the normal cursor type. */
23341 if (cursor_type
== FILLED_BOX_CURSOR
)
23342 cursor_type
= HOLLOW_BOX_CURSOR
;
23343 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23345 return cursor_type
;
23348 /* Use normal cursor if not blinked off. */
23349 if (!w
->cursor_off_p
)
23351 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23353 if (cursor_type
== FILLED_BOX_CURSOR
)
23355 /* Using a block cursor on large images can be very annoying.
23356 So use a hollow cursor for "large" images.
23357 If image is not transparent (no mask), also use hollow cursor. */
23358 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23359 if (img
!= NULL
&& IMAGEP (img
->spec
))
23361 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23362 where N = size of default frame font size.
23363 This should cover most of the "tiny" icons people may use. */
23365 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23366 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23367 cursor_type
= HOLLOW_BOX_CURSOR
;
23370 else if (cursor_type
!= NO_CURSOR
)
23372 /* Display current only supports BOX and HOLLOW cursors for images.
23373 So for now, unconditionally use a HOLLOW cursor when cursor is
23374 not a solid box cursor. */
23375 cursor_type
= HOLLOW_BOX_CURSOR
;
23378 return cursor_type
;
23381 /* Cursor is blinked off, so determine how to "toggle" it. */
23383 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23384 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23385 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23387 /* Then see if frame has specified a specific blink off cursor type. */
23388 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23390 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23391 return FRAME_BLINK_OFF_CURSOR (f
);
23395 /* Some people liked having a permanently visible blinking cursor,
23396 while others had very strong opinions against it. So it was
23397 decided to remove it. KFS 2003-09-03 */
23399 /* Finally perform built-in cursor blinking:
23400 filled box <-> hollow box
23401 wide [h]bar <-> narrow [h]bar
23402 narrow [h]bar <-> no cursor
23403 other type <-> no cursor */
23405 if (cursor_type
== FILLED_BOX_CURSOR
)
23406 return HOLLOW_BOX_CURSOR
;
23408 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23411 return cursor_type
;
23419 /* Notice when the text cursor of window W has been completely
23420 overwritten by a drawing operation that outputs glyphs in AREA
23421 starting at X0 and ending at X1 in the line starting at Y0 and
23422 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23423 the rest of the line after X0 has been written. Y coordinates
23424 are window-relative. */
23427 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23428 int x0
, int x1
, int y0
, int y1
)
23430 int cx0
, cx1
, cy0
, cy1
;
23431 struct glyph_row
*row
;
23433 if (!w
->phys_cursor_on_p
)
23435 if (area
!= TEXT_AREA
)
23438 if (w
->phys_cursor
.vpos
< 0
23439 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23440 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23441 !(row
->enabled_p
&& row
->displays_text_p
)))
23444 if (row
->cursor_in_fringe_p
)
23446 row
->cursor_in_fringe_p
= 0;
23447 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23448 w
->phys_cursor_on_p
= 0;
23452 cx0
= w
->phys_cursor
.x
;
23453 cx1
= cx0
+ w
->phys_cursor_width
;
23454 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23457 /* The cursor image will be completely removed from the
23458 screen if the output area intersects the cursor area in
23459 y-direction. When we draw in [y0 y1[, and some part of
23460 the cursor is at y < y0, that part must have been drawn
23461 before. When scrolling, the cursor is erased before
23462 actually scrolling, so we don't come here. When not
23463 scrolling, the rows above the old cursor row must have
23464 changed, and in this case these rows must have written
23465 over the cursor image.
23467 Likewise if part of the cursor is below y1, with the
23468 exception of the cursor being in the first blank row at
23469 the buffer and window end because update_text_area
23470 doesn't draw that row. (Except when it does, but
23471 that's handled in update_text_area.) */
23473 cy0
= w
->phys_cursor
.y
;
23474 cy1
= cy0
+ w
->phys_cursor_height
;
23475 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23478 w
->phys_cursor_on_p
= 0;
23481 #endif /* HAVE_WINDOW_SYSTEM */
23484 /************************************************************************
23486 ************************************************************************/
23488 #ifdef HAVE_WINDOW_SYSTEM
23491 Fix the display of area AREA of overlapping row ROW in window W
23492 with respect to the overlapping part OVERLAPS. */
23495 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23496 enum glyph_row_area area
, int overlaps
)
23503 for (i
= 0; i
< row
->used
[area
];)
23505 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23507 int start
= i
, start_x
= x
;
23511 x
+= row
->glyphs
[area
][i
].pixel_width
;
23514 while (i
< row
->used
[area
]
23515 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23517 draw_glyphs (w
, start_x
, row
, area
,
23519 DRAW_NORMAL_TEXT
, overlaps
);
23523 x
+= row
->glyphs
[area
][i
].pixel_width
;
23533 Draw the cursor glyph of window W in glyph row ROW. See the
23534 comment of draw_glyphs for the meaning of HL. */
23537 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23538 enum draw_glyphs_face hl
)
23540 /* If cursor hpos is out of bounds, don't draw garbage. This can
23541 happen in mini-buffer windows when switching between echo area
23542 glyphs and mini-buffer. */
23543 if ((row
->reversed_p
23544 ? (w
->phys_cursor
.hpos
>= 0)
23545 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23547 int on_p
= w
->phys_cursor_on_p
;
23549 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23550 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23552 w
->phys_cursor_on_p
= on_p
;
23554 if (hl
== DRAW_CURSOR
)
23555 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23556 /* When we erase the cursor, and ROW is overlapped by other
23557 rows, make sure that these overlapping parts of other rows
23559 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23561 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23563 if (row
> w
->current_matrix
->rows
23564 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23565 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23566 OVERLAPS_ERASED_CURSOR
);
23568 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23569 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23570 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23571 OVERLAPS_ERASED_CURSOR
);
23578 Erase the image of a cursor of window W from the screen. */
23581 erase_phys_cursor (struct window
*w
)
23583 struct frame
*f
= XFRAME (w
->frame
);
23584 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23585 int hpos
= w
->phys_cursor
.hpos
;
23586 int vpos
= w
->phys_cursor
.vpos
;
23587 int mouse_face_here_p
= 0;
23588 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23589 struct glyph_row
*cursor_row
;
23590 struct glyph
*cursor_glyph
;
23591 enum draw_glyphs_face hl
;
23593 /* No cursor displayed or row invalidated => nothing to do on the
23595 if (w
->phys_cursor_type
== NO_CURSOR
)
23596 goto mark_cursor_off
;
23598 /* VPOS >= active_glyphs->nrows means that window has been resized.
23599 Don't bother to erase the cursor. */
23600 if (vpos
>= active_glyphs
->nrows
)
23601 goto mark_cursor_off
;
23603 /* If row containing cursor is marked invalid, there is nothing we
23605 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23606 if (!cursor_row
->enabled_p
)
23607 goto mark_cursor_off
;
23609 /* If line spacing is > 0, old cursor may only be partially visible in
23610 window after split-window. So adjust visible height. */
23611 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23612 window_text_bottom_y (w
) - cursor_row
->y
);
23614 /* If row is completely invisible, don't attempt to delete a cursor which
23615 isn't there. This can happen if cursor is at top of a window, and
23616 we switch to a buffer with a header line in that window. */
23617 if (cursor_row
->visible_height
<= 0)
23618 goto mark_cursor_off
;
23620 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23621 if (cursor_row
->cursor_in_fringe_p
)
23623 cursor_row
->cursor_in_fringe_p
= 0;
23624 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23625 goto mark_cursor_off
;
23628 /* This can happen when the new row is shorter than the old one.
23629 In this case, either draw_glyphs or clear_end_of_line
23630 should have cleared the cursor. Note that we wouldn't be
23631 able to erase the cursor in this case because we don't have a
23632 cursor glyph at hand. */
23633 if ((cursor_row
->reversed_p
23634 ? (w
->phys_cursor
.hpos
< 0)
23635 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23636 goto mark_cursor_off
;
23638 /* If the cursor is in the mouse face area, redisplay that when
23639 we clear the cursor. */
23640 if (! NILP (hlinfo
->mouse_face_window
)
23641 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23642 /* Don't redraw the cursor's spot in mouse face if it is at the
23643 end of a line (on a newline). The cursor appears there, but
23644 mouse highlighting does not. */
23645 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23646 mouse_face_here_p
= 1;
23648 /* Maybe clear the display under the cursor. */
23649 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23652 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23655 cursor_glyph
= get_phys_cursor_glyph (w
);
23656 if (cursor_glyph
== NULL
)
23657 goto mark_cursor_off
;
23659 width
= cursor_glyph
->pixel_width
;
23660 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23661 x
= w
->phys_cursor
.x
;
23663 width
-= left_x
- x
;
23664 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23665 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23666 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23669 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23672 /* Erase the cursor by redrawing the character underneath it. */
23673 if (mouse_face_here_p
)
23674 hl
= DRAW_MOUSE_FACE
;
23676 hl
= DRAW_NORMAL_TEXT
;
23677 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23680 w
->phys_cursor_on_p
= 0;
23681 w
->phys_cursor_type
= NO_CURSOR
;
23686 Display or clear cursor of window W. If ON is zero, clear the
23687 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23688 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23691 display_and_set_cursor (struct window
*w
, int on
,
23692 int hpos
, int vpos
, int x
, int y
)
23694 struct frame
*f
= XFRAME (w
->frame
);
23695 int new_cursor_type
;
23696 int new_cursor_width
;
23698 struct glyph_row
*glyph_row
;
23699 struct glyph
*glyph
;
23701 /* This is pointless on invisible frames, and dangerous on garbaged
23702 windows and frames; in the latter case, the frame or window may
23703 be in the midst of changing its size, and x and y may be off the
23705 if (! FRAME_VISIBLE_P (f
)
23706 || FRAME_GARBAGED_P (f
)
23707 || vpos
>= w
->current_matrix
->nrows
23708 || hpos
>= w
->current_matrix
->matrix_w
)
23711 /* If cursor is off and we want it off, return quickly. */
23712 if (!on
&& !w
->phys_cursor_on_p
)
23715 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23716 /* If cursor row is not enabled, we don't really know where to
23717 display the cursor. */
23718 if (!glyph_row
->enabled_p
)
23720 w
->phys_cursor_on_p
= 0;
23725 if (!glyph_row
->exact_window_width_line_p
23726 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23727 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23729 xassert (interrupt_input_blocked
);
23731 /* Set new_cursor_type to the cursor we want to be displayed. */
23732 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23733 &new_cursor_width
, &active_cursor
);
23735 /* If cursor is currently being shown and we don't want it to be or
23736 it is in the wrong place, or the cursor type is not what we want,
23738 if (w
->phys_cursor_on_p
23740 || w
->phys_cursor
.x
!= x
23741 || w
->phys_cursor
.y
!= y
23742 || new_cursor_type
!= w
->phys_cursor_type
23743 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23744 && new_cursor_width
!= w
->phys_cursor_width
)))
23745 erase_phys_cursor (w
);
23747 /* Don't check phys_cursor_on_p here because that flag is only set
23748 to zero in some cases where we know that the cursor has been
23749 completely erased, to avoid the extra work of erasing the cursor
23750 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23751 still not be visible, or it has only been partly erased. */
23754 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23755 w
->phys_cursor_height
= glyph_row
->height
;
23757 /* Set phys_cursor_.* before x_draw_.* is called because some
23758 of them may need the information. */
23759 w
->phys_cursor
.x
= x
;
23760 w
->phys_cursor
.y
= glyph_row
->y
;
23761 w
->phys_cursor
.hpos
= hpos
;
23762 w
->phys_cursor
.vpos
= vpos
;
23765 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23766 new_cursor_type
, new_cursor_width
,
23767 on
, active_cursor
);
23771 /* Switch the display of W's cursor on or off, according to the value
23775 update_window_cursor (struct window
*w
, int on
)
23777 /* Don't update cursor in windows whose frame is in the process
23778 of being deleted. */
23779 if (w
->current_matrix
)
23782 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23783 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23789 /* Call update_window_cursor with parameter ON_P on all leaf windows
23790 in the window tree rooted at W. */
23793 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23797 if (!NILP (w
->hchild
))
23798 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23799 else if (!NILP (w
->vchild
))
23800 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23802 update_window_cursor (w
, on_p
);
23804 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23810 Display the cursor on window W, or clear it, according to ON_P.
23811 Don't change the cursor's position. */
23814 x_update_cursor (struct frame
*f
, int on_p
)
23816 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23821 Clear the cursor of window W to background color, and mark the
23822 cursor as not shown. This is used when the text where the cursor
23823 is about to be rewritten. */
23826 x_clear_cursor (struct window
*w
)
23828 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23829 update_window_cursor (w
, 0);
23832 #endif /* HAVE_WINDOW_SYSTEM */
23834 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23837 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23838 int start_hpos
, int end_hpos
,
23839 enum draw_glyphs_face draw
)
23841 #ifdef HAVE_WINDOW_SYSTEM
23842 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23844 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23848 #if defined (HAVE_GPM) || defined (MSDOS)
23849 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23854 Display the active region described by mouse_face_* according to DRAW. */
23857 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23859 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23860 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23862 if (/* If window is in the process of being destroyed, don't bother
23864 w
->current_matrix
!= NULL
23865 /* Don't update mouse highlight if hidden */
23866 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23867 /* Recognize when we are called to operate on rows that don't exist
23868 anymore. This can happen when a window is split. */
23869 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23871 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23872 struct glyph_row
*row
, *first
, *last
;
23874 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23875 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23877 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23879 int start_hpos
, end_hpos
, start_x
;
23881 /* For all but the first row, the highlight starts at column 0. */
23884 /* R2L rows have BEG and END in reversed order, but the
23885 screen drawing geometry is always left to right. So
23886 we need to mirror the beginning and end of the
23887 highlighted area in R2L rows. */
23888 if (!row
->reversed_p
)
23890 start_hpos
= hlinfo
->mouse_face_beg_col
;
23891 start_x
= hlinfo
->mouse_face_beg_x
;
23893 else if (row
== last
)
23895 start_hpos
= hlinfo
->mouse_face_end_col
;
23896 start_x
= hlinfo
->mouse_face_end_x
;
23904 else if (row
->reversed_p
&& row
== last
)
23906 start_hpos
= hlinfo
->mouse_face_end_col
;
23907 start_x
= hlinfo
->mouse_face_end_x
;
23917 if (!row
->reversed_p
)
23918 end_hpos
= hlinfo
->mouse_face_end_col
;
23919 else if (row
== first
)
23920 end_hpos
= hlinfo
->mouse_face_beg_col
;
23923 end_hpos
= row
->used
[TEXT_AREA
];
23924 if (draw
== DRAW_NORMAL_TEXT
)
23925 row
->fill_line_p
= 1; /* Clear to end of line */
23928 else if (row
->reversed_p
&& row
== first
)
23929 end_hpos
= hlinfo
->mouse_face_beg_col
;
23932 end_hpos
= row
->used
[TEXT_AREA
];
23933 if (draw
== DRAW_NORMAL_TEXT
)
23934 row
->fill_line_p
= 1; /* Clear to end of line */
23937 if (end_hpos
> start_hpos
)
23939 draw_row_with_mouse_face (w
, start_x
, row
,
23940 start_hpos
, end_hpos
, draw
);
23943 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23947 #ifdef HAVE_WINDOW_SYSTEM
23948 /* When we've written over the cursor, arrange for it to
23949 be displayed again. */
23950 if (FRAME_WINDOW_P (f
)
23951 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23954 display_and_set_cursor (w
, 1,
23955 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23956 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23959 #endif /* HAVE_WINDOW_SYSTEM */
23962 #ifdef HAVE_WINDOW_SYSTEM
23963 /* Change the mouse cursor. */
23964 if (FRAME_WINDOW_P (f
))
23966 if (draw
== DRAW_NORMAL_TEXT
23967 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
23968 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23969 else if (draw
== DRAW_MOUSE_FACE
)
23970 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23972 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23974 #endif /* HAVE_WINDOW_SYSTEM */
23978 Clear out the mouse-highlighted active region.
23979 Redraw it un-highlighted first. Value is non-zero if mouse
23980 face was actually drawn unhighlighted. */
23983 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
23987 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
23989 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
23993 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
23994 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
23995 hlinfo
->mouse_face_window
= Qnil
;
23996 hlinfo
->mouse_face_overlay
= Qnil
;
24000 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24001 within the mouse face on that window. */
24003 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24005 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24007 /* Quickly resolve the easy cases. */
24008 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24009 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24011 if (vpos
< hlinfo
->mouse_face_beg_row
24012 || vpos
> hlinfo
->mouse_face_end_row
)
24014 if (vpos
> hlinfo
->mouse_face_beg_row
24015 && vpos
< hlinfo
->mouse_face_end_row
)
24018 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24020 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24022 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24025 else if ((vpos
== hlinfo
->mouse_face_beg_row
24026 && hpos
>= hlinfo
->mouse_face_beg_col
)
24027 || (vpos
== hlinfo
->mouse_face_end_row
24028 && hpos
< hlinfo
->mouse_face_end_col
))
24033 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24035 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24038 else if ((vpos
== hlinfo
->mouse_face_beg_row
24039 && hpos
<= hlinfo
->mouse_face_beg_col
)
24040 || (vpos
== hlinfo
->mouse_face_end_row
24041 && hpos
> hlinfo
->mouse_face_end_col
))
24049 Non-zero if physical cursor of window W is within mouse face. */
24052 cursor_in_mouse_face_p (struct window
*w
)
24054 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24059 /* Find the glyph rows START_ROW and END_ROW of window W that display
24060 characters between buffer positions START_CHARPOS and END_CHARPOS
24061 (excluding END_CHARPOS). This is similar to row_containing_pos,
24062 but is more accurate when bidi reordering makes buffer positions
24063 change non-linearly with glyph rows. */
24065 rows_from_pos_range (struct window
*w
,
24066 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24067 struct glyph_row
**start
, struct glyph_row
**end
)
24069 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24070 int last_y
= window_text_bottom_y (w
);
24071 struct glyph_row
*row
;
24076 while (!first
->enabled_p
24077 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24080 /* Find the START row. */
24082 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24085 /* A row can potentially be the START row if the range of the
24086 characters it displays intersects the range
24087 [START_CHARPOS..END_CHARPOS). */
24088 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24089 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24090 /* See the commentary in row_containing_pos, for the
24091 explanation of the complicated way to check whether
24092 some position is beyond the end of the characters
24093 displayed by a row. */
24094 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24095 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24096 && !row
->ends_at_zv_p
24097 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24098 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24099 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24100 && !row
->ends_at_zv_p
24101 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24103 /* Found a candidate row. Now make sure at least one of the
24104 glyphs it displays has a charpos from the range
24105 [START_CHARPOS..END_CHARPOS).
24107 This is not obvious because bidi reordering could make
24108 buffer positions of a row be 1,2,3,102,101,100, and if we
24109 want to highlight characters in [50..60), we don't want
24110 this row, even though [50..60) does intersect [1..103),
24111 the range of character positions given by the row's start
24112 and end positions. */
24113 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24114 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24118 if (BUFFERP (g
->object
)
24119 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24128 /* Find the END row. */
24130 /* If the last row is partially visible, start looking for END
24131 from that row, instead of starting from FIRST. */
24132 && !(row
->enabled_p
24133 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24135 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24137 struct glyph_row
*next
= row
+ 1;
24139 if (!next
->enabled_p
24140 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24141 /* The first row >= START whose range of displayed characters
24142 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24143 is the row END + 1. */
24144 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24145 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24146 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24147 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24148 && !next
->ends_at_zv_p
24149 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24150 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24151 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24152 && !next
->ends_at_zv_p
24153 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24160 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24161 but none of the characters it displays are in the range, it is
24163 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24164 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24168 if (BUFFERP (g
->object
)
24169 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24182 /* This function sets the mouse_face_* elements of HLINFO, assuming
24183 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24184 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24185 for the overlay or run of text properties specifying the mouse
24186 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24187 before-string and after-string that must also be highlighted.
24188 COVER_STRING, if non-nil, is a display string that may cover some
24189 or all of the highlighted text. */
24192 mouse_face_from_buffer_pos (Lisp_Object window
,
24193 Mouse_HLInfo
*hlinfo
,
24194 EMACS_INT mouse_charpos
,
24195 EMACS_INT start_charpos
,
24196 EMACS_INT end_charpos
,
24197 Lisp_Object before_string
,
24198 Lisp_Object after_string
,
24199 Lisp_Object cover_string
)
24201 struct window
*w
= XWINDOW (window
);
24202 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24203 struct glyph_row
*r1
, *r2
;
24204 struct glyph
*glyph
, *end
;
24205 EMACS_INT ignore
, pos
;
24208 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24209 xassert (NILP (before_string
) || STRINGP (before_string
));
24210 xassert (NILP (after_string
) || STRINGP (after_string
));
24212 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24213 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24215 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24216 /* If the before-string or display-string contains newlines,
24217 rows_from_pos_range skips to its last row. Move back. */
24218 if (!NILP (before_string
) || !NILP (cover_string
))
24220 struct glyph_row
*prev
;
24221 while ((prev
= r1
- 1, prev
>= first
)
24222 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24223 && prev
->used
[TEXT_AREA
] > 0)
24225 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24226 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24227 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24229 || !(EQ (glyph
->object
, before_string
)
24230 || EQ (glyph
->object
, cover_string
)))
24237 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24238 hlinfo
->mouse_face_past_end
= 1;
24240 else if (!NILP (after_string
))
24242 /* If the after-string has newlines, advance to its last row. */
24243 struct glyph_row
*next
;
24244 struct glyph_row
*last
24245 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24247 for (next
= r2
+ 1;
24249 && next
->used
[TEXT_AREA
] > 0
24250 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24254 /* The rest of the display engine assumes that mouse_face_beg_row is
24255 either above below mouse_face_end_row or identical to it. But
24256 with bidi-reordered continued lines, the row for START_CHARPOS
24257 could be below the row for END_CHARPOS. If so, swap the rows and
24258 store them in correct order. */
24261 struct glyph_row
*tem
= r2
;
24267 hlinfo
->mouse_face_beg_y
= r1
->y
;
24268 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24269 hlinfo
->mouse_face_end_y
= r2
->y
;
24270 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24272 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24273 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24274 could be anywhere in the row and in any order. The strategy
24275 below is to find the leftmost and the rightmost glyph that
24276 belongs to either of these 3 strings, or whose position is
24277 between START_CHARPOS and END_CHARPOS, and highlight all the
24278 glyphs between those two. This may cover more than just the text
24279 between START_CHARPOS and END_CHARPOS if the range of characters
24280 strides the bidi level boundary, e.g. if the beginning is in R2L
24281 text while the end is in L2R text or vice versa. */
24282 if (!r1
->reversed_p
)
24284 /* This row is in a left to right paragraph. Scan it left to
24286 glyph
= r1
->glyphs
[TEXT_AREA
];
24287 end
= glyph
+ r1
->used
[TEXT_AREA
];
24290 /* Skip truncation glyphs at the start of the glyph row. */
24291 if (r1
->displays_text_p
)
24293 && INTEGERP (glyph
->object
)
24294 && glyph
->charpos
< 0;
24296 x
+= glyph
->pixel_width
;
24298 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24299 or COVER_STRING, and the first glyph from buffer whose
24300 position is between START_CHARPOS and END_CHARPOS. */
24302 && !INTEGERP (glyph
->object
)
24303 && !EQ (glyph
->object
, cover_string
)
24304 && !(BUFFERP (glyph
->object
)
24305 && (glyph
->charpos
>= start_charpos
24306 && glyph
->charpos
< end_charpos
));
24309 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24310 are present at buffer positions between START_CHARPOS and
24311 END_CHARPOS, or if they come from an overlay. */
24312 if (EQ (glyph
->object
, before_string
))
24314 pos
= string_buffer_position (before_string
,
24316 /* If pos == 0, it means before_string came from an
24317 overlay, not from a buffer position. */
24318 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24321 else if (EQ (glyph
->object
, after_string
))
24323 pos
= string_buffer_position (after_string
, end_charpos
);
24324 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24327 x
+= glyph
->pixel_width
;
24329 hlinfo
->mouse_face_beg_x
= x
;
24330 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24334 /* This row is in a right to left paragraph. Scan it right to
24338 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24339 glyph
= end
+ r1
->used
[TEXT_AREA
];
24341 /* Skip truncation glyphs at the start of the glyph row. */
24342 if (r1
->displays_text_p
)
24344 && INTEGERP (glyph
->object
)
24345 && glyph
->charpos
< 0;
24349 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24350 or COVER_STRING, and the first glyph from buffer whose
24351 position is between START_CHARPOS and END_CHARPOS. */
24353 && !INTEGERP (glyph
->object
)
24354 && !EQ (glyph
->object
, cover_string
)
24355 && !(BUFFERP (glyph
->object
)
24356 && (glyph
->charpos
>= start_charpos
24357 && glyph
->charpos
< end_charpos
));
24360 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24361 are present at buffer positions between START_CHARPOS and
24362 END_CHARPOS, or if they come from an overlay. */
24363 if (EQ (glyph
->object
, before_string
))
24365 pos
= string_buffer_position (before_string
, start_charpos
);
24366 /* If pos == 0, it means before_string came from an
24367 overlay, not from a buffer position. */
24368 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24371 else if (EQ (glyph
->object
, after_string
))
24373 pos
= string_buffer_position (after_string
, end_charpos
);
24374 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24379 glyph
++; /* first glyph to the right of the highlighted area */
24380 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24381 x
+= g
->pixel_width
;
24382 hlinfo
->mouse_face_beg_x
= x
;
24383 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24386 /* If the highlight ends in a different row, compute GLYPH and END
24387 for the end row. Otherwise, reuse the values computed above for
24388 the row where the highlight begins. */
24391 if (!r2
->reversed_p
)
24393 glyph
= r2
->glyphs
[TEXT_AREA
];
24394 end
= glyph
+ r2
->used
[TEXT_AREA
];
24399 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24400 glyph
= end
+ r2
->used
[TEXT_AREA
];
24404 if (!r2
->reversed_p
)
24406 /* Skip truncation and continuation glyphs near the end of the
24407 row, and also blanks and stretch glyphs inserted by
24408 extend_face_to_end_of_line. */
24410 && INTEGERP ((end
- 1)->object
)
24411 && (end
- 1)->charpos
<= 0)
24413 /* Scan the rest of the glyph row from the end, looking for the
24414 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24415 COVER_STRING, or whose position is between START_CHARPOS
24419 && !INTEGERP (end
->object
)
24420 && !EQ (end
->object
, cover_string
)
24421 && !(BUFFERP (end
->object
)
24422 && (end
->charpos
>= start_charpos
24423 && end
->charpos
< end_charpos
));
24426 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24427 are present at buffer positions between START_CHARPOS and
24428 END_CHARPOS, or if they come from an overlay. */
24429 if (EQ (end
->object
, before_string
))
24431 pos
= string_buffer_position (before_string
, start_charpos
);
24432 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24435 else if (EQ (end
->object
, after_string
))
24437 pos
= string_buffer_position (after_string
, end_charpos
);
24438 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24442 /* Find the X coordinate of the last glyph to be highlighted. */
24443 for (; glyph
<= end
; ++glyph
)
24444 x
+= glyph
->pixel_width
;
24446 hlinfo
->mouse_face_end_x
= x
;
24447 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24451 /* Skip truncation and continuation glyphs near the end of the
24452 row, and also blanks and stretch glyphs inserted by
24453 extend_face_to_end_of_line. */
24457 && INTEGERP (end
->object
)
24458 && end
->charpos
<= 0)
24460 x
+= end
->pixel_width
;
24463 /* Scan the rest of the glyph row from the end, looking for the
24464 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24465 COVER_STRING, or whose position is between START_CHARPOS
24469 && !INTEGERP (end
->object
)
24470 && !EQ (end
->object
, cover_string
)
24471 && !(BUFFERP (end
->object
)
24472 && (end
->charpos
>= start_charpos
24473 && end
->charpos
< end_charpos
));
24476 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24477 are present at buffer positions between START_CHARPOS and
24478 END_CHARPOS, or if they come from an overlay. */
24479 if (EQ (end
->object
, before_string
))
24481 pos
= string_buffer_position (before_string
, start_charpos
);
24482 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24485 else if (EQ (end
->object
, after_string
))
24487 pos
= string_buffer_position (after_string
, end_charpos
);
24488 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24491 x
+= end
->pixel_width
;
24493 hlinfo
->mouse_face_end_x
= x
;
24494 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24497 hlinfo
->mouse_face_window
= window
;
24498 hlinfo
->mouse_face_face_id
24499 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24501 !hlinfo
->mouse_face_hidden
, -1);
24502 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24505 /* The following function is not used anymore (replaced with
24506 mouse_face_from_string_pos), but I leave it here for the time
24507 being, in case someone would. */
24509 #if 0 /* not used */
24511 /* Find the position of the glyph for position POS in OBJECT in
24512 window W's current matrix, and return in *X, *Y the pixel
24513 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24515 RIGHT_P non-zero means return the position of the right edge of the
24516 glyph, RIGHT_P zero means return the left edge position.
24518 If no glyph for POS exists in the matrix, return the position of
24519 the glyph with the next smaller position that is in the matrix, if
24520 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24521 exists in the matrix, return the position of the glyph with the
24522 next larger position in OBJECT.
24524 Value is non-zero if a glyph was found. */
24527 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24528 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24530 int yb
= window_text_bottom_y (w
);
24531 struct glyph_row
*r
;
24532 struct glyph
*best_glyph
= NULL
;
24533 struct glyph_row
*best_row
= NULL
;
24536 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24537 r
->enabled_p
&& r
->y
< yb
;
24540 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24541 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24544 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24545 if (EQ (g
->object
, object
))
24547 if (g
->charpos
== pos
)
24554 else if (best_glyph
== NULL
24555 || ((eabs (g
->charpos
- pos
)
24556 < eabs (best_glyph
->charpos
- pos
))
24559 : g
->charpos
> pos
)))
24573 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24577 *x
+= best_glyph
->pixel_width
;
24582 *vpos
= best_row
- w
->current_matrix
->rows
;
24585 return best_glyph
!= NULL
;
24587 #endif /* not used */
24589 /* Find the positions of the first and the last glyphs in window W's
24590 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24591 (assumed to be a string), and return in HLINFO's mouse_face_*
24592 members the pixel and column/row coordinates of those glyphs. */
24595 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24596 Lisp_Object object
,
24597 EMACS_INT startpos
, EMACS_INT endpos
)
24599 int yb
= window_text_bottom_y (w
);
24600 struct glyph_row
*r
;
24601 struct glyph
*g
, *e
;
24605 /* Find the glyph row with at least one position in the range
24606 [STARTPOS..ENDPOS], and the first glyph in that row whose
24607 position belongs to that range. */
24608 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24609 r
->enabled_p
&& r
->y
< yb
;
24612 if (!r
->reversed_p
)
24614 g
= r
->glyphs
[TEXT_AREA
];
24615 e
= g
+ r
->used
[TEXT_AREA
];
24616 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24617 if (EQ (g
->object
, object
)
24618 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24620 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24621 hlinfo
->mouse_face_beg_y
= r
->y
;
24622 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24623 hlinfo
->mouse_face_beg_x
= gx
;
24632 e
= r
->glyphs
[TEXT_AREA
];
24633 g
= e
+ r
->used
[TEXT_AREA
];
24634 for ( ; g
> e
; --g
)
24635 if (EQ ((g
-1)->object
, object
)
24636 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24638 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24639 hlinfo
->mouse_face_beg_y
= r
->y
;
24640 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24641 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24642 gx
+= g1
->pixel_width
;
24643 hlinfo
->mouse_face_beg_x
= gx
;
24655 /* Starting with the next row, look for the first row which does NOT
24656 include any glyphs whose positions are in the range. */
24657 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24659 g
= r
->glyphs
[TEXT_AREA
];
24660 e
= g
+ r
->used
[TEXT_AREA
];
24662 for ( ; g
< e
; ++g
)
24663 if (EQ (g
->object
, object
)
24664 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24673 /* The highlighted region ends on the previous row. */
24676 /* Set the end row and its vertical pixel coordinate. */
24677 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24678 hlinfo
->mouse_face_end_y
= r
->y
;
24680 /* Compute and set the end column and the end column's horizontal
24681 pixel coordinate. */
24682 if (!r
->reversed_p
)
24684 g
= r
->glyphs
[TEXT_AREA
];
24685 e
= g
+ r
->used
[TEXT_AREA
];
24686 for ( ; e
> g
; --e
)
24687 if (EQ ((e
-1)->object
, object
)
24688 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24690 hlinfo
->mouse_face_end_col
= e
- g
;
24692 for (gx
= r
->x
; g
< e
; ++g
)
24693 gx
+= g
->pixel_width
;
24694 hlinfo
->mouse_face_end_x
= gx
;
24698 e
= r
->glyphs
[TEXT_AREA
];
24699 g
= e
+ r
->used
[TEXT_AREA
];
24700 for (gx
= r
->x
; e
< g
; ++e
)
24702 if (EQ (e
->object
, object
)
24703 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24705 gx
+= e
->pixel_width
;
24707 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24708 hlinfo
->mouse_face_end_x
= gx
;
24712 #ifdef HAVE_WINDOW_SYSTEM
24714 /* See if position X, Y is within a hot-spot of an image. */
24717 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24719 if (!CONSP (hot_spot
))
24722 if (EQ (XCAR (hot_spot
), Qrect
))
24724 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24725 Lisp_Object rect
= XCDR (hot_spot
);
24729 if (!CONSP (XCAR (rect
)))
24731 if (!CONSP (XCDR (rect
)))
24733 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24735 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24737 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24739 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24743 else if (EQ (XCAR (hot_spot
), Qcircle
))
24745 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24746 Lisp_Object circ
= XCDR (hot_spot
);
24747 Lisp_Object lr
, lx0
, ly0
;
24749 && CONSP (XCAR (circ
))
24750 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24751 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24752 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24754 double r
= XFLOATINT (lr
);
24755 double dx
= XINT (lx0
) - x
;
24756 double dy
= XINT (ly0
) - y
;
24757 return (dx
* dx
+ dy
* dy
<= r
* r
);
24760 else if (EQ (XCAR (hot_spot
), Qpoly
))
24762 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24763 if (VECTORP (XCDR (hot_spot
)))
24765 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24766 Lisp_Object
*poly
= v
->contents
;
24770 Lisp_Object lx
, ly
;
24773 /* Need an even number of coordinates, and at least 3 edges. */
24774 if (n
< 6 || n
& 1)
24777 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24778 If count is odd, we are inside polygon. Pixels on edges
24779 may or may not be included depending on actual geometry of the
24781 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24782 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24784 x0
= XINT (lx
), y0
= XINT (ly
);
24785 for (i
= 0; i
< n
; i
+= 2)
24787 int x1
= x0
, y1
= y0
;
24788 if ((lx
= poly
[i
], !INTEGERP (lx
))
24789 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24791 x0
= XINT (lx
), y0
= XINT (ly
);
24793 /* Does this segment cross the X line? */
24801 if (y
> y0
&& y
> y1
)
24803 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24813 find_hot_spot (Lisp_Object map
, int x
, int y
)
24815 while (CONSP (map
))
24817 if (CONSP (XCAR (map
))
24818 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24826 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24828 doc
: /* Lookup in image map MAP coordinates X and Y.
24829 An image map is an alist where each element has the format (AREA ID PLIST).
24830 An AREA is specified as either a rectangle, a circle, or a polygon:
24831 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24832 pixel coordinates of the upper left and bottom right corners.
24833 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24834 and the radius of the circle; r may be a float or integer.
24835 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24836 vector describes one corner in the polygon.
24837 Returns the alist element for the first matching AREA in MAP. */)
24838 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24846 return find_hot_spot (map
, XINT (x
), XINT (y
));
24850 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24852 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24854 /* Do not change cursor shape while dragging mouse. */
24855 if (!NILP (do_mouse_tracking
))
24858 if (!NILP (pointer
))
24860 if (EQ (pointer
, Qarrow
))
24861 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24862 else if (EQ (pointer
, Qhand
))
24863 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24864 else if (EQ (pointer
, Qtext
))
24865 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24866 else if (EQ (pointer
, intern ("hdrag")))
24867 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24868 #ifdef HAVE_X_WINDOWS
24869 else if (EQ (pointer
, intern ("vdrag")))
24870 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24872 else if (EQ (pointer
, intern ("hourglass")))
24873 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24874 else if (EQ (pointer
, Qmodeline
))
24875 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24877 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24880 if (cursor
!= No_Cursor
)
24881 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24884 #endif /* HAVE_WINDOW_SYSTEM */
24886 /* Take proper action when mouse has moved to the mode or header line
24887 or marginal area AREA of window W, x-position X and y-position Y.
24888 X is relative to the start of the text display area of W, so the
24889 width of bitmap areas and scroll bars must be subtracted to get a
24890 position relative to the start of the mode line. */
24893 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24894 enum window_part area
)
24896 struct window
*w
= XWINDOW (window
);
24897 struct frame
*f
= XFRAME (w
->frame
);
24898 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24899 #ifdef HAVE_WINDOW_SYSTEM
24900 Display_Info
*dpyinfo
;
24902 Cursor cursor
= No_Cursor
;
24903 Lisp_Object pointer
= Qnil
;
24904 int dx
, dy
, width
, height
;
24906 Lisp_Object string
, object
= Qnil
;
24907 Lisp_Object pos
, help
;
24909 Lisp_Object mouse_face
;
24910 int original_x_pixel
= x
;
24911 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24912 struct glyph_row
*row
;
24914 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24919 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24920 returns them in row/column units! */
24921 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24922 &object
, &dx
, &dy
, &width
, &height
);
24924 row
= (area
== ON_MODE_LINE
24925 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24926 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24928 /* Find the glyph under the mouse pointer. */
24929 if (row
->mode_line_p
&& row
->enabled_p
)
24931 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24932 end
= glyph
+ row
->used
[TEXT_AREA
];
24934 for (x0
= original_x_pixel
;
24935 glyph
< end
&& x0
>= glyph
->pixel_width
;
24937 x0
-= glyph
->pixel_width
;
24945 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24946 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24947 returns them in row/column units! */
24948 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24949 &object
, &dx
, &dy
, &width
, &height
);
24954 #ifdef HAVE_WINDOW_SYSTEM
24955 if (IMAGEP (object
))
24957 Lisp_Object image_map
, hotspot
;
24958 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24960 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24962 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24966 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
24967 If so, we could look for mouse-enter, mouse-leave
24968 properties in PLIST (and do something...). */
24969 hotspot
= XCDR (hotspot
);
24970 if (CONSP (hotspot
)
24971 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24973 pointer
= Fplist_get (plist
, Qpointer
);
24974 if (NILP (pointer
))
24976 help
= Fplist_get (plist
, Qhelp_echo
);
24979 help_echo_string
= help
;
24980 /* Is this correct? ++kfs */
24981 XSETWINDOW (help_echo_window
, w
);
24982 help_echo_object
= w
->buffer
;
24983 help_echo_pos
= charpos
;
24987 if (NILP (pointer
))
24988 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24990 #endif /* HAVE_WINDOW_SYSTEM */
24992 if (STRINGP (string
))
24994 pos
= make_number (charpos
);
24995 /* If we're on a string with `help-echo' text property, arrange
24996 for the help to be displayed. This is done by setting the
24997 global variable help_echo_string to the help string. */
25000 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25003 help_echo_string
= help
;
25004 XSETWINDOW (help_echo_window
, w
);
25005 help_echo_object
= string
;
25006 help_echo_pos
= charpos
;
25010 #ifdef HAVE_WINDOW_SYSTEM
25011 if (FRAME_WINDOW_P (f
))
25013 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25014 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25015 if (NILP (pointer
))
25016 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25018 /* Change the mouse pointer according to what is under X/Y. */
25020 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25023 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25024 if (!KEYMAPP (map
))
25025 map
= Fget_text_property (pos
, Qkeymap
, string
);
25026 if (!KEYMAPP (map
))
25027 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25032 /* Change the mouse face according to what is under X/Y. */
25033 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25034 if (!NILP (mouse_face
)
25035 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25040 struct glyph
* tmp_glyph
;
25044 int total_pixel_width
;
25045 EMACS_INT begpos
, endpos
, ignore
;
25049 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25050 Qmouse_face
, string
, Qnil
);
25056 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25058 endpos
= SCHARS (string
);
25062 /* Calculate the glyph position GPOS of GLYPH in the
25063 displayed string, relative to the beginning of the
25064 highlighted part of the string.
25066 Note: GPOS is different from CHARPOS. CHARPOS is the
25067 position of GLYPH in the internal string object. A mode
25068 line string format has structures which are converted to
25069 a flattened string by the Emacs Lisp interpreter. The
25070 internal string is an element of those structures. The
25071 displayed string is the flattened string. */
25072 tmp_glyph
= row_start_glyph
;
25073 while (tmp_glyph
< glyph
25074 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25075 && begpos
<= tmp_glyph
->charpos
25076 && tmp_glyph
->charpos
< endpos
)))
25078 gpos
= glyph
- tmp_glyph
;
25080 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25081 the highlighted part of the displayed string to which
25082 GLYPH belongs. Note: GSEQ_LENGTH is different from
25083 SCHARS (STRING), because the latter returns the length of
25084 the internal string. */
25085 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25087 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25088 && begpos
<= tmp_glyph
->charpos
25089 && tmp_glyph
->charpos
< endpos
));
25092 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25094 /* Calculate the total pixel width of all the glyphs between
25095 the beginning of the highlighted area and GLYPH. */
25096 total_pixel_width
= 0;
25097 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25098 total_pixel_width
+= tmp_glyph
->pixel_width
;
25100 /* Pre calculation of re-rendering position. Note: X is in
25101 column units here, after the call to mode_line_string or
25102 marginal_area_string. */
25104 vpos
= (area
== ON_MODE_LINE
25105 ? (w
->current_matrix
)->nrows
- 1
25108 /* If GLYPH's position is included in the region that is
25109 already drawn in mouse face, we have nothing to do. */
25110 if ( EQ (window
, hlinfo
->mouse_face_window
)
25111 && (!row
->reversed_p
25112 ? (hlinfo
->mouse_face_beg_col
<= hpos
25113 && hpos
< hlinfo
->mouse_face_end_col
)
25114 /* In R2L rows we swap BEG and END, see below. */
25115 : (hlinfo
->mouse_face_end_col
<= hpos
25116 && hpos
< hlinfo
->mouse_face_beg_col
))
25117 && hlinfo
->mouse_face_beg_row
== vpos
)
25120 if (clear_mouse_face (hlinfo
))
25121 cursor
= No_Cursor
;
25123 if (!row
->reversed_p
)
25125 hlinfo
->mouse_face_beg_col
= hpos
;
25126 hlinfo
->mouse_face_beg_x
= original_x_pixel
25127 - (total_pixel_width
+ dx
);
25128 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25129 hlinfo
->mouse_face_end_x
= 0;
25133 /* In R2L rows, show_mouse_face expects BEG and END
25134 coordinates to be swapped. */
25135 hlinfo
->mouse_face_end_col
= hpos
;
25136 hlinfo
->mouse_face_end_x
= original_x_pixel
25137 - (total_pixel_width
+ dx
);
25138 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25139 hlinfo
->mouse_face_beg_x
= 0;
25142 hlinfo
->mouse_face_beg_row
= vpos
;
25143 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25144 hlinfo
->mouse_face_beg_y
= 0;
25145 hlinfo
->mouse_face_end_y
= 0;
25146 hlinfo
->mouse_face_past_end
= 0;
25147 hlinfo
->mouse_face_window
= window
;
25149 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25155 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25157 if (NILP (pointer
))
25160 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25161 clear_mouse_face (hlinfo
);
25163 #ifdef HAVE_WINDOW_SYSTEM
25164 if (FRAME_WINDOW_P (f
))
25165 define_frame_cursor1 (f
, cursor
, pointer
);
25171 Take proper action when the mouse has moved to position X, Y on
25172 frame F as regards highlighting characters that have mouse-face
25173 properties. Also de-highlighting chars where the mouse was before.
25174 X and Y can be negative or out of range. */
25177 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25179 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25180 enum window_part part
;
25181 Lisp_Object window
;
25183 Cursor cursor
= No_Cursor
;
25184 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25187 /* When a menu is active, don't highlight because this looks odd. */
25188 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25189 if (popup_activated ())
25193 if (NILP (Vmouse_highlight
)
25194 || !f
->glyphs_initialized_p
25195 || f
->pointer_invisible
)
25198 hlinfo
->mouse_face_mouse_x
= x
;
25199 hlinfo
->mouse_face_mouse_y
= y
;
25200 hlinfo
->mouse_face_mouse_frame
= f
;
25202 if (hlinfo
->mouse_face_defer
)
25205 if (gc_in_progress
)
25207 hlinfo
->mouse_face_deferred_gc
= 1;
25211 /* Which window is that in? */
25212 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25214 /* If we were displaying active text in another window, clear that.
25215 Also clear if we move out of text area in same window. */
25216 if (! EQ (window
, hlinfo
->mouse_face_window
)
25217 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25218 && !NILP (hlinfo
->mouse_face_window
)))
25219 clear_mouse_face (hlinfo
);
25221 /* Not on a window -> return. */
25222 if (!WINDOWP (window
))
25225 /* Reset help_echo_string. It will get recomputed below. */
25226 help_echo_string
= Qnil
;
25228 /* Convert to window-relative pixel coordinates. */
25229 w
= XWINDOW (window
);
25230 frame_to_window_pixel_xy (w
, &x
, &y
);
25232 #ifdef HAVE_WINDOW_SYSTEM
25233 /* Handle tool-bar window differently since it doesn't display a
25235 if (EQ (window
, f
->tool_bar_window
))
25237 note_tool_bar_highlight (f
, x
, y
);
25242 /* Mouse is on the mode, header line or margin? */
25243 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25244 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25246 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25250 #ifdef HAVE_WINDOW_SYSTEM
25251 if (part
== ON_VERTICAL_BORDER
)
25253 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25254 help_echo_string
= build_string ("drag-mouse-1: resize");
25256 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25257 || part
== ON_SCROLL_BAR
)
25258 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25260 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25263 /* Are we in a window whose display is up to date?
25264 And verify the buffer's text has not changed. */
25265 b
= XBUFFER (w
->buffer
);
25266 if (part
== ON_TEXT
25267 && EQ (w
->window_end_valid
, w
->buffer
)
25268 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25269 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25271 int hpos
, vpos
, i
, dx
, dy
, area
;
25273 struct glyph
*glyph
;
25274 Lisp_Object object
;
25275 Lisp_Object mouse_face
= Qnil
, position
;
25276 Lisp_Object
*overlay_vec
= NULL
;
25278 struct buffer
*obuf
;
25279 EMACS_INT obegv
, ozv
;
25282 /* Find the glyph under X/Y. */
25283 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25285 #ifdef HAVE_WINDOW_SYSTEM
25286 /* Look for :pointer property on image. */
25287 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25289 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25290 if (img
!= NULL
&& IMAGEP (img
->spec
))
25292 Lisp_Object image_map
, hotspot
;
25293 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25295 && (hotspot
= find_hot_spot (image_map
,
25296 glyph
->slice
.img
.x
+ dx
,
25297 glyph
->slice
.img
.y
+ dy
),
25299 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25303 /* Could check XCAR (hotspot) to see if we enter/leave
25305 If so, we could look for mouse-enter, mouse-leave
25306 properties in PLIST (and do something...). */
25307 hotspot
= XCDR (hotspot
);
25308 if (CONSP (hotspot
)
25309 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25311 pointer
= Fplist_get (plist
, Qpointer
);
25312 if (NILP (pointer
))
25314 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25315 if (!NILP (help_echo_string
))
25317 help_echo_window
= window
;
25318 help_echo_object
= glyph
->object
;
25319 help_echo_pos
= glyph
->charpos
;
25323 if (NILP (pointer
))
25324 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25327 #endif /* HAVE_WINDOW_SYSTEM */
25329 /* Clear mouse face if X/Y not over text. */
25331 || area
!= TEXT_AREA
25332 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25333 /* Glyph's OBJECT is an integer for glyphs inserted by the
25334 display engine for its internal purposes, like truncation
25335 and continuation glyphs and blanks beyond the end of
25336 line's text on text terminals. If we are over such a
25337 glyph, we are not over any text. */
25338 || INTEGERP (glyph
->object
)
25339 /* R2L rows have a stretch glyph at their front, which
25340 stands for no text, whereas L2R rows have no glyphs at
25341 all beyond the end of text. Treat such stretch glyphs
25342 like we do with NULL glyphs in L2R rows. */
25343 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25344 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25345 && glyph
->type
== STRETCH_GLYPH
25346 && glyph
->avoid_cursor_p
))
25348 if (clear_mouse_face (hlinfo
))
25349 cursor
= No_Cursor
;
25350 #ifdef HAVE_WINDOW_SYSTEM
25351 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25353 if (area
!= TEXT_AREA
)
25354 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25356 pointer
= Vvoid_text_area_pointer
;
25362 pos
= glyph
->charpos
;
25363 object
= glyph
->object
;
25364 if (!STRINGP (object
) && !BUFFERP (object
))
25367 /* If we get an out-of-range value, return now; avoid an error. */
25368 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25371 /* Make the window's buffer temporarily current for
25372 overlays_at and compute_char_face. */
25373 obuf
= current_buffer
;
25374 current_buffer
= b
;
25380 /* Is this char mouse-active or does it have help-echo? */
25381 position
= make_number (pos
);
25383 if (BUFFERP (object
))
25385 /* Put all the overlays we want in a vector in overlay_vec. */
25386 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25387 /* Sort overlays into increasing priority order. */
25388 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25393 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25396 cursor
= No_Cursor
;
25398 /* Check mouse-face highlighting. */
25400 /* If there exists an overlay with mouse-face overlapping
25401 the one we are currently highlighting, we have to
25402 check if we enter the overlapping overlay, and then
25403 highlight only that. */
25404 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25405 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25407 /* Find the highest priority overlay with a mouse-face. */
25408 Lisp_Object overlay
= Qnil
;
25409 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25411 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25412 if (!NILP (mouse_face
))
25413 overlay
= overlay_vec
[i
];
25416 /* If we're highlighting the same overlay as before, there's
25417 no need to do that again. */
25418 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25419 goto check_help_echo
;
25420 hlinfo
->mouse_face_overlay
= overlay
;
25422 /* Clear the display of the old active region, if any. */
25423 if (clear_mouse_face (hlinfo
))
25424 cursor
= No_Cursor
;
25426 /* If no overlay applies, get a text property. */
25427 if (NILP (overlay
))
25428 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25430 /* Next, compute the bounds of the mouse highlighting and
25432 if (!NILP (mouse_face
) && STRINGP (object
))
25434 /* The mouse-highlighting comes from a display string
25435 with a mouse-face. */
25439 s
= Fprevious_single_property_change
25440 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25441 e
= Fnext_single_property_change
25442 (position
, Qmouse_face
, object
, Qnil
);
25444 s
= make_number (0);
25446 e
= make_number (SCHARS (object
) - 1);
25447 mouse_face_from_string_pos (w
, hlinfo
, object
,
25448 XINT (s
), XINT (e
));
25449 hlinfo
->mouse_face_past_end
= 0;
25450 hlinfo
->mouse_face_window
= window
;
25451 hlinfo
->mouse_face_face_id
25452 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25453 glyph
->face_id
, 1);
25454 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25455 cursor
= No_Cursor
;
25459 /* The mouse-highlighting, if any, comes from an overlay
25460 or text property in the buffer. */
25461 Lisp_Object buffer
IF_LINT (= Qnil
);
25462 Lisp_Object cover_string
IF_LINT (= Qnil
);
25464 if (STRINGP (object
))
25466 /* If we are on a display string with no mouse-face,
25467 check if the text under it has one. */
25468 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25469 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25470 pos
= string_buffer_position (object
, start
);
25473 mouse_face
= get_char_property_and_overlay
25474 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25475 buffer
= w
->buffer
;
25476 cover_string
= object
;
25482 cover_string
= Qnil
;
25485 if (!NILP (mouse_face
))
25487 Lisp_Object before
, after
;
25488 Lisp_Object before_string
, after_string
;
25489 /* To correctly find the limits of mouse highlight
25490 in a bidi-reordered buffer, we must not use the
25491 optimization of limiting the search in
25492 previous-single-property-change and
25493 next-single-property-change, because
25494 rows_from_pos_range needs the real start and end
25495 positions to DTRT in this case. That's because
25496 the first row visible in a window does not
25497 necessarily display the character whose position
25498 is the smallest. */
25500 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25501 ? Fmarker_position (w
->start
)
25504 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25505 ? make_number (BUF_Z (XBUFFER (buffer
))
25506 - XFASTINT (w
->window_end_pos
))
25509 if (NILP (overlay
))
25511 /* Handle the text property case. */
25512 before
= Fprevious_single_property_change
25513 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25514 after
= Fnext_single_property_change
25515 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25516 before_string
= after_string
= Qnil
;
25520 /* Handle the overlay case. */
25521 before
= Foverlay_start (overlay
);
25522 after
= Foverlay_end (overlay
);
25523 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25524 after_string
= Foverlay_get (overlay
, Qafter_string
);
25526 if (!STRINGP (before_string
)) before_string
= Qnil
;
25527 if (!STRINGP (after_string
)) after_string
= Qnil
;
25530 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25533 before_string
, after_string
,
25535 cursor
= No_Cursor
;
25542 /* Look for a `help-echo' property. */
25543 if (NILP (help_echo_string
)) {
25544 Lisp_Object help
, overlay
;
25546 /* Check overlays first. */
25547 help
= overlay
= Qnil
;
25548 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25550 overlay
= overlay_vec
[i
];
25551 help
= Foverlay_get (overlay
, Qhelp_echo
);
25556 help_echo_string
= help
;
25557 help_echo_window
= window
;
25558 help_echo_object
= overlay
;
25559 help_echo_pos
= pos
;
25563 Lisp_Object obj
= glyph
->object
;
25564 EMACS_INT charpos
= glyph
->charpos
;
25566 /* Try text properties. */
25569 && charpos
< SCHARS (obj
))
25571 help
= Fget_text_property (make_number (charpos
),
25575 /* If the string itself doesn't specify a help-echo,
25576 see if the buffer text ``under'' it does. */
25577 struct glyph_row
*r
25578 = MATRIX_ROW (w
->current_matrix
, vpos
);
25579 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25580 EMACS_INT p
= string_buffer_position (obj
, start
);
25583 help
= Fget_char_property (make_number (p
),
25584 Qhelp_echo
, w
->buffer
);
25593 else if (BUFFERP (obj
)
25596 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25601 help_echo_string
= help
;
25602 help_echo_window
= window
;
25603 help_echo_object
= obj
;
25604 help_echo_pos
= charpos
;
25609 #ifdef HAVE_WINDOW_SYSTEM
25610 /* Look for a `pointer' property. */
25611 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25613 /* Check overlays first. */
25614 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25615 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25617 if (NILP (pointer
))
25619 Lisp_Object obj
= glyph
->object
;
25620 EMACS_INT charpos
= glyph
->charpos
;
25622 /* Try text properties. */
25625 && charpos
< SCHARS (obj
))
25627 pointer
= Fget_text_property (make_number (charpos
),
25629 if (NILP (pointer
))
25631 /* If the string itself doesn't specify a pointer,
25632 see if the buffer text ``under'' it does. */
25633 struct glyph_row
*r
25634 = MATRIX_ROW (w
->current_matrix
, vpos
);
25635 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25636 EMACS_INT p
= string_buffer_position (obj
, start
);
25638 pointer
= Fget_char_property (make_number (p
),
25639 Qpointer
, w
->buffer
);
25642 else if (BUFFERP (obj
)
25645 pointer
= Fget_text_property (make_number (charpos
),
25649 #endif /* HAVE_WINDOW_SYSTEM */
25653 current_buffer
= obuf
;
25658 #ifdef HAVE_WINDOW_SYSTEM
25659 if (FRAME_WINDOW_P (f
))
25660 define_frame_cursor1 (f
, cursor
, pointer
);
25662 /* This is here to prevent a compiler error, about "label at end of
25663 compound statement". */
25670 Clear any mouse-face on window W. This function is part of the
25671 redisplay interface, and is called from try_window_id and similar
25672 functions to ensure the mouse-highlight is off. */
25675 x_clear_window_mouse_face (struct window
*w
)
25677 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25678 Lisp_Object window
;
25681 XSETWINDOW (window
, w
);
25682 if (EQ (window
, hlinfo
->mouse_face_window
))
25683 clear_mouse_face (hlinfo
);
25689 Just discard the mouse face information for frame F, if any.
25690 This is used when the size of F is changed. */
25693 cancel_mouse_face (struct frame
*f
)
25695 Lisp_Object window
;
25696 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25698 window
= hlinfo
->mouse_face_window
;
25699 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25701 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25702 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25703 hlinfo
->mouse_face_window
= Qnil
;
25709 /***********************************************************************
25711 ***********************************************************************/
25713 #ifdef HAVE_WINDOW_SYSTEM
25715 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25716 which intersects rectangle R. R is in window-relative coordinates. */
25719 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25720 enum glyph_row_area area
)
25722 struct glyph
*first
= row
->glyphs
[area
];
25723 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25724 struct glyph
*last
;
25725 int first_x
, start_x
, x
;
25727 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25728 /* If row extends face to end of line write the whole line. */
25729 draw_glyphs (w
, 0, row
, area
,
25730 0, row
->used
[area
],
25731 DRAW_NORMAL_TEXT
, 0);
25734 /* Set START_X to the window-relative start position for drawing glyphs of
25735 AREA. The first glyph of the text area can be partially visible.
25736 The first glyphs of other areas cannot. */
25737 start_x
= window_box_left_offset (w
, area
);
25739 if (area
== TEXT_AREA
)
25742 /* Find the first glyph that must be redrawn. */
25744 && x
+ first
->pixel_width
< r
->x
)
25746 x
+= first
->pixel_width
;
25750 /* Find the last one. */
25754 && x
< r
->x
+ r
->width
)
25756 x
+= last
->pixel_width
;
25762 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25763 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25764 DRAW_NORMAL_TEXT
, 0);
25769 /* Redraw the parts of the glyph row ROW on window W intersecting
25770 rectangle R. R is in window-relative coordinates. Value is
25771 non-zero if mouse-face was overwritten. */
25774 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25776 xassert (row
->enabled_p
);
25778 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25779 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25780 0, row
->used
[TEXT_AREA
],
25781 DRAW_NORMAL_TEXT
, 0);
25784 if (row
->used
[LEFT_MARGIN_AREA
])
25785 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25786 if (row
->used
[TEXT_AREA
])
25787 expose_area (w
, row
, r
, TEXT_AREA
);
25788 if (row
->used
[RIGHT_MARGIN_AREA
])
25789 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25790 draw_row_fringe_bitmaps (w
, row
);
25793 return row
->mouse_face_p
;
25797 /* Redraw those parts of glyphs rows during expose event handling that
25798 overlap other rows. Redrawing of an exposed line writes over parts
25799 of lines overlapping that exposed line; this function fixes that.
25801 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25802 row in W's current matrix that is exposed and overlaps other rows.
25803 LAST_OVERLAPPING_ROW is the last such row. */
25806 expose_overlaps (struct window
*w
,
25807 struct glyph_row
*first_overlapping_row
,
25808 struct glyph_row
*last_overlapping_row
,
25811 struct glyph_row
*row
;
25813 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25814 if (row
->overlapping_p
)
25816 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25819 if (row
->used
[LEFT_MARGIN_AREA
])
25820 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25822 if (row
->used
[TEXT_AREA
])
25823 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25825 if (row
->used
[RIGHT_MARGIN_AREA
])
25826 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25832 /* Return non-zero if W's cursor intersects rectangle R. */
25835 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25837 XRectangle cr
, result
;
25838 struct glyph
*cursor_glyph
;
25839 struct glyph_row
*row
;
25841 if (w
->phys_cursor
.vpos
>= 0
25842 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25843 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25845 && row
->cursor_in_fringe_p
)
25847 /* Cursor is in the fringe. */
25848 cr
.x
= window_box_right_offset (w
,
25849 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25850 ? RIGHT_MARGIN_AREA
25853 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25854 cr
.height
= row
->height
;
25855 return x_intersect_rectangles (&cr
, r
, &result
);
25858 cursor_glyph
= get_phys_cursor_glyph (w
);
25861 /* r is relative to W's box, but w->phys_cursor.x is relative
25862 to left edge of W's TEXT area. Adjust it. */
25863 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25864 cr
.y
= w
->phys_cursor
.y
;
25865 cr
.width
= cursor_glyph
->pixel_width
;
25866 cr
.height
= w
->phys_cursor_height
;
25867 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25868 I assume the effect is the same -- and this is portable. */
25869 return x_intersect_rectangles (&cr
, r
, &result
);
25871 /* If we don't understand the format, pretend we're not in the hot-spot. */
25877 Draw a vertical window border to the right of window W if W doesn't
25878 have vertical scroll bars. */
25881 x_draw_vertical_border (struct window
*w
)
25883 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25885 /* We could do better, if we knew what type of scroll-bar the adjacent
25886 windows (on either side) have... But we don't :-(
25887 However, I think this works ok. ++KFS 2003-04-25 */
25889 /* Redraw borders between horizontally adjacent windows. Don't
25890 do it for frames with vertical scroll bars because either the
25891 right scroll bar of a window, or the left scroll bar of its
25892 neighbor will suffice as a border. */
25893 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25896 if (!WINDOW_RIGHTMOST_P (w
)
25897 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25899 int x0
, x1
, y0
, y1
;
25901 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25904 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25907 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25909 else if (!WINDOW_LEFTMOST_P (w
)
25910 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25912 int x0
, x1
, y0
, y1
;
25914 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25917 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25920 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25925 /* Redraw the part of window W intersection rectangle FR. Pixel
25926 coordinates in FR are frame-relative. Call this function with
25927 input blocked. Value is non-zero if the exposure overwrites
25931 expose_window (struct window
*w
, XRectangle
*fr
)
25933 struct frame
*f
= XFRAME (w
->frame
);
25935 int mouse_face_overwritten_p
= 0;
25937 /* If window is not yet fully initialized, do nothing. This can
25938 happen when toolkit scroll bars are used and a window is split.
25939 Reconfiguring the scroll bar will generate an expose for a newly
25941 if (w
->current_matrix
== NULL
)
25944 /* When we're currently updating the window, display and current
25945 matrix usually don't agree. Arrange for a thorough display
25947 if (w
== updated_window
)
25949 SET_FRAME_GARBAGED (f
);
25953 /* Frame-relative pixel rectangle of W. */
25954 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25955 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25956 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25957 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25959 if (x_intersect_rectangles (fr
, &wr
, &r
))
25961 int yb
= window_text_bottom_y (w
);
25962 struct glyph_row
*row
;
25963 int cursor_cleared_p
;
25964 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25966 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25967 r
.x
, r
.y
, r
.width
, r
.height
));
25969 /* Convert to window coordinates. */
25970 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25971 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25973 /* Turn off the cursor. */
25974 if (!w
->pseudo_window_p
25975 && phys_cursor_in_rect_p (w
, &r
))
25977 x_clear_cursor (w
);
25978 cursor_cleared_p
= 1;
25981 cursor_cleared_p
= 0;
25983 /* Update lines intersecting rectangle R. */
25984 first_overlapping_row
= last_overlapping_row
= NULL
;
25985 for (row
= w
->current_matrix
->rows
;
25990 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25992 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25993 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25994 || (r
.y
>= y0
&& r
.y
< y1
)
25995 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25997 /* A header line may be overlapping, but there is no need
25998 to fix overlapping areas for them. KFS 2005-02-12 */
25999 if (row
->overlapping_p
&& !row
->mode_line_p
)
26001 if (first_overlapping_row
== NULL
)
26002 first_overlapping_row
= row
;
26003 last_overlapping_row
= row
;
26007 if (expose_line (w
, row
, &r
))
26008 mouse_face_overwritten_p
= 1;
26011 else if (row
->overlapping_p
)
26013 /* We must redraw a row overlapping the exposed area. */
26015 ? y0
+ row
->phys_height
> r
.y
26016 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26018 if (first_overlapping_row
== NULL
)
26019 first_overlapping_row
= row
;
26020 last_overlapping_row
= row
;
26028 /* Display the mode line if there is one. */
26029 if (WINDOW_WANTS_MODELINE_P (w
)
26030 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26032 && row
->y
< r
.y
+ r
.height
)
26034 if (expose_line (w
, row
, &r
))
26035 mouse_face_overwritten_p
= 1;
26038 if (!w
->pseudo_window_p
)
26040 /* Fix the display of overlapping rows. */
26041 if (first_overlapping_row
)
26042 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26045 /* Draw border between windows. */
26046 x_draw_vertical_border (w
);
26048 /* Turn the cursor on again. */
26049 if (cursor_cleared_p
)
26050 update_window_cursor (w
, 1);
26054 return mouse_face_overwritten_p
;
26059 /* Redraw (parts) of all windows in the window tree rooted at W that
26060 intersect R. R contains frame pixel coordinates. Value is
26061 non-zero if the exposure overwrites mouse-face. */
26064 expose_window_tree (struct window
*w
, XRectangle
*r
)
26066 struct frame
*f
= XFRAME (w
->frame
);
26067 int mouse_face_overwritten_p
= 0;
26069 while (w
&& !FRAME_GARBAGED_P (f
))
26071 if (!NILP (w
->hchild
))
26072 mouse_face_overwritten_p
26073 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26074 else if (!NILP (w
->vchild
))
26075 mouse_face_overwritten_p
26076 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26078 mouse_face_overwritten_p
|= expose_window (w
, r
);
26080 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26083 return mouse_face_overwritten_p
;
26088 Redisplay an exposed area of frame F. X and Y are the upper-left
26089 corner of the exposed rectangle. W and H are width and height of
26090 the exposed area. All are pixel values. W or H zero means redraw
26091 the entire frame. */
26094 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26097 int mouse_face_overwritten_p
= 0;
26099 TRACE ((stderr
, "expose_frame "));
26101 /* No need to redraw if frame will be redrawn soon. */
26102 if (FRAME_GARBAGED_P (f
))
26104 TRACE ((stderr
, " garbaged\n"));
26108 /* If basic faces haven't been realized yet, there is no point in
26109 trying to redraw anything. This can happen when we get an expose
26110 event while Emacs is starting, e.g. by moving another window. */
26111 if (FRAME_FACE_CACHE (f
) == NULL
26112 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26114 TRACE ((stderr
, " no faces\n"));
26118 if (w
== 0 || h
== 0)
26121 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26122 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26132 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26133 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26135 if (WINDOWP (f
->tool_bar_window
))
26136 mouse_face_overwritten_p
26137 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26139 #ifdef HAVE_X_WINDOWS
26141 #ifndef USE_X_TOOLKIT
26142 if (WINDOWP (f
->menu_bar_window
))
26143 mouse_face_overwritten_p
26144 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26145 #endif /* not USE_X_TOOLKIT */
26149 /* Some window managers support a focus-follows-mouse style with
26150 delayed raising of frames. Imagine a partially obscured frame,
26151 and moving the mouse into partially obscured mouse-face on that
26152 frame. The visible part of the mouse-face will be highlighted,
26153 then the WM raises the obscured frame. With at least one WM, KDE
26154 2.1, Emacs is not getting any event for the raising of the frame
26155 (even tried with SubstructureRedirectMask), only Expose events.
26156 These expose events will draw text normally, i.e. not
26157 highlighted. Which means we must redo the highlight here.
26158 Subsume it under ``we love X''. --gerd 2001-08-15 */
26159 /* Included in Windows version because Windows most likely does not
26160 do the right thing if any third party tool offers
26161 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26162 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26164 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26165 if (f
== hlinfo
->mouse_face_mouse_frame
)
26167 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26168 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26169 clear_mouse_face (hlinfo
);
26170 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26177 Determine the intersection of two rectangles R1 and R2. Return
26178 the intersection in *RESULT. Value is non-zero if RESULT is not
26182 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26184 XRectangle
*left
, *right
;
26185 XRectangle
*upper
, *lower
;
26186 int intersection_p
= 0;
26188 /* Rearrange so that R1 is the left-most rectangle. */
26190 left
= r1
, right
= r2
;
26192 left
= r2
, right
= r1
;
26194 /* X0 of the intersection is right.x0, if this is inside R1,
26195 otherwise there is no intersection. */
26196 if (right
->x
<= left
->x
+ left
->width
)
26198 result
->x
= right
->x
;
26200 /* The right end of the intersection is the minimum of the
26201 the right ends of left and right. */
26202 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26205 /* Same game for Y. */
26207 upper
= r1
, lower
= r2
;
26209 upper
= r2
, lower
= r1
;
26211 /* The upper end of the intersection is lower.y0, if this is inside
26212 of upper. Otherwise, there is no intersection. */
26213 if (lower
->y
<= upper
->y
+ upper
->height
)
26215 result
->y
= lower
->y
;
26217 /* The lower end of the intersection is the minimum of the lower
26218 ends of upper and lower. */
26219 result
->height
= (min (lower
->y
+ lower
->height
,
26220 upper
->y
+ upper
->height
)
26222 intersection_p
= 1;
26226 return intersection_p
;
26229 #endif /* HAVE_WINDOW_SYSTEM */
26232 /***********************************************************************
26234 ***********************************************************************/
26237 syms_of_xdisp (void)
26239 Vwith_echo_area_save_vector
= Qnil
;
26240 staticpro (&Vwith_echo_area_save_vector
);
26242 Vmessage_stack
= Qnil
;
26243 staticpro (&Vmessage_stack
);
26245 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26246 staticpro (&Qinhibit_redisplay
);
26248 message_dolog_marker1
= Fmake_marker ();
26249 staticpro (&message_dolog_marker1
);
26250 message_dolog_marker2
= Fmake_marker ();
26251 staticpro (&message_dolog_marker2
);
26252 message_dolog_marker3
= Fmake_marker ();
26253 staticpro (&message_dolog_marker3
);
26256 defsubr (&Sdump_frame_glyph_matrix
);
26257 defsubr (&Sdump_glyph_matrix
);
26258 defsubr (&Sdump_glyph_row
);
26259 defsubr (&Sdump_tool_bar_row
);
26260 defsubr (&Strace_redisplay
);
26261 defsubr (&Strace_to_stderr
);
26263 #ifdef HAVE_WINDOW_SYSTEM
26264 defsubr (&Stool_bar_lines_needed
);
26265 defsubr (&Slookup_image_map
);
26267 defsubr (&Sformat_mode_line
);
26268 defsubr (&Sinvisible_p
);
26269 defsubr (&Scurrent_bidi_paragraph_direction
);
26271 staticpro (&Qmenu_bar_update_hook
);
26272 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26274 staticpro (&Qoverriding_terminal_local_map
);
26275 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26277 staticpro (&Qoverriding_local_map
);
26278 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26280 staticpro (&Qwindow_scroll_functions
);
26281 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26283 staticpro (&Qwindow_text_change_functions
);
26284 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26286 staticpro (&Qredisplay_end_trigger_functions
);
26287 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26289 staticpro (&Qinhibit_point_motion_hooks
);
26290 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26292 Qeval
= intern_c_string ("eval");
26293 staticpro (&Qeval
);
26295 QCdata
= intern_c_string (":data");
26296 staticpro (&QCdata
);
26297 Qdisplay
= intern_c_string ("display");
26298 staticpro (&Qdisplay
);
26299 Qspace_width
= intern_c_string ("space-width");
26300 staticpro (&Qspace_width
);
26301 Qraise
= intern_c_string ("raise");
26302 staticpro (&Qraise
);
26303 Qslice
= intern_c_string ("slice");
26304 staticpro (&Qslice
);
26305 Qspace
= intern_c_string ("space");
26306 staticpro (&Qspace
);
26307 Qmargin
= intern_c_string ("margin");
26308 staticpro (&Qmargin
);
26309 Qpointer
= intern_c_string ("pointer");
26310 staticpro (&Qpointer
);
26311 Qleft_margin
= intern_c_string ("left-margin");
26312 staticpro (&Qleft_margin
);
26313 Qright_margin
= intern_c_string ("right-margin");
26314 staticpro (&Qright_margin
);
26315 Qcenter
= intern_c_string ("center");
26316 staticpro (&Qcenter
);
26317 Qline_height
= intern_c_string ("line-height");
26318 staticpro (&Qline_height
);
26319 QCalign_to
= intern_c_string (":align-to");
26320 staticpro (&QCalign_to
);
26321 QCrelative_width
= intern_c_string (":relative-width");
26322 staticpro (&QCrelative_width
);
26323 QCrelative_height
= intern_c_string (":relative-height");
26324 staticpro (&QCrelative_height
);
26325 QCeval
= intern_c_string (":eval");
26326 staticpro (&QCeval
);
26327 QCpropertize
= intern_c_string (":propertize");
26328 staticpro (&QCpropertize
);
26329 QCfile
= intern_c_string (":file");
26330 staticpro (&QCfile
);
26331 Qfontified
= intern_c_string ("fontified");
26332 staticpro (&Qfontified
);
26333 Qfontification_functions
= intern_c_string ("fontification-functions");
26334 staticpro (&Qfontification_functions
);
26335 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26336 staticpro (&Qtrailing_whitespace
);
26337 Qescape_glyph
= intern_c_string ("escape-glyph");
26338 staticpro (&Qescape_glyph
);
26339 Qnobreak_space
= intern_c_string ("nobreak-space");
26340 staticpro (&Qnobreak_space
);
26341 Qimage
= intern_c_string ("image");
26342 staticpro (&Qimage
);
26343 Qtext
= intern_c_string ("text");
26344 staticpro (&Qtext
);
26345 Qboth
= intern_c_string ("both");
26346 staticpro (&Qboth
);
26347 Qboth_horiz
= intern_c_string ("both-horiz");
26348 staticpro (&Qboth_horiz
);
26349 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26350 staticpro (&Qtext_image_horiz
);
26351 QCmap
= intern_c_string (":map");
26352 staticpro (&QCmap
);
26353 QCpointer
= intern_c_string (":pointer");
26354 staticpro (&QCpointer
);
26355 Qrect
= intern_c_string ("rect");
26356 staticpro (&Qrect
);
26357 Qcircle
= intern_c_string ("circle");
26358 staticpro (&Qcircle
);
26359 Qpoly
= intern_c_string ("poly");
26360 staticpro (&Qpoly
);
26361 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26362 staticpro (&Qmessage_truncate_lines
);
26363 Qgrow_only
= intern_c_string ("grow-only");
26364 staticpro (&Qgrow_only
);
26365 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26366 staticpro (&Qinhibit_menubar_update
);
26367 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26368 staticpro (&Qinhibit_eval_during_redisplay
);
26369 Qposition
= intern_c_string ("position");
26370 staticpro (&Qposition
);
26371 Qbuffer_position
= intern_c_string ("buffer-position");
26372 staticpro (&Qbuffer_position
);
26373 Qobject
= intern_c_string ("object");
26374 staticpro (&Qobject
);
26375 Qbar
= intern_c_string ("bar");
26377 Qhbar
= intern_c_string ("hbar");
26378 staticpro (&Qhbar
);
26379 Qbox
= intern_c_string ("box");
26381 Qhollow
= intern_c_string ("hollow");
26382 staticpro (&Qhollow
);
26383 Qhand
= intern_c_string ("hand");
26384 staticpro (&Qhand
);
26385 Qarrow
= intern_c_string ("arrow");
26386 staticpro (&Qarrow
);
26387 Qtext
= intern_c_string ("text");
26388 staticpro (&Qtext
);
26389 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26390 staticpro (&Qinhibit_free_realized_faces
);
26392 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26393 Fcons (intern_c_string ("void-variable"), Qnil
)),
26395 staticpro (&list_of_error
);
26397 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26398 staticpro (&Qlast_arrow_position
);
26399 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26400 staticpro (&Qlast_arrow_string
);
26402 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26403 staticpro (&Qoverlay_arrow_string
);
26404 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26405 staticpro (&Qoverlay_arrow_bitmap
);
26407 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26408 staticpro (&echo_buffer
[0]);
26409 staticpro (&echo_buffer
[1]);
26411 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26412 staticpro (&echo_area_buffer
[0]);
26413 staticpro (&echo_area_buffer
[1]);
26415 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26416 staticpro (&Vmessages_buffer_name
);
26418 mode_line_proptrans_alist
= Qnil
;
26419 staticpro (&mode_line_proptrans_alist
);
26420 mode_line_string_list
= Qnil
;
26421 staticpro (&mode_line_string_list
);
26422 mode_line_string_face
= Qnil
;
26423 staticpro (&mode_line_string_face
);
26424 mode_line_string_face_prop
= Qnil
;
26425 staticpro (&mode_line_string_face_prop
);
26426 Vmode_line_unwind_vector
= Qnil
;
26427 staticpro (&Vmode_line_unwind_vector
);
26429 help_echo_string
= Qnil
;
26430 staticpro (&help_echo_string
);
26431 help_echo_object
= Qnil
;
26432 staticpro (&help_echo_object
);
26433 help_echo_window
= Qnil
;
26434 staticpro (&help_echo_window
);
26435 previous_help_echo_string
= Qnil
;
26436 staticpro (&previous_help_echo_string
);
26437 help_echo_pos
= -1;
26439 Qright_to_left
= intern_c_string ("right-to-left");
26440 staticpro (&Qright_to_left
);
26441 Qleft_to_right
= intern_c_string ("left-to-right");
26442 staticpro (&Qleft_to_right
);
26444 #ifdef HAVE_WINDOW_SYSTEM
26445 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26446 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26447 For example, if a block cursor is over a tab, it will be drawn as
26448 wide as that tab on the display. */);
26449 x_stretch_cursor_p
= 0;
26452 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26453 doc
: /* *Non-nil means highlight trailing whitespace.
26454 The face used for trailing whitespace is `trailing-whitespace'. */);
26455 Vshow_trailing_whitespace
= Qnil
;
26457 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26458 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26459 A value of t means highlight the character itself (for nobreak space,
26460 use face `nobreak-space').
26461 A value of nil means no highlighting.
26462 Other values mean display the escape glyph followed by an ordinary
26463 space or ordinary hyphen. */);
26464 Vnobreak_char_display
= Qt
;
26466 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26467 doc
: /* *The pointer shape to show in void text areas.
26468 A value of nil means to show the text pointer. Other options are `arrow',
26469 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26470 Vvoid_text_area_pointer
= Qarrow
;
26472 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26473 doc
: /* Non-nil means don't actually do any redisplay.
26474 This is used for internal purposes. */);
26475 Vinhibit_redisplay
= Qnil
;
26477 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26478 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26479 Vglobal_mode_string
= Qnil
;
26481 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26482 doc
: /* Marker for where to display an arrow on top of the buffer text.
26483 This must be the beginning of a line in order to work.
26484 See also `overlay-arrow-string'. */);
26485 Voverlay_arrow_position
= Qnil
;
26487 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26488 doc
: /* String to display as an arrow in non-window frames.
26489 See also `overlay-arrow-position'. */);
26490 Voverlay_arrow_string
= make_pure_c_string ("=>");
26492 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26493 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26494 The symbols on this list are examined during redisplay to determine
26495 where to display overlay arrows. */);
26496 Voverlay_arrow_variable_list
26497 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26499 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26500 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26501 If that fails to bring point back on frame, point is centered instead.
26502 If this is zero, point is always centered after it moves off frame.
26503 If you want scrolling to always be a line at a time, you should set
26504 `scroll-conservatively' to a large value rather than set this to 1. */);
26506 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26507 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26508 If point moves off-screen, redisplay will scroll by up to
26509 `scroll-conservatively' lines in order to bring point just barely
26510 onto the screen again. If that cannot be done, then redisplay
26511 recenters point as usual.
26513 A value of zero means always recenter point if it moves off screen. */);
26514 scroll_conservatively
= 0;
26516 DEFVAR_INT ("scroll-margin", scroll_margin
,
26517 doc
: /* *Number of lines of margin at the top and bottom of a window.
26518 Recenter the window whenever point gets within this many lines
26519 of the top or bottom of the window. */);
26522 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26523 doc
: /* Pixels per inch value for non-window system displays.
26524 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26525 Vdisplay_pixels_per_inch
= make_float (72.0);
26528 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26531 DEFVAR_LISP ("truncate-partial-width-windows",
26532 Vtruncate_partial_width_windows
,
26533 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26534 For an integer value, truncate lines in each window narrower than the
26535 full frame width, provided the window width is less than that integer;
26536 otherwise, respect the value of `truncate-lines'.
26538 For any other non-nil value, truncate lines in all windows that do
26539 not span the full frame width.
26541 A value of nil means to respect the value of `truncate-lines'.
26543 If `word-wrap' is enabled, you might want to reduce this. */);
26544 Vtruncate_partial_width_windows
= make_number (50);
26546 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26547 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26548 Any other value means to use the appropriate face, `mode-line',
26549 `header-line', or `menu' respectively. */);
26550 mode_line_inverse_video
= 1;
26552 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26553 doc
: /* *Maximum buffer size for which line number should be displayed.
26554 If the buffer is bigger than this, the line number does not appear
26555 in the mode line. A value of nil means no limit. */);
26556 Vline_number_display_limit
= Qnil
;
26558 DEFVAR_INT ("line-number-display-limit-width",
26559 line_number_display_limit_width
,
26560 doc
: /* *Maximum line width (in characters) for line number display.
26561 If the average length of the lines near point is bigger than this, then the
26562 line number may be omitted from the mode line. */);
26563 line_number_display_limit_width
= 200;
26565 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26566 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26567 highlight_nonselected_windows
= 0;
26569 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26570 doc
: /* Non-nil if more than one frame is visible on this display.
26571 Minibuffer-only frames don't count, but iconified frames do.
26572 This variable is not guaranteed to be accurate except while processing
26573 `frame-title-format' and `icon-title-format'. */);
26575 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26576 doc
: /* Template for displaying the title bar of visible frames.
26577 \(Assuming the window manager supports this feature.)
26579 This variable has the same structure as `mode-line-format', except that
26580 the %c and %l constructs are ignored. It is used only on frames for
26581 which no explicit name has been set \(see `modify-frame-parameters'). */);
26583 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26584 doc
: /* Template for displaying the title bar of an iconified frame.
26585 \(Assuming the window manager supports this feature.)
26586 This variable has the same structure as `mode-line-format' (which see),
26587 and is used only on frames for which no explicit name has been set
26588 \(see `modify-frame-parameters'). */);
26590 = Vframe_title_format
26591 = pure_cons (intern_c_string ("multiple-frames"),
26592 pure_cons (make_pure_c_string ("%b"),
26593 pure_cons (pure_cons (empty_unibyte_string
,
26594 pure_cons (intern_c_string ("invocation-name"),
26595 pure_cons (make_pure_c_string ("@"),
26596 pure_cons (intern_c_string ("system-name"),
26600 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26601 doc
: /* Maximum number of lines to keep in the message log buffer.
26602 If nil, disable message logging. If t, log messages but don't truncate
26603 the buffer when it becomes large. */);
26604 Vmessage_log_max
= make_number (100);
26606 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26607 doc
: /* Functions called before redisplay, if window sizes have changed.
26608 The value should be a list of functions that take one argument.
26609 Just before redisplay, for each frame, if any of its windows have changed
26610 size since the last redisplay, or have been split or deleted,
26611 all the functions in the list are called, with the frame as argument. */);
26612 Vwindow_size_change_functions
= Qnil
;
26614 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26615 doc
: /* List of functions to call before redisplaying a window with scrolling.
26616 Each function is called with two arguments, the window and its new
26617 display-start position. Note that these functions are also called by
26618 `set-window-buffer'. Also note that the value of `window-end' is not
26619 valid when these functions are called. */);
26620 Vwindow_scroll_functions
= Qnil
;
26622 DEFVAR_LISP ("window-text-change-functions",
26623 Vwindow_text_change_functions
,
26624 doc
: /* Functions to call in redisplay when text in the window might change. */);
26625 Vwindow_text_change_functions
= Qnil
;
26627 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26628 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26629 Each function is called with two arguments, the window and the end trigger value.
26630 See `set-window-redisplay-end-trigger'. */);
26631 Vredisplay_end_trigger_functions
= Qnil
;
26633 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26634 doc
: /* *Non-nil means autoselect window with mouse pointer.
26635 If nil, do not autoselect windows.
26636 A positive number means delay autoselection by that many seconds: a
26637 window is autoselected only after the mouse has remained in that
26638 window for the duration of the delay.
26639 A negative number has a similar effect, but causes windows to be
26640 autoselected only after the mouse has stopped moving. \(Because of
26641 the way Emacs compares mouse events, you will occasionally wait twice
26642 that time before the window gets selected.\)
26643 Any other value means to autoselect window instantaneously when the
26644 mouse pointer enters it.
26646 Autoselection selects the minibuffer only if it is active, and never
26647 unselects the minibuffer if it is active.
26649 When customizing this variable make sure that the actual value of
26650 `focus-follows-mouse' matches the behavior of your window manager. */);
26651 Vmouse_autoselect_window
= Qnil
;
26653 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26654 doc
: /* *Non-nil means automatically resize tool-bars.
26655 This dynamically changes the tool-bar's height to the minimum height
26656 that is needed to make all tool-bar items visible.
26657 If value is `grow-only', the tool-bar's height is only increased
26658 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26659 Vauto_resize_tool_bars
= Qt
;
26661 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26662 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26663 auto_raise_tool_bar_buttons_p
= 1;
26665 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26666 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26667 make_cursor_line_fully_visible_p
= 1;
26669 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26670 doc
: /* *Border below tool-bar in pixels.
26671 If an integer, use it as the height of the border.
26672 If it is one of `internal-border-width' or `border-width', use the
26673 value of the corresponding frame parameter.
26674 Otherwise, no border is added below the tool-bar. */);
26675 Vtool_bar_border
= Qinternal_border_width
;
26677 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26678 doc
: /* *Margin around tool-bar buttons in pixels.
26679 If an integer, use that for both horizontal and vertical margins.
26680 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26681 HORZ specifying the horizontal margin, and VERT specifying the
26682 vertical margin. */);
26683 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26685 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26686 doc
: /* *Relief thickness of tool-bar buttons. */);
26687 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26689 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26690 doc
: /* Tool bar style to use.
26692 image - show images only
26693 text - show text only
26694 both - show both, text below image
26695 both-horiz - show text to the right of the image
26696 text-image-horiz - show text to the left of the image
26697 any other - use system default or image if no system default. */);
26698 Vtool_bar_style
= Qnil
;
26700 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26701 doc
: /* *Maximum number of characters a label can have to be shown.
26702 The tool bar style must also show labels for this to have any effect, see
26703 `tool-bar-style'. */);
26704 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26706 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26707 doc
: /* List of functions to call to fontify regions of text.
26708 Each function is called with one argument POS. Functions must
26709 fontify a region starting at POS in the current buffer, and give
26710 fontified regions the property `fontified'. */);
26711 Vfontification_functions
= Qnil
;
26712 Fmake_variable_buffer_local (Qfontification_functions
);
26714 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26715 unibyte_display_via_language_environment
,
26716 doc
: /* *Non-nil means display unibyte text according to language environment.
26717 Specifically, this means that raw bytes in the range 160-255 decimal
26718 are displayed by converting them to the equivalent multibyte characters
26719 according to the current language environment. As a result, they are
26720 displayed according to the current fontset.
26722 Note that this variable affects only how these bytes are displayed,
26723 but does not change the fact they are interpreted as raw bytes. */);
26724 unibyte_display_via_language_environment
= 0;
26726 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26727 doc
: /* *Maximum height for resizing mini-windows.
26728 If a float, it specifies a fraction of the mini-window frame's height.
26729 If an integer, it specifies a number of lines. */);
26730 Vmax_mini_window_height
= make_float (0.25);
26732 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26733 doc
: /* *How to resize mini-windows.
26734 A value of nil means don't automatically resize mini-windows.
26735 A value of t means resize them to fit the text displayed in them.
26736 A value of `grow-only', the default, means let mini-windows grow
26737 only, until their display becomes empty, at which point the windows
26738 go back to their normal size. */);
26739 Vresize_mini_windows
= Qgrow_only
;
26741 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26742 doc
: /* Alist specifying how to blink the cursor off.
26743 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26744 `cursor-type' frame-parameter or variable equals ON-STATE,
26745 comparing using `equal', Emacs uses OFF-STATE to specify
26746 how to blink it off. ON-STATE and OFF-STATE are values for
26747 the `cursor-type' frame parameter.
26749 If a frame's ON-STATE has no entry in this list,
26750 the frame's other specifications determine how to blink the cursor off. */);
26751 Vblink_cursor_alist
= Qnil
;
26753 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26754 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26755 If non-nil, windows are automatically scrolled horizontally to make
26756 point visible. */);
26757 automatic_hscrolling_p
= 1;
26758 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26759 staticpro (&Qauto_hscroll_mode
);
26761 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26762 doc
: /* *How many columns away from the window edge point is allowed to get
26763 before automatic hscrolling will horizontally scroll the window. */);
26764 hscroll_margin
= 5;
26766 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26767 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26768 When point is less than `hscroll-margin' columns from the window
26769 edge, automatic hscrolling will scroll the window by the amount of columns
26770 determined by this variable. If its value is a positive integer, scroll that
26771 many columns. If it's a positive floating-point number, it specifies the
26772 fraction of the window's width to scroll. If it's nil or zero, point will be
26773 centered horizontally after the scroll. Any other value, including negative
26774 numbers, are treated as if the value were zero.
26776 Automatic hscrolling always moves point outside the scroll margin, so if
26777 point was more than scroll step columns inside the margin, the window will
26778 scroll more than the value given by the scroll step.
26780 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26781 and `scroll-right' overrides this variable's effect. */);
26782 Vhscroll_step
= make_number (0);
26784 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26785 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26786 Bind this around calls to `message' to let it take effect. */);
26787 message_truncate_lines
= 0;
26789 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26790 doc
: /* Normal hook run to update the menu bar definitions.
26791 Redisplay runs this hook before it redisplays the menu bar.
26792 This is used to update submenus such as Buffers,
26793 whose contents depend on various data. */);
26794 Vmenu_bar_update_hook
= Qnil
;
26796 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26797 doc
: /* Frame for which we are updating a menu.
26798 The enable predicate for a menu binding should check this variable. */);
26799 Vmenu_updating_frame
= Qnil
;
26801 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26802 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26803 inhibit_menubar_update
= 0;
26805 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26806 doc
: /* Prefix prepended to all continuation lines at display time.
26807 The value may be a string, an image, or a stretch-glyph; it is
26808 interpreted in the same way as the value of a `display' text property.
26810 This variable is overridden by any `wrap-prefix' text or overlay
26813 To add a prefix to non-continuation lines, use `line-prefix'. */);
26814 Vwrap_prefix
= Qnil
;
26815 staticpro (&Qwrap_prefix
);
26816 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26817 Fmake_variable_buffer_local (Qwrap_prefix
);
26819 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26820 doc
: /* Prefix prepended to all non-continuation lines at display time.
26821 The value may be a string, an image, or a stretch-glyph; it is
26822 interpreted in the same way as the value of a `display' text property.
26824 This variable is overridden by any `line-prefix' text or overlay
26827 To add a prefix to continuation lines, use `wrap-prefix'. */);
26828 Vline_prefix
= Qnil
;
26829 staticpro (&Qline_prefix
);
26830 Qline_prefix
= intern_c_string ("line-prefix");
26831 Fmake_variable_buffer_local (Qline_prefix
);
26833 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26834 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26835 inhibit_eval_during_redisplay
= 0;
26837 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26838 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26839 inhibit_free_realized_faces
= 0;
26842 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26843 doc
: /* Inhibit try_window_id display optimization. */);
26844 inhibit_try_window_id
= 0;
26846 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26847 doc
: /* Inhibit try_window_reusing display optimization. */);
26848 inhibit_try_window_reusing
= 0;
26850 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26851 doc
: /* Inhibit try_cursor_movement display optimization. */);
26852 inhibit_try_cursor_movement
= 0;
26853 #endif /* GLYPH_DEBUG */
26855 DEFVAR_INT ("overline-margin", overline_margin
,
26856 doc
: /* *Space between overline and text, in pixels.
26857 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26858 margin to the caracter height. */);
26859 overline_margin
= 2;
26861 DEFVAR_INT ("underline-minimum-offset",
26862 underline_minimum_offset
,
26863 doc
: /* Minimum distance between baseline and underline.
26864 This can improve legibility of underlined text at small font sizes,
26865 particularly when using variable `x-use-underline-position-properties'
26866 with fonts that specify an UNDERLINE_POSITION relatively close to the
26867 baseline. The default value is 1. */);
26868 underline_minimum_offset
= 1;
26870 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26871 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26872 This feature only works when on a window system that can change
26873 cursor shapes. */);
26874 display_hourglass_p
= 1;
26876 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26877 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26878 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26880 hourglass_atimer
= NULL
;
26881 hourglass_shown_p
= 0;
26883 DEFSYM (Qglyphless_char
, "glyphless-char");
26884 DEFSYM (Qhex_code
, "hex-code");
26885 DEFSYM (Qempty_box
, "empty-box");
26886 DEFSYM (Qthin_space
, "thin-space");
26887 DEFSYM (Qzero_width
, "zero-width");
26889 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26890 /* Intern this now in case it isn't already done.
26891 Setting this variable twice is harmless.
26892 But don't staticpro it here--that is done in alloc.c. */
26893 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26894 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26896 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26897 doc
: /* Char-table to control displaying of glyphless characters.
26898 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26899 or one of these symbols:
26900 hex-code: display the hexadecimal code of a character in a box
26901 empty-box: display as an empty box
26902 thin-space: display as 1-pixel width space
26903 zero-width: don't display
26905 It has one extra slot to control the display of a character for which
26906 no font is found. The value of the slot is `hex-code' or `empty-box'.
26907 The default is `empty-box'. */);
26908 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26909 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26914 /* Initialize this module when Emacs starts. */
26919 Lisp_Object root_window
;
26920 struct window
*mini_w
;
26922 current_header_line_height
= current_mode_line_height
= -1;
26924 CHARPOS (this_line_start_pos
) = 0;
26926 mini_w
= XWINDOW (minibuf_window
);
26927 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26929 if (!noninteractive
)
26931 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26934 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26935 set_window_height (root_window
,
26936 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26938 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26939 set_window_height (minibuf_window
, 1, 0);
26941 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26942 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26944 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26945 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26946 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26948 /* The default ellipsis glyphs `...'. */
26949 for (i
= 0; i
< 3; ++i
)
26950 default_invis_vector
[i
] = make_number ('.');
26954 /* Allocate the buffer for frame titles.
26955 Also used for `format-mode-line'. */
26957 mode_line_noprop_buf
= (char *) xmalloc (size
);
26958 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26959 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26960 mode_line_target
= MODE_LINE_DISPLAY
;
26963 help_echo_showing_p
= 0;
26966 /* Since w32 does not support atimers, it defines its own implementation of
26967 the following three functions in w32fns.c. */
26970 /* Platform-independent portion of hourglass implementation. */
26972 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26974 hourglass_started (void)
26976 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26979 /* Cancel a currently active hourglass timer, and start a new one. */
26981 start_hourglass (void)
26983 #if defined (HAVE_WINDOW_SYSTEM)
26985 int secs
, usecs
= 0;
26987 cancel_hourglass ();
26989 if (INTEGERP (Vhourglass_delay
)
26990 && XINT (Vhourglass_delay
) > 0)
26991 secs
= XFASTINT (Vhourglass_delay
);
26992 else if (FLOATP (Vhourglass_delay
)
26993 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26996 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26997 secs
= XFASTINT (tem
);
26998 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27001 secs
= DEFAULT_HOURGLASS_DELAY
;
27003 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27004 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27005 show_hourglass
, NULL
);
27010 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27013 cancel_hourglass (void)
27015 #if defined (HAVE_WINDOW_SYSTEM)
27016 if (hourglass_atimer
)
27018 cancel_atimer (hourglass_atimer
);
27019 hourglass_atimer
= NULL
;
27022 if (hourglass_shown_p
)
27026 #endif /* ! WINDOWSNT */