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 window
*, 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 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, int,
828 static void display_menu_bar (struct window
*);
829 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
831 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
832 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
833 static void compute_line_metrics (struct it
*);
834 static void run_redisplay_end_trigger_hook (struct it
*);
835 static int get_overlay_strings (struct it
*, EMACS_INT
);
836 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
837 static void next_overlay_string (struct it
*);
838 static void reseat (struct it
*, struct text_pos
, int);
839 static void reseat_1 (struct it
*, struct text_pos
, int);
840 static void back_to_previous_visible_line_start (struct it
*);
841 void reseat_at_previous_visible_line_start (struct it
*);
842 static void reseat_at_next_visible_line_start (struct it
*, int);
843 static int next_element_from_ellipsis (struct it
*);
844 static int next_element_from_display_vector (struct it
*);
845 static int next_element_from_string (struct it
*);
846 static int next_element_from_c_string (struct it
*);
847 static int next_element_from_buffer (struct it
*);
848 static int next_element_from_composition (struct it
*);
849 static int next_element_from_image (struct it
*);
850 static int next_element_from_stretch (struct it
*);
851 static void load_overlay_strings (struct it
*, EMACS_INT
);
852 static int init_from_display_pos (struct it
*, struct window
*,
853 struct display_pos
*);
854 static void reseat_to_string (struct it
*, const char *,
855 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
856 static enum move_it_result
857 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
858 enum move_operation_enum
);
859 void move_it_vertically_backward (struct it
*, int);
860 static void init_to_row_start (struct it
*, struct window
*,
862 static int init_to_row_end (struct it
*, struct window
*,
864 static void back_to_previous_line_start (struct it
*);
865 static int forward_to_next_line_start (struct it
*, int *);
866 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
867 Lisp_Object
, EMACS_INT
);
868 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
869 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
870 static EMACS_INT
number_of_chars (const char *, int);
871 static void compute_stop_pos (struct it
*);
872 static void compute_string_pos (struct text_pos
*, struct text_pos
,
874 static int face_before_or_after_it_pos (struct it
*, int);
875 static EMACS_INT
next_overlay_change (EMACS_INT
);
876 static int handle_single_display_spec (struct it
*, Lisp_Object
,
877 Lisp_Object
, Lisp_Object
,
878 struct text_pos
*, int);
879 static int underlying_face_id (struct it
*);
880 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
883 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
884 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
886 #ifdef HAVE_WINDOW_SYSTEM
888 static void x_consider_frame_title (Lisp_Object
);
889 static int tool_bar_lines_needed (struct frame
*, int *);
890 static void update_tool_bar (struct frame
*, int);
891 static void build_desired_tool_bar_string (struct frame
*f
);
892 static int redisplay_tool_bar (struct frame
*);
893 static void display_tool_bar_line (struct it
*, int);
894 static void notice_overwritten_cursor (struct window
*,
897 static void append_stretch_glyph (struct it
*, Lisp_Object
,
901 #endif /* HAVE_WINDOW_SYSTEM */
903 static int coords_in_mouse_face_p (struct window
*, int, int);
907 /***********************************************************************
908 Window display dimensions
909 ***********************************************************************/
911 /* Return the bottom boundary y-position for text lines in window W.
912 This is the first y position at which a line cannot start.
913 It is relative to the top of the window.
915 This is the height of W minus the height of a mode line, if any. */
918 window_text_bottom_y (struct window
*w
)
920 int height
= WINDOW_TOTAL_HEIGHT (w
);
922 if (WINDOW_WANTS_MODELINE_P (w
))
923 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
927 /* Return the pixel width of display area AREA of window W. AREA < 0
928 means return the total width of W, not including fringes to
929 the left and right of the window. */
932 window_box_width (struct window
*w
, int area
)
934 int cols
= XFASTINT (w
->total_cols
);
937 if (!w
->pseudo_window_p
)
939 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
941 if (area
== TEXT_AREA
)
943 if (INTEGERP (w
->left_margin_cols
))
944 cols
-= XFASTINT (w
->left_margin_cols
);
945 if (INTEGERP (w
->right_margin_cols
))
946 cols
-= XFASTINT (w
->right_margin_cols
);
947 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
949 else if (area
== LEFT_MARGIN_AREA
)
951 cols
= (INTEGERP (w
->left_margin_cols
)
952 ? XFASTINT (w
->left_margin_cols
) : 0);
955 else if (area
== RIGHT_MARGIN_AREA
)
957 cols
= (INTEGERP (w
->right_margin_cols
)
958 ? XFASTINT (w
->right_margin_cols
) : 0);
963 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
967 /* Return the pixel height of the display area of window W, not
968 including mode lines of W, if any. */
971 window_box_height (struct window
*w
)
973 struct frame
*f
= XFRAME (w
->frame
);
974 int height
= WINDOW_TOTAL_HEIGHT (w
);
976 xassert (height
>= 0);
978 /* Note: the code below that determines the mode-line/header-line
979 height is essentially the same as that contained in the macro
980 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
981 the appropriate glyph row has its `mode_line_p' flag set,
982 and if it doesn't, uses estimate_mode_line_height instead. */
984 if (WINDOW_WANTS_MODELINE_P (w
))
986 struct glyph_row
*ml_row
987 = (w
->current_matrix
&& w
->current_matrix
->rows
988 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
990 if (ml_row
&& ml_row
->mode_line_p
)
991 height
-= ml_row
->height
;
993 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
996 if (WINDOW_WANTS_HEADER_LINE_P (w
))
998 struct glyph_row
*hl_row
999 = (w
->current_matrix
&& w
->current_matrix
->rows
1000 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1002 if (hl_row
&& hl_row
->mode_line_p
)
1003 height
-= hl_row
->height
;
1005 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1008 /* With a very small font and a mode-line that's taller than
1009 default, we might end up with a negative height. */
1010 return max (0, height
);
1013 /* Return the window-relative coordinate of the left edge of display
1014 area AREA of window W. AREA < 0 means return the left edge of the
1015 whole window, to the right of the left fringe of W. */
1018 window_box_left_offset (struct window
*w
, int area
)
1022 if (w
->pseudo_window_p
)
1025 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1027 if (area
== TEXT_AREA
)
1028 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1029 + window_box_width (w
, LEFT_MARGIN_AREA
));
1030 else if (area
== RIGHT_MARGIN_AREA
)
1031 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1032 + window_box_width (w
, LEFT_MARGIN_AREA
)
1033 + window_box_width (w
, TEXT_AREA
)
1034 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1036 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1037 else if (area
== LEFT_MARGIN_AREA
1038 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1039 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1045 /* Return the window-relative coordinate of the right edge of display
1046 area AREA of window W. AREA < 0 means return the right edge of the
1047 whole window, to the left of the right fringe of W. */
1050 window_box_right_offset (struct window
*w
, int area
)
1052 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1055 /* Return the frame-relative coordinate of the left edge of display
1056 area AREA of window W. AREA < 0 means return the left edge of the
1057 whole window, to the right of the left fringe of W. */
1060 window_box_left (struct window
*w
, int area
)
1062 struct frame
*f
= XFRAME (w
->frame
);
1065 if (w
->pseudo_window_p
)
1066 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1068 x
= (WINDOW_LEFT_EDGE_X (w
)
1069 + window_box_left_offset (w
, area
));
1075 /* Return the frame-relative coordinate of the right edge of display
1076 area AREA of window W. AREA < 0 means return the right edge of the
1077 whole window, to the left of the right fringe of W. */
1080 window_box_right (struct window
*w
, int area
)
1082 return window_box_left (w
, area
) + window_box_width (w
, area
);
1085 /* Get the bounding box of the display area AREA of window W, without
1086 mode lines, in frame-relative coordinates. AREA < 0 means the
1087 whole window, not including the left and right fringes of
1088 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1089 coordinates of the upper-left corner of the box. Return in
1090 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1093 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1094 int *box_width
, int *box_height
)
1097 *box_width
= window_box_width (w
, area
);
1099 *box_height
= window_box_height (w
);
1101 *box_x
= window_box_left (w
, area
);
1104 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1105 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1106 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1111 /* Get the bounding box of the display area AREA of window W, without
1112 mode lines. AREA < 0 means the whole window, not including the
1113 left and right fringe of the window. Return in *TOP_LEFT_X
1114 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1115 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1116 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1120 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1121 int *bottom_right_x
, int *bottom_right_y
)
1123 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1125 *bottom_right_x
+= *top_left_x
;
1126 *bottom_right_y
+= *top_left_y
;
1131 /***********************************************************************
1133 ***********************************************************************/
1135 /* Return the bottom y-position of the line the iterator IT is in.
1136 This can modify IT's settings. */
1139 line_bottom_y (struct it
*it
)
1141 int line_height
= it
->max_ascent
+ it
->max_descent
;
1142 int line_top_y
= it
->current_y
;
1144 if (line_height
== 0)
1147 line_height
= last_height
;
1148 else if (IT_CHARPOS (*it
) < ZV
)
1150 move_it_by_lines (it
, 1, 1);
1151 line_height
= (it
->max_ascent
|| it
->max_descent
1152 ? it
->max_ascent
+ it
->max_descent
1157 struct glyph_row
*row
= it
->glyph_row
;
1159 /* Use the default character height. */
1160 it
->glyph_row
= NULL
;
1161 it
->what
= IT_CHARACTER
;
1164 PRODUCE_GLYPHS (it
);
1165 line_height
= it
->ascent
+ it
->descent
;
1166 it
->glyph_row
= row
;
1170 return line_top_y
+ line_height
;
1174 /* Return 1 if position CHARPOS is visible in window W.
1175 CHARPOS < 0 means return info about WINDOW_END position.
1176 If visible, set *X and *Y to pixel coordinates of top left corner.
1177 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1178 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1181 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1182 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1185 struct text_pos top
;
1187 struct buffer
*old_buffer
= NULL
;
1189 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1192 if (XBUFFER (w
->buffer
) != current_buffer
)
1194 old_buffer
= current_buffer
;
1195 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1198 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1200 /* Compute exact mode line heights. */
1201 if (WINDOW_WANTS_MODELINE_P (w
))
1202 current_mode_line_height
1203 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1204 BVAR (current_buffer
, mode_line_format
));
1206 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1207 current_header_line_height
1208 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1209 BVAR (current_buffer
, header_line_format
));
1211 start_display (&it
, w
, top
);
1212 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1213 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1215 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1217 /* We have reached CHARPOS, or passed it. How the call to
1218 move_it_to can overshoot: (i) If CHARPOS is on invisible
1219 text, move_it_to stops at the end of the invisible text,
1220 after CHARPOS. (ii) If CHARPOS is in a display vector,
1221 move_it_to stops on its last glyph. */
1222 int top_x
= it
.current_x
;
1223 int top_y
= it
.current_y
;
1224 enum it_method it_method
= it
.method
;
1225 /* Calling line_bottom_y may change it.method, it.position, etc. */
1226 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1227 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1229 if (top_y
< window_top_y
)
1230 visible_p
= bottom_y
> window_top_y
;
1231 else if (top_y
< it
.last_visible_y
)
1235 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1237 /* We stopped on the last glyph of a display vector.
1238 Try and recompute. Hack alert! */
1239 if (charpos
< 2 || top
.charpos
>= charpos
)
1240 top_x
= it
.glyph_row
->x
;
1244 start_display (&it2
, w
, top
);
1245 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1246 get_next_display_element (&it2
);
1247 PRODUCE_GLYPHS (&it2
);
1248 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1249 || it2
.current_x
> it2
.last_visible_x
)
1250 top_x
= it
.glyph_row
->x
;
1253 top_x
= it2
.current_x
;
1254 top_y
= it2
.current_y
;
1260 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1261 *rtop
= max (0, window_top_y
- top_y
);
1262 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1263 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1264 - max (top_y
, window_top_y
)));
1273 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1274 move_it_by_lines (&it
, 1, 0);
1275 if (charpos
< IT_CHARPOS (it
)
1276 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1279 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1281 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1282 *rtop
= max (0, -it2
.current_y
);
1283 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1284 - it
.last_visible_y
));
1285 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1287 - max (it2
.current_y
,
1288 WINDOW_HEADER_LINE_HEIGHT (w
))));
1294 set_buffer_internal_1 (old_buffer
);
1296 current_header_line_height
= current_mode_line_height
= -1;
1298 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1299 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1302 /* Debugging code. */
1304 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1305 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1307 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1314 /* Return the next character from STR. Return in *LEN the length of
1315 the character. This is like STRING_CHAR_AND_LENGTH but never
1316 returns an invalid character. If we find one, we return a `?', but
1317 with the length of the invalid character. */
1320 string_char_and_length (const unsigned char *str
, int *len
)
1324 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1325 if (!CHAR_VALID_P (c
, 1))
1326 /* We may not change the length here because other places in Emacs
1327 don't use this function, i.e. they silently accept invalid
1336 /* Given a position POS containing a valid character and byte position
1337 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1339 static struct text_pos
1340 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1342 xassert (STRINGP (string
) && nchars
>= 0);
1344 if (STRING_MULTIBYTE (string
))
1346 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1351 string_char_and_length (p
, &len
);
1354 BYTEPOS (pos
) += len
;
1358 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1364 /* Value is the text position, i.e. character and byte position,
1365 for character position CHARPOS in STRING. */
1367 static INLINE
struct text_pos
1368 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1370 struct text_pos pos
;
1371 xassert (STRINGP (string
));
1372 xassert (charpos
>= 0);
1373 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1378 /* Value is a text position, i.e. character and byte position, for
1379 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1380 means recognize multibyte characters. */
1382 static struct text_pos
1383 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1385 struct text_pos pos
;
1387 xassert (s
!= NULL
);
1388 xassert (charpos
>= 0);
1394 SET_TEXT_POS (pos
, 0, 0);
1397 string_char_and_length ((const unsigned char *) s
, &len
);
1400 BYTEPOS (pos
) += len
;
1404 SET_TEXT_POS (pos
, charpos
, charpos
);
1410 /* Value is the number of characters in C string S. MULTIBYTE_P
1411 non-zero means recognize multibyte characters. */
1414 number_of_chars (const char *s
, int multibyte_p
)
1420 EMACS_INT rest
= strlen (s
);
1422 const unsigned char *p
= (const unsigned char *) s
;
1424 for (nchars
= 0; rest
> 0; ++nchars
)
1426 string_char_and_length (p
, &len
);
1427 rest
-= len
, p
+= len
;
1431 nchars
= strlen (s
);
1437 /* Compute byte position NEWPOS->bytepos corresponding to
1438 NEWPOS->charpos. POS is a known position in string STRING.
1439 NEWPOS->charpos must be >= POS.charpos. */
1442 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1444 xassert (STRINGP (string
));
1445 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1447 if (STRING_MULTIBYTE (string
))
1448 *newpos
= string_pos_nchars_ahead (pos
, string
,
1449 CHARPOS (*newpos
) - CHARPOS (pos
));
1451 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1455 Return an estimation of the pixel height of mode or header lines on
1456 frame F. FACE_ID specifies what line's height to estimate. */
1459 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1461 #ifdef HAVE_WINDOW_SYSTEM
1462 if (FRAME_WINDOW_P (f
))
1464 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1466 /* This function is called so early when Emacs starts that the face
1467 cache and mode line face are not yet initialized. */
1468 if (FRAME_FACE_CACHE (f
))
1470 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1474 height
= FONT_HEIGHT (face
->font
);
1475 if (face
->box_line_width
> 0)
1476 height
+= 2 * face
->box_line_width
;
1487 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1488 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1489 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1490 not force the value into range. */
1493 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1494 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1497 #ifdef HAVE_WINDOW_SYSTEM
1498 if (FRAME_WINDOW_P (f
))
1500 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1501 even for negative values. */
1503 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1505 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1507 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1508 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1511 STORE_NATIVE_RECT (*bounds
,
1512 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1513 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1514 FRAME_COLUMN_WIDTH (f
) - 1,
1515 FRAME_LINE_HEIGHT (f
) - 1);
1521 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1522 pix_x
= FRAME_TOTAL_COLS (f
);
1526 else if (pix_y
> FRAME_LINES (f
))
1527 pix_y
= FRAME_LINES (f
);
1537 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1538 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1539 can't tell the positions because W's display is not up to date,
1543 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1544 int *frame_x
, int *frame_y
)
1546 #ifdef HAVE_WINDOW_SYSTEM
1547 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1551 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1552 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1554 if (display_completed
)
1556 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1557 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1558 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1564 hpos
+= glyph
->pixel_width
;
1568 /* If first glyph is partially visible, its first visible position is still 0. */
1580 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1581 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1675 Convert frame-relative x/y to coordinates relative to window W.
1676 Takes pseudo-windows into account. */
1679 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1681 if (w
->pseudo_window_p
)
1683 /* A pseudo-window is always full-width, and starts at the
1684 left edge of the frame, plus a frame border. */
1685 struct frame
*f
= XFRAME (w
->frame
);
1686 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1687 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1691 *x
-= WINDOW_LEFT_EDGE_X (w
);
1692 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1696 #ifdef HAVE_WINDOW_SYSTEM
1699 Return in RECTS[] at most N clipping rectangles for glyph string S.
1700 Return the number of stored rectangles. */
1703 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1710 if (s
->row
->full_width_p
)
1712 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1713 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1714 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1716 /* Unless displaying a mode or menu bar line, which are always
1717 fully visible, clip to the visible part of the row. */
1718 if (s
->w
->pseudo_window_p
)
1719 r
.height
= s
->row
->visible_height
;
1721 r
.height
= s
->height
;
1725 /* This is a text line that may be partially visible. */
1726 r
.x
= window_box_left (s
->w
, s
->area
);
1727 r
.width
= window_box_width (s
->w
, s
->area
);
1728 r
.height
= s
->row
->visible_height
;
1732 if (r
.x
< s
->clip_head
->x
)
1734 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1735 r
.width
-= s
->clip_head
->x
- r
.x
;
1738 r
.x
= s
->clip_head
->x
;
1741 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1743 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1744 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1749 /* If S draws overlapping rows, it's sufficient to use the top and
1750 bottom of the window for clipping because this glyph string
1751 intentionally draws over other lines. */
1752 if (s
->for_overlaps
)
1754 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1755 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1757 /* Alas, the above simple strategy does not work for the
1758 environments with anti-aliased text: if the same text is
1759 drawn onto the same place multiple times, it gets thicker.
1760 If the overlap we are processing is for the erased cursor, we
1761 take the intersection with the rectagle of the cursor. */
1762 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1764 XRectangle rc
, r_save
= r
;
1766 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1767 rc
.y
= s
->w
->phys_cursor
.y
;
1768 rc
.width
= s
->w
->phys_cursor_width
;
1769 rc
.height
= s
->w
->phys_cursor_height
;
1771 x_intersect_rectangles (&r_save
, &rc
, &r
);
1776 /* Don't use S->y for clipping because it doesn't take partially
1777 visible lines into account. For example, it can be negative for
1778 partially visible lines at the top of a window. */
1779 if (!s
->row
->full_width_p
1780 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1781 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1783 r
.y
= max (0, s
->row
->y
);
1786 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1788 /* If drawing the cursor, don't let glyph draw outside its
1789 advertised boundaries. Cleartype does this under some circumstances. */
1790 if (s
->hl
== DRAW_CURSOR
)
1792 struct glyph
*glyph
= s
->first_glyph
;
1797 r
.width
-= s
->x
- r
.x
;
1800 r
.width
= min (r
.width
, glyph
->pixel_width
);
1802 /* If r.y is below window bottom, ensure that we still see a cursor. */
1803 height
= min (glyph
->ascent
+ glyph
->descent
,
1804 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1805 max_y
= window_text_bottom_y (s
->w
) - height
;
1806 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1807 if (s
->ybase
- glyph
->ascent
> max_y
)
1814 /* Don't draw cursor glyph taller than our actual glyph. */
1815 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1816 if (height
< r
.height
)
1818 max_y
= r
.y
+ r
.height
;
1819 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1820 r
.height
= min (max_y
- r
.y
, height
);
1827 XRectangle r_save
= r
;
1829 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1833 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1834 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1836 #ifdef CONVERT_FROM_XRECT
1837 CONVERT_FROM_XRECT (r
, *rects
);
1845 /* If we are processing overlapping and allowed to return
1846 multiple clipping rectangles, we exclude the row of the glyph
1847 string from the clipping rectangle. This is to avoid drawing
1848 the same text on the environment with anti-aliasing. */
1849 #ifdef CONVERT_FROM_XRECT
1852 XRectangle
*rs
= rects
;
1854 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1856 if (s
->for_overlaps
& OVERLAPS_PRED
)
1859 if (r
.y
+ r
.height
> row_y
)
1862 rs
[i
].height
= row_y
- r
.y
;
1868 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1871 if (r
.y
< row_y
+ s
->row
->visible_height
)
1873 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1875 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1876 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1885 #ifdef CONVERT_FROM_XRECT
1886 for (i
= 0; i
< n
; i
++)
1887 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1894 Return in *NR the clipping rectangle for glyph string S. */
1897 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1899 get_glyph_string_clip_rects (s
, nr
, 1);
1904 Return the position and height of the phys cursor in window W.
1905 Set w->phys_cursor_width to width of phys cursor.
1909 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1910 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1912 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1913 int x
, y
, wd
, h
, h0
, y0
;
1915 /* Compute the width of the rectangle to draw. If on a stretch
1916 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1917 rectangle as wide as the glyph, but use a canonical character
1919 wd
= glyph
->pixel_width
- 1;
1920 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1924 x
= w
->phys_cursor
.x
;
1931 if (glyph
->type
== STRETCH_GLYPH
1932 && !x_stretch_cursor_p
)
1933 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1934 w
->phys_cursor_width
= wd
;
1936 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1938 /* If y is below window bottom, ensure that we still see a cursor. */
1939 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1941 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1942 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1944 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1947 h
= max (h
- (y0
- y
) + 1, h0
);
1952 y0
= window_text_bottom_y (w
) - h0
;
1960 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1961 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1966 * Remember which glyph the mouse is over.
1970 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1974 struct glyph_row
*r
, *gr
, *end_row
;
1975 enum window_part part
;
1976 enum glyph_row_area area
;
1977 int x
, y
, width
, height
;
1979 /* Try to determine frame pixel position and size of the glyph under
1980 frame pixel coordinates X/Y on frame F. */
1982 if (!f
->glyphs_initialized_p
1983 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1986 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1987 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1991 w
= XWINDOW (window
);
1992 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1993 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1995 x
= window_relative_x_coord (w
, part
, gx
);
1996 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1998 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1999 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2001 if (w
->pseudo_window_p
)
2004 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2010 case ON_LEFT_MARGIN
:
2011 area
= LEFT_MARGIN_AREA
;
2014 case ON_RIGHT_MARGIN
:
2015 area
= RIGHT_MARGIN_AREA
;
2018 case ON_HEADER_LINE
:
2020 gr
= (part
== ON_HEADER_LINE
2021 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2022 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2025 goto text_glyph_row_found
;
2032 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2033 if (r
->y
+ r
->height
> y
)
2039 text_glyph_row_found
:
2042 struct glyph
*g
= gr
->glyphs
[area
];
2043 struct glyph
*end
= g
+ gr
->used
[area
];
2045 height
= gr
->height
;
2046 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2047 if (gx
+ g
->pixel_width
> x
)
2052 if (g
->type
== IMAGE_GLYPH
)
2054 /* Don't remember when mouse is over image, as
2055 image may have hot-spots. */
2056 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2059 width
= g
->pixel_width
;
2063 /* Use nominal char spacing at end of line. */
2065 gx
+= (x
/ width
) * width
;
2068 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2069 gx
+= window_box_left_offset (w
, area
);
2073 /* Use nominal line height at end of window. */
2074 gx
= (x
/ width
) * width
;
2076 gy
+= (y
/ height
) * height
;
2080 case ON_LEFT_FRINGE
:
2081 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2082 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2083 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2084 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2087 case ON_RIGHT_FRINGE
:
2088 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2089 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2090 : window_box_right_offset (w
, TEXT_AREA
));
2091 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2095 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2097 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2098 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2099 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2101 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2105 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2106 if (r
->y
+ r
->height
> y
)
2113 height
= gr
->height
;
2116 /* Use nominal line height at end of window. */
2118 gy
+= (y
/ height
) * height
;
2125 /* If there is no glyph under the mouse, then we divide the screen
2126 into a grid of the smallest glyph in the frame, and use that
2129 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2130 round down even for negative values. */
2136 gx
= (gx
/ width
) * width
;
2137 gy
= (gy
/ height
) * height
;
2142 gx
+= WINDOW_LEFT_EDGE_X (w
);
2143 gy
+= WINDOW_TOP_EDGE_Y (w
);
2146 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2148 /* Visible feedback for debugging. */
2151 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2152 f
->output_data
.x
->normal_gc
,
2153 gx
, gy
, width
, height
);
2159 #endif /* HAVE_WINDOW_SYSTEM */
2162 /***********************************************************************
2163 Lisp form evaluation
2164 ***********************************************************************/
2166 /* Error handler for safe_eval and safe_call. */
2169 safe_eval_handler (Lisp_Object arg
)
2171 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2176 /* Evaluate SEXPR and return the result, or nil if something went
2177 wrong. Prevent redisplay during the evaluation. */
2179 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2180 Return the result, or nil if something went wrong. Prevent
2181 redisplay during the evaluation. */
2184 safe_call (int nargs
, Lisp_Object
*args
)
2188 if (inhibit_eval_during_redisplay
)
2192 int count
= SPECPDL_INDEX ();
2193 struct gcpro gcpro1
;
2196 gcpro1
.nvars
= nargs
;
2197 specbind (Qinhibit_redisplay
, Qt
);
2198 /* Use Qt to ensure debugger does not run,
2199 so there is no possibility of wanting to redisplay. */
2200 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2203 val
= unbind_to (count
, val
);
2210 /* Call function FN with one argument ARG.
2211 Return the result, or nil if something went wrong. */
2214 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2216 Lisp_Object args
[2];
2219 return safe_call (2, args
);
2222 static Lisp_Object Qeval
;
2225 safe_eval (Lisp_Object sexpr
)
2227 return safe_call1 (Qeval
, sexpr
);
2230 /* Call function FN with one argument ARG.
2231 Return the result, or nil if something went wrong. */
2234 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2236 Lisp_Object args
[3];
2240 return safe_call (3, args
);
2245 /***********************************************************************
2247 ***********************************************************************/
2251 /* Define CHECK_IT to perform sanity checks on iterators.
2252 This is for debugging. It is too slow to do unconditionally. */
2258 if (it
->method
== GET_FROM_STRING
)
2260 xassert (STRINGP (it
->string
));
2261 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2265 xassert (IT_STRING_CHARPOS (*it
) < 0);
2266 if (it
->method
== GET_FROM_BUFFER
)
2268 /* Check that character and byte positions agree. */
2269 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2274 xassert (it
->current
.dpvec_index
>= 0);
2276 xassert (it
->current
.dpvec_index
< 0);
2279 #define CHECK_IT(IT) check_it ((IT))
2283 #define CHECK_IT(IT) (void) 0
2290 /* Check that the window end of window W is what we expect it
2291 to be---the last row in the current matrix displaying text. */
2294 check_window_end (w
)
2297 if (!MINI_WINDOW_P (w
)
2298 && !NILP (w
->window_end_valid
))
2300 struct glyph_row
*row
;
2301 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2302 XFASTINT (w
->window_end_vpos
)),
2304 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2305 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2309 #define CHECK_WINDOW_END(W) check_window_end ((W))
2311 #else /* not GLYPH_DEBUG */
2313 #define CHECK_WINDOW_END(W) (void) 0
2315 #endif /* not GLYPH_DEBUG */
2319 /***********************************************************************
2320 Iterator initialization
2321 ***********************************************************************/
2323 /* Initialize IT for displaying current_buffer in window W, starting
2324 at character position CHARPOS. CHARPOS < 0 means that no buffer
2325 position is specified which is useful when the iterator is assigned
2326 a position later. BYTEPOS is the byte position corresponding to
2327 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2329 If ROW is not null, calls to produce_glyphs with IT as parameter
2330 will produce glyphs in that row.
2332 BASE_FACE_ID is the id of a base face to use. It must be one of
2333 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2334 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2335 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2337 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2338 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2339 will be initialized to use the corresponding mode line glyph row of
2340 the desired matrix of W. */
2343 init_iterator (struct it
*it
, struct window
*w
,
2344 EMACS_INT charpos
, EMACS_INT bytepos
,
2345 struct glyph_row
*row
, enum face_id base_face_id
)
2347 int highlight_region_p
;
2348 enum face_id remapped_base_face_id
= base_face_id
;
2350 /* Some precondition checks. */
2351 xassert (w
!= NULL
&& it
!= NULL
);
2352 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2355 /* If face attributes have been changed since the last redisplay,
2356 free realized faces now because they depend on face definitions
2357 that might have changed. Don't free faces while there might be
2358 desired matrices pending which reference these faces. */
2359 if (face_change_count
&& !inhibit_free_realized_faces
)
2361 face_change_count
= 0;
2362 free_all_realized_faces (Qnil
);
2365 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2366 if (! NILP (Vface_remapping_alist
))
2367 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2369 /* Use one of the mode line rows of W's desired matrix if
2373 if (base_face_id
== MODE_LINE_FACE_ID
2374 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2375 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2376 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2377 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2381 memset (it
, 0, sizeof *it
);
2382 it
->current
.overlay_string_index
= -1;
2383 it
->current
.dpvec_index
= -1;
2384 it
->base_face_id
= remapped_base_face_id
;
2386 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2388 /* The window in which we iterate over current_buffer: */
2389 XSETWINDOW (it
->window
, w
);
2391 it
->f
= XFRAME (w
->frame
);
2395 /* Extra space between lines (on window systems only). */
2396 if (base_face_id
== DEFAULT_FACE_ID
2397 && FRAME_WINDOW_P (it
->f
))
2399 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2400 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2401 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2402 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2403 * FRAME_LINE_HEIGHT (it
->f
));
2404 else if (it
->f
->extra_line_spacing
> 0)
2405 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2406 it
->max_extra_line_spacing
= 0;
2409 /* If realized faces have been removed, e.g. because of face
2410 attribute changes of named faces, recompute them. When running
2411 in batch mode, the face cache of the initial frame is null. If
2412 we happen to get called, make a dummy face cache. */
2413 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2414 init_frame_faces (it
->f
);
2415 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2416 recompute_basic_faces (it
->f
);
2418 /* Current value of the `slice', `space-width', and 'height' properties. */
2419 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2420 it
->space_width
= Qnil
;
2421 it
->font_height
= Qnil
;
2422 it
->override_ascent
= -1;
2424 /* Are control characters displayed as `^C'? */
2425 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2427 /* -1 means everything between a CR and the following line end
2428 is invisible. >0 means lines indented more than this value are
2430 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2431 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2432 : (!NILP (BVAR (current_buffer
, selective_display
))
2434 it
->selective_display_ellipsis_p
2435 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2437 /* Display table to use. */
2438 it
->dp
= window_display_table (w
);
2440 /* Are multibyte characters enabled in current_buffer? */
2441 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2443 /* Do we need to reorder bidirectional text? Not if this is a
2444 unibyte buffer: by definition, none of the single-byte characters
2445 are strong R2L, so no reordering is needed. And bidi.c doesn't
2446 support unibyte buffers anyway. */
2448 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2450 /* Non-zero if we should highlight the region. */
2452 = (!NILP (Vtransient_mark_mode
)
2453 && !NILP (BVAR (current_buffer
, mark_active
))
2454 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2456 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2457 start and end of a visible region in window IT->w. Set both to
2458 -1 to indicate no region. */
2459 if (highlight_region_p
2460 /* Maybe highlight only in selected window. */
2461 && (/* Either show region everywhere. */
2462 highlight_nonselected_windows
2463 /* Or show region in the selected window. */
2464 || w
== XWINDOW (selected_window
)
2465 /* Or show the region if we are in the mini-buffer and W is
2466 the window the mini-buffer refers to. */
2467 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2468 && WINDOWP (minibuf_selected_window
)
2469 && w
== XWINDOW (minibuf_selected_window
))))
2471 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2472 it
->region_beg_charpos
= min (PT
, markpos
);
2473 it
->region_end_charpos
= max (PT
, markpos
);
2476 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2478 /* Get the position at which the redisplay_end_trigger hook should
2479 be run, if it is to be run at all. */
2480 if (MARKERP (w
->redisplay_end_trigger
)
2481 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2482 it
->redisplay_end_trigger_charpos
2483 = marker_position (w
->redisplay_end_trigger
);
2484 else if (INTEGERP (w
->redisplay_end_trigger
))
2485 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2487 /* Correct bogus values of tab_width. */
2488 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2489 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2492 /* Are lines in the display truncated? */
2493 if (base_face_id
!= DEFAULT_FACE_ID
2494 || XINT (it
->w
->hscroll
)
2495 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2496 && ((!NILP (Vtruncate_partial_width_windows
)
2497 && !INTEGERP (Vtruncate_partial_width_windows
))
2498 || (INTEGERP (Vtruncate_partial_width_windows
)
2499 && (WINDOW_TOTAL_COLS (it
->w
)
2500 < XINT (Vtruncate_partial_width_windows
))))))
2501 it
->line_wrap
= TRUNCATE
;
2502 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2503 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2504 ? WINDOW_WRAP
: WORD_WRAP
;
2506 it
->line_wrap
= TRUNCATE
;
2508 /* Get dimensions of truncation and continuation glyphs. These are
2509 displayed as fringe bitmaps under X, so we don't need them for such
2511 if (!FRAME_WINDOW_P (it
->f
))
2513 if (it
->line_wrap
== TRUNCATE
)
2515 /* We will need the truncation glyph. */
2516 xassert (it
->glyph_row
== NULL
);
2517 produce_special_glyphs (it
, IT_TRUNCATION
);
2518 it
->truncation_pixel_width
= it
->pixel_width
;
2522 /* We will need the continuation glyph. */
2523 xassert (it
->glyph_row
== NULL
);
2524 produce_special_glyphs (it
, IT_CONTINUATION
);
2525 it
->continuation_pixel_width
= it
->pixel_width
;
2528 /* Reset these values to zero because the produce_special_glyphs
2529 above has changed them. */
2530 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2531 it
->phys_ascent
= it
->phys_descent
= 0;
2534 /* Set this after getting the dimensions of truncation and
2535 continuation glyphs, so that we don't produce glyphs when calling
2536 produce_special_glyphs, above. */
2537 it
->glyph_row
= row
;
2538 it
->area
= TEXT_AREA
;
2540 /* Forget any previous info about this row being reversed. */
2542 it
->glyph_row
->reversed_p
= 0;
2544 /* Get the dimensions of the display area. The display area
2545 consists of the visible window area plus a horizontally scrolled
2546 part to the left of the window. All x-values are relative to the
2547 start of this total display area. */
2548 if (base_face_id
!= DEFAULT_FACE_ID
)
2550 /* Mode lines, menu bar in terminal frames. */
2551 it
->first_visible_x
= 0;
2552 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2557 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2558 it
->last_visible_x
= (it
->first_visible_x
2559 + window_box_width (w
, TEXT_AREA
));
2561 /* If we truncate lines, leave room for the truncator glyph(s) at
2562 the right margin. Otherwise, leave room for the continuation
2563 glyph(s). Truncation and continuation glyphs are not inserted
2564 for window-based redisplay. */
2565 if (!FRAME_WINDOW_P (it
->f
))
2567 if (it
->line_wrap
== TRUNCATE
)
2568 it
->last_visible_x
-= it
->truncation_pixel_width
;
2570 it
->last_visible_x
-= it
->continuation_pixel_width
;
2573 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2574 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2577 /* Leave room for a border glyph. */
2578 if (!FRAME_WINDOW_P (it
->f
)
2579 && !WINDOW_RIGHTMOST_P (it
->w
))
2580 it
->last_visible_x
-= 1;
2582 it
->last_visible_y
= window_text_bottom_y (w
);
2584 /* For mode lines and alike, arrange for the first glyph having a
2585 left box line if the face specifies a box. */
2586 if (base_face_id
!= DEFAULT_FACE_ID
)
2590 it
->face_id
= remapped_base_face_id
;
2592 /* If we have a boxed mode line, make the first character appear
2593 with a left box line. */
2594 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2595 if (face
->box
!= FACE_NO_BOX
)
2596 it
->start_of_box_run_p
= 1;
2599 /* If we are to reorder bidirectional text, init the bidi
2603 /* Note the paragraph direction that this buffer wants to
2605 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2606 it
->paragraph_embedding
= L2R
;
2607 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2608 it
->paragraph_embedding
= R2L
;
2610 it
->paragraph_embedding
= NEUTRAL_DIR
;
2611 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2614 /* If a buffer position was specified, set the iterator there,
2615 getting overlays and face properties from that position. */
2616 if (charpos
>= BUF_BEG (current_buffer
))
2618 it
->end_charpos
= ZV
;
2620 IT_CHARPOS (*it
) = charpos
;
2622 /* Compute byte position if not specified. */
2623 if (bytepos
< charpos
)
2624 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2626 IT_BYTEPOS (*it
) = bytepos
;
2628 it
->start
= it
->current
;
2630 /* Compute faces etc. */
2631 reseat (it
, it
->current
.pos
, 1);
2638 /* Initialize IT for the display of window W with window start POS. */
2641 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2643 struct glyph_row
*row
;
2644 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2646 row
= w
->desired_matrix
->rows
+ first_vpos
;
2647 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2648 it
->first_vpos
= first_vpos
;
2650 /* Don't reseat to previous visible line start if current start
2651 position is in a string or image. */
2652 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2654 int start_at_line_beg_p
;
2655 int first_y
= it
->current_y
;
2657 /* If window start is not at a line start, skip forward to POS to
2658 get the correct continuation lines width. */
2659 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2660 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2661 if (!start_at_line_beg_p
)
2665 reseat_at_previous_visible_line_start (it
);
2666 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2668 new_x
= it
->current_x
+ it
->pixel_width
;
2670 /* If lines are continued, this line may end in the middle
2671 of a multi-glyph character (e.g. a control character
2672 displayed as \003, or in the middle of an overlay
2673 string). In this case move_it_to above will not have
2674 taken us to the start of the continuation line but to the
2675 end of the continued line. */
2676 if (it
->current_x
> 0
2677 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2678 && (/* And glyph doesn't fit on the line. */
2679 new_x
> it
->last_visible_x
2680 /* Or it fits exactly and we're on a window
2682 || (new_x
== it
->last_visible_x
2683 && FRAME_WINDOW_P (it
->f
))))
2685 if (it
->current
.dpvec_index
>= 0
2686 || it
->current
.overlay_string_index
>= 0)
2688 set_iterator_to_next (it
, 1);
2689 move_it_in_display_line_to (it
, -1, -1, 0);
2692 it
->continuation_lines_width
+= it
->current_x
;
2695 /* We're starting a new display line, not affected by the
2696 height of the continued line, so clear the appropriate
2697 fields in the iterator structure. */
2698 it
->max_ascent
= it
->max_descent
= 0;
2699 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2701 it
->current_y
= first_y
;
2703 it
->current_x
= it
->hpos
= 0;
2709 /* Return 1 if POS is a position in ellipses displayed for invisible
2710 text. W is the window we display, for text property lookup. */
2713 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2715 Lisp_Object prop
, window
;
2717 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2719 /* If POS specifies a position in a display vector, this might
2720 be for an ellipsis displayed for invisible text. We won't
2721 get the iterator set up for delivering that ellipsis unless
2722 we make sure that it gets aware of the invisible text. */
2723 if (pos
->dpvec_index
>= 0
2724 && pos
->overlay_string_index
< 0
2725 && CHARPOS (pos
->string_pos
) < 0
2727 && (XSETWINDOW (window
, w
),
2728 prop
= Fget_char_property (make_number (charpos
),
2729 Qinvisible
, window
),
2730 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2732 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2734 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2741 /* Initialize IT for stepping through current_buffer in window W,
2742 starting at position POS that includes overlay string and display
2743 vector/ control character translation position information. Value
2744 is zero if there are overlay strings with newlines at POS. */
2747 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2749 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2750 int i
, overlay_strings_with_newlines
= 0;
2752 /* If POS specifies a position in a display vector, this might
2753 be for an ellipsis displayed for invisible text. We won't
2754 get the iterator set up for delivering that ellipsis unless
2755 we make sure that it gets aware of the invisible text. */
2756 if (in_ellipses_for_invisible_text_p (pos
, w
))
2762 /* Keep in mind: the call to reseat in init_iterator skips invisible
2763 text, so we might end up at a position different from POS. This
2764 is only a problem when POS is a row start after a newline and an
2765 overlay starts there with an after-string, and the overlay has an
2766 invisible property. Since we don't skip invisible text in
2767 display_line and elsewhere immediately after consuming the
2768 newline before the row start, such a POS will not be in a string,
2769 but the call to init_iterator below will move us to the
2771 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2773 /* This only scans the current chunk -- it should scan all chunks.
2774 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2775 to 16 in 22.1 to make this a lesser problem. */
2776 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2778 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2779 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2781 while (s
< e
&& *s
!= '\n')
2786 overlay_strings_with_newlines
= 1;
2791 /* If position is within an overlay string, set up IT to the right
2793 if (pos
->overlay_string_index
>= 0)
2797 /* If the first overlay string happens to have a `display'
2798 property for an image, the iterator will be set up for that
2799 image, and we have to undo that setup first before we can
2800 correct the overlay string index. */
2801 if (it
->method
== GET_FROM_IMAGE
)
2804 /* We already have the first chunk of overlay strings in
2805 IT->overlay_strings. Load more until the one for
2806 pos->overlay_string_index is in IT->overlay_strings. */
2807 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2809 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2810 it
->current
.overlay_string_index
= 0;
2813 load_overlay_strings (it
, 0);
2814 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2818 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2819 relative_index
= (it
->current
.overlay_string_index
2820 % OVERLAY_STRING_CHUNK_SIZE
);
2821 it
->string
= it
->overlay_strings
[relative_index
];
2822 xassert (STRINGP (it
->string
));
2823 it
->current
.string_pos
= pos
->string_pos
;
2824 it
->method
= GET_FROM_STRING
;
2827 if (CHARPOS (pos
->string_pos
) >= 0)
2829 /* Recorded position is not in an overlay string, but in another
2830 string. This can only be a string from a `display' property.
2831 IT should already be filled with that string. */
2832 it
->current
.string_pos
= pos
->string_pos
;
2833 xassert (STRINGP (it
->string
));
2836 /* Restore position in display vector translations, control
2837 character translations or ellipses. */
2838 if (pos
->dpvec_index
>= 0)
2840 if (it
->dpvec
== NULL
)
2841 get_next_display_element (it
);
2842 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2843 it
->current
.dpvec_index
= pos
->dpvec_index
;
2847 return !overlay_strings_with_newlines
;
2851 /* Initialize IT for stepping through current_buffer in window W
2852 starting at ROW->start. */
2855 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2857 init_from_display_pos (it
, w
, &row
->start
);
2858 it
->start
= row
->start
;
2859 it
->continuation_lines_width
= row
->continuation_lines_width
;
2864 /* Initialize IT for stepping through current_buffer in window W
2865 starting in the line following ROW, i.e. starting at ROW->end.
2866 Value is zero if there are overlay strings with newlines at ROW's
2870 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2874 if (init_from_display_pos (it
, w
, &row
->end
))
2876 if (row
->continued_p
)
2877 it
->continuation_lines_width
2878 = row
->continuation_lines_width
+ row
->pixel_width
;
2889 /***********************************************************************
2891 ***********************************************************************/
2893 /* Called when IT reaches IT->stop_charpos. Handle text property and
2894 overlay changes. Set IT->stop_charpos to the next position where
2898 handle_stop (struct it
*it
)
2900 enum prop_handled handled
;
2901 int handle_overlay_change_p
;
2905 it
->current
.dpvec_index
= -1;
2906 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2907 it
->ignore_overlay_strings_at_pos_p
= 0;
2910 /* Use face of preceding text for ellipsis (if invisible) */
2911 if (it
->selective_display_ellipsis_p
)
2912 it
->saved_face_id
= it
->face_id
;
2916 handled
= HANDLED_NORMALLY
;
2918 /* Call text property handlers. */
2919 for (p
= it_props
; p
->handler
; ++p
)
2921 handled
= p
->handler (it
);
2923 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2925 else if (handled
== HANDLED_RETURN
)
2927 /* We still want to show before and after strings from
2928 overlays even if the actual buffer text is replaced. */
2929 if (!handle_overlay_change_p
2931 || !get_overlay_strings_1 (it
, 0, 0))
2934 setup_for_ellipsis (it
, 0);
2935 /* When handling a display spec, we might load an
2936 empty string. In that case, discard it here. We
2937 used to discard it in handle_single_display_spec,
2938 but that causes get_overlay_strings_1, above, to
2939 ignore overlay strings that we must check. */
2940 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2944 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2948 it
->ignore_overlay_strings_at_pos_p
= 1;
2949 it
->string_from_display_prop_p
= 0;
2950 handle_overlay_change_p
= 0;
2952 handled
= HANDLED_RECOMPUTE_PROPS
;
2955 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2956 handle_overlay_change_p
= 0;
2959 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2961 /* Don't check for overlay strings below when set to deliver
2962 characters from a display vector. */
2963 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2964 handle_overlay_change_p
= 0;
2966 /* Handle overlay changes.
2967 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2968 if it finds overlays. */
2969 if (handle_overlay_change_p
)
2970 handled
= handle_overlay_change (it
);
2975 setup_for_ellipsis (it
, 0);
2979 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2981 /* Determine where to stop next. */
2982 if (handled
== HANDLED_NORMALLY
)
2983 compute_stop_pos (it
);
2987 /* Compute IT->stop_charpos from text property and overlay change
2988 information for IT's current position. */
2991 compute_stop_pos (struct it
*it
)
2993 register INTERVAL iv
, next_iv
;
2994 Lisp_Object object
, limit
, position
;
2995 EMACS_INT charpos
, bytepos
;
2997 /* If nowhere else, stop at the end. */
2998 it
->stop_charpos
= it
->end_charpos
;
3000 if (STRINGP (it
->string
))
3002 /* Strings are usually short, so don't limit the search for
3004 object
= it
->string
;
3006 charpos
= IT_STRING_CHARPOS (*it
);
3007 bytepos
= IT_STRING_BYTEPOS (*it
);
3013 /* If next overlay change is in front of the current stop pos
3014 (which is IT->end_charpos), stop there. Note: value of
3015 next_overlay_change is point-max if no overlay change
3017 charpos
= IT_CHARPOS (*it
);
3018 bytepos
= IT_BYTEPOS (*it
);
3019 pos
= next_overlay_change (charpos
);
3020 if (pos
< it
->stop_charpos
)
3021 it
->stop_charpos
= pos
;
3023 /* If showing the region, we have to stop at the region
3024 start or end because the face might change there. */
3025 if (it
->region_beg_charpos
> 0)
3027 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3028 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3029 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3030 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3033 /* Set up variables for computing the stop position from text
3034 property changes. */
3035 XSETBUFFER (object
, current_buffer
);
3036 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3039 /* Get the interval containing IT's position. Value is a null
3040 interval if there isn't such an interval. */
3041 position
= make_number (charpos
);
3042 iv
= validate_interval_range (object
, &position
, &position
, 0);
3043 if (!NULL_INTERVAL_P (iv
))
3045 Lisp_Object values_here
[LAST_PROP_IDX
];
3048 /* Get properties here. */
3049 for (p
= it_props
; p
->handler
; ++p
)
3050 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3052 /* Look for an interval following iv that has different
3054 for (next_iv
= next_interval (iv
);
3055 (!NULL_INTERVAL_P (next_iv
)
3057 || XFASTINT (limit
) > next_iv
->position
));
3058 next_iv
= next_interval (next_iv
))
3060 for (p
= it_props
; p
->handler
; ++p
)
3062 Lisp_Object new_value
;
3064 new_value
= textget (next_iv
->plist
, *p
->name
);
3065 if (!EQ (values_here
[p
->idx
], new_value
))
3073 if (!NULL_INTERVAL_P (next_iv
))
3075 if (INTEGERP (limit
)
3076 && next_iv
->position
>= XFASTINT (limit
))
3077 /* No text property change up to limit. */
3078 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3080 /* Text properties change in next_iv. */
3081 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3085 if (it
->cmp_it
.id
< 0)
3087 EMACS_INT stoppos
= it
->end_charpos
;
3089 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3091 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3092 stoppos
, it
->string
);
3095 xassert (STRINGP (it
->string
)
3096 || (it
->stop_charpos
>= BEGV
3097 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3101 /* Return the position of the next overlay change after POS in
3102 current_buffer. Value is point-max if no overlay change
3103 follows. This is like `next-overlay-change' but doesn't use
3107 next_overlay_change (EMACS_INT pos
)
3111 Lisp_Object
*overlays
;
3114 /* Get all overlays at the given position. */
3115 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3117 /* If any of these overlays ends before endpos,
3118 use its ending point instead. */
3119 for (i
= 0; i
< noverlays
; ++i
)
3124 oend
= OVERLAY_END (overlays
[i
]);
3125 oendpos
= OVERLAY_POSITION (oend
);
3126 endpos
= min (endpos
, oendpos
);
3134 /***********************************************************************
3136 ***********************************************************************/
3138 /* Handle changes in the `fontified' property of the current buffer by
3139 calling hook functions from Qfontification_functions to fontify
3142 static enum prop_handled
3143 handle_fontified_prop (struct it
*it
)
3145 Lisp_Object prop
, pos
;
3146 enum prop_handled handled
= HANDLED_NORMALLY
;
3148 if (!NILP (Vmemory_full
))
3151 /* Get the value of the `fontified' property at IT's current buffer
3152 position. (The `fontified' property doesn't have a special
3153 meaning in strings.) If the value is nil, call functions from
3154 Qfontification_functions. */
3155 if (!STRINGP (it
->string
)
3157 && !NILP (Vfontification_functions
)
3158 && !NILP (Vrun_hooks
)
3159 && (pos
= make_number (IT_CHARPOS (*it
)),
3160 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3161 /* Ignore the special cased nil value always present at EOB since
3162 no amount of fontifying will be able to change it. */
3163 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3165 int count
= SPECPDL_INDEX ();
3168 val
= Vfontification_functions
;
3169 specbind (Qfontification_functions
, Qnil
);
3171 xassert (it
->end_charpos
== ZV
);
3173 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3174 safe_call1 (val
, pos
);
3177 Lisp_Object fns
, fn
;
3178 struct gcpro gcpro1
, gcpro2
;
3183 for (; CONSP (val
); val
= XCDR (val
))
3189 /* A value of t indicates this hook has a local
3190 binding; it means to run the global binding too.
3191 In a global value, t should not occur. If it
3192 does, we must ignore it to avoid an endless
3194 for (fns
= Fdefault_value (Qfontification_functions
);
3200 safe_call1 (fn
, pos
);
3204 safe_call1 (fn
, pos
);
3210 unbind_to (count
, Qnil
);
3212 /* The fontification code may have added/removed text.
3213 It could do even a lot worse, but let's at least protect against
3214 the most obvious case where only the text past `pos' gets changed',
3215 as is/was done in grep.el where some escapes sequences are turned
3216 into face properties (bug#7876). */
3217 it
->end_charpos
= ZV
;
3219 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3220 something. This avoids an endless loop if they failed to
3221 fontify the text for which reason ever. */
3222 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3223 handled
= HANDLED_RECOMPUTE_PROPS
;
3231 /***********************************************************************
3233 ***********************************************************************/
3235 /* Set up iterator IT from face properties at its current position.
3236 Called from handle_stop. */
3238 static enum prop_handled
3239 handle_face_prop (struct it
*it
)
3242 EMACS_INT next_stop
;
3244 if (!STRINGP (it
->string
))
3247 = face_at_buffer_position (it
->w
,
3249 it
->region_beg_charpos
,
3250 it
->region_end_charpos
,
3253 + TEXT_PROP_DISTANCE_LIMIT
),
3254 0, it
->base_face_id
);
3256 /* Is this a start of a run of characters with box face?
3257 Caveat: this can be called for a freshly initialized
3258 iterator; face_id is -1 in this case. We know that the new
3259 face will not change until limit, i.e. if the new face has a
3260 box, all characters up to limit will have one. But, as
3261 usual, we don't know whether limit is really the end. */
3262 if (new_face_id
!= it
->face_id
)
3264 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3266 /* If new face has a box but old face has not, this is
3267 the start of a run of characters with box, i.e. it has
3268 a shadow on the left side. The value of face_id of the
3269 iterator will be -1 if this is the initial call that gets
3270 the face. In this case, we have to look in front of IT's
3271 position and see whether there is a face != new_face_id. */
3272 it
->start_of_box_run_p
3273 = (new_face
->box
!= FACE_NO_BOX
3274 && (it
->face_id
>= 0
3275 || IT_CHARPOS (*it
) == BEG
3276 || new_face_id
!= face_before_it_pos (it
)));
3277 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3285 Lisp_Object from_overlay
3286 = (it
->current
.overlay_string_index
>= 0
3287 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3290 /* See if we got to this string directly or indirectly from
3291 an overlay property. That includes the before-string or
3292 after-string of an overlay, strings in display properties
3293 provided by an overlay, their text properties, etc.
3295 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3296 if (! NILP (from_overlay
))
3297 for (i
= it
->sp
- 1; i
>= 0; i
--)
3299 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3301 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3302 else if (! NILP (it
->stack
[i
].from_overlay
))
3303 from_overlay
= it
->stack
[i
].from_overlay
;
3305 if (!NILP (from_overlay
))
3309 if (! NILP (from_overlay
))
3311 bufpos
= IT_CHARPOS (*it
);
3312 /* For a string from an overlay, the base face depends
3313 only on text properties and ignores overlays. */
3315 = face_for_overlay_string (it
->w
,
3317 it
->region_beg_charpos
,
3318 it
->region_end_charpos
,
3321 + TEXT_PROP_DISTANCE_LIMIT
),
3329 /* For strings from a `display' property, use the face at
3330 IT's current buffer position as the base face to merge
3331 with, so that overlay strings appear in the same face as
3332 surrounding text, unless they specify their own
3334 base_face_id
= underlying_face_id (it
);
3337 new_face_id
= face_at_string_position (it
->w
,
3339 IT_STRING_CHARPOS (*it
),
3341 it
->region_beg_charpos
,
3342 it
->region_end_charpos
,
3346 /* Is this a start of a run of characters with box? Caveat:
3347 this can be called for a freshly allocated iterator; face_id
3348 is -1 is this case. We know that the new face will not
3349 change until the next check pos, i.e. if the new face has a
3350 box, all characters up to that position will have a
3351 box. But, as usual, we don't know whether that position
3352 is really the end. */
3353 if (new_face_id
!= it
->face_id
)
3355 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3356 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3358 /* If new face has a box but old face hasn't, this is the
3359 start of a run of characters with box, i.e. it has a
3360 shadow on the left side. */
3361 it
->start_of_box_run_p
3362 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3363 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3367 it
->face_id
= new_face_id
;
3368 return HANDLED_NORMALLY
;
3372 /* Return the ID of the face ``underlying'' IT's current position,
3373 which is in a string. If the iterator is associated with a
3374 buffer, return the face at IT's current buffer position.
3375 Otherwise, use the iterator's base_face_id. */
3378 underlying_face_id (struct it
*it
)
3380 int face_id
= it
->base_face_id
, i
;
3382 xassert (STRINGP (it
->string
));
3384 for (i
= it
->sp
- 1; i
>= 0; --i
)
3385 if (NILP (it
->stack
[i
].string
))
3386 face_id
= it
->stack
[i
].face_id
;
3392 /* Compute the face one character before or after the current position
3393 of IT. BEFORE_P non-zero means get the face in front of IT's
3394 position. Value is the id of the face. */
3397 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3400 EMACS_INT next_check_charpos
;
3401 struct text_pos pos
;
3403 xassert (it
->s
== NULL
);
3405 if (STRINGP (it
->string
))
3410 /* No face change past the end of the string (for the case
3411 we are padding with spaces). No face change before the
3413 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3414 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3417 /* Set pos to the position before or after IT's current position. */
3419 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3421 /* For composition, we must check the character after the
3423 pos
= (it
->what
== IT_COMPOSITION
3424 ? string_pos (IT_STRING_CHARPOS (*it
)
3425 + it
->cmp_it
.nchars
, it
->string
)
3426 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3428 if (it
->current
.overlay_string_index
>= 0)
3429 bufpos
= IT_CHARPOS (*it
);
3433 base_face_id
= underlying_face_id (it
);
3435 /* Get the face for ASCII, or unibyte. */
3436 face_id
= face_at_string_position (it
->w
,
3440 it
->region_beg_charpos
,
3441 it
->region_end_charpos
,
3442 &next_check_charpos
,
3445 /* Correct the face for charsets different from ASCII. Do it
3446 for the multibyte case only. The face returned above is
3447 suitable for unibyte text if IT->string is unibyte. */
3448 if (STRING_MULTIBYTE (it
->string
))
3450 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3452 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3454 c
= string_char_and_length (p
, &len
);
3455 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3460 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3461 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3464 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3465 pos
= it
->current
.pos
;
3468 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3471 if (it
->what
== IT_COMPOSITION
)
3472 /* For composition, we must check the position after the
3474 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3476 INC_TEXT_POS (pos
, it
->multibyte_p
);
3479 /* Determine face for CHARSET_ASCII, or unibyte. */
3480 face_id
= face_at_buffer_position (it
->w
,
3482 it
->region_beg_charpos
,
3483 it
->region_end_charpos
,
3484 &next_check_charpos
,
3487 /* Correct the face for charsets different from ASCII. Do it
3488 for the multibyte case only. The face returned above is
3489 suitable for unibyte text if current_buffer is unibyte. */
3490 if (it
->multibyte_p
)
3492 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3493 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3494 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3503 /***********************************************************************
3505 ***********************************************************************/
3507 /* Set up iterator IT from invisible properties at its current
3508 position. Called from handle_stop. */
3510 static enum prop_handled
3511 handle_invisible_prop (struct it
*it
)
3513 enum prop_handled handled
= HANDLED_NORMALLY
;
3515 if (STRINGP (it
->string
))
3517 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3519 /* Get the value of the invisible text property at the
3520 current position. Value will be nil if there is no such
3522 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3523 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3526 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3528 handled
= HANDLED_RECOMPUTE_PROPS
;
3530 /* Get the position at which the next change of the
3531 invisible text property can be found in IT->string.
3532 Value will be nil if the property value is the same for
3533 all the rest of IT->string. */
3534 XSETINT (limit
, SCHARS (it
->string
));
3535 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3538 /* Text at current position is invisible. The next
3539 change in the property is at position end_charpos.
3540 Move IT's current position to that position. */
3541 if (INTEGERP (end_charpos
)
3542 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3544 struct text_pos old
;
3545 old
= it
->current
.string_pos
;
3546 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3547 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3551 /* The rest of the string is invisible. If this is an
3552 overlay string, proceed with the next overlay string
3553 or whatever comes and return a character from there. */
3554 if (it
->current
.overlay_string_index
>= 0)
3556 next_overlay_string (it
);
3557 /* Don't check for overlay strings when we just
3558 finished processing them. */
3559 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3563 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3564 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3572 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3573 Lisp_Object pos
, prop
, overlay
;
3575 /* First of all, is there invisible text at this position? */
3576 tem
= start_charpos
= IT_CHARPOS (*it
);
3577 pos
= make_number (tem
);
3578 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3580 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3582 /* If we are on invisible text, skip over it. */
3583 if (invis_p
&& start_charpos
< it
->end_charpos
)
3585 /* Record whether we have to display an ellipsis for the
3587 int display_ellipsis_p
= invis_p
== 2;
3589 handled
= HANDLED_RECOMPUTE_PROPS
;
3591 /* Loop skipping over invisible text. The loop is left at
3592 ZV or with IT on the first char being visible again. */
3595 /* Try to skip some invisible text. Return value is the
3596 position reached which can be equal to where we start
3597 if there is nothing invisible there. This skips both
3598 over invisible text properties and overlays with
3599 invisible property. */
3600 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3602 /* If we skipped nothing at all we weren't at invisible
3603 text in the first place. If everything to the end of
3604 the buffer was skipped, end the loop. */
3605 if (newpos
== tem
|| newpos
>= ZV
)
3609 /* We skipped some characters but not necessarily
3610 all there are. Check if we ended up on visible
3611 text. Fget_char_property returns the property of
3612 the char before the given position, i.e. if we
3613 get invis_p = 0, this means that the char at
3614 newpos is visible. */
3615 pos
= make_number (newpos
);
3616 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3617 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3620 /* If we ended up on invisible text, proceed to
3621 skip starting with next_stop. */
3625 /* If there are adjacent invisible texts, don't lose the
3626 second one's ellipsis. */
3628 display_ellipsis_p
= 1;
3632 /* The position newpos is now either ZV or on visible text. */
3633 if (it
->bidi_p
&& newpos
< ZV
)
3635 /* With bidi iteration, the region of invisible text
3636 could start and/or end in the middle of a non-base
3637 embedding level. Therefore, we need to skip
3638 invisible text using the bidi iterator, starting at
3639 IT's current position, until we find ourselves
3640 outside the invisible text. Skipping invisible text
3641 _after_ bidi iteration avoids affecting the visual
3642 order of the displayed text when invisible properties
3643 are added or removed. */
3644 if (it
->bidi_it
.first_elt
)
3646 /* If we were `reseat'ed to a new paragraph,
3647 determine the paragraph base direction. We need
3648 to do it now because next_element_from_buffer may
3649 not have a chance to do it, if we are going to
3650 skip any text at the beginning, which resets the
3652 bidi_paragraph_init (it
->paragraph_embedding
,
3657 bidi_move_to_visually_next (&it
->bidi_it
);
3659 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3660 && it
->bidi_it
.charpos
< newpos
);
3661 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3662 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3663 /* If we overstepped NEWPOS, record its position in the
3664 iterator, so that we skip invisible text if later the
3665 bidi iteration lands us in the invisible region
3667 if (IT_CHARPOS (*it
) >= newpos
)
3668 it
->prev_stop
= newpos
;
3672 IT_CHARPOS (*it
) = newpos
;
3673 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3676 /* If there are before-strings at the start of invisible
3677 text, and the text is invisible because of a text
3678 property, arrange to show before-strings because 20.x did
3679 it that way. (If the text is invisible because of an
3680 overlay property instead of a text property, this is
3681 already handled in the overlay code.) */
3683 && get_overlay_strings (it
, it
->stop_charpos
))
3685 handled
= HANDLED_RECOMPUTE_PROPS
;
3686 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3688 else if (display_ellipsis_p
)
3690 /* Make sure that the glyphs of the ellipsis will get
3691 correct `charpos' values. If we would not update
3692 it->position here, the glyphs would belong to the
3693 last visible character _before_ the invisible
3694 text, which confuses `set_cursor_from_row'.
3696 We use the last invisible position instead of the
3697 first because this way the cursor is always drawn on
3698 the first "." of the ellipsis, whenever PT is inside
3699 the invisible text. Otherwise the cursor would be
3700 placed _after_ the ellipsis when the point is after the
3701 first invisible character. */
3702 if (!STRINGP (it
->object
))
3704 it
->position
.charpos
= newpos
- 1;
3705 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3708 /* Let the ellipsis display before
3709 considering any properties of the following char.
3710 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3711 handled
= HANDLED_RETURN
;
3720 /* Make iterator IT return `...' next.
3721 Replaces LEN characters from buffer. */
3724 setup_for_ellipsis (struct it
*it
, int len
)
3726 /* Use the display table definition for `...'. Invalid glyphs
3727 will be handled by the method returning elements from dpvec. */
3728 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3730 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3731 it
->dpvec
= v
->contents
;
3732 it
->dpend
= v
->contents
+ v
->size
;
3736 /* Default `...'. */
3737 it
->dpvec
= default_invis_vector
;
3738 it
->dpend
= default_invis_vector
+ 3;
3741 it
->dpvec_char_len
= len
;
3742 it
->current
.dpvec_index
= 0;
3743 it
->dpvec_face_id
= -1;
3745 /* Remember the current face id in case glyphs specify faces.
3746 IT's face is restored in set_iterator_to_next.
3747 saved_face_id was set to preceding char's face in handle_stop. */
3748 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3749 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3751 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3757 /***********************************************************************
3759 ***********************************************************************/
3761 /* Set up iterator IT from `display' property at its current position.
3762 Called from handle_stop.
3763 We return HANDLED_RETURN if some part of the display property
3764 overrides the display of the buffer text itself.
3765 Otherwise we return HANDLED_NORMALLY. */
3767 static enum prop_handled
3768 handle_display_prop (struct it
*it
)
3770 Lisp_Object prop
, object
, overlay
;
3771 struct text_pos
*position
;
3772 /* Nonzero if some property replaces the display of the text itself. */
3773 int display_replaced_p
= 0;
3775 if (STRINGP (it
->string
))
3777 object
= it
->string
;
3778 position
= &it
->current
.string_pos
;
3782 XSETWINDOW (object
, it
->w
);
3783 position
= &it
->current
.pos
;
3786 /* Reset those iterator values set from display property values. */
3787 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3788 it
->space_width
= Qnil
;
3789 it
->font_height
= Qnil
;
3792 /* We don't support recursive `display' properties, i.e. string
3793 values that have a string `display' property, that have a string
3794 `display' property etc. */
3795 if (!it
->string_from_display_prop_p
)
3796 it
->area
= TEXT_AREA
;
3798 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3799 Qdisplay
, object
, &overlay
);
3801 return HANDLED_NORMALLY
;
3802 /* Now OVERLAY is the overlay that gave us this property, or nil
3803 if it was a text property. */
3805 if (!STRINGP (it
->string
))
3806 object
= it
->w
->buffer
;
3809 /* Simple properties. */
3810 && !EQ (XCAR (prop
), Qimage
)
3811 && !EQ (XCAR (prop
), Qspace
)
3812 && !EQ (XCAR (prop
), Qwhen
)
3813 && !EQ (XCAR (prop
), Qslice
)
3814 && !EQ (XCAR (prop
), Qspace_width
)
3815 && !EQ (XCAR (prop
), Qheight
)
3816 && !EQ (XCAR (prop
), Qraise
)
3817 /* Marginal area specifications. */
3818 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3819 && !EQ (XCAR (prop
), Qleft_fringe
)
3820 && !EQ (XCAR (prop
), Qright_fringe
)
3821 && !NILP (XCAR (prop
)))
3823 for (; CONSP (prop
); prop
= XCDR (prop
))
3825 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3826 position
, display_replaced_p
))
3828 display_replaced_p
= 1;
3829 /* If some text in a string is replaced, `position' no
3830 longer points to the position of `object'. */
3831 if (STRINGP (object
))
3836 else if (VECTORP (prop
))
3839 for (i
= 0; i
< ASIZE (prop
); ++i
)
3840 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3841 position
, display_replaced_p
))
3843 display_replaced_p
= 1;
3844 /* If some text in a string is replaced, `position' no
3845 longer points to the position of `object'. */
3846 if (STRINGP (object
))
3852 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3854 display_replaced_p
= 1;
3857 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3861 /* Value is the position of the end of the `display' property starting
3862 at START_POS in OBJECT. */
3864 static struct text_pos
3865 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3868 struct text_pos end_pos
;
3870 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3871 Qdisplay
, object
, Qnil
);
3872 CHARPOS (end_pos
) = XFASTINT (end
);
3873 if (STRINGP (object
))
3874 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3876 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3882 /* Set up IT from a single `display' specification PROP. OBJECT
3883 is the object in which the `display' property was found. *POSITION
3884 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3885 means that we previously saw a display specification which already
3886 replaced text display with something else, for example an image;
3887 we ignore such properties after the first one has been processed.
3889 OVERLAY is the overlay this `display' property came from,
3890 or nil if it was a text property.
3892 If PROP is a `space' or `image' specification, and in some other
3893 cases too, set *POSITION to the position where the `display'
3896 Value is non-zero if something was found which replaces the display
3897 of buffer or string text. */
3900 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3901 Lisp_Object overlay
, struct text_pos
*position
,
3902 int display_replaced_before_p
)
3905 Lisp_Object location
, value
;
3906 struct text_pos start_pos
, save_pos
;
3909 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3910 If the result is non-nil, use VALUE instead of SPEC. */
3912 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3921 if (!NILP (form
) && !EQ (form
, Qt
))
3923 int count
= SPECPDL_INDEX ();
3924 struct gcpro gcpro1
;
3926 /* Bind `object' to the object having the `display' property, a
3927 buffer or string. Bind `position' to the position in the
3928 object where the property was found, and `buffer-position'
3929 to the current position in the buffer. */
3930 specbind (Qobject
, object
);
3931 specbind (Qposition
, make_number (CHARPOS (*position
)));
3932 specbind (Qbuffer_position
,
3933 make_number (STRINGP (object
)
3934 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3936 form
= safe_eval (form
);
3938 unbind_to (count
, Qnil
);
3944 /* Handle `(height HEIGHT)' specifications. */
3946 && EQ (XCAR (spec
), Qheight
)
3947 && CONSP (XCDR (spec
)))
3949 if (!FRAME_WINDOW_P (it
->f
))
3952 it
->font_height
= XCAR (XCDR (spec
));
3953 if (!NILP (it
->font_height
))
3955 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3956 int new_height
= -1;
3958 if (CONSP (it
->font_height
)
3959 && (EQ (XCAR (it
->font_height
), Qplus
)
3960 || EQ (XCAR (it
->font_height
), Qminus
))
3961 && CONSP (XCDR (it
->font_height
))
3962 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3964 /* `(+ N)' or `(- N)' where N is an integer. */
3965 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3966 if (EQ (XCAR (it
->font_height
), Qplus
))
3968 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3970 else if (FUNCTIONP (it
->font_height
))
3972 /* Call function with current height as argument.
3973 Value is the new height. */
3975 height
= safe_call1 (it
->font_height
,
3976 face
->lface
[LFACE_HEIGHT_INDEX
]);
3977 if (NUMBERP (height
))
3978 new_height
= XFLOATINT (height
);
3980 else if (NUMBERP (it
->font_height
))
3982 /* Value is a multiple of the canonical char height. */
3985 f
= FACE_FROM_ID (it
->f
,
3986 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3987 new_height
= (XFLOATINT (it
->font_height
)
3988 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
3992 /* Evaluate IT->font_height with `height' bound to the
3993 current specified height to get the new height. */
3994 int count
= SPECPDL_INDEX ();
3996 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3997 value
= safe_eval (it
->font_height
);
3998 unbind_to (count
, Qnil
);
4000 if (NUMBERP (value
))
4001 new_height
= XFLOATINT (value
);
4005 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4011 /* Handle `(space-width WIDTH)'. */
4013 && EQ (XCAR (spec
), Qspace_width
)
4014 && CONSP (XCDR (spec
)))
4016 if (!FRAME_WINDOW_P (it
->f
))
4019 value
= XCAR (XCDR (spec
));
4020 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4021 it
->space_width
= value
;
4026 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4028 && EQ (XCAR (spec
), Qslice
))
4032 if (!FRAME_WINDOW_P (it
->f
))
4035 if (tem
= XCDR (spec
), CONSP (tem
))
4037 it
->slice
.x
= XCAR (tem
);
4038 if (tem
= XCDR (tem
), CONSP (tem
))
4040 it
->slice
.y
= XCAR (tem
);
4041 if (tem
= XCDR (tem
), CONSP (tem
))
4043 it
->slice
.width
= XCAR (tem
);
4044 if (tem
= XCDR (tem
), CONSP (tem
))
4045 it
->slice
.height
= XCAR (tem
);
4053 /* Handle `(raise FACTOR)'. */
4055 && EQ (XCAR (spec
), Qraise
)
4056 && CONSP (XCDR (spec
)))
4058 if (!FRAME_WINDOW_P (it
->f
))
4061 #ifdef HAVE_WINDOW_SYSTEM
4062 value
= XCAR (XCDR (spec
));
4063 if (NUMBERP (value
))
4065 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4066 it
->voffset
= - (XFLOATINT (value
)
4067 * (FONT_HEIGHT (face
->font
)));
4069 #endif /* HAVE_WINDOW_SYSTEM */
4074 /* Don't handle the other kinds of display specifications
4075 inside a string that we got from a `display' property. */
4076 if (it
->string_from_display_prop_p
)
4079 /* Characters having this form of property are not displayed, so
4080 we have to find the end of the property. */
4081 start_pos
= *position
;
4082 *position
= display_prop_end (it
, object
, start_pos
);
4085 /* Stop the scan at that end position--we assume that all
4086 text properties change there. */
4087 it
->stop_charpos
= position
->charpos
;
4089 /* Handle `(left-fringe BITMAP [FACE])'
4090 and `(right-fringe BITMAP [FACE])'. */
4092 && (EQ (XCAR (spec
), Qleft_fringe
)
4093 || EQ (XCAR (spec
), Qright_fringe
))
4094 && CONSP (XCDR (spec
)))
4096 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4099 if (!FRAME_WINDOW_P (it
->f
))
4100 /* If we return here, POSITION has been advanced
4101 across the text with this property. */
4104 #ifdef HAVE_WINDOW_SYSTEM
4105 value
= XCAR (XCDR (spec
));
4106 if (!SYMBOLP (value
)
4107 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4108 /* If we return here, POSITION has been advanced
4109 across the text with this property. */
4112 if (CONSP (XCDR (XCDR (spec
))))
4114 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4115 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4121 /* Save current settings of IT so that we can restore them
4122 when we are finished with the glyph property value. */
4124 save_pos
= it
->position
;
4125 it
->position
= *position
;
4127 it
->position
= save_pos
;
4129 it
->area
= TEXT_AREA
;
4130 it
->what
= IT_IMAGE
;
4131 it
->image_id
= -1; /* no image */
4132 it
->position
= start_pos
;
4133 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4134 it
->method
= GET_FROM_IMAGE
;
4135 it
->from_overlay
= Qnil
;
4136 it
->face_id
= face_id
;
4138 /* Say that we haven't consumed the characters with
4139 `display' property yet. The call to pop_it in
4140 set_iterator_to_next will clean this up. */
4141 *position
= start_pos
;
4143 if (EQ (XCAR (spec
), Qleft_fringe
))
4145 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4146 it
->left_user_fringe_face_id
= face_id
;
4150 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4151 it
->right_user_fringe_face_id
= face_id
;
4153 #endif /* HAVE_WINDOW_SYSTEM */
4157 /* Prepare to handle `((margin left-margin) ...)',
4158 `((margin right-margin) ...)' and `((margin nil) ...)'
4159 prefixes for display specifications. */
4160 location
= Qunbound
;
4161 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4165 value
= XCDR (spec
);
4167 value
= XCAR (value
);
4170 if (EQ (XCAR (tem
), Qmargin
)
4171 && (tem
= XCDR (tem
),
4172 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4174 || EQ (tem
, Qleft_margin
)
4175 || EQ (tem
, Qright_margin
))))
4179 if (EQ (location
, Qunbound
))
4185 /* After this point, VALUE is the property after any
4186 margin prefix has been stripped. It must be a string,
4187 an image specification, or `(space ...)'.
4189 LOCATION specifies where to display: `left-margin',
4190 `right-margin' or nil. */
4192 valid_p
= (STRINGP (value
)
4193 #ifdef HAVE_WINDOW_SYSTEM
4194 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4195 #endif /* not HAVE_WINDOW_SYSTEM */
4196 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4198 if (valid_p
&& !display_replaced_before_p
)
4200 /* Save current settings of IT so that we can restore them
4201 when we are finished with the glyph property value. */
4202 save_pos
= it
->position
;
4203 it
->position
= *position
;
4205 it
->position
= save_pos
;
4206 it
->from_overlay
= overlay
;
4208 if (NILP (location
))
4209 it
->area
= TEXT_AREA
;
4210 else if (EQ (location
, Qleft_margin
))
4211 it
->area
= LEFT_MARGIN_AREA
;
4213 it
->area
= RIGHT_MARGIN_AREA
;
4215 if (STRINGP (value
))
4218 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4219 it
->current
.overlay_string_index
= -1;
4220 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4221 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4222 it
->method
= GET_FROM_STRING
;
4223 it
->stop_charpos
= 0;
4224 it
->string_from_display_prop_p
= 1;
4225 /* Say that we haven't consumed the characters with
4226 `display' property yet. The call to pop_it in
4227 set_iterator_to_next will clean this up. */
4228 if (BUFFERP (object
))
4229 *position
= start_pos
;
4231 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4233 it
->method
= GET_FROM_STRETCH
;
4235 *position
= it
->position
= start_pos
;
4237 #ifdef HAVE_WINDOW_SYSTEM
4240 it
->what
= IT_IMAGE
;
4241 it
->image_id
= lookup_image (it
->f
, value
);
4242 it
->position
= start_pos
;
4243 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4244 it
->method
= GET_FROM_IMAGE
;
4246 /* Say that we haven't consumed the characters with
4247 `display' property yet. The call to pop_it in
4248 set_iterator_to_next will clean this up. */
4249 *position
= start_pos
;
4251 #endif /* HAVE_WINDOW_SYSTEM */
4256 /* Invalid property or property not supported. Restore
4257 POSITION to what it was before. */
4258 *position
= start_pos
;
4263 /* Check if SPEC is a display sub-property value whose text should be
4264 treated as intangible. */
4267 single_display_spec_intangible_p (Lisp_Object prop
)
4269 /* Skip over `when FORM'. */
4270 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4284 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4285 we don't need to treat text as intangible. */
4286 if (EQ (XCAR (prop
), Qmargin
))
4294 || EQ (XCAR (prop
), Qleft_margin
)
4295 || EQ (XCAR (prop
), Qright_margin
))
4299 return (CONSP (prop
)
4300 && (EQ (XCAR (prop
), Qimage
)
4301 || EQ (XCAR (prop
), Qspace
)));
4305 /* Check if PROP is a display property value whose text should be
4306 treated as intangible. */
4309 display_prop_intangible_p (Lisp_Object prop
)
4312 && CONSP (XCAR (prop
))
4313 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4315 /* A list of sub-properties. */
4316 while (CONSP (prop
))
4318 if (single_display_spec_intangible_p (XCAR (prop
)))
4323 else if (VECTORP (prop
))
4325 /* A vector of sub-properties. */
4327 for (i
= 0; i
< ASIZE (prop
); ++i
)
4328 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4332 return single_display_spec_intangible_p (prop
);
4338 /* Return 1 if PROP is a display sub-property value containing STRING. */
4341 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4343 if (EQ (string
, prop
))
4346 /* Skip over `when FORM'. */
4347 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4356 /* Skip over `margin LOCATION'. */
4357 if (EQ (XCAR (prop
), Qmargin
))
4368 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4372 /* Return 1 if STRING appears in the `display' property PROP. */
4375 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4378 && CONSP (XCAR (prop
))
4379 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4381 /* A list of sub-properties. */
4382 while (CONSP (prop
))
4384 if (single_display_spec_string_p (XCAR (prop
), string
))
4389 else if (VECTORP (prop
))
4391 /* A vector of sub-properties. */
4393 for (i
= 0; i
< ASIZE (prop
); ++i
)
4394 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4398 return single_display_spec_string_p (prop
, string
);
4403 /* Look for STRING in overlays and text properties in W's buffer,
4404 between character positions FROM and TO (excluding TO).
4405 BACK_P non-zero means look back (in this case, TO is supposed to be
4407 Value is the first character position where STRING was found, or
4408 zero if it wasn't found before hitting TO.
4410 W's buffer must be current.
4412 This function may only use code that doesn't eval because it is
4413 called asynchronously from note_mouse_highlight. */
4416 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4417 EMACS_INT from
, EMACS_INT to
, int back_p
)
4419 Lisp_Object limit
, prop
, pos
;
4422 pos
= make_number (from
);
4424 if (!back_p
) /* looking forward */
4426 limit
= make_number (min (to
, ZV
));
4427 while (!found
&& !EQ (pos
, limit
))
4429 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4430 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4433 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4437 else /* looking back */
4439 limit
= make_number (max (to
, BEGV
));
4440 while (!found
&& !EQ (pos
, limit
))
4442 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4443 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4446 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4451 return found
? XINT (pos
) : 0;
4454 /* Determine which buffer position in W's buffer STRING comes from.
4455 AROUND_CHARPOS is an approximate position where it could come from.
4456 Value is the buffer position or 0 if it couldn't be determined.
4458 W's buffer must be current.
4460 This function is necessary because we don't record buffer positions
4461 in glyphs generated from strings (to keep struct glyph small).
4462 This function may only use code that doesn't eval because it is
4463 called asynchronously from note_mouse_highlight. */
4466 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4468 const int MAX_DISTANCE
= 1000;
4469 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4470 around_charpos
+ MAX_DISTANCE
,
4474 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4475 around_charpos
- MAX_DISTANCE
, 1);
4481 /***********************************************************************
4482 `composition' property
4483 ***********************************************************************/
4485 /* Set up iterator IT from `composition' property at its current
4486 position. Called from handle_stop. */
4488 static enum prop_handled
4489 handle_composition_prop (struct it
*it
)
4491 Lisp_Object prop
, string
;
4492 EMACS_INT pos
, pos_byte
, start
, end
;
4494 if (STRINGP (it
->string
))
4498 pos
= IT_STRING_CHARPOS (*it
);
4499 pos_byte
= IT_STRING_BYTEPOS (*it
);
4500 string
= it
->string
;
4501 s
= SDATA (string
) + pos_byte
;
4502 it
->c
= STRING_CHAR (s
);
4506 pos
= IT_CHARPOS (*it
);
4507 pos_byte
= IT_BYTEPOS (*it
);
4509 it
->c
= FETCH_CHAR (pos_byte
);
4512 /* If there's a valid composition and point is not inside of the
4513 composition (in the case that the composition is from the current
4514 buffer), draw a glyph composed from the composition components. */
4515 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4516 && COMPOSITION_VALID_P (start
, end
, prop
)
4517 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4521 if (STRINGP (it
->string
))
4522 pos_byte
= string_char_to_byte (it
->string
, start
);
4524 pos_byte
= CHAR_TO_BYTE (start
);
4526 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4529 if (it
->cmp_it
.id
>= 0)
4532 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4533 it
->cmp_it
.nglyphs
= -1;
4537 return HANDLED_NORMALLY
;
4542 /***********************************************************************
4544 ***********************************************************************/
4546 /* The following structure is used to record overlay strings for
4547 later sorting in load_overlay_strings. */
4549 struct overlay_entry
4551 Lisp_Object overlay
;
4558 /* Set up iterator IT from overlay strings at its current position.
4559 Called from handle_stop. */
4561 static enum prop_handled
4562 handle_overlay_change (struct it
*it
)
4564 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4565 return HANDLED_RECOMPUTE_PROPS
;
4567 return HANDLED_NORMALLY
;
4571 /* Set up the next overlay string for delivery by IT, if there is an
4572 overlay string to deliver. Called by set_iterator_to_next when the
4573 end of the current overlay string is reached. If there are more
4574 overlay strings to display, IT->string and
4575 IT->current.overlay_string_index are set appropriately here.
4576 Otherwise IT->string is set to nil. */
4579 next_overlay_string (struct it
*it
)
4581 ++it
->current
.overlay_string_index
;
4582 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4584 /* No more overlay strings. Restore IT's settings to what
4585 they were before overlay strings were processed, and
4586 continue to deliver from current_buffer. */
4588 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4591 || (NILP (it
->string
)
4592 && it
->method
== GET_FROM_BUFFER
4593 && it
->stop_charpos
>= BEGV
4594 && it
->stop_charpos
<= it
->end_charpos
));
4595 it
->current
.overlay_string_index
= -1;
4596 it
->n_overlay_strings
= 0;
4597 it
->overlay_strings_charpos
= -1;
4599 /* If we're at the end of the buffer, record that we have
4600 processed the overlay strings there already, so that
4601 next_element_from_buffer doesn't try it again. */
4602 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4603 it
->overlay_strings_at_end_processed_p
= 1;
4607 /* There are more overlay strings to process. If
4608 IT->current.overlay_string_index has advanced to a position
4609 where we must load IT->overlay_strings with more strings, do
4610 it. We must load at the IT->overlay_strings_charpos where
4611 IT->n_overlay_strings was originally computed; when invisible
4612 text is present, this might not be IT_CHARPOS (Bug#7016). */
4613 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4615 if (it
->current
.overlay_string_index
&& i
== 0)
4616 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4618 /* Initialize IT to deliver display elements from the overlay
4620 it
->string
= it
->overlay_strings
[i
];
4621 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4622 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4623 it
->method
= GET_FROM_STRING
;
4624 it
->stop_charpos
= 0;
4625 if (it
->cmp_it
.stop_pos
>= 0)
4626 it
->cmp_it
.stop_pos
= 0;
4633 /* Compare two overlay_entry structures E1 and E2. Used as a
4634 comparison function for qsort in load_overlay_strings. Overlay
4635 strings for the same position are sorted so that
4637 1. All after-strings come in front of before-strings, except
4638 when they come from the same overlay.
4640 2. Within after-strings, strings are sorted so that overlay strings
4641 from overlays with higher priorities come first.
4643 2. Within before-strings, strings are sorted so that overlay
4644 strings from overlays with higher priorities come last.
4646 Value is analogous to strcmp. */
4650 compare_overlay_entries (const void *e1
, const void *e2
)
4652 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4653 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4656 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4658 /* Let after-strings appear in front of before-strings if
4659 they come from different overlays. */
4660 if (EQ (entry1
->overlay
, entry2
->overlay
))
4661 result
= entry1
->after_string_p
? 1 : -1;
4663 result
= entry1
->after_string_p
? -1 : 1;
4665 else if (entry1
->after_string_p
)
4666 /* After-strings sorted in order of decreasing priority. */
4667 result
= entry2
->priority
- entry1
->priority
;
4669 /* Before-strings sorted in order of increasing priority. */
4670 result
= entry1
->priority
- entry2
->priority
;
4676 /* Load the vector IT->overlay_strings with overlay strings from IT's
4677 current buffer position, or from CHARPOS if that is > 0. Set
4678 IT->n_overlays to the total number of overlay strings found.
4680 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4681 a time. On entry into load_overlay_strings,
4682 IT->current.overlay_string_index gives the number of overlay
4683 strings that have already been loaded by previous calls to this
4686 IT->add_overlay_start contains an additional overlay start
4687 position to consider for taking overlay strings from, if non-zero.
4688 This position comes into play when the overlay has an `invisible'
4689 property, and both before and after-strings. When we've skipped to
4690 the end of the overlay, because of its `invisible' property, we
4691 nevertheless want its before-string to appear.
4692 IT->add_overlay_start will contain the overlay start position
4695 Overlay strings are sorted so that after-string strings come in
4696 front of before-string strings. Within before and after-strings,
4697 strings are sorted by overlay priority. See also function
4698 compare_overlay_entries. */
4701 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4703 Lisp_Object overlay
, window
, str
, invisible
;
4704 struct Lisp_Overlay
*ov
;
4705 EMACS_INT start
, end
;
4707 int n
= 0, i
, j
, invis_p
;
4708 struct overlay_entry
*entries
4709 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4712 charpos
= IT_CHARPOS (*it
);
4714 /* Append the overlay string STRING of overlay OVERLAY to vector
4715 `entries' which has size `size' and currently contains `n'
4716 elements. AFTER_P non-zero means STRING is an after-string of
4718 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4721 Lisp_Object priority; \
4725 int new_size = 2 * size; \
4726 struct overlay_entry *old = entries; \
4728 (struct overlay_entry *) alloca (new_size \
4729 * sizeof *entries); \
4730 memcpy (entries, old, size * sizeof *entries); \
4734 entries[n].string = (STRING); \
4735 entries[n].overlay = (OVERLAY); \
4736 priority = Foverlay_get ((OVERLAY), Qpriority); \
4737 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4738 entries[n].after_string_p = (AFTER_P); \
4743 /* Process overlay before the overlay center. */
4744 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4746 XSETMISC (overlay
, ov
);
4747 xassert (OVERLAYP (overlay
));
4748 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4749 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4754 /* Skip this overlay if it doesn't start or end at IT's current
4756 if (end
!= charpos
&& start
!= charpos
)
4759 /* Skip this overlay if it doesn't apply to IT->w. */
4760 window
= Foverlay_get (overlay
, Qwindow
);
4761 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4764 /* If the text ``under'' the overlay is invisible, both before-
4765 and after-strings from this overlay are visible; start and
4766 end position are indistinguishable. */
4767 invisible
= Foverlay_get (overlay
, Qinvisible
);
4768 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4770 /* If overlay has a non-empty before-string, record it. */
4771 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4772 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4774 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4776 /* If overlay has a non-empty after-string, record it. */
4777 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4778 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4780 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4783 /* Process overlays after the overlay center. */
4784 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4786 XSETMISC (overlay
, ov
);
4787 xassert (OVERLAYP (overlay
));
4788 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4789 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4791 if (start
> charpos
)
4794 /* Skip this overlay if it doesn't start or end at IT's current
4796 if (end
!= charpos
&& start
!= charpos
)
4799 /* Skip this overlay if it doesn't apply to IT->w. */
4800 window
= Foverlay_get (overlay
, Qwindow
);
4801 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4804 /* If the text ``under'' the overlay is invisible, it has a zero
4805 dimension, and both before- and after-strings apply. */
4806 invisible
= Foverlay_get (overlay
, Qinvisible
);
4807 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4809 /* If overlay has a non-empty before-string, record it. */
4810 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4811 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4813 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4815 /* If overlay has a non-empty after-string, record it. */
4816 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4817 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4819 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4822 #undef RECORD_OVERLAY_STRING
4826 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4828 /* Record number of overlay strings, and where we computed it. */
4829 it
->n_overlay_strings
= n
;
4830 it
->overlay_strings_charpos
= charpos
;
4832 /* IT->current.overlay_string_index is the number of overlay strings
4833 that have already been consumed by IT. Copy some of the
4834 remaining overlay strings to IT->overlay_strings. */
4836 j
= it
->current
.overlay_string_index
;
4837 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4839 it
->overlay_strings
[i
] = entries
[j
].string
;
4840 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4847 /* Get the first chunk of overlay strings at IT's current buffer
4848 position, or at CHARPOS if that is > 0. Value is non-zero if at
4849 least one overlay string was found. */
4852 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4854 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4855 process. This fills IT->overlay_strings with strings, and sets
4856 IT->n_overlay_strings to the total number of strings to process.
4857 IT->pos.overlay_string_index has to be set temporarily to zero
4858 because load_overlay_strings needs this; it must be set to -1
4859 when no overlay strings are found because a zero value would
4860 indicate a position in the first overlay string. */
4861 it
->current
.overlay_string_index
= 0;
4862 load_overlay_strings (it
, charpos
);
4864 /* If we found overlay strings, set up IT to deliver display
4865 elements from the first one. Otherwise set up IT to deliver
4866 from current_buffer. */
4867 if (it
->n_overlay_strings
)
4869 /* Make sure we know settings in current_buffer, so that we can
4870 restore meaningful values when we're done with the overlay
4873 compute_stop_pos (it
);
4874 xassert (it
->face_id
>= 0);
4876 /* Save IT's settings. They are restored after all overlay
4877 strings have been processed. */
4878 xassert (!compute_stop_p
|| it
->sp
== 0);
4880 /* When called from handle_stop, there might be an empty display
4881 string loaded. In that case, don't bother saving it. */
4882 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4885 /* Set up IT to deliver display elements from the first overlay
4887 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4888 it
->string
= it
->overlay_strings
[0];
4889 it
->from_overlay
= Qnil
;
4890 it
->stop_charpos
= 0;
4891 xassert (STRINGP (it
->string
));
4892 it
->end_charpos
= SCHARS (it
->string
);
4893 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4894 it
->method
= GET_FROM_STRING
;
4898 it
->current
.overlay_string_index
= -1;
4903 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4906 it
->method
= GET_FROM_BUFFER
;
4908 (void) get_overlay_strings_1 (it
, charpos
, 1);
4912 /* Value is non-zero if we found at least one overlay string. */
4913 return STRINGP (it
->string
);
4918 /***********************************************************************
4919 Saving and restoring state
4920 ***********************************************************************/
4922 /* Save current settings of IT on IT->stack. Called, for example,
4923 before setting up IT for an overlay string, to be able to restore
4924 IT's settings to what they were after the overlay string has been
4928 push_it (struct it
*it
)
4930 struct iterator_stack_entry
*p
;
4932 xassert (it
->sp
< IT_STACK_SIZE
);
4933 p
= it
->stack
+ it
->sp
;
4935 p
->stop_charpos
= it
->stop_charpos
;
4936 p
->prev_stop
= it
->prev_stop
;
4937 p
->base_level_stop
= it
->base_level_stop
;
4938 p
->cmp_it
= it
->cmp_it
;
4939 xassert (it
->face_id
>= 0);
4940 p
->face_id
= it
->face_id
;
4941 p
->string
= it
->string
;
4942 p
->method
= it
->method
;
4943 p
->from_overlay
= it
->from_overlay
;
4946 case GET_FROM_IMAGE
:
4947 p
->u
.image
.object
= it
->object
;
4948 p
->u
.image
.image_id
= it
->image_id
;
4949 p
->u
.image
.slice
= it
->slice
;
4951 case GET_FROM_STRETCH
:
4952 p
->u
.stretch
.object
= it
->object
;
4955 p
->position
= it
->position
;
4956 p
->current
= it
->current
;
4957 p
->end_charpos
= it
->end_charpos
;
4958 p
->string_nchars
= it
->string_nchars
;
4960 p
->multibyte_p
= it
->multibyte_p
;
4961 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4962 p
->space_width
= it
->space_width
;
4963 p
->font_height
= it
->font_height
;
4964 p
->voffset
= it
->voffset
;
4965 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4966 p
->display_ellipsis_p
= 0;
4967 p
->line_wrap
= it
->line_wrap
;
4972 iterate_out_of_display_property (struct it
*it
)
4974 /* Maybe initialize paragraph direction. If we are at the beginning
4975 of a new paragraph, next_element_from_buffer may not have a
4976 chance to do that. */
4977 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4978 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4979 /* prev_stop can be zero, so check against BEGV as well. */
4980 while (it
->bidi_it
.charpos
>= BEGV
4981 && it
->prev_stop
<= it
->bidi_it
.charpos
4982 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4983 bidi_move_to_visually_next (&it
->bidi_it
);
4984 /* Record the stop_pos we just crossed, for when we cross it
4986 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4987 it
->prev_stop
= CHARPOS (it
->position
);
4988 /* If we ended up not where pop_it put us, resync IT's
4989 positional members with the bidi iterator. */
4990 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
4992 SET_TEXT_POS (it
->position
,
4993 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
4994 it
->current
.pos
= it
->position
;
4998 /* Restore IT's settings from IT->stack. Called, for example, when no
4999 more overlay strings must be processed, and we return to delivering
5000 display elements from a buffer, or when the end of a string from a
5001 `display' property is reached and we return to delivering display
5002 elements from an overlay string, or from a buffer. */
5005 pop_it (struct it
*it
)
5007 struct iterator_stack_entry
*p
;
5009 xassert (it
->sp
> 0);
5011 p
= it
->stack
+ it
->sp
;
5012 it
->stop_charpos
= p
->stop_charpos
;
5013 it
->prev_stop
= p
->prev_stop
;
5014 it
->base_level_stop
= p
->base_level_stop
;
5015 it
->cmp_it
= p
->cmp_it
;
5016 it
->face_id
= p
->face_id
;
5017 it
->current
= p
->current
;
5018 it
->position
= p
->position
;
5019 it
->string
= p
->string
;
5020 it
->from_overlay
= p
->from_overlay
;
5021 if (NILP (it
->string
))
5022 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5023 it
->method
= p
->method
;
5026 case GET_FROM_IMAGE
:
5027 it
->image_id
= p
->u
.image
.image_id
;
5028 it
->object
= p
->u
.image
.object
;
5029 it
->slice
= p
->u
.image
.slice
;
5031 case GET_FROM_STRETCH
:
5032 it
->object
= p
->u
.comp
.object
;
5034 case GET_FROM_BUFFER
:
5035 it
->object
= it
->w
->buffer
;
5038 /* Bidi-iterate until we get out of the portion of text, if
5039 any, covered by a `display' text property or an overlay
5040 with `display' property. (We cannot just jump there,
5041 because the internal coherency of the bidi iterator state
5042 can not be preserved across such jumps.) We also must
5043 determine the paragraph base direction if the overlay we
5044 just processed is at the beginning of a new
5046 iterate_out_of_display_property (it
);
5049 case GET_FROM_STRING
:
5050 it
->object
= it
->string
;
5052 case GET_FROM_DISPLAY_VECTOR
:
5054 it
->method
= GET_FROM_C_STRING
;
5055 else if (STRINGP (it
->string
))
5056 it
->method
= GET_FROM_STRING
;
5059 it
->method
= GET_FROM_BUFFER
;
5060 it
->object
= it
->w
->buffer
;
5063 it
->end_charpos
= p
->end_charpos
;
5064 it
->string_nchars
= p
->string_nchars
;
5066 it
->multibyte_p
= p
->multibyte_p
;
5067 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5068 it
->space_width
= p
->space_width
;
5069 it
->font_height
= p
->font_height
;
5070 it
->voffset
= p
->voffset
;
5071 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5072 it
->line_wrap
= p
->line_wrap
;
5077 /***********************************************************************
5079 ***********************************************************************/
5081 /* Set IT's current position to the previous line start. */
5084 back_to_previous_line_start (struct it
*it
)
5086 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5087 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5091 /* Move IT to the next line start.
5093 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5094 we skipped over part of the text (as opposed to moving the iterator
5095 continuously over the text). Otherwise, don't change the value
5098 Newlines may come from buffer text, overlay strings, or strings
5099 displayed via the `display' property. That's the reason we can't
5100 simply use find_next_newline_no_quit.
5102 Note that this function may not skip over invisible text that is so
5103 because of text properties and immediately follows a newline. If
5104 it would, function reseat_at_next_visible_line_start, when called
5105 from set_iterator_to_next, would effectively make invisible
5106 characters following a newline part of the wrong glyph row, which
5107 leads to wrong cursor motion. */
5110 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5112 int old_selective
, newline_found_p
, n
;
5113 const int MAX_NEWLINE_DISTANCE
= 500;
5115 /* If already on a newline, just consume it to avoid unintended
5116 skipping over invisible text below. */
5117 if (it
->what
== IT_CHARACTER
5119 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5121 set_iterator_to_next (it
, 0);
5126 /* Don't handle selective display in the following. It's (a)
5127 unnecessary because it's done by the caller, and (b) leads to an
5128 infinite recursion because next_element_from_ellipsis indirectly
5129 calls this function. */
5130 old_selective
= it
->selective
;
5133 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5134 from buffer text. */
5135 for (n
= newline_found_p
= 0;
5136 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5137 n
+= STRINGP (it
->string
) ? 0 : 1)
5139 if (!get_next_display_element (it
))
5141 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5142 set_iterator_to_next (it
, 0);
5145 /* If we didn't find a newline near enough, see if we can use a
5147 if (!newline_found_p
)
5149 EMACS_INT start
= IT_CHARPOS (*it
);
5150 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5153 xassert (!STRINGP (it
->string
));
5155 /* If there isn't any `display' property in sight, and no
5156 overlays, we can just use the position of the newline in
5158 if (it
->stop_charpos
>= limit
5159 || ((pos
= Fnext_single_property_change (make_number (start
),
5161 Qnil
, make_number (limit
)),
5163 && next_overlay_change (start
) == ZV
))
5165 IT_CHARPOS (*it
) = limit
;
5166 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5167 *skipped_p
= newline_found_p
= 1;
5171 while (get_next_display_element (it
)
5172 && !newline_found_p
)
5174 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5175 set_iterator_to_next (it
, 0);
5180 it
->selective
= old_selective
;
5181 return newline_found_p
;
5185 /* Set IT's current position to the previous visible line start. Skip
5186 invisible text that is so either due to text properties or due to
5187 selective display. Caution: this does not change IT->current_x and
5191 back_to_previous_visible_line_start (struct it
*it
)
5193 while (IT_CHARPOS (*it
) > BEGV
)
5195 back_to_previous_line_start (it
);
5197 if (IT_CHARPOS (*it
) <= BEGV
)
5200 /* If selective > 0, then lines indented more than its value are
5202 if (it
->selective
> 0
5203 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5204 (double) it
->selective
)) /* iftc */
5207 /* Check the newline before point for invisibility. */
5210 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5211 Qinvisible
, it
->window
);
5212 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5216 if (IT_CHARPOS (*it
) <= BEGV
)
5223 Lisp_Object val
, overlay
;
5225 /* If newline is part of a composition, continue from start of composition */
5226 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5227 && beg
< IT_CHARPOS (*it
))
5230 /* If newline is replaced by a display property, find start of overlay
5231 or interval and continue search from that point. */
5233 pos
= --IT_CHARPOS (it2
);
5236 it2
.string_from_display_prop_p
= 0;
5237 if (handle_display_prop (&it2
) == HANDLED_RETURN
5238 && !NILP (val
= get_char_property_and_overlay
5239 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5240 && (OVERLAYP (overlay
)
5241 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5242 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5245 /* Newline is not replaced by anything -- so we are done. */
5251 IT_CHARPOS (*it
) = beg
;
5252 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5256 it
->continuation_lines_width
= 0;
5258 xassert (IT_CHARPOS (*it
) >= BEGV
);
5259 xassert (IT_CHARPOS (*it
) == BEGV
5260 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5265 /* Reseat iterator IT at the previous visible line start. Skip
5266 invisible text that is so either due to text properties or due to
5267 selective display. At the end, update IT's overlay information,
5268 face information etc. */
5271 reseat_at_previous_visible_line_start (struct it
*it
)
5273 back_to_previous_visible_line_start (it
);
5274 reseat (it
, it
->current
.pos
, 1);
5279 /* Reseat iterator IT on the next visible line start in the current
5280 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5281 preceding the line start. Skip over invisible text that is so
5282 because of selective display. Compute faces, overlays etc at the
5283 new position. Note that this function does not skip over text that
5284 is invisible because of text properties. */
5287 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5289 int newline_found_p
, skipped_p
= 0;
5291 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5293 /* Skip over lines that are invisible because they are indented
5294 more than the value of IT->selective. */
5295 if (it
->selective
> 0)
5296 while (IT_CHARPOS (*it
) < ZV
5297 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5298 (double) it
->selective
)) /* iftc */
5300 xassert (IT_BYTEPOS (*it
) == BEGV
5301 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5302 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5305 /* Position on the newline if that's what's requested. */
5306 if (on_newline_p
&& newline_found_p
)
5308 if (STRINGP (it
->string
))
5310 if (IT_STRING_CHARPOS (*it
) > 0)
5312 --IT_STRING_CHARPOS (*it
);
5313 --IT_STRING_BYTEPOS (*it
);
5316 else if (IT_CHARPOS (*it
) > BEGV
)
5320 reseat (it
, it
->current
.pos
, 0);
5324 reseat (it
, it
->current
.pos
, 0);
5331 /***********************************************************************
5332 Changing an iterator's position
5333 ***********************************************************************/
5335 /* Change IT's current position to POS in current_buffer. If FORCE_P
5336 is non-zero, always check for text properties at the new position.
5337 Otherwise, text properties are only looked up if POS >=
5338 IT->check_charpos of a property. */
5341 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5343 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5345 reseat_1 (it
, pos
, 0);
5347 /* Determine where to check text properties. Avoid doing it
5348 where possible because text property lookup is very expensive. */
5350 || CHARPOS (pos
) > it
->stop_charpos
5351 || CHARPOS (pos
) < original_pos
)
5355 /* For bidi iteration, we need to prime prev_stop and
5356 base_level_stop with our best estimations. */
5357 if (CHARPOS (pos
) < it
->prev_stop
)
5359 handle_stop_backwards (it
, BEGV
);
5360 if (CHARPOS (pos
) < it
->base_level_stop
)
5361 it
->base_level_stop
= 0;
5363 else if (CHARPOS (pos
) > it
->stop_charpos
5364 && it
->stop_charpos
>= BEGV
)
5365 handle_stop_backwards (it
, it
->stop_charpos
);
5372 it
->prev_stop
= it
->base_level_stop
= 0;
5381 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5382 IT->stop_pos to POS, also. */
5385 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5387 /* Don't call this function when scanning a C string. */
5388 xassert (it
->s
== NULL
);
5390 /* POS must be a reasonable value. */
5391 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5393 it
->current
.pos
= it
->position
= pos
;
5394 it
->end_charpos
= ZV
;
5396 it
->current
.dpvec_index
= -1;
5397 it
->current
.overlay_string_index
= -1;
5398 IT_STRING_CHARPOS (*it
) = -1;
5399 IT_STRING_BYTEPOS (*it
) = -1;
5401 it
->string_from_display_prop_p
= 0;
5402 it
->method
= GET_FROM_BUFFER
;
5403 it
->object
= it
->w
->buffer
;
5404 it
->area
= TEXT_AREA
;
5405 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5407 it
->string_from_display_prop_p
= 0;
5408 it
->face_before_selective_p
= 0;
5411 it
->bidi_it
.first_elt
= 1;
5412 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5417 it
->stop_charpos
= CHARPOS (pos
);
5418 it
->base_level_stop
= CHARPOS (pos
);
5423 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5424 If S is non-null, it is a C string to iterate over. Otherwise,
5425 STRING gives a Lisp string to iterate over.
5427 If PRECISION > 0, don't return more then PRECISION number of
5428 characters from the string.
5430 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5431 characters have been returned. FIELD_WIDTH < 0 means an infinite
5434 MULTIBYTE = 0 means disable processing of multibyte characters,
5435 MULTIBYTE > 0 means enable it,
5436 MULTIBYTE < 0 means use IT->multibyte_p.
5438 IT must be initialized via a prior call to init_iterator before
5439 calling this function. */
5442 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5443 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5446 /* No region in strings. */
5447 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5449 /* No text property checks performed by default, but see below. */
5450 it
->stop_charpos
= -1;
5452 /* Set iterator position and end position. */
5453 memset (&it
->current
, 0, sizeof it
->current
);
5454 it
->current
.overlay_string_index
= -1;
5455 it
->current
.dpvec_index
= -1;
5456 xassert (charpos
>= 0);
5458 /* If STRING is specified, use its multibyteness, otherwise use the
5459 setting of MULTIBYTE, if specified. */
5461 it
->multibyte_p
= multibyte
> 0;
5465 xassert (STRINGP (string
));
5466 it
->string
= string
;
5468 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5469 it
->method
= GET_FROM_STRING
;
5470 it
->current
.string_pos
= string_pos (charpos
, string
);
5474 it
->s
= (const unsigned char *) s
;
5477 /* Note that we use IT->current.pos, not it->current.string_pos,
5478 for displaying C strings. */
5479 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5480 if (it
->multibyte_p
)
5482 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5483 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5487 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5488 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5491 it
->method
= GET_FROM_C_STRING
;
5494 /* PRECISION > 0 means don't return more than PRECISION characters
5496 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5497 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5499 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5500 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5501 FIELD_WIDTH < 0 means infinite field width. This is useful for
5502 padding with `-' at the end of a mode line. */
5503 if (field_width
< 0)
5504 field_width
= INFINITY
;
5505 if (field_width
> it
->end_charpos
- charpos
)
5506 it
->end_charpos
= charpos
+ field_width
;
5508 /* Use the standard display table for displaying strings. */
5509 if (DISP_TABLE_P (Vstandard_display_table
))
5510 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5512 it
->stop_charpos
= charpos
;
5513 if (s
== NULL
&& it
->multibyte_p
)
5515 EMACS_INT endpos
= SCHARS (it
->string
);
5516 if (endpos
> it
->end_charpos
)
5517 endpos
= it
->end_charpos
;
5518 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5526 /***********************************************************************
5528 ***********************************************************************/
5530 /* Map enum it_method value to corresponding next_element_from_* function. */
5532 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5534 next_element_from_buffer
,
5535 next_element_from_display_vector
,
5536 next_element_from_string
,
5537 next_element_from_c_string
,
5538 next_element_from_image
,
5539 next_element_from_stretch
5542 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5545 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5546 (possibly with the following characters). */
5548 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5549 ((IT)->cmp_it.id >= 0 \
5550 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5551 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5552 END_CHARPOS, (IT)->w, \
5553 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5557 /* Lookup the char-table Vglyphless_char_display for character C (-1
5558 if we want information for no-font case), and return the display
5559 method symbol. By side-effect, update it->what and
5560 it->glyphless_method. This function is called from
5561 get_next_display_element for each character element, and from
5562 x_produce_glyphs when no suitable font was found. */
5565 lookup_glyphless_char_display (int c
, struct it
*it
)
5567 Lisp_Object glyphless_method
= Qnil
;
5569 if (CHAR_TABLE_P (Vglyphless_char_display
)
5570 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5571 glyphless_method
= (c
>= 0
5572 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5573 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5575 if (NILP (glyphless_method
))
5578 /* The default is to display the character by a proper font. */
5580 /* The default for the no-font case is to display an empty box. */
5581 glyphless_method
= Qempty_box
;
5583 if (EQ (glyphless_method
, Qzero_width
))
5586 return glyphless_method
;
5587 /* This method can't be used for the no-font case. */
5588 glyphless_method
= Qempty_box
;
5590 if (EQ (glyphless_method
, Qthin_space
))
5591 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5592 else if (EQ (glyphless_method
, Qempty_box
))
5593 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5594 else if (EQ (glyphless_method
, Qhex_code
))
5595 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5596 else if (STRINGP (glyphless_method
))
5597 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5600 /* Invalid value. We use the default method. */
5601 glyphless_method
= Qnil
;
5604 it
->what
= IT_GLYPHLESS
;
5605 return glyphless_method
;
5608 /* Load IT's display element fields with information about the next
5609 display element from the current position of IT. Value is zero if
5610 end of buffer (or C string) is reached. */
5612 static struct frame
*last_escape_glyph_frame
= NULL
;
5613 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5614 static int last_escape_glyph_merged_face_id
= 0;
5616 struct frame
*last_glyphless_glyph_frame
= NULL
;
5617 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5618 int last_glyphless_glyph_merged_face_id
= 0;
5621 get_next_display_element (struct it
*it
)
5623 /* Non-zero means that we found a display element. Zero means that
5624 we hit the end of what we iterate over. Performance note: the
5625 function pointer `method' used here turns out to be faster than
5626 using a sequence of if-statements. */
5630 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5632 if (it
->what
== IT_CHARACTER
)
5634 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5635 and only if (a) the resolved directionality of that character
5637 /* FIXME: Do we need an exception for characters from display
5639 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5640 it
->c
= bidi_mirror_char (it
->c
);
5641 /* Map via display table or translate control characters.
5642 IT->c, IT->len etc. have been set to the next character by
5643 the function call above. If we have a display table, and it
5644 contains an entry for IT->c, translate it. Don't do this if
5645 IT->c itself comes from a display table, otherwise we could
5646 end up in an infinite recursion. (An alternative could be to
5647 count the recursion depth of this function and signal an
5648 error when a certain maximum depth is reached.) Is it worth
5650 if (success_p
&& it
->dpvec
== NULL
)
5653 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5654 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5655 nbsp_or_shy
= char_is_other
;
5656 int c
= it
->c
; /* This is the character to display. */
5658 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5660 xassert (SINGLE_BYTE_CHAR_P (c
));
5661 if (unibyte_display_via_language_environment
)
5663 c
= DECODE_CHAR (unibyte
, c
);
5665 c
= BYTE8_TO_CHAR (it
->c
);
5668 c
= BYTE8_TO_CHAR (it
->c
);
5672 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5675 struct Lisp_Vector
*v
= XVECTOR (dv
);
5677 /* Return the first character from the display table
5678 entry, if not empty. If empty, don't display the
5679 current character. */
5682 it
->dpvec_char_len
= it
->len
;
5683 it
->dpvec
= v
->contents
;
5684 it
->dpend
= v
->contents
+ v
->size
;
5685 it
->current
.dpvec_index
= 0;
5686 it
->dpvec_face_id
= -1;
5687 it
->saved_face_id
= it
->face_id
;
5688 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5693 set_iterator_to_next (it
, 0);
5698 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5700 if (it
->what
== IT_GLYPHLESS
)
5702 /* Don't display this character. */
5703 set_iterator_to_next (it
, 0);
5707 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5708 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5709 : c
== 0xAD ? char_is_soft_hyphen
5712 /* Translate control characters into `\003' or `^C' form.
5713 Control characters coming from a display table entry are
5714 currently not translated because we use IT->dpvec to hold
5715 the translation. This could easily be changed but I
5716 don't believe that it is worth doing.
5718 NBSP and SOFT-HYPEN are property translated too.
5720 Non-printable characters and raw-byte characters are also
5721 translated to octal form. */
5722 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5723 ? (it
->area
!= TEXT_AREA
5724 /* In mode line, treat \n, \t like other crl chars. */
5727 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5728 || (c
!= '\n' && c
!= '\t'))
5731 || ! CHAR_PRINTABLE_P (c
))))
5733 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5734 or a non-printable character which must be displayed
5735 either as '\003' or as `^C' where the '\\' and '^'
5736 can be defined in the display table. Fill
5737 IT->ctl_chars with glyphs for what we have to
5738 display. Then, set IT->dpvec to these glyphs. */
5741 int face_id
, lface_id
= 0 ;
5744 /* Handle control characters with ^. */
5746 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5750 g
= '^'; /* default glyph for Control */
5751 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5753 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5754 && GLYPH_CODE_CHAR_VALID_P (gc
))
5756 g
= GLYPH_CODE_CHAR (gc
);
5757 lface_id
= GLYPH_CODE_FACE (gc
);
5761 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5763 else if (it
->f
== last_escape_glyph_frame
5764 && it
->face_id
== last_escape_glyph_face_id
)
5766 face_id
= last_escape_glyph_merged_face_id
;
5770 /* Merge the escape-glyph face into the current face. */
5771 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5773 last_escape_glyph_frame
= it
->f
;
5774 last_escape_glyph_face_id
= it
->face_id
;
5775 last_escape_glyph_merged_face_id
= face_id
;
5778 XSETINT (it
->ctl_chars
[0], g
);
5779 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5781 goto display_control
;
5784 /* Handle non-break space in the mode where it only gets
5787 if (EQ (Vnobreak_char_display
, Qt
)
5788 && nbsp_or_shy
== char_is_nbsp
)
5790 /* Merge the no-break-space face into the current face. */
5791 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5795 XSETINT (it
->ctl_chars
[0], ' ');
5797 goto display_control
;
5800 /* Handle sequences that start with the "escape glyph". */
5802 /* the default escape glyph is \. */
5803 escape_glyph
= '\\';
5806 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5807 && GLYPH_CODE_CHAR_VALID_P (gc
))
5809 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5810 lface_id
= GLYPH_CODE_FACE (gc
);
5814 /* The display table specified a face.
5815 Merge it into face_id and also into escape_glyph. */
5816 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5819 else if (it
->f
== last_escape_glyph_frame
5820 && it
->face_id
== last_escape_glyph_face_id
)
5822 face_id
= last_escape_glyph_merged_face_id
;
5826 /* Merge the escape-glyph face into the current face. */
5827 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5829 last_escape_glyph_frame
= it
->f
;
5830 last_escape_glyph_face_id
= it
->face_id
;
5831 last_escape_glyph_merged_face_id
= face_id
;
5834 /* Handle soft hyphens in the mode where they only get
5837 if (EQ (Vnobreak_char_display
, Qt
)
5838 && nbsp_or_shy
== char_is_soft_hyphen
)
5840 XSETINT (it
->ctl_chars
[0], '-');
5842 goto display_control
;
5845 /* Handle non-break space and soft hyphen
5846 with the escape glyph. */
5850 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5851 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5852 XSETINT (it
->ctl_chars
[1], c
);
5854 goto display_control
;
5861 if (CHAR_BYTE8_P (c
))
5862 /* Display \200 instead of \17777600. */
5863 c
= CHAR_TO_BYTE8 (c
);
5864 len
= sprintf (str
, "%03o", c
);
5866 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5867 for (i
= 0; i
< len
; i
++)
5868 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5873 /* Set up IT->dpvec and return first character from it. */
5874 it
->dpvec_char_len
= it
->len
;
5875 it
->dpvec
= it
->ctl_chars
;
5876 it
->dpend
= it
->dpvec
+ ctl_len
;
5877 it
->current
.dpvec_index
= 0;
5878 it
->dpvec_face_id
= face_id
;
5879 it
->saved_face_id
= it
->face_id
;
5880 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5884 it
->char_to_display
= c
;
5888 it
->char_to_display
= it
->c
;
5892 #ifdef HAVE_WINDOW_SYSTEM
5893 /* Adjust face id for a multibyte character. There are no multibyte
5894 character in unibyte text. */
5895 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5898 && FRAME_WINDOW_P (it
->f
))
5900 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5902 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5904 /* Automatic composition with glyph-string. */
5905 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5907 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5911 EMACS_INT pos
= (it
->s
? -1
5912 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5913 : IT_CHARPOS (*it
));
5915 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5922 /* Is this character the last one of a run of characters with
5923 box? If yes, set IT->end_of_box_run_p to 1. */
5927 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5929 int face_id
= underlying_face_id (it
);
5930 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5934 if (face
->box
== FACE_NO_BOX
)
5936 /* If the box comes from face properties in a
5937 display string, check faces in that string. */
5938 int string_face_id
= face_after_it_pos (it
);
5939 it
->end_of_box_run_p
5940 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5943 /* Otherwise, the box comes from the underlying face.
5944 If this is the last string character displayed, check
5945 the next buffer location. */
5946 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5947 && (it
->current
.overlay_string_index
5948 == it
->n_overlay_strings
- 1))
5952 struct text_pos pos
= it
->current
.pos
;
5953 INC_TEXT_POS (pos
, it
->multibyte_p
);
5955 next_face_id
= face_at_buffer_position
5956 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5957 it
->region_end_charpos
, &ignore
,
5958 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5960 it
->end_of_box_run_p
5961 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5968 int face_id
= face_after_it_pos (it
);
5969 it
->end_of_box_run_p
5970 = (face_id
!= it
->face_id
5971 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5975 /* Value is 0 if end of buffer or string reached. */
5980 /* Move IT to the next display element.
5982 RESEAT_P non-zero means if called on a newline in buffer text,
5983 skip to the next visible line start.
5985 Functions get_next_display_element and set_iterator_to_next are
5986 separate because I find this arrangement easier to handle than a
5987 get_next_display_element function that also increments IT's
5988 position. The way it is we can first look at an iterator's current
5989 display element, decide whether it fits on a line, and if it does,
5990 increment the iterator position. The other way around we probably
5991 would either need a flag indicating whether the iterator has to be
5992 incremented the next time, or we would have to implement a
5993 decrement position function which would not be easy to write. */
5996 set_iterator_to_next (struct it
*it
, int reseat_p
)
5998 /* Reset flags indicating start and end of a sequence of characters
5999 with box. Reset them at the start of this function because
6000 moving the iterator to a new position might set them. */
6001 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6005 case GET_FROM_BUFFER
:
6006 /* The current display element of IT is a character from
6007 current_buffer. Advance in the buffer, and maybe skip over
6008 invisible lines that are so because of selective display. */
6009 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6010 reseat_at_next_visible_line_start (it
, 0);
6011 else if (it
->cmp_it
.id
>= 0)
6013 /* We are currently getting glyphs from a composition. */
6018 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6019 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6020 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6022 it
->cmp_it
.from
= it
->cmp_it
.to
;
6027 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6029 it
->end_charpos
, Qnil
);
6032 else if (! it
->cmp_it
.reversed_p
)
6034 /* Composition created while scanning forward. */
6035 /* Update IT's char/byte positions to point to the first
6036 character of the next grapheme cluster, or to the
6037 character visually after the current composition. */
6038 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6039 bidi_move_to_visually_next (&it
->bidi_it
);
6040 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6041 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6043 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6045 /* Proceed to the next grapheme cluster. */
6046 it
->cmp_it
.from
= it
->cmp_it
.to
;
6050 /* No more grapheme clusters in this composition.
6051 Find the next stop position. */
6052 EMACS_INT stop
= it
->end_charpos
;
6053 if (it
->bidi_it
.scan_dir
< 0)
6054 /* Now we are scanning backward and don't know
6057 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6058 IT_BYTEPOS (*it
), stop
, Qnil
);
6063 /* Composition created while scanning backward. */
6064 /* Update IT's char/byte positions to point to the last
6065 character of the previous grapheme cluster, or the
6066 character visually after the current composition. */
6067 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6068 bidi_move_to_visually_next (&it
->bidi_it
);
6069 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6070 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6071 if (it
->cmp_it
.from
> 0)
6073 /* Proceed to the previous grapheme cluster. */
6074 it
->cmp_it
.to
= it
->cmp_it
.from
;
6078 /* No more grapheme clusters in this composition.
6079 Find the next stop position. */
6080 EMACS_INT stop
= it
->end_charpos
;
6081 if (it
->bidi_it
.scan_dir
< 0)
6082 /* Now we are scanning backward and don't know
6085 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6086 IT_BYTEPOS (*it
), stop
, Qnil
);
6092 xassert (it
->len
!= 0);
6096 IT_BYTEPOS (*it
) += it
->len
;
6097 IT_CHARPOS (*it
) += 1;
6101 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6102 /* If this is a new paragraph, determine its base
6103 direction (a.k.a. its base embedding level). */
6104 if (it
->bidi_it
.new_paragraph
)
6105 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6106 bidi_move_to_visually_next (&it
->bidi_it
);
6107 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6108 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6109 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6111 /* As the scan direction was changed, we must
6112 re-compute the stop position for composition. */
6113 EMACS_INT stop
= it
->end_charpos
;
6114 if (it
->bidi_it
.scan_dir
< 0)
6116 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6117 IT_BYTEPOS (*it
), stop
, Qnil
);
6120 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6124 case GET_FROM_C_STRING
:
6125 /* Current display element of IT is from a C string. */
6126 IT_BYTEPOS (*it
) += it
->len
;
6127 IT_CHARPOS (*it
) += 1;
6130 case GET_FROM_DISPLAY_VECTOR
:
6131 /* Current display element of IT is from a display table entry.
6132 Advance in the display table definition. Reset it to null if
6133 end reached, and continue with characters from buffers/
6135 ++it
->current
.dpvec_index
;
6137 /* Restore face of the iterator to what they were before the
6138 display vector entry (these entries may contain faces). */
6139 it
->face_id
= it
->saved_face_id
;
6141 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6143 int recheck_faces
= it
->ellipsis_p
;
6146 it
->method
= GET_FROM_C_STRING
;
6147 else if (STRINGP (it
->string
))
6148 it
->method
= GET_FROM_STRING
;
6151 it
->method
= GET_FROM_BUFFER
;
6152 it
->object
= it
->w
->buffer
;
6156 it
->current
.dpvec_index
= -1;
6158 /* Skip over characters which were displayed via IT->dpvec. */
6159 if (it
->dpvec_char_len
< 0)
6160 reseat_at_next_visible_line_start (it
, 1);
6161 else if (it
->dpvec_char_len
> 0)
6163 if (it
->method
== GET_FROM_STRING
6164 && it
->n_overlay_strings
> 0)
6165 it
->ignore_overlay_strings_at_pos_p
= 1;
6166 it
->len
= it
->dpvec_char_len
;
6167 set_iterator_to_next (it
, reseat_p
);
6170 /* Maybe recheck faces after display vector */
6172 it
->stop_charpos
= IT_CHARPOS (*it
);
6176 case GET_FROM_STRING
:
6177 /* Current display element is a character from a Lisp string. */
6178 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6179 if (it
->cmp_it
.id
>= 0)
6181 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6182 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6183 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6184 it
->cmp_it
.from
= it
->cmp_it
.to
;
6188 composition_compute_stop_pos (&it
->cmp_it
,
6189 IT_STRING_CHARPOS (*it
),
6190 IT_STRING_BYTEPOS (*it
),
6191 it
->end_charpos
, it
->string
);
6196 IT_STRING_BYTEPOS (*it
) += it
->len
;
6197 IT_STRING_CHARPOS (*it
) += 1;
6200 consider_string_end
:
6202 if (it
->current
.overlay_string_index
>= 0)
6204 /* IT->string is an overlay string. Advance to the
6205 next, if there is one. */
6206 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6209 next_overlay_string (it
);
6211 setup_for_ellipsis (it
, 0);
6216 /* IT->string is not an overlay string. If we reached
6217 its end, and there is something on IT->stack, proceed
6218 with what is on the stack. This can be either another
6219 string, this time an overlay string, or a buffer. */
6220 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6224 if (it
->method
== GET_FROM_STRING
)
6225 goto consider_string_end
;
6230 case GET_FROM_IMAGE
:
6231 case GET_FROM_STRETCH
:
6232 /* The position etc with which we have to proceed are on
6233 the stack. The position may be at the end of a string,
6234 if the `display' property takes up the whole string. */
6235 xassert (it
->sp
> 0);
6237 if (it
->method
== GET_FROM_STRING
)
6238 goto consider_string_end
;
6242 /* There are no other methods defined, so this should be a bug. */
6246 xassert (it
->method
!= GET_FROM_STRING
6247 || (STRINGP (it
->string
)
6248 && IT_STRING_CHARPOS (*it
) >= 0));
6251 /* Load IT's display element fields with information about the next
6252 display element which comes from a display table entry or from the
6253 result of translating a control character to one of the forms `^C'
6256 IT->dpvec holds the glyphs to return as characters.
6257 IT->saved_face_id holds the face id before the display vector--it
6258 is restored into IT->face_id in set_iterator_to_next. */
6261 next_element_from_display_vector (struct it
*it
)
6266 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6268 it
->face_id
= it
->saved_face_id
;
6270 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6271 That seemed totally bogus - so I changed it... */
6272 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6274 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6276 it
->c
= GLYPH_CODE_CHAR (gc
);
6277 it
->len
= CHAR_BYTES (it
->c
);
6279 /* The entry may contain a face id to use. Such a face id is
6280 the id of a Lisp face, not a realized face. A face id of
6281 zero means no face is specified. */
6282 if (it
->dpvec_face_id
>= 0)
6283 it
->face_id
= it
->dpvec_face_id
;
6286 int lface_id
= GLYPH_CODE_FACE (gc
);
6288 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6293 /* Display table entry is invalid. Return a space. */
6294 it
->c
= ' ', it
->len
= 1;
6296 /* Don't change position and object of the iterator here. They are
6297 still the values of the character that had this display table
6298 entry or was translated, and that's what we want. */
6299 it
->what
= IT_CHARACTER
;
6304 /* Load IT with the next display element from Lisp string IT->string.
6305 IT->current.string_pos is the current position within the string.
6306 If IT->current.overlay_string_index >= 0, the Lisp string is an
6310 next_element_from_string (struct it
*it
)
6312 struct text_pos position
;
6314 xassert (STRINGP (it
->string
));
6315 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6316 position
= it
->current
.string_pos
;
6318 /* Time to check for invisible text? */
6319 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6320 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6324 /* Since a handler may have changed IT->method, we must
6326 return GET_NEXT_DISPLAY_ELEMENT (it
);
6329 if (it
->current
.overlay_string_index
>= 0)
6331 /* Get the next character from an overlay string. In overlay
6332 strings, There is no field width or padding with spaces to
6334 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6339 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6340 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6341 && next_element_from_composition (it
))
6345 else if (STRING_MULTIBYTE (it
->string
))
6347 const unsigned char *s
= (SDATA (it
->string
)
6348 + IT_STRING_BYTEPOS (*it
));
6349 it
->c
= string_char_and_length (s
, &it
->len
);
6353 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6359 /* Get the next character from a Lisp string that is not an
6360 overlay string. Such strings come from the mode line, for
6361 example. We may have to pad with spaces, or truncate the
6362 string. See also next_element_from_c_string. */
6363 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6368 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6370 /* Pad with spaces. */
6371 it
->c
= ' ', it
->len
= 1;
6372 CHARPOS (position
) = BYTEPOS (position
) = -1;
6374 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6375 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6376 && next_element_from_composition (it
))
6380 else if (STRING_MULTIBYTE (it
->string
))
6382 const unsigned char *s
= (SDATA (it
->string
)
6383 + IT_STRING_BYTEPOS (*it
));
6384 it
->c
= string_char_and_length (s
, &it
->len
);
6388 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6393 /* Record what we have and where it came from. */
6394 it
->what
= IT_CHARACTER
;
6395 it
->object
= it
->string
;
6396 it
->position
= position
;
6401 /* Load IT with next display element from C string IT->s.
6402 IT->string_nchars is the maximum number of characters to return
6403 from the string. IT->end_charpos may be greater than
6404 IT->string_nchars when this function is called, in which case we
6405 may have to return padding spaces. Value is zero if end of string
6406 reached, including padding spaces. */
6409 next_element_from_c_string (struct it
*it
)
6414 it
->what
= IT_CHARACTER
;
6415 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6418 /* IT's position can be greater IT->string_nchars in case a field
6419 width or precision has been specified when the iterator was
6421 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6423 /* End of the game. */
6427 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6429 /* Pad with spaces. */
6430 it
->c
= ' ', it
->len
= 1;
6431 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6433 else if (it
->multibyte_p
)
6434 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6436 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6442 /* Set up IT to return characters from an ellipsis, if appropriate.
6443 The definition of the ellipsis glyphs may come from a display table
6444 entry. This function fills IT with the first glyph from the
6445 ellipsis if an ellipsis is to be displayed. */
6448 next_element_from_ellipsis (struct it
*it
)
6450 if (it
->selective_display_ellipsis_p
)
6451 setup_for_ellipsis (it
, it
->len
);
6454 /* The face at the current position may be different from the
6455 face we find after the invisible text. Remember what it
6456 was in IT->saved_face_id, and signal that it's there by
6457 setting face_before_selective_p. */
6458 it
->saved_face_id
= it
->face_id
;
6459 it
->method
= GET_FROM_BUFFER
;
6460 it
->object
= it
->w
->buffer
;
6461 reseat_at_next_visible_line_start (it
, 1);
6462 it
->face_before_selective_p
= 1;
6465 return GET_NEXT_DISPLAY_ELEMENT (it
);
6469 /* Deliver an image display element. The iterator IT is already
6470 filled with image information (done in handle_display_prop). Value
6475 next_element_from_image (struct it
*it
)
6477 it
->what
= IT_IMAGE
;
6478 it
->ignore_overlay_strings_at_pos_p
= 0;
6483 /* Fill iterator IT with next display element from a stretch glyph
6484 property. IT->object is the value of the text property. Value is
6488 next_element_from_stretch (struct it
*it
)
6490 it
->what
= IT_STRETCH
;
6494 /* Scan forward from CHARPOS in the current buffer, until we find a
6495 stop position > current IT's position. Then handle the stop
6496 position before that. This is called when we bump into a stop
6497 position while reordering bidirectional text. CHARPOS should be
6498 the last previously processed stop_pos (or BEGV, if none were
6499 processed yet) whose position is less that IT's current
6503 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6505 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6506 struct display_pos save_current
= it
->current
;
6507 struct text_pos save_position
= it
->position
;
6508 struct text_pos pos1
;
6509 EMACS_INT next_stop
;
6511 /* Scan in strict logical order. */
6515 it
->prev_stop
= charpos
;
6516 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6517 reseat_1 (it
, pos1
, 0);
6518 compute_stop_pos (it
);
6519 /* We must advance forward, right? */
6520 if (it
->stop_charpos
<= it
->prev_stop
)
6522 charpos
= it
->stop_charpos
;
6524 while (charpos
<= where_we_are
);
6526 next_stop
= it
->stop_charpos
;
6527 it
->stop_charpos
= it
->prev_stop
;
6529 it
->current
= save_current
;
6530 it
->position
= save_position
;
6532 it
->stop_charpos
= next_stop
;
6535 /* Load IT with the next display element from current_buffer. Value
6536 is zero if end of buffer reached. IT->stop_charpos is the next
6537 position at which to stop and check for text properties or buffer
6541 next_element_from_buffer (struct it
*it
)
6545 xassert (IT_CHARPOS (*it
) >= BEGV
);
6547 /* With bidi reordering, the character to display might not be the
6548 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6549 we were reseat()ed to a new buffer position, which is potentially
6550 a different paragraph. */
6551 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6553 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6554 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6555 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6557 /* Nothing to do, but reset the FIRST_ELT flag, like
6558 bidi_paragraph_init does, because we are not going to
6560 it
->bidi_it
.first_elt
= 0;
6562 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6563 /* FIXME: Should support all Unicode line separators. */
6564 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6565 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6567 /* If we are at the beginning of a line, we can produce the
6568 next element right away. */
6569 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6570 bidi_move_to_visually_next (&it
->bidi_it
);
6574 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6576 /* We need to prime the bidi iterator starting at the line's
6577 beginning, before we will be able to produce the next
6579 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6580 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6581 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6582 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6583 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6586 /* Now return to buffer position where we were asked to
6587 get the next display element, and produce that. */
6588 bidi_move_to_visually_next (&it
->bidi_it
);
6590 while (it
->bidi_it
.bytepos
!= orig_bytepos
6591 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6594 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6595 /* Adjust IT's position information to where we ended up. */
6596 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6597 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6598 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6600 EMACS_INT stop
= it
->end_charpos
;
6601 if (it
->bidi_it
.scan_dir
< 0)
6603 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6604 IT_BYTEPOS (*it
), stop
, Qnil
);
6608 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6610 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6612 int overlay_strings_follow_p
;
6614 /* End of the game, except when overlay strings follow that
6615 haven't been returned yet. */
6616 if (it
->overlay_strings_at_end_processed_p
)
6617 overlay_strings_follow_p
= 0;
6620 it
->overlay_strings_at_end_processed_p
= 1;
6621 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6624 if (overlay_strings_follow_p
)
6625 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6629 it
->position
= it
->current
.pos
;
6633 else if (!(!it
->bidi_p
6634 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6635 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6637 /* With bidi non-linear iteration, we could find ourselves
6638 far beyond the last computed stop_charpos, with several
6639 other stop positions in between that we missed. Scan
6640 them all now, in buffer's logical order, until we find
6641 and handle the last stop_charpos that precedes our
6642 current position. */
6643 handle_stop_backwards (it
, it
->stop_charpos
);
6644 return GET_NEXT_DISPLAY_ELEMENT (it
);
6650 /* Take note of the stop position we just moved across,
6651 for when we will move back across it. */
6652 it
->prev_stop
= it
->stop_charpos
;
6653 /* If we are at base paragraph embedding level, take
6654 note of the last stop position seen at this
6656 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6657 it
->base_level_stop
= it
->stop_charpos
;
6660 return GET_NEXT_DISPLAY_ELEMENT (it
);
6664 /* We can sometimes back up for reasons that have nothing
6665 to do with bidi reordering. E.g., compositions. The
6666 code below is only needed when we are above the base
6667 embedding level, so test for that explicitly. */
6668 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6669 && IT_CHARPOS (*it
) < it
->prev_stop
)
6671 if (it
->base_level_stop
<= 0)
6672 it
->base_level_stop
= BEGV
;
6673 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6675 handle_stop_backwards (it
, it
->base_level_stop
);
6676 return GET_NEXT_DISPLAY_ELEMENT (it
);
6680 /* No face changes, overlays etc. in sight, so just return a
6681 character from current_buffer. */
6685 /* Maybe run the redisplay end trigger hook. Performance note:
6686 This doesn't seem to cost measurable time. */
6687 if (it
->redisplay_end_trigger_charpos
6689 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6690 run_redisplay_end_trigger_hook (it
);
6692 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6693 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6695 && next_element_from_composition (it
))
6700 /* Get the next character, maybe multibyte. */
6701 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6702 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6703 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6705 it
->c
= *p
, it
->len
= 1;
6707 /* Record what we have and where it came from. */
6708 it
->what
= IT_CHARACTER
;
6709 it
->object
= it
->w
->buffer
;
6710 it
->position
= it
->current
.pos
;
6712 /* Normally we return the character found above, except when we
6713 really want to return an ellipsis for selective display. */
6718 /* A value of selective > 0 means hide lines indented more
6719 than that number of columns. */
6720 if (it
->selective
> 0
6721 && IT_CHARPOS (*it
) + 1 < ZV
6722 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6723 IT_BYTEPOS (*it
) + 1,
6724 (double) it
->selective
)) /* iftc */
6726 success_p
= next_element_from_ellipsis (it
);
6727 it
->dpvec_char_len
= -1;
6730 else if (it
->c
== '\r' && it
->selective
== -1)
6732 /* A value of selective == -1 means that everything from the
6733 CR to the end of the line is invisible, with maybe an
6734 ellipsis displayed for it. */
6735 success_p
= next_element_from_ellipsis (it
);
6736 it
->dpvec_char_len
= -1;
6741 /* Value is zero if end of buffer reached. */
6742 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6747 /* Run the redisplay end trigger hook for IT. */
6750 run_redisplay_end_trigger_hook (struct it
*it
)
6752 Lisp_Object args
[3];
6754 /* IT->glyph_row should be non-null, i.e. we should be actually
6755 displaying something, or otherwise we should not run the hook. */
6756 xassert (it
->glyph_row
);
6758 /* Set up hook arguments. */
6759 args
[0] = Qredisplay_end_trigger_functions
;
6760 args
[1] = it
->window
;
6761 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6762 it
->redisplay_end_trigger_charpos
= 0;
6764 /* Since we are *trying* to run these functions, don't try to run
6765 them again, even if they get an error. */
6766 it
->w
->redisplay_end_trigger
= Qnil
;
6767 Frun_hook_with_args (3, args
);
6769 /* Notice if it changed the face of the character we are on. */
6770 handle_face_prop (it
);
6774 /* Deliver a composition display element. Unlike the other
6775 next_element_from_XXX, this function is not registered in the array
6776 get_next_element[]. It is called from next_element_from_buffer and
6777 next_element_from_string when necessary. */
6780 next_element_from_composition (struct it
*it
)
6782 it
->what
= IT_COMPOSITION
;
6783 it
->len
= it
->cmp_it
.nbytes
;
6784 if (STRINGP (it
->string
))
6788 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6789 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6792 it
->position
= it
->current
.string_pos
;
6793 it
->object
= it
->string
;
6794 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6795 IT_STRING_BYTEPOS (*it
), it
->string
);
6801 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6802 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6805 if (it
->bidi_it
.new_paragraph
)
6806 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6807 /* Resync the bidi iterator with IT's new position.
6808 FIXME: this doesn't support bidirectional text. */
6809 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6810 bidi_move_to_visually_next (&it
->bidi_it
);
6814 it
->position
= it
->current
.pos
;
6815 it
->object
= it
->w
->buffer
;
6816 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6817 IT_BYTEPOS (*it
), Qnil
);
6824 /***********************************************************************
6825 Moving an iterator without producing glyphs
6826 ***********************************************************************/
6828 /* Check if iterator is at a position corresponding to a valid buffer
6829 position after some move_it_ call. */
6831 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6832 ((it)->method == GET_FROM_STRING \
6833 ? IT_STRING_CHARPOS (*it) == 0 \
6837 /* Move iterator IT to a specified buffer or X position within one
6838 line on the display without producing glyphs.
6840 OP should be a bit mask including some or all of these bits:
6841 MOVE_TO_X: Stop upon reaching x-position TO_X.
6842 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6843 Regardless of OP's value, stop upon reaching the end of the display line.
6845 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6846 This means, in particular, that TO_X includes window's horizontal
6849 The return value has several possible values that
6850 say what condition caused the scan to stop:
6852 MOVE_POS_MATCH_OR_ZV
6853 - when TO_POS or ZV was reached.
6856 -when TO_X was reached before TO_POS or ZV were reached.
6859 - when we reached the end of the display area and the line must
6863 - when we reached the end of the display area and the line is
6867 - when we stopped at a line end, i.e. a newline or a CR and selective
6870 static enum move_it_result
6871 move_it_in_display_line_to (struct it
*it
,
6872 EMACS_INT to_charpos
, int to_x
,
6873 enum move_operation_enum op
)
6875 enum move_it_result result
= MOVE_UNDEFINED
;
6876 struct glyph_row
*saved_glyph_row
;
6877 struct it wrap_it
, atpos_it
, atx_it
;
6879 enum it_method prev_method
= it
->method
;
6880 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6882 /* Don't produce glyphs in produce_glyphs. */
6883 saved_glyph_row
= it
->glyph_row
;
6884 it
->glyph_row
= NULL
;
6886 /* Use wrap_it to save a copy of IT wherever a word wrap could
6887 occur. Use atpos_it to save a copy of IT at the desired buffer
6888 position, if found, so that we can scan ahead and check if the
6889 word later overshoots the window edge. Use atx_it similarly, for
6895 #define BUFFER_POS_REACHED_P() \
6896 ((op & MOVE_TO_POS) != 0 \
6897 && BUFFERP (it->object) \
6898 && (IT_CHARPOS (*it) == to_charpos \
6899 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6900 && (it->method == GET_FROM_BUFFER \
6901 || (it->method == GET_FROM_DISPLAY_VECTOR \
6902 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6904 /* If there's a line-/wrap-prefix, handle it. */
6905 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6906 && it
->current_y
< it
->last_visible_y
)
6907 handle_line_prefix (it
);
6909 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6910 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6914 int x
, i
, ascent
= 0, descent
= 0;
6916 /* Utility macro to reset an iterator with x, ascent, and descent. */
6917 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6918 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6919 (IT)->max_descent = descent)
6921 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6923 if ((op
& MOVE_TO_POS
) != 0
6924 && BUFFERP (it
->object
)
6925 && it
->method
== GET_FROM_BUFFER
6926 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6928 && (prev_method
== GET_FROM_IMAGE
6929 || prev_method
== GET_FROM_STRETCH
)
6930 /* Passed TO_CHARPOS from left to right. */
6931 && ((prev_pos
< to_charpos
6932 && IT_CHARPOS (*it
) > to_charpos
)
6933 /* Passed TO_CHARPOS from right to left. */
6934 || (prev_pos
> to_charpos
6935 && IT_CHARPOS (*it
) < to_charpos
)))))
6937 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6939 result
= MOVE_POS_MATCH_OR_ZV
;
6942 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6943 /* If wrap_it is valid, the current position might be in a
6944 word that is wrapped. So, save the iterator in
6945 atpos_it and continue to see if wrapping happens. */
6949 prev_method
= it
->method
;
6950 if (it
->method
== GET_FROM_BUFFER
)
6951 prev_pos
= IT_CHARPOS (*it
);
6952 /* Stop when ZV reached.
6953 We used to stop here when TO_CHARPOS reached as well, but that is
6954 too soon if this glyph does not fit on this line. So we handle it
6955 explicitly below. */
6956 if (!get_next_display_element (it
))
6958 result
= MOVE_POS_MATCH_OR_ZV
;
6962 if (it
->line_wrap
== TRUNCATE
)
6964 if (BUFFER_POS_REACHED_P ())
6966 result
= MOVE_POS_MATCH_OR_ZV
;
6972 if (it
->line_wrap
== WORD_WRAP
)
6974 if (IT_DISPLAYING_WHITESPACE (it
))
6978 /* We have reached a glyph that follows one or more
6979 whitespace characters. If the position is
6980 already found, we are done. */
6981 if (atpos_it
.sp
>= 0)
6984 result
= MOVE_POS_MATCH_OR_ZV
;
6990 result
= MOVE_X_REACHED
;
6993 /* Otherwise, we can wrap here. */
7000 /* Remember the line height for the current line, in case
7001 the next element doesn't fit on the line. */
7002 ascent
= it
->max_ascent
;
7003 descent
= it
->max_descent
;
7005 /* The call to produce_glyphs will get the metrics of the
7006 display element IT is loaded with. Record the x-position
7007 before this display element, in case it doesn't fit on the
7011 PRODUCE_GLYPHS (it
);
7013 if (it
->area
!= TEXT_AREA
)
7015 set_iterator_to_next (it
, 1);
7016 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7017 SET_TEXT_POS (this_line_min_pos
,
7018 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7022 /* The number of glyphs we get back in IT->nglyphs will normally
7023 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7024 character on a terminal frame, or (iii) a line end. For the
7025 second case, IT->nglyphs - 1 padding glyphs will be present.
7026 (On X frames, there is only one glyph produced for a
7027 composite character.)
7029 The behavior implemented below means, for continuation lines,
7030 that as many spaces of a TAB as fit on the current line are
7031 displayed there. For terminal frames, as many glyphs of a
7032 multi-glyph character are displayed in the current line, too.
7033 This is what the old redisplay code did, and we keep it that
7034 way. Under X, the whole shape of a complex character must
7035 fit on the line or it will be completely displayed in the
7038 Note that both for tabs and padding glyphs, all glyphs have
7042 /* More than one glyph or glyph doesn't fit on line. All
7043 glyphs have the same width. */
7044 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7046 int x_before_this_char
= x
;
7047 int hpos_before_this_char
= it
->hpos
;
7049 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7051 new_x
= x
+ single_glyph_width
;
7053 /* We want to leave anything reaching TO_X to the caller. */
7054 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7056 if (BUFFER_POS_REACHED_P ())
7058 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7059 goto buffer_pos_reached
;
7060 if (atpos_it
.sp
< 0)
7063 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7068 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7071 result
= MOVE_X_REACHED
;
7077 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7082 if (/* Lines are continued. */
7083 it
->line_wrap
!= TRUNCATE
7084 && (/* And glyph doesn't fit on the line. */
7085 new_x
> it
->last_visible_x
7086 /* Or it fits exactly and we're on a window
7088 || (new_x
== it
->last_visible_x
7089 && FRAME_WINDOW_P (it
->f
))))
7091 if (/* IT->hpos == 0 means the very first glyph
7092 doesn't fit on the line, e.g. a wide image. */
7094 || (new_x
== it
->last_visible_x
7095 && FRAME_WINDOW_P (it
->f
)))
7098 it
->current_x
= new_x
;
7100 /* The character's last glyph just barely fits
7102 if (i
== it
->nglyphs
- 1)
7104 /* If this is the destination position,
7105 return a position *before* it in this row,
7106 now that we know it fits in this row. */
7107 if (BUFFER_POS_REACHED_P ())
7109 if (it
->line_wrap
!= WORD_WRAP
7112 it
->hpos
= hpos_before_this_char
;
7113 it
->current_x
= x_before_this_char
;
7114 result
= MOVE_POS_MATCH_OR_ZV
;
7117 if (it
->line_wrap
== WORD_WRAP
7121 atpos_it
.current_x
= x_before_this_char
;
7122 atpos_it
.hpos
= hpos_before_this_char
;
7126 set_iterator_to_next (it
, 1);
7127 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7128 SET_TEXT_POS (this_line_min_pos
,
7129 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7130 /* On graphical terminals, newlines may
7131 "overflow" into the fringe if
7132 overflow-newline-into-fringe is non-nil.
7133 On text-only terminals, newlines may
7134 overflow into the last glyph on the
7136 if (!FRAME_WINDOW_P (it
->f
)
7137 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7139 if (!get_next_display_element (it
))
7141 result
= MOVE_POS_MATCH_OR_ZV
;
7144 if (BUFFER_POS_REACHED_P ())
7146 if (ITERATOR_AT_END_OF_LINE_P (it
))
7147 result
= MOVE_POS_MATCH_OR_ZV
;
7149 result
= MOVE_LINE_CONTINUED
;
7152 if (ITERATOR_AT_END_OF_LINE_P (it
))
7154 result
= MOVE_NEWLINE_OR_CR
;
7161 IT_RESET_X_ASCENT_DESCENT (it
);
7163 if (wrap_it
.sp
>= 0)
7170 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7172 result
= MOVE_LINE_CONTINUED
;
7176 if (BUFFER_POS_REACHED_P ())
7178 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7179 goto buffer_pos_reached
;
7180 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7183 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7187 if (new_x
> it
->first_visible_x
)
7189 /* Glyph is visible. Increment number of glyphs that
7190 would be displayed. */
7195 if (result
!= MOVE_UNDEFINED
)
7198 else if (BUFFER_POS_REACHED_P ())
7201 IT_RESET_X_ASCENT_DESCENT (it
);
7202 result
= MOVE_POS_MATCH_OR_ZV
;
7205 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7207 /* Stop when TO_X specified and reached. This check is
7208 necessary here because of lines consisting of a line end,
7209 only. The line end will not produce any glyphs and we
7210 would never get MOVE_X_REACHED. */
7211 xassert (it
->nglyphs
== 0);
7212 result
= MOVE_X_REACHED
;
7216 /* Is this a line end? If yes, we're done. */
7217 if (ITERATOR_AT_END_OF_LINE_P (it
))
7219 result
= MOVE_NEWLINE_OR_CR
;
7223 if (it
->method
== GET_FROM_BUFFER
)
7224 prev_pos
= IT_CHARPOS (*it
);
7225 /* The current display element has been consumed. Advance
7227 set_iterator_to_next (it
, 1);
7228 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7229 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7231 /* Stop if lines are truncated and IT's current x-position is
7232 past the right edge of the window now. */
7233 if (it
->line_wrap
== TRUNCATE
7234 && it
->current_x
>= it
->last_visible_x
)
7236 if (!FRAME_WINDOW_P (it
->f
)
7237 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7239 if (!get_next_display_element (it
)
7240 || BUFFER_POS_REACHED_P ())
7242 result
= MOVE_POS_MATCH_OR_ZV
;
7245 if (ITERATOR_AT_END_OF_LINE_P (it
))
7247 result
= MOVE_NEWLINE_OR_CR
;
7251 result
= MOVE_LINE_TRUNCATED
;
7254 #undef IT_RESET_X_ASCENT_DESCENT
7257 #undef BUFFER_POS_REACHED_P
7259 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7260 restore the saved iterator. */
7261 if (atpos_it
.sp
>= 0)
7263 else if (atx_it
.sp
>= 0)
7268 /* Restore the iterator settings altered at the beginning of this
7270 it
->glyph_row
= saved_glyph_row
;
7274 /* For external use. */
7276 move_it_in_display_line (struct it
*it
,
7277 EMACS_INT to_charpos
, int to_x
,
7278 enum move_operation_enum op
)
7280 if (it
->line_wrap
== WORD_WRAP
7281 && (op
& MOVE_TO_X
))
7283 struct it save_it
= *it
;
7284 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7285 /* When word-wrap is on, TO_X may lie past the end
7286 of a wrapped line. Then it->current is the
7287 character on the next line, so backtrack to the
7288 space before the wrap point. */
7289 if (skip
== MOVE_LINE_CONTINUED
)
7291 int prev_x
= max (it
->current_x
- 1, 0);
7293 move_it_in_display_line_to
7294 (it
, -1, prev_x
, MOVE_TO_X
);
7298 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7302 /* Move IT forward until it satisfies one or more of the criteria in
7303 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7305 OP is a bit-mask that specifies where to stop, and in particular,
7306 which of those four position arguments makes a difference. See the
7307 description of enum move_operation_enum.
7309 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7310 screen line, this function will set IT to the next position >
7314 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7316 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7317 int line_height
, line_start_x
= 0, reached
= 0;
7321 if (op
& MOVE_TO_VPOS
)
7323 /* If no TO_CHARPOS and no TO_X specified, stop at the
7324 start of the line TO_VPOS. */
7325 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7327 if (it
->vpos
== to_vpos
)
7333 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7337 /* TO_VPOS >= 0 means stop at TO_X in the line at
7338 TO_VPOS, or at TO_POS, whichever comes first. */
7339 if (it
->vpos
== to_vpos
)
7345 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7347 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7352 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7354 /* We have reached TO_X but not in the line we want. */
7355 skip
= move_it_in_display_line_to (it
, to_charpos
,
7357 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7365 else if (op
& MOVE_TO_Y
)
7367 struct it it_backup
;
7369 if (it
->line_wrap
== WORD_WRAP
)
7372 /* TO_Y specified means stop at TO_X in the line containing
7373 TO_Y---or at TO_CHARPOS if this is reached first. The
7374 problem is that we can't really tell whether the line
7375 contains TO_Y before we have completely scanned it, and
7376 this may skip past TO_X. What we do is to first scan to
7379 If TO_X is not specified, use a TO_X of zero. The reason
7380 is to make the outcome of this function more predictable.
7381 If we didn't use TO_X == 0, we would stop at the end of
7382 the line which is probably not what a caller would expect
7384 skip
= move_it_in_display_line_to
7385 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7386 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7388 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7389 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7391 else if (skip
== MOVE_X_REACHED
)
7393 /* If TO_X was reached, we want to know whether TO_Y is
7394 in the line. We know this is the case if the already
7395 scanned glyphs make the line tall enough. Otherwise,
7396 we must check by scanning the rest of the line. */
7397 line_height
= it
->max_ascent
+ it
->max_descent
;
7398 if (to_y
>= it
->current_y
7399 && to_y
< it
->current_y
+ line_height
)
7405 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7406 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7408 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7409 line_height
= it
->max_ascent
+ it
->max_descent
;
7410 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7412 if (to_y
>= it
->current_y
7413 && to_y
< it
->current_y
+ line_height
)
7415 /* If TO_Y is in this line and TO_X was reached
7416 above, we scanned too far. We have to restore
7417 IT's settings to the ones before skipping. */
7424 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7430 /* Check whether TO_Y is in this line. */
7431 line_height
= it
->max_ascent
+ it
->max_descent
;
7432 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7434 if (to_y
>= it
->current_y
7435 && to_y
< it
->current_y
+ line_height
)
7437 /* When word-wrap is on, TO_X may lie past the end
7438 of a wrapped line. Then it->current is the
7439 character on the next line, so backtrack to the
7440 space before the wrap point. */
7441 if (skip
== MOVE_LINE_CONTINUED
7442 && it
->line_wrap
== WORD_WRAP
)
7444 int prev_x
= max (it
->current_x
- 1, 0);
7446 skip
= move_it_in_display_line_to
7447 (it
, -1, prev_x
, MOVE_TO_X
);
7456 else if (BUFFERP (it
->object
)
7457 && (it
->method
== GET_FROM_BUFFER
7458 || it
->method
== GET_FROM_STRETCH
)
7459 && IT_CHARPOS (*it
) >= to_charpos
)
7460 skip
= MOVE_POS_MATCH_OR_ZV
;
7462 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7466 case MOVE_POS_MATCH_OR_ZV
:
7470 case MOVE_NEWLINE_OR_CR
:
7471 set_iterator_to_next (it
, 1);
7472 it
->continuation_lines_width
= 0;
7475 case MOVE_LINE_TRUNCATED
:
7476 it
->continuation_lines_width
= 0;
7477 reseat_at_next_visible_line_start (it
, 0);
7478 if ((op
& MOVE_TO_POS
) != 0
7479 && IT_CHARPOS (*it
) > to_charpos
)
7486 case MOVE_LINE_CONTINUED
:
7487 /* For continued lines ending in a tab, some of the glyphs
7488 associated with the tab are displayed on the current
7489 line. Since it->current_x does not include these glyphs,
7490 we use it->last_visible_x instead. */
7493 it
->continuation_lines_width
+= it
->last_visible_x
;
7494 /* When moving by vpos, ensure that the iterator really
7495 advances to the next line (bug#847, bug#969). Fixme:
7496 do we need to do this in other circumstances? */
7497 if (it
->current_x
!= it
->last_visible_x
7498 && (op
& MOVE_TO_VPOS
)
7499 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7501 line_start_x
= it
->current_x
+ it
->pixel_width
7502 - it
->last_visible_x
;
7503 set_iterator_to_next (it
, 0);
7507 it
->continuation_lines_width
+= it
->current_x
;
7514 /* Reset/increment for the next run. */
7515 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7516 it
->current_x
= line_start_x
;
7519 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7521 last_height
= it
->max_ascent
+ it
->max_descent
;
7522 last_max_ascent
= it
->max_ascent
;
7523 it
->max_ascent
= it
->max_descent
= 0;
7528 /* On text terminals, we may stop at the end of a line in the middle
7529 of a multi-character glyph. If the glyph itself is continued,
7530 i.e. it is actually displayed on the next line, don't treat this
7531 stopping point as valid; move to the next line instead (unless
7532 that brings us offscreen). */
7533 if (!FRAME_WINDOW_P (it
->f
)
7535 && IT_CHARPOS (*it
) == to_charpos
7536 && it
->what
== IT_CHARACTER
7538 && it
->line_wrap
== WINDOW_WRAP
7539 && it
->current_x
== it
->last_visible_x
- 1
7542 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7544 it
->continuation_lines_width
+= it
->current_x
;
7545 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7546 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7548 last_height
= it
->max_ascent
+ it
->max_descent
;
7549 last_max_ascent
= it
->max_ascent
;
7552 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7556 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7558 If DY > 0, move IT backward at least that many pixels. DY = 0
7559 means move IT backward to the preceding line start or BEGV. This
7560 function may move over more than DY pixels if IT->current_y - DY
7561 ends up in the middle of a line; in this case IT->current_y will be
7562 set to the top of the line moved to. */
7565 move_it_vertically_backward (struct it
*it
, int dy
)
7569 EMACS_INT start_pos
;
7574 start_pos
= IT_CHARPOS (*it
);
7576 /* Estimate how many newlines we must move back. */
7577 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7579 /* Set the iterator's position that many lines back. */
7580 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7581 back_to_previous_visible_line_start (it
);
7583 /* Reseat the iterator here. When moving backward, we don't want
7584 reseat to skip forward over invisible text, set up the iterator
7585 to deliver from overlay strings at the new position etc. So,
7586 use reseat_1 here. */
7587 reseat_1 (it
, it
->current
.pos
, 1);
7589 /* We are now surely at a line start. */
7590 it
->current_x
= it
->hpos
= 0;
7591 it
->continuation_lines_width
= 0;
7593 /* Move forward and see what y-distance we moved. First move to the
7594 start of the next line so that we get its height. We need this
7595 height to be able to tell whether we reached the specified
7598 it2
.max_ascent
= it2
.max_descent
= 0;
7601 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7602 MOVE_TO_POS
| MOVE_TO_VPOS
);
7604 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7605 xassert (IT_CHARPOS (*it
) >= BEGV
);
7608 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7609 xassert (IT_CHARPOS (*it
) >= BEGV
);
7610 /* H is the actual vertical distance from the position in *IT
7611 and the starting position. */
7612 h
= it2
.current_y
- it
->current_y
;
7613 /* NLINES is the distance in number of lines. */
7614 nlines
= it2
.vpos
- it
->vpos
;
7616 /* Correct IT's y and vpos position
7617 so that they are relative to the starting point. */
7623 /* DY == 0 means move to the start of the screen line. The
7624 value of nlines is > 0 if continuation lines were involved. */
7626 move_it_by_lines (it
, nlines
, 1);
7630 /* The y-position we try to reach, relative to *IT.
7631 Note that H has been subtracted in front of the if-statement. */
7632 int target_y
= it
->current_y
+ h
- dy
;
7633 int y0
= it3
.current_y
;
7634 int y1
= line_bottom_y (&it3
);
7635 int line_height
= y1
- y0
;
7637 /* If we did not reach target_y, try to move further backward if
7638 we can. If we moved too far backward, try to move forward. */
7639 if (target_y
< it
->current_y
7640 /* This is heuristic. In a window that's 3 lines high, with
7641 a line height of 13 pixels each, recentering with point
7642 on the bottom line will try to move -39/2 = 19 pixels
7643 backward. Try to avoid moving into the first line. */
7644 && (it
->current_y
- target_y
7645 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7646 && IT_CHARPOS (*it
) > BEGV
)
7648 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7649 target_y
- it
->current_y
));
7650 dy
= it
->current_y
- target_y
;
7651 goto move_further_back
;
7653 else if (target_y
>= it
->current_y
+ line_height
7654 && IT_CHARPOS (*it
) < ZV
)
7656 /* Should move forward by at least one line, maybe more.
7658 Note: Calling move_it_by_lines can be expensive on
7659 terminal frames, where compute_motion is used (via
7660 vmotion) to do the job, when there are very long lines
7661 and truncate-lines is nil. That's the reason for
7662 treating terminal frames specially here. */
7664 if (!FRAME_WINDOW_P (it
->f
))
7665 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7670 move_it_by_lines (it
, 1, 1);
7672 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7679 /* Move IT by a specified amount of pixel lines DY. DY negative means
7680 move backwards. DY = 0 means move to start of screen line. At the
7681 end, IT will be on the start of a screen line. */
7684 move_it_vertically (struct it
*it
, int dy
)
7687 move_it_vertically_backward (it
, -dy
);
7690 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7691 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7692 MOVE_TO_POS
| MOVE_TO_Y
);
7693 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7695 /* If buffer ends in ZV without a newline, move to the start of
7696 the line to satisfy the post-condition. */
7697 if (IT_CHARPOS (*it
) == ZV
7699 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7700 move_it_by_lines (it
, 0, 0);
7705 /* Move iterator IT past the end of the text line it is in. */
7708 move_it_past_eol (struct it
*it
)
7710 enum move_it_result rc
;
7712 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7713 if (rc
== MOVE_NEWLINE_OR_CR
)
7714 set_iterator_to_next (it
, 0);
7718 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7719 negative means move up. DVPOS == 0 means move to the start of the
7720 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7721 NEED_Y_P is zero, IT->current_y will be left unchanged.
7723 Further optimization ideas: If we would know that IT->f doesn't use
7724 a face with proportional font, we could be faster for
7725 truncate-lines nil. */
7728 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7731 /* The commented-out optimization uses vmotion on terminals. This
7732 gives bad results, because elements like it->what, on which
7733 callers such as pos_visible_p rely, aren't updated. */
7734 /* struct position pos;
7735 if (!FRAME_WINDOW_P (it->f))
7737 struct text_pos textpos;
7739 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7740 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7741 reseat (it, textpos, 1);
7742 it->vpos += pos.vpos;
7743 it->current_y += pos.vpos;
7749 /* DVPOS == 0 means move to the start of the screen line. */
7750 move_it_vertically_backward (it
, 0);
7751 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7752 /* Let next call to line_bottom_y calculate real line height */
7757 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7758 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7759 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7764 EMACS_INT start_charpos
, i
;
7766 /* Start at the beginning of the screen line containing IT's
7767 position. This may actually move vertically backwards,
7768 in case of overlays, so adjust dvpos accordingly. */
7770 move_it_vertically_backward (it
, 0);
7773 /* Go back -DVPOS visible lines and reseat the iterator there. */
7774 start_charpos
= IT_CHARPOS (*it
);
7775 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7776 back_to_previous_visible_line_start (it
);
7777 reseat (it
, it
->current
.pos
, 1);
7779 /* Move further back if we end up in a string or an image. */
7780 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7782 /* First try to move to start of display line. */
7784 move_it_vertically_backward (it
, 0);
7786 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7788 /* If start of line is still in string or image,
7789 move further back. */
7790 back_to_previous_visible_line_start (it
);
7791 reseat (it
, it
->current
.pos
, 1);
7795 it
->current_x
= it
->hpos
= 0;
7797 /* Above call may have moved too far if continuation lines
7798 are involved. Scan forward and see if it did. */
7800 it2
.vpos
= it2
.current_y
= 0;
7801 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7802 it
->vpos
-= it2
.vpos
;
7803 it
->current_y
-= it2
.current_y
;
7804 it
->current_x
= it
->hpos
= 0;
7806 /* If we moved too far back, move IT some lines forward. */
7807 if (it2
.vpos
> -dvpos
)
7809 int delta
= it2
.vpos
+ dvpos
;
7811 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7812 /* Move back again if we got too far ahead. */
7813 if (IT_CHARPOS (*it
) >= start_charpos
)
7819 /* Return 1 if IT points into the middle of a display vector. */
7822 in_display_vector_p (struct it
*it
)
7824 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7825 && it
->current
.dpvec_index
> 0
7826 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7830 /***********************************************************************
7832 ***********************************************************************/
7835 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7839 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7841 Lisp_Object args
[3];
7842 Lisp_Object msg
, fmt
;
7845 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7848 /* Do nothing if called asynchronously. Inserting text into
7849 a buffer may call after-change-functions and alike and
7850 that would means running Lisp asynchronously. */
7851 if (handling_signal
)
7855 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7857 args
[0] = fmt
= build_string (format
);
7860 msg
= Fformat (3, args
);
7862 len
= SBYTES (msg
) + 1;
7863 SAFE_ALLOCA (buffer
, char *, len
);
7864 memcpy (buffer
, SDATA (msg
), len
);
7866 message_dolog (buffer
, len
- 1, 1, 0);
7873 /* Output a newline in the *Messages* buffer if "needs" one. */
7876 message_log_maybe_newline (void)
7878 if (message_log_need_newline
)
7879 message_dolog ("", 0, 1, 0);
7883 /* Add a string M of length NBYTES to the message log, optionally
7884 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7885 nonzero, means interpret the contents of M as multibyte. This
7886 function calls low-level routines in order to bypass text property
7887 hooks, etc. which might not be safe to run.
7889 This may GC (insert may run before/after change hooks),
7890 so the buffer M must NOT point to a Lisp string. */
7893 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7895 const unsigned char *msg
= (const unsigned char *) m
;
7897 if (!NILP (Vmemory_full
))
7900 if (!NILP (Vmessage_log_max
))
7902 struct buffer
*oldbuf
;
7903 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7904 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7905 EMACS_INT point_at_end
= 0;
7906 EMACS_INT zv_at_end
= 0;
7907 Lisp_Object old_deactivate_mark
, tem
;
7908 struct gcpro gcpro1
;
7910 old_deactivate_mark
= Vdeactivate_mark
;
7911 oldbuf
= current_buffer
;
7912 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7913 BVAR (current_buffer
, undo_list
) = Qt
;
7915 oldpoint
= message_dolog_marker1
;
7916 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7917 oldbegv
= message_dolog_marker2
;
7918 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7919 oldzv
= message_dolog_marker3
;
7920 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7921 GCPRO1 (old_deactivate_mark
);
7929 BEGV_BYTE
= BEG_BYTE
;
7932 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7934 /* Insert the string--maybe converting multibyte to single byte
7935 or vice versa, so that all the text fits the buffer. */
7937 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7943 /* Convert a multibyte string to single-byte
7944 for the *Message* buffer. */
7945 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7947 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7948 work
[0] = (ASCII_CHAR_P (c
)
7950 : multibyte_char_to_unibyte (c
, Qnil
));
7951 insert_1_both (work
, 1, 1, 1, 0, 0);
7954 else if (! multibyte
7955 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7959 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7960 /* Convert a single-byte string to multibyte
7961 for the *Message* buffer. */
7962 for (i
= 0; i
< nbytes
; i
++)
7965 MAKE_CHAR_MULTIBYTE (c
);
7966 char_bytes
= CHAR_STRING (c
, str
);
7967 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7971 insert_1 (m
, nbytes
, 1, 0, 0);
7975 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7977 insert_1 ("\n", 1, 1, 0, 0);
7979 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7981 this_bol_byte
= PT_BYTE
;
7983 /* See if this line duplicates the previous one.
7984 If so, combine duplicates. */
7987 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7989 prev_bol_byte
= PT_BYTE
;
7991 dups
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7992 this_bol
, this_bol_byte
);
7995 del_range_both (prev_bol
, prev_bol_byte
,
7996 this_bol
, this_bol_byte
, 0);
8002 /* If you change this format, don't forget to also
8003 change message_log_check_duplicate. */
8004 sprintf (dupstr
, " [%d times]", dups
);
8005 duplen
= strlen (dupstr
);
8006 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8007 insert_1 (dupstr
, duplen
, 1, 0, 1);
8012 /* If we have more than the desired maximum number of lines
8013 in the *Messages* buffer now, delete the oldest ones.
8014 This is safe because we don't have undo in this buffer. */
8016 if (NATNUMP (Vmessage_log_max
))
8018 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8019 -XFASTINT (Vmessage_log_max
) - 1, 0);
8020 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8023 BEGV
= XMARKER (oldbegv
)->charpos
;
8024 BEGV_BYTE
= marker_byte_position (oldbegv
);
8033 ZV
= XMARKER (oldzv
)->charpos
;
8034 ZV_BYTE
= marker_byte_position (oldzv
);
8038 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8040 /* We can't do Fgoto_char (oldpoint) because it will run some
8042 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8043 XMARKER (oldpoint
)->bytepos
);
8046 unchain_marker (XMARKER (oldpoint
));
8047 unchain_marker (XMARKER (oldbegv
));
8048 unchain_marker (XMARKER (oldzv
));
8050 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8051 set_buffer_internal (oldbuf
);
8053 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8054 message_log_need_newline
= !nlflag
;
8055 Vdeactivate_mark
= old_deactivate_mark
;
8060 /* We are at the end of the buffer after just having inserted a newline.
8061 (Note: We depend on the fact we won't be crossing the gap.)
8062 Check to see if the most recent message looks a lot like the previous one.
8063 Return 0 if different, 1 if the new one should just replace it, or a
8064 value N > 1 if we should also append " [N times]". */
8067 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8068 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8071 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8073 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8074 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8076 for (i
= 0; i
< len
; i
++)
8078 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8086 if (*p1
++ == ' ' && *p1
++ == '[')
8089 while (*p1
>= '0' && *p1
<= '9')
8090 n
= n
* 10 + *p1
++ - '0';
8091 if (strncmp ((char *) p1
, " times]\n", 8) == 0)
8098 /* Display an echo area message M with a specified length of NBYTES
8099 bytes. The string may include null characters. If M is 0, clear
8100 out any existing message, and let the mini-buffer text show
8103 This may GC, so the buffer M must NOT point to a Lisp string. */
8106 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8108 /* First flush out any partial line written with print. */
8109 message_log_maybe_newline ();
8111 message_dolog (m
, nbytes
, 1, multibyte
);
8112 message2_nolog (m
, nbytes
, multibyte
);
8116 /* The non-logging counterpart of message2. */
8119 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8121 struct frame
*sf
= SELECTED_FRAME ();
8122 message_enable_multibyte
= multibyte
;
8124 if (FRAME_INITIAL_P (sf
))
8126 if (noninteractive_need_newline
)
8127 putc ('\n', stderr
);
8128 noninteractive_need_newline
= 0;
8130 fwrite (m
, nbytes
, 1, stderr
);
8131 if (cursor_in_echo_area
== 0)
8132 fprintf (stderr
, "\n");
8135 /* A null message buffer means that the frame hasn't really been
8136 initialized yet. Error messages get reported properly by
8137 cmd_error, so this must be just an informative message; toss it. */
8138 else if (INTERACTIVE
8139 && sf
->glyphs_initialized_p
8140 && FRAME_MESSAGE_BUF (sf
))
8142 Lisp_Object mini_window
;
8145 /* Get the frame containing the mini-buffer
8146 that the selected frame is using. */
8147 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8148 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8150 FRAME_SAMPLE_VISIBILITY (f
);
8151 if (FRAME_VISIBLE_P (sf
)
8152 && ! FRAME_VISIBLE_P (f
))
8153 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8157 set_message (m
, Qnil
, nbytes
, multibyte
);
8158 if (minibuffer_auto_raise
)
8159 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8162 clear_message (1, 1);
8164 do_pending_window_change (0);
8165 echo_area_display (1);
8166 do_pending_window_change (0);
8167 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8168 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8173 /* Display an echo area message M with a specified length of NBYTES
8174 bytes. The string may include null characters. If M is not a
8175 string, clear out any existing message, and let the mini-buffer
8178 This function cancels echoing. */
8181 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8183 struct gcpro gcpro1
;
8186 clear_message (1,1);
8189 /* First flush out any partial line written with print. */
8190 message_log_maybe_newline ();
8196 SAFE_ALLOCA (buffer
, char *, nbytes
);
8197 memcpy (buffer
, SDATA (m
), nbytes
);
8198 message_dolog (buffer
, nbytes
, 1, multibyte
);
8201 message3_nolog (m
, nbytes
, multibyte
);
8207 /* The non-logging version of message3.
8208 This does not cancel echoing, because it is used for echoing.
8209 Perhaps we need to make a separate function for echoing
8210 and make this cancel echoing. */
8213 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8215 struct frame
*sf
= SELECTED_FRAME ();
8216 message_enable_multibyte
= multibyte
;
8218 if (FRAME_INITIAL_P (sf
))
8220 if (noninteractive_need_newline
)
8221 putc ('\n', stderr
);
8222 noninteractive_need_newline
= 0;
8224 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8225 if (cursor_in_echo_area
== 0)
8226 fprintf (stderr
, "\n");
8229 /* A null message buffer means that the frame hasn't really been
8230 initialized yet. Error messages get reported properly by
8231 cmd_error, so this must be just an informative message; toss it. */
8232 else if (INTERACTIVE
8233 && sf
->glyphs_initialized_p
8234 && FRAME_MESSAGE_BUF (sf
))
8236 Lisp_Object mini_window
;
8240 /* Get the frame containing the mini-buffer
8241 that the selected frame is using. */
8242 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8243 frame
= XWINDOW (mini_window
)->frame
;
8246 FRAME_SAMPLE_VISIBILITY (f
);
8247 if (FRAME_VISIBLE_P (sf
)
8248 && !FRAME_VISIBLE_P (f
))
8249 Fmake_frame_visible (frame
);
8251 if (STRINGP (m
) && SCHARS (m
) > 0)
8253 set_message (NULL
, m
, nbytes
, multibyte
);
8254 if (minibuffer_auto_raise
)
8255 Fraise_frame (frame
);
8256 /* Assume we are not echoing.
8257 (If we are, echo_now will override this.) */
8258 echo_message_buffer
= Qnil
;
8261 clear_message (1, 1);
8263 do_pending_window_change (0);
8264 echo_area_display (1);
8265 do_pending_window_change (0);
8266 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8267 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8272 /* Display a null-terminated echo area message M. If M is 0, clear
8273 out any existing message, and let the mini-buffer text show through.
8275 The buffer M must continue to exist until after the echo area gets
8276 cleared or some other message gets displayed there. Do not pass
8277 text that is stored in a Lisp string. Do not pass text in a buffer
8278 that was alloca'd. */
8281 message1 (const char *m
)
8283 message2 (m
, (m
? strlen (m
) : 0), 0);
8287 /* The non-logging counterpart of message1. */
8290 message1_nolog (const char *m
)
8292 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8295 /* Display a message M which contains a single %s
8296 which gets replaced with STRING. */
8299 message_with_string (const char *m
, Lisp_Object string
, int log
)
8301 CHECK_STRING (string
);
8307 if (noninteractive_need_newline
)
8308 putc ('\n', stderr
);
8309 noninteractive_need_newline
= 0;
8310 fprintf (stderr
, m
, SDATA (string
));
8311 if (!cursor_in_echo_area
)
8312 fprintf (stderr
, "\n");
8316 else if (INTERACTIVE
)
8318 /* The frame whose minibuffer we're going to display the message on.
8319 It may be larger than the selected frame, so we need
8320 to use its buffer, not the selected frame's buffer. */
8321 Lisp_Object mini_window
;
8322 struct frame
*f
, *sf
= SELECTED_FRAME ();
8324 /* Get the frame containing the minibuffer
8325 that the selected frame is using. */
8326 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8327 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8329 /* A null message buffer means that the frame hasn't really been
8330 initialized yet. Error messages get reported properly by
8331 cmd_error, so this must be just an informative message; toss it. */
8332 if (FRAME_MESSAGE_BUF (f
))
8334 Lisp_Object args
[2], msg
;
8335 struct gcpro gcpro1
, gcpro2
;
8337 args
[0] = build_string (m
);
8338 args
[1] = msg
= string
;
8339 GCPRO2 (args
[0], msg
);
8342 msg
= Fformat (2, args
);
8345 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8347 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8351 /* Print should start at the beginning of the message
8352 buffer next time. */
8353 message_buf_print
= 0;
8359 /* Dump an informative message to the minibuf. If M is 0, clear out
8360 any existing message, and let the mini-buffer text show through. */
8363 vmessage (const char *m
, va_list ap
)
8369 if (noninteractive_need_newline
)
8370 putc ('\n', stderr
);
8371 noninteractive_need_newline
= 0;
8372 vfprintf (stderr
, m
, ap
);
8373 if (cursor_in_echo_area
== 0)
8374 fprintf (stderr
, "\n");
8378 else if (INTERACTIVE
)
8380 /* The frame whose mini-buffer we're going to display the message
8381 on. It may be larger than the selected frame, so we need to
8382 use its buffer, not the selected frame's buffer. */
8383 Lisp_Object mini_window
;
8384 struct frame
*f
, *sf
= SELECTED_FRAME ();
8386 /* Get the frame containing the mini-buffer
8387 that the selected frame is using. */
8388 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8389 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8391 /* A null message buffer means that the frame hasn't really been
8392 initialized yet. Error messages get reported properly by
8393 cmd_error, so this must be just an informative message; toss
8395 if (FRAME_MESSAGE_BUF (f
))
8401 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8402 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8404 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8409 /* Print should start at the beginning of the message
8410 buffer next time. */
8411 message_buf_print
= 0;
8417 message (const char *m
, ...)
8426 /* The non-logging version of message. */
8429 message_nolog (const char *m
, ...)
8431 Lisp_Object old_log_max
;
8434 old_log_max
= Vmessage_log_max
;
8435 Vmessage_log_max
= Qnil
;
8437 Vmessage_log_max
= old_log_max
;
8442 /* Display the current message in the current mini-buffer. This is
8443 only called from error handlers in process.c, and is not time
8447 update_echo_area (void)
8449 if (!NILP (echo_area_buffer
[0]))
8452 string
= Fcurrent_message ();
8453 message3 (string
, SBYTES (string
),
8454 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8459 /* Make sure echo area buffers in `echo_buffers' are live.
8460 If they aren't, make new ones. */
8463 ensure_echo_area_buffers (void)
8467 for (i
= 0; i
< 2; ++i
)
8468 if (!BUFFERP (echo_buffer
[i
])
8469 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8472 Lisp_Object old_buffer
;
8475 old_buffer
= echo_buffer
[i
];
8476 sprintf (name
, " *Echo Area %d*", i
);
8477 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8478 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8479 /* to force word wrap in echo area -
8480 it was decided to postpone this*/
8481 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8483 for (j
= 0; j
< 2; ++j
)
8484 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8485 echo_area_buffer
[j
] = echo_buffer
[i
];
8490 /* Call FN with args A1..A4 with either the current or last displayed
8491 echo_area_buffer as current buffer.
8493 WHICH zero means use the current message buffer
8494 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8495 from echo_buffer[] and clear it.
8497 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8498 suitable buffer from echo_buffer[] and clear it.
8500 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8501 that the current message becomes the last displayed one, make
8502 choose a suitable buffer for echo_area_buffer[0], and clear it.
8504 Value is what FN returns. */
8507 with_echo_area_buffer (struct window
*w
, int which
,
8508 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8509 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8512 int this_one
, the_other
, clear_buffer_p
, rc
;
8513 int count
= SPECPDL_INDEX ();
8515 /* If buffers aren't live, make new ones. */
8516 ensure_echo_area_buffers ();
8521 this_one
= 0, the_other
= 1;
8523 this_one
= 1, the_other
= 0;
8526 this_one
= 0, the_other
= 1;
8529 /* We need a fresh one in case the current echo buffer equals
8530 the one containing the last displayed echo area message. */
8531 if (!NILP (echo_area_buffer
[this_one
])
8532 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8533 echo_area_buffer
[this_one
] = Qnil
;
8536 /* Choose a suitable buffer from echo_buffer[] is we don't
8538 if (NILP (echo_area_buffer
[this_one
]))
8540 echo_area_buffer
[this_one
]
8541 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8542 ? echo_buffer
[the_other
]
8543 : echo_buffer
[this_one
]);
8547 buffer
= echo_area_buffer
[this_one
];
8549 /* Don't get confused by reusing the buffer used for echoing
8550 for a different purpose. */
8551 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8554 record_unwind_protect (unwind_with_echo_area_buffer
,
8555 with_echo_area_buffer_unwind_data (w
));
8557 /* Make the echo area buffer current. Note that for display
8558 purposes, it is not necessary that the displayed window's buffer
8559 == current_buffer, except for text property lookup. So, let's
8560 only set that buffer temporarily here without doing a full
8561 Fset_window_buffer. We must also change w->pointm, though,
8562 because otherwise an assertions in unshow_buffer fails, and Emacs
8564 set_buffer_internal_1 (XBUFFER (buffer
));
8568 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8571 BVAR (current_buffer
, undo_list
) = Qt
;
8572 BVAR (current_buffer
, read_only
) = Qnil
;
8573 specbind (Qinhibit_read_only
, Qt
);
8574 specbind (Qinhibit_modification_hooks
, Qt
);
8576 if (clear_buffer_p
&& Z
> BEG
)
8579 xassert (BEGV
>= BEG
);
8580 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8582 rc
= fn (a1
, a2
, a3
, a4
);
8584 xassert (BEGV
>= BEG
);
8585 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8587 unbind_to (count
, Qnil
);
8592 /* Save state that should be preserved around the call to the function
8593 FN called in with_echo_area_buffer. */
8596 with_echo_area_buffer_unwind_data (struct window
*w
)
8599 Lisp_Object vector
, tmp
;
8601 /* Reduce consing by keeping one vector in
8602 Vwith_echo_area_save_vector. */
8603 vector
= Vwith_echo_area_save_vector
;
8604 Vwith_echo_area_save_vector
= Qnil
;
8607 vector
= Fmake_vector (make_number (7), Qnil
);
8609 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8610 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8611 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8615 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8616 ASET (vector
, i
, w
->buffer
); ++i
;
8617 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8618 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8623 for (; i
< end
; ++i
)
8624 ASET (vector
, i
, Qnil
);
8627 xassert (i
== ASIZE (vector
));
8632 /* Restore global state from VECTOR which was created by
8633 with_echo_area_buffer_unwind_data. */
8636 unwind_with_echo_area_buffer (Lisp_Object vector
)
8638 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8639 Vdeactivate_mark
= AREF (vector
, 1);
8640 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8642 if (WINDOWP (AREF (vector
, 3)))
8645 Lisp_Object buffer
, charpos
, bytepos
;
8647 w
= XWINDOW (AREF (vector
, 3));
8648 buffer
= AREF (vector
, 4);
8649 charpos
= AREF (vector
, 5);
8650 bytepos
= AREF (vector
, 6);
8653 set_marker_both (w
->pointm
, buffer
,
8654 XFASTINT (charpos
), XFASTINT (bytepos
));
8657 Vwith_echo_area_save_vector
= vector
;
8662 /* Set up the echo area for use by print functions. MULTIBYTE_P
8663 non-zero means we will print multibyte. */
8666 setup_echo_area_for_printing (int multibyte_p
)
8668 /* If we can't find an echo area any more, exit. */
8669 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8672 ensure_echo_area_buffers ();
8674 if (!message_buf_print
)
8676 /* A message has been output since the last time we printed.
8677 Choose a fresh echo area buffer. */
8678 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8679 echo_area_buffer
[0] = echo_buffer
[1];
8681 echo_area_buffer
[0] = echo_buffer
[0];
8683 /* Switch to that buffer and clear it. */
8684 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8685 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8689 int count
= SPECPDL_INDEX ();
8690 specbind (Qinhibit_read_only
, Qt
);
8691 /* Note that undo recording is always disabled. */
8693 unbind_to (count
, Qnil
);
8695 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8697 /* Set up the buffer for the multibyteness we need. */
8699 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8700 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8702 /* Raise the frame containing the echo area. */
8703 if (minibuffer_auto_raise
)
8705 struct frame
*sf
= SELECTED_FRAME ();
8706 Lisp_Object mini_window
;
8707 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8708 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8711 message_log_maybe_newline ();
8712 message_buf_print
= 1;
8716 if (NILP (echo_area_buffer
[0]))
8718 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8719 echo_area_buffer
[0] = echo_buffer
[1];
8721 echo_area_buffer
[0] = echo_buffer
[0];
8724 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8726 /* Someone switched buffers between print requests. */
8727 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8728 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8734 /* Display an echo area message in window W. Value is non-zero if W's
8735 height is changed. If display_last_displayed_message_p is
8736 non-zero, display the message that was last displayed, otherwise
8737 display the current message. */
8740 display_echo_area (struct window
*w
)
8742 int i
, no_message_p
, window_height_changed_p
, count
;
8744 /* Temporarily disable garbage collections while displaying the echo
8745 area. This is done because a GC can print a message itself.
8746 That message would modify the echo area buffer's contents while a
8747 redisplay of the buffer is going on, and seriously confuse
8749 count
= inhibit_garbage_collection ();
8751 /* If there is no message, we must call display_echo_area_1
8752 nevertheless because it resizes the window. But we will have to
8753 reset the echo_area_buffer in question to nil at the end because
8754 with_echo_area_buffer will sets it to an empty buffer. */
8755 i
= display_last_displayed_message_p
? 1 : 0;
8756 no_message_p
= NILP (echo_area_buffer
[i
]);
8758 window_height_changed_p
8759 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8760 display_echo_area_1
,
8761 (EMACS_INT
) w
, Qnil
, 0, 0);
8764 echo_area_buffer
[i
] = Qnil
;
8766 unbind_to (count
, Qnil
);
8767 return window_height_changed_p
;
8771 /* Helper for display_echo_area. Display the current buffer which
8772 contains the current echo area message in window W, a mini-window,
8773 a pointer to which is passed in A1. A2..A4 are currently not used.
8774 Change the height of W so that all of the message is displayed.
8775 Value is non-zero if height of W was changed. */
8778 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8780 struct window
*w
= (struct window
*) a1
;
8782 struct text_pos start
;
8783 int window_height_changed_p
= 0;
8785 /* Do this before displaying, so that we have a large enough glyph
8786 matrix for the display. If we can't get enough space for the
8787 whole text, display the last N lines. That works by setting w->start. */
8788 window_height_changed_p
= resize_mini_window (w
, 0);
8790 /* Use the starting position chosen by resize_mini_window. */
8791 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8794 clear_glyph_matrix (w
->desired_matrix
);
8795 XSETWINDOW (window
, w
);
8796 try_window (window
, start
, 0);
8798 return window_height_changed_p
;
8802 /* Resize the echo area window to exactly the size needed for the
8803 currently displayed message, if there is one. If a mini-buffer
8804 is active, don't shrink it. */
8807 resize_echo_area_exactly (void)
8809 if (BUFFERP (echo_area_buffer
[0])
8810 && WINDOWP (echo_area_window
))
8812 struct window
*w
= XWINDOW (echo_area_window
);
8814 Lisp_Object resize_exactly
;
8816 if (minibuf_level
== 0)
8817 resize_exactly
= Qt
;
8819 resize_exactly
= Qnil
;
8821 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8822 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8825 ++windows_or_buffers_changed
;
8826 ++update_mode_lines
;
8827 redisplay_internal (0);
8833 /* Callback function for with_echo_area_buffer, when used from
8834 resize_echo_area_exactly. A1 contains a pointer to the window to
8835 resize, EXACTLY non-nil means resize the mini-window exactly to the
8836 size of the text displayed. A3 and A4 are not used. Value is what
8837 resize_mini_window returns. */
8840 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8842 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8846 /* Resize mini-window W to fit the size of its contents. EXACT_P
8847 means size the window exactly to the size needed. Otherwise, it's
8848 only enlarged until W's buffer is empty.
8850 Set W->start to the right place to begin display. If the whole
8851 contents fit, start at the beginning. Otherwise, start so as
8852 to make the end of the contents appear. This is particularly
8853 important for y-or-n-p, but seems desirable generally.
8855 Value is non-zero if the window height has been changed. */
8858 resize_mini_window (struct window
*w
, int exact_p
)
8860 struct frame
*f
= XFRAME (w
->frame
);
8861 int window_height_changed_p
= 0;
8863 xassert (MINI_WINDOW_P (w
));
8865 /* By default, start display at the beginning. */
8866 set_marker_both (w
->start
, w
->buffer
,
8867 BUF_BEGV (XBUFFER (w
->buffer
)),
8868 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8870 /* Don't resize windows while redisplaying a window; it would
8871 confuse redisplay functions when the size of the window they are
8872 displaying changes from under them. Such a resizing can happen,
8873 for instance, when which-func prints a long message while
8874 we are running fontification-functions. We're running these
8875 functions with safe_call which binds inhibit-redisplay to t. */
8876 if (!NILP (Vinhibit_redisplay
))
8879 /* Nil means don't try to resize. */
8880 if (NILP (Vresize_mini_windows
)
8881 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8884 if (!FRAME_MINIBUF_ONLY_P (f
))
8887 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8888 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8889 int height
, max_height
;
8890 int unit
= FRAME_LINE_HEIGHT (f
);
8891 struct text_pos start
;
8892 struct buffer
*old_current_buffer
= NULL
;
8894 if (current_buffer
!= XBUFFER (w
->buffer
))
8896 old_current_buffer
= current_buffer
;
8897 set_buffer_internal (XBUFFER (w
->buffer
));
8900 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8902 /* Compute the max. number of lines specified by the user. */
8903 if (FLOATP (Vmax_mini_window_height
))
8904 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8905 else if (INTEGERP (Vmax_mini_window_height
))
8906 max_height
= XINT (Vmax_mini_window_height
);
8908 max_height
= total_height
/ 4;
8910 /* Correct that max. height if it's bogus. */
8911 max_height
= max (1, max_height
);
8912 max_height
= min (total_height
, max_height
);
8914 /* Find out the height of the text in the window. */
8915 if (it
.line_wrap
== TRUNCATE
)
8920 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8921 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8922 height
= it
.current_y
+ last_height
;
8924 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8925 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8926 height
= (height
+ unit
- 1) / unit
;
8929 /* Compute a suitable window start. */
8930 if (height
> max_height
)
8932 height
= max_height
;
8933 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8934 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8935 start
= it
.current
.pos
;
8938 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8939 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8941 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8943 /* Let it grow only, until we display an empty message, in which
8944 case the window shrinks again. */
8945 if (height
> WINDOW_TOTAL_LINES (w
))
8947 int old_height
= WINDOW_TOTAL_LINES (w
);
8948 freeze_window_starts (f
, 1);
8949 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8950 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8952 else if (height
< WINDOW_TOTAL_LINES (w
)
8953 && (exact_p
|| BEGV
== ZV
))
8955 int old_height
= WINDOW_TOTAL_LINES (w
);
8956 freeze_window_starts (f
, 0);
8957 shrink_mini_window (w
);
8958 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8963 /* Always resize to exact size needed. */
8964 if (height
> WINDOW_TOTAL_LINES (w
))
8966 int old_height
= WINDOW_TOTAL_LINES (w
);
8967 freeze_window_starts (f
, 1);
8968 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8969 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8971 else if (height
< WINDOW_TOTAL_LINES (w
))
8973 int old_height
= WINDOW_TOTAL_LINES (w
);
8974 freeze_window_starts (f
, 0);
8975 shrink_mini_window (w
);
8979 freeze_window_starts (f
, 1);
8980 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8983 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8987 if (old_current_buffer
)
8988 set_buffer_internal (old_current_buffer
);
8991 return window_height_changed_p
;
8995 /* Value is the current message, a string, or nil if there is no
8999 current_message (void)
9003 if (!BUFFERP (echo_area_buffer
[0]))
9007 with_echo_area_buffer (0, 0, current_message_1
,
9008 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9010 echo_area_buffer
[0] = Qnil
;
9018 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9020 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9023 *msg
= make_buffer_string (BEG
, Z
, 1);
9030 /* Push the current message on Vmessage_stack for later restauration
9031 by restore_message. Value is non-zero if the current message isn't
9032 empty. This is a relatively infrequent operation, so it's not
9033 worth optimizing. */
9039 msg
= current_message ();
9040 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9041 return STRINGP (msg
);
9045 /* Restore message display from the top of Vmessage_stack. */
9048 restore_message (void)
9052 xassert (CONSP (Vmessage_stack
));
9053 msg
= XCAR (Vmessage_stack
);
9055 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9057 message3_nolog (msg
, 0, 0);
9061 /* Handler for record_unwind_protect calling pop_message. */
9064 pop_message_unwind (Lisp_Object dummy
)
9070 /* Pop the top-most entry off Vmessage_stack. */
9075 xassert (CONSP (Vmessage_stack
));
9076 Vmessage_stack
= XCDR (Vmessage_stack
);
9080 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9081 exits. If the stack is not empty, we have a missing pop_message
9085 check_message_stack (void)
9087 if (!NILP (Vmessage_stack
))
9092 /* Truncate to NCHARS what will be displayed in the echo area the next
9093 time we display it---but don't redisplay it now. */
9096 truncate_echo_area (EMACS_INT nchars
)
9099 echo_area_buffer
[0] = Qnil
;
9100 /* A null message buffer means that the frame hasn't really been
9101 initialized yet. Error messages get reported properly by
9102 cmd_error, so this must be just an informative message; toss it. */
9103 else if (!noninteractive
9105 && !NILP (echo_area_buffer
[0]))
9107 struct frame
*sf
= SELECTED_FRAME ();
9108 if (FRAME_MESSAGE_BUF (sf
))
9109 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9114 /* Helper function for truncate_echo_area. Truncate the current
9115 message to at most NCHARS characters. */
9118 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9120 if (BEG
+ nchars
< Z
)
9121 del_range (BEG
+ nchars
, Z
);
9123 echo_area_buffer
[0] = Qnil
;
9128 /* Set the current message to a substring of S or STRING.
9130 If STRING is a Lisp string, set the message to the first NBYTES
9131 bytes from STRING. NBYTES zero means use the whole string. If
9132 STRING is multibyte, the message will be displayed multibyte.
9134 If S is not null, set the message to the first LEN bytes of S. LEN
9135 zero means use the whole string. MULTIBYTE_P non-zero means S is
9136 multibyte. Display the message multibyte in that case.
9138 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9139 to t before calling set_message_1 (which calls insert).
9143 set_message (const char *s
, Lisp_Object string
,
9144 EMACS_INT nbytes
, int multibyte_p
)
9146 message_enable_multibyte
9147 = ((s
&& multibyte_p
)
9148 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9150 with_echo_area_buffer (0, -1, set_message_1
,
9151 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9152 message_buf_print
= 0;
9153 help_echo_showing_p
= 0;
9157 /* Helper function for set_message. Arguments have the same meaning
9158 as there, with A1 corresponding to S and A2 corresponding to STRING
9159 This function is called with the echo area buffer being
9163 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9165 const char *s
= (const char *) a1
;
9166 const unsigned char *msg
= (const unsigned char *) s
;
9167 Lisp_Object string
= a2
;
9169 /* Change multibyteness of the echo buffer appropriately. */
9170 if (message_enable_multibyte
9171 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9172 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9174 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9175 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9176 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9178 /* Insert new message at BEG. */
9179 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9181 if (STRINGP (string
))
9186 nbytes
= SBYTES (string
);
9187 nchars
= string_byte_to_char (string
, nbytes
);
9189 /* This function takes care of single/multibyte conversion. We
9190 just have to ensure that the echo area buffer has the right
9191 setting of enable_multibyte_characters. */
9192 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9197 nbytes
= strlen (s
);
9199 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9201 /* Convert from multi-byte to single-byte. */
9206 /* Convert a multibyte string to single-byte. */
9207 for (i
= 0; i
< nbytes
; i
+= n
)
9209 c
= string_char_and_length (msg
+ i
, &n
);
9210 work
[0] = (ASCII_CHAR_P (c
)
9212 : multibyte_char_to_unibyte (c
, Qnil
));
9213 insert_1_both (work
, 1, 1, 1, 0, 0);
9216 else if (!multibyte_p
9217 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9219 /* Convert from single-byte to multi-byte. */
9222 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9224 /* Convert a single-byte string to multibyte. */
9225 for (i
= 0; i
< nbytes
; i
++)
9228 MAKE_CHAR_MULTIBYTE (c
);
9229 n
= CHAR_STRING (c
, str
);
9230 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9234 insert_1 (s
, nbytes
, 1, 0, 0);
9241 /* Clear messages. CURRENT_P non-zero means clear the current
9242 message. LAST_DISPLAYED_P non-zero means clear the message
9246 clear_message (int current_p
, int last_displayed_p
)
9250 echo_area_buffer
[0] = Qnil
;
9251 message_cleared_p
= 1;
9254 if (last_displayed_p
)
9255 echo_area_buffer
[1] = Qnil
;
9257 message_buf_print
= 0;
9260 /* Clear garbaged frames.
9262 This function is used where the old redisplay called
9263 redraw_garbaged_frames which in turn called redraw_frame which in
9264 turn called clear_frame. The call to clear_frame was a source of
9265 flickering. I believe a clear_frame is not necessary. It should
9266 suffice in the new redisplay to invalidate all current matrices,
9267 and ensure a complete redisplay of all windows. */
9270 clear_garbaged_frames (void)
9274 Lisp_Object tail
, frame
;
9275 int changed_count
= 0;
9277 FOR_EACH_FRAME (tail
, frame
)
9279 struct frame
*f
= XFRAME (frame
);
9281 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9285 Fredraw_frame (frame
);
9286 f
->force_flush_display_p
= 1;
9288 clear_current_matrices (f
);
9297 ++windows_or_buffers_changed
;
9302 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9303 is non-zero update selected_frame. Value is non-zero if the
9304 mini-windows height has been changed. */
9307 echo_area_display (int update_frame_p
)
9309 Lisp_Object mini_window
;
9312 int window_height_changed_p
= 0;
9313 struct frame
*sf
= SELECTED_FRAME ();
9315 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9316 w
= XWINDOW (mini_window
);
9317 f
= XFRAME (WINDOW_FRAME (w
));
9319 /* Don't display if frame is invisible or not yet initialized. */
9320 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9323 #ifdef HAVE_WINDOW_SYSTEM
9324 /* When Emacs starts, selected_frame may be the initial terminal
9325 frame. If we let this through, a message would be displayed on
9327 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9329 #endif /* HAVE_WINDOW_SYSTEM */
9331 /* Redraw garbaged frames. */
9333 clear_garbaged_frames ();
9335 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9337 echo_area_window
= mini_window
;
9338 window_height_changed_p
= display_echo_area (w
);
9339 w
->must_be_updated_p
= 1;
9341 /* Update the display, unless called from redisplay_internal.
9342 Also don't update the screen during redisplay itself. The
9343 update will happen at the end of redisplay, and an update
9344 here could cause confusion. */
9345 if (update_frame_p
&& !redisplaying_p
)
9349 /* If the display update has been interrupted by pending
9350 input, update mode lines in the frame. Due to the
9351 pending input, it might have been that redisplay hasn't
9352 been called, so that mode lines above the echo area are
9353 garbaged. This looks odd, so we prevent it here. */
9354 if (!display_completed
)
9355 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9357 if (window_height_changed_p
9358 /* Don't do this if Emacs is shutting down. Redisplay
9359 needs to run hooks. */
9360 && !NILP (Vrun_hooks
))
9362 /* Must update other windows. Likewise as in other
9363 cases, don't let this update be interrupted by
9365 int count
= SPECPDL_INDEX ();
9366 specbind (Qredisplay_dont_pause
, Qt
);
9367 windows_or_buffers_changed
= 1;
9368 redisplay_internal (0);
9369 unbind_to (count
, Qnil
);
9371 else if (FRAME_WINDOW_P (f
) && n
== 0)
9373 /* Window configuration is the same as before.
9374 Can do with a display update of the echo area,
9375 unless we displayed some mode lines. */
9376 update_single_window (w
, 1);
9377 FRAME_RIF (f
)->flush_display (f
);
9380 update_frame (f
, 1, 1);
9382 /* If cursor is in the echo area, make sure that the next
9383 redisplay displays the minibuffer, so that the cursor will
9384 be replaced with what the minibuffer wants. */
9385 if (cursor_in_echo_area
)
9386 ++windows_or_buffers_changed
;
9389 else if (!EQ (mini_window
, selected_window
))
9390 windows_or_buffers_changed
++;
9392 /* Last displayed message is now the current message. */
9393 echo_area_buffer
[1] = echo_area_buffer
[0];
9394 /* Inform read_char that we're not echoing. */
9395 echo_message_buffer
= Qnil
;
9397 /* Prevent redisplay optimization in redisplay_internal by resetting
9398 this_line_start_pos. This is done because the mini-buffer now
9399 displays the message instead of its buffer text. */
9400 if (EQ (mini_window
, selected_window
))
9401 CHARPOS (this_line_start_pos
) = 0;
9403 return window_height_changed_p
;
9408 /***********************************************************************
9409 Mode Lines and Frame Titles
9410 ***********************************************************************/
9412 /* A buffer for constructing non-propertized mode-line strings and
9413 frame titles in it; allocated from the heap in init_xdisp and
9414 resized as needed in store_mode_line_noprop_char. */
9416 static char *mode_line_noprop_buf
;
9418 /* The buffer's end, and a current output position in it. */
9420 static char *mode_line_noprop_buf_end
;
9421 static char *mode_line_noprop_ptr
;
9423 #define MODE_LINE_NOPROP_LEN(start) \
9424 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9427 MODE_LINE_DISPLAY
= 0,
9433 /* Alist that caches the results of :propertize.
9434 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9435 static Lisp_Object mode_line_proptrans_alist
;
9437 /* List of strings making up the mode-line. */
9438 static Lisp_Object mode_line_string_list
;
9440 /* Base face property when building propertized mode line string. */
9441 static Lisp_Object mode_line_string_face
;
9442 static Lisp_Object mode_line_string_face_prop
;
9445 /* Unwind data for mode line strings */
9447 static Lisp_Object Vmode_line_unwind_vector
;
9450 format_mode_line_unwind_data (struct buffer
*obuf
,
9454 Lisp_Object vector
, tmp
;
9456 /* Reduce consing by keeping one vector in
9457 Vwith_echo_area_save_vector. */
9458 vector
= Vmode_line_unwind_vector
;
9459 Vmode_line_unwind_vector
= Qnil
;
9462 vector
= Fmake_vector (make_number (8), Qnil
);
9464 ASET (vector
, 0, make_number (mode_line_target
));
9465 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9466 ASET (vector
, 2, mode_line_string_list
);
9467 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9468 ASET (vector
, 4, mode_line_string_face
);
9469 ASET (vector
, 5, mode_line_string_face_prop
);
9472 XSETBUFFER (tmp
, obuf
);
9475 ASET (vector
, 6, tmp
);
9476 ASET (vector
, 7, owin
);
9482 unwind_format_mode_line (Lisp_Object vector
)
9484 mode_line_target
= XINT (AREF (vector
, 0));
9485 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9486 mode_line_string_list
= AREF (vector
, 2);
9487 if (! EQ (AREF (vector
, 3), Qt
))
9488 mode_line_proptrans_alist
= AREF (vector
, 3);
9489 mode_line_string_face
= AREF (vector
, 4);
9490 mode_line_string_face_prop
= AREF (vector
, 5);
9492 if (!NILP (AREF (vector
, 7)))
9493 /* Select window before buffer, since it may change the buffer. */
9494 Fselect_window (AREF (vector
, 7), Qt
);
9496 if (!NILP (AREF (vector
, 6)))
9498 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9499 ASET (vector
, 6, Qnil
);
9502 Vmode_line_unwind_vector
= vector
;
9507 /* Store a single character C for the frame title in mode_line_noprop_buf.
9508 Re-allocate mode_line_noprop_buf if necessary. */
9511 store_mode_line_noprop_char (char c
)
9513 /* If output position has reached the end of the allocated buffer,
9514 double the buffer's size. */
9515 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9517 int len
= MODE_LINE_NOPROP_LEN (0);
9518 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9519 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9520 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9521 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9524 *mode_line_noprop_ptr
++ = c
;
9528 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9529 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9530 characters that yield more columns than PRECISION; PRECISION <= 0
9531 means copy the whole string. Pad with spaces until FIELD_WIDTH
9532 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9533 pad. Called from display_mode_element when it is used to build a
9537 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9539 const unsigned char *str
= (const unsigned char *) string
;
9541 EMACS_INT dummy
, nbytes
;
9543 /* Copy at most PRECISION chars from STR. */
9544 nbytes
= strlen (string
);
9545 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9547 store_mode_line_noprop_char (*str
++);
9549 /* Fill up with spaces until FIELD_WIDTH reached. */
9550 while (field_width
> 0
9553 store_mode_line_noprop_char (' ');
9560 /***********************************************************************
9562 ***********************************************************************/
9564 #ifdef HAVE_WINDOW_SYSTEM
9566 /* Set the title of FRAME, if it has changed. The title format is
9567 Vicon_title_format if FRAME is iconified, otherwise it is
9568 frame_title_format. */
9571 x_consider_frame_title (Lisp_Object frame
)
9573 struct frame
*f
= XFRAME (frame
);
9575 if (FRAME_WINDOW_P (f
)
9576 || FRAME_MINIBUF_ONLY_P (f
)
9577 || f
->explicit_name
)
9579 /* Do we have more than one visible frame on this X display? */
9586 int count
= SPECPDL_INDEX ();
9588 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9590 Lisp_Object other_frame
= XCAR (tail
);
9591 struct frame
*tf
= XFRAME (other_frame
);
9594 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9595 && !FRAME_MINIBUF_ONLY_P (tf
)
9596 && !EQ (other_frame
, tip_frame
)
9597 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9601 /* Set global variable indicating that multiple frames exist. */
9602 multiple_frames
= CONSP (tail
);
9604 /* Switch to the buffer of selected window of the frame. Set up
9605 mode_line_target so that display_mode_element will output into
9606 mode_line_noprop_buf; then display the title. */
9607 record_unwind_protect (unwind_format_mode_line
,
9608 format_mode_line_unwind_data
9609 (current_buffer
, selected_window
, 0));
9611 Fselect_window (f
->selected_window
, Qt
);
9612 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9613 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9615 mode_line_target
= MODE_LINE_TITLE
;
9616 title_start
= MODE_LINE_NOPROP_LEN (0);
9617 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9618 NULL
, DEFAULT_FACE_ID
);
9619 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9620 len
= MODE_LINE_NOPROP_LEN (title_start
);
9621 title
= mode_line_noprop_buf
+ title_start
;
9622 unbind_to (count
, Qnil
);
9624 /* Set the title only if it's changed. This avoids consing in
9625 the common case where it hasn't. (If it turns out that we've
9626 already wasted too much time by walking through the list with
9627 display_mode_element, then we might need to optimize at a
9628 higher level than this.) */
9629 if (! STRINGP (f
->name
)
9630 || SBYTES (f
->name
) != len
9631 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9632 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9636 #endif /* not HAVE_WINDOW_SYSTEM */
9641 /***********************************************************************
9643 ***********************************************************************/
9646 /* Prepare for redisplay by updating menu-bar item lists when
9647 appropriate. This can call eval. */
9650 prepare_menu_bars (void)
9653 struct gcpro gcpro1
, gcpro2
;
9655 Lisp_Object tooltip_frame
;
9657 #ifdef HAVE_WINDOW_SYSTEM
9658 tooltip_frame
= tip_frame
;
9660 tooltip_frame
= Qnil
;
9663 /* Update all frame titles based on their buffer names, etc. We do
9664 this before the menu bars so that the buffer-menu will show the
9665 up-to-date frame titles. */
9666 #ifdef HAVE_WINDOW_SYSTEM
9667 if (windows_or_buffers_changed
|| update_mode_lines
)
9669 Lisp_Object tail
, frame
;
9671 FOR_EACH_FRAME (tail
, frame
)
9674 if (!EQ (frame
, tooltip_frame
)
9675 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9676 x_consider_frame_title (frame
);
9679 #endif /* HAVE_WINDOW_SYSTEM */
9681 /* Update the menu bar item lists, if appropriate. This has to be
9682 done before any actual redisplay or generation of display lines. */
9683 all_windows
= (update_mode_lines
9684 || buffer_shared
> 1
9685 || windows_or_buffers_changed
);
9688 Lisp_Object tail
, frame
;
9689 int count
= SPECPDL_INDEX ();
9690 /* 1 means that update_menu_bar has run its hooks
9691 so any further calls to update_menu_bar shouldn't do so again. */
9692 int menu_bar_hooks_run
= 0;
9694 record_unwind_save_match_data ();
9696 FOR_EACH_FRAME (tail
, frame
)
9700 /* Ignore tooltip frame. */
9701 if (EQ (frame
, tooltip_frame
))
9704 /* If a window on this frame changed size, report that to
9705 the user and clear the size-change flag. */
9706 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9708 Lisp_Object functions
;
9710 /* Clear flag first in case we get an error below. */
9711 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9712 functions
= Vwindow_size_change_functions
;
9713 GCPRO2 (tail
, functions
);
9715 while (CONSP (functions
))
9717 if (!EQ (XCAR (functions
), Qt
))
9718 call1 (XCAR (functions
), frame
);
9719 functions
= XCDR (functions
);
9725 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9726 #ifdef HAVE_WINDOW_SYSTEM
9727 update_tool_bar (f
, 0);
9730 if (windows_or_buffers_changed
9732 ns_set_doc_edited (f
, Fbuffer_modified_p
9733 (XWINDOW (f
->selected_window
)->buffer
));
9738 unbind_to (count
, Qnil
);
9742 struct frame
*sf
= SELECTED_FRAME ();
9743 update_menu_bar (sf
, 1, 0);
9744 #ifdef HAVE_WINDOW_SYSTEM
9745 update_tool_bar (sf
, 1);
9751 /* Update the menu bar item list for frame F. This has to be done
9752 before we start to fill in any display lines, because it can call
9755 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9757 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9758 already ran the menu bar hooks for this redisplay, so there
9759 is no need to run them again. The return value is the
9760 updated value of this flag, to pass to the next call. */
9763 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9766 register struct window
*w
;
9768 /* If called recursively during a menu update, do nothing. This can
9769 happen when, for instance, an activate-menubar-hook causes a
9771 if (inhibit_menubar_update
)
9774 window
= FRAME_SELECTED_WINDOW (f
);
9775 w
= XWINDOW (window
);
9777 if (FRAME_WINDOW_P (f
)
9779 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9780 || defined (HAVE_NS) || defined (USE_GTK)
9781 FRAME_EXTERNAL_MENU_BAR (f
)
9783 FRAME_MENU_BAR_LINES (f
) > 0
9785 : FRAME_MENU_BAR_LINES (f
) > 0)
9787 /* If the user has switched buffers or windows, we need to
9788 recompute to reflect the new bindings. But we'll
9789 recompute when update_mode_lines is set too; that means
9790 that people can use force-mode-line-update to request
9791 that the menu bar be recomputed. The adverse effect on
9792 the rest of the redisplay algorithm is about the same as
9793 windows_or_buffers_changed anyway. */
9794 if (windows_or_buffers_changed
9795 /* This used to test w->update_mode_line, but we believe
9796 there is no need to recompute the menu in that case. */
9797 || update_mode_lines
9798 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9799 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9800 != !NILP (w
->last_had_star
))
9801 || ((!NILP (Vtransient_mark_mode
)
9802 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9803 != !NILP (w
->region_showing
)))
9805 struct buffer
*prev
= current_buffer
;
9806 int count
= SPECPDL_INDEX ();
9808 specbind (Qinhibit_menubar_update
, Qt
);
9810 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9811 if (save_match_data
)
9812 record_unwind_save_match_data ();
9813 if (NILP (Voverriding_local_map_menu_flag
))
9815 specbind (Qoverriding_terminal_local_map
, Qnil
);
9816 specbind (Qoverriding_local_map
, Qnil
);
9821 /* Run the Lucid hook. */
9822 safe_run_hooks (Qactivate_menubar_hook
);
9824 /* If it has changed current-menubar from previous value,
9825 really recompute the menu-bar from the value. */
9826 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9827 call0 (Qrecompute_lucid_menubar
);
9829 safe_run_hooks (Qmenu_bar_update_hook
);
9834 XSETFRAME (Vmenu_updating_frame
, f
);
9835 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9837 /* Redisplay the menu bar in case we changed it. */
9838 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9839 || defined (HAVE_NS) || defined (USE_GTK)
9840 if (FRAME_WINDOW_P (f
))
9842 #if defined (HAVE_NS)
9843 /* All frames on Mac OS share the same menubar. So only
9844 the selected frame should be allowed to set it. */
9845 if (f
== SELECTED_FRAME ())
9847 set_frame_menubar (f
, 0, 0);
9850 /* On a terminal screen, the menu bar is an ordinary screen
9851 line, and this makes it get updated. */
9852 w
->update_mode_line
= Qt
;
9853 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9854 /* In the non-toolkit version, the menu bar is an ordinary screen
9855 line, and this makes it get updated. */
9856 w
->update_mode_line
= Qt
;
9857 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9859 unbind_to (count
, Qnil
);
9860 set_buffer_internal_1 (prev
);
9869 /***********************************************************************
9871 ***********************************************************************/
9873 #ifdef HAVE_WINDOW_SYSTEM
9876 Nominal cursor position -- where to draw output.
9877 HPOS and VPOS are window relative glyph matrix coordinates.
9878 X and Y are window relative pixel coordinates. */
9880 struct cursor_pos output_cursor
;
9884 Set the global variable output_cursor to CURSOR. All cursor
9885 positions are relative to updated_window. */
9888 set_output_cursor (struct cursor_pos
*cursor
)
9890 output_cursor
.hpos
= cursor
->hpos
;
9891 output_cursor
.vpos
= cursor
->vpos
;
9892 output_cursor
.x
= cursor
->x
;
9893 output_cursor
.y
= cursor
->y
;
9898 Set a nominal cursor position.
9900 HPOS and VPOS are column/row positions in a window glyph matrix. X
9901 and Y are window text area relative pixel positions.
9903 If this is done during an update, updated_window will contain the
9904 window that is being updated and the position is the future output
9905 cursor position for that window. If updated_window is null, use
9906 selected_window and display the cursor at the given position. */
9909 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9913 /* If updated_window is not set, work on selected_window. */
9917 w
= XWINDOW (selected_window
);
9919 /* Set the output cursor. */
9920 output_cursor
.hpos
= hpos
;
9921 output_cursor
.vpos
= vpos
;
9922 output_cursor
.x
= x
;
9923 output_cursor
.y
= y
;
9925 /* If not called as part of an update, really display the cursor.
9926 This will also set the cursor position of W. */
9927 if (updated_window
== NULL
)
9930 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9931 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9932 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9937 #endif /* HAVE_WINDOW_SYSTEM */
9940 /***********************************************************************
9942 ***********************************************************************/
9944 #ifdef HAVE_WINDOW_SYSTEM
9946 /* Where the mouse was last time we reported a mouse event. */
9948 FRAME_PTR last_mouse_frame
;
9950 /* Tool-bar item index of the item on which a mouse button was pressed
9953 int last_tool_bar_item
;
9957 update_tool_bar_unwind (Lisp_Object frame
)
9959 selected_frame
= frame
;
9963 /* Update the tool-bar item list for frame F. This has to be done
9964 before we start to fill in any display lines. Called from
9965 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9966 and restore it here. */
9969 update_tool_bar (struct frame
*f
, int save_match_data
)
9971 #if defined (USE_GTK) || defined (HAVE_NS)
9972 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9974 int do_update
= WINDOWP (f
->tool_bar_window
)
9975 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9983 window
= FRAME_SELECTED_WINDOW (f
);
9984 w
= XWINDOW (window
);
9986 /* If the user has switched buffers or windows, we need to
9987 recompute to reflect the new bindings. But we'll
9988 recompute when update_mode_lines is set too; that means
9989 that people can use force-mode-line-update to request
9990 that the menu bar be recomputed. The adverse effect on
9991 the rest of the redisplay algorithm is about the same as
9992 windows_or_buffers_changed anyway. */
9993 if (windows_or_buffers_changed
9994 || !NILP (w
->update_mode_line
)
9995 || update_mode_lines
9996 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9997 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9998 != !NILP (w
->last_had_star
))
9999 || ((!NILP (Vtransient_mark_mode
)
10000 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10001 != !NILP (w
->region_showing
)))
10003 struct buffer
*prev
= current_buffer
;
10004 int count
= SPECPDL_INDEX ();
10005 Lisp_Object frame
, new_tool_bar
;
10006 int new_n_tool_bar
;
10007 struct gcpro gcpro1
;
10009 /* Set current_buffer to the buffer of the selected
10010 window of the frame, so that we get the right local
10012 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10014 /* Save match data, if we must. */
10015 if (save_match_data
)
10016 record_unwind_save_match_data ();
10018 /* Make sure that we don't accidentally use bogus keymaps. */
10019 if (NILP (Voverriding_local_map_menu_flag
))
10021 specbind (Qoverriding_terminal_local_map
, Qnil
);
10022 specbind (Qoverriding_local_map
, Qnil
);
10025 GCPRO1 (new_tool_bar
);
10027 /* We must temporarily set the selected frame to this frame
10028 before calling tool_bar_items, because the calculation of
10029 the tool-bar keymap uses the selected frame (see
10030 `tool-bar-make-keymap' in tool-bar.el). */
10031 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10032 XSETFRAME (frame
, f
);
10033 selected_frame
= frame
;
10035 /* Build desired tool-bar items from keymaps. */
10036 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10039 /* Redisplay the tool-bar if we changed it. */
10040 if (new_n_tool_bar
!= f
->n_tool_bar_items
10041 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10043 /* Redisplay that happens asynchronously due to an expose event
10044 may access f->tool_bar_items. Make sure we update both
10045 variables within BLOCK_INPUT so no such event interrupts. */
10047 f
->tool_bar_items
= new_tool_bar
;
10048 f
->n_tool_bar_items
= new_n_tool_bar
;
10049 w
->update_mode_line
= Qt
;
10055 unbind_to (count
, Qnil
);
10056 set_buffer_internal_1 (prev
);
10062 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10063 F's desired tool-bar contents. F->tool_bar_items must have
10064 been set up previously by calling prepare_menu_bars. */
10067 build_desired_tool_bar_string (struct frame
*f
)
10069 int i
, size
, size_needed
;
10070 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10071 Lisp_Object image
, plist
, props
;
10073 image
= plist
= props
= Qnil
;
10074 GCPRO3 (image
, plist
, props
);
10076 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10077 Otherwise, make a new string. */
10079 /* The size of the string we might be able to reuse. */
10080 size
= (STRINGP (f
->desired_tool_bar_string
)
10081 ? SCHARS (f
->desired_tool_bar_string
)
10084 /* We need one space in the string for each image. */
10085 size_needed
= f
->n_tool_bar_items
;
10087 /* Reuse f->desired_tool_bar_string, if possible. */
10088 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10089 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10090 make_number (' '));
10093 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10094 Fremove_text_properties (make_number (0), make_number (size
),
10095 props
, f
->desired_tool_bar_string
);
10098 /* Put a `display' property on the string for the images to display,
10099 put a `menu_item' property on tool-bar items with a value that
10100 is the index of the item in F's tool-bar item vector. */
10101 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10103 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10105 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10106 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10107 int hmargin
, vmargin
, relief
, idx
, end
;
10109 /* If image is a vector, choose the image according to the
10111 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10112 if (VECTORP (image
))
10116 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10117 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10120 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10121 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10123 xassert (ASIZE (image
) >= idx
);
10124 image
= AREF (image
, idx
);
10129 /* Ignore invalid image specifications. */
10130 if (!valid_image_p (image
))
10133 /* Display the tool-bar button pressed, or depressed. */
10134 plist
= Fcopy_sequence (XCDR (image
));
10136 /* Compute margin and relief to draw. */
10137 relief
= (tool_bar_button_relief
>= 0
10138 ? tool_bar_button_relief
10139 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10140 hmargin
= vmargin
= relief
;
10142 if (INTEGERP (Vtool_bar_button_margin
)
10143 && XINT (Vtool_bar_button_margin
) > 0)
10145 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10146 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10148 else if (CONSP (Vtool_bar_button_margin
))
10150 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10151 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10152 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10154 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10155 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10156 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10159 if (auto_raise_tool_bar_buttons_p
)
10161 /* Add a `:relief' property to the image spec if the item is
10165 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10172 /* If image is selected, display it pressed, i.e. with a
10173 negative relief. If it's not selected, display it with a
10175 plist
= Fplist_put (plist
, QCrelief
,
10177 ? make_number (-relief
)
10178 : make_number (relief
)));
10183 /* Put a margin around the image. */
10184 if (hmargin
|| vmargin
)
10186 if (hmargin
== vmargin
)
10187 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10189 plist
= Fplist_put (plist
, QCmargin
,
10190 Fcons (make_number (hmargin
),
10191 make_number (vmargin
)));
10194 /* If button is not enabled, and we don't have special images
10195 for the disabled state, make the image appear disabled by
10196 applying an appropriate algorithm to it. */
10197 if (!enabled_p
&& idx
< 0)
10198 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10200 /* Put a `display' text property on the string for the image to
10201 display. Put a `menu-item' property on the string that gives
10202 the start of this item's properties in the tool-bar items
10204 image
= Fcons (Qimage
, plist
);
10205 props
= list4 (Qdisplay
, image
,
10206 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10208 /* Let the last image hide all remaining spaces in the tool bar
10209 string. The string can be longer than needed when we reuse a
10210 previous string. */
10211 if (i
+ 1 == f
->n_tool_bar_items
)
10212 end
= SCHARS (f
->desired_tool_bar_string
);
10215 Fadd_text_properties (make_number (i
), make_number (end
),
10216 props
, f
->desired_tool_bar_string
);
10224 /* Display one line of the tool-bar of frame IT->f.
10226 HEIGHT specifies the desired height of the tool-bar line.
10227 If the actual height of the glyph row is less than HEIGHT, the
10228 row's height is increased to HEIGHT, and the icons are centered
10229 vertically in the new height.
10231 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10232 count a final empty row in case the tool-bar width exactly matches
10237 display_tool_bar_line (struct it
*it
, int height
)
10239 struct glyph_row
*row
= it
->glyph_row
;
10240 int max_x
= it
->last_visible_x
;
10241 struct glyph
*last
;
10243 prepare_desired_row (row
);
10244 row
->y
= it
->current_y
;
10246 /* Note that this isn't made use of if the face hasn't a box,
10247 so there's no need to check the face here. */
10248 it
->start_of_box_run_p
= 1;
10250 while (it
->current_x
< max_x
)
10252 int x
, n_glyphs_before
, i
, nglyphs
;
10253 struct it it_before
;
10255 /* Get the next display element. */
10256 if (!get_next_display_element (it
))
10258 /* Don't count empty row if we are counting needed tool-bar lines. */
10259 if (height
< 0 && !it
->hpos
)
10264 /* Produce glyphs. */
10265 n_glyphs_before
= row
->used
[TEXT_AREA
];
10268 PRODUCE_GLYPHS (it
);
10270 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10272 x
= it_before
.current_x
;
10273 while (i
< nglyphs
)
10275 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10277 if (x
+ glyph
->pixel_width
> max_x
)
10279 /* Glyph doesn't fit on line. Backtrack. */
10280 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10282 /* If this is the only glyph on this line, it will never fit on the
10283 tool-bar, so skip it. But ensure there is at least one glyph,
10284 so we don't accidentally disable the tool-bar. */
10285 if (n_glyphs_before
== 0
10286 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10292 x
+= glyph
->pixel_width
;
10296 /* Stop at line ends. */
10297 if (ITERATOR_AT_END_OF_LINE_P (it
))
10300 set_iterator_to_next (it
, 1);
10305 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10307 /* Use default face for the border below the tool bar.
10309 FIXME: When auto-resize-tool-bars is grow-only, there is
10310 no additional border below the possibly empty tool-bar lines.
10311 So to make the extra empty lines look "normal", we have to
10312 use the tool-bar face for the border too. */
10313 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10314 it
->face_id
= DEFAULT_FACE_ID
;
10316 extend_face_to_end_of_line (it
);
10317 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10318 last
->right_box_line_p
= 1;
10319 if (last
== row
->glyphs
[TEXT_AREA
])
10320 last
->left_box_line_p
= 1;
10322 /* Make line the desired height and center it vertically. */
10323 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10325 /* Don't add more than one line height. */
10326 height
%= FRAME_LINE_HEIGHT (it
->f
);
10327 it
->max_ascent
+= height
/ 2;
10328 it
->max_descent
+= (height
+ 1) / 2;
10331 compute_line_metrics (it
);
10333 /* If line is empty, make it occupy the rest of the tool-bar. */
10334 if (!row
->displays_text_p
)
10336 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10337 row
->visible_height
= row
->height
;
10338 row
->ascent
= row
->phys_ascent
= 0;
10339 row
->extra_line_spacing
= 0;
10342 row
->full_width_p
= 1;
10343 row
->continued_p
= 0;
10344 row
->truncated_on_left_p
= 0;
10345 row
->truncated_on_right_p
= 0;
10347 it
->current_x
= it
->hpos
= 0;
10348 it
->current_y
+= row
->height
;
10354 /* Max tool-bar height. */
10356 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10357 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10359 /* Value is the number of screen lines needed to make all tool-bar
10360 items of frame F visible. The number of actual rows needed is
10361 returned in *N_ROWS if non-NULL. */
10364 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10366 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10368 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10369 the desired matrix, so use (unused) mode-line row as temporary row to
10370 avoid destroying the first tool-bar row. */
10371 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10373 /* Initialize an iterator for iteration over
10374 F->desired_tool_bar_string in the tool-bar window of frame F. */
10375 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10376 it
.first_visible_x
= 0;
10377 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10378 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10380 while (!ITERATOR_AT_END_P (&it
))
10382 clear_glyph_row (temp_row
);
10383 it
.glyph_row
= temp_row
;
10384 display_tool_bar_line (&it
, -1);
10386 clear_glyph_row (temp_row
);
10388 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10390 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10392 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10396 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10398 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10399 (Lisp_Object frame
)
10406 frame
= selected_frame
;
10408 CHECK_FRAME (frame
);
10409 f
= XFRAME (frame
);
10411 if (WINDOWP (f
->tool_bar_window
)
10412 || (w
= XWINDOW (f
->tool_bar_window
),
10413 WINDOW_TOTAL_LINES (w
) > 0))
10415 update_tool_bar (f
, 1);
10416 if (f
->n_tool_bar_items
)
10418 build_desired_tool_bar_string (f
);
10419 nlines
= tool_bar_lines_needed (f
, NULL
);
10423 return make_number (nlines
);
10427 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10428 height should be changed. */
10431 redisplay_tool_bar (struct frame
*f
)
10435 struct glyph_row
*row
;
10437 #if defined (USE_GTK) || defined (HAVE_NS)
10438 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10439 update_frame_tool_bar (f
);
10443 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10444 do anything. This means you must start with tool-bar-lines
10445 non-zero to get the auto-sizing effect. Or in other words, you
10446 can turn off tool-bars by specifying tool-bar-lines zero. */
10447 if (!WINDOWP (f
->tool_bar_window
)
10448 || (w
= XWINDOW (f
->tool_bar_window
),
10449 WINDOW_TOTAL_LINES (w
) == 0))
10452 /* Set up an iterator for the tool-bar window. */
10453 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10454 it
.first_visible_x
= 0;
10455 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10456 row
= it
.glyph_row
;
10458 /* Build a string that represents the contents of the tool-bar. */
10459 build_desired_tool_bar_string (f
);
10460 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10462 if (f
->n_tool_bar_rows
== 0)
10466 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10467 nlines
!= WINDOW_TOTAL_LINES (w
)))
10470 int old_height
= WINDOW_TOTAL_LINES (w
);
10472 XSETFRAME (frame
, f
);
10473 Fmodify_frame_parameters (frame
,
10474 Fcons (Fcons (Qtool_bar_lines
,
10475 make_number (nlines
)),
10477 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10479 clear_glyph_matrix (w
->desired_matrix
);
10480 fonts_changed_p
= 1;
10486 /* Display as many lines as needed to display all tool-bar items. */
10488 if (f
->n_tool_bar_rows
> 0)
10490 int border
, rows
, height
, extra
;
10492 if (INTEGERP (Vtool_bar_border
))
10493 border
= XINT (Vtool_bar_border
);
10494 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10495 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10496 else if (EQ (Vtool_bar_border
, Qborder_width
))
10497 border
= f
->border_width
;
10503 rows
= f
->n_tool_bar_rows
;
10504 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10505 extra
= it
.last_visible_y
- border
- height
* rows
;
10507 while (it
.current_y
< it
.last_visible_y
)
10510 if (extra
> 0 && rows
-- > 0)
10512 h
= (extra
+ rows
- 1) / rows
;
10515 display_tool_bar_line (&it
, height
+ h
);
10520 while (it
.current_y
< it
.last_visible_y
)
10521 display_tool_bar_line (&it
, 0);
10524 /* It doesn't make much sense to try scrolling in the tool-bar
10525 window, so don't do it. */
10526 w
->desired_matrix
->no_scrolling_p
= 1;
10527 w
->must_be_updated_p
= 1;
10529 if (!NILP (Vauto_resize_tool_bars
))
10531 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10532 int change_height_p
= 0;
10534 /* If we couldn't display everything, change the tool-bar's
10535 height if there is room for more. */
10536 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10537 && it
.current_y
< max_tool_bar_height
)
10538 change_height_p
= 1;
10540 row
= it
.glyph_row
- 1;
10542 /* If there are blank lines at the end, except for a partially
10543 visible blank line at the end that is smaller than
10544 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10545 if (!row
->displays_text_p
10546 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10547 change_height_p
= 1;
10549 /* If row displays tool-bar items, but is partially visible,
10550 change the tool-bar's height. */
10551 if (row
->displays_text_p
10552 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10553 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10554 change_height_p
= 1;
10556 /* Resize windows as needed by changing the `tool-bar-lines'
10557 frame parameter. */
10558 if (change_height_p
)
10561 int old_height
= WINDOW_TOTAL_LINES (w
);
10563 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10565 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10566 && !f
->minimize_tool_bar_window_p
)
10567 ? (nlines
> old_height
)
10568 : (nlines
!= old_height
));
10569 f
->minimize_tool_bar_window_p
= 0;
10571 if (change_height_p
)
10573 XSETFRAME (frame
, f
);
10574 Fmodify_frame_parameters (frame
,
10575 Fcons (Fcons (Qtool_bar_lines
,
10576 make_number (nlines
)),
10578 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10580 clear_glyph_matrix (w
->desired_matrix
);
10581 f
->n_tool_bar_rows
= nrows
;
10582 fonts_changed_p
= 1;
10589 f
->minimize_tool_bar_window_p
= 0;
10594 /* Get information about the tool-bar item which is displayed in GLYPH
10595 on frame F. Return in *PROP_IDX the index where tool-bar item
10596 properties start in F->tool_bar_items. Value is zero if
10597 GLYPH doesn't display a tool-bar item. */
10600 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10606 /* This function can be called asynchronously, which means we must
10607 exclude any possibility that Fget_text_property signals an
10609 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10610 charpos
= max (0, charpos
);
10612 /* Get the text property `menu-item' at pos. The value of that
10613 property is the start index of this item's properties in
10614 F->tool_bar_items. */
10615 prop
= Fget_text_property (make_number (charpos
),
10616 Qmenu_item
, f
->current_tool_bar_string
);
10617 if (INTEGERP (prop
))
10619 *prop_idx
= XINT (prop
);
10629 /* Get information about the tool-bar item at position X/Y on frame F.
10630 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10631 the current matrix of the tool-bar window of F, or NULL if not
10632 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10633 item in F->tool_bar_items. Value is
10635 -1 if X/Y is not on a tool-bar item
10636 0 if X/Y is on the same item that was highlighted before.
10640 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10641 int *hpos
, int *vpos
, int *prop_idx
)
10643 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10644 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10647 /* Find the glyph under X/Y. */
10648 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10649 if (*glyph
== NULL
)
10652 /* Get the start of this tool-bar item's properties in
10653 f->tool_bar_items. */
10654 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10657 /* Is mouse on the highlighted item? */
10658 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10659 && *vpos
>= hlinfo
->mouse_face_beg_row
10660 && *vpos
<= hlinfo
->mouse_face_end_row
10661 && (*vpos
> hlinfo
->mouse_face_beg_row
10662 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10663 && (*vpos
< hlinfo
->mouse_face_end_row
10664 || *hpos
< hlinfo
->mouse_face_end_col
10665 || hlinfo
->mouse_face_past_end
))
10673 Handle mouse button event on the tool-bar of frame F, at
10674 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10675 0 for button release. MODIFIERS is event modifiers for button
10679 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10680 unsigned int modifiers
)
10682 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10683 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10684 int hpos
, vpos
, prop_idx
;
10685 struct glyph
*glyph
;
10686 Lisp_Object enabled_p
;
10688 /* If not on the highlighted tool-bar item, return. */
10689 frame_to_window_pixel_xy (w
, &x
, &y
);
10690 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10693 /* If item is disabled, do nothing. */
10694 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10695 if (NILP (enabled_p
))
10700 /* Show item in pressed state. */
10701 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10702 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10703 last_tool_bar_item
= prop_idx
;
10707 Lisp_Object key
, frame
;
10708 struct input_event event
;
10709 EVENT_INIT (event
);
10711 /* Show item in released state. */
10712 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10713 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10715 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10717 XSETFRAME (frame
, f
);
10718 event
.kind
= TOOL_BAR_EVENT
;
10719 event
.frame_or_window
= frame
;
10721 kbd_buffer_store_event (&event
);
10723 event
.kind
= TOOL_BAR_EVENT
;
10724 event
.frame_or_window
= frame
;
10726 event
.modifiers
= modifiers
;
10727 kbd_buffer_store_event (&event
);
10728 last_tool_bar_item
= -1;
10733 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10734 tool-bar window-relative coordinates X/Y. Called from
10735 note_mouse_highlight. */
10738 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10740 Lisp_Object window
= f
->tool_bar_window
;
10741 struct window
*w
= XWINDOW (window
);
10742 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10743 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10745 struct glyph
*glyph
;
10746 struct glyph_row
*row
;
10748 Lisp_Object enabled_p
;
10750 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10751 int mouse_down_p
, rc
;
10753 /* Function note_mouse_highlight is called with negative X/Y
10754 values when mouse moves outside of the frame. */
10755 if (x
<= 0 || y
<= 0)
10757 clear_mouse_face (hlinfo
);
10761 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10764 /* Not on tool-bar item. */
10765 clear_mouse_face (hlinfo
);
10769 /* On same tool-bar item as before. */
10770 goto set_help_echo
;
10772 clear_mouse_face (hlinfo
);
10774 /* Mouse is down, but on different tool-bar item? */
10775 mouse_down_p
= (dpyinfo
->grabbed
10776 && f
== last_mouse_frame
10777 && FRAME_LIVE_P (f
));
10779 && last_tool_bar_item
!= prop_idx
)
10782 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10783 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10785 /* If tool-bar item is not enabled, don't highlight it. */
10786 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10787 if (!NILP (enabled_p
))
10789 /* Compute the x-position of the glyph. In front and past the
10790 image is a space. We include this in the highlighted area. */
10791 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10792 for (i
= x
= 0; i
< hpos
; ++i
)
10793 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10795 /* Record this as the current active region. */
10796 hlinfo
->mouse_face_beg_col
= hpos
;
10797 hlinfo
->mouse_face_beg_row
= vpos
;
10798 hlinfo
->mouse_face_beg_x
= x
;
10799 hlinfo
->mouse_face_beg_y
= row
->y
;
10800 hlinfo
->mouse_face_past_end
= 0;
10802 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10803 hlinfo
->mouse_face_end_row
= vpos
;
10804 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10805 hlinfo
->mouse_face_end_y
= row
->y
;
10806 hlinfo
->mouse_face_window
= window
;
10807 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10809 /* Display it as active. */
10810 show_mouse_face (hlinfo
, draw
);
10811 hlinfo
->mouse_face_image_state
= draw
;
10816 /* Set help_echo_string to a help string to display for this tool-bar item.
10817 XTread_socket does the rest. */
10818 help_echo_object
= help_echo_window
= Qnil
;
10819 help_echo_pos
= -1;
10820 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10821 if (NILP (help_echo_string
))
10822 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10825 #endif /* HAVE_WINDOW_SYSTEM */
10829 /************************************************************************
10830 Horizontal scrolling
10831 ************************************************************************/
10833 static int hscroll_window_tree (Lisp_Object
);
10834 static int hscroll_windows (Lisp_Object
);
10836 /* For all leaf windows in the window tree rooted at WINDOW, set their
10837 hscroll value so that PT is (i) visible in the window, and (ii) so
10838 that it is not within a certain margin at the window's left and
10839 right border. Value is non-zero if any window's hscroll has been
10843 hscroll_window_tree (Lisp_Object window
)
10845 int hscrolled_p
= 0;
10846 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10847 int hscroll_step_abs
= 0;
10848 double hscroll_step_rel
= 0;
10850 if (hscroll_relative_p
)
10852 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10853 if (hscroll_step_rel
< 0)
10855 hscroll_relative_p
= 0;
10856 hscroll_step_abs
= 0;
10859 else if (INTEGERP (Vhscroll_step
))
10861 hscroll_step_abs
= XINT (Vhscroll_step
);
10862 if (hscroll_step_abs
< 0)
10863 hscroll_step_abs
= 0;
10866 hscroll_step_abs
= 0;
10868 while (WINDOWP (window
))
10870 struct window
*w
= XWINDOW (window
);
10872 if (WINDOWP (w
->hchild
))
10873 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10874 else if (WINDOWP (w
->vchild
))
10875 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10876 else if (w
->cursor
.vpos
>= 0)
10879 int text_area_width
;
10880 struct glyph_row
*current_cursor_row
10881 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10882 struct glyph_row
*desired_cursor_row
10883 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10884 struct glyph_row
*cursor_row
10885 = (desired_cursor_row
->enabled_p
10886 ? desired_cursor_row
10887 : current_cursor_row
);
10889 text_area_width
= window_box_width (w
, TEXT_AREA
);
10891 /* Scroll when cursor is inside this scroll margin. */
10892 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10894 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10895 && ((XFASTINT (w
->hscroll
)
10896 && w
->cursor
.x
<= h_margin
)
10897 || (cursor_row
->enabled_p
10898 && cursor_row
->truncated_on_right_p
10899 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10903 struct buffer
*saved_current_buffer
;
10907 /* Find point in a display of infinite width. */
10908 saved_current_buffer
= current_buffer
;
10909 current_buffer
= XBUFFER (w
->buffer
);
10911 if (w
== XWINDOW (selected_window
))
10912 pt
= BUF_PT (current_buffer
);
10915 pt
= marker_position (w
->pointm
);
10916 pt
= max (BEGV
, pt
);
10920 /* Move iterator to pt starting at cursor_row->start in
10921 a line with infinite width. */
10922 init_to_row_start (&it
, w
, cursor_row
);
10923 it
.last_visible_x
= INFINITY
;
10924 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10925 current_buffer
= saved_current_buffer
;
10927 /* Position cursor in window. */
10928 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10929 hscroll
= max (0, (it
.current_x
10930 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10931 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10932 : (text_area_width
/ 2))))
10933 / FRAME_COLUMN_WIDTH (it
.f
);
10934 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10936 if (hscroll_relative_p
)
10937 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10940 wanted_x
= text_area_width
10941 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10944 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10948 if (hscroll_relative_p
)
10949 wanted_x
= text_area_width
* hscroll_step_rel
10952 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10955 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10957 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10959 /* Don't call Fset_window_hscroll if value hasn't
10960 changed because it will prevent redisplay
10962 if (XFASTINT (w
->hscroll
) != hscroll
)
10964 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10965 w
->hscroll
= make_number (hscroll
);
10974 /* Value is non-zero if hscroll of any leaf window has been changed. */
10975 return hscrolled_p
;
10979 /* Set hscroll so that cursor is visible and not inside horizontal
10980 scroll margins for all windows in the tree rooted at WINDOW. See
10981 also hscroll_window_tree above. Value is non-zero if any window's
10982 hscroll has been changed. If it has, desired matrices on the frame
10983 of WINDOW are cleared. */
10986 hscroll_windows (Lisp_Object window
)
10988 int hscrolled_p
= hscroll_window_tree (window
);
10990 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10991 return hscrolled_p
;
10996 /************************************************************************
10998 ************************************************************************/
11000 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11001 to a non-zero value. This is sometimes handy to have in a debugger
11006 /* First and last unchanged row for try_window_id. */
11008 int debug_first_unchanged_at_end_vpos
;
11009 int debug_last_unchanged_at_beg_vpos
;
11011 /* Delta vpos and y. */
11013 int debug_dvpos
, debug_dy
;
11015 /* Delta in characters and bytes for try_window_id. */
11017 EMACS_INT debug_delta
, debug_delta_bytes
;
11019 /* Values of window_end_pos and window_end_vpos at the end of
11022 EMACS_INT debug_end_vpos
;
11024 /* Append a string to W->desired_matrix->method. FMT is a printf
11025 format string. A1...A9 are a supplement for a variable-length
11026 argument list. If trace_redisplay_p is non-zero also printf the
11027 resulting string to stderr. */
11030 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11033 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11036 char *method
= w
->desired_matrix
->method
;
11037 int len
= strlen (method
);
11038 int size
= sizeof w
->desired_matrix
->method
;
11039 int remaining
= size
- len
- 1;
11041 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11042 if (len
&& remaining
)
11045 --remaining
, ++len
;
11048 strncpy (method
+ len
, buffer
, remaining
);
11050 if (trace_redisplay_p
)
11051 fprintf (stderr
, "%p (%s): %s\n",
11053 ((BUFFERP (w
->buffer
)
11054 && STRINGP (XBUFFER (w
->buffer
)->name
))
11055 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11060 #endif /* GLYPH_DEBUG */
11063 /* Value is non-zero if all changes in window W, which displays
11064 current_buffer, are in the text between START and END. START is a
11065 buffer position, END is given as a distance from Z. Used in
11066 redisplay_internal for display optimization. */
11069 text_outside_line_unchanged_p (struct window
*w
,
11070 EMACS_INT start
, EMACS_INT end
)
11072 int unchanged_p
= 1;
11074 /* If text or overlays have changed, see where. */
11075 if (XFASTINT (w
->last_modified
) < MODIFF
11076 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11078 /* Gap in the line? */
11079 if (GPT
< start
|| Z
- GPT
< end
)
11082 /* Changes start in front of the line, or end after it? */
11084 && (BEG_UNCHANGED
< start
- 1
11085 || END_UNCHANGED
< end
))
11088 /* If selective display, can't optimize if changes start at the
11089 beginning of the line. */
11091 && INTEGERP (BVAR (current_buffer
, selective_display
))
11092 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11093 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11096 /* If there are overlays at the start or end of the line, these
11097 may have overlay strings with newlines in them. A change at
11098 START, for instance, may actually concern the display of such
11099 overlay strings as well, and they are displayed on different
11100 lines. So, quickly rule out this case. (For the future, it
11101 might be desirable to implement something more telling than
11102 just BEG/END_UNCHANGED.) */
11105 if (BEG
+ BEG_UNCHANGED
== start
11106 && overlay_touches_p (start
))
11108 if (END_UNCHANGED
== end
11109 && overlay_touches_p (Z
- end
))
11113 /* Under bidi reordering, adding or deleting a character in the
11114 beginning of a paragraph, before the first strong directional
11115 character, can change the base direction of the paragraph (unless
11116 the buffer specifies a fixed paragraph direction), which will
11117 require to redisplay the whole paragraph. It might be worthwhile
11118 to find the paragraph limits and widen the range of redisplayed
11119 lines to that, but for now just give up this optimization. */
11120 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11121 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11125 return unchanged_p
;
11129 /* Do a frame update, taking possible shortcuts into account. This is
11130 the main external entry point for redisplay.
11132 If the last redisplay displayed an echo area message and that message
11133 is no longer requested, we clear the echo area or bring back the
11134 mini-buffer if that is in use. */
11139 redisplay_internal (0);
11144 overlay_arrow_string_or_property (Lisp_Object var
)
11148 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11151 return Voverlay_arrow_string
;
11154 /* Return 1 if there are any overlay-arrows in current_buffer. */
11156 overlay_arrow_in_current_buffer_p (void)
11160 for (vlist
= Voverlay_arrow_variable_list
;
11162 vlist
= XCDR (vlist
))
11164 Lisp_Object var
= XCAR (vlist
);
11167 if (!SYMBOLP (var
))
11169 val
= find_symbol_value (var
);
11171 && current_buffer
== XMARKER (val
)->buffer
)
11178 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11182 overlay_arrows_changed_p (void)
11186 for (vlist
= Voverlay_arrow_variable_list
;
11188 vlist
= XCDR (vlist
))
11190 Lisp_Object var
= XCAR (vlist
);
11191 Lisp_Object val
, pstr
;
11193 if (!SYMBOLP (var
))
11195 val
= find_symbol_value (var
);
11196 if (!MARKERP (val
))
11198 if (! EQ (COERCE_MARKER (val
),
11199 Fget (var
, Qlast_arrow_position
))
11200 || ! (pstr
= overlay_arrow_string_or_property (var
),
11201 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11207 /* Mark overlay arrows to be updated on next redisplay. */
11210 update_overlay_arrows (int up_to_date
)
11214 for (vlist
= Voverlay_arrow_variable_list
;
11216 vlist
= XCDR (vlist
))
11218 Lisp_Object var
= XCAR (vlist
);
11220 if (!SYMBOLP (var
))
11223 if (up_to_date
> 0)
11225 Lisp_Object val
= find_symbol_value (var
);
11226 Fput (var
, Qlast_arrow_position
,
11227 COERCE_MARKER (val
));
11228 Fput (var
, Qlast_arrow_string
,
11229 overlay_arrow_string_or_property (var
));
11231 else if (up_to_date
< 0
11232 || !NILP (Fget (var
, Qlast_arrow_position
)))
11234 Fput (var
, Qlast_arrow_position
, Qt
);
11235 Fput (var
, Qlast_arrow_string
, Qt
);
11241 /* Return overlay arrow string to display at row.
11242 Return integer (bitmap number) for arrow bitmap in left fringe.
11243 Return nil if no overlay arrow. */
11246 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11250 for (vlist
= Voverlay_arrow_variable_list
;
11252 vlist
= XCDR (vlist
))
11254 Lisp_Object var
= XCAR (vlist
);
11257 if (!SYMBOLP (var
))
11260 val
= find_symbol_value (var
);
11263 && current_buffer
== XMARKER (val
)->buffer
11264 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11266 if (FRAME_WINDOW_P (it
->f
)
11267 /* FIXME: if ROW->reversed_p is set, this should test
11268 the right fringe, not the left one. */
11269 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11271 #ifdef HAVE_WINDOW_SYSTEM
11272 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11275 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11276 return make_number (fringe_bitmap
);
11279 return make_number (-1); /* Use default arrow bitmap */
11281 return overlay_arrow_string_or_property (var
);
11288 /* Return 1 if point moved out of or into a composition. Otherwise
11289 return 0. PREV_BUF and PREV_PT are the last point buffer and
11290 position. BUF and PT are the current point buffer and position. */
11293 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11294 struct buffer
*buf
, EMACS_INT pt
)
11296 EMACS_INT start
, end
;
11298 Lisp_Object buffer
;
11300 XSETBUFFER (buffer
, buf
);
11301 /* Check a composition at the last point if point moved within the
11303 if (prev_buf
== buf
)
11306 /* Point didn't move. */
11309 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11310 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11311 && COMPOSITION_VALID_P (start
, end
, prop
)
11312 && start
< prev_pt
&& end
> prev_pt
)
11313 /* The last point was within the composition. Return 1 iff
11314 point moved out of the composition. */
11315 return (pt
<= start
|| pt
>= end
);
11318 /* Check a composition at the current point. */
11319 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11320 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11321 && COMPOSITION_VALID_P (start
, end
, prop
)
11322 && start
< pt
&& end
> pt
);
11326 /* Reconsider the setting of B->clip_changed which is displayed
11330 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11332 if (b
->clip_changed
11333 && !NILP (w
->window_end_valid
)
11334 && w
->current_matrix
->buffer
== b
11335 && w
->current_matrix
->zv
== BUF_ZV (b
)
11336 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11337 b
->clip_changed
= 0;
11339 /* If display wasn't paused, and W is not a tool bar window, see if
11340 point has been moved into or out of a composition. In that case,
11341 we set b->clip_changed to 1 to force updating the screen. If
11342 b->clip_changed has already been set to 1, we can skip this
11344 if (!b
->clip_changed
11345 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11349 if (w
== XWINDOW (selected_window
))
11350 pt
= BUF_PT (current_buffer
);
11352 pt
= marker_position (w
->pointm
);
11354 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11355 || pt
!= XINT (w
->last_point
))
11356 && check_point_in_composition (w
->current_matrix
->buffer
,
11357 XINT (w
->last_point
),
11358 XBUFFER (w
->buffer
), pt
))
11359 b
->clip_changed
= 1;
11364 /* Select FRAME to forward the values of frame-local variables into C
11365 variables so that the redisplay routines can access those values
11369 select_frame_for_redisplay (Lisp_Object frame
)
11371 Lisp_Object tail
, tem
;
11372 Lisp_Object old
= selected_frame
;
11373 struct Lisp_Symbol
*sym
;
11375 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11377 selected_frame
= frame
;
11380 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11381 if (CONSP (XCAR (tail
))
11382 && (tem
= XCAR (XCAR (tail
)),
11384 && (sym
= indirect_variable (XSYMBOL (tem
)),
11385 sym
->redirect
== SYMBOL_LOCALIZED
)
11386 && sym
->val
.blv
->frame_local
)
11387 /* Use find_symbol_value rather than Fsymbol_value
11388 to avoid an error if it is void. */
11389 find_symbol_value (tem
);
11390 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11394 #define STOP_POLLING \
11395 do { if (! polling_stopped_here) stop_polling (); \
11396 polling_stopped_here = 1; } while (0)
11398 #define RESUME_POLLING \
11399 do { if (polling_stopped_here) start_polling (); \
11400 polling_stopped_here = 0; } while (0)
11403 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11404 response to any user action; therefore, we should preserve the echo
11405 area. (Actually, our caller does that job.) Perhaps in the future
11406 avoid recentering windows if it is not necessary; currently that
11407 causes some problems. */
11410 redisplay_internal (int preserve_echo_area
)
11412 struct window
*w
= XWINDOW (selected_window
);
11416 int must_finish
= 0;
11417 struct text_pos tlbufpos
, tlendpos
;
11418 int number_of_visible_frames
;
11421 int polling_stopped_here
= 0;
11422 Lisp_Object old_frame
= selected_frame
;
11424 /* Non-zero means redisplay has to consider all windows on all
11425 frames. Zero means, only selected_window is considered. */
11426 int consider_all_windows_p
;
11428 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11430 /* No redisplay if running in batch mode or frame is not yet fully
11431 initialized, or redisplay is explicitly turned off by setting
11432 Vinhibit_redisplay. */
11433 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11434 || !NILP (Vinhibit_redisplay
))
11437 /* Don't examine these until after testing Vinhibit_redisplay.
11438 When Emacs is shutting down, perhaps because its connection to
11439 X has dropped, we should not look at them at all. */
11440 fr
= XFRAME (w
->frame
);
11441 sf
= SELECTED_FRAME ();
11443 if (!fr
->glyphs_initialized_p
)
11446 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11447 if (popup_activated ())
11451 /* I don't think this happens but let's be paranoid. */
11452 if (redisplaying_p
)
11455 /* Record a function that resets redisplaying_p to its old value
11456 when we leave this function. */
11457 count
= SPECPDL_INDEX ();
11458 record_unwind_protect (unwind_redisplay
,
11459 Fcons (make_number (redisplaying_p
), selected_frame
));
11461 specbind (Qinhibit_free_realized_faces
, Qnil
);
11464 Lisp_Object tail
, frame
;
11466 FOR_EACH_FRAME (tail
, frame
)
11468 struct frame
*f
= XFRAME (frame
);
11469 f
->already_hscrolled_p
= 0;
11474 /* Remember the currently selected window. */
11477 if (!EQ (old_frame
, selected_frame
)
11478 && FRAME_LIVE_P (XFRAME (old_frame
)))
11479 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11480 selected_frame and selected_window to be temporarily out-of-sync so
11481 when we come back here via `goto retry', we need to resync because we
11482 may need to run Elisp code (via prepare_menu_bars). */
11483 select_frame_for_redisplay (old_frame
);
11486 reconsider_clip_changes (w
, current_buffer
);
11487 last_escape_glyph_frame
= NULL
;
11488 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11489 last_glyphless_glyph_frame
= NULL
;
11490 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11492 /* If new fonts have been loaded that make a glyph matrix adjustment
11493 necessary, do it. */
11494 if (fonts_changed_p
)
11496 adjust_glyphs (NULL
);
11497 ++windows_or_buffers_changed
;
11498 fonts_changed_p
= 0;
11501 /* If face_change_count is non-zero, init_iterator will free all
11502 realized faces, which includes the faces referenced from current
11503 matrices. So, we can't reuse current matrices in this case. */
11504 if (face_change_count
)
11505 ++windows_or_buffers_changed
;
11507 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11508 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11510 /* Since frames on a single ASCII terminal share the same
11511 display area, displaying a different frame means redisplay
11512 the whole thing. */
11513 windows_or_buffers_changed
++;
11514 SET_FRAME_GARBAGED (sf
);
11516 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11518 FRAME_TTY (sf
)->previous_frame
= sf
;
11521 /* Set the visible flags for all frames. Do this before checking
11522 for resized or garbaged frames; they want to know if their frames
11523 are visible. See the comment in frame.h for
11524 FRAME_SAMPLE_VISIBILITY. */
11526 Lisp_Object tail
, frame
;
11528 number_of_visible_frames
= 0;
11530 FOR_EACH_FRAME (tail
, frame
)
11532 struct frame
*f
= XFRAME (frame
);
11534 FRAME_SAMPLE_VISIBILITY (f
);
11535 if (FRAME_VISIBLE_P (f
))
11536 ++number_of_visible_frames
;
11537 clear_desired_matrices (f
);
11541 /* Notice any pending interrupt request to change frame size. */
11542 do_pending_window_change (1);
11544 /* do_pending_window_change could change the selected_window due to
11545 frame resizing which makes the selected window too small. */
11546 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11549 reconsider_clip_changes (w
, current_buffer
);
11552 /* Clear frames marked as garbaged. */
11553 if (frame_garbaged
)
11554 clear_garbaged_frames ();
11556 /* Build menubar and tool-bar items. */
11557 if (NILP (Vmemory_full
))
11558 prepare_menu_bars ();
11560 if (windows_or_buffers_changed
)
11561 update_mode_lines
++;
11563 /* Detect case that we need to write or remove a star in the mode line. */
11564 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11566 w
->update_mode_line
= Qt
;
11567 if (buffer_shared
> 1)
11568 update_mode_lines
++;
11571 /* Avoid invocation of point motion hooks by `current_column' below. */
11572 count1
= SPECPDL_INDEX ();
11573 specbind (Qinhibit_point_motion_hooks
, Qt
);
11575 /* If %c is in the mode line, update it if needed. */
11576 if (!NILP (w
->column_number_displayed
)
11577 /* This alternative quickly identifies a common case
11578 where no change is needed. */
11579 && !(PT
== XFASTINT (w
->last_point
)
11580 && XFASTINT (w
->last_modified
) >= MODIFF
11581 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11582 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11583 w
->update_mode_line
= Qt
;
11585 unbind_to (count1
, Qnil
);
11587 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11589 /* The variable buffer_shared is set in redisplay_window and
11590 indicates that we redisplay a buffer in different windows. See
11592 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11593 || cursor_type_changed
);
11595 /* If specs for an arrow have changed, do thorough redisplay
11596 to ensure we remove any arrow that should no longer exist. */
11597 if (overlay_arrows_changed_p ())
11598 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11600 /* Normally the message* functions will have already displayed and
11601 updated the echo area, but the frame may have been trashed, or
11602 the update may have been preempted, so display the echo area
11603 again here. Checking message_cleared_p captures the case that
11604 the echo area should be cleared. */
11605 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11606 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11607 || (message_cleared_p
11608 && minibuf_level
== 0
11609 /* If the mini-window is currently selected, this means the
11610 echo-area doesn't show through. */
11611 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11613 int window_height_changed_p
= echo_area_display (0);
11616 /* If we don't display the current message, don't clear the
11617 message_cleared_p flag, because, if we did, we wouldn't clear
11618 the echo area in the next redisplay which doesn't preserve
11620 if (!display_last_displayed_message_p
)
11621 message_cleared_p
= 0;
11623 if (fonts_changed_p
)
11625 else if (window_height_changed_p
)
11627 consider_all_windows_p
= 1;
11628 ++update_mode_lines
;
11629 ++windows_or_buffers_changed
;
11631 /* If window configuration was changed, frames may have been
11632 marked garbaged. Clear them or we will experience
11633 surprises wrt scrolling. */
11634 if (frame_garbaged
)
11635 clear_garbaged_frames ();
11638 else if (EQ (selected_window
, minibuf_window
)
11639 && (current_buffer
->clip_changed
11640 || XFASTINT (w
->last_modified
) < MODIFF
11641 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11642 && resize_mini_window (w
, 0))
11644 /* Resized active mini-window to fit the size of what it is
11645 showing if its contents might have changed. */
11647 /* FIXME: this causes all frames to be updated, which seems unnecessary
11648 since only the current frame needs to be considered. This function needs
11649 to be rewritten with two variables, consider_all_windows and
11650 consider_all_frames. */
11651 consider_all_windows_p
= 1;
11652 ++windows_or_buffers_changed
;
11653 ++update_mode_lines
;
11655 /* If window configuration was changed, frames may have been
11656 marked garbaged. Clear them or we will experience
11657 surprises wrt scrolling. */
11658 if (frame_garbaged
)
11659 clear_garbaged_frames ();
11663 /* If showing the region, and mark has changed, we must redisplay
11664 the whole window. The assignment to this_line_start_pos prevents
11665 the optimization directly below this if-statement. */
11666 if (((!NILP (Vtransient_mark_mode
)
11667 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11668 != !NILP (w
->region_showing
))
11669 || (!NILP (w
->region_showing
)
11670 && !EQ (w
->region_showing
,
11671 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11672 CHARPOS (this_line_start_pos
) = 0;
11674 /* Optimize the case that only the line containing the cursor in the
11675 selected window has changed. Variables starting with this_ are
11676 set in display_line and record information about the line
11677 containing the cursor. */
11678 tlbufpos
= this_line_start_pos
;
11679 tlendpos
= this_line_end_pos
;
11680 if (!consider_all_windows_p
11681 && CHARPOS (tlbufpos
) > 0
11682 && NILP (w
->update_mode_line
)
11683 && !current_buffer
->clip_changed
11684 && !current_buffer
->prevent_redisplay_optimizations_p
11685 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11686 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11687 /* Make sure recorded data applies to current buffer, etc. */
11688 && this_line_buffer
== current_buffer
11689 && current_buffer
== XBUFFER (w
->buffer
)
11690 && NILP (w
->force_start
)
11691 && NILP (w
->optional_new_start
)
11692 /* Point must be on the line that we have info recorded about. */
11693 && PT
>= CHARPOS (tlbufpos
)
11694 && PT
<= Z
- CHARPOS (tlendpos
)
11695 /* All text outside that line, including its final newline,
11696 must be unchanged. */
11697 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11698 CHARPOS (tlendpos
)))
11700 if (CHARPOS (tlbufpos
) > BEGV
11701 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11702 && (CHARPOS (tlbufpos
) == ZV
11703 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11704 /* Former continuation line has disappeared by becoming empty. */
11706 else if (XFASTINT (w
->last_modified
) < MODIFF
11707 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11708 || MINI_WINDOW_P (w
))
11710 /* We have to handle the case of continuation around a
11711 wide-column character (see the comment in indent.c around
11714 For instance, in the following case:
11716 -------- Insert --------
11717 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11718 J_I_ ==> J_I_ `^^' are cursors.
11722 As we have to redraw the line above, we cannot use this
11726 int line_height_before
= this_line_pixel_height
;
11728 /* Note that start_display will handle the case that the
11729 line starting at tlbufpos is a continuation line. */
11730 start_display (&it
, w
, tlbufpos
);
11732 /* Implementation note: It this still necessary? */
11733 if (it
.current_x
!= this_line_start_x
)
11736 TRACE ((stderr
, "trying display optimization 1\n"));
11737 w
->cursor
.vpos
= -1;
11738 overlay_arrow_seen
= 0;
11739 it
.vpos
= this_line_vpos
;
11740 it
.current_y
= this_line_y
;
11741 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11742 display_line (&it
);
11744 /* If line contains point, is not continued,
11745 and ends at same distance from eob as before, we win. */
11746 if (w
->cursor
.vpos
>= 0
11747 /* Line is not continued, otherwise this_line_start_pos
11748 would have been set to 0 in display_line. */
11749 && CHARPOS (this_line_start_pos
)
11750 /* Line ends as before. */
11751 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11752 /* Line has same height as before. Otherwise other lines
11753 would have to be shifted up or down. */
11754 && this_line_pixel_height
== line_height_before
)
11756 /* If this is not the window's last line, we must adjust
11757 the charstarts of the lines below. */
11758 if (it
.current_y
< it
.last_visible_y
)
11760 struct glyph_row
*row
11761 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11762 EMACS_INT delta
, delta_bytes
;
11764 /* We used to distinguish between two cases here,
11765 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11766 when the line ends in a newline or the end of the
11767 buffer's accessible portion. But both cases did
11768 the same, so they were collapsed. */
11770 - CHARPOS (tlendpos
)
11771 - MATRIX_ROW_START_CHARPOS (row
));
11772 delta_bytes
= (Z_BYTE
11773 - BYTEPOS (tlendpos
)
11774 - MATRIX_ROW_START_BYTEPOS (row
));
11776 increment_matrix_positions (w
->current_matrix
,
11777 this_line_vpos
+ 1,
11778 w
->current_matrix
->nrows
,
11779 delta
, delta_bytes
);
11782 /* If this row displays text now but previously didn't,
11783 or vice versa, w->window_end_vpos may have to be
11785 if ((it
.glyph_row
- 1)->displays_text_p
)
11787 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11788 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11790 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11791 && this_line_vpos
> 0)
11792 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11793 w
->window_end_valid
= Qnil
;
11795 /* Update hint: No need to try to scroll in update_window. */
11796 w
->desired_matrix
->no_scrolling_p
= 1;
11799 *w
->desired_matrix
->method
= 0;
11800 debug_method_add (w
, "optimization 1");
11802 #ifdef HAVE_WINDOW_SYSTEM
11803 update_window_fringes (w
, 0);
11810 else if (/* Cursor position hasn't changed. */
11811 PT
== XFASTINT (w
->last_point
)
11812 /* Make sure the cursor was last displayed
11813 in this window. Otherwise we have to reposition it. */
11814 && 0 <= w
->cursor
.vpos
11815 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11819 do_pending_window_change (1);
11820 /* If selected_window changed, redisplay again. */
11821 if (WINDOWP (selected_window
)
11822 && (w
= XWINDOW (selected_window
)) != sw
)
11825 /* We used to always goto end_of_redisplay here, but this
11826 isn't enough if we have a blinking cursor. */
11827 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11828 goto end_of_redisplay
;
11832 /* If highlighting the region, or if the cursor is in the echo area,
11833 then we can't just move the cursor. */
11834 else if (! (!NILP (Vtransient_mark_mode
)
11835 && !NILP (BVAR (current_buffer
, mark_active
)))
11836 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11837 || highlight_nonselected_windows
)
11838 && NILP (w
->region_showing
)
11839 && NILP (Vshow_trailing_whitespace
)
11840 && !cursor_in_echo_area
)
11843 struct glyph_row
*row
;
11845 /* Skip from tlbufpos to PT and see where it is. Note that
11846 PT may be in invisible text. If so, we will end at the
11847 next visible position. */
11848 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11849 NULL
, DEFAULT_FACE_ID
);
11850 it
.current_x
= this_line_start_x
;
11851 it
.current_y
= this_line_y
;
11852 it
.vpos
= this_line_vpos
;
11854 /* The call to move_it_to stops in front of PT, but
11855 moves over before-strings. */
11856 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11858 if (it
.vpos
== this_line_vpos
11859 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11862 xassert (this_line_vpos
== it
.vpos
);
11863 xassert (this_line_y
== it
.current_y
);
11864 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11866 *w
->desired_matrix
->method
= 0;
11867 debug_method_add (w
, "optimization 3");
11876 /* Text changed drastically or point moved off of line. */
11877 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11880 CHARPOS (this_line_start_pos
) = 0;
11881 consider_all_windows_p
|= buffer_shared
> 1;
11882 ++clear_face_cache_count
;
11883 #ifdef HAVE_WINDOW_SYSTEM
11884 ++clear_image_cache_count
;
11887 /* Build desired matrices, and update the display. If
11888 consider_all_windows_p is non-zero, do it for all windows on all
11889 frames. Otherwise do it for selected_window, only. */
11891 if (consider_all_windows_p
)
11893 Lisp_Object tail
, frame
;
11895 FOR_EACH_FRAME (tail
, frame
)
11896 XFRAME (frame
)->updated_p
= 0;
11898 /* Recompute # windows showing selected buffer. This will be
11899 incremented each time such a window is displayed. */
11902 FOR_EACH_FRAME (tail
, frame
)
11904 struct frame
*f
= XFRAME (frame
);
11906 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11908 if (! EQ (frame
, selected_frame
))
11909 /* Select the frame, for the sake of frame-local
11911 select_frame_for_redisplay (frame
);
11913 /* Mark all the scroll bars to be removed; we'll redeem
11914 the ones we want when we redisplay their windows. */
11915 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11916 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11918 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11919 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11921 /* The X error handler may have deleted that frame. */
11922 if (!FRAME_LIVE_P (f
))
11925 /* Any scroll bars which redisplay_windows should have
11926 nuked should now go away. */
11927 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11928 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11930 /* If fonts changed, display again. */
11931 /* ??? rms: I suspect it is a mistake to jump all the way
11932 back to retry here. It should just retry this frame. */
11933 if (fonts_changed_p
)
11936 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11938 /* See if we have to hscroll. */
11939 if (!f
->already_hscrolled_p
)
11941 f
->already_hscrolled_p
= 1;
11942 if (hscroll_windows (f
->root_window
))
11946 /* Prevent various kinds of signals during display
11947 update. stdio is not robust about handling
11948 signals, which can cause an apparent I/O
11950 if (interrupt_input
)
11951 unrequest_sigio ();
11954 /* Update the display. */
11955 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11956 pending
|= update_frame (f
, 0, 0);
11962 if (!EQ (old_frame
, selected_frame
)
11963 && FRAME_LIVE_P (XFRAME (old_frame
)))
11964 /* We played a bit fast-and-loose above and allowed selected_frame
11965 and selected_window to be temporarily out-of-sync but let's make
11966 sure this stays contained. */
11967 select_frame_for_redisplay (old_frame
);
11968 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11972 /* Do the mark_window_display_accurate after all windows have
11973 been redisplayed because this call resets flags in buffers
11974 which are needed for proper redisplay. */
11975 FOR_EACH_FRAME (tail
, frame
)
11977 struct frame
*f
= XFRAME (frame
);
11980 mark_window_display_accurate (f
->root_window
, 1);
11981 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11982 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11987 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11989 Lisp_Object mini_window
;
11990 struct frame
*mini_frame
;
11992 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11993 /* Use list_of_error, not Qerror, so that
11994 we catch only errors and don't run the debugger. */
11995 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11997 redisplay_window_error
);
11999 /* Compare desired and current matrices, perform output. */
12002 /* If fonts changed, display again. */
12003 if (fonts_changed_p
)
12006 /* Prevent various kinds of signals during display update.
12007 stdio is not robust about handling signals,
12008 which can cause an apparent I/O error. */
12009 if (interrupt_input
)
12010 unrequest_sigio ();
12013 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12015 if (hscroll_windows (selected_window
))
12018 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12019 pending
= update_frame (sf
, 0, 0);
12022 /* We may have called echo_area_display at the top of this
12023 function. If the echo area is on another frame, that may
12024 have put text on a frame other than the selected one, so the
12025 above call to update_frame would not have caught it. Catch
12027 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12028 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12030 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12032 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12033 pending
|= update_frame (mini_frame
, 0, 0);
12034 if (!pending
&& hscroll_windows (mini_window
))
12039 /* If display was paused because of pending input, make sure we do a
12040 thorough update the next time. */
12043 /* Prevent the optimization at the beginning of
12044 redisplay_internal that tries a single-line update of the
12045 line containing the cursor in the selected window. */
12046 CHARPOS (this_line_start_pos
) = 0;
12048 /* Let the overlay arrow be updated the next time. */
12049 update_overlay_arrows (0);
12051 /* If we pause after scrolling, some rows in the current
12052 matrices of some windows are not valid. */
12053 if (!WINDOW_FULL_WIDTH_P (w
)
12054 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12055 update_mode_lines
= 1;
12059 if (!consider_all_windows_p
)
12061 /* This has already been done above if
12062 consider_all_windows_p is set. */
12063 mark_window_display_accurate_1 (w
, 1);
12065 /* Say overlay arrows are up to date. */
12066 update_overlay_arrows (1);
12068 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12069 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12072 update_mode_lines
= 0;
12073 windows_or_buffers_changed
= 0;
12074 cursor_type_changed
= 0;
12077 /* Start SIGIO interrupts coming again. Having them off during the
12078 code above makes it less likely one will discard output, but not
12079 impossible, since there might be stuff in the system buffer here.
12080 But it is much hairier to try to do anything about that. */
12081 if (interrupt_input
)
12085 /* If a frame has become visible which was not before, redisplay
12086 again, so that we display it. Expose events for such a frame
12087 (which it gets when becoming visible) don't call the parts of
12088 redisplay constructing glyphs, so simply exposing a frame won't
12089 display anything in this case. So, we have to display these
12090 frames here explicitly. */
12093 Lisp_Object tail
, frame
;
12096 FOR_EACH_FRAME (tail
, frame
)
12098 int this_is_visible
= 0;
12100 if (XFRAME (frame
)->visible
)
12101 this_is_visible
= 1;
12102 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12103 if (XFRAME (frame
)->visible
)
12104 this_is_visible
= 1;
12106 if (this_is_visible
)
12110 if (new_count
!= number_of_visible_frames
)
12111 windows_or_buffers_changed
++;
12114 /* Change frame size now if a change is pending. */
12115 do_pending_window_change (1);
12117 /* If we just did a pending size change, or have additional
12118 visible frames, or selected_window changed, redisplay again. */
12119 if ((windows_or_buffers_changed
&& !pending
)
12120 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12123 /* Clear the face and image caches.
12125 We used to do this only if consider_all_windows_p. But the cache
12126 needs to be cleared if a timer creates images in the current
12127 buffer (e.g. the test case in Bug#6230). */
12129 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12131 clear_face_cache (0);
12132 clear_face_cache_count
= 0;
12135 #ifdef HAVE_WINDOW_SYSTEM
12136 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12138 clear_image_caches (Qnil
);
12139 clear_image_cache_count
= 0;
12141 #endif /* HAVE_WINDOW_SYSTEM */
12144 unbind_to (count
, Qnil
);
12149 /* Redisplay, but leave alone any recent echo area message unless
12150 another message has been requested in its place.
12152 This is useful in situations where you need to redisplay but no
12153 user action has occurred, making it inappropriate for the message
12154 area to be cleared. See tracking_off and
12155 wait_reading_process_output for examples of these situations.
12157 FROM_WHERE is an integer saying from where this function was
12158 called. This is useful for debugging. */
12161 redisplay_preserve_echo_area (int from_where
)
12163 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12165 if (!NILP (echo_area_buffer
[1]))
12167 /* We have a previously displayed message, but no current
12168 message. Redisplay the previous message. */
12169 display_last_displayed_message_p
= 1;
12170 redisplay_internal (1);
12171 display_last_displayed_message_p
= 0;
12174 redisplay_internal (1);
12176 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12177 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12178 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12182 /* Function registered with record_unwind_protect in
12183 redisplay_internal. Reset redisplaying_p to the value it had
12184 before redisplay_internal was called, and clear
12185 prevent_freeing_realized_faces_p. It also selects the previously
12186 selected frame, unless it has been deleted (by an X connection
12187 failure during redisplay, for example). */
12190 unwind_redisplay (Lisp_Object val
)
12192 Lisp_Object old_redisplaying_p
, old_frame
;
12194 old_redisplaying_p
= XCAR (val
);
12195 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12196 old_frame
= XCDR (val
);
12197 if (! EQ (old_frame
, selected_frame
)
12198 && FRAME_LIVE_P (XFRAME (old_frame
)))
12199 select_frame_for_redisplay (old_frame
);
12204 /* Mark the display of window W as accurate or inaccurate. If
12205 ACCURATE_P is non-zero mark display of W as accurate. If
12206 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12207 redisplay_internal is called. */
12210 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12212 if (BUFFERP (w
->buffer
))
12214 struct buffer
*b
= XBUFFER (w
->buffer
);
12217 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12218 w
->last_overlay_modified
12219 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12221 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12225 b
->clip_changed
= 0;
12226 b
->prevent_redisplay_optimizations_p
= 0;
12228 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12229 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12230 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12231 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12233 w
->current_matrix
->buffer
= b
;
12234 w
->current_matrix
->begv
= BUF_BEGV (b
);
12235 w
->current_matrix
->zv
= BUF_ZV (b
);
12237 w
->last_cursor
= w
->cursor
;
12238 w
->last_cursor_off_p
= w
->cursor_off_p
;
12240 if (w
== XWINDOW (selected_window
))
12241 w
->last_point
= make_number (BUF_PT (b
));
12243 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12249 w
->window_end_valid
= w
->buffer
;
12250 w
->update_mode_line
= Qnil
;
12255 /* Mark the display of windows in the window tree rooted at WINDOW as
12256 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12257 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12258 be redisplayed the next time redisplay_internal is called. */
12261 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12265 for (; !NILP (window
); window
= w
->next
)
12267 w
= XWINDOW (window
);
12268 mark_window_display_accurate_1 (w
, accurate_p
);
12270 if (!NILP (w
->vchild
))
12271 mark_window_display_accurate (w
->vchild
, accurate_p
);
12272 if (!NILP (w
->hchild
))
12273 mark_window_display_accurate (w
->hchild
, accurate_p
);
12278 update_overlay_arrows (1);
12282 /* Force a thorough redisplay the next time by setting
12283 last_arrow_position and last_arrow_string to t, which is
12284 unequal to any useful value of Voverlay_arrow_... */
12285 update_overlay_arrows (-1);
12290 /* Return value in display table DP (Lisp_Char_Table *) for character
12291 C. Since a display table doesn't have any parent, we don't have to
12292 follow parent. Do not call this function directly but use the
12293 macro DISP_CHAR_VECTOR. */
12296 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12300 if (ASCII_CHAR_P (c
))
12303 if (SUB_CHAR_TABLE_P (val
))
12304 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12310 XSETCHAR_TABLE (table
, dp
);
12311 val
= char_table_ref (table
, c
);
12320 /***********************************************************************
12322 ***********************************************************************/
12324 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12327 redisplay_windows (Lisp_Object window
)
12329 while (!NILP (window
))
12331 struct window
*w
= XWINDOW (window
);
12333 if (!NILP (w
->hchild
))
12334 redisplay_windows (w
->hchild
);
12335 else if (!NILP (w
->vchild
))
12336 redisplay_windows (w
->vchild
);
12337 else if (!NILP (w
->buffer
))
12339 displayed_buffer
= XBUFFER (w
->buffer
);
12340 /* Use list_of_error, not Qerror, so that
12341 we catch only errors and don't run the debugger. */
12342 internal_condition_case_1 (redisplay_window_0
, window
,
12344 redisplay_window_error
);
12352 redisplay_window_error (Lisp_Object ignore
)
12354 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12359 redisplay_window_0 (Lisp_Object window
)
12361 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12362 redisplay_window (window
, 0);
12367 redisplay_window_1 (Lisp_Object window
)
12369 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12370 redisplay_window (window
, 1);
12375 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12376 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12377 which positions recorded in ROW differ from current buffer
12380 Return 0 if cursor is not on this row, 1 otherwise. */
12383 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12384 struct glyph_matrix
*matrix
,
12385 EMACS_INT delta
, EMACS_INT delta_bytes
,
12388 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12389 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12390 struct glyph
*cursor
= NULL
;
12391 /* The last known character position in row. */
12392 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12394 EMACS_INT pt_old
= PT
- delta
;
12395 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12396 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12397 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12398 /* A glyph beyond the edge of TEXT_AREA which we should never
12400 struct glyph
*glyphs_end
= end
;
12401 /* Non-zero means we've found a match for cursor position, but that
12402 glyph has the avoid_cursor_p flag set. */
12403 int match_with_avoid_cursor
= 0;
12404 /* Non-zero means we've seen at least one glyph that came from a
12406 int string_seen
= 0;
12407 /* Largest and smalles buffer positions seen so far during scan of
12409 EMACS_INT bpos_max
= pos_before
;
12410 EMACS_INT bpos_min
= pos_after
;
12411 /* Last buffer position covered by an overlay string with an integer
12412 `cursor' property. */
12413 EMACS_INT bpos_covered
= 0;
12415 /* Skip over glyphs not having an object at the start and the end of
12416 the row. These are special glyphs like truncation marks on
12417 terminal frames. */
12418 if (row
->displays_text_p
)
12420 if (!row
->reversed_p
)
12423 && INTEGERP (glyph
->object
)
12424 && glyph
->charpos
< 0)
12426 x
+= glyph
->pixel_width
;
12430 && INTEGERP ((end
- 1)->object
)
12431 /* CHARPOS is zero for blanks and stretch glyphs
12432 inserted by extend_face_to_end_of_line. */
12433 && (end
- 1)->charpos
<= 0)
12435 glyph_before
= glyph
- 1;
12442 /* If the glyph row is reversed, we need to process it from back
12443 to front, so swap the edge pointers. */
12444 glyphs_end
= end
= glyph
- 1;
12445 glyph
+= row
->used
[TEXT_AREA
] - 1;
12447 while (glyph
> end
+ 1
12448 && INTEGERP (glyph
->object
)
12449 && glyph
->charpos
< 0)
12452 x
-= glyph
->pixel_width
;
12454 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12456 /* By default, in reversed rows we put the cursor on the
12457 rightmost (first in the reading order) glyph. */
12458 for (g
= end
+ 1; g
< glyph
; g
++)
12459 x
+= g
->pixel_width
;
12461 && INTEGERP ((end
+ 1)->object
)
12462 && (end
+ 1)->charpos
<= 0)
12464 glyph_before
= glyph
+ 1;
12468 else if (row
->reversed_p
)
12470 /* In R2L rows that don't display text, put the cursor on the
12471 rightmost glyph. Case in point: an empty last line that is
12472 part of an R2L paragraph. */
12474 /* Avoid placing the cursor on the last glyph of the row, where
12475 on terminal frames we hold the vertical border between
12476 adjacent windows. */
12477 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12478 && !WINDOW_RIGHTMOST_P (w
)
12479 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12481 x
= -1; /* will be computed below, at label compute_x */
12484 /* Step 1: Try to find the glyph whose character position
12485 corresponds to point. If that's not possible, find 2 glyphs
12486 whose character positions are the closest to point, one before
12487 point, the other after it. */
12488 if (!row
->reversed_p
)
12489 while (/* not marched to end of glyph row */
12491 /* glyph was not inserted by redisplay for internal purposes */
12492 && !INTEGERP (glyph
->object
))
12494 if (BUFFERP (glyph
->object
))
12496 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12498 if (glyph
->charpos
> bpos_max
)
12499 bpos_max
= glyph
->charpos
;
12500 if (glyph
->charpos
< bpos_min
)
12501 bpos_min
= glyph
->charpos
;
12502 if (!glyph
->avoid_cursor_p
)
12504 /* If we hit point, we've found the glyph on which to
12505 display the cursor. */
12508 match_with_avoid_cursor
= 0;
12511 /* See if we've found a better approximation to
12512 POS_BEFORE or to POS_AFTER. Note that we want the
12513 first (leftmost) glyph of all those that are the
12514 closest from below, and the last (rightmost) of all
12515 those from above. */
12516 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12518 pos_before
= glyph
->charpos
;
12519 glyph_before
= glyph
;
12521 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12523 pos_after
= glyph
->charpos
;
12524 glyph_after
= glyph
;
12527 else if (dpos
== 0)
12528 match_with_avoid_cursor
= 1;
12530 else if (STRINGP (glyph
->object
))
12532 Lisp_Object chprop
;
12533 EMACS_INT glyph_pos
= glyph
->charpos
;
12535 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12537 if (INTEGERP (chprop
))
12539 bpos_covered
= bpos_max
+ XINT (chprop
);
12540 /* If the `cursor' property covers buffer positions up
12541 to and including point, we should display cursor on
12542 this glyph. Note that overlays and text properties
12543 with string values stop bidi reordering, so every
12544 buffer position to the left of the string is always
12545 smaller than any position to the right of the
12546 string. Therefore, if a `cursor' property on one
12547 of the string's characters has an integer value, we
12548 will break out of the loop below _before_ we get to
12549 the position match above. IOW, integer values of
12550 the `cursor' property override the "exact match for
12551 point" strategy of positioning the cursor. */
12552 /* Implementation note: bpos_max == pt_old when, e.g.,
12553 we are in an empty line, where bpos_max is set to
12554 MATRIX_ROW_START_CHARPOS, see above. */
12555 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12564 x
+= glyph
->pixel_width
;
12567 else if (glyph
> end
) /* row is reversed */
12568 while (!INTEGERP (glyph
->object
))
12570 if (BUFFERP (glyph
->object
))
12572 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12574 if (glyph
->charpos
> bpos_max
)
12575 bpos_max
= glyph
->charpos
;
12576 if (glyph
->charpos
< bpos_min
)
12577 bpos_min
= glyph
->charpos
;
12578 if (!glyph
->avoid_cursor_p
)
12582 match_with_avoid_cursor
= 0;
12585 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12587 pos_before
= glyph
->charpos
;
12588 glyph_before
= glyph
;
12590 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12592 pos_after
= glyph
->charpos
;
12593 glyph_after
= glyph
;
12596 else if (dpos
== 0)
12597 match_with_avoid_cursor
= 1;
12599 else if (STRINGP (glyph
->object
))
12601 Lisp_Object chprop
;
12602 EMACS_INT glyph_pos
= glyph
->charpos
;
12604 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12606 if (INTEGERP (chprop
))
12608 bpos_covered
= bpos_max
+ XINT (chprop
);
12609 /* If the `cursor' property covers buffer positions up
12610 to and including point, we should display cursor on
12612 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12621 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12623 x
--; /* can't use any pixel_width */
12626 x
-= glyph
->pixel_width
;
12629 /* Step 2: If we didn't find an exact match for point, we need to
12630 look for a proper place to put the cursor among glyphs between
12631 GLYPH_BEFORE and GLYPH_AFTER. */
12632 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12633 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12634 && bpos_covered
< pt_old
)
12636 /* An empty line has a single glyph whose OBJECT is zero and
12637 whose CHARPOS is the position of a newline on that line.
12638 Note that on a TTY, there are more glyphs after that, which
12639 were produced by extend_face_to_end_of_line, but their
12640 CHARPOS is zero or negative. */
12642 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12643 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12645 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12647 EMACS_INT ellipsis_pos
;
12649 /* Scan back over the ellipsis glyphs. */
12650 if (!row
->reversed_p
)
12652 ellipsis_pos
= (glyph
- 1)->charpos
;
12653 while (glyph
> row
->glyphs
[TEXT_AREA
]
12654 && (glyph
- 1)->charpos
== ellipsis_pos
)
12655 glyph
--, x
-= glyph
->pixel_width
;
12656 /* That loop always goes one position too far, including
12657 the glyph before the ellipsis. So scan forward over
12659 x
+= glyph
->pixel_width
;
12662 else /* row is reversed */
12664 ellipsis_pos
= (glyph
+ 1)->charpos
;
12665 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12666 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12667 glyph
++, x
+= glyph
->pixel_width
;
12668 x
-= glyph
->pixel_width
;
12672 else if (match_with_avoid_cursor
12673 /* A truncated row may not include PT among its
12674 character positions. Setting the cursor inside the
12675 scroll margin will trigger recalculation of hscroll
12676 in hscroll_window_tree. */
12677 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12678 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12679 /* Zero-width characters produce no glyphs. */
12682 && (row
->reversed_p
12683 ? glyph_after
> glyphs_end
12684 : glyph_after
< glyphs_end
)))
12686 cursor
= glyph_after
;
12689 else if (string_seen
)
12691 int incr
= row
->reversed_p
? -1 : +1;
12693 /* Need to find the glyph that came out of a string which is
12694 present at point. That glyph is somewhere between
12695 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12696 positioned between POS_BEFORE and POS_AFTER in the
12698 struct glyph
*stop
= glyph_after
;
12699 EMACS_INT pos
= pos_before
;
12702 for (glyph
= glyph_before
+ incr
;
12703 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12706 /* Any glyphs that come from the buffer are here because
12707 of bidi reordering. Skip them, and only pay
12708 attention to glyphs that came from some string. */
12709 if (STRINGP (glyph
->object
))
12714 str
= glyph
->object
;
12715 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12716 if (tem
== 0 /* from overlay */
12719 /* If the string from which this glyph came is
12720 found in the buffer at point, then we've
12721 found the glyph we've been looking for. If
12722 it comes from an overlay (tem == 0), and it
12723 has the `cursor' property on one of its
12724 glyphs, record that glyph as a candidate for
12725 displaying the cursor. (As in the
12726 unidirectional version, we will display the
12727 cursor on the last candidate we find.) */
12728 if (tem
== 0 || tem
== pt_old
)
12730 /* The glyphs from this string could have
12731 been reordered. Find the one with the
12732 smallest string position. Or there could
12733 be a character in the string with the
12734 `cursor' property, which means display
12735 cursor on that character's glyph. */
12736 EMACS_INT strpos
= glyph
->charpos
;
12741 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12742 && EQ (glyph
->object
, str
);
12746 EMACS_INT gpos
= glyph
->charpos
;
12748 cprop
= Fget_char_property (make_number (gpos
),
12756 if (tem
&& glyph
->charpos
< strpos
)
12758 strpos
= glyph
->charpos
;
12767 pos
= tem
+ 1; /* don't find previous instances */
12769 /* This string is not what we want; skip all of the
12770 glyphs that came from it. */
12771 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12772 && EQ (glyph
->object
, str
))
12779 /* If we reached the end of the line, and END was from a string,
12780 the cursor is not on this line. */
12782 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12783 && STRINGP (end
->object
)
12784 && row
->continued_p
)
12790 if (cursor
!= NULL
)
12796 /* Need to compute x that corresponds to GLYPH. */
12797 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12799 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12801 x
+= g
->pixel_width
;
12805 /* ROW could be part of a continued line, which, under bidi
12806 reordering, might have other rows whose start and end charpos
12807 occlude point. Only set w->cursor if we found a better
12808 approximation to the cursor position than we have from previously
12809 examined candidate rows belonging to the same continued line. */
12810 if (/* we already have a candidate row */
12811 w
->cursor
.vpos
>= 0
12812 /* that candidate is not the row we are processing */
12813 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12814 /* the row we are processing is part of a continued line */
12815 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12816 /* Make sure cursor.vpos specifies a row whose start and end
12817 charpos occlude point. This is because some callers of this
12818 function leave cursor.vpos at the row where the cursor was
12819 displayed during the last redisplay cycle. */
12820 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12821 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12824 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12826 /* Don't consider glyphs that are outside TEXT_AREA. */
12827 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12829 /* Keep the candidate whose buffer position is the closest to
12831 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12832 w
->cursor
.hpos
>= 0
12833 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12834 && BUFFERP (g1
->object
)
12835 && (g1
->charpos
== pt_old
/* an exact match always wins */
12836 || (BUFFERP (glyph
->object
)
12837 && eabs (g1
->charpos
- pt_old
)
12838 < eabs (glyph
->charpos
- pt_old
))))
12840 /* If this candidate gives an exact match, use that. */
12841 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12842 /* Otherwise, keep the candidate that comes from a row
12843 spanning less buffer positions. This may win when one or
12844 both candidate positions are on glyphs that came from
12845 display strings, for which we cannot compare buffer
12847 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12848 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12849 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12852 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12854 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12855 w
->cursor
.y
= row
->y
+ dy
;
12857 if (w
== XWINDOW (selected_window
))
12859 if (!row
->continued_p
12860 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12863 this_line_buffer
= XBUFFER (w
->buffer
);
12865 CHARPOS (this_line_start_pos
)
12866 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12867 BYTEPOS (this_line_start_pos
)
12868 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12870 CHARPOS (this_line_end_pos
)
12871 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12872 BYTEPOS (this_line_end_pos
)
12873 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12875 this_line_y
= w
->cursor
.y
;
12876 this_line_pixel_height
= row
->height
;
12877 this_line_vpos
= w
->cursor
.vpos
;
12878 this_line_start_x
= row
->x
;
12881 CHARPOS (this_line_start_pos
) = 0;
12888 /* Run window scroll functions, if any, for WINDOW with new window
12889 start STARTP. Sets the window start of WINDOW to that position.
12891 We assume that the window's buffer is really current. */
12893 static INLINE
struct text_pos
12894 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12896 struct window
*w
= XWINDOW (window
);
12897 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12899 if (current_buffer
!= XBUFFER (w
->buffer
))
12902 if (!NILP (Vwindow_scroll_functions
))
12904 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12905 make_number (CHARPOS (startp
)));
12906 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12907 /* In case the hook functions switch buffers. */
12908 if (current_buffer
!= XBUFFER (w
->buffer
))
12909 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12916 /* Make sure the line containing the cursor is fully visible.
12917 A value of 1 means there is nothing to be done.
12918 (Either the line is fully visible, or it cannot be made so,
12919 or we cannot tell.)
12921 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12922 is higher than window.
12924 A value of 0 means the caller should do scrolling
12925 as if point had gone off the screen. */
12928 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12930 struct glyph_matrix
*matrix
;
12931 struct glyph_row
*row
;
12934 if (!make_cursor_line_fully_visible_p
)
12937 /* It's not always possible to find the cursor, e.g, when a window
12938 is full of overlay strings. Don't do anything in that case. */
12939 if (w
->cursor
.vpos
< 0)
12942 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12943 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12945 /* If the cursor row is not partially visible, there's nothing to do. */
12946 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12949 /* If the row the cursor is in is taller than the window's height,
12950 it's not clear what to do, so do nothing. */
12951 window_height
= window_box_height (w
);
12952 if (row
->height
>= window_height
)
12954 if (!force_p
|| MINI_WINDOW_P (w
)
12955 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12962 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12963 non-zero means only WINDOW is redisplayed in redisplay_internal.
12964 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12965 in redisplay_window to bring a partially visible line into view in
12966 the case that only the cursor has moved.
12968 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12969 last screen line's vertical height extends past the end of the screen.
12973 1 if scrolling succeeded
12975 0 if scrolling didn't find point.
12977 -1 if new fonts have been loaded so that we must interrupt
12978 redisplay, adjust glyph matrices, and try again. */
12984 SCROLLING_NEED_LARGER_MATRICES
12988 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12989 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12990 int temp_scroll_step
, int last_line_misfit
)
12992 struct window
*w
= XWINDOW (window
);
12993 struct frame
*f
= XFRAME (w
->frame
);
12994 struct text_pos pos
, startp
;
12996 int this_scroll_margin
, scroll_max
, rc
, height
;
12997 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12998 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12999 Lisp_Object aggressive
;
13000 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13003 debug_method_add (w
, "try_scrolling");
13006 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13008 /* Compute scroll margin height in pixels. We scroll when point is
13009 within this distance from the top or bottom of the window. */
13010 if (scroll_margin
> 0)
13011 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13012 * FRAME_LINE_HEIGHT (f
);
13014 this_scroll_margin
= 0;
13016 /* Force arg_scroll_conservatively to have a reasonable value, to avoid
13017 overflow while computing how much to scroll. Note that the user
13018 can supply scroll-conservatively equal to `most-positive-fixnum',
13019 which can be larger than INT_MAX. */
13020 if (arg_scroll_conservatively
> scroll_limit
)
13022 arg_scroll_conservatively
= scroll_limit
;
13023 scroll_max
= INT_MAX
;
13025 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13026 /* Compute how much we should try to scroll maximally to bring
13027 point into view. */
13028 scroll_max
= (max (scroll_step
,
13029 max (arg_scroll_conservatively
, temp_scroll_step
))
13030 * FRAME_LINE_HEIGHT (f
));
13031 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13032 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13033 /* We're trying to scroll because of aggressive scrolling but no
13034 scroll_step is set. Choose an arbitrary one. */
13035 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13041 /* Decide whether to scroll down. */
13042 if (PT
> CHARPOS (startp
))
13044 int scroll_margin_y
;
13046 /* Compute the pixel ypos of the scroll margin, then move it to
13047 either that ypos or PT, whichever comes first. */
13048 start_display (&it
, w
, startp
);
13049 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13050 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13051 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13052 (MOVE_TO_POS
| MOVE_TO_Y
));
13054 if (PT
> CHARPOS (it
.current
.pos
))
13056 int y0
= line_bottom_y (&it
);
13057 /* Compute how many pixels below window bottom to stop searching
13058 for PT. This avoids costly search for PT that is far away if
13059 the user limited scrolling by a small number of lines, but
13060 always finds PT if arg_scroll_conservatively is set to a large
13061 number, such as most-positive-fixnum. */
13062 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13064 slack
>= INT_MAX
- it
.last_visible_y
13066 : it
.last_visible_y
+ slack
;
13068 /* Compute the distance from the scroll margin to PT or to
13069 the scroll limit, whichever comes first. This should
13070 include the height of the cursor line, to make that line
13072 move_it_to (&it
, PT
, -1, y_to_move
,
13073 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13074 dy
= line_bottom_y (&it
) - y0
;
13076 if (dy
> scroll_max
)
13077 return SCROLLING_FAILED
;
13085 /* Point is in or below the bottom scroll margin, so move the
13086 window start down. If scrolling conservatively, move it just
13087 enough down to make point visible. If scroll_step is set,
13088 move it down by scroll_step. */
13089 if (arg_scroll_conservatively
)
13091 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13092 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13093 else if (scroll_step
|| temp_scroll_step
)
13094 amount_to_scroll
= scroll_max
;
13097 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13098 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13099 if (NUMBERP (aggressive
))
13101 double float_amount
= XFLOATINT (aggressive
) * height
;
13102 amount_to_scroll
= float_amount
;
13103 if (amount_to_scroll
== 0 && float_amount
> 0)
13104 amount_to_scroll
= 1;
13108 if (amount_to_scroll
<= 0)
13109 return SCROLLING_FAILED
;
13111 start_display (&it
, w
, startp
);
13112 if (scroll_max
< INT_MAX
)
13113 move_it_vertically (&it
, amount_to_scroll
);
13116 /* Extra precision for users who set scroll-conservatively
13117 to most-positive-fixnum: make sure the amount we scroll
13118 the window start is never less than amount_to_scroll,
13119 which was computed as distance from window bottom to
13120 point. This matters when lines at window top and lines
13121 below window bottom have different height. */
13122 struct it it1
= it
;
13123 /* We use a temporary it1 because line_bottom_y can modify
13124 its argument, if it moves one line down; see there. */
13125 int start_y
= line_bottom_y (&it1
);
13128 move_it_by_lines (&it
, 1, 1);
13130 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13133 /* If STARTP is unchanged, move it down another screen line. */
13134 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13135 move_it_by_lines (&it
, 1, 1);
13136 startp
= it
.current
.pos
;
13140 struct text_pos scroll_margin_pos
= startp
;
13142 /* See if point is inside the scroll margin at the top of the
13144 if (this_scroll_margin
)
13146 start_display (&it
, w
, startp
);
13147 move_it_vertically (&it
, this_scroll_margin
);
13148 scroll_margin_pos
= it
.current
.pos
;
13151 if (PT
< CHARPOS (scroll_margin_pos
))
13153 /* Point is in the scroll margin at the top of the window or
13154 above what is displayed in the window. */
13157 /* Compute the vertical distance from PT to the scroll
13158 margin position. Give up if distance is greater than
13160 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13161 start_display (&it
, w
, pos
);
13163 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13164 it
.last_visible_y
, -1,
13165 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13166 dy
= it
.current_y
- y0
;
13167 if (dy
> scroll_max
)
13168 return SCROLLING_FAILED
;
13170 /* Compute new window start. */
13171 start_display (&it
, w
, startp
);
13173 if (arg_scroll_conservatively
)
13175 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13176 else if (scroll_step
|| temp_scroll_step
)
13177 amount_to_scroll
= scroll_max
;
13180 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13181 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13182 if (NUMBERP (aggressive
))
13184 double float_amount
= XFLOATINT (aggressive
) * height
;
13185 amount_to_scroll
= float_amount
;
13186 if (amount_to_scroll
== 0 && float_amount
> 0)
13187 amount_to_scroll
= 1;
13191 if (amount_to_scroll
<= 0)
13192 return SCROLLING_FAILED
;
13194 move_it_vertically_backward (&it
, amount_to_scroll
);
13195 startp
= it
.current
.pos
;
13199 /* Run window scroll functions. */
13200 startp
= run_window_scroll_functions (window
, startp
);
13202 /* Display the window. Give up if new fonts are loaded, or if point
13204 if (!try_window (window
, startp
, 0))
13205 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13206 else if (w
->cursor
.vpos
< 0)
13208 clear_glyph_matrix (w
->desired_matrix
);
13209 rc
= SCROLLING_FAILED
;
13213 /* Maybe forget recorded base line for line number display. */
13214 if (!just_this_one_p
13215 || current_buffer
->clip_changed
13216 || BEG_UNCHANGED
< CHARPOS (startp
))
13217 w
->base_line_number
= Qnil
;
13219 /* If cursor ends up on a partially visible line,
13220 treat that as being off the bottom of the screen. */
13221 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13222 /* It's possible that the cursor is on the first line of the
13223 buffer, which is partially obscured due to a vscroll
13224 (Bug#7537). In that case, avoid looping forever . */
13225 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13227 clear_glyph_matrix (w
->desired_matrix
);
13228 ++extra_scroll_margin_lines
;
13231 rc
= SCROLLING_SUCCESS
;
13238 /* Compute a suitable window start for window W if display of W starts
13239 on a continuation line. Value is non-zero if a new window start
13242 The new window start will be computed, based on W's width, starting
13243 from the start of the continued line. It is the start of the
13244 screen line with the minimum distance from the old start W->start. */
13247 compute_window_start_on_continuation_line (struct window
*w
)
13249 struct text_pos pos
, start_pos
;
13250 int window_start_changed_p
= 0;
13252 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13254 /* If window start is on a continuation line... Window start may be
13255 < BEGV in case there's invisible text at the start of the
13256 buffer (M-x rmail, for example). */
13257 if (CHARPOS (start_pos
) > BEGV
13258 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13261 struct glyph_row
*row
;
13263 /* Handle the case that the window start is out of range. */
13264 if (CHARPOS (start_pos
) < BEGV
)
13265 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13266 else if (CHARPOS (start_pos
) > ZV
)
13267 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13269 /* Find the start of the continued line. This should be fast
13270 because scan_buffer is fast (newline cache). */
13271 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13272 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13273 row
, DEFAULT_FACE_ID
);
13274 reseat_at_previous_visible_line_start (&it
);
13276 /* If the line start is "too far" away from the window start,
13277 say it takes too much time to compute a new window start. */
13278 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13279 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13281 int min_distance
, distance
;
13283 /* Move forward by display lines to find the new window
13284 start. If window width was enlarged, the new start can
13285 be expected to be > the old start. If window width was
13286 decreased, the new window start will be < the old start.
13287 So, we're looking for the display line start with the
13288 minimum distance from the old window start. */
13289 pos
= it
.current
.pos
;
13290 min_distance
= INFINITY
;
13291 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13292 distance
< min_distance
)
13294 min_distance
= distance
;
13295 pos
= it
.current
.pos
;
13296 move_it_by_lines (&it
, 1, 0);
13299 /* Set the window start there. */
13300 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13301 window_start_changed_p
= 1;
13305 return window_start_changed_p
;
13309 /* Try cursor movement in case text has not changed in window WINDOW,
13310 with window start STARTP. Value is
13312 CURSOR_MOVEMENT_SUCCESS if successful
13314 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13316 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13317 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13318 we want to scroll as if scroll-step were set to 1. See the code.
13320 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13321 which case we have to abort this redisplay, and adjust matrices
13326 CURSOR_MOVEMENT_SUCCESS
,
13327 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13328 CURSOR_MOVEMENT_MUST_SCROLL
,
13329 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13333 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13335 struct window
*w
= XWINDOW (window
);
13336 struct frame
*f
= XFRAME (w
->frame
);
13337 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13340 if (inhibit_try_cursor_movement
)
13344 /* Handle case where text has not changed, only point, and it has
13345 not moved off the frame. */
13346 if (/* Point may be in this window. */
13347 PT
>= CHARPOS (startp
)
13348 /* Selective display hasn't changed. */
13349 && !current_buffer
->clip_changed
13350 /* Function force-mode-line-update is used to force a thorough
13351 redisplay. It sets either windows_or_buffers_changed or
13352 update_mode_lines. So don't take a shortcut here for these
13354 && !update_mode_lines
13355 && !windows_or_buffers_changed
13356 && !cursor_type_changed
13357 /* Can't use this case if highlighting a region. When a
13358 region exists, cursor movement has to do more than just
13360 && !(!NILP (Vtransient_mark_mode
)
13361 && !NILP (BVAR (current_buffer
, mark_active
)))
13362 && NILP (w
->region_showing
)
13363 && NILP (Vshow_trailing_whitespace
)
13364 /* Right after splitting windows, last_point may be nil. */
13365 && INTEGERP (w
->last_point
)
13366 /* This code is not used for mini-buffer for the sake of the case
13367 of redisplaying to replace an echo area message; since in
13368 that case the mini-buffer contents per se are usually
13369 unchanged. This code is of no real use in the mini-buffer
13370 since the handling of this_line_start_pos, etc., in redisplay
13371 handles the same cases. */
13372 && !EQ (window
, minibuf_window
)
13373 /* When splitting windows or for new windows, it happens that
13374 redisplay is called with a nil window_end_vpos or one being
13375 larger than the window. This should really be fixed in
13376 window.c. I don't have this on my list, now, so we do
13377 approximately the same as the old redisplay code. --gerd. */
13378 && INTEGERP (w
->window_end_vpos
)
13379 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13380 && (FRAME_WINDOW_P (f
)
13381 || !overlay_arrow_in_current_buffer_p ()))
13383 int this_scroll_margin
, top_scroll_margin
;
13384 struct glyph_row
*row
= NULL
;
13387 debug_method_add (w
, "cursor movement");
13390 /* Scroll if point within this distance from the top or bottom
13391 of the window. This is a pixel value. */
13392 if (scroll_margin
> 0)
13394 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13395 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13398 this_scroll_margin
= 0;
13400 top_scroll_margin
= this_scroll_margin
;
13401 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13402 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13404 /* Start with the row the cursor was displayed during the last
13405 not paused redisplay. Give up if that row is not valid. */
13406 if (w
->last_cursor
.vpos
< 0
13407 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13408 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13411 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13412 if (row
->mode_line_p
)
13414 if (!row
->enabled_p
)
13415 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13418 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13420 int scroll_p
= 0, must_scroll
= 0;
13421 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13423 if (PT
> XFASTINT (w
->last_point
))
13425 /* Point has moved forward. */
13426 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13427 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13429 xassert (row
->enabled_p
);
13433 /* If the end position of a row equals the start
13434 position of the next row, and PT is at that position,
13435 we would rather display cursor in the next line. */
13436 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13437 && MATRIX_ROW_END_CHARPOS (row
) == PT
13438 && row
< w
->current_matrix
->rows
13439 + w
->current_matrix
->nrows
- 1
13440 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13441 && !cursor_row_p (w
, row
))
13444 /* If within the scroll margin, scroll. Note that
13445 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13446 the next line would be drawn, and that
13447 this_scroll_margin can be zero. */
13448 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13449 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13450 /* Line is completely visible last line in window
13451 and PT is to be set in the next line. */
13452 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13453 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13454 && !row
->ends_at_zv_p
13455 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13458 else if (PT
< XFASTINT (w
->last_point
))
13460 /* Cursor has to be moved backward. Note that PT >=
13461 CHARPOS (startp) because of the outer if-statement. */
13462 while (!row
->mode_line_p
13463 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13464 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13465 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13466 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13467 row
> w
->current_matrix
->rows
13468 && (row
-1)->ends_in_newline_from_string_p
))))
13469 && (row
->y
> top_scroll_margin
13470 || CHARPOS (startp
) == BEGV
))
13472 xassert (row
->enabled_p
);
13476 /* Consider the following case: Window starts at BEGV,
13477 there is invisible, intangible text at BEGV, so that
13478 display starts at some point START > BEGV. It can
13479 happen that we are called with PT somewhere between
13480 BEGV and START. Try to handle that case. */
13481 if (row
< w
->current_matrix
->rows
13482 || row
->mode_line_p
)
13484 row
= w
->current_matrix
->rows
;
13485 if (row
->mode_line_p
)
13489 /* Due to newlines in overlay strings, we may have to
13490 skip forward over overlay strings. */
13491 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13492 && MATRIX_ROW_END_CHARPOS (row
) == PT
13493 && !cursor_row_p (w
, row
))
13496 /* If within the scroll margin, scroll. */
13497 if (row
->y
< top_scroll_margin
13498 && CHARPOS (startp
) != BEGV
)
13503 /* Cursor did not move. So don't scroll even if cursor line
13504 is partially visible, as it was so before. */
13505 rc
= CURSOR_MOVEMENT_SUCCESS
;
13508 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13509 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13511 /* if PT is not in the glyph row, give up. */
13512 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13515 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13516 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13518 /* If rows are bidi-reordered and point moved, back up
13519 until we find a row that does not belong to a
13520 continuation line. This is because we must consider
13521 all rows of a continued line as candidates for the
13522 new cursor positioning, since row start and end
13523 positions change non-linearly with vertical position
13525 /* FIXME: Revisit this when glyph ``spilling'' in
13526 continuation lines' rows is implemented for
13527 bidi-reordered rows. */
13528 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13530 xassert (row
->enabled_p
);
13532 /* If we hit the beginning of the displayed portion
13533 without finding the first row of a continued
13535 if (row
<= w
->current_matrix
->rows
)
13537 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13545 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13546 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13547 && make_cursor_line_fully_visible_p
)
13549 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13550 && !row
->ends_at_zv_p
13551 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13552 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13553 else if (row
->height
> window_box_height (w
))
13555 /* If we end up in a partially visible line, let's
13556 make it fully visible, except when it's taller
13557 than the window, in which case we can't do much
13560 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13564 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13565 if (!cursor_row_fully_visible_p (w
, 0, 1))
13566 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13568 rc
= CURSOR_MOVEMENT_SUCCESS
;
13572 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13573 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13574 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13576 /* With bidi-reordered rows, there could be more than
13577 one candidate row whose start and end positions
13578 occlude point. We need to let set_cursor_from_row
13579 find the best candidate. */
13580 /* FIXME: Revisit this when glyph ``spilling'' in
13581 continuation lines' rows is implemented for
13582 bidi-reordered rows. */
13587 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13588 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13589 && cursor_row_p (w
, row
))
13590 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13592 /* As soon as we've found the first suitable row
13593 whose ends_at_zv_p flag is set, we are done. */
13595 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13597 rc
= CURSOR_MOVEMENT_SUCCESS
;
13602 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13603 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13604 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13605 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13606 /* If we didn't find any candidate rows, or exited the
13607 loop before all the candidates were examined, signal
13608 to the caller that this method failed. */
13609 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13610 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13611 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13613 rc
= CURSOR_MOVEMENT_SUCCESS
;
13619 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13621 rc
= CURSOR_MOVEMENT_SUCCESS
;
13626 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13627 && MATRIX_ROW_START_CHARPOS (row
) == PT
13628 && cursor_row_p (w
, row
));
13637 set_vertical_scroll_bar (struct window
*w
)
13639 EMACS_INT start
, end
, whole
;
13641 /* Calculate the start and end positions for the current window.
13642 At some point, it would be nice to choose between scrollbars
13643 which reflect the whole buffer size, with special markers
13644 indicating narrowing, and scrollbars which reflect only the
13647 Note that mini-buffers sometimes aren't displaying any text. */
13648 if (!MINI_WINDOW_P (w
)
13649 || (w
== XWINDOW (minibuf_window
)
13650 && NILP (echo_area_buffer
[0])))
13652 struct buffer
*buf
= XBUFFER (w
->buffer
);
13653 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13654 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13655 /* I don't think this is guaranteed to be right. For the
13656 moment, we'll pretend it is. */
13657 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13661 if (whole
< (end
- start
))
13662 whole
= end
- start
;
13665 start
= end
= whole
= 0;
13667 /* Indicate what this scroll bar ought to be displaying now. */
13668 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13669 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13670 (w
, end
- start
, whole
, start
);
13674 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13675 selected_window is redisplayed.
13677 We can return without actually redisplaying the window if
13678 fonts_changed_p is nonzero. In that case, redisplay_internal will
13682 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13684 struct window
*w
= XWINDOW (window
);
13685 struct frame
*f
= XFRAME (w
->frame
);
13686 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13687 struct buffer
*old
= current_buffer
;
13688 struct text_pos lpoint
, opoint
, startp
;
13689 int update_mode_line
;
13692 /* Record it now because it's overwritten. */
13693 int current_matrix_up_to_date_p
= 0;
13694 int used_current_matrix_p
= 0;
13695 /* This is less strict than current_matrix_up_to_date_p.
13696 It indictes that the buffer contents and narrowing are unchanged. */
13697 int buffer_unchanged_p
= 0;
13698 int temp_scroll_step
= 0;
13699 int count
= SPECPDL_INDEX ();
13700 int centering_position
= -1;
13701 int last_line_misfit
= 0;
13702 EMACS_INT beg_unchanged
, end_unchanged
;
13704 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13707 /* W must be a leaf window here. */
13708 xassert (!NILP (w
->buffer
));
13710 *w
->desired_matrix
->method
= 0;
13714 reconsider_clip_changes (w
, buffer
);
13716 /* Has the mode line to be updated? */
13717 update_mode_line
= (!NILP (w
->update_mode_line
)
13718 || update_mode_lines
13719 || buffer
->clip_changed
13720 || buffer
->prevent_redisplay_optimizations_p
);
13722 if (MINI_WINDOW_P (w
))
13724 if (w
== XWINDOW (echo_area_window
)
13725 && !NILP (echo_area_buffer
[0]))
13727 if (update_mode_line
)
13728 /* We may have to update a tty frame's menu bar or a
13729 tool-bar. Example `M-x C-h C-h C-g'. */
13730 goto finish_menu_bars
;
13732 /* We've already displayed the echo area glyphs in this window. */
13733 goto finish_scroll_bars
;
13735 else if ((w
!= XWINDOW (minibuf_window
)
13736 || minibuf_level
== 0)
13737 /* When buffer is nonempty, redisplay window normally. */
13738 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13739 /* Quail displays non-mini buffers in minibuffer window.
13740 In that case, redisplay the window normally. */
13741 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13743 /* W is a mini-buffer window, but it's not active, so clear
13745 int yb
= window_text_bottom_y (w
);
13746 struct glyph_row
*row
;
13749 for (y
= 0, row
= w
->desired_matrix
->rows
;
13751 y
+= row
->height
, ++row
)
13752 blank_row (w
, row
, y
);
13753 goto finish_scroll_bars
;
13756 clear_glyph_matrix (w
->desired_matrix
);
13759 /* Otherwise set up data on this window; select its buffer and point
13761 /* Really select the buffer, for the sake of buffer-local
13763 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13765 current_matrix_up_to_date_p
13766 = (!NILP (w
->window_end_valid
)
13767 && !current_buffer
->clip_changed
13768 && !current_buffer
->prevent_redisplay_optimizations_p
13769 && XFASTINT (w
->last_modified
) >= MODIFF
13770 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13772 /* Run the window-bottom-change-functions
13773 if it is possible that the text on the screen has changed
13774 (either due to modification of the text, or any other reason). */
13775 if (!current_matrix_up_to_date_p
13776 && !NILP (Vwindow_text_change_functions
))
13778 safe_run_hooks (Qwindow_text_change_functions
);
13782 beg_unchanged
= BEG_UNCHANGED
;
13783 end_unchanged
= END_UNCHANGED
;
13785 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13787 specbind (Qinhibit_point_motion_hooks
, Qt
);
13790 = (!NILP (w
->window_end_valid
)
13791 && !current_buffer
->clip_changed
13792 && XFASTINT (w
->last_modified
) >= MODIFF
13793 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13795 /* When windows_or_buffers_changed is non-zero, we can't rely on
13796 the window end being valid, so set it to nil there. */
13797 if (windows_or_buffers_changed
)
13799 /* If window starts on a continuation line, maybe adjust the
13800 window start in case the window's width changed. */
13801 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13802 compute_window_start_on_continuation_line (w
);
13804 w
->window_end_valid
= Qnil
;
13807 /* Some sanity checks. */
13808 CHECK_WINDOW_END (w
);
13809 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13811 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13814 /* If %c is in mode line, update it if needed. */
13815 if (!NILP (w
->column_number_displayed
)
13816 /* This alternative quickly identifies a common case
13817 where no change is needed. */
13818 && !(PT
== XFASTINT (w
->last_point
)
13819 && XFASTINT (w
->last_modified
) >= MODIFF
13820 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13821 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13822 update_mode_line
= 1;
13824 /* Count number of windows showing the selected buffer. An indirect
13825 buffer counts as its base buffer. */
13826 if (!just_this_one_p
)
13828 struct buffer
*current_base
, *window_base
;
13829 current_base
= current_buffer
;
13830 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13831 if (current_base
->base_buffer
)
13832 current_base
= current_base
->base_buffer
;
13833 if (window_base
->base_buffer
)
13834 window_base
= window_base
->base_buffer
;
13835 if (current_base
== window_base
)
13839 /* Point refers normally to the selected window. For any other
13840 window, set up appropriate value. */
13841 if (!EQ (window
, selected_window
))
13843 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13844 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13848 new_pt_byte
= BEGV_BYTE
;
13849 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13851 else if (new_pt
> (ZV
- 1))
13854 new_pt_byte
= ZV_BYTE
;
13855 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13858 /* We don't use SET_PT so that the point-motion hooks don't run. */
13859 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13862 /* If any of the character widths specified in the display table
13863 have changed, invalidate the width run cache. It's true that
13864 this may be a bit late to catch such changes, but the rest of
13865 redisplay goes (non-fatally) haywire when the display table is
13866 changed, so why should we worry about doing any better? */
13867 if (current_buffer
->width_run_cache
)
13869 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13871 if (! disptab_matches_widthtab (disptab
,
13872 XVECTOR (BVAR (current_buffer
, width_table
))))
13874 invalidate_region_cache (current_buffer
,
13875 current_buffer
->width_run_cache
,
13877 recompute_width_table (current_buffer
, disptab
);
13881 /* If window-start is screwed up, choose a new one. */
13882 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13885 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13887 /* If someone specified a new starting point but did not insist,
13888 check whether it can be used. */
13889 if (!NILP (w
->optional_new_start
)
13890 && CHARPOS (startp
) >= BEGV
13891 && CHARPOS (startp
) <= ZV
)
13893 w
->optional_new_start
= Qnil
;
13894 start_display (&it
, w
, startp
);
13895 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13896 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13897 if (IT_CHARPOS (it
) == PT
)
13898 w
->force_start
= Qt
;
13899 /* IT may overshoot PT if text at PT is invisible. */
13900 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13901 w
->force_start
= Qt
;
13906 /* Handle case where place to start displaying has been specified,
13907 unless the specified location is outside the accessible range. */
13908 if (!NILP (w
->force_start
)
13909 || w
->frozen_window_start_p
)
13911 /* We set this later on if we have to adjust point. */
13914 w
->force_start
= Qnil
;
13916 w
->window_end_valid
= Qnil
;
13918 /* Forget any recorded base line for line number display. */
13919 if (!buffer_unchanged_p
)
13920 w
->base_line_number
= Qnil
;
13922 /* Redisplay the mode line. Select the buffer properly for that.
13923 Also, run the hook window-scroll-functions
13924 because we have scrolled. */
13925 /* Note, we do this after clearing force_start because
13926 if there's an error, it is better to forget about force_start
13927 than to get into an infinite loop calling the hook functions
13928 and having them get more errors. */
13929 if (!update_mode_line
13930 || ! NILP (Vwindow_scroll_functions
))
13932 update_mode_line
= 1;
13933 w
->update_mode_line
= Qt
;
13934 startp
= run_window_scroll_functions (window
, startp
);
13937 w
->last_modified
= make_number (0);
13938 w
->last_overlay_modified
= make_number (0);
13939 if (CHARPOS (startp
) < BEGV
)
13940 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13941 else if (CHARPOS (startp
) > ZV
)
13942 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13944 /* Redisplay, then check if cursor has been set during the
13945 redisplay. Give up if new fonts were loaded. */
13946 /* We used to issue a CHECK_MARGINS argument to try_window here,
13947 but this causes scrolling to fail when point begins inside
13948 the scroll margin (bug#148) -- cyd */
13949 if (!try_window (window
, startp
, 0))
13951 w
->force_start
= Qt
;
13952 clear_glyph_matrix (w
->desired_matrix
);
13953 goto need_larger_matrices
;
13956 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13958 /* If point does not appear, try to move point so it does
13959 appear. The desired matrix has been built above, so we
13960 can use it here. */
13961 new_vpos
= window_box_height (w
) / 2;
13964 if (!cursor_row_fully_visible_p (w
, 0, 0))
13966 /* Point does appear, but on a line partly visible at end of window.
13967 Move it back to a fully-visible line. */
13968 new_vpos
= window_box_height (w
);
13971 /* If we need to move point for either of the above reasons,
13972 now actually do it. */
13975 struct glyph_row
*row
;
13977 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13978 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13981 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13982 MATRIX_ROW_START_BYTEPOS (row
));
13984 if (w
!= XWINDOW (selected_window
))
13985 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13986 else if (current_buffer
== old
)
13987 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13989 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13991 /* If we are highlighting the region, then we just changed
13992 the region, so redisplay to show it. */
13993 if (!NILP (Vtransient_mark_mode
)
13994 && !NILP (BVAR (current_buffer
, mark_active
)))
13996 clear_glyph_matrix (w
->desired_matrix
);
13997 if (!try_window (window
, startp
, 0))
13998 goto need_larger_matrices
;
14003 debug_method_add (w
, "forced window start");
14008 /* Handle case where text has not changed, only point, and it has
14009 not moved off the frame, and we are not retrying after hscroll.
14010 (current_matrix_up_to_date_p is nonzero when retrying.) */
14011 if (current_matrix_up_to_date_p
)
14013 int rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
);
14017 case CURSOR_MOVEMENT_CANNOT_BE_USED
:
14020 case CURSOR_MOVEMENT_SUCCESS
:
14021 used_current_matrix_p
= 1;
14024 case CURSOR_MOVEMENT_MUST_SCROLL
:
14025 goto try_to_scroll
;
14031 /* If current starting point was originally the beginning of a line
14032 but no longer is, find a new starting point. */
14033 else if (!NILP (w
->start_at_line_beg
)
14034 && !(CHARPOS (startp
) <= BEGV
14035 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14038 debug_method_add (w
, "recenter 1");
14043 /* Try scrolling with try_window_id. Value is > 0 if update has
14044 been done, it is -1 if we know that the same window start will
14045 not work. It is 0 if unsuccessful for some other reason. */
14046 else if ((tem
= try_window_id (w
)) != 0)
14049 debug_method_add (w
, "try_window_id %d", tem
);
14052 if (fonts_changed_p
)
14053 goto need_larger_matrices
;
14057 /* Otherwise try_window_id has returned -1 which means that we
14058 don't want the alternative below this comment to execute. */
14060 else if (CHARPOS (startp
) >= BEGV
14061 && CHARPOS (startp
) <= ZV
14062 && PT
>= CHARPOS (startp
)
14063 && (CHARPOS (startp
) < ZV
14064 /* Avoid starting at end of buffer. */
14065 || CHARPOS (startp
) == BEGV
14066 || (XFASTINT (w
->last_modified
) >= MODIFF
14067 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14070 /* If first window line is a continuation line, and window start
14071 is inside the modified region, but the first change is before
14072 current window start, we must select a new window start.
14074 However, if this is the result of a down-mouse event (e.g. by
14075 extending the mouse-drag-overlay), we don't want to select a
14076 new window start, since that would change the position under
14077 the mouse, resulting in an unwanted mouse-movement rather
14078 than a simple mouse-click. */
14079 if (NILP (w
->start_at_line_beg
)
14080 && NILP (do_mouse_tracking
)
14081 && CHARPOS (startp
) > BEGV
14082 && CHARPOS (startp
) > BEG
+ beg_unchanged
14083 && CHARPOS (startp
) <= Z
- end_unchanged
14084 /* Even if w->start_at_line_beg is nil, a new window may
14085 start at a line_beg, since that's how set_buffer_window
14086 sets it. So, we need to check the return value of
14087 compute_window_start_on_continuation_line. (See also
14089 && XMARKER (w
->start
)->buffer
== current_buffer
14090 && compute_window_start_on_continuation_line (w
))
14092 w
->force_start
= Qt
;
14093 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14098 debug_method_add (w
, "same window start");
14101 /* Try to redisplay starting at same place as before.
14102 If point has not moved off frame, accept the results. */
14103 if (!current_matrix_up_to_date_p
14104 /* Don't use try_window_reusing_current_matrix in this case
14105 because a window scroll function can have changed the
14107 || !NILP (Vwindow_scroll_functions
)
14108 || MINI_WINDOW_P (w
)
14109 || !(used_current_matrix_p
14110 = try_window_reusing_current_matrix (w
)))
14112 IF_DEBUG (debug_method_add (w
, "1"));
14113 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14114 /* -1 means we need to scroll.
14115 0 means we need new matrices, but fonts_changed_p
14116 is set in that case, so we will detect it below. */
14117 goto try_to_scroll
;
14120 if (fonts_changed_p
)
14121 goto need_larger_matrices
;
14123 if (w
->cursor
.vpos
>= 0)
14125 if (!just_this_one_p
14126 || current_buffer
->clip_changed
14127 || BEG_UNCHANGED
< CHARPOS (startp
))
14128 /* Forget any recorded base line for line number display. */
14129 w
->base_line_number
= Qnil
;
14131 if (!cursor_row_fully_visible_p (w
, 1, 0))
14133 clear_glyph_matrix (w
->desired_matrix
);
14134 last_line_misfit
= 1;
14136 /* Drop through and scroll. */
14141 clear_glyph_matrix (w
->desired_matrix
);
14146 w
->last_modified
= make_number (0);
14147 w
->last_overlay_modified
= make_number (0);
14149 /* Redisplay the mode line. Select the buffer properly for that. */
14150 if (!update_mode_line
)
14152 update_mode_line
= 1;
14153 w
->update_mode_line
= Qt
;
14156 /* Try to scroll by specified few lines. */
14157 if ((scroll_conservatively
14158 || emacs_scroll_step
14159 || temp_scroll_step
14160 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14161 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14162 && !current_buffer
->clip_changed
14163 && CHARPOS (startp
) >= BEGV
14164 && CHARPOS (startp
) <= ZV
)
14166 /* The function returns -1 if new fonts were loaded, 1 if
14167 successful, 0 if not successful. */
14168 int rc
= try_scrolling (window
, just_this_one_p
,
14169 scroll_conservatively
,
14171 temp_scroll_step
, last_line_misfit
);
14174 case SCROLLING_SUCCESS
:
14177 case SCROLLING_NEED_LARGER_MATRICES
:
14178 goto need_larger_matrices
;
14180 case SCROLLING_FAILED
:
14188 /* Finally, just choose place to start which centers point */
14191 if (centering_position
< 0)
14192 centering_position
= window_box_height (w
) / 2;
14195 debug_method_add (w
, "recenter");
14198 /* w->vscroll = 0; */
14200 /* Forget any previously recorded base line for line number display. */
14201 if (!buffer_unchanged_p
)
14202 w
->base_line_number
= Qnil
;
14204 /* Move backward half the height of the window. */
14205 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14206 it
.current_y
= it
.last_visible_y
;
14207 move_it_vertically_backward (&it
, centering_position
);
14208 xassert (IT_CHARPOS (it
) >= BEGV
);
14210 /* The function move_it_vertically_backward may move over more
14211 than the specified y-distance. If it->w is small, e.g. a
14212 mini-buffer window, we may end up in front of the window's
14213 display area. Start displaying at the start of the line
14214 containing PT in this case. */
14215 if (it
.current_y
<= 0)
14217 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14218 move_it_vertically_backward (&it
, 0);
14222 it
.current_x
= it
.hpos
= 0;
14224 /* Set startp here explicitly in case that helps avoid an infinite loop
14225 in case the window-scroll-functions functions get errors. */
14226 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14228 /* Run scroll hooks. */
14229 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14231 /* Redisplay the window. */
14232 if (!current_matrix_up_to_date_p
14233 || windows_or_buffers_changed
14234 || cursor_type_changed
14235 /* Don't use try_window_reusing_current_matrix in this case
14236 because it can have changed the buffer. */
14237 || !NILP (Vwindow_scroll_functions
)
14238 || !just_this_one_p
14239 || MINI_WINDOW_P (w
)
14240 || !(used_current_matrix_p
14241 = try_window_reusing_current_matrix (w
)))
14242 try_window (window
, startp
, 0);
14244 /* If new fonts have been loaded (due to fontsets), give up. We
14245 have to start a new redisplay since we need to re-adjust glyph
14247 if (fonts_changed_p
)
14248 goto need_larger_matrices
;
14250 /* If cursor did not appear assume that the middle of the window is
14251 in the first line of the window. Do it again with the next line.
14252 (Imagine a window of height 100, displaying two lines of height
14253 60. Moving back 50 from it->last_visible_y will end in the first
14255 if (w
->cursor
.vpos
< 0)
14257 if (!NILP (w
->window_end_valid
)
14258 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14260 clear_glyph_matrix (w
->desired_matrix
);
14261 move_it_by_lines (&it
, 1, 0);
14262 try_window (window
, it
.current
.pos
, 0);
14264 else if (PT
< IT_CHARPOS (it
))
14266 clear_glyph_matrix (w
->desired_matrix
);
14267 move_it_by_lines (&it
, -1, 0);
14268 try_window (window
, it
.current
.pos
, 0);
14272 /* Not much we can do about it. */
14276 /* Consider the following case: Window starts at BEGV, there is
14277 invisible, intangible text at BEGV, so that display starts at
14278 some point START > BEGV. It can happen that we are called with
14279 PT somewhere between BEGV and START. Try to handle that case. */
14280 if (w
->cursor
.vpos
< 0)
14282 struct glyph_row
*row
= w
->current_matrix
->rows
;
14283 if (row
->mode_line_p
)
14285 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14288 if (!cursor_row_fully_visible_p (w
, 0, 0))
14290 /* If vscroll is enabled, disable it and try again. */
14294 clear_glyph_matrix (w
->desired_matrix
);
14298 /* If centering point failed to make the whole line visible,
14299 put point at the top instead. That has to make the whole line
14300 visible, if it can be done. */
14301 if (centering_position
== 0)
14304 clear_glyph_matrix (w
->desired_matrix
);
14305 centering_position
= 0;
14311 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14312 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14313 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14316 /* Display the mode line, if we must. */
14317 if ((update_mode_line
14318 /* If window not full width, must redo its mode line
14319 if (a) the window to its side is being redone and
14320 (b) we do a frame-based redisplay. This is a consequence
14321 of how inverted lines are drawn in frame-based redisplay. */
14322 || (!just_this_one_p
14323 && !FRAME_WINDOW_P (f
)
14324 && !WINDOW_FULL_WIDTH_P (w
))
14325 /* Line number to display. */
14326 || INTEGERP (w
->base_line_pos
)
14327 /* Column number is displayed and different from the one displayed. */
14328 || (!NILP (w
->column_number_displayed
)
14329 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14330 /* This means that the window has a mode line. */
14331 && (WINDOW_WANTS_MODELINE_P (w
)
14332 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14334 display_mode_lines (w
);
14336 /* If mode line height has changed, arrange for a thorough
14337 immediate redisplay using the correct mode line height. */
14338 if (WINDOW_WANTS_MODELINE_P (w
)
14339 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14341 fonts_changed_p
= 1;
14342 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14343 = DESIRED_MODE_LINE_HEIGHT (w
);
14346 /* If header line height has changed, arrange for a thorough
14347 immediate redisplay using the correct header line height. */
14348 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14349 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14351 fonts_changed_p
= 1;
14352 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14353 = DESIRED_HEADER_LINE_HEIGHT (w
);
14356 if (fonts_changed_p
)
14357 goto need_larger_matrices
;
14360 if (!line_number_displayed
14361 && !BUFFERP (w
->base_line_pos
))
14363 w
->base_line_pos
= Qnil
;
14364 w
->base_line_number
= Qnil
;
14369 /* When we reach a frame's selected window, redo the frame's menu bar. */
14370 if (update_mode_line
14371 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14373 int redisplay_menu_p
= 0;
14374 int redisplay_tool_bar_p
= 0;
14376 if (FRAME_WINDOW_P (f
))
14378 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14379 || defined (HAVE_NS) || defined (USE_GTK)
14380 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14382 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14386 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14388 if (redisplay_menu_p
)
14389 display_menu_bar (w
);
14391 #ifdef HAVE_WINDOW_SYSTEM
14392 if (FRAME_WINDOW_P (f
))
14394 #if defined (USE_GTK) || defined (HAVE_NS)
14395 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14397 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14398 && (FRAME_TOOL_BAR_LINES (f
) > 0
14399 || !NILP (Vauto_resize_tool_bars
));
14402 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14404 ignore_mouse_drag_p
= 1;
14410 #ifdef HAVE_WINDOW_SYSTEM
14411 if (FRAME_WINDOW_P (f
)
14412 && update_window_fringes (w
, (just_this_one_p
14413 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14414 || w
->pseudo_window_p
)))
14418 if (draw_window_fringes (w
, 1))
14419 x_draw_vertical_border (w
);
14423 #endif /* HAVE_WINDOW_SYSTEM */
14425 /* We go to this label, with fonts_changed_p nonzero,
14426 if it is necessary to try again using larger glyph matrices.
14427 We have to redeem the scroll bar even in this case,
14428 because the loop in redisplay_internal expects that. */
14429 need_larger_matrices
:
14431 finish_scroll_bars
:
14433 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14435 /* Set the thumb's position and size. */
14436 set_vertical_scroll_bar (w
);
14438 /* Note that we actually used the scroll bar attached to this
14439 window, so it shouldn't be deleted at the end of redisplay. */
14440 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14441 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14444 /* Restore current_buffer and value of point in it. The window
14445 update may have changed the buffer, so first make sure `opoint'
14446 is still valid (Bug#6177). */
14447 if (CHARPOS (opoint
) < BEGV
)
14448 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14449 else if (CHARPOS (opoint
) > ZV
)
14450 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14452 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14454 set_buffer_internal_1 (old
);
14455 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14456 shorter. This can be caused by log truncation in *Messages*. */
14457 if (CHARPOS (lpoint
) <= ZV
)
14458 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14460 unbind_to (count
, Qnil
);
14464 /* Build the complete desired matrix of WINDOW with a window start
14465 buffer position POS.
14467 Value is 1 if successful. It is zero if fonts were loaded during
14468 redisplay which makes re-adjusting glyph matrices necessary, and -1
14469 if point would appear in the scroll margins.
14470 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14471 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14475 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14477 struct window
*w
= XWINDOW (window
);
14479 struct glyph_row
*last_text_row
= NULL
;
14480 struct frame
*f
= XFRAME (w
->frame
);
14482 /* Make POS the new window start. */
14483 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14485 /* Mark cursor position as unknown. No overlay arrow seen. */
14486 w
->cursor
.vpos
= -1;
14487 overlay_arrow_seen
= 0;
14489 /* Initialize iterator and info to start at POS. */
14490 start_display (&it
, w
, pos
);
14492 /* Display all lines of W. */
14493 while (it
.current_y
< it
.last_visible_y
)
14495 if (display_line (&it
))
14496 last_text_row
= it
.glyph_row
- 1;
14497 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14501 /* Don't let the cursor end in the scroll margins. */
14502 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14503 && !MINI_WINDOW_P (w
))
14505 int this_scroll_margin
;
14507 if (scroll_margin
> 0)
14509 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14510 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14513 this_scroll_margin
= 0;
14515 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14516 && w
->cursor
.y
< this_scroll_margin
14517 && CHARPOS (pos
) > BEGV
14518 && IT_CHARPOS (it
) < ZV
)
14519 /* rms: considering make_cursor_line_fully_visible_p here
14520 seems to give wrong results. We don't want to recenter
14521 when the last line is partly visible, we want to allow
14522 that case to be handled in the usual way. */
14523 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14525 w
->cursor
.vpos
= -1;
14526 clear_glyph_matrix (w
->desired_matrix
);
14531 /* If bottom moved off end of frame, change mode line percentage. */
14532 if (XFASTINT (w
->window_end_pos
) <= 0
14533 && Z
!= IT_CHARPOS (it
))
14534 w
->update_mode_line
= Qt
;
14536 /* Set window_end_pos to the offset of the last character displayed
14537 on the window from the end of current_buffer. Set
14538 window_end_vpos to its row number. */
14541 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14542 w
->window_end_bytepos
14543 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14545 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14547 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14548 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14549 ->displays_text_p
);
14553 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14554 w
->window_end_pos
= make_number (Z
- ZV
);
14555 w
->window_end_vpos
= make_number (0);
14558 /* But that is not valid info until redisplay finishes. */
14559 w
->window_end_valid
= Qnil
;
14565 /************************************************************************
14566 Window redisplay reusing current matrix when buffer has not changed
14567 ************************************************************************/
14569 /* Try redisplay of window W showing an unchanged buffer with a
14570 different window start than the last time it was displayed by
14571 reusing its current matrix. Value is non-zero if successful.
14572 W->start is the new window start. */
14575 try_window_reusing_current_matrix (struct window
*w
)
14577 struct frame
*f
= XFRAME (w
->frame
);
14578 struct glyph_row
*bottom_row
;
14581 struct text_pos start
, new_start
;
14582 int nrows_scrolled
, i
;
14583 struct glyph_row
*last_text_row
;
14584 struct glyph_row
*last_reused_text_row
;
14585 struct glyph_row
*start_row
;
14586 int start_vpos
, min_y
, max_y
;
14589 if (inhibit_try_window_reusing
)
14593 if (/* This function doesn't handle terminal frames. */
14594 !FRAME_WINDOW_P (f
)
14595 /* Don't try to reuse the display if windows have been split
14597 || windows_or_buffers_changed
14598 || cursor_type_changed
)
14601 /* Can't do this if region may have changed. */
14602 if ((!NILP (Vtransient_mark_mode
)
14603 && !NILP (BVAR (current_buffer
, mark_active
)))
14604 || !NILP (w
->region_showing
)
14605 || !NILP (Vshow_trailing_whitespace
))
14608 /* If top-line visibility has changed, give up. */
14609 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14610 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14613 /* Give up if old or new display is scrolled vertically. We could
14614 make this function handle this, but right now it doesn't. */
14615 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14616 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14619 /* The variable new_start now holds the new window start. The old
14620 start `start' can be determined from the current matrix. */
14621 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14622 start
= start_row
->minpos
;
14623 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14625 /* Clear the desired matrix for the display below. */
14626 clear_glyph_matrix (w
->desired_matrix
);
14628 if (CHARPOS (new_start
) <= CHARPOS (start
))
14632 /* Don't use this method if the display starts with an ellipsis
14633 displayed for invisible text. It's not easy to handle that case
14634 below, and it's certainly not worth the effort since this is
14635 not a frequent case. */
14636 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14639 IF_DEBUG (debug_method_add (w
, "twu1"));
14641 /* Display up to a row that can be reused. The variable
14642 last_text_row is set to the last row displayed that displays
14643 text. Note that it.vpos == 0 if or if not there is a
14644 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14645 start_display (&it
, w
, new_start
);
14646 first_row_y
= it
.current_y
;
14647 w
->cursor
.vpos
= -1;
14648 last_text_row
= last_reused_text_row
= NULL
;
14650 while (it
.current_y
< it
.last_visible_y
14651 && !fonts_changed_p
)
14653 /* If we have reached into the characters in the START row,
14654 that means the line boundaries have changed. So we
14655 can't start copying with the row START. Maybe it will
14656 work to start copying with the following row. */
14657 while (IT_CHARPOS (it
) > CHARPOS (start
))
14659 /* Advance to the next row as the "start". */
14661 start
= start_row
->minpos
;
14662 /* If there are no more rows to try, or just one, give up. */
14663 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14664 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14665 || CHARPOS (start
) == ZV
)
14667 clear_glyph_matrix (w
->desired_matrix
);
14671 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14673 /* If we have reached alignment,
14674 we can copy the rest of the rows. */
14675 if (IT_CHARPOS (it
) == CHARPOS (start
))
14678 if (display_line (&it
))
14679 last_text_row
= it
.glyph_row
- 1;
14682 /* A value of current_y < last_visible_y means that we stopped
14683 at the previous window start, which in turn means that we
14684 have at least one reusable row. */
14685 if (it
.current_y
< it
.last_visible_y
)
14687 struct glyph_row
*row
;
14689 /* IT.vpos always starts from 0; it counts text lines. */
14690 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14692 /* Find PT if not already found in the lines displayed. */
14693 if (w
->cursor
.vpos
< 0)
14695 int dy
= it
.current_y
- start_row
->y
;
14697 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14698 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14700 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14701 dy
, nrows_scrolled
);
14704 clear_glyph_matrix (w
->desired_matrix
);
14709 /* Scroll the display. Do it before the current matrix is
14710 changed. The problem here is that update has not yet
14711 run, i.e. part of the current matrix is not up to date.
14712 scroll_run_hook will clear the cursor, and use the
14713 current matrix to get the height of the row the cursor is
14715 run
.current_y
= start_row
->y
;
14716 run
.desired_y
= it
.current_y
;
14717 run
.height
= it
.last_visible_y
- it
.current_y
;
14719 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14722 FRAME_RIF (f
)->update_window_begin_hook (w
);
14723 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14724 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14725 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14729 /* Shift current matrix down by nrows_scrolled lines. */
14730 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14731 rotate_matrix (w
->current_matrix
,
14733 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14736 /* Disable lines that must be updated. */
14737 for (i
= 0; i
< nrows_scrolled
; ++i
)
14738 (start_row
+ i
)->enabled_p
= 0;
14740 /* Re-compute Y positions. */
14741 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14742 max_y
= it
.last_visible_y
;
14743 for (row
= start_row
+ nrows_scrolled
;
14747 row
->y
= it
.current_y
;
14748 row
->visible_height
= row
->height
;
14750 if (row
->y
< min_y
)
14751 row
->visible_height
-= min_y
- row
->y
;
14752 if (row
->y
+ row
->height
> max_y
)
14753 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14754 row
->redraw_fringe_bitmaps_p
= 1;
14756 it
.current_y
+= row
->height
;
14758 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14759 last_reused_text_row
= row
;
14760 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14764 /* Disable lines in the current matrix which are now
14765 below the window. */
14766 for (++row
; row
< bottom_row
; ++row
)
14767 row
->enabled_p
= row
->mode_line_p
= 0;
14770 /* Update window_end_pos etc.; last_reused_text_row is the last
14771 reused row from the current matrix containing text, if any.
14772 The value of last_text_row is the last displayed line
14773 containing text. */
14774 if (last_reused_text_row
)
14776 w
->window_end_bytepos
14777 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14779 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14781 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14782 w
->current_matrix
));
14784 else if (last_text_row
)
14786 w
->window_end_bytepos
14787 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14789 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14791 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14795 /* This window must be completely empty. */
14796 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14797 w
->window_end_pos
= make_number (Z
- ZV
);
14798 w
->window_end_vpos
= make_number (0);
14800 w
->window_end_valid
= Qnil
;
14802 /* Update hint: don't try scrolling again in update_window. */
14803 w
->desired_matrix
->no_scrolling_p
= 1;
14806 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14810 else if (CHARPOS (new_start
) > CHARPOS (start
))
14812 struct glyph_row
*pt_row
, *row
;
14813 struct glyph_row
*first_reusable_row
;
14814 struct glyph_row
*first_row_to_display
;
14816 int yb
= window_text_bottom_y (w
);
14818 /* Find the row starting at new_start, if there is one. Don't
14819 reuse a partially visible line at the end. */
14820 first_reusable_row
= start_row
;
14821 while (first_reusable_row
->enabled_p
14822 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14823 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14824 < CHARPOS (new_start
)))
14825 ++first_reusable_row
;
14827 /* Give up if there is no row to reuse. */
14828 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14829 || !first_reusable_row
->enabled_p
14830 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14831 != CHARPOS (new_start
)))
14834 /* We can reuse fully visible rows beginning with
14835 first_reusable_row to the end of the window. Set
14836 first_row_to_display to the first row that cannot be reused.
14837 Set pt_row to the row containing point, if there is any. */
14839 for (first_row_to_display
= first_reusable_row
;
14840 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14841 ++first_row_to_display
)
14843 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14844 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14845 pt_row
= first_row_to_display
;
14848 /* Start displaying at the start of first_row_to_display. */
14849 xassert (first_row_to_display
->y
< yb
);
14850 init_to_row_start (&it
, w
, first_row_to_display
);
14852 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14854 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14856 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14857 + WINDOW_HEADER_LINE_HEIGHT (w
));
14859 /* Display lines beginning with first_row_to_display in the
14860 desired matrix. Set last_text_row to the last row displayed
14861 that displays text. */
14862 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14863 if (pt_row
== NULL
)
14864 w
->cursor
.vpos
= -1;
14865 last_text_row
= NULL
;
14866 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14867 if (display_line (&it
))
14868 last_text_row
= it
.glyph_row
- 1;
14870 /* If point is in a reused row, adjust y and vpos of the cursor
14874 w
->cursor
.vpos
-= nrows_scrolled
;
14875 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14878 /* Give up if point isn't in a row displayed or reused. (This
14879 also handles the case where w->cursor.vpos < nrows_scrolled
14880 after the calls to display_line, which can happen with scroll
14881 margins. See bug#1295.) */
14882 if (w
->cursor
.vpos
< 0)
14884 clear_glyph_matrix (w
->desired_matrix
);
14888 /* Scroll the display. */
14889 run
.current_y
= first_reusable_row
->y
;
14890 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14891 run
.height
= it
.last_visible_y
- run
.current_y
;
14892 dy
= run
.current_y
- run
.desired_y
;
14897 FRAME_RIF (f
)->update_window_begin_hook (w
);
14898 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14899 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14900 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14904 /* Adjust Y positions of reused rows. */
14905 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14906 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14907 max_y
= it
.last_visible_y
;
14908 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14911 row
->visible_height
= row
->height
;
14912 if (row
->y
< min_y
)
14913 row
->visible_height
-= min_y
- row
->y
;
14914 if (row
->y
+ row
->height
> max_y
)
14915 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14916 row
->redraw_fringe_bitmaps_p
= 1;
14919 /* Scroll the current matrix. */
14920 xassert (nrows_scrolled
> 0);
14921 rotate_matrix (w
->current_matrix
,
14923 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14926 /* Disable rows not reused. */
14927 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14928 row
->enabled_p
= 0;
14930 /* Point may have moved to a different line, so we cannot assume that
14931 the previous cursor position is valid; locate the correct row. */
14934 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14935 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14939 w
->cursor
.y
= row
->y
;
14941 if (row
< bottom_row
)
14943 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14944 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14946 /* Can't use this optimization with bidi-reordered glyph
14947 rows, unless cursor is already at point. */
14948 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14950 if (!(w
->cursor
.hpos
>= 0
14951 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
14952 && BUFFERP (glyph
->object
)
14953 && glyph
->charpos
== PT
))
14958 && (!BUFFERP (glyph
->object
)
14959 || glyph
->charpos
< PT
);
14963 w
->cursor
.x
+= glyph
->pixel_width
;
14968 /* Adjust window end. A null value of last_text_row means that
14969 the window end is in reused rows which in turn means that
14970 only its vpos can have changed. */
14973 w
->window_end_bytepos
14974 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14976 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14978 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14983 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14986 w
->window_end_valid
= Qnil
;
14987 w
->desired_matrix
->no_scrolling_p
= 1;
14990 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15000 /************************************************************************
15001 Window redisplay reusing current matrix when buffer has changed
15002 ************************************************************************/
15004 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15005 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15006 EMACS_INT
*, EMACS_INT
*);
15007 static struct glyph_row
*
15008 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15009 struct glyph_row
*);
15012 /* Return the last row in MATRIX displaying text. If row START is
15013 non-null, start searching with that row. IT gives the dimensions
15014 of the display. Value is null if matrix is empty; otherwise it is
15015 a pointer to the row found. */
15017 static struct glyph_row
*
15018 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15019 struct glyph_row
*start
)
15021 struct glyph_row
*row
, *row_found
;
15023 /* Set row_found to the last row in IT->w's current matrix
15024 displaying text. The loop looks funny but think of partially
15027 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15028 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15030 xassert (row
->enabled_p
);
15032 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15041 /* Return the last row in the current matrix of W that is not affected
15042 by changes at the start of current_buffer that occurred since W's
15043 current matrix was built. Value is null if no such row exists.
15045 BEG_UNCHANGED us the number of characters unchanged at the start of
15046 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15047 first changed character in current_buffer. Characters at positions <
15048 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15049 when the current matrix was built. */
15051 static struct glyph_row
*
15052 find_last_unchanged_at_beg_row (struct window
*w
)
15054 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15055 struct glyph_row
*row
;
15056 struct glyph_row
*row_found
= NULL
;
15057 int yb
= window_text_bottom_y (w
);
15059 /* Find the last row displaying unchanged text. */
15060 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15061 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15062 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15065 if (/* If row ends before first_changed_pos, it is unchanged,
15066 except in some case. */
15067 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15068 /* When row ends in ZV and we write at ZV it is not
15070 && !row
->ends_at_zv_p
15071 /* When first_changed_pos is the end of a continued line,
15072 row is not unchanged because it may be no longer
15074 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15075 && (row
->continued_p
15076 || row
->exact_window_width_line_p
)))
15079 /* Stop if last visible row. */
15080 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15088 /* Find the first glyph row in the current matrix of W that is not
15089 affected by changes at the end of current_buffer since the
15090 time W's current matrix was built.
15092 Return in *DELTA the number of chars by which buffer positions in
15093 unchanged text at the end of current_buffer must be adjusted.
15095 Return in *DELTA_BYTES the corresponding number of bytes.
15097 Value is null if no such row exists, i.e. all rows are affected by
15100 static struct glyph_row
*
15101 find_first_unchanged_at_end_row (struct window
*w
,
15102 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15104 struct glyph_row
*row
;
15105 struct glyph_row
*row_found
= NULL
;
15107 *delta
= *delta_bytes
= 0;
15109 /* Display must not have been paused, otherwise the current matrix
15110 is not up to date. */
15111 eassert (!NILP (w
->window_end_valid
));
15113 /* A value of window_end_pos >= END_UNCHANGED means that the window
15114 end is in the range of changed text. If so, there is no
15115 unchanged row at the end of W's current matrix. */
15116 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15119 /* Set row to the last row in W's current matrix displaying text. */
15120 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15122 /* If matrix is entirely empty, no unchanged row exists. */
15123 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15125 /* The value of row is the last glyph row in the matrix having a
15126 meaningful buffer position in it. The end position of row
15127 corresponds to window_end_pos. This allows us to translate
15128 buffer positions in the current matrix to current buffer
15129 positions for characters not in changed text. */
15131 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15132 EMACS_INT Z_BYTE_old
=
15133 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15134 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15135 struct glyph_row
*first_text_row
15136 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15138 *delta
= Z
- Z_old
;
15139 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15141 /* Set last_unchanged_pos to the buffer position of the last
15142 character in the buffer that has not been changed. Z is the
15143 index + 1 of the last character in current_buffer, i.e. by
15144 subtracting END_UNCHANGED we get the index of the last
15145 unchanged character, and we have to add BEG to get its buffer
15147 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15148 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15150 /* Search backward from ROW for a row displaying a line that
15151 starts at a minimum position >= last_unchanged_pos_old. */
15152 for (; row
> first_text_row
; --row
)
15154 /* This used to abort, but it can happen.
15155 It is ok to just stop the search instead here. KFS. */
15156 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15159 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15164 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15170 /* Make sure that glyph rows in the current matrix of window W
15171 reference the same glyph memory as corresponding rows in the
15172 frame's frame matrix. This function is called after scrolling W's
15173 current matrix on a terminal frame in try_window_id and
15174 try_window_reusing_current_matrix. */
15177 sync_frame_with_window_matrix_rows (struct window
*w
)
15179 struct frame
*f
= XFRAME (w
->frame
);
15180 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15182 /* Preconditions: W must be a leaf window and full-width. Its frame
15183 must have a frame matrix. */
15184 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15185 xassert (WINDOW_FULL_WIDTH_P (w
));
15186 xassert (!FRAME_WINDOW_P (f
));
15188 /* If W is a full-width window, glyph pointers in W's current matrix
15189 have, by definition, to be the same as glyph pointers in the
15190 corresponding frame matrix. Note that frame matrices have no
15191 marginal areas (see build_frame_matrix). */
15192 window_row
= w
->current_matrix
->rows
;
15193 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15194 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15195 while (window_row
< window_row_end
)
15197 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15198 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15200 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15201 frame_row
->glyphs
[TEXT_AREA
] = start
;
15202 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15203 frame_row
->glyphs
[LAST_AREA
] = end
;
15205 /* Disable frame rows whose corresponding window rows have
15206 been disabled in try_window_id. */
15207 if (!window_row
->enabled_p
)
15208 frame_row
->enabled_p
= 0;
15210 ++window_row
, ++frame_row
;
15215 /* Find the glyph row in window W containing CHARPOS. Consider all
15216 rows between START and END (not inclusive). END null means search
15217 all rows to the end of the display area of W. Value is the row
15218 containing CHARPOS or null. */
15221 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15222 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15224 struct glyph_row
*row
= start
;
15225 struct glyph_row
*best_row
= NULL
;
15226 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15229 /* If we happen to start on a header-line, skip that. */
15230 if (row
->mode_line_p
)
15233 if ((end
&& row
>= end
) || !row
->enabled_p
)
15236 last_y
= window_text_bottom_y (w
) - dy
;
15240 /* Give up if we have gone too far. */
15241 if (end
&& row
>= end
)
15243 /* This formerly returned if they were equal.
15244 I think that both quantities are of a "last plus one" type;
15245 if so, when they are equal, the row is within the screen. -- rms. */
15246 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15249 /* If it is in this row, return this row. */
15250 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15251 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15252 /* The end position of a row equals the start
15253 position of the next row. If CHARPOS is there, we
15254 would rather display it in the next line, except
15255 when this line ends in ZV. */
15256 && !row
->ends_at_zv_p
15257 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15258 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15262 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15263 || (!best_row
&& !row
->continued_p
))
15265 /* In bidi-reordered rows, there could be several rows
15266 occluding point, all of them belonging to the same
15267 continued line. We need to find the row which fits
15268 CHARPOS the best. */
15269 for (g
= row
->glyphs
[TEXT_AREA
];
15270 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15273 if (!STRINGP (g
->object
))
15275 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15277 mindif
= eabs (g
->charpos
- charpos
);
15279 /* Exact match always wins. */
15286 else if (best_row
&& !row
->continued_p
)
15293 /* Try to redisplay window W by reusing its existing display. W's
15294 current matrix must be up to date when this function is called,
15295 i.e. window_end_valid must not be nil.
15299 1 if display has been updated
15300 0 if otherwise unsuccessful
15301 -1 if redisplay with same window start is known not to succeed
15303 The following steps are performed:
15305 1. Find the last row in the current matrix of W that is not
15306 affected by changes at the start of current_buffer. If no such row
15309 2. Find the first row in W's current matrix that is not affected by
15310 changes at the end of current_buffer. Maybe there is no such row.
15312 3. Display lines beginning with the row + 1 found in step 1 to the
15313 row found in step 2 or, if step 2 didn't find a row, to the end of
15316 4. If cursor is not known to appear on the window, give up.
15318 5. If display stopped at the row found in step 2, scroll the
15319 display and current matrix as needed.
15321 6. Maybe display some lines at the end of W, if we must. This can
15322 happen under various circumstances, like a partially visible line
15323 becoming fully visible, or because newly displayed lines are displayed
15324 in smaller font sizes.
15326 7. Update W's window end information. */
15329 try_window_id (struct window
*w
)
15331 struct frame
*f
= XFRAME (w
->frame
);
15332 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15333 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15334 struct glyph_row
*last_unchanged_at_beg_row
;
15335 struct glyph_row
*first_unchanged_at_end_row
;
15336 struct glyph_row
*row
;
15337 struct glyph_row
*bottom_row
;
15340 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15342 struct text_pos start_pos
;
15344 int first_unchanged_at_end_vpos
= 0;
15345 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15346 struct text_pos start
;
15347 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15350 if (inhibit_try_window_id
)
15354 /* This is handy for debugging. */
15356 #define GIVE_UP(X) \
15358 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15362 #define GIVE_UP(X) return 0
15365 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15367 /* Don't use this for mini-windows because these can show
15368 messages and mini-buffers, and we don't handle that here. */
15369 if (MINI_WINDOW_P (w
))
15372 /* This flag is used to prevent redisplay optimizations. */
15373 if (windows_or_buffers_changed
|| cursor_type_changed
)
15376 /* Verify that narrowing has not changed.
15377 Also verify that we were not told to prevent redisplay optimizations.
15378 It would be nice to further
15379 reduce the number of cases where this prevents try_window_id. */
15380 if (current_buffer
->clip_changed
15381 || current_buffer
->prevent_redisplay_optimizations_p
)
15384 /* Window must either use window-based redisplay or be full width. */
15385 if (!FRAME_WINDOW_P (f
)
15386 && (!FRAME_LINE_INS_DEL_OK (f
)
15387 || !WINDOW_FULL_WIDTH_P (w
)))
15390 /* Give up if point is known NOT to appear in W. */
15391 if (PT
< CHARPOS (start
))
15394 /* Another way to prevent redisplay optimizations. */
15395 if (XFASTINT (w
->last_modified
) == 0)
15398 /* Verify that window is not hscrolled. */
15399 if (XFASTINT (w
->hscroll
) != 0)
15402 /* Verify that display wasn't paused. */
15403 if (NILP (w
->window_end_valid
))
15406 /* Can't use this if highlighting a region because a cursor movement
15407 will do more than just set the cursor. */
15408 if (!NILP (Vtransient_mark_mode
)
15409 && !NILP (BVAR (current_buffer
, mark_active
)))
15412 /* Likewise if highlighting trailing whitespace. */
15413 if (!NILP (Vshow_trailing_whitespace
))
15416 /* Likewise if showing a region. */
15417 if (!NILP (w
->region_showing
))
15420 /* Can't use this if overlay arrow position and/or string have
15422 if (overlay_arrows_changed_p ())
15425 /* When word-wrap is on, adding a space to the first word of a
15426 wrapped line can change the wrap position, altering the line
15427 above it. It might be worthwhile to handle this more
15428 intelligently, but for now just redisplay from scratch. */
15429 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15432 /* Under bidi reordering, adding or deleting a character in the
15433 beginning of a paragraph, before the first strong directional
15434 character, can change the base direction of the paragraph (unless
15435 the buffer specifies a fixed paragraph direction), which will
15436 require to redisplay the whole paragraph. It might be worthwhile
15437 to find the paragraph limits and widen the range of redisplayed
15438 lines to that, but for now just give up this optimization and
15439 redisplay from scratch. */
15440 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15441 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15444 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15445 only if buffer has really changed. The reason is that the gap is
15446 initially at Z for freshly visited files. The code below would
15447 set end_unchanged to 0 in that case. */
15448 if (MODIFF
> SAVE_MODIFF
15449 /* This seems to happen sometimes after saving a buffer. */
15450 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15452 if (GPT
- BEG
< BEG_UNCHANGED
)
15453 BEG_UNCHANGED
= GPT
- BEG
;
15454 if (Z
- GPT
< END_UNCHANGED
)
15455 END_UNCHANGED
= Z
- GPT
;
15458 /* The position of the first and last character that has been changed. */
15459 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15460 last_changed_charpos
= Z
- END_UNCHANGED
;
15462 /* If window starts after a line end, and the last change is in
15463 front of that newline, then changes don't affect the display.
15464 This case happens with stealth-fontification. Note that although
15465 the display is unchanged, glyph positions in the matrix have to
15466 be adjusted, of course. */
15467 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15468 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15469 && ((last_changed_charpos
< CHARPOS (start
)
15470 && CHARPOS (start
) == BEGV
)
15471 || (last_changed_charpos
< CHARPOS (start
) - 1
15472 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15474 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15475 struct glyph_row
*r0
;
15477 /* Compute how many chars/bytes have been added to or removed
15478 from the buffer. */
15479 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15480 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15481 Z_delta
= Z
- Z_old
;
15482 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15484 /* Give up if PT is not in the window. Note that it already has
15485 been checked at the start of try_window_id that PT is not in
15486 front of the window start. */
15487 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15490 /* If window start is unchanged, we can reuse the whole matrix
15491 as is, after adjusting glyph positions. No need to compute
15492 the window end again, since its offset from Z hasn't changed. */
15493 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15494 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15495 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15496 /* PT must not be in a partially visible line. */
15497 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15498 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15500 /* Adjust positions in the glyph matrix. */
15501 if (Z_delta
|| Z_delta_bytes
)
15503 struct glyph_row
*r1
15504 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15505 increment_matrix_positions (w
->current_matrix
,
15506 MATRIX_ROW_VPOS (r0
, current_matrix
),
15507 MATRIX_ROW_VPOS (r1
, current_matrix
),
15508 Z_delta
, Z_delta_bytes
);
15511 /* Set the cursor. */
15512 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15514 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15521 /* Handle the case that changes are all below what is displayed in
15522 the window, and that PT is in the window. This shortcut cannot
15523 be taken if ZV is visible in the window, and text has been added
15524 there that is visible in the window. */
15525 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15526 /* ZV is not visible in the window, or there are no
15527 changes at ZV, actually. */
15528 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15529 || first_changed_charpos
== last_changed_charpos
))
15531 struct glyph_row
*r0
;
15533 /* Give up if PT is not in the window. Note that it already has
15534 been checked at the start of try_window_id that PT is not in
15535 front of the window start. */
15536 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15539 /* If window start is unchanged, we can reuse the whole matrix
15540 as is, without changing glyph positions since no text has
15541 been added/removed in front of the window end. */
15542 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15543 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15544 /* PT must not be in a partially visible line. */
15545 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15546 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15548 /* We have to compute the window end anew since text
15549 could have been added/removed after it. */
15551 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15552 w
->window_end_bytepos
15553 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15555 /* Set the cursor. */
15556 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15558 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15565 /* Give up if window start is in the changed area.
15567 The condition used to read
15569 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15571 but why that was tested escapes me at the moment. */
15572 if (CHARPOS (start
) >= first_changed_charpos
15573 && CHARPOS (start
) <= last_changed_charpos
)
15576 /* Check that window start agrees with the start of the first glyph
15577 row in its current matrix. Check this after we know the window
15578 start is not in changed text, otherwise positions would not be
15580 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15581 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15584 /* Give up if the window ends in strings. Overlay strings
15585 at the end are difficult to handle, so don't try. */
15586 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15587 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15590 /* Compute the position at which we have to start displaying new
15591 lines. Some of the lines at the top of the window might be
15592 reusable because they are not displaying changed text. Find the
15593 last row in W's current matrix not affected by changes at the
15594 start of current_buffer. Value is null if changes start in the
15595 first line of window. */
15596 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15597 if (last_unchanged_at_beg_row
)
15599 /* Avoid starting to display in the moddle of a character, a TAB
15600 for instance. This is easier than to set up the iterator
15601 exactly, and it's not a frequent case, so the additional
15602 effort wouldn't really pay off. */
15603 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15604 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15605 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15606 --last_unchanged_at_beg_row
;
15608 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15611 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15613 start_pos
= it
.current
.pos
;
15615 /* Start displaying new lines in the desired matrix at the same
15616 vpos we would use in the current matrix, i.e. below
15617 last_unchanged_at_beg_row. */
15618 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15620 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15621 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15623 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15627 /* There are no reusable lines at the start of the window.
15628 Start displaying in the first text line. */
15629 start_display (&it
, w
, start
);
15630 it
.vpos
= it
.first_vpos
;
15631 start_pos
= it
.current
.pos
;
15634 /* Find the first row that is not affected by changes at the end of
15635 the buffer. Value will be null if there is no unchanged row, in
15636 which case we must redisplay to the end of the window. delta
15637 will be set to the value by which buffer positions beginning with
15638 first_unchanged_at_end_row have to be adjusted due to text
15640 first_unchanged_at_end_row
15641 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15642 IF_DEBUG (debug_delta
= delta
);
15643 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15645 /* Set stop_pos to the buffer position up to which we will have to
15646 display new lines. If first_unchanged_at_end_row != NULL, this
15647 is the buffer position of the start of the line displayed in that
15648 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15649 that we don't stop at a buffer position. */
15651 if (first_unchanged_at_end_row
)
15653 xassert (last_unchanged_at_beg_row
== NULL
15654 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15656 /* If this is a continuation line, move forward to the next one
15657 that isn't. Changes in lines above affect this line.
15658 Caution: this may move first_unchanged_at_end_row to a row
15659 not displaying text. */
15660 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15661 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15662 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15663 < it
.last_visible_y
))
15664 ++first_unchanged_at_end_row
;
15666 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15667 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15668 >= it
.last_visible_y
))
15669 first_unchanged_at_end_row
= NULL
;
15672 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15674 first_unchanged_at_end_vpos
15675 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15676 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15679 else if (last_unchanged_at_beg_row
== NULL
)
15685 /* Either there is no unchanged row at the end, or the one we have
15686 now displays text. This is a necessary condition for the window
15687 end pos calculation at the end of this function. */
15688 xassert (first_unchanged_at_end_row
== NULL
15689 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15691 debug_last_unchanged_at_beg_vpos
15692 = (last_unchanged_at_beg_row
15693 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15695 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15697 #endif /* GLYPH_DEBUG != 0 */
15700 /* Display new lines. Set last_text_row to the last new line
15701 displayed which has text on it, i.e. might end up as being the
15702 line where the window_end_vpos is. */
15703 w
->cursor
.vpos
= -1;
15704 last_text_row
= NULL
;
15705 overlay_arrow_seen
= 0;
15706 while (it
.current_y
< it
.last_visible_y
15707 && !fonts_changed_p
15708 && (first_unchanged_at_end_row
== NULL
15709 || IT_CHARPOS (it
) < stop_pos
))
15711 if (display_line (&it
))
15712 last_text_row
= it
.glyph_row
- 1;
15715 if (fonts_changed_p
)
15719 /* Compute differences in buffer positions, y-positions etc. for
15720 lines reused at the bottom of the window. Compute what we can
15722 if (first_unchanged_at_end_row
15723 /* No lines reused because we displayed everything up to the
15724 bottom of the window. */
15725 && it
.current_y
< it
.last_visible_y
)
15728 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15730 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15731 run
.current_y
= first_unchanged_at_end_row
->y
;
15732 run
.desired_y
= run
.current_y
+ dy
;
15733 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15737 delta
= delta_bytes
= dvpos
= dy
15738 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15739 first_unchanged_at_end_row
= NULL
;
15741 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15744 /* Find the cursor if not already found. We have to decide whether
15745 PT will appear on this window (it sometimes doesn't, but this is
15746 not a very frequent case.) This decision has to be made before
15747 the current matrix is altered. A value of cursor.vpos < 0 means
15748 that PT is either in one of the lines beginning at
15749 first_unchanged_at_end_row or below the window. Don't care for
15750 lines that might be displayed later at the window end; as
15751 mentioned, this is not a frequent case. */
15752 if (w
->cursor
.vpos
< 0)
15754 /* Cursor in unchanged rows at the top? */
15755 if (PT
< CHARPOS (start_pos
)
15756 && last_unchanged_at_beg_row
)
15758 row
= row_containing_pos (w
, PT
,
15759 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15760 last_unchanged_at_beg_row
+ 1, 0);
15762 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15765 /* Start from first_unchanged_at_end_row looking for PT. */
15766 else if (first_unchanged_at_end_row
)
15768 row
= row_containing_pos (w
, PT
- delta
,
15769 first_unchanged_at_end_row
, NULL
, 0);
15771 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15772 delta_bytes
, dy
, dvpos
);
15775 /* Give up if cursor was not found. */
15776 if (w
->cursor
.vpos
< 0)
15778 clear_glyph_matrix (w
->desired_matrix
);
15783 /* Don't let the cursor end in the scroll margins. */
15785 int this_scroll_margin
, cursor_height
;
15787 this_scroll_margin
= max (0, scroll_margin
);
15788 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15789 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15790 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15792 if ((w
->cursor
.y
< this_scroll_margin
15793 && CHARPOS (start
) > BEGV
)
15794 /* Old redisplay didn't take scroll margin into account at the bottom,
15795 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15796 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15797 ? cursor_height
+ this_scroll_margin
15798 : 1)) > it
.last_visible_y
)
15800 w
->cursor
.vpos
= -1;
15801 clear_glyph_matrix (w
->desired_matrix
);
15806 /* Scroll the display. Do it before changing the current matrix so
15807 that xterm.c doesn't get confused about where the cursor glyph is
15809 if (dy
&& run
.height
)
15813 if (FRAME_WINDOW_P (f
))
15815 FRAME_RIF (f
)->update_window_begin_hook (w
);
15816 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15817 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15818 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15822 /* Terminal frame. In this case, dvpos gives the number of
15823 lines to scroll by; dvpos < 0 means scroll up. */
15825 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15826 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15827 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15828 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15829 + window_internal_height (w
));
15831 #if defined (HAVE_GPM) || defined (MSDOS)
15832 x_clear_window_mouse_face (w
);
15834 /* Perform the operation on the screen. */
15837 /* Scroll last_unchanged_at_beg_row to the end of the
15838 window down dvpos lines. */
15839 set_terminal_window (f
, end
);
15841 /* On dumb terminals delete dvpos lines at the end
15842 before inserting dvpos empty lines. */
15843 if (!FRAME_SCROLL_REGION_OK (f
))
15844 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15846 /* Insert dvpos empty lines in front of
15847 last_unchanged_at_beg_row. */
15848 ins_del_lines (f
, from
, dvpos
);
15850 else if (dvpos
< 0)
15852 /* Scroll up last_unchanged_at_beg_vpos to the end of
15853 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15854 set_terminal_window (f
, end
);
15856 /* Delete dvpos lines in front of
15857 last_unchanged_at_beg_vpos. ins_del_lines will set
15858 the cursor to the given vpos and emit |dvpos| delete
15860 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15862 /* On a dumb terminal insert dvpos empty lines at the
15864 if (!FRAME_SCROLL_REGION_OK (f
))
15865 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15868 set_terminal_window (f
, 0);
15874 /* Shift reused rows of the current matrix to the right position.
15875 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15877 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15878 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15881 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15882 bottom_vpos
, dvpos
);
15883 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15886 else if (dvpos
> 0)
15888 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15889 bottom_vpos
, dvpos
);
15890 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15891 first_unchanged_at_end_vpos
+ dvpos
, 0);
15894 /* For frame-based redisplay, make sure that current frame and window
15895 matrix are in sync with respect to glyph memory. */
15896 if (!FRAME_WINDOW_P (f
))
15897 sync_frame_with_window_matrix_rows (w
);
15899 /* Adjust buffer positions in reused rows. */
15900 if (delta
|| delta_bytes
)
15901 increment_matrix_positions (current_matrix
,
15902 first_unchanged_at_end_vpos
+ dvpos
,
15903 bottom_vpos
, delta
, delta_bytes
);
15905 /* Adjust Y positions. */
15907 shift_glyph_matrix (w
, current_matrix
,
15908 first_unchanged_at_end_vpos
+ dvpos
,
15911 if (first_unchanged_at_end_row
)
15913 first_unchanged_at_end_row
+= dvpos
;
15914 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15915 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15916 first_unchanged_at_end_row
= NULL
;
15919 /* If scrolling up, there may be some lines to display at the end of
15921 last_text_row_at_end
= NULL
;
15924 /* Scrolling up can leave for example a partially visible line
15925 at the end of the window to be redisplayed. */
15926 /* Set last_row to the glyph row in the current matrix where the
15927 window end line is found. It has been moved up or down in
15928 the matrix by dvpos. */
15929 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15930 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15932 /* If last_row is the window end line, it should display text. */
15933 xassert (last_row
->displays_text_p
);
15935 /* If window end line was partially visible before, begin
15936 displaying at that line. Otherwise begin displaying with the
15937 line following it. */
15938 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15940 init_to_row_start (&it
, w
, last_row
);
15941 it
.vpos
= last_vpos
;
15942 it
.current_y
= last_row
->y
;
15946 init_to_row_end (&it
, w
, last_row
);
15947 it
.vpos
= 1 + last_vpos
;
15948 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15952 /* We may start in a continuation line. If so, we have to
15953 get the right continuation_lines_width and current_x. */
15954 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15955 it
.hpos
= it
.current_x
= 0;
15957 /* Display the rest of the lines at the window end. */
15958 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15959 while (it
.current_y
< it
.last_visible_y
15960 && !fonts_changed_p
)
15962 /* Is it always sure that the display agrees with lines in
15963 the current matrix? I don't think so, so we mark rows
15964 displayed invalid in the current matrix by setting their
15965 enabled_p flag to zero. */
15966 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15967 if (display_line (&it
))
15968 last_text_row_at_end
= it
.glyph_row
- 1;
15972 /* Update window_end_pos and window_end_vpos. */
15973 if (first_unchanged_at_end_row
15974 && !last_text_row_at_end
)
15976 /* Window end line if one of the preserved rows from the current
15977 matrix. Set row to the last row displaying text in current
15978 matrix starting at first_unchanged_at_end_row, after
15980 xassert (first_unchanged_at_end_row
->displays_text_p
);
15981 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15982 first_unchanged_at_end_row
);
15983 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15985 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15986 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15988 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15989 xassert (w
->window_end_bytepos
>= 0);
15990 IF_DEBUG (debug_method_add (w
, "A"));
15992 else if (last_text_row_at_end
)
15995 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15996 w
->window_end_bytepos
15997 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15999 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16000 xassert (w
->window_end_bytepos
>= 0);
16001 IF_DEBUG (debug_method_add (w
, "B"));
16003 else if (last_text_row
)
16005 /* We have displayed either to the end of the window or at the
16006 end of the window, i.e. the last row with text is to be found
16007 in the desired matrix. */
16009 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16010 w
->window_end_bytepos
16011 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16013 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16014 xassert (w
->window_end_bytepos
>= 0);
16016 else if (first_unchanged_at_end_row
== NULL
16017 && last_text_row
== NULL
16018 && last_text_row_at_end
== NULL
)
16020 /* Displayed to end of window, but no line containing text was
16021 displayed. Lines were deleted at the end of the window. */
16022 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16023 int vpos
= XFASTINT (w
->window_end_vpos
);
16024 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16025 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16028 row
== NULL
&& vpos
>= first_vpos
;
16029 --vpos
, --current_row
, --desired_row
)
16031 if (desired_row
->enabled_p
)
16033 if (desired_row
->displays_text_p
)
16036 else if (current_row
->displays_text_p
)
16040 xassert (row
!= NULL
);
16041 w
->window_end_vpos
= make_number (vpos
+ 1);
16042 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16043 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16044 xassert (w
->window_end_bytepos
>= 0);
16045 IF_DEBUG (debug_method_add (w
, "C"));
16050 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16051 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16053 /* Record that display has not been completed. */
16054 w
->window_end_valid
= Qnil
;
16055 w
->desired_matrix
->no_scrolling_p
= 1;
16063 /***********************************************************************
16064 More debugging support
16065 ***********************************************************************/
16069 void dump_glyph_row (struct glyph_row
*, int, int);
16070 void dump_glyph_matrix (struct glyph_matrix
*, int);
16071 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16074 /* Dump the contents of glyph matrix MATRIX on stderr.
16076 GLYPHS 0 means don't show glyph contents.
16077 GLYPHS 1 means show glyphs in short form
16078 GLYPHS > 1 means show glyphs in long form. */
16081 dump_glyph_matrix (matrix
, glyphs
)
16082 struct glyph_matrix
*matrix
;
16086 for (i
= 0; i
< matrix
->nrows
; ++i
)
16087 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16091 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16092 the glyph row and area where the glyph comes from. */
16095 dump_glyph (row
, glyph
, area
)
16096 struct glyph_row
*row
;
16097 struct glyph
*glyph
;
16100 if (glyph
->type
== CHAR_GLYPH
)
16103 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16104 glyph
- row
->glyphs
[TEXT_AREA
],
16107 (BUFFERP (glyph
->object
)
16109 : (STRINGP (glyph
->object
)
16112 glyph
->pixel_width
,
16114 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16118 glyph
->left_box_line_p
,
16119 glyph
->right_box_line_p
);
16121 else if (glyph
->type
== STRETCH_GLYPH
)
16124 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16125 glyph
- row
->glyphs
[TEXT_AREA
],
16128 (BUFFERP (glyph
->object
)
16130 : (STRINGP (glyph
->object
)
16133 glyph
->pixel_width
,
16137 glyph
->left_box_line_p
,
16138 glyph
->right_box_line_p
);
16140 else if (glyph
->type
== IMAGE_GLYPH
)
16143 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16144 glyph
- row
->glyphs
[TEXT_AREA
],
16147 (BUFFERP (glyph
->object
)
16149 : (STRINGP (glyph
->object
)
16152 glyph
->pixel_width
,
16156 glyph
->left_box_line_p
,
16157 glyph
->right_box_line_p
);
16159 else if (glyph
->type
== COMPOSITE_GLYPH
)
16162 " %5d %4c %6d %c %3d 0x%05x",
16163 glyph
- row
->glyphs
[TEXT_AREA
],
16166 (BUFFERP (glyph
->object
)
16168 : (STRINGP (glyph
->object
)
16171 glyph
->pixel_width
,
16173 if (glyph
->u
.cmp
.automatic
)
16176 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16177 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16179 glyph
->left_box_line_p
,
16180 glyph
->right_box_line_p
);
16185 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16186 GLYPHS 0 means don't show glyph contents.
16187 GLYPHS 1 means show glyphs in short form
16188 GLYPHS > 1 means show glyphs in long form. */
16191 dump_glyph_row (row
, vpos
, glyphs
)
16192 struct glyph_row
*row
;
16197 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16198 fprintf (stderr
, "======================================================================\n");
16200 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16201 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16203 MATRIX_ROW_START_CHARPOS (row
),
16204 MATRIX_ROW_END_CHARPOS (row
),
16205 row
->used
[TEXT_AREA
],
16206 row
->contains_overlapping_glyphs_p
,
16208 row
->truncated_on_left_p
,
16209 row
->truncated_on_right_p
,
16211 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16212 row
->displays_text_p
,
16215 row
->ends_in_middle_of_char_p
,
16216 row
->starts_in_middle_of_char_p
,
16222 row
->visible_height
,
16225 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16226 row
->end
.overlay_string_index
,
16227 row
->continuation_lines_width
);
16228 fprintf (stderr
, "%9d %5d\n",
16229 CHARPOS (row
->start
.string_pos
),
16230 CHARPOS (row
->end
.string_pos
));
16231 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16232 row
->end
.dpvec_index
);
16239 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16241 struct glyph
*glyph
= row
->glyphs
[area
];
16242 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16244 /* Glyph for a line end in text. */
16245 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16248 if (glyph
< glyph_end
)
16249 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16251 for (; glyph
< glyph_end
; ++glyph
)
16252 dump_glyph (row
, glyph
, area
);
16255 else if (glyphs
== 1)
16259 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16261 char *s
= (char *) alloca (row
->used
[area
] + 1);
16264 for (i
= 0; i
< row
->used
[area
]; ++i
)
16266 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16267 if (glyph
->type
== CHAR_GLYPH
16268 && glyph
->u
.ch
< 0x80
16269 && glyph
->u
.ch
>= ' ')
16270 s
[i
] = glyph
->u
.ch
;
16276 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16282 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16283 Sdump_glyph_matrix
, 0, 1, "p",
16284 doc
: /* Dump the current matrix of the selected window to stderr.
16285 Shows contents of glyph row structures. With non-nil
16286 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16287 glyphs in short form, otherwise show glyphs in long form. */)
16288 (Lisp_Object glyphs
)
16290 struct window
*w
= XWINDOW (selected_window
);
16291 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16293 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16294 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16295 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16296 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16297 fprintf (stderr
, "=============================================\n");
16298 dump_glyph_matrix (w
->current_matrix
,
16299 NILP (glyphs
) ? 0 : XINT (glyphs
));
16304 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16305 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16308 struct frame
*f
= XFRAME (selected_frame
);
16309 dump_glyph_matrix (f
->current_matrix
, 1);
16314 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16315 doc
: /* Dump glyph row ROW to stderr.
16316 GLYPH 0 means don't dump glyphs.
16317 GLYPH 1 means dump glyphs in short form.
16318 GLYPH > 1 or omitted means dump glyphs in long form. */)
16319 (Lisp_Object row
, Lisp_Object glyphs
)
16321 struct glyph_matrix
*matrix
;
16324 CHECK_NUMBER (row
);
16325 matrix
= XWINDOW (selected_window
)->current_matrix
;
16327 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16328 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16330 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16335 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16336 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16337 GLYPH 0 means don't dump glyphs.
16338 GLYPH 1 means dump glyphs in short form.
16339 GLYPH > 1 or omitted means dump glyphs in long form. */)
16340 (Lisp_Object row
, Lisp_Object glyphs
)
16342 struct frame
*sf
= SELECTED_FRAME ();
16343 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16346 CHECK_NUMBER (row
);
16348 if (vpos
>= 0 && vpos
< m
->nrows
)
16349 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16350 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16355 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16356 doc
: /* Toggle tracing of redisplay.
16357 With ARG, turn tracing on if and only if ARG is positive. */)
16361 trace_redisplay_p
= !trace_redisplay_p
;
16364 arg
= Fprefix_numeric_value (arg
);
16365 trace_redisplay_p
= XINT (arg
) > 0;
16372 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16373 doc
: /* Like `format', but print result to stderr.
16374 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16375 (int nargs
, Lisp_Object
*args
)
16377 Lisp_Object s
= Fformat (nargs
, args
);
16378 fprintf (stderr
, "%s", SDATA (s
));
16382 #endif /* GLYPH_DEBUG */
16386 /***********************************************************************
16387 Building Desired Matrix Rows
16388 ***********************************************************************/
16390 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16391 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16393 static struct glyph_row
*
16394 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16396 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16397 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16398 struct buffer
*old
= current_buffer
;
16399 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16400 int arrow_len
= SCHARS (overlay_arrow_string
);
16401 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16402 const unsigned char *p
;
16405 int n_glyphs_before
;
16407 set_buffer_temp (buffer
);
16408 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16409 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16410 SET_TEXT_POS (it
.position
, 0, 0);
16412 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16414 while (p
< arrow_end
)
16416 Lisp_Object face
, ilisp
;
16418 /* Get the next character. */
16420 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16423 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16424 if (! ASCII_CHAR_P (it
.c
))
16425 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16429 /* Get its face. */
16430 ilisp
= make_number (p
- arrow_string
);
16431 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16432 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16434 /* Compute its width, get its glyphs. */
16435 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16436 SET_TEXT_POS (it
.position
, -1, -1);
16437 PRODUCE_GLYPHS (&it
);
16439 /* If this character doesn't fit any more in the line, we have
16440 to remove some glyphs. */
16441 if (it
.current_x
> it
.last_visible_x
)
16443 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16448 set_buffer_temp (old
);
16449 return it
.glyph_row
;
16453 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16454 glyphs are only inserted for terminal frames since we can't really
16455 win with truncation glyphs when partially visible glyphs are
16456 involved. Which glyphs to insert is determined by
16457 produce_special_glyphs. */
16460 insert_left_trunc_glyphs (struct it
*it
)
16462 struct it truncate_it
;
16463 struct glyph
*from
, *end
, *to
, *toend
;
16465 xassert (!FRAME_WINDOW_P (it
->f
));
16467 /* Get the truncation glyphs. */
16469 truncate_it
.current_x
= 0;
16470 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16471 truncate_it
.glyph_row
= &scratch_glyph_row
;
16472 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16473 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16474 truncate_it
.object
= make_number (0);
16475 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16477 /* Overwrite glyphs from IT with truncation glyphs. */
16478 if (!it
->glyph_row
->reversed_p
)
16480 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16481 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16482 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16483 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16488 /* There may be padding glyphs left over. Overwrite them too. */
16489 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16491 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16497 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16501 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16502 that back to front. */
16503 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16504 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16505 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16506 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16508 while (from
>= end
&& to
>= toend
)
16510 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16513 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16514 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16515 while (from
>= end
&& to
>= toend
)
16520 /* Need to free some room before prepending additional
16522 int move_by
= from
- end
+ 1;
16523 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16524 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16526 for ( ; g
>= g0
; g
--)
16528 while (from
>= end
)
16530 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16536 /* Compute the pixel height and width of IT->glyph_row.
16538 Most of the time, ascent and height of a display line will be equal
16539 to the max_ascent and max_height values of the display iterator
16540 structure. This is not the case if
16542 1. We hit ZV without displaying anything. In this case, max_ascent
16543 and max_height will be zero.
16545 2. We have some glyphs that don't contribute to the line height.
16546 (The glyph row flag contributes_to_line_height_p is for future
16547 pixmap extensions).
16549 The first case is easily covered by using default values because in
16550 these cases, the line height does not really matter, except that it
16551 must not be zero. */
16554 compute_line_metrics (struct it
*it
)
16556 struct glyph_row
*row
= it
->glyph_row
;
16558 if (FRAME_WINDOW_P (it
->f
))
16560 int i
, min_y
, max_y
;
16562 /* The line may consist of one space only, that was added to
16563 place the cursor on it. If so, the row's height hasn't been
16565 if (row
->height
== 0)
16567 if (it
->max_ascent
+ it
->max_descent
== 0)
16568 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16569 row
->ascent
= it
->max_ascent
;
16570 row
->height
= it
->max_ascent
+ it
->max_descent
;
16571 row
->phys_ascent
= it
->max_phys_ascent
;
16572 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16573 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16576 /* Compute the width of this line. */
16577 row
->pixel_width
= row
->x
;
16578 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16579 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16581 xassert (row
->pixel_width
>= 0);
16582 xassert (row
->ascent
>= 0 && row
->height
> 0);
16584 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16585 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16587 /* If first line's physical ascent is larger than its logical
16588 ascent, use the physical ascent, and make the row taller.
16589 This makes accented characters fully visible. */
16590 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16591 && row
->phys_ascent
> row
->ascent
)
16593 row
->height
+= row
->phys_ascent
- row
->ascent
;
16594 row
->ascent
= row
->phys_ascent
;
16597 /* Compute how much of the line is visible. */
16598 row
->visible_height
= row
->height
;
16600 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16601 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16603 if (row
->y
< min_y
)
16604 row
->visible_height
-= min_y
- row
->y
;
16605 if (row
->y
+ row
->height
> max_y
)
16606 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16610 row
->pixel_width
= row
->used
[TEXT_AREA
];
16611 if (row
->continued_p
)
16612 row
->pixel_width
-= it
->continuation_pixel_width
;
16613 else if (row
->truncated_on_right_p
)
16614 row
->pixel_width
-= it
->truncation_pixel_width
;
16615 row
->ascent
= row
->phys_ascent
= 0;
16616 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16617 row
->extra_line_spacing
= 0;
16620 /* Compute a hash code for this row. */
16624 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16625 for (i
= 0; i
< row
->used
[area
]; ++i
)
16626 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16627 + row
->glyphs
[area
][i
].u
.val
16628 + row
->glyphs
[area
][i
].face_id
16629 + row
->glyphs
[area
][i
].padding_p
16630 + (row
->glyphs
[area
][i
].type
<< 2));
16633 it
->max_ascent
= it
->max_descent
= 0;
16634 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16638 /* Append one space to the glyph row of iterator IT if doing a
16639 window-based redisplay. The space has the same face as
16640 IT->face_id. Value is non-zero if a space was added.
16642 This function is called to make sure that there is always one glyph
16643 at the end of a glyph row that the cursor can be set on under
16644 window-systems. (If there weren't such a glyph we would not know
16645 how wide and tall a box cursor should be displayed).
16647 At the same time this space let's a nicely handle clearing to the
16648 end of the line if the row ends in italic text. */
16651 append_space_for_newline (struct it
*it
, int default_face_p
)
16653 if (FRAME_WINDOW_P (it
->f
))
16655 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16657 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16658 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16660 /* Save some values that must not be changed.
16661 Must save IT->c and IT->len because otherwise
16662 ITERATOR_AT_END_P wouldn't work anymore after
16663 append_space_for_newline has been called. */
16664 enum display_element_type saved_what
= it
->what
;
16665 int saved_c
= it
->c
, saved_len
= it
->len
;
16666 int saved_char_to_display
= it
->char_to_display
;
16667 int saved_x
= it
->current_x
;
16668 int saved_face_id
= it
->face_id
;
16669 struct text_pos saved_pos
;
16670 Lisp_Object saved_object
;
16673 saved_object
= it
->object
;
16674 saved_pos
= it
->position
;
16676 it
->what
= IT_CHARACTER
;
16677 memset (&it
->position
, 0, sizeof it
->position
);
16678 it
->object
= make_number (0);
16679 it
->c
= it
->char_to_display
= ' ';
16682 if (default_face_p
)
16683 it
->face_id
= DEFAULT_FACE_ID
;
16684 else if (it
->face_before_selective_p
)
16685 it
->face_id
= it
->saved_face_id
;
16686 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16687 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16689 PRODUCE_GLYPHS (it
);
16691 it
->override_ascent
= -1;
16692 it
->constrain_row_ascent_descent_p
= 0;
16693 it
->current_x
= saved_x
;
16694 it
->object
= saved_object
;
16695 it
->position
= saved_pos
;
16696 it
->what
= saved_what
;
16697 it
->face_id
= saved_face_id
;
16698 it
->len
= saved_len
;
16700 it
->char_to_display
= saved_char_to_display
;
16709 /* Extend the face of the last glyph in the text area of IT->glyph_row
16710 to the end of the display line. Called from display_line. If the
16711 glyph row is empty, add a space glyph to it so that we know the
16712 face to draw. Set the glyph row flag fill_line_p. If the glyph
16713 row is R2L, prepend a stretch glyph to cover the empty space to the
16714 left of the leftmost glyph. */
16717 extend_face_to_end_of_line (struct it
*it
)
16720 struct frame
*f
= it
->f
;
16722 /* If line is already filled, do nothing. Non window-system frames
16723 get a grace of one more ``pixel'' because their characters are
16724 1-``pixel'' wide, so they hit the equality too early. This grace
16725 is needed only for R2L rows that are not continued, to produce
16726 one extra blank where we could display the cursor. */
16727 if (it
->current_x
>= it
->last_visible_x
16728 + (!FRAME_WINDOW_P (f
)
16729 && it
->glyph_row
->reversed_p
16730 && !it
->glyph_row
->continued_p
))
16733 /* Face extension extends the background and box of IT->face_id
16734 to the end of the line. If the background equals the background
16735 of the frame, we don't have to do anything. */
16736 if (it
->face_before_selective_p
)
16737 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16739 face
= FACE_FROM_ID (f
, it
->face_id
);
16741 if (FRAME_WINDOW_P (f
)
16742 && it
->glyph_row
->displays_text_p
16743 && face
->box
== FACE_NO_BOX
16744 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16746 && !it
->glyph_row
->reversed_p
)
16749 /* Set the glyph row flag indicating that the face of the last glyph
16750 in the text area has to be drawn to the end of the text area. */
16751 it
->glyph_row
->fill_line_p
= 1;
16753 /* If current character of IT is not ASCII, make sure we have the
16754 ASCII face. This will be automatically undone the next time
16755 get_next_display_element returns a multibyte character. Note
16756 that the character will always be single byte in unibyte
16758 if (!ASCII_CHAR_P (it
->c
))
16760 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16763 if (FRAME_WINDOW_P (f
))
16765 /* If the row is empty, add a space with the current face of IT,
16766 so that we know which face to draw. */
16767 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16769 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16770 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16771 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16773 #ifdef HAVE_WINDOW_SYSTEM
16774 if (it
->glyph_row
->reversed_p
)
16776 /* Prepend a stretch glyph to the row, such that the
16777 rightmost glyph will be drawn flushed all the way to the
16778 right margin of the window. The stretch glyph that will
16779 occupy the empty space, if any, to the left of the
16781 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16782 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16783 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16785 int row_width
, stretch_ascent
, stretch_width
;
16786 struct text_pos saved_pos
;
16787 int saved_face_id
, saved_avoid_cursor
;
16789 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16790 row_width
+= g
->pixel_width
;
16791 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16792 if (stretch_width
> 0)
16795 (((it
->ascent
+ it
->descent
)
16796 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16797 saved_pos
= it
->position
;
16798 memset (&it
->position
, 0, sizeof it
->position
);
16799 saved_avoid_cursor
= it
->avoid_cursor_p
;
16800 it
->avoid_cursor_p
= 1;
16801 saved_face_id
= it
->face_id
;
16802 /* The last row's stretch glyph should get the default
16803 face, to avoid painting the rest of the window with
16804 the region face, if the region ends at ZV. */
16805 if (it
->glyph_row
->ends_at_zv_p
)
16806 it
->face_id
= DEFAULT_FACE_ID
;
16808 it
->face_id
= face
->id
;
16809 append_stretch_glyph (it
, make_number (0), stretch_width
,
16810 it
->ascent
+ it
->descent
, stretch_ascent
);
16811 it
->position
= saved_pos
;
16812 it
->avoid_cursor_p
= saved_avoid_cursor
;
16813 it
->face_id
= saved_face_id
;
16816 #endif /* HAVE_WINDOW_SYSTEM */
16820 /* Save some values that must not be changed. */
16821 int saved_x
= it
->current_x
;
16822 struct text_pos saved_pos
;
16823 Lisp_Object saved_object
;
16824 enum display_element_type saved_what
= it
->what
;
16825 int saved_face_id
= it
->face_id
;
16827 saved_object
= it
->object
;
16828 saved_pos
= it
->position
;
16830 it
->what
= IT_CHARACTER
;
16831 memset (&it
->position
, 0, sizeof it
->position
);
16832 it
->object
= make_number (0);
16833 it
->c
= it
->char_to_display
= ' ';
16835 /* The last row's blank glyphs should get the default face, to
16836 avoid painting the rest of the window with the region face,
16837 if the region ends at ZV. */
16838 if (it
->glyph_row
->ends_at_zv_p
)
16839 it
->face_id
= DEFAULT_FACE_ID
;
16841 it
->face_id
= face
->id
;
16843 PRODUCE_GLYPHS (it
);
16845 while (it
->current_x
<= it
->last_visible_x
)
16846 PRODUCE_GLYPHS (it
);
16848 /* Don't count these blanks really. It would let us insert a left
16849 truncation glyph below and make us set the cursor on them, maybe. */
16850 it
->current_x
= saved_x
;
16851 it
->object
= saved_object
;
16852 it
->position
= saved_pos
;
16853 it
->what
= saved_what
;
16854 it
->face_id
= saved_face_id
;
16859 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16860 trailing whitespace. */
16863 trailing_whitespace_p (EMACS_INT charpos
)
16865 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16868 while (bytepos
< ZV_BYTE
16869 && (c
= FETCH_CHAR (bytepos
),
16870 c
== ' ' || c
== '\t'))
16873 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16875 if (bytepos
!= PT_BYTE
)
16882 /* Highlight trailing whitespace, if any, in ROW. */
16885 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16887 int used
= row
->used
[TEXT_AREA
];
16891 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16892 struct glyph
*glyph
= start
+ used
- 1;
16894 if (row
->reversed_p
)
16896 /* Right-to-left rows need to be processed in the opposite
16897 direction, so swap the edge pointers. */
16899 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16902 /* Skip over glyphs inserted to display the cursor at the
16903 end of a line, for extending the face of the last glyph
16904 to the end of the line on terminals, and for truncation
16905 and continuation glyphs. */
16906 if (!row
->reversed_p
)
16908 while (glyph
>= start
16909 && glyph
->type
== CHAR_GLYPH
16910 && INTEGERP (glyph
->object
))
16915 while (glyph
<= start
16916 && glyph
->type
== CHAR_GLYPH
16917 && INTEGERP (glyph
->object
))
16921 /* If last glyph is a space or stretch, and it's trailing
16922 whitespace, set the face of all trailing whitespace glyphs in
16923 IT->glyph_row to `trailing-whitespace'. */
16924 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16925 && BUFFERP (glyph
->object
)
16926 && (glyph
->type
== STRETCH_GLYPH
16927 || (glyph
->type
== CHAR_GLYPH
16928 && glyph
->u
.ch
== ' '))
16929 && trailing_whitespace_p (glyph
->charpos
))
16931 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16935 if (!row
->reversed_p
)
16937 while (glyph
>= start
16938 && BUFFERP (glyph
->object
)
16939 && (glyph
->type
== STRETCH_GLYPH
16940 || (glyph
->type
== CHAR_GLYPH
16941 && glyph
->u
.ch
== ' ')))
16942 (glyph
--)->face_id
= face_id
;
16946 while (glyph
<= start
16947 && BUFFERP (glyph
->object
)
16948 && (glyph
->type
== STRETCH_GLYPH
16949 || (glyph
->type
== CHAR_GLYPH
16950 && glyph
->u
.ch
== ' ')))
16951 (glyph
++)->face_id
= face_id
;
16958 /* Value is non-zero if glyph row ROW in window W should be
16959 used to hold the cursor. */
16962 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
16966 if (PT
== CHARPOS (row
->end
.pos
))
16968 /* Suppose the row ends on a string.
16969 Unless the row is continued, that means it ends on a newline
16970 in the string. If it's anything other than a display string
16971 (e.g. a before-string from an overlay), we don't want the
16972 cursor there. (This heuristic seems to give the optimal
16973 behavior for the various types of multi-line strings.) */
16974 if (CHARPOS (row
->end
.string_pos
) >= 0)
16976 if (row
->continued_p
)
16980 /* Check for `display' property. */
16981 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16982 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16983 struct glyph
*glyph
;
16986 for (glyph
= end
; glyph
>= beg
; --glyph
)
16987 if (STRINGP (glyph
->object
))
16990 = Fget_char_property (make_number (PT
),
16994 && display_prop_string_p (prop
, glyph
->object
));
16999 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17001 /* If the row ends in middle of a real character,
17002 and the line is continued, we want the cursor here.
17003 That's because CHARPOS (ROW->end.pos) would equal
17004 PT if PT is before the character. */
17005 if (!row
->ends_in_ellipsis_p
)
17006 result
= row
->continued_p
;
17008 /* If the row ends in an ellipsis, then
17009 CHARPOS (ROW->end.pos) will equal point after the
17010 invisible text. We want that position to be displayed
17011 after the ellipsis. */
17014 /* If the row ends at ZV, display the cursor at the end of that
17015 row instead of at the start of the row below. */
17016 else if (row
->ends_at_zv_p
)
17027 /* Push the display property PROP so that it will be rendered at the
17028 current position in IT. Return 1 if PROP was successfully pushed,
17032 push_display_prop (struct it
*it
, Lisp_Object prop
)
17036 if (STRINGP (prop
))
17038 if (SCHARS (prop
) == 0)
17045 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17046 it
->current
.overlay_string_index
= -1;
17047 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17048 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17049 it
->method
= GET_FROM_STRING
;
17050 it
->stop_charpos
= 0;
17052 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17054 it
->method
= GET_FROM_STRETCH
;
17057 #ifdef HAVE_WINDOW_SYSTEM
17058 else if (IMAGEP (prop
))
17060 it
->what
= IT_IMAGE
;
17061 it
->image_id
= lookup_image (it
->f
, prop
);
17062 it
->method
= GET_FROM_IMAGE
;
17064 #endif /* HAVE_WINDOW_SYSTEM */
17067 pop_it (it
); /* bogus display property, give up */
17074 /* Return the character-property PROP at the current position in IT. */
17077 get_it_property (struct it
*it
, Lisp_Object prop
)
17079 Lisp_Object position
;
17081 if (STRINGP (it
->object
))
17082 position
= make_number (IT_STRING_CHARPOS (*it
));
17083 else if (BUFFERP (it
->object
))
17084 position
= make_number (IT_CHARPOS (*it
));
17088 return Fget_char_property (position
, prop
, it
->object
);
17091 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17094 handle_line_prefix (struct it
*it
)
17096 Lisp_Object prefix
;
17097 if (it
->continuation_lines_width
> 0)
17099 prefix
= get_it_property (it
, Qwrap_prefix
);
17101 prefix
= Vwrap_prefix
;
17105 prefix
= get_it_property (it
, Qline_prefix
);
17107 prefix
= Vline_prefix
;
17109 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17111 /* If the prefix is wider than the window, and we try to wrap
17112 it, it would acquire its own wrap prefix, and so on till the
17113 iterator stack overflows. So, don't wrap the prefix. */
17114 it
->line_wrap
= TRUNCATE
;
17115 it
->avoid_cursor_p
= 1;
17121 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17122 only for R2L lines from display_line, when it decides that too many
17123 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17126 unproduce_glyphs (struct it
*it
, int n
)
17128 struct glyph
*glyph
, *end
;
17130 xassert (it
->glyph_row
);
17131 xassert (it
->glyph_row
->reversed_p
);
17132 xassert (it
->area
== TEXT_AREA
);
17133 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17135 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17136 n
= it
->glyph_row
->used
[TEXT_AREA
];
17137 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17138 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17139 for ( ; glyph
< end
; glyph
++)
17140 glyph
[-n
] = *glyph
;
17143 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17144 and ROW->maxpos. */
17146 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17147 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17148 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17150 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17151 lines' rows is implemented for bidi-reordered rows. */
17153 /* ROW->minpos is the value of min_pos, the minimal buffer position
17156 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17158 /* We didn't find _any_ valid buffer positions in any of the
17159 glyphs, so we must trust the iterator's computed positions. */
17160 row
->minpos
= row
->start
.pos
;
17163 max_pos
= CHARPOS (it
->current
.pos
);
17164 max_bpos
= BYTEPOS (it
->current
.pos
);
17167 /* Here are the various use-cases for ending the row, and the
17168 corresponding values for ROW->maxpos:
17170 Line ends in a newline from buffer eol_pos + 1
17171 Line is continued from buffer max_pos + 1
17172 Line is truncated on right it->current.pos
17173 Line ends in a newline from string max_pos
17174 Line is continued from string max_pos
17175 Line is continued from display vector max_pos
17176 Line is entirely from a string min_pos == max_pos
17177 Line is entirely from a display vector min_pos == max_pos
17178 Line that ends at ZV ZV
17180 If you discover other use-cases, please add them here as
17182 if (row
->ends_at_zv_p
)
17183 row
->maxpos
= it
->current
.pos
;
17184 else if (row
->used
[TEXT_AREA
])
17186 if (row
->ends_in_newline_from_string_p
)
17187 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17188 else if (CHARPOS (it
->eol_pos
) > 0)
17189 SET_TEXT_POS (row
->maxpos
,
17190 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17191 else if (row
->continued_p
)
17193 /* If max_pos is different from IT's current position, it
17194 means IT->method does not belong to the display element
17195 at max_pos. However, it also means that the display
17196 element at max_pos was displayed in its entirety on this
17197 line, which is equivalent to saying that the next line
17198 starts at the next buffer position. */
17199 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17200 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17203 INC_BOTH (max_pos
, max_bpos
);
17204 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17207 else if (row
->truncated_on_right_p
)
17208 /* display_line already called reseat_at_next_visible_line_start,
17209 which puts the iterator at the beginning of the next line, in
17210 the logical order. */
17211 row
->maxpos
= it
->current
.pos
;
17212 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17213 /* A line that is entirely from a string/image/stretch... */
17214 row
->maxpos
= row
->minpos
;
17219 row
->maxpos
= it
->current
.pos
;
17222 /* Construct the glyph row IT->glyph_row in the desired matrix of
17223 IT->w from text at the current position of IT. See dispextern.h
17224 for an overview of struct it. Value is non-zero if
17225 IT->glyph_row displays text, as opposed to a line displaying ZV
17229 display_line (struct it
*it
)
17231 struct glyph_row
*row
= it
->glyph_row
;
17232 Lisp_Object overlay_arrow_string
;
17234 int may_wrap
= 0, wrap_x
;
17235 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17236 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17237 int wrap_row_extra_line_spacing
;
17238 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17239 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17241 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17243 /* We always start displaying at hpos zero even if hscrolled. */
17244 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17246 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17247 >= it
->w
->desired_matrix
->nrows
)
17249 it
->w
->nrows_scale_factor
++;
17250 fonts_changed_p
= 1;
17254 /* Is IT->w showing the region? */
17255 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17257 /* Clear the result glyph row and enable it. */
17258 prepare_desired_row (row
);
17260 row
->y
= it
->current_y
;
17261 row
->start
= it
->start
;
17262 row
->continuation_lines_width
= it
->continuation_lines_width
;
17263 row
->displays_text_p
= 1;
17264 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17265 it
->starts_in_middle_of_char_p
= 0;
17267 /* Arrange the overlays nicely for our purposes. Usually, we call
17268 display_line on only one line at a time, in which case this
17269 can't really hurt too much, or we call it on lines which appear
17270 one after another in the buffer, in which case all calls to
17271 recenter_overlay_lists but the first will be pretty cheap. */
17272 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17274 /* Move over display elements that are not visible because we are
17275 hscrolled. This may stop at an x-position < IT->first_visible_x
17276 if the first glyph is partially visible or if we hit a line end. */
17277 if (it
->current_x
< it
->first_visible_x
)
17279 this_line_min_pos
= row
->start
.pos
;
17280 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17281 MOVE_TO_POS
| MOVE_TO_X
);
17282 /* Record the smallest positions seen while we moved over
17283 display elements that are not visible. This is needed by
17284 redisplay_internal for optimizing the case where the cursor
17285 stays inside the same line. The rest of this function only
17286 considers positions that are actually displayed, so
17287 RECORD_MAX_MIN_POS will not otherwise record positions that
17288 are hscrolled to the left of the left edge of the window. */
17289 min_pos
= CHARPOS (this_line_min_pos
);
17290 min_bpos
= BYTEPOS (this_line_min_pos
);
17294 /* We only do this when not calling `move_it_in_display_line_to'
17295 above, because move_it_in_display_line_to calls
17296 handle_line_prefix itself. */
17297 handle_line_prefix (it
);
17300 /* Get the initial row height. This is either the height of the
17301 text hscrolled, if there is any, or zero. */
17302 row
->ascent
= it
->max_ascent
;
17303 row
->height
= it
->max_ascent
+ it
->max_descent
;
17304 row
->phys_ascent
= it
->max_phys_ascent
;
17305 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17306 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17308 /* Utility macro to record max and min buffer positions seen until now. */
17309 #define RECORD_MAX_MIN_POS(IT) \
17312 if (IT_CHARPOS (*(IT)) < min_pos) \
17314 min_pos = IT_CHARPOS (*(IT)); \
17315 min_bpos = IT_BYTEPOS (*(IT)); \
17317 if (IT_CHARPOS (*(IT)) > max_pos) \
17319 max_pos = IT_CHARPOS (*(IT)); \
17320 max_bpos = IT_BYTEPOS (*(IT)); \
17325 /* Loop generating characters. The loop is left with IT on the next
17326 character to display. */
17329 int n_glyphs_before
, hpos_before
, x_before
;
17331 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17333 /* Retrieve the next thing to display. Value is zero if end of
17335 if (!get_next_display_element (it
))
17337 /* Maybe add a space at the end of this line that is used to
17338 display the cursor there under X. Set the charpos of the
17339 first glyph of blank lines not corresponding to any text
17341 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17342 row
->exact_window_width_line_p
= 1;
17343 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17344 || row
->used
[TEXT_AREA
] == 0)
17346 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17347 row
->displays_text_p
= 0;
17349 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17350 && (!MINI_WINDOW_P (it
->w
)
17351 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17352 row
->indicate_empty_line_p
= 1;
17355 it
->continuation_lines_width
= 0;
17356 row
->ends_at_zv_p
= 1;
17357 /* A row that displays right-to-left text must always have
17358 its last face extended all the way to the end of line,
17359 even if this row ends in ZV, because we still write to
17360 the screen left to right. */
17361 if (row
->reversed_p
)
17362 extend_face_to_end_of_line (it
);
17366 /* Now, get the metrics of what we want to display. This also
17367 generates glyphs in `row' (which is IT->glyph_row). */
17368 n_glyphs_before
= row
->used
[TEXT_AREA
];
17371 /* Remember the line height so far in case the next element doesn't
17372 fit on the line. */
17373 if (it
->line_wrap
!= TRUNCATE
)
17375 ascent
= it
->max_ascent
;
17376 descent
= it
->max_descent
;
17377 phys_ascent
= it
->max_phys_ascent
;
17378 phys_descent
= it
->max_phys_descent
;
17380 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17382 if (IT_DISPLAYING_WHITESPACE (it
))
17388 wrap_row_used
= row
->used
[TEXT_AREA
];
17389 wrap_row_ascent
= row
->ascent
;
17390 wrap_row_height
= row
->height
;
17391 wrap_row_phys_ascent
= row
->phys_ascent
;
17392 wrap_row_phys_height
= row
->phys_height
;
17393 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17394 wrap_row_min_pos
= min_pos
;
17395 wrap_row_min_bpos
= min_bpos
;
17396 wrap_row_max_pos
= max_pos
;
17397 wrap_row_max_bpos
= max_bpos
;
17403 PRODUCE_GLYPHS (it
);
17405 /* If this display element was in marginal areas, continue with
17407 if (it
->area
!= TEXT_AREA
)
17409 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17410 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17411 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17412 row
->phys_height
= max (row
->phys_height
,
17413 it
->max_phys_ascent
+ it
->max_phys_descent
);
17414 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17415 it
->max_extra_line_spacing
);
17416 set_iterator_to_next (it
, 1);
17420 /* Does the display element fit on the line? If we truncate
17421 lines, we should draw past the right edge of the window. If
17422 we don't truncate, we want to stop so that we can display the
17423 continuation glyph before the right margin. If lines are
17424 continued, there are two possible strategies for characters
17425 resulting in more than 1 glyph (e.g. tabs): Display as many
17426 glyphs as possible in this line and leave the rest for the
17427 continuation line, or display the whole element in the next
17428 line. Original redisplay did the former, so we do it also. */
17429 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17430 hpos_before
= it
->hpos
;
17433 if (/* Not a newline. */
17435 /* Glyphs produced fit entirely in the line. */
17436 && it
->current_x
< it
->last_visible_x
)
17438 it
->hpos
+= nglyphs
;
17439 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17440 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17441 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17442 row
->phys_height
= max (row
->phys_height
,
17443 it
->max_phys_ascent
+ it
->max_phys_descent
);
17444 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17445 it
->max_extra_line_spacing
);
17446 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17447 row
->x
= x
- it
->first_visible_x
;
17448 /* Record the maximum and minimum buffer positions seen so
17449 far in glyphs that will be displayed by this row. */
17451 RECORD_MAX_MIN_POS (it
);
17456 struct glyph
*glyph
;
17458 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17460 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17461 new_x
= x
+ glyph
->pixel_width
;
17463 if (/* Lines are continued. */
17464 it
->line_wrap
!= TRUNCATE
17465 && (/* Glyph doesn't fit on the line. */
17466 new_x
> it
->last_visible_x
17467 /* Or it fits exactly on a window system frame. */
17468 || (new_x
== it
->last_visible_x
17469 && FRAME_WINDOW_P (it
->f
))))
17471 /* End of a continued line. */
17474 || (new_x
== it
->last_visible_x
17475 && FRAME_WINDOW_P (it
->f
)))
17477 /* Current glyph is the only one on the line or
17478 fits exactly on the line. We must continue
17479 the line because we can't draw the cursor
17480 after the glyph. */
17481 row
->continued_p
= 1;
17482 it
->current_x
= new_x
;
17483 it
->continuation_lines_width
+= new_x
;
17485 /* Record the maximum and minimum buffer
17486 positions seen so far in glyphs that will be
17487 displayed by this row. */
17489 RECORD_MAX_MIN_POS (it
);
17490 if (i
== nglyphs
- 1)
17492 /* If line-wrap is on, check if a previous
17493 wrap point was found. */
17494 if (wrap_row_used
> 0
17495 /* Even if there is a previous wrap
17496 point, continue the line here as
17497 usual, if (i) the previous character
17498 was a space or tab AND (ii) the
17499 current character is not. */
17501 || IT_DISPLAYING_WHITESPACE (it
)))
17504 set_iterator_to_next (it
, 1);
17505 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17507 if (!get_next_display_element (it
))
17509 row
->exact_window_width_line_p
= 1;
17510 it
->continuation_lines_width
= 0;
17511 row
->continued_p
= 0;
17512 row
->ends_at_zv_p
= 1;
17514 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17516 row
->continued_p
= 0;
17517 row
->exact_window_width_line_p
= 1;
17522 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17523 && !FRAME_WINDOW_P (it
->f
))
17525 /* A padding glyph that doesn't fit on this line.
17526 This means the whole character doesn't fit
17528 if (row
->reversed_p
)
17529 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17530 - n_glyphs_before
);
17531 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17533 /* Fill the rest of the row with continuation
17534 glyphs like in 20.x. */
17535 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17536 < row
->glyphs
[1 + TEXT_AREA
])
17537 produce_special_glyphs (it
, IT_CONTINUATION
);
17539 row
->continued_p
= 1;
17540 it
->current_x
= x_before
;
17541 it
->continuation_lines_width
+= x_before
;
17543 /* Restore the height to what it was before the
17544 element not fitting on the line. */
17545 it
->max_ascent
= ascent
;
17546 it
->max_descent
= descent
;
17547 it
->max_phys_ascent
= phys_ascent
;
17548 it
->max_phys_descent
= phys_descent
;
17550 else if (wrap_row_used
> 0)
17553 if (row
->reversed_p
)
17554 unproduce_glyphs (it
,
17555 row
->used
[TEXT_AREA
] - wrap_row_used
);
17557 it
->continuation_lines_width
+= wrap_x
;
17558 row
->used
[TEXT_AREA
] = wrap_row_used
;
17559 row
->ascent
= wrap_row_ascent
;
17560 row
->height
= wrap_row_height
;
17561 row
->phys_ascent
= wrap_row_phys_ascent
;
17562 row
->phys_height
= wrap_row_phys_height
;
17563 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17564 min_pos
= wrap_row_min_pos
;
17565 min_bpos
= wrap_row_min_bpos
;
17566 max_pos
= wrap_row_max_pos
;
17567 max_bpos
= wrap_row_max_bpos
;
17568 row
->continued_p
= 1;
17569 row
->ends_at_zv_p
= 0;
17570 row
->exact_window_width_line_p
= 0;
17571 it
->continuation_lines_width
+= x
;
17573 /* Make sure that a non-default face is extended
17574 up to the right margin of the window. */
17575 extend_face_to_end_of_line (it
);
17577 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17579 /* A TAB that extends past the right edge of the
17580 window. This produces a single glyph on
17581 window system frames. We leave the glyph in
17582 this row and let it fill the row, but don't
17583 consume the TAB. */
17584 it
->continuation_lines_width
+= it
->last_visible_x
;
17585 row
->ends_in_middle_of_char_p
= 1;
17586 row
->continued_p
= 1;
17587 glyph
->pixel_width
= it
->last_visible_x
- x
;
17588 it
->starts_in_middle_of_char_p
= 1;
17592 /* Something other than a TAB that draws past
17593 the right edge of the window. Restore
17594 positions to values before the element. */
17595 if (row
->reversed_p
)
17596 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17597 - (n_glyphs_before
+ i
));
17598 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17600 /* Display continuation glyphs. */
17601 if (!FRAME_WINDOW_P (it
->f
))
17602 produce_special_glyphs (it
, IT_CONTINUATION
);
17603 row
->continued_p
= 1;
17605 it
->current_x
= x_before
;
17606 it
->continuation_lines_width
+= x
;
17607 extend_face_to_end_of_line (it
);
17609 if (nglyphs
> 1 && i
> 0)
17611 row
->ends_in_middle_of_char_p
= 1;
17612 it
->starts_in_middle_of_char_p
= 1;
17615 /* Restore the height to what it was before the
17616 element not fitting on the line. */
17617 it
->max_ascent
= ascent
;
17618 it
->max_descent
= descent
;
17619 it
->max_phys_ascent
= phys_ascent
;
17620 it
->max_phys_descent
= phys_descent
;
17625 else if (new_x
> it
->first_visible_x
)
17627 /* Increment number of glyphs actually displayed. */
17630 /* Record the maximum and minimum buffer positions
17631 seen so far in glyphs that will be displayed by
17634 RECORD_MAX_MIN_POS (it
);
17636 if (x
< it
->first_visible_x
)
17637 /* Glyph is partially visible, i.e. row starts at
17638 negative X position. */
17639 row
->x
= x
- it
->first_visible_x
;
17643 /* Glyph is completely off the left margin of the
17644 window. This should not happen because of the
17645 move_it_in_display_line at the start of this
17646 function, unless the text display area of the
17647 window is empty. */
17648 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17652 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17653 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17654 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17655 row
->phys_height
= max (row
->phys_height
,
17656 it
->max_phys_ascent
+ it
->max_phys_descent
);
17657 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17658 it
->max_extra_line_spacing
);
17660 /* End of this display line if row is continued. */
17661 if (row
->continued_p
|| row
->ends_at_zv_p
)
17666 /* Is this a line end? If yes, we're also done, after making
17667 sure that a non-default face is extended up to the right
17668 margin of the window. */
17669 if (ITERATOR_AT_END_OF_LINE_P (it
))
17671 int used_before
= row
->used
[TEXT_AREA
];
17673 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17675 /* Add a space at the end of the line that is used to
17676 display the cursor there. */
17677 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17678 append_space_for_newline (it
, 0);
17680 /* Extend the face to the end of the line. */
17681 extend_face_to_end_of_line (it
);
17683 /* Make sure we have the position. */
17684 if (used_before
== 0)
17685 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17687 /* Record the position of the newline, for use in
17689 it
->eol_pos
= it
->current
.pos
;
17691 /* Consume the line end. This skips over invisible lines. */
17692 set_iterator_to_next (it
, 1);
17693 it
->continuation_lines_width
= 0;
17697 /* Proceed with next display element. Note that this skips
17698 over lines invisible because of selective display. */
17699 set_iterator_to_next (it
, 1);
17701 /* If we truncate lines, we are done when the last displayed
17702 glyphs reach past the right margin of the window. */
17703 if (it
->line_wrap
== TRUNCATE
17704 && (FRAME_WINDOW_P (it
->f
)
17705 ? (it
->current_x
>= it
->last_visible_x
)
17706 : (it
->current_x
> it
->last_visible_x
)))
17708 /* Maybe add truncation glyphs. */
17709 if (!FRAME_WINDOW_P (it
->f
))
17713 if (!row
->reversed_p
)
17715 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17716 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17721 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17722 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17724 /* Remove any padding glyphs at the front of ROW, to
17725 make room for the truncation glyphs we will be
17726 adding below. The loop below always inserts at
17727 least one truncation glyph, so also remove the
17728 last glyph added to ROW. */
17729 unproduce_glyphs (it
, i
+ 1);
17730 /* Adjust i for the loop below. */
17731 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17734 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17736 row
->used
[TEXT_AREA
] = i
;
17737 produce_special_glyphs (it
, IT_TRUNCATION
);
17740 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17742 /* Don't truncate if we can overflow newline into fringe. */
17743 if (!get_next_display_element (it
))
17745 it
->continuation_lines_width
= 0;
17746 row
->ends_at_zv_p
= 1;
17747 row
->exact_window_width_line_p
= 1;
17750 if (ITERATOR_AT_END_OF_LINE_P (it
))
17752 row
->exact_window_width_line_p
= 1;
17753 goto at_end_of_line
;
17757 row
->truncated_on_right_p
= 1;
17758 it
->continuation_lines_width
= 0;
17759 reseat_at_next_visible_line_start (it
, 0);
17760 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17761 it
->hpos
= hpos_before
;
17762 it
->current_x
= x_before
;
17767 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17768 at the left window margin. */
17769 if (it
->first_visible_x
17770 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17772 if (!FRAME_WINDOW_P (it
->f
))
17773 insert_left_trunc_glyphs (it
);
17774 row
->truncated_on_left_p
= 1;
17777 /* Remember the position at which this line ends.
17779 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17780 cannot be before the call to find_row_edges below, since that is
17781 where these positions are determined. */
17782 row
->end
= it
->current
;
17785 row
->minpos
= row
->start
.pos
;
17786 row
->maxpos
= row
->end
.pos
;
17790 /* ROW->minpos and ROW->maxpos must be the smallest and
17791 `1 + the largest' buffer positions in ROW. But if ROW was
17792 bidi-reordered, these two positions can be anywhere in the
17793 row, so we must determine them now. */
17794 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17797 /* If the start of this line is the overlay arrow-position, then
17798 mark this glyph row as the one containing the overlay arrow.
17799 This is clearly a mess with variable size fonts. It would be
17800 better to let it be displayed like cursors under X. */
17801 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17802 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17803 !NILP (overlay_arrow_string
)))
17805 /* Overlay arrow in window redisplay is a fringe bitmap. */
17806 if (STRINGP (overlay_arrow_string
))
17808 struct glyph_row
*arrow_row
17809 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17810 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17811 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17812 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17813 struct glyph
*p2
, *end
;
17815 /* Copy the arrow glyphs. */
17816 while (glyph
< arrow_end
)
17819 /* Throw away padding glyphs. */
17821 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17822 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17828 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17833 xassert (INTEGERP (overlay_arrow_string
));
17834 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17836 overlay_arrow_seen
= 1;
17839 /* Compute pixel dimensions of this line. */
17840 compute_line_metrics (it
);
17842 /* Record whether this row ends inside an ellipsis. */
17843 row
->ends_in_ellipsis_p
17844 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17845 && it
->ellipsis_p
);
17847 /* Save fringe bitmaps in this row. */
17848 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17849 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17850 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17851 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17853 it
->left_user_fringe_bitmap
= 0;
17854 it
->left_user_fringe_face_id
= 0;
17855 it
->right_user_fringe_bitmap
= 0;
17856 it
->right_user_fringe_face_id
= 0;
17858 /* Maybe set the cursor. */
17859 cvpos
= it
->w
->cursor
.vpos
;
17861 /* In bidi-reordered rows, keep checking for proper cursor
17862 position even if one has been found already, because buffer
17863 positions in such rows change non-linearly with ROW->VPOS,
17864 when a line is continued. One exception: when we are at ZV,
17865 display cursor on the first suitable glyph row, since all
17866 the empty rows after that also have their position set to ZV. */
17867 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17868 lines' rows is implemented for bidi-reordered rows. */
17870 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17871 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17872 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17873 && cursor_row_p (it
->w
, row
))
17874 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17876 /* Highlight trailing whitespace. */
17877 if (!NILP (Vshow_trailing_whitespace
))
17878 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17880 /* Prepare for the next line. This line starts horizontally at (X
17881 HPOS) = (0 0). Vertical positions are incremented. As a
17882 convenience for the caller, IT->glyph_row is set to the next
17884 it
->current_x
= it
->hpos
= 0;
17885 it
->current_y
+= row
->height
;
17886 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17889 /* The next row should by default use the same value of the
17890 reversed_p flag as this one. set_iterator_to_next decides when
17891 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17892 the flag accordingly. */
17893 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17894 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17895 it
->start
= row
->end
;
17896 return row
->displays_text_p
;
17898 #undef RECORD_MAX_MIN_POS
17901 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17902 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17903 doc
: /* Return paragraph direction at point in BUFFER.
17904 Value is either `left-to-right' or `right-to-left'.
17905 If BUFFER is omitted or nil, it defaults to the current buffer.
17907 Paragraph direction determines how the text in the paragraph is displayed.
17908 In left-to-right paragraphs, text begins at the left margin of the window
17909 and the reading direction is generally left to right. In right-to-left
17910 paragraphs, text begins at the right margin and is read from right to left.
17912 See also `bidi-paragraph-direction'. */)
17913 (Lisp_Object buffer
)
17915 struct buffer
*buf
= current_buffer
;
17916 struct buffer
*old
= buf
;
17918 if (! NILP (buffer
))
17920 CHECK_BUFFER (buffer
);
17921 buf
= XBUFFER (buffer
);
17924 if (NILP (BVAR (buf
, bidi_display_reordering
)))
17925 return Qleft_to_right
;
17926 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
17927 return BVAR (buf
, bidi_paragraph_direction
);
17930 /* Determine the direction from buffer text. We could try to
17931 use current_matrix if it is up to date, but this seems fast
17932 enough as it is. */
17933 struct bidi_it itb
;
17934 EMACS_INT pos
= BUF_PT (buf
);
17935 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17938 set_buffer_temp (buf
);
17939 /* bidi_paragraph_init finds the base direction of the paragraph
17940 by searching forward from paragraph start. We need the base
17941 direction of the current or _previous_ paragraph, so we need
17942 to make sure we are within that paragraph. To that end, find
17943 the previous non-empty line. */
17944 if (pos
>= ZV
&& pos
> BEGV
)
17947 bytepos
= CHAR_TO_BYTE (pos
);
17949 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17950 || c
== ' ' || c
== '\t' || c
== '\f')
17952 if (bytepos
<= BEGV_BYTE
)
17957 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17960 itb
.bytepos
= bytepos
;
17962 itb
.separator_limit
= -1;
17963 itb
.paragraph_dir
= NEUTRAL_DIR
;
17965 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
17966 set_buffer_temp (old
);
17967 switch (itb
.paragraph_dir
)
17970 return Qleft_to_right
;
17973 return Qright_to_left
;
17983 /***********************************************************************
17985 ***********************************************************************/
17987 /* Redisplay the menu bar in the frame for window W.
17989 The menu bar of X frames that don't have X toolkit support is
17990 displayed in a special window W->frame->menu_bar_window.
17992 The menu bar of terminal frames is treated specially as far as
17993 glyph matrices are concerned. Menu bar lines are not part of
17994 windows, so the update is done directly on the frame matrix rows
17995 for the menu bar. */
17998 display_menu_bar (struct window
*w
)
18000 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18005 /* Don't do all this for graphical frames. */
18007 if (FRAME_W32_P (f
))
18010 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18016 if (FRAME_NS_P (f
))
18018 #endif /* HAVE_NS */
18020 #ifdef USE_X_TOOLKIT
18021 xassert (!FRAME_WINDOW_P (f
));
18022 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18023 it
.first_visible_x
= 0;
18024 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18025 #else /* not USE_X_TOOLKIT */
18026 if (FRAME_WINDOW_P (f
))
18028 /* Menu bar lines are displayed in the desired matrix of the
18029 dummy window menu_bar_window. */
18030 struct window
*menu_w
;
18031 xassert (WINDOWP (f
->menu_bar_window
));
18032 menu_w
= XWINDOW (f
->menu_bar_window
);
18033 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18035 it
.first_visible_x
= 0;
18036 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18040 /* This is a TTY frame, i.e. character hpos/vpos are used as
18042 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18044 it
.first_visible_x
= 0;
18045 it
.last_visible_x
= FRAME_COLS (f
);
18047 #endif /* not USE_X_TOOLKIT */
18049 if (! mode_line_inverse_video
)
18050 /* Force the menu-bar to be displayed in the default face. */
18051 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18053 /* Clear all rows of the menu bar. */
18054 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18056 struct glyph_row
*row
= it
.glyph_row
+ i
;
18057 clear_glyph_row (row
);
18058 row
->enabled_p
= 1;
18059 row
->full_width_p
= 1;
18062 /* Display all items of the menu bar. */
18063 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18064 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18066 Lisp_Object string
;
18068 /* Stop at nil string. */
18069 string
= AREF (items
, i
+ 1);
18073 /* Remember where item was displayed. */
18074 ASET (items
, i
+ 3, make_number (it
.hpos
));
18076 /* Display the item, pad with one space. */
18077 if (it
.current_x
< it
.last_visible_x
)
18078 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18079 SCHARS (string
) + 1, 0, 0, -1);
18082 /* Fill out the line with spaces. */
18083 if (it
.current_x
< it
.last_visible_x
)
18084 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18086 /* Compute the total height of the lines. */
18087 compute_line_metrics (&it
);
18092 /***********************************************************************
18094 ***********************************************************************/
18096 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18097 FORCE is non-zero, redisplay mode lines unconditionally.
18098 Otherwise, redisplay only mode lines that are garbaged. Value is
18099 the number of windows whose mode lines were redisplayed. */
18102 redisplay_mode_lines (Lisp_Object window
, int force
)
18106 while (!NILP (window
))
18108 struct window
*w
= XWINDOW (window
);
18110 if (WINDOWP (w
->hchild
))
18111 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18112 else if (WINDOWP (w
->vchild
))
18113 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18115 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18116 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18118 struct text_pos lpoint
;
18119 struct buffer
*old
= current_buffer
;
18121 /* Set the window's buffer for the mode line display. */
18122 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18123 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18125 /* Point refers normally to the selected window. For any
18126 other window, set up appropriate value. */
18127 if (!EQ (window
, selected_window
))
18129 struct text_pos pt
;
18131 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18132 if (CHARPOS (pt
) < BEGV
)
18133 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18134 else if (CHARPOS (pt
) > (ZV
- 1))
18135 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18137 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18140 /* Display mode lines. */
18141 clear_glyph_matrix (w
->desired_matrix
);
18142 if (display_mode_lines (w
))
18145 w
->must_be_updated_p
= 1;
18148 /* Restore old settings. */
18149 set_buffer_internal_1 (old
);
18150 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18160 /* Display the mode and/or header line of window W. Value is the
18161 sum number of mode lines and header lines displayed. */
18164 display_mode_lines (struct window
*w
)
18166 Lisp_Object old_selected_window
, old_selected_frame
;
18169 old_selected_frame
= selected_frame
;
18170 selected_frame
= w
->frame
;
18171 old_selected_window
= selected_window
;
18172 XSETWINDOW (selected_window
, w
);
18174 /* These will be set while the mode line specs are processed. */
18175 line_number_displayed
= 0;
18176 w
->column_number_displayed
= Qnil
;
18178 if (WINDOW_WANTS_MODELINE_P (w
))
18180 struct window
*sel_w
= XWINDOW (old_selected_window
);
18182 /* Select mode line face based on the real selected window. */
18183 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18184 BVAR (current_buffer
, mode_line_format
));
18188 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18190 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18191 BVAR (current_buffer
, header_line_format
));
18195 selected_frame
= old_selected_frame
;
18196 selected_window
= old_selected_window
;
18201 /* Display mode or header line of window W. FACE_ID specifies which
18202 line to display; it is either MODE_LINE_FACE_ID or
18203 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18204 display. Value is the pixel height of the mode/header line
18208 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18212 int count
= SPECPDL_INDEX ();
18214 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18215 /* Don't extend on a previously drawn mode-line.
18216 This may happen if called from pos_visible_p. */
18217 it
.glyph_row
->enabled_p
= 0;
18218 prepare_desired_row (it
.glyph_row
);
18220 it
.glyph_row
->mode_line_p
= 1;
18222 if (! mode_line_inverse_video
)
18223 /* Force the mode-line to be displayed in the default face. */
18224 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18226 record_unwind_protect (unwind_format_mode_line
,
18227 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18229 mode_line_target
= MODE_LINE_DISPLAY
;
18231 /* Temporarily make frame's keyboard the current kboard so that
18232 kboard-local variables in the mode_line_format will get the right
18234 push_kboard (FRAME_KBOARD (it
.f
));
18235 record_unwind_save_match_data ();
18236 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18239 unbind_to (count
, Qnil
);
18241 /* Fill up with spaces. */
18242 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18244 compute_line_metrics (&it
);
18245 it
.glyph_row
->full_width_p
= 1;
18246 it
.glyph_row
->continued_p
= 0;
18247 it
.glyph_row
->truncated_on_left_p
= 0;
18248 it
.glyph_row
->truncated_on_right_p
= 0;
18250 /* Make a 3D mode-line have a shadow at its right end. */
18251 face
= FACE_FROM_ID (it
.f
, face_id
);
18252 extend_face_to_end_of_line (&it
);
18253 if (face
->box
!= FACE_NO_BOX
)
18255 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18256 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18257 last
->right_box_line_p
= 1;
18260 return it
.glyph_row
->height
;
18263 /* Move element ELT in LIST to the front of LIST.
18264 Return the updated list. */
18267 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18269 register Lisp_Object tail
, prev
;
18270 register Lisp_Object tem
;
18274 while (CONSP (tail
))
18280 /* Splice out the link TAIL. */
18282 list
= XCDR (tail
);
18284 Fsetcdr (prev
, XCDR (tail
));
18286 /* Now make it the first. */
18287 Fsetcdr (tail
, list
);
18292 tail
= XCDR (tail
);
18296 /* Not found--return unchanged LIST. */
18300 /* Contribute ELT to the mode line for window IT->w. How it
18301 translates into text depends on its data type.
18303 IT describes the display environment in which we display, as usual.
18305 DEPTH is the depth in recursion. It is used to prevent
18306 infinite recursion here.
18308 FIELD_WIDTH is the number of characters the display of ELT should
18309 occupy in the mode line, and PRECISION is the maximum number of
18310 characters to display from ELT's representation. See
18311 display_string for details.
18313 Returns the hpos of the end of the text generated by ELT.
18315 PROPS is a property list to add to any string we encounter.
18317 If RISKY is nonzero, remove (disregard) any properties in any string
18318 we encounter, and ignore :eval and :propertize.
18320 The global variable `mode_line_target' determines whether the
18321 output is passed to `store_mode_line_noprop',
18322 `store_mode_line_string', or `display_string'. */
18325 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18326 Lisp_Object elt
, Lisp_Object props
, int risky
)
18328 int n
= 0, field
, prec
;
18333 elt
= build_string ("*too-deep*");
18337 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18341 /* A string: output it and check for %-constructs within it. */
18343 EMACS_INT offset
= 0;
18345 if (SCHARS (elt
) > 0
18346 && (!NILP (props
) || risky
))
18348 Lisp_Object oprops
, aelt
;
18349 oprops
= Ftext_properties_at (make_number (0), elt
);
18351 /* If the starting string's properties are not what
18352 we want, translate the string. Also, if the string
18353 is risky, do that anyway. */
18355 if (NILP (Fequal (props
, oprops
)) || risky
)
18357 /* If the starting string has properties,
18358 merge the specified ones onto the existing ones. */
18359 if (! NILP (oprops
) && !risky
)
18363 oprops
= Fcopy_sequence (oprops
);
18365 while (CONSP (tem
))
18367 oprops
= Fplist_put (oprops
, XCAR (tem
),
18368 XCAR (XCDR (tem
)));
18369 tem
= XCDR (XCDR (tem
));
18374 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18375 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18377 /* AELT is what we want. Move it to the front
18378 without consing. */
18380 mode_line_proptrans_alist
18381 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18387 /* If AELT has the wrong props, it is useless.
18388 so get rid of it. */
18390 mode_line_proptrans_alist
18391 = Fdelq (aelt
, mode_line_proptrans_alist
);
18393 elt
= Fcopy_sequence (elt
);
18394 Fset_text_properties (make_number (0), Flength (elt
),
18396 /* Add this item to mode_line_proptrans_alist. */
18397 mode_line_proptrans_alist
18398 = Fcons (Fcons (elt
, props
),
18399 mode_line_proptrans_alist
);
18400 /* Truncate mode_line_proptrans_alist
18401 to at most 50 elements. */
18402 tem
= Fnthcdr (make_number (50),
18403 mode_line_proptrans_alist
);
18405 XSETCDR (tem
, Qnil
);
18414 prec
= precision
- n
;
18415 switch (mode_line_target
)
18417 case MODE_LINE_NOPROP
:
18418 case MODE_LINE_TITLE
:
18419 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18421 case MODE_LINE_STRING
:
18422 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18424 case MODE_LINE_DISPLAY
:
18425 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18426 0, prec
, 0, STRING_MULTIBYTE (elt
));
18433 /* Handle the non-literal case. */
18435 while ((precision
<= 0 || n
< precision
)
18436 && SREF (elt
, offset
) != 0
18437 && (mode_line_target
!= MODE_LINE_DISPLAY
18438 || it
->current_x
< it
->last_visible_x
))
18440 EMACS_INT last_offset
= offset
;
18442 /* Advance to end of string or next format specifier. */
18443 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18446 if (offset
- 1 != last_offset
)
18448 EMACS_INT nchars
, nbytes
;
18450 /* Output to end of string or up to '%'. Field width
18451 is length of string. Don't output more than
18452 PRECISION allows us. */
18455 prec
= c_string_width (SDATA (elt
) + last_offset
,
18456 offset
- last_offset
, precision
- n
,
18459 switch (mode_line_target
)
18461 case MODE_LINE_NOPROP
:
18462 case MODE_LINE_TITLE
:
18463 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18465 case MODE_LINE_STRING
:
18467 EMACS_INT bytepos
= last_offset
;
18468 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18469 EMACS_INT endpos
= (precision
<= 0
18470 ? string_byte_to_char (elt
, offset
)
18471 : charpos
+ nchars
);
18473 n
+= store_mode_line_string (NULL
,
18474 Fsubstring (elt
, make_number (charpos
),
18475 make_number (endpos
)),
18479 case MODE_LINE_DISPLAY
:
18481 EMACS_INT bytepos
= last_offset
;
18482 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18484 if (precision
<= 0)
18485 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18486 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18488 STRING_MULTIBYTE (elt
));
18493 else /* c == '%' */
18495 EMACS_INT percent_position
= offset
;
18497 /* Get the specified minimum width. Zero means
18500 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18501 field
= field
* 10 + c
- '0';
18503 /* Don't pad beyond the total padding allowed. */
18504 if (field_width
- n
> 0 && field
> field_width
- n
)
18505 field
= field_width
- n
;
18507 /* Note that either PRECISION <= 0 or N < PRECISION. */
18508 prec
= precision
- n
;
18511 n
+= display_mode_element (it
, depth
, field
, prec
,
18512 Vglobal_mode_string
, props
,
18517 EMACS_INT bytepos
, charpos
;
18519 Lisp_Object string
;
18521 bytepos
= percent_position
;
18522 charpos
= (STRING_MULTIBYTE (elt
)
18523 ? string_byte_to_char (elt
, bytepos
)
18525 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18526 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18528 switch (mode_line_target
)
18530 case MODE_LINE_NOPROP
:
18531 case MODE_LINE_TITLE
:
18532 n
+= store_mode_line_noprop (spec
, field
, prec
);
18534 case MODE_LINE_STRING
:
18536 int len
= strlen (spec
);
18537 Lisp_Object tem
= make_string (spec
, len
);
18538 props
= Ftext_properties_at (make_number (charpos
), elt
);
18539 /* Should only keep face property in props */
18540 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18543 case MODE_LINE_DISPLAY
:
18545 int nglyphs_before
, nwritten
;
18547 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18548 nwritten
= display_string (spec
, string
, elt
,
18553 /* Assign to the glyphs written above the
18554 string where the `%x' came from, position
18558 struct glyph
*glyph
18559 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18563 for (i
= 0; i
< nwritten
; ++i
)
18565 glyph
[i
].object
= elt
;
18566 glyph
[i
].charpos
= charpos
;
18583 /* A symbol: process the value of the symbol recursively
18584 as if it appeared here directly. Avoid error if symbol void.
18585 Special case: if value of symbol is a string, output the string
18588 register Lisp_Object tem
;
18590 /* If the variable is not marked as risky to set
18591 then its contents are risky to use. */
18592 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18595 tem
= Fboundp (elt
);
18598 tem
= Fsymbol_value (elt
);
18599 /* If value is a string, output that string literally:
18600 don't check for % within it. */
18604 if (!EQ (tem
, elt
))
18606 /* Give up right away for nil or t. */
18616 register Lisp_Object car
, tem
;
18618 /* A cons cell: five distinct cases.
18619 If first element is :eval or :propertize, do something special.
18620 If first element is a string or a cons, process all the elements
18621 and effectively concatenate them.
18622 If first element is a negative number, truncate displaying cdr to
18623 at most that many characters. If positive, pad (with spaces)
18624 to at least that many characters.
18625 If first element is a symbol, process the cadr or caddr recursively
18626 according to whether the symbol's value is non-nil or nil. */
18628 if (EQ (car
, QCeval
))
18630 /* An element of the form (:eval FORM) means evaluate FORM
18631 and use the result as mode line elements. */
18636 if (CONSP (XCDR (elt
)))
18639 spec
= safe_eval (XCAR (XCDR (elt
)));
18640 n
+= display_mode_element (it
, depth
, field_width
- n
,
18641 precision
- n
, spec
, props
,
18645 else if (EQ (car
, QCpropertize
))
18647 /* An element of the form (:propertize ELT PROPS...)
18648 means display ELT but applying properties PROPS. */
18653 if (CONSP (XCDR (elt
)))
18654 n
+= display_mode_element (it
, depth
, field_width
- n
,
18655 precision
- n
, XCAR (XCDR (elt
)),
18656 XCDR (XCDR (elt
)), risky
);
18658 else if (SYMBOLP (car
))
18660 tem
= Fboundp (car
);
18664 /* elt is now the cdr, and we know it is a cons cell.
18665 Use its car if CAR has a non-nil value. */
18668 tem
= Fsymbol_value (car
);
18675 /* Symbol's value is nil (or symbol is unbound)
18676 Get the cddr of the original list
18677 and if possible find the caddr and use that. */
18681 else if (!CONSP (elt
))
18686 else if (INTEGERP (car
))
18688 register int lim
= XINT (car
);
18692 /* Negative int means reduce maximum width. */
18693 if (precision
<= 0)
18696 precision
= min (precision
, -lim
);
18700 /* Padding specified. Don't let it be more than
18701 current maximum. */
18703 lim
= min (precision
, lim
);
18705 /* If that's more padding than already wanted, queue it.
18706 But don't reduce padding already specified even if
18707 that is beyond the current truncation point. */
18708 field_width
= max (lim
, field_width
);
18712 else if (STRINGP (car
) || CONSP (car
))
18714 Lisp_Object halftail
= elt
;
18718 && (precision
<= 0 || n
< precision
))
18720 n
+= display_mode_element (it
, depth
,
18721 /* Do padding only after the last
18722 element in the list. */
18723 (! CONSP (XCDR (elt
))
18726 precision
- n
, XCAR (elt
),
18730 if ((len
& 1) == 0)
18731 halftail
= XCDR (halftail
);
18732 /* Check for cycle. */
18733 if (EQ (halftail
, elt
))
18742 elt
= build_string ("*invalid*");
18746 /* Pad to FIELD_WIDTH. */
18747 if (field_width
> 0 && n
< field_width
)
18749 switch (mode_line_target
)
18751 case MODE_LINE_NOPROP
:
18752 case MODE_LINE_TITLE
:
18753 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18755 case MODE_LINE_STRING
:
18756 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18758 case MODE_LINE_DISPLAY
:
18759 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18768 /* Store a mode-line string element in mode_line_string_list.
18770 If STRING is non-null, display that C string. Otherwise, the Lisp
18771 string LISP_STRING is displayed.
18773 FIELD_WIDTH is the minimum number of output glyphs to produce.
18774 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18775 with spaces. FIELD_WIDTH <= 0 means don't pad.
18777 PRECISION is the maximum number of characters to output from
18778 STRING. PRECISION <= 0 means don't truncate the string.
18780 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18781 properties to the string.
18783 PROPS are the properties to add to the string.
18784 The mode_line_string_face face property is always added to the string.
18788 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18789 int field_width
, int precision
, Lisp_Object props
)
18794 if (string
!= NULL
)
18796 len
= strlen (string
);
18797 if (precision
> 0 && len
> precision
)
18799 lisp_string
= make_string (string
, len
);
18801 props
= mode_line_string_face_prop
;
18802 else if (!NILP (mode_line_string_face
))
18804 Lisp_Object face
= Fplist_get (props
, Qface
);
18805 props
= Fcopy_sequence (props
);
18807 face
= mode_line_string_face
;
18809 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18810 props
= Fplist_put (props
, Qface
, face
);
18812 Fadd_text_properties (make_number (0), make_number (len
),
18813 props
, lisp_string
);
18817 len
= XFASTINT (Flength (lisp_string
));
18818 if (precision
> 0 && len
> precision
)
18821 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18824 if (!NILP (mode_line_string_face
))
18828 props
= Ftext_properties_at (make_number (0), lisp_string
);
18829 face
= Fplist_get (props
, Qface
);
18831 face
= mode_line_string_face
;
18833 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18834 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18836 lisp_string
= Fcopy_sequence (lisp_string
);
18839 Fadd_text_properties (make_number (0), make_number (len
),
18840 props
, lisp_string
);
18845 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18849 if (field_width
> len
)
18851 field_width
-= len
;
18852 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18854 Fadd_text_properties (make_number (0), make_number (field_width
),
18855 props
, lisp_string
);
18856 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18864 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18866 doc
: /* Format a string out of a mode line format specification.
18867 First arg FORMAT specifies the mode line format (see `mode-line-format'
18868 for details) to use.
18870 By default, the format is evaluated for the currently selected window.
18872 Optional second arg FACE specifies the face property to put on all
18873 characters for which no face is specified. The value nil means the
18874 default face. The value t means whatever face the window's mode line
18875 currently uses (either `mode-line' or `mode-line-inactive',
18876 depending on whether the window is the selected window or not).
18877 An integer value means the value string has no text
18880 Optional third and fourth args WINDOW and BUFFER specify the window
18881 and buffer to use as the context for the formatting (defaults
18882 are the selected window and the WINDOW's buffer). */)
18883 (Lisp_Object format
, Lisp_Object face
,
18884 Lisp_Object window
, Lisp_Object buffer
)
18889 struct buffer
*old_buffer
= NULL
;
18891 int no_props
= INTEGERP (face
);
18892 int count
= SPECPDL_INDEX ();
18894 int string_start
= 0;
18897 window
= selected_window
;
18898 CHECK_WINDOW (window
);
18899 w
= XWINDOW (window
);
18902 buffer
= w
->buffer
;
18903 CHECK_BUFFER (buffer
);
18905 /* Make formatting the modeline a non-op when noninteractive, otherwise
18906 there will be problems later caused by a partially initialized frame. */
18907 if (NILP (format
) || noninteractive
)
18908 return empty_unibyte_string
;
18913 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18914 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18915 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18916 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18917 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18918 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18919 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18922 if (XBUFFER (buffer
) != current_buffer
)
18923 old_buffer
= current_buffer
;
18925 /* Save things including mode_line_proptrans_alist,
18926 and set that to nil so that we don't alter the outer value. */
18927 record_unwind_protect (unwind_format_mode_line
,
18928 format_mode_line_unwind_data
18929 (old_buffer
, selected_window
, 1));
18930 mode_line_proptrans_alist
= Qnil
;
18932 Fselect_window (window
, Qt
);
18934 set_buffer_internal_1 (XBUFFER (buffer
));
18936 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18940 mode_line_target
= MODE_LINE_NOPROP
;
18941 mode_line_string_face_prop
= Qnil
;
18942 mode_line_string_list
= Qnil
;
18943 string_start
= MODE_LINE_NOPROP_LEN (0);
18947 mode_line_target
= MODE_LINE_STRING
;
18948 mode_line_string_list
= Qnil
;
18949 mode_line_string_face
= face
;
18950 mode_line_string_face_prop
18951 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18954 push_kboard (FRAME_KBOARD (it
.f
));
18955 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18960 len
= MODE_LINE_NOPROP_LEN (string_start
);
18961 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18965 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18966 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18967 empty_unibyte_string
);
18970 unbind_to (count
, Qnil
);
18974 /* Write a null-terminated, right justified decimal representation of
18975 the positive integer D to BUF using a minimal field width WIDTH. */
18978 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
18980 register char *p
= buf
;
18988 *p
++ = d
% 10 + '0';
18993 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19004 /* Write a null-terminated, right justified decimal and "human
19005 readable" representation of the nonnegative integer D to BUF using
19006 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19008 static const char power_letter
[] =
19022 pint2hrstr (char *buf
, int width
, int d
)
19024 /* We aim to represent the nonnegative integer D as
19025 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19028 /* -1 means: do not use TENTHS. */
19032 /* Length of QUOTIENT.TENTHS as a string. */
19038 if (1000 <= quotient
)
19040 /* Scale to the appropriate EXPONENT. */
19043 remainder
= quotient
% 1000;
19047 while (1000 <= quotient
);
19049 /* Round to nearest and decide whether to use TENTHS or not. */
19052 tenths
= remainder
/ 100;
19053 if (50 <= remainder
% 100)
19060 if (quotient
== 10)
19068 if (500 <= remainder
)
19070 if (quotient
< 999)
19081 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19082 if (tenths
== -1 && quotient
<= 99)
19089 p
= psuffix
= buf
+ max (width
, length
);
19091 /* Print EXPONENT. */
19093 *psuffix
++ = power_letter
[exponent
];
19096 /* Print TENTHS. */
19099 *--p
= '0' + tenths
;
19103 /* Print QUOTIENT. */
19106 int digit
= quotient
% 10;
19107 *--p
= '0' + digit
;
19109 while ((quotient
/= 10) != 0);
19111 /* Print leading spaces. */
19116 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19117 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19118 type of CODING_SYSTEM. Return updated pointer into BUF. */
19120 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19123 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19126 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19127 const unsigned char *eol_str
;
19129 /* The EOL conversion we are using. */
19130 Lisp_Object eoltype
;
19132 val
= CODING_SYSTEM_SPEC (coding_system
);
19135 if (!VECTORP (val
)) /* Not yet decided. */
19140 eoltype
= eol_mnemonic_undecided
;
19141 /* Don't mention EOL conversion if it isn't decided. */
19146 Lisp_Object eolvalue
;
19148 attrs
= AREF (val
, 0);
19149 eolvalue
= AREF (val
, 2);
19152 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19156 /* The EOL conversion that is normal on this system. */
19158 if (NILP (eolvalue
)) /* Not yet decided. */
19159 eoltype
= eol_mnemonic_undecided
;
19160 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19161 eoltype
= eol_mnemonic_undecided
;
19162 else /* eolvalue is Qunix, Qdos, or Qmac. */
19163 eoltype
= (EQ (eolvalue
, Qunix
)
19164 ? eol_mnemonic_unix
19165 : (EQ (eolvalue
, Qdos
) == 1
19166 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19172 /* Mention the EOL conversion if it is not the usual one. */
19173 if (STRINGP (eoltype
))
19175 eol_str
= SDATA (eoltype
);
19176 eol_str_len
= SBYTES (eoltype
);
19178 else if (CHARACTERP (eoltype
))
19180 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19181 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19186 eol_str
= invalid_eol_type
;
19187 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19189 memcpy (buf
, eol_str
, eol_str_len
);
19190 buf
+= eol_str_len
;
19196 /* Return a string for the output of a mode line %-spec for window W,
19197 generated by character C. PRECISION >= 0 means don't return a
19198 string longer than that value. FIELD_WIDTH > 0 means pad the
19199 string returned with spaces to that value. Return a Lisp string in
19200 *STRING if the resulting string is taken from that Lisp string.
19202 Note we operate on the current buffer for most purposes,
19203 the exception being w->base_line_pos. */
19205 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19207 static const char *
19208 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19209 int precision
, Lisp_Object
*string
)
19212 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19213 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19214 struct buffer
*b
= current_buffer
;
19222 if (!NILP (BVAR (b
, read_only
)))
19224 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19229 /* This differs from %* only for a modified read-only buffer. */
19230 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19232 if (!NILP (BVAR (b
, read_only
)))
19237 /* This differs from %* in ignoring read-only-ness. */
19238 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19250 if (command_loop_level
> 5)
19252 p
= decode_mode_spec_buf
;
19253 for (i
= 0; i
< command_loop_level
; i
++)
19256 return decode_mode_spec_buf
;
19264 if (command_loop_level
> 5)
19266 p
= decode_mode_spec_buf
;
19267 for (i
= 0; i
< command_loop_level
; i
++)
19270 return decode_mode_spec_buf
;
19277 /* Let lots_of_dashes be a string of infinite length. */
19278 if (mode_line_target
== MODE_LINE_NOPROP
||
19279 mode_line_target
== MODE_LINE_STRING
)
19281 if (field_width
<= 0
19282 || field_width
> sizeof (lots_of_dashes
))
19284 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19285 decode_mode_spec_buf
[i
] = '-';
19286 decode_mode_spec_buf
[i
] = '\0';
19287 return decode_mode_spec_buf
;
19290 return lots_of_dashes
;
19294 obj
= BVAR (b
, name
);
19298 /* %c and %l are ignored in `frame-title-format'.
19299 (In redisplay_internal, the frame title is drawn _before_ the
19300 windows are updated, so the stuff which depends on actual
19301 window contents (such as %l) may fail to render properly, or
19302 even crash emacs.) */
19303 if (mode_line_target
== MODE_LINE_TITLE
)
19307 EMACS_INT col
= current_column ();
19308 w
->column_number_displayed
= make_number (col
);
19309 pint2str (decode_mode_spec_buf
, field_width
, col
);
19310 return decode_mode_spec_buf
;
19314 #ifndef SYSTEM_MALLOC
19316 if (NILP (Vmemory_full
))
19319 return "!MEM FULL! ";
19326 /* %F displays the frame name. */
19327 if (!NILP (f
->title
))
19328 return SSDATA (f
->title
);
19329 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19330 return SSDATA (f
->name
);
19334 obj
= BVAR (b
, filename
);
19339 EMACS_INT size
= ZV
- BEGV
;
19340 pint2str (decode_mode_spec_buf
, field_width
, size
);
19341 return decode_mode_spec_buf
;
19346 EMACS_INT size
= ZV
- BEGV
;
19347 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19348 return decode_mode_spec_buf
;
19353 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19354 int topline
, nlines
, height
;
19357 /* %c and %l are ignored in `frame-title-format'. */
19358 if (mode_line_target
== MODE_LINE_TITLE
)
19361 startpos
= XMARKER (w
->start
)->charpos
;
19362 startpos_byte
= marker_byte_position (w
->start
);
19363 height
= WINDOW_TOTAL_LINES (w
);
19365 /* If we decided that this buffer isn't suitable for line numbers,
19366 don't forget that too fast. */
19367 if (EQ (w
->base_line_pos
, w
->buffer
))
19369 /* But do forget it, if the window shows a different buffer now. */
19370 else if (BUFFERP (w
->base_line_pos
))
19371 w
->base_line_pos
= Qnil
;
19373 /* If the buffer is very big, don't waste time. */
19374 if (INTEGERP (Vline_number_display_limit
)
19375 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19377 w
->base_line_pos
= Qnil
;
19378 w
->base_line_number
= Qnil
;
19382 if (INTEGERP (w
->base_line_number
)
19383 && INTEGERP (w
->base_line_pos
)
19384 && XFASTINT (w
->base_line_pos
) <= startpos
)
19386 line
= XFASTINT (w
->base_line_number
);
19387 linepos
= XFASTINT (w
->base_line_pos
);
19388 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19393 linepos
= BUF_BEGV (b
);
19394 linepos_byte
= BUF_BEGV_BYTE (b
);
19397 /* Count lines from base line to window start position. */
19398 nlines
= display_count_lines (linepos
, linepos_byte
,
19402 topline
= nlines
+ line
;
19404 /* Determine a new base line, if the old one is too close
19405 or too far away, or if we did not have one.
19406 "Too close" means it's plausible a scroll-down would
19407 go back past it. */
19408 if (startpos
== BUF_BEGV (b
))
19410 w
->base_line_number
= make_number (topline
);
19411 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19413 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19414 || linepos
== BUF_BEGV (b
))
19416 EMACS_INT limit
= BUF_BEGV (b
);
19417 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19418 EMACS_INT position
;
19419 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19421 if (startpos
- distance
> limit
)
19423 limit
= startpos
- distance
;
19424 limit_byte
= CHAR_TO_BYTE (limit
);
19427 nlines
= display_count_lines (startpos
, startpos_byte
,
19429 - (height
* 2 + 30),
19431 /* If we couldn't find the lines we wanted within
19432 line_number_display_limit_width chars per line,
19433 give up on line numbers for this window. */
19434 if (position
== limit_byte
&& limit
== startpos
- distance
)
19436 w
->base_line_pos
= w
->buffer
;
19437 w
->base_line_number
= Qnil
;
19441 w
->base_line_number
= make_number (topline
- nlines
);
19442 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19445 /* Now count lines from the start pos to point. */
19446 nlines
= display_count_lines (startpos
, startpos_byte
,
19447 PT_BYTE
, PT
, &junk
);
19449 /* Record that we did display the line number. */
19450 line_number_displayed
= 1;
19452 /* Make the string to show. */
19453 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19454 return decode_mode_spec_buf
;
19457 char* p
= decode_mode_spec_buf
;
19458 int pad
= field_width
- 2;
19464 return decode_mode_spec_buf
;
19470 obj
= BVAR (b
, mode_name
);
19474 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19480 EMACS_INT pos
= marker_position (w
->start
);
19481 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19483 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19485 if (pos
<= BUF_BEGV (b
))
19490 else if (pos
<= BUF_BEGV (b
))
19494 if (total
> 1000000)
19495 /* Do it differently for a large value, to avoid overflow. */
19496 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19498 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19499 /* We can't normally display a 3-digit number,
19500 so get us a 2-digit number that is close. */
19503 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19504 return decode_mode_spec_buf
;
19508 /* Display percentage of size above the bottom of the screen. */
19511 EMACS_INT toppos
= marker_position (w
->start
);
19512 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19513 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19515 if (botpos
>= BUF_ZV (b
))
19517 if (toppos
<= BUF_BEGV (b
))
19524 if (total
> 1000000)
19525 /* Do it differently for a large value, to avoid overflow. */
19526 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19528 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19529 /* We can't normally display a 3-digit number,
19530 so get us a 2-digit number that is close. */
19533 if (toppos
<= BUF_BEGV (b
))
19534 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19536 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19537 return decode_mode_spec_buf
;
19542 /* status of process */
19543 obj
= Fget_buffer_process (Fcurrent_buffer ());
19545 return "no process";
19547 obj
= Fsymbol_name (Fprocess_status (obj
));
19553 int count
= inhibit_garbage_collection ();
19554 Lisp_Object val
= call1 (intern ("file-remote-p"),
19555 BVAR (current_buffer
, directory
));
19556 unbind_to (count
, Qnil
);
19564 case 't': /* indicate TEXT or BINARY */
19568 /* coding-system (not including end-of-line format) */
19570 /* coding-system (including end-of-line type) */
19572 int eol_flag
= (c
== 'Z');
19573 char *p
= decode_mode_spec_buf
;
19575 if (! FRAME_WINDOW_P (f
))
19577 /* No need to mention EOL here--the terminal never needs
19578 to do EOL conversion. */
19579 p
= decode_mode_spec_coding (CODING_ID_NAME
19580 (FRAME_KEYBOARD_CODING (f
)->id
),
19582 p
= decode_mode_spec_coding (CODING_ID_NAME
19583 (FRAME_TERMINAL_CODING (f
)->id
),
19586 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19589 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19590 #ifdef subprocesses
19591 obj
= Fget_buffer_process (Fcurrent_buffer ());
19592 if (PROCESSP (obj
))
19594 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19596 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19599 #endif /* subprocesses */
19602 return decode_mode_spec_buf
;
19609 return SSDATA (obj
);
19616 /* Count up to COUNT lines starting from START / START_BYTE.
19617 But don't go beyond LIMIT_BYTE.
19618 Return the number of lines thus found (always nonnegative).
19620 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19623 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19624 EMACS_INT limit_byte
, int count
,
19625 EMACS_INT
*byte_pos_ptr
)
19627 register unsigned char *cursor
;
19628 unsigned char *base
;
19630 register int ceiling
;
19631 register unsigned char *ceiling_addr
;
19632 int orig_count
= count
;
19634 /* If we are not in selective display mode,
19635 check only for newlines. */
19636 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19637 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19641 while (start_byte
< limit_byte
)
19643 ceiling
= BUFFER_CEILING_OF (start_byte
);
19644 ceiling
= min (limit_byte
- 1, ceiling
);
19645 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19646 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19649 if (selective_display
)
19650 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19653 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19656 if (cursor
!= ceiling_addr
)
19660 start_byte
+= cursor
- base
+ 1;
19661 *byte_pos_ptr
= start_byte
;
19665 if (++cursor
== ceiling_addr
)
19671 start_byte
+= cursor
- base
;
19676 while (start_byte
> limit_byte
)
19678 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19679 ceiling
= max (limit_byte
, ceiling
);
19680 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19681 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19684 if (selective_display
)
19685 while (--cursor
!= ceiling_addr
19686 && *cursor
!= '\n' && *cursor
!= 015)
19689 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19692 if (cursor
!= ceiling_addr
)
19696 start_byte
+= cursor
- base
+ 1;
19697 *byte_pos_ptr
= start_byte
;
19698 /* When scanning backwards, we should
19699 not count the newline posterior to which we stop. */
19700 return - orig_count
- 1;
19706 /* Here we add 1 to compensate for the last decrement
19707 of CURSOR, which took it past the valid range. */
19708 start_byte
+= cursor
- base
+ 1;
19712 *byte_pos_ptr
= limit_byte
;
19715 return - orig_count
+ count
;
19716 return orig_count
- count
;
19722 /***********************************************************************
19724 ***********************************************************************/
19726 /* Display a NUL-terminated string, starting with index START.
19728 If STRING is non-null, display that C string. Otherwise, the Lisp
19729 string LISP_STRING is displayed. There's a case that STRING is
19730 non-null and LISP_STRING is not nil. It means STRING is a string
19731 data of LISP_STRING. In that case, we display LISP_STRING while
19732 ignoring its text properties.
19734 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19735 FACE_STRING. Display STRING or LISP_STRING with the face at
19736 FACE_STRING_POS in FACE_STRING:
19738 Display the string in the environment given by IT, but use the
19739 standard display table, temporarily.
19741 FIELD_WIDTH is the minimum number of output glyphs to produce.
19742 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19743 with spaces. If STRING has more characters, more than FIELD_WIDTH
19744 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19746 PRECISION is the maximum number of characters to output from
19747 STRING. PRECISION < 0 means don't truncate the string.
19749 This is roughly equivalent to printf format specifiers:
19751 FIELD_WIDTH PRECISION PRINTF
19752 ----------------------------------------
19758 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19759 display them, and < 0 means obey the current buffer's value of
19760 enable_multibyte_characters.
19762 Value is the number of columns displayed. */
19765 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19766 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19767 int field_width
, int precision
, int max_x
, int multibyte
)
19769 int hpos_at_start
= it
->hpos
;
19770 int saved_face_id
= it
->face_id
;
19771 struct glyph_row
*row
= it
->glyph_row
;
19773 /* Initialize the iterator IT for iteration over STRING beginning
19774 with index START. */
19775 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19776 precision
, field_width
, multibyte
);
19777 if (string
&& STRINGP (lisp_string
))
19778 /* LISP_STRING is the one returned by decode_mode_spec. We should
19779 ignore its text properties. */
19780 it
->stop_charpos
= -1;
19782 /* If displaying STRING, set up the face of the iterator
19783 from LISP_STRING, if that's given. */
19784 if (STRINGP (face_string
))
19790 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19791 0, it
->region_beg_charpos
,
19792 it
->region_end_charpos
,
19793 &endptr
, it
->base_face_id
, 0);
19794 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19795 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19798 /* Set max_x to the maximum allowed X position. Don't let it go
19799 beyond the right edge of the window. */
19801 max_x
= it
->last_visible_x
;
19803 max_x
= min (max_x
, it
->last_visible_x
);
19805 /* Skip over display elements that are not visible. because IT->w is
19807 if (it
->current_x
< it
->first_visible_x
)
19808 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19809 MOVE_TO_POS
| MOVE_TO_X
);
19811 row
->ascent
= it
->max_ascent
;
19812 row
->height
= it
->max_ascent
+ it
->max_descent
;
19813 row
->phys_ascent
= it
->max_phys_ascent
;
19814 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19815 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19817 /* This condition is for the case that we are called with current_x
19818 past last_visible_x. */
19819 while (it
->current_x
< max_x
)
19821 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19823 /* Get the next display element. */
19824 if (!get_next_display_element (it
))
19827 /* Produce glyphs. */
19828 x_before
= it
->current_x
;
19829 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19830 PRODUCE_GLYPHS (it
);
19832 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19835 while (i
< nglyphs
)
19837 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19839 if (it
->line_wrap
!= TRUNCATE
19840 && x
+ glyph
->pixel_width
> max_x
)
19842 /* End of continued line or max_x reached. */
19843 if (CHAR_GLYPH_PADDING_P (*glyph
))
19845 /* A wide character is unbreakable. */
19846 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19847 it
->current_x
= x_before
;
19851 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19856 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19858 /* Glyph is at least partially visible. */
19860 if (x
< it
->first_visible_x
)
19861 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19865 /* Glyph is off the left margin of the display area.
19866 Should not happen. */
19870 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19871 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19872 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19873 row
->phys_height
= max (row
->phys_height
,
19874 it
->max_phys_ascent
+ it
->max_phys_descent
);
19875 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19876 it
->max_extra_line_spacing
);
19877 x
+= glyph
->pixel_width
;
19881 /* Stop if max_x reached. */
19885 /* Stop at line ends. */
19886 if (ITERATOR_AT_END_OF_LINE_P (it
))
19888 it
->continuation_lines_width
= 0;
19892 set_iterator_to_next (it
, 1);
19894 /* Stop if truncating at the right edge. */
19895 if (it
->line_wrap
== TRUNCATE
19896 && it
->current_x
>= it
->last_visible_x
)
19898 /* Add truncation mark, but don't do it if the line is
19899 truncated at a padding space. */
19900 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19902 if (!FRAME_WINDOW_P (it
->f
))
19906 if (it
->current_x
> it
->last_visible_x
)
19908 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19909 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19911 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19913 row
->used
[TEXT_AREA
] = ii
;
19914 produce_special_glyphs (it
, IT_TRUNCATION
);
19917 produce_special_glyphs (it
, IT_TRUNCATION
);
19919 it
->glyph_row
->truncated_on_right_p
= 1;
19925 /* Maybe insert a truncation at the left. */
19926 if (it
->first_visible_x
19927 && IT_CHARPOS (*it
) > 0)
19929 if (!FRAME_WINDOW_P (it
->f
))
19930 insert_left_trunc_glyphs (it
);
19931 it
->glyph_row
->truncated_on_left_p
= 1;
19934 it
->face_id
= saved_face_id
;
19936 /* Value is number of columns displayed. */
19937 return it
->hpos
- hpos_at_start
;
19942 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19943 appears as an element of LIST or as the car of an element of LIST.
19944 If PROPVAL is a list, compare each element against LIST in that
19945 way, and return 1/2 if any element of PROPVAL is found in LIST.
19946 Otherwise return 0. This function cannot quit.
19947 The return value is 2 if the text is invisible but with an ellipsis
19948 and 1 if it's invisible and without an ellipsis. */
19951 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19953 register Lisp_Object tail
, proptail
;
19955 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19957 register Lisp_Object tem
;
19959 if (EQ (propval
, tem
))
19961 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19962 return NILP (XCDR (tem
)) ? 1 : 2;
19965 if (CONSP (propval
))
19967 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19969 Lisp_Object propelt
;
19970 propelt
= XCAR (proptail
);
19971 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19973 register Lisp_Object tem
;
19975 if (EQ (propelt
, tem
))
19977 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19978 return NILP (XCDR (tem
)) ? 1 : 2;
19986 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19987 doc
: /* Non-nil if the property makes the text invisible.
19988 POS-OR-PROP can be a marker or number, in which case it is taken to be
19989 a position in the current buffer and the value of the `invisible' property
19990 is checked; or it can be some other value, which is then presumed to be the
19991 value of the `invisible' property of the text of interest.
19992 The non-nil value returned can be t for truly invisible text or something
19993 else if the text is replaced by an ellipsis. */)
19994 (Lisp_Object pos_or_prop
)
19997 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19998 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20000 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20001 return (invis
== 0 ? Qnil
20003 : make_number (invis
));
20006 /* Calculate a width or height in pixels from a specification using
20007 the following elements:
20010 NUM - a (fractional) multiple of the default font width/height
20011 (NUM) - specifies exactly NUM pixels
20012 UNIT - a fixed number of pixels, see below.
20013 ELEMENT - size of a display element in pixels, see below.
20014 (NUM . SPEC) - equals NUM * SPEC
20015 (+ SPEC SPEC ...) - add pixel values
20016 (- SPEC SPEC ...) - subtract pixel values
20017 (- SPEC) - negate pixel value
20020 INT or FLOAT - a number constant
20021 SYMBOL - use symbol's (buffer local) variable binding.
20024 in - pixels per inch *)
20025 mm - pixels per 1/1000 meter *)
20026 cm - pixels per 1/100 meter *)
20027 width - width of current font in pixels.
20028 height - height of current font in pixels.
20030 *) using the ratio(s) defined in display-pixels-per-inch.
20034 left-fringe - left fringe width in pixels
20035 right-fringe - right fringe width in pixels
20037 left-margin - left margin width in pixels
20038 right-margin - right margin width in pixels
20040 scroll-bar - scroll-bar area width in pixels
20044 Pixels corresponding to 5 inches:
20047 Total width of non-text areas on left side of window (if scroll-bar is on left):
20048 '(space :width (+ left-fringe left-margin scroll-bar))
20050 Align to first text column (in header line):
20051 '(space :align-to 0)
20053 Align to middle of text area minus half the width of variable `my-image'
20054 containing a loaded image:
20055 '(space :align-to (0.5 . (- text my-image)))
20057 Width of left margin minus width of 1 character in the default font:
20058 '(space :width (- left-margin 1))
20060 Width of left margin minus width of 2 characters in the current font:
20061 '(space :width (- left-margin (2 . width)))
20063 Center 1 character over left-margin (in header line):
20064 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20066 Different ways to express width of left fringe plus left margin minus one pixel:
20067 '(space :width (- (+ left-fringe left-margin) (1)))
20068 '(space :width (+ left-fringe left-margin (- (1))))
20069 '(space :width (+ left-fringe left-margin (-1)))
20073 #define NUMVAL(X) \
20074 ((INTEGERP (X) || FLOATP (X)) \
20079 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20080 struct font
*font
, int width_p
, int *align_to
)
20084 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20085 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20088 return OK_PIXELS (0);
20090 xassert (FRAME_LIVE_P (it
->f
));
20092 if (SYMBOLP (prop
))
20094 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20096 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20098 if (unit
[0] == 'i' && unit
[1] == 'n')
20100 else if (unit
[0] == 'm' && unit
[1] == 'm')
20102 else if (unit
[0] == 'c' && unit
[1] == 'm')
20109 #ifdef HAVE_WINDOW_SYSTEM
20110 if (FRAME_WINDOW_P (it
->f
)
20112 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20113 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20115 return OK_PIXELS (ppi
/ pixels
);
20118 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20119 || (CONSP (Vdisplay_pixels_per_inch
)
20121 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20122 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20124 return OK_PIXELS (ppi
/ pixels
);
20130 #ifdef HAVE_WINDOW_SYSTEM
20131 if (EQ (prop
, Qheight
))
20132 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20133 if (EQ (prop
, Qwidth
))
20134 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20136 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20137 return OK_PIXELS (1);
20140 if (EQ (prop
, Qtext
))
20141 return OK_PIXELS (width_p
20142 ? window_box_width (it
->w
, TEXT_AREA
)
20143 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20145 if (align_to
&& *align_to
< 0)
20148 if (EQ (prop
, Qleft
))
20149 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20150 if (EQ (prop
, Qright
))
20151 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20152 if (EQ (prop
, Qcenter
))
20153 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20154 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20155 if (EQ (prop
, Qleft_fringe
))
20156 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20157 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20158 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20159 if (EQ (prop
, Qright_fringe
))
20160 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20161 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20162 : window_box_right_offset (it
->w
, TEXT_AREA
));
20163 if (EQ (prop
, Qleft_margin
))
20164 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20165 if (EQ (prop
, Qright_margin
))
20166 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20167 if (EQ (prop
, Qscroll_bar
))
20168 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20170 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20171 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20172 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20177 if (EQ (prop
, Qleft_fringe
))
20178 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20179 if (EQ (prop
, Qright_fringe
))
20180 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20181 if (EQ (prop
, Qleft_margin
))
20182 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20183 if (EQ (prop
, Qright_margin
))
20184 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20185 if (EQ (prop
, Qscroll_bar
))
20186 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20189 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20192 if (INTEGERP (prop
) || FLOATP (prop
))
20194 int base_unit
= (width_p
20195 ? FRAME_COLUMN_WIDTH (it
->f
)
20196 : FRAME_LINE_HEIGHT (it
->f
));
20197 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20202 Lisp_Object car
= XCAR (prop
);
20203 Lisp_Object cdr
= XCDR (prop
);
20207 #ifdef HAVE_WINDOW_SYSTEM
20208 if (FRAME_WINDOW_P (it
->f
)
20209 && valid_image_p (prop
))
20211 int id
= lookup_image (it
->f
, prop
);
20212 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20214 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20217 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20223 while (CONSP (cdr
))
20225 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20226 font
, width_p
, align_to
))
20229 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20234 if (EQ (car
, Qminus
))
20236 return OK_PIXELS (pixels
);
20239 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20242 if (INTEGERP (car
) || FLOATP (car
))
20245 pixels
= XFLOATINT (car
);
20247 return OK_PIXELS (pixels
);
20248 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20249 font
, width_p
, align_to
))
20250 return OK_PIXELS (pixels
* fact
);
20261 /***********************************************************************
20263 ***********************************************************************/
20265 #ifdef HAVE_WINDOW_SYSTEM
20270 dump_glyph_string (s
)
20271 struct glyph_string
*s
;
20273 fprintf (stderr
, "glyph string\n");
20274 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20275 s
->x
, s
->y
, s
->width
, s
->height
);
20276 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20277 fprintf (stderr
, " hl = %d\n", s
->hl
);
20278 fprintf (stderr
, " left overhang = %d, right = %d\n",
20279 s
->left_overhang
, s
->right_overhang
);
20280 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20281 fprintf (stderr
, " extends to end of line = %d\n",
20282 s
->extends_to_end_of_line_p
);
20283 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20284 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20287 #endif /* GLYPH_DEBUG */
20289 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20290 of XChar2b structures for S; it can't be allocated in
20291 init_glyph_string because it must be allocated via `alloca'. W
20292 is the window on which S is drawn. ROW and AREA are the glyph row
20293 and area within the row from which S is constructed. START is the
20294 index of the first glyph structure covered by S. HL is a
20295 face-override for drawing S. */
20298 #define OPTIONAL_HDC(hdc) HDC hdc,
20299 #define DECLARE_HDC(hdc) HDC hdc;
20300 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20301 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20304 #ifndef OPTIONAL_HDC
20305 #define OPTIONAL_HDC(hdc)
20306 #define DECLARE_HDC(hdc)
20307 #define ALLOCATE_HDC(hdc, f)
20308 #define RELEASE_HDC(hdc, f)
20312 init_glyph_string (struct glyph_string
*s
,
20314 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20315 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20317 memset (s
, 0, sizeof *s
);
20319 s
->f
= XFRAME (w
->frame
);
20323 s
->display
= FRAME_X_DISPLAY (s
->f
);
20324 s
->window
= FRAME_X_WINDOW (s
->f
);
20325 s
->char2b
= char2b
;
20329 s
->first_glyph
= row
->glyphs
[area
] + start
;
20330 s
->height
= row
->height
;
20331 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20332 s
->ybase
= s
->y
+ row
->ascent
;
20336 /* Append the list of glyph strings with head H and tail T to the list
20337 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20340 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20341 struct glyph_string
*h
, struct glyph_string
*t
)
20355 /* Prepend the list of glyph strings with head H and tail T to the
20356 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20360 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20361 struct glyph_string
*h
, struct glyph_string
*t
)
20375 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20376 Set *HEAD and *TAIL to the resulting list. */
20379 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20380 struct glyph_string
*s
)
20382 s
->next
= s
->prev
= NULL
;
20383 append_glyph_string_lists (head
, tail
, s
, s
);
20387 /* Get face and two-byte form of character C in face FACE_ID on frame
20388 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20389 means we want to display multibyte text. DISPLAY_P non-zero means
20390 make sure that X resources for the face returned are allocated.
20391 Value is a pointer to a realized face that is ready for display if
20392 DISPLAY_P is non-zero. */
20394 static INLINE
struct face
*
20395 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20396 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20398 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20402 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20404 if (code
!= FONT_INVALID_CODE
)
20405 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20407 STORE_XCHAR2B (char2b
, 0, 0);
20410 /* Make sure X resources of the face are allocated. */
20411 #ifdef HAVE_X_WINDOWS
20415 xassert (face
!= NULL
);
20416 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20423 /* Get face and two-byte form of character glyph GLYPH on frame F.
20424 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20425 a pointer to a realized face that is ready for display. */
20427 static INLINE
struct face
*
20428 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20429 XChar2b
*char2b
, int *two_byte_p
)
20433 xassert (glyph
->type
== CHAR_GLYPH
);
20434 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20443 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20444 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20446 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20448 if (code
!= FONT_INVALID_CODE
)
20449 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20451 STORE_XCHAR2B (char2b
, 0, 0);
20454 /* Make sure X resources of the face are allocated. */
20455 xassert (face
!= NULL
);
20456 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20461 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20462 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20465 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20469 if (CHAR_BYTE8_P (c
))
20470 code
= CHAR_TO_BYTE8 (c
);
20472 code
= font
->driver
->encode_char (font
, c
);
20474 if (code
== FONT_INVALID_CODE
)
20476 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20481 /* Fill glyph string S with composition components specified by S->cmp.
20483 BASE_FACE is the base face of the composition.
20484 S->cmp_from is the index of the first component for S.
20486 OVERLAPS non-zero means S should draw the foreground only, and use
20487 its physical height for clipping. See also draw_glyphs.
20489 Value is the index of a component not in S. */
20492 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20496 /* For all glyphs of this composition, starting at the offset
20497 S->cmp_from, until we reach the end of the definition or encounter a
20498 glyph that requires the different face, add it to S. */
20503 s
->for_overlaps
= overlaps
;
20506 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20508 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20512 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20515 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20516 s
->char2b
+ i
, 1, 1);
20522 s
->font
= s
->face
->font
;
20524 else if (s
->face
!= face
)
20532 /* All glyph strings for the same composition has the same width,
20533 i.e. the width set for the first component of the composition. */
20534 s
->width
= s
->first_glyph
->pixel_width
;
20536 /* If the specified font could not be loaded, use the frame's
20537 default font, but record the fact that we couldn't load it in
20538 the glyph string so that we can draw rectangles for the
20539 characters of the glyph string. */
20540 if (s
->font
== NULL
)
20542 s
->font_not_found_p
= 1;
20543 s
->font
= FRAME_FONT (s
->f
);
20546 /* Adjust base line for subscript/superscript text. */
20547 s
->ybase
+= s
->first_glyph
->voffset
;
20549 /* This glyph string must always be drawn with 16-bit functions. */
20556 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20557 int start
, int end
, int overlaps
)
20559 struct glyph
*glyph
, *last
;
20560 Lisp_Object lgstring
;
20563 s
->for_overlaps
= overlaps
;
20564 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20565 last
= s
->row
->glyphs
[s
->area
] + end
;
20566 s
->cmp_id
= glyph
->u
.cmp
.id
;
20567 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20568 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20569 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20570 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20571 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20573 while (glyph
< last
20574 && glyph
->u
.cmp
.automatic
20575 && glyph
->u
.cmp
.id
== s
->cmp_id
20576 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20577 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20579 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20581 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20582 unsigned code
= LGLYPH_CODE (lglyph
);
20584 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20586 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20587 return glyph
- s
->row
->glyphs
[s
->area
];
20591 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20592 See the comment of fill_glyph_string for arguments.
20593 Value is the index of the first glyph not in S. */
20597 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20598 int start
, int end
, int overlaps
)
20600 struct glyph
*glyph
, *last
;
20603 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20604 s
->for_overlaps
= overlaps
;
20605 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20606 last
= s
->row
->glyphs
[s
->area
] + end
;
20607 voffset
= glyph
->voffset
;
20608 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20609 s
->font
= s
->face
->font
;
20611 s
->width
= glyph
->pixel_width
;
20613 while (glyph
< last
20614 && glyph
->type
== GLYPHLESS_GLYPH
20615 && glyph
->voffset
== voffset
20616 && glyph
->face_id
== face_id
)
20619 s
->width
+= glyph
->pixel_width
;
20622 s
->ybase
+= voffset
;
20623 return glyph
- s
->row
->glyphs
[s
->area
];
20627 /* Fill glyph string S from a sequence of character glyphs.
20629 FACE_ID is the face id of the string. START is the index of the
20630 first glyph to consider, END is the index of the last + 1.
20631 OVERLAPS non-zero means S should draw the foreground only, and use
20632 its physical height for clipping. See also draw_glyphs.
20634 Value is the index of the first glyph not in S. */
20637 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20638 int start
, int end
, int overlaps
)
20640 struct glyph
*glyph
, *last
;
20642 int glyph_not_available_p
;
20644 xassert (s
->f
== XFRAME (s
->w
->frame
));
20645 xassert (s
->nchars
== 0);
20646 xassert (start
>= 0 && end
> start
);
20648 s
->for_overlaps
= overlaps
;
20649 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20650 last
= s
->row
->glyphs
[s
->area
] + end
;
20651 voffset
= glyph
->voffset
;
20652 s
->padding_p
= glyph
->padding_p
;
20653 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20655 while (glyph
< last
20656 && glyph
->type
== CHAR_GLYPH
20657 && glyph
->voffset
== voffset
20658 /* Same face id implies same font, nowadays. */
20659 && glyph
->face_id
== face_id
20660 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20664 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20665 s
->char2b
+ s
->nchars
,
20667 s
->two_byte_p
= two_byte_p
;
20669 xassert (s
->nchars
<= end
- start
);
20670 s
->width
+= glyph
->pixel_width
;
20671 if (glyph
++->padding_p
!= s
->padding_p
)
20675 s
->font
= s
->face
->font
;
20677 /* If the specified font could not be loaded, use the frame's font,
20678 but record the fact that we couldn't load it in
20679 S->font_not_found_p so that we can draw rectangles for the
20680 characters of the glyph string. */
20681 if (s
->font
== NULL
|| glyph_not_available_p
)
20683 s
->font_not_found_p
= 1;
20684 s
->font
= FRAME_FONT (s
->f
);
20687 /* Adjust base line for subscript/superscript text. */
20688 s
->ybase
+= voffset
;
20690 xassert (s
->face
&& s
->face
->gc
);
20691 return glyph
- s
->row
->glyphs
[s
->area
];
20695 /* Fill glyph string S from image glyph S->first_glyph. */
20698 fill_image_glyph_string (struct glyph_string
*s
)
20700 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20701 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20703 s
->slice
= s
->first_glyph
->slice
.img
;
20704 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20705 s
->font
= s
->face
->font
;
20706 s
->width
= s
->first_glyph
->pixel_width
;
20708 /* Adjust base line for subscript/superscript text. */
20709 s
->ybase
+= s
->first_glyph
->voffset
;
20713 /* Fill glyph string S from a sequence of stretch glyphs.
20715 ROW is the glyph row in which the glyphs are found, AREA is the
20716 area within the row. START is the index of the first glyph to
20717 consider, END is the index of the last + 1.
20719 Value is the index of the first glyph not in S. */
20722 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20723 enum glyph_row_area area
, int start
, int end
)
20725 struct glyph
*glyph
, *last
;
20726 int voffset
, face_id
;
20728 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20730 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20731 last
= s
->row
->glyphs
[s
->area
] + end
;
20732 face_id
= glyph
->face_id
;
20733 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20734 s
->font
= s
->face
->font
;
20735 s
->width
= glyph
->pixel_width
;
20737 voffset
= glyph
->voffset
;
20741 && glyph
->type
== STRETCH_GLYPH
20742 && glyph
->voffset
== voffset
20743 && glyph
->face_id
== face_id
);
20745 s
->width
+= glyph
->pixel_width
;
20747 /* Adjust base line for subscript/superscript text. */
20748 s
->ybase
+= voffset
;
20750 /* The case that face->gc == 0 is handled when drawing the glyph
20751 string by calling PREPARE_FACE_FOR_DISPLAY. */
20753 return glyph
- s
->row
->glyphs
[s
->area
];
20756 static struct font_metrics
*
20757 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20759 static struct font_metrics metrics
;
20760 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20762 if (! font
|| code
== FONT_INVALID_CODE
)
20764 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20769 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20770 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20771 assumed to be zero. */
20774 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20776 *left
= *right
= 0;
20778 if (glyph
->type
== CHAR_GLYPH
)
20782 struct font_metrics
*pcm
;
20784 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20785 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20787 if (pcm
->rbearing
> pcm
->width
)
20788 *right
= pcm
->rbearing
- pcm
->width
;
20789 if (pcm
->lbearing
< 0)
20790 *left
= -pcm
->lbearing
;
20793 else if (glyph
->type
== COMPOSITE_GLYPH
)
20795 if (! glyph
->u
.cmp
.automatic
)
20797 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20799 if (cmp
->rbearing
> cmp
->pixel_width
)
20800 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20801 if (cmp
->lbearing
< 0)
20802 *left
= - cmp
->lbearing
;
20806 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20807 struct font_metrics metrics
;
20809 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20810 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20811 if (metrics
.rbearing
> metrics
.width
)
20812 *right
= metrics
.rbearing
- metrics
.width
;
20813 if (metrics
.lbearing
< 0)
20814 *left
= - metrics
.lbearing
;
20820 /* Return the index of the first glyph preceding glyph string S that
20821 is overwritten by S because of S's left overhang. Value is -1
20822 if no glyphs are overwritten. */
20825 left_overwritten (struct glyph_string
*s
)
20829 if (s
->left_overhang
)
20832 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20833 int first
= s
->first_glyph
- glyphs
;
20835 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20836 x
-= glyphs
[i
].pixel_width
;
20847 /* Return the index of the first glyph preceding glyph string S that
20848 is overwriting S because of its right overhang. Value is -1 if no
20849 glyph in front of S overwrites S. */
20852 left_overwriting (struct glyph_string
*s
)
20855 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20856 int first
= s
->first_glyph
- glyphs
;
20860 for (i
= first
- 1; i
>= 0; --i
)
20863 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20866 x
-= glyphs
[i
].pixel_width
;
20873 /* Return the index of the last glyph following glyph string S that is
20874 overwritten by S because of S's right overhang. Value is -1 if
20875 no such glyph is found. */
20878 right_overwritten (struct glyph_string
*s
)
20882 if (s
->right_overhang
)
20885 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20886 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20887 int end
= s
->row
->used
[s
->area
];
20889 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20890 x
+= glyphs
[i
].pixel_width
;
20899 /* Return the index of the last glyph following glyph string S that
20900 overwrites S because of its left overhang. Value is negative
20901 if no such glyph is found. */
20904 right_overwriting (struct glyph_string
*s
)
20907 int end
= s
->row
->used
[s
->area
];
20908 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20909 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20913 for (i
= first
; i
< end
; ++i
)
20916 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20919 x
+= glyphs
[i
].pixel_width
;
20926 /* Set background width of glyph string S. START is the index of the
20927 first glyph following S. LAST_X is the right-most x-position + 1
20928 in the drawing area. */
20931 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20933 /* If the face of this glyph string has to be drawn to the end of
20934 the drawing area, set S->extends_to_end_of_line_p. */
20936 if (start
== s
->row
->used
[s
->area
]
20937 && s
->area
== TEXT_AREA
20938 && ((s
->row
->fill_line_p
20939 && (s
->hl
== DRAW_NORMAL_TEXT
20940 || s
->hl
== DRAW_IMAGE_RAISED
20941 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20942 || s
->hl
== DRAW_MOUSE_FACE
))
20943 s
->extends_to_end_of_line_p
= 1;
20945 /* If S extends its face to the end of the line, set its
20946 background_width to the distance to the right edge of the drawing
20948 if (s
->extends_to_end_of_line_p
)
20949 s
->background_width
= last_x
- s
->x
+ 1;
20951 s
->background_width
= s
->width
;
20955 /* Compute overhangs and x-positions for glyph string S and its
20956 predecessors, or successors. X is the starting x-position for S.
20957 BACKWARD_P non-zero means process predecessors. */
20960 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20966 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20967 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20977 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20978 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20988 /* The following macros are only called from draw_glyphs below.
20989 They reference the following parameters of that function directly:
20990 `w', `row', `area', and `overlap_p'
20991 as well as the following local variables:
20992 `s', `f', and `hdc' (in W32) */
20995 /* On W32, silently add local `hdc' variable to argument list of
20996 init_glyph_string. */
20997 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20998 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21000 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21001 init_glyph_string (s, char2b, w, row, area, start, hl)
21004 /* Add a glyph string for a stretch glyph to the list of strings
21005 between HEAD and TAIL. START is the index of the stretch glyph in
21006 row area AREA of glyph row ROW. END is the index of the last glyph
21007 in that glyph row area. X is the current output position assigned
21008 to the new glyph string constructed. HL overrides that face of the
21009 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21010 is the right-most x-position of the drawing area. */
21012 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21013 and below -- keep them on one line. */
21014 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21017 s = (struct glyph_string *) alloca (sizeof *s); \
21018 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21019 START = fill_stretch_glyph_string (s, row, area, START, END); \
21020 append_glyph_string (&HEAD, &TAIL, s); \
21026 /* Add a glyph string for an image glyph to the list of strings
21027 between HEAD and TAIL. START is the index of the image glyph in
21028 row area AREA of glyph row ROW. END is the index of the last glyph
21029 in that glyph row area. X is the current output position assigned
21030 to the new glyph string constructed. HL overrides that face of the
21031 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21032 is the right-most x-position of the drawing area. */
21034 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21037 s = (struct glyph_string *) alloca (sizeof *s); \
21038 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21039 fill_image_glyph_string (s); \
21040 append_glyph_string (&HEAD, &TAIL, s); \
21047 /* Add a glyph string for a sequence of character glyphs to the list
21048 of strings between HEAD and TAIL. START is the index of the first
21049 glyph in row area AREA of glyph row ROW that is part of the new
21050 glyph string. END is the index of the last glyph in that glyph row
21051 area. X is the current output position assigned to the new glyph
21052 string constructed. HL overrides that face of the glyph; e.g. it
21053 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21054 right-most x-position of the drawing area. */
21056 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21062 face_id = (row)->glyphs[area][START].face_id; \
21064 s = (struct glyph_string *) alloca (sizeof *s); \
21065 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21066 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21067 append_glyph_string (&HEAD, &TAIL, s); \
21069 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21074 /* Add a glyph string for a composite sequence to the list of strings
21075 between HEAD and TAIL. START is the index of the first glyph in
21076 row area AREA of glyph row ROW that is part of the new glyph
21077 string. END is the index of the last glyph in that glyph row area.
21078 X is the current output position assigned to the new glyph string
21079 constructed. HL overrides that face of the glyph; e.g. it is
21080 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21081 x-position of the drawing area. */
21083 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21085 int face_id = (row)->glyphs[area][START].face_id; \
21086 struct face *base_face = FACE_FROM_ID (f, face_id); \
21087 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21088 struct composition *cmp = composition_table[cmp_id]; \
21090 struct glyph_string *first_s; \
21093 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21095 /* Make glyph_strings for each glyph sequence that is drawable by \
21096 the same face, and append them to HEAD/TAIL. */ \
21097 for (n = 0; n < cmp->glyph_len;) \
21099 s = (struct glyph_string *) alloca (sizeof *s); \
21100 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21101 append_glyph_string (&(HEAD), &(TAIL), s); \
21107 n = fill_composite_glyph_string (s, base_face, overlaps); \
21115 /* Add a glyph string for a glyph-string sequence to the list of strings
21116 between HEAD and TAIL. */
21118 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21122 Lisp_Object gstring; \
21124 face_id = (row)->glyphs[area][START].face_id; \
21125 gstring = (composition_gstring_from_id \
21126 ((row)->glyphs[area][START].u.cmp.id)); \
21127 s = (struct glyph_string *) alloca (sizeof *s); \
21128 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21129 * LGSTRING_GLYPH_LEN (gstring)); \
21130 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21131 append_glyph_string (&(HEAD), &(TAIL), s); \
21133 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21137 /* Add a glyph string for a sequence of glyphless character's glyphs
21138 to the list of strings between HEAD and TAIL. The meanings of
21139 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21141 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21146 face_id = (row)->glyphs[area][START].face_id; \
21148 s = (struct glyph_string *) alloca (sizeof *s); \
21149 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21150 append_glyph_string (&HEAD, &TAIL, s); \
21152 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21158 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21159 of AREA of glyph row ROW on window W between indices START and END.
21160 HL overrides the face for drawing glyph strings, e.g. it is
21161 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21162 x-positions of the drawing area.
21164 This is an ugly monster macro construct because we must use alloca
21165 to allocate glyph strings (because draw_glyphs can be called
21166 asynchronously). */
21168 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21171 HEAD = TAIL = NULL; \
21172 while (START < END) \
21174 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21175 switch (first_glyph->type) \
21178 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21182 case COMPOSITE_GLYPH: \
21183 if (first_glyph->u.cmp.automatic) \
21184 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21187 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21191 case STRETCH_GLYPH: \
21192 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21196 case IMAGE_GLYPH: \
21197 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21201 case GLYPHLESS_GLYPH: \
21202 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21212 set_glyph_string_background_width (s, START, LAST_X); \
21219 /* Draw glyphs between START and END in AREA of ROW on window W,
21220 starting at x-position X. X is relative to AREA in W. HL is a
21221 face-override with the following meaning:
21223 DRAW_NORMAL_TEXT draw normally
21224 DRAW_CURSOR draw in cursor face
21225 DRAW_MOUSE_FACE draw in mouse face.
21226 DRAW_INVERSE_VIDEO draw in mode line face
21227 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21228 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21230 If OVERLAPS is non-zero, draw only the foreground of characters and
21231 clip to the physical height of ROW. Non-zero value also defines
21232 the overlapping part to be drawn:
21234 OVERLAPS_PRED overlap with preceding rows
21235 OVERLAPS_SUCC overlap with succeeding rows
21236 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21237 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21239 Value is the x-position reached, relative to AREA of W. */
21242 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21243 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21244 enum draw_glyphs_face hl
, int overlaps
)
21246 struct glyph_string
*head
, *tail
;
21247 struct glyph_string
*s
;
21248 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21249 int i
, j
, x_reached
, last_x
, area_left
= 0;
21250 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21253 ALLOCATE_HDC (hdc
, f
);
21255 /* Let's rather be paranoid than getting a SEGV. */
21256 end
= min (end
, row
->used
[area
]);
21257 start
= max (0, start
);
21258 start
= min (end
, start
);
21260 /* Translate X to frame coordinates. Set last_x to the right
21261 end of the drawing area. */
21262 if (row
->full_width_p
)
21264 /* X is relative to the left edge of W, without scroll bars
21266 area_left
= WINDOW_LEFT_EDGE_X (w
);
21267 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21271 area_left
= window_box_left (w
, area
);
21272 last_x
= area_left
+ window_box_width (w
, area
);
21276 /* Build a doubly-linked list of glyph_string structures between
21277 head and tail from what we have to draw. Note that the macro
21278 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21279 the reason we use a separate variable `i'. */
21281 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21283 x_reached
= tail
->x
+ tail
->background_width
;
21287 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21288 the row, redraw some glyphs in front or following the glyph
21289 strings built above. */
21290 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21292 struct glyph_string
*h
, *t
;
21293 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21294 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21297 /* If mouse highlighting is on, we may need to draw adjacent
21298 glyphs using mouse-face highlighting. */
21299 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21301 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21303 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21304 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21306 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21308 check_mouse_face
= 1;
21309 mouse_beg_col
= (row
== mouse_beg_row
)
21310 ? hlinfo
->mouse_face_beg_col
: 0;
21311 mouse_end_col
= (row
== mouse_end_row
)
21312 ? hlinfo
->mouse_face_end_col
21313 : row
->used
[TEXT_AREA
];
21317 /* Compute overhangs for all glyph strings. */
21318 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21319 for (s
= head
; s
; s
= s
->next
)
21320 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21322 /* Prepend glyph strings for glyphs in front of the first glyph
21323 string that are overwritten because of the first glyph
21324 string's left overhang. The background of all strings
21325 prepended must be drawn because the first glyph string
21327 i
= left_overwritten (head
);
21330 enum draw_glyphs_face overlap_hl
;
21332 /* If this row contains mouse highlighting, attempt to draw
21333 the overlapped glyphs with the correct highlight. This
21334 code fails if the overlap encompasses more than one glyph
21335 and mouse-highlight spans only some of these glyphs.
21336 However, making it work perfectly involves a lot more
21337 code, and I don't know if the pathological case occurs in
21338 practice, so we'll stick to this for now. --- cyd */
21339 if (check_mouse_face
21340 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21341 overlap_hl
= DRAW_MOUSE_FACE
;
21343 overlap_hl
= DRAW_NORMAL_TEXT
;
21346 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21347 overlap_hl
, dummy_x
, last_x
);
21349 compute_overhangs_and_x (t
, head
->x
, 1);
21350 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21354 /* Prepend glyph strings for glyphs in front of the first glyph
21355 string that overwrite that glyph string because of their
21356 right overhang. For these strings, only the foreground must
21357 be drawn, because it draws over the glyph string at `head'.
21358 The background must not be drawn because this would overwrite
21359 right overhangs of preceding glyphs for which no glyph
21361 i
= left_overwriting (head
);
21364 enum draw_glyphs_face overlap_hl
;
21366 if (check_mouse_face
21367 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21368 overlap_hl
= DRAW_MOUSE_FACE
;
21370 overlap_hl
= DRAW_NORMAL_TEXT
;
21373 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21374 overlap_hl
, dummy_x
, last_x
);
21375 for (s
= h
; s
; s
= s
->next
)
21376 s
->background_filled_p
= 1;
21377 compute_overhangs_and_x (t
, head
->x
, 1);
21378 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21381 /* Append glyphs strings for glyphs following the last glyph
21382 string tail that are overwritten by tail. The background of
21383 these strings has to be drawn because tail's foreground draws
21385 i
= right_overwritten (tail
);
21388 enum draw_glyphs_face overlap_hl
;
21390 if (check_mouse_face
21391 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21392 overlap_hl
= DRAW_MOUSE_FACE
;
21394 overlap_hl
= DRAW_NORMAL_TEXT
;
21396 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21397 overlap_hl
, x
, last_x
);
21398 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21399 we don't have `end = i;' here. */
21400 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21401 append_glyph_string_lists (&head
, &tail
, h
, t
);
21405 /* Append glyph strings for glyphs following the last glyph
21406 string tail that overwrite tail. The foreground of such
21407 glyphs has to be drawn because it writes into the background
21408 of tail. The background must not be drawn because it could
21409 paint over the foreground of following glyphs. */
21410 i
= right_overwriting (tail
);
21413 enum draw_glyphs_face overlap_hl
;
21414 if (check_mouse_face
21415 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21416 overlap_hl
= DRAW_MOUSE_FACE
;
21418 overlap_hl
= DRAW_NORMAL_TEXT
;
21421 i
++; /* We must include the Ith glyph. */
21422 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21423 overlap_hl
, x
, last_x
);
21424 for (s
= h
; s
; s
= s
->next
)
21425 s
->background_filled_p
= 1;
21426 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21427 append_glyph_string_lists (&head
, &tail
, h
, t
);
21429 if (clip_head
|| clip_tail
)
21430 for (s
= head
; s
; s
= s
->next
)
21432 s
->clip_head
= clip_head
;
21433 s
->clip_tail
= clip_tail
;
21437 /* Draw all strings. */
21438 for (s
= head
; s
; s
= s
->next
)
21439 FRAME_RIF (f
)->draw_glyph_string (s
);
21442 /* When focus a sole frame and move horizontally, this sets on_p to 0
21443 causing a failure to erase prev cursor position. */
21444 if (area
== TEXT_AREA
21445 && !row
->full_width_p
21446 /* When drawing overlapping rows, only the glyph strings'
21447 foreground is drawn, which doesn't erase a cursor
21451 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21452 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21453 : (tail
? tail
->x
+ tail
->background_width
: x
));
21457 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21458 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21462 /* Value is the x-position up to which drawn, relative to AREA of W.
21463 This doesn't include parts drawn because of overhangs. */
21464 if (row
->full_width_p
)
21465 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21467 x_reached
-= area_left
;
21469 RELEASE_HDC (hdc
, f
);
21474 /* Expand row matrix if too narrow. Don't expand if area
21477 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21479 if (!fonts_changed_p \
21480 && (it->glyph_row->glyphs[area] \
21481 < it->glyph_row->glyphs[area + 1])) \
21483 it->w->ncols_scale_factor++; \
21484 fonts_changed_p = 1; \
21488 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21489 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21492 append_glyph (struct it
*it
)
21494 struct glyph
*glyph
;
21495 enum glyph_row_area area
= it
->area
;
21497 xassert (it
->glyph_row
);
21498 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21500 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21501 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21503 /* If the glyph row is reversed, we need to prepend the glyph
21504 rather than append it. */
21505 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21509 /* Make room for the additional glyph. */
21510 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21512 glyph
= it
->glyph_row
->glyphs
[area
];
21514 glyph
->charpos
= CHARPOS (it
->position
);
21515 glyph
->object
= it
->object
;
21516 if (it
->pixel_width
> 0)
21518 glyph
->pixel_width
= it
->pixel_width
;
21519 glyph
->padding_p
= 0;
21523 /* Assure at least 1-pixel width. Otherwise, cursor can't
21524 be displayed correctly. */
21525 glyph
->pixel_width
= 1;
21526 glyph
->padding_p
= 1;
21528 glyph
->ascent
= it
->ascent
;
21529 glyph
->descent
= it
->descent
;
21530 glyph
->voffset
= it
->voffset
;
21531 glyph
->type
= CHAR_GLYPH
;
21532 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21533 glyph
->multibyte_p
= it
->multibyte_p
;
21534 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21535 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21536 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21537 || it
->phys_descent
> it
->descent
);
21538 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21539 glyph
->face_id
= it
->face_id
;
21540 glyph
->u
.ch
= it
->char_to_display
;
21541 glyph
->slice
.img
= null_glyph_slice
;
21542 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21545 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21546 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21548 glyph
->bidi_type
= it
->bidi_it
.type
;
21552 glyph
->resolved_level
= 0;
21553 glyph
->bidi_type
= UNKNOWN_BT
;
21555 ++it
->glyph_row
->used
[area
];
21558 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21561 /* Store one glyph for the composition IT->cmp_it.id in
21562 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21566 append_composite_glyph (struct it
*it
)
21568 struct glyph
*glyph
;
21569 enum glyph_row_area area
= it
->area
;
21571 xassert (it
->glyph_row
);
21573 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21574 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21576 /* If the glyph row is reversed, we need to prepend the glyph
21577 rather than append it. */
21578 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21582 /* Make room for the new glyph. */
21583 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21585 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21587 glyph
->charpos
= it
->cmp_it
.charpos
;
21588 glyph
->object
= it
->object
;
21589 glyph
->pixel_width
= it
->pixel_width
;
21590 glyph
->ascent
= it
->ascent
;
21591 glyph
->descent
= it
->descent
;
21592 glyph
->voffset
= it
->voffset
;
21593 glyph
->type
= COMPOSITE_GLYPH
;
21594 if (it
->cmp_it
.ch
< 0)
21596 glyph
->u
.cmp
.automatic
= 0;
21597 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21598 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21602 glyph
->u
.cmp
.automatic
= 1;
21603 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21604 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21605 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21607 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21608 glyph
->multibyte_p
= it
->multibyte_p
;
21609 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21610 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21611 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21612 || it
->phys_descent
> it
->descent
);
21613 glyph
->padding_p
= 0;
21614 glyph
->glyph_not_available_p
= 0;
21615 glyph
->face_id
= it
->face_id
;
21616 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21619 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21620 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21622 glyph
->bidi_type
= it
->bidi_it
.type
;
21624 ++it
->glyph_row
->used
[area
];
21627 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21631 /* Change IT->ascent and IT->height according to the setting of
21635 take_vertical_position_into_account (struct it
*it
)
21639 if (it
->voffset
< 0)
21640 /* Increase the ascent so that we can display the text higher
21642 it
->ascent
-= it
->voffset
;
21644 /* Increase the descent so that we can display the text lower
21646 it
->descent
+= it
->voffset
;
21651 /* Produce glyphs/get display metrics for the image IT is loaded with.
21652 See the description of struct display_iterator in dispextern.h for
21653 an overview of struct display_iterator. */
21656 produce_image_glyph (struct it
*it
)
21660 int glyph_ascent
, crop
;
21661 struct glyph_slice slice
;
21663 xassert (it
->what
== IT_IMAGE
);
21665 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21667 /* Make sure X resources of the face is loaded. */
21668 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21670 if (it
->image_id
< 0)
21672 /* Fringe bitmap. */
21673 it
->ascent
= it
->phys_ascent
= 0;
21674 it
->descent
= it
->phys_descent
= 0;
21675 it
->pixel_width
= 0;
21680 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21682 /* Make sure X resources of the image is loaded. */
21683 prepare_image_for_display (it
->f
, img
);
21685 slice
.x
= slice
.y
= 0;
21686 slice
.width
= img
->width
;
21687 slice
.height
= img
->height
;
21689 if (INTEGERP (it
->slice
.x
))
21690 slice
.x
= XINT (it
->slice
.x
);
21691 else if (FLOATP (it
->slice
.x
))
21692 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21694 if (INTEGERP (it
->slice
.y
))
21695 slice
.y
= XINT (it
->slice
.y
);
21696 else if (FLOATP (it
->slice
.y
))
21697 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21699 if (INTEGERP (it
->slice
.width
))
21700 slice
.width
= XINT (it
->slice
.width
);
21701 else if (FLOATP (it
->slice
.width
))
21702 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21704 if (INTEGERP (it
->slice
.height
))
21705 slice
.height
= XINT (it
->slice
.height
);
21706 else if (FLOATP (it
->slice
.height
))
21707 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21709 if (slice
.x
>= img
->width
)
21710 slice
.x
= img
->width
;
21711 if (slice
.y
>= img
->height
)
21712 slice
.y
= img
->height
;
21713 if (slice
.x
+ slice
.width
>= img
->width
)
21714 slice
.width
= img
->width
- slice
.x
;
21715 if (slice
.y
+ slice
.height
> img
->height
)
21716 slice
.height
= img
->height
- slice
.y
;
21718 if (slice
.width
== 0 || slice
.height
== 0)
21721 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21723 it
->descent
= slice
.height
- glyph_ascent
;
21725 it
->descent
+= img
->vmargin
;
21726 if (slice
.y
+ slice
.height
== img
->height
)
21727 it
->descent
+= img
->vmargin
;
21728 it
->phys_descent
= it
->descent
;
21730 it
->pixel_width
= slice
.width
;
21732 it
->pixel_width
+= img
->hmargin
;
21733 if (slice
.x
+ slice
.width
== img
->width
)
21734 it
->pixel_width
+= img
->hmargin
;
21736 /* It's quite possible for images to have an ascent greater than
21737 their height, so don't get confused in that case. */
21738 if (it
->descent
< 0)
21743 if (face
->box
!= FACE_NO_BOX
)
21745 if (face
->box_line_width
> 0)
21748 it
->ascent
+= face
->box_line_width
;
21749 if (slice
.y
+ slice
.height
== img
->height
)
21750 it
->descent
+= face
->box_line_width
;
21753 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21754 it
->pixel_width
+= eabs (face
->box_line_width
);
21755 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21756 it
->pixel_width
+= eabs (face
->box_line_width
);
21759 take_vertical_position_into_account (it
);
21761 /* Automatically crop wide image glyphs at right edge so we can
21762 draw the cursor on same display row. */
21763 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21764 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21766 it
->pixel_width
-= crop
;
21767 slice
.width
-= crop
;
21772 struct glyph
*glyph
;
21773 enum glyph_row_area area
= it
->area
;
21775 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21776 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21778 glyph
->charpos
= CHARPOS (it
->position
);
21779 glyph
->object
= it
->object
;
21780 glyph
->pixel_width
= it
->pixel_width
;
21781 glyph
->ascent
= glyph_ascent
;
21782 glyph
->descent
= it
->descent
;
21783 glyph
->voffset
= it
->voffset
;
21784 glyph
->type
= IMAGE_GLYPH
;
21785 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21786 glyph
->multibyte_p
= it
->multibyte_p
;
21787 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21788 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21789 glyph
->overlaps_vertically_p
= 0;
21790 glyph
->padding_p
= 0;
21791 glyph
->glyph_not_available_p
= 0;
21792 glyph
->face_id
= it
->face_id
;
21793 glyph
->u
.img_id
= img
->id
;
21794 glyph
->slice
.img
= slice
;
21795 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21798 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21799 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21801 glyph
->bidi_type
= it
->bidi_it
.type
;
21803 ++it
->glyph_row
->used
[area
];
21806 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21811 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21812 of the glyph, WIDTH and HEIGHT are the width and height of the
21813 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21816 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21817 int width
, int height
, int ascent
)
21819 struct glyph
*glyph
;
21820 enum glyph_row_area area
= it
->area
;
21822 xassert (ascent
>= 0 && ascent
<= height
);
21824 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21825 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21827 /* If the glyph row is reversed, we need to prepend the glyph
21828 rather than append it. */
21829 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21833 /* Make room for the additional glyph. */
21834 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21836 glyph
= it
->glyph_row
->glyphs
[area
];
21838 glyph
->charpos
= CHARPOS (it
->position
);
21839 glyph
->object
= object
;
21840 glyph
->pixel_width
= width
;
21841 glyph
->ascent
= ascent
;
21842 glyph
->descent
= height
- ascent
;
21843 glyph
->voffset
= it
->voffset
;
21844 glyph
->type
= STRETCH_GLYPH
;
21845 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21846 glyph
->multibyte_p
= it
->multibyte_p
;
21847 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21848 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21849 glyph
->overlaps_vertically_p
= 0;
21850 glyph
->padding_p
= 0;
21851 glyph
->glyph_not_available_p
= 0;
21852 glyph
->face_id
= it
->face_id
;
21853 glyph
->u
.stretch
.ascent
= ascent
;
21854 glyph
->u
.stretch
.height
= height
;
21855 glyph
->slice
.img
= null_glyph_slice
;
21856 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21859 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21860 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21862 glyph
->bidi_type
= it
->bidi_it
.type
;
21866 glyph
->resolved_level
= 0;
21867 glyph
->bidi_type
= UNKNOWN_BT
;
21869 ++it
->glyph_row
->used
[area
];
21872 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21876 /* Produce a stretch glyph for iterator IT. IT->object is the value
21877 of the glyph property displayed. The value must be a list
21878 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21881 1. `:width WIDTH' specifies that the space should be WIDTH *
21882 canonical char width wide. WIDTH may be an integer or floating
21885 2. `:relative-width FACTOR' specifies that the width of the stretch
21886 should be computed from the width of the first character having the
21887 `glyph' property, and should be FACTOR times that width.
21889 3. `:align-to HPOS' specifies that the space should be wide enough
21890 to reach HPOS, a value in canonical character units.
21892 Exactly one of the above pairs must be present.
21894 4. `:height HEIGHT' specifies that the height of the stretch produced
21895 should be HEIGHT, measured in canonical character units.
21897 5. `:relative-height FACTOR' specifies that the height of the
21898 stretch should be FACTOR times the height of the characters having
21899 the glyph property.
21901 Either none or exactly one of 4 or 5 must be present.
21903 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21904 of the stretch should be used for the ascent of the stretch.
21905 ASCENT must be in the range 0 <= ASCENT <= 100. */
21908 produce_stretch_glyph (struct it
*it
)
21910 /* (space :width WIDTH :height HEIGHT ...) */
21911 Lisp_Object prop
, plist
;
21912 int width
= 0, height
= 0, align_to
= -1;
21913 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21916 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21917 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21919 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21921 /* List should start with `space'. */
21922 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21923 plist
= XCDR (it
->object
);
21925 /* Compute the width of the stretch. */
21926 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21927 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21929 /* Absolute width `:width WIDTH' specified and valid. */
21930 zero_width_ok_p
= 1;
21933 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21936 /* Relative width `:relative-width FACTOR' specified and valid.
21937 Compute the width of the characters having the `glyph'
21940 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21943 if (it
->multibyte_p
)
21944 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21947 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21948 if (! ASCII_CHAR_P (it2
.c
))
21949 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21952 it2
.glyph_row
= NULL
;
21953 it2
.what
= IT_CHARACTER
;
21954 x_produce_glyphs (&it2
);
21955 width
= NUMVAL (prop
) * it2
.pixel_width
;
21957 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21958 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21960 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21961 align_to
= (align_to
< 0
21963 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21964 else if (align_to
< 0)
21965 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21966 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21967 zero_width_ok_p
= 1;
21970 /* Nothing specified -> width defaults to canonical char width. */
21971 width
= FRAME_COLUMN_WIDTH (it
->f
);
21973 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21976 /* Compute height. */
21977 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21978 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21981 zero_height_ok_p
= 1;
21983 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21985 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21987 height
= FONT_HEIGHT (font
);
21989 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21992 /* Compute percentage of height used for ascent. If
21993 `:ascent ASCENT' is present and valid, use that. Otherwise,
21994 derive the ascent from the font in use. */
21995 if (prop
= Fplist_get (plist
, QCascent
),
21996 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21997 ascent
= height
* NUMVAL (prop
) / 100.0;
21998 else if (!NILP (prop
)
21999 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22000 ascent
= min (max (0, (int)tem
), height
);
22002 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22004 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22005 && it
->current_x
+ width
> it
->last_visible_x
)
22006 width
= it
->last_visible_x
- it
->current_x
- 1;
22008 if (width
> 0 && height
> 0 && it
->glyph_row
)
22010 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22011 if (!STRINGP (object
))
22012 object
= it
->w
->buffer
;
22013 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22016 it
->pixel_width
= width
;
22017 it
->ascent
= it
->phys_ascent
= ascent
;
22018 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22019 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22021 take_vertical_position_into_account (it
);
22024 /* Calculate line-height and line-spacing properties.
22025 An integer value specifies explicit pixel value.
22026 A float value specifies relative value to current face height.
22027 A cons (float . face-name) specifies relative value to
22028 height of specified face font.
22030 Returns height in pixels, or nil. */
22034 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22035 int boff
, int override
)
22037 Lisp_Object face_name
= Qnil
;
22038 int ascent
, descent
, height
;
22040 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22045 face_name
= XCAR (val
);
22047 if (!NUMBERP (val
))
22048 val
= make_number (1);
22049 if (NILP (face_name
))
22051 height
= it
->ascent
+ it
->descent
;
22056 if (NILP (face_name
))
22058 font
= FRAME_FONT (it
->f
);
22059 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22061 else if (EQ (face_name
, Qt
))
22070 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22072 return make_number (-1);
22074 face
= FACE_FROM_ID (it
->f
, face_id
);
22077 return make_number (-1);
22078 boff
= font
->baseline_offset
;
22079 if (font
->vertical_centering
)
22080 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22083 ascent
= FONT_BASE (font
) + boff
;
22084 descent
= FONT_DESCENT (font
) - boff
;
22088 it
->override_ascent
= ascent
;
22089 it
->override_descent
= descent
;
22090 it
->override_boff
= boff
;
22093 height
= ascent
+ descent
;
22097 height
= (int)(XFLOAT_DATA (val
) * height
);
22098 else if (INTEGERP (val
))
22099 height
*= XINT (val
);
22101 return make_number (height
);
22105 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22106 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22107 and only if this is for a character for which no font was found.
22109 If the display method (it->glyphless_method) is
22110 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22111 length of the acronym or the hexadecimal string, UPPER_XOFF and
22112 UPPER_YOFF are pixel offsets for the upper part of the string,
22113 LOWER_XOFF and LOWER_YOFF are for the lower part.
22115 For the other display methods, LEN through LOWER_YOFF are zero. */
22118 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22119 short upper_xoff
, short upper_yoff
,
22120 short lower_xoff
, short lower_yoff
)
22122 struct glyph
*glyph
;
22123 enum glyph_row_area area
= it
->area
;
22125 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22126 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22128 /* If the glyph row is reversed, we need to prepend the glyph
22129 rather than append it. */
22130 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22134 /* Make room for the additional glyph. */
22135 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22137 glyph
= it
->glyph_row
->glyphs
[area
];
22139 glyph
->charpos
= CHARPOS (it
->position
);
22140 glyph
->object
= it
->object
;
22141 glyph
->pixel_width
= it
->pixel_width
;
22142 glyph
->ascent
= it
->ascent
;
22143 glyph
->descent
= it
->descent
;
22144 glyph
->voffset
= it
->voffset
;
22145 glyph
->type
= GLYPHLESS_GLYPH
;
22146 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22147 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22148 glyph
->u
.glyphless
.len
= len
;
22149 glyph
->u
.glyphless
.ch
= it
->c
;
22150 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22151 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22152 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22153 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22154 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22155 glyph
->multibyte_p
= it
->multibyte_p
;
22156 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22157 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22158 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22159 || it
->phys_descent
> it
->descent
);
22160 glyph
->padding_p
= 0;
22161 glyph
->glyph_not_available_p
= 0;
22162 glyph
->face_id
= face_id
;
22163 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22166 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22167 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22169 glyph
->bidi_type
= it
->bidi_it
.type
;
22171 ++it
->glyph_row
->used
[area
];
22174 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22178 /* Produce a glyph for a glyphless character for iterator IT.
22179 IT->glyphless_method specifies which method to use for displaying
22180 the character. See the description of enum
22181 glyphless_display_method in dispextern.h for the detail.
22183 FOR_NO_FONT is nonzero if and only if this is for a character for
22184 which no font was found. ACRONYM, if non-nil, is an acronym string
22185 for the character. */
22188 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22193 int base_width
, base_height
, width
, height
;
22194 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22197 /* Get the metrics of the base font. We always refer to the current
22199 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22200 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22201 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22202 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22203 base_height
= it
->ascent
+ it
->descent
;
22204 base_width
= font
->average_width
;
22206 /* Get a face ID for the glyph by utilizing a cache (the same way as
22207 doen for `escape-glyph' in get_next_display_element). */
22208 if (it
->f
== last_glyphless_glyph_frame
22209 && it
->face_id
== last_glyphless_glyph_face_id
)
22211 face_id
= last_glyphless_glyph_merged_face_id
;
22215 /* Merge the `glyphless-char' face into the current face. */
22216 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22217 last_glyphless_glyph_frame
= it
->f
;
22218 last_glyphless_glyph_face_id
= it
->face_id
;
22219 last_glyphless_glyph_merged_face_id
= face_id
;
22222 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22224 it
->pixel_width
= THIN_SPACE_WIDTH
;
22226 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22228 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22230 width
= CHAR_WIDTH (it
->c
);
22233 else if (width
> 4)
22235 it
->pixel_width
= base_width
* width
;
22237 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22243 unsigned int code
[6];
22245 int ascent
, descent
;
22246 struct font_metrics metrics_upper
, metrics_lower
;
22248 face
= FACE_FROM_ID (it
->f
, face_id
);
22249 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22250 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22252 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22254 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22255 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22256 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22260 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22261 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22264 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22265 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22266 upper_len
= (len
+ 1) / 2;
22267 font
->driver
->text_extents (font
, code
, upper_len
,
22269 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22274 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22275 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22276 upper_xoff
= upper_yoff
= 2; /* the typical case */
22277 if (base_width
>= width
)
22279 /* Align the upper to the left, the lower to the right. */
22280 it
->pixel_width
= base_width
;
22281 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22285 /* Center the shorter one. */
22286 it
->pixel_width
= width
;
22287 if (metrics_upper
.width
>= metrics_lower
.width
)
22288 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22291 /* FIXME: This code doesn't look right. It formerly was
22292 missing the "lower_xoff = 0;", which couldn't have
22293 been right since it left lower_xoff uninitialized. */
22295 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22299 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22300 top, bottom, and between upper and lower strings. */
22301 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22302 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22303 /* Center vertically.
22304 H:base_height, D:base_descent
22305 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22307 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22308 descent = D - H/2 + h/2;
22309 lower_yoff = descent - 2 - ld;
22310 upper_yoff = lower_yoff - la - 1 - ud; */
22311 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22312 descent
= it
->descent
- (base_height
- height
) / 2;
22313 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22314 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22315 - metrics_upper
.descent
);
22316 /* Don't make the height shorter than the base height. */
22317 if (height
> base_height
)
22319 it
->ascent
= ascent
;
22320 it
->descent
= descent
;
22324 it
->phys_ascent
= it
->ascent
;
22325 it
->phys_descent
= it
->descent
;
22327 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22328 upper_xoff
, upper_yoff
,
22329 lower_xoff
, lower_yoff
);
22331 take_vertical_position_into_account (it
);
22336 Produce glyphs/get display metrics for the display element IT is
22337 loaded with. See the description of struct it in dispextern.h
22338 for an overview of struct it. */
22341 x_produce_glyphs (struct it
*it
)
22343 int extra_line_spacing
= it
->extra_line_spacing
;
22345 it
->glyph_not_available_p
= 0;
22347 if (it
->what
== IT_CHARACTER
)
22350 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22351 struct font
*font
= face
->font
;
22352 struct font_metrics
*pcm
= NULL
;
22353 int boff
; /* baseline offset */
22357 /* When no suitable font is found, display this character by
22358 the method specified in the first extra slot of
22359 Vglyphless_char_display. */
22360 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22362 xassert (it
->what
== IT_GLYPHLESS
);
22363 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22367 boff
= font
->baseline_offset
;
22368 if (font
->vertical_centering
)
22369 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22371 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22377 if (it
->override_ascent
>= 0)
22379 it
->ascent
= it
->override_ascent
;
22380 it
->descent
= it
->override_descent
;
22381 boff
= it
->override_boff
;
22385 it
->ascent
= FONT_BASE (font
) + boff
;
22386 it
->descent
= FONT_DESCENT (font
) - boff
;
22389 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22391 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22392 if (pcm
->width
== 0
22393 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22399 it
->phys_ascent
= pcm
->ascent
+ boff
;
22400 it
->phys_descent
= pcm
->descent
- boff
;
22401 it
->pixel_width
= pcm
->width
;
22405 it
->glyph_not_available_p
= 1;
22406 it
->phys_ascent
= it
->ascent
;
22407 it
->phys_descent
= it
->descent
;
22408 it
->pixel_width
= font
->space_width
;
22411 if (it
->constrain_row_ascent_descent_p
)
22413 if (it
->descent
> it
->max_descent
)
22415 it
->ascent
+= it
->descent
- it
->max_descent
;
22416 it
->descent
= it
->max_descent
;
22418 if (it
->ascent
> it
->max_ascent
)
22420 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22421 it
->ascent
= it
->max_ascent
;
22423 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22424 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22425 extra_line_spacing
= 0;
22428 /* If this is a space inside a region of text with
22429 `space-width' property, change its width. */
22430 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22432 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22434 /* If face has a box, add the box thickness to the character
22435 height. If character has a box line to the left and/or
22436 right, add the box line width to the character's width. */
22437 if (face
->box
!= FACE_NO_BOX
)
22439 int thick
= face
->box_line_width
;
22443 it
->ascent
+= thick
;
22444 it
->descent
+= thick
;
22449 if (it
->start_of_box_run_p
)
22450 it
->pixel_width
+= thick
;
22451 if (it
->end_of_box_run_p
)
22452 it
->pixel_width
+= thick
;
22455 /* If face has an overline, add the height of the overline
22456 (1 pixel) and a 1 pixel margin to the character height. */
22457 if (face
->overline_p
)
22458 it
->ascent
+= overline_margin
;
22460 if (it
->constrain_row_ascent_descent_p
)
22462 if (it
->ascent
> it
->max_ascent
)
22463 it
->ascent
= it
->max_ascent
;
22464 if (it
->descent
> it
->max_descent
)
22465 it
->descent
= it
->max_descent
;
22468 take_vertical_position_into_account (it
);
22470 /* If we have to actually produce glyphs, do it. */
22475 /* Translate a space with a `space-width' property
22476 into a stretch glyph. */
22477 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22478 / FONT_HEIGHT (font
));
22479 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22480 it
->ascent
+ it
->descent
, ascent
);
22485 /* If characters with lbearing or rbearing are displayed
22486 in this line, record that fact in a flag of the
22487 glyph row. This is used to optimize X output code. */
22488 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22489 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22491 if (! stretched_p
&& it
->pixel_width
== 0)
22492 /* We assure that all visible glyphs have at least 1-pixel
22494 it
->pixel_width
= 1;
22496 else if (it
->char_to_display
== '\n')
22498 /* A newline has no width, but we need the height of the
22499 line. But if previous part of the line sets a height,
22500 don't increase that height */
22502 Lisp_Object height
;
22503 Lisp_Object total_height
= Qnil
;
22505 it
->override_ascent
= -1;
22506 it
->pixel_width
= 0;
22509 height
= get_it_property (it
, Qline_height
);
22510 /* Split (line-height total-height) list */
22512 && CONSP (XCDR (height
))
22513 && NILP (XCDR (XCDR (height
))))
22515 total_height
= XCAR (XCDR (height
));
22516 height
= XCAR (height
);
22518 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22520 if (it
->override_ascent
>= 0)
22522 it
->ascent
= it
->override_ascent
;
22523 it
->descent
= it
->override_descent
;
22524 boff
= it
->override_boff
;
22528 it
->ascent
= FONT_BASE (font
) + boff
;
22529 it
->descent
= FONT_DESCENT (font
) - boff
;
22532 if (EQ (height
, Qt
))
22534 if (it
->descent
> it
->max_descent
)
22536 it
->ascent
+= it
->descent
- it
->max_descent
;
22537 it
->descent
= it
->max_descent
;
22539 if (it
->ascent
> it
->max_ascent
)
22541 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22542 it
->ascent
= it
->max_ascent
;
22544 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22545 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22546 it
->constrain_row_ascent_descent_p
= 1;
22547 extra_line_spacing
= 0;
22551 Lisp_Object spacing
;
22553 it
->phys_ascent
= it
->ascent
;
22554 it
->phys_descent
= it
->descent
;
22556 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22557 && face
->box
!= FACE_NO_BOX
22558 && face
->box_line_width
> 0)
22560 it
->ascent
+= face
->box_line_width
;
22561 it
->descent
+= face
->box_line_width
;
22564 && XINT (height
) > it
->ascent
+ it
->descent
)
22565 it
->ascent
= XINT (height
) - it
->descent
;
22567 if (!NILP (total_height
))
22568 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22571 spacing
= get_it_property (it
, Qline_spacing
);
22572 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22574 if (INTEGERP (spacing
))
22576 extra_line_spacing
= XINT (spacing
);
22577 if (!NILP (total_height
))
22578 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22582 else /* i.e. (it->char_to_display == '\t') */
22584 if (font
->space_width
> 0)
22586 int tab_width
= it
->tab_width
* font
->space_width
;
22587 int x
= it
->current_x
+ it
->continuation_lines_width
;
22588 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22590 /* If the distance from the current position to the next tab
22591 stop is less than a space character width, use the
22592 tab stop after that. */
22593 if (next_tab_x
- x
< font
->space_width
)
22594 next_tab_x
+= tab_width
;
22596 it
->pixel_width
= next_tab_x
- x
;
22598 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22599 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22603 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22604 it
->ascent
+ it
->descent
, it
->ascent
);
22609 it
->pixel_width
= 0;
22614 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22616 /* A static composition.
22618 Note: A composition is represented as one glyph in the
22619 glyph matrix. There are no padding glyphs.
22621 Important note: pixel_width, ascent, and descent are the
22622 values of what is drawn by draw_glyphs (i.e. the values of
22623 the overall glyphs composed). */
22624 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22625 int boff
; /* baseline offset */
22626 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22627 int glyph_len
= cmp
->glyph_len
;
22628 struct font
*font
= face
->font
;
22632 /* If we have not yet calculated pixel size data of glyphs of
22633 the composition for the current face font, calculate them
22634 now. Theoretically, we have to check all fonts for the
22635 glyphs, but that requires much time and memory space. So,
22636 here we check only the font of the first glyph. This may
22637 lead to incorrect display, but it's very rare, and C-l
22638 (recenter-top-bottom) can correct the display anyway. */
22639 if (! cmp
->font
|| cmp
->font
!= font
)
22641 /* Ascent and descent of the font of the first character
22642 of this composition (adjusted by baseline offset).
22643 Ascent and descent of overall glyphs should not be less
22644 than these, respectively. */
22645 int font_ascent
, font_descent
, font_height
;
22646 /* Bounding box of the overall glyphs. */
22647 int leftmost
, rightmost
, lowest
, highest
;
22648 int lbearing
, rbearing
;
22649 int i
, width
, ascent
, descent
;
22650 int left_padded
= 0, right_padded
= 0;
22653 struct font_metrics
*pcm
;
22654 int font_not_found_p
;
22657 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22658 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22660 if (glyph_len
< cmp
->glyph_len
)
22662 for (i
= 0; i
< glyph_len
; i
++)
22664 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22666 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22671 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22672 : IT_CHARPOS (*it
));
22673 /* If no suitable font is found, use the default font. */
22674 font_not_found_p
= font
== NULL
;
22675 if (font_not_found_p
)
22677 face
= face
->ascii_face
;
22680 boff
= font
->baseline_offset
;
22681 if (font
->vertical_centering
)
22682 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22683 font_ascent
= FONT_BASE (font
) + boff
;
22684 font_descent
= FONT_DESCENT (font
) - boff
;
22685 font_height
= FONT_HEIGHT (font
);
22687 cmp
->font
= (void *) font
;
22690 if (! font_not_found_p
)
22692 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22693 &char2b
, it
->multibyte_p
, 0);
22694 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22697 /* Initialize the bounding box. */
22700 width
= pcm
->width
;
22701 ascent
= pcm
->ascent
;
22702 descent
= pcm
->descent
;
22703 lbearing
= pcm
->lbearing
;
22704 rbearing
= pcm
->rbearing
;
22708 width
= font
->space_width
;
22709 ascent
= FONT_BASE (font
);
22710 descent
= FONT_DESCENT (font
);
22717 lowest
= - descent
+ boff
;
22718 highest
= ascent
+ boff
;
22720 if (! font_not_found_p
22721 && font
->default_ascent
22722 && CHAR_TABLE_P (Vuse_default_ascent
)
22723 && !NILP (Faref (Vuse_default_ascent
,
22724 make_number (it
->char_to_display
))))
22725 highest
= font
->default_ascent
+ boff
;
22727 /* Draw the first glyph at the normal position. It may be
22728 shifted to right later if some other glyphs are drawn
22730 cmp
->offsets
[i
* 2] = 0;
22731 cmp
->offsets
[i
* 2 + 1] = boff
;
22732 cmp
->lbearing
= lbearing
;
22733 cmp
->rbearing
= rbearing
;
22735 /* Set cmp->offsets for the remaining glyphs. */
22736 for (i
++; i
< glyph_len
; i
++)
22738 int left
, right
, btm
, top
;
22739 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22741 struct face
*this_face
;
22746 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22747 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22748 font
= this_face
->font
;
22754 this_boff
= font
->baseline_offset
;
22755 if (font
->vertical_centering
)
22756 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22757 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22758 &char2b
, it
->multibyte_p
, 0);
22759 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22762 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22765 width
= pcm
->width
;
22766 ascent
= pcm
->ascent
;
22767 descent
= pcm
->descent
;
22768 lbearing
= pcm
->lbearing
;
22769 rbearing
= pcm
->rbearing
;
22770 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22772 /* Relative composition with or without
22773 alternate chars. */
22774 left
= (leftmost
+ rightmost
- width
) / 2;
22775 btm
= - descent
+ boff
;
22776 if (font
->relative_compose
22777 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22778 || NILP (Faref (Vignore_relative_composition
,
22779 make_number (ch
)))))
22782 if (- descent
>= font
->relative_compose
)
22783 /* One extra pixel between two glyphs. */
22785 else if (ascent
<= 0)
22786 /* One extra pixel between two glyphs. */
22787 btm
= lowest
- 1 - ascent
- descent
;
22792 /* A composition rule is specified by an integer
22793 value that encodes global and new reference
22794 points (GREF and NREF). GREF and NREF are
22795 specified by numbers as below:
22797 0---1---2 -- ascent
22801 9--10--11 -- center
22803 ---3---4---5--- baseline
22805 6---7---8 -- descent
22807 int rule
= COMPOSITION_RULE (cmp
, i
);
22808 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22810 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22811 grefx
= gref
% 3, nrefx
= nref
% 3;
22812 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22814 xoff
= font_height
* (xoff
- 128) / 256;
22816 yoff
= font_height
* (yoff
- 128) / 256;
22819 + grefx
* (rightmost
- leftmost
) / 2
22820 - nrefx
* width
/ 2
22823 btm
= ((grefy
== 0 ? highest
22825 : grefy
== 2 ? lowest
22826 : (highest
+ lowest
) / 2)
22827 - (nrefy
== 0 ? ascent
+ descent
22828 : nrefy
== 1 ? descent
- boff
22830 : (ascent
+ descent
) / 2)
22834 cmp
->offsets
[i
* 2] = left
;
22835 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22837 /* Update the bounding box of the overall glyphs. */
22840 right
= left
+ width
;
22841 if (left
< leftmost
)
22843 if (right
> rightmost
)
22846 top
= btm
+ descent
+ ascent
;
22852 if (cmp
->lbearing
> left
+ lbearing
)
22853 cmp
->lbearing
= left
+ lbearing
;
22854 if (cmp
->rbearing
< left
+ rbearing
)
22855 cmp
->rbearing
= left
+ rbearing
;
22859 /* If there are glyphs whose x-offsets are negative,
22860 shift all glyphs to the right and make all x-offsets
22864 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22865 cmp
->offsets
[i
* 2] -= leftmost
;
22866 rightmost
-= leftmost
;
22867 cmp
->lbearing
-= leftmost
;
22868 cmp
->rbearing
-= leftmost
;
22871 if (left_padded
&& cmp
->lbearing
< 0)
22873 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22874 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22875 rightmost
-= cmp
->lbearing
;
22876 cmp
->rbearing
-= cmp
->lbearing
;
22879 if (right_padded
&& rightmost
< cmp
->rbearing
)
22881 rightmost
= cmp
->rbearing
;
22884 cmp
->pixel_width
= rightmost
;
22885 cmp
->ascent
= highest
;
22886 cmp
->descent
= - lowest
;
22887 if (cmp
->ascent
< font_ascent
)
22888 cmp
->ascent
= font_ascent
;
22889 if (cmp
->descent
< font_descent
)
22890 cmp
->descent
= font_descent
;
22894 && (cmp
->lbearing
< 0
22895 || cmp
->rbearing
> cmp
->pixel_width
))
22896 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22898 it
->pixel_width
= cmp
->pixel_width
;
22899 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22900 it
->descent
= it
->phys_descent
= cmp
->descent
;
22901 if (face
->box
!= FACE_NO_BOX
)
22903 int thick
= face
->box_line_width
;
22907 it
->ascent
+= thick
;
22908 it
->descent
+= thick
;
22913 if (it
->start_of_box_run_p
)
22914 it
->pixel_width
+= thick
;
22915 if (it
->end_of_box_run_p
)
22916 it
->pixel_width
+= thick
;
22919 /* If face has an overline, add the height of the overline
22920 (1 pixel) and a 1 pixel margin to the character height. */
22921 if (face
->overline_p
)
22922 it
->ascent
+= overline_margin
;
22924 take_vertical_position_into_account (it
);
22925 if (it
->ascent
< 0)
22927 if (it
->descent
< 0)
22931 append_composite_glyph (it
);
22933 else if (it
->what
== IT_COMPOSITION
)
22935 /* A dynamic (automatic) composition. */
22936 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22937 Lisp_Object gstring
;
22938 struct font_metrics metrics
;
22940 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22942 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22945 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22946 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22947 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22948 it
->descent
= it
->phys_descent
= metrics
.descent
;
22949 if (face
->box
!= FACE_NO_BOX
)
22951 int thick
= face
->box_line_width
;
22955 it
->ascent
+= thick
;
22956 it
->descent
+= thick
;
22961 if (it
->start_of_box_run_p
)
22962 it
->pixel_width
+= thick
;
22963 if (it
->end_of_box_run_p
)
22964 it
->pixel_width
+= thick
;
22966 /* If face has an overline, add the height of the overline
22967 (1 pixel) and a 1 pixel margin to the character height. */
22968 if (face
->overline_p
)
22969 it
->ascent
+= overline_margin
;
22970 take_vertical_position_into_account (it
);
22971 if (it
->ascent
< 0)
22973 if (it
->descent
< 0)
22977 append_composite_glyph (it
);
22979 else if (it
->what
== IT_GLYPHLESS
)
22980 produce_glyphless_glyph (it
, 0, Qnil
);
22981 else if (it
->what
== IT_IMAGE
)
22982 produce_image_glyph (it
);
22983 else if (it
->what
== IT_STRETCH
)
22984 produce_stretch_glyph (it
);
22987 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22988 because this isn't true for images with `:ascent 100'. */
22989 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22990 if (it
->area
== TEXT_AREA
)
22991 it
->current_x
+= it
->pixel_width
;
22993 if (extra_line_spacing
> 0)
22995 it
->descent
+= extra_line_spacing
;
22996 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22997 it
->max_extra_line_spacing
= extra_line_spacing
;
23000 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23001 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23002 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23003 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23007 Output LEN glyphs starting at START at the nominal cursor position.
23008 Advance the nominal cursor over the text. The global variable
23009 updated_window contains the window being updated, updated_row is
23010 the glyph row being updated, and updated_area is the area of that
23011 row being updated. */
23014 x_write_glyphs (struct glyph
*start
, int len
)
23018 xassert (updated_window
&& updated_row
);
23021 /* Write glyphs. */
23023 hpos
= start
- updated_row
->glyphs
[updated_area
];
23024 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23025 updated_row
, updated_area
,
23027 DRAW_NORMAL_TEXT
, 0);
23029 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23030 if (updated_area
== TEXT_AREA
23031 && updated_window
->phys_cursor_on_p
23032 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23033 && updated_window
->phys_cursor
.hpos
>= hpos
23034 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23035 updated_window
->phys_cursor_on_p
= 0;
23039 /* Advance the output cursor. */
23040 output_cursor
.hpos
+= len
;
23041 output_cursor
.x
= x
;
23046 Insert LEN glyphs from START at the nominal cursor position. */
23049 x_insert_glyphs (struct glyph
*start
, int len
)
23053 int line_height
, shift_by_width
, shifted_region_width
;
23054 struct glyph_row
*row
;
23055 struct glyph
*glyph
;
23056 int frame_x
, frame_y
;
23059 xassert (updated_window
&& updated_row
);
23061 w
= updated_window
;
23062 f
= XFRAME (WINDOW_FRAME (w
));
23064 /* Get the height of the line we are in. */
23066 line_height
= row
->height
;
23068 /* Get the width of the glyphs to insert. */
23069 shift_by_width
= 0;
23070 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23071 shift_by_width
+= glyph
->pixel_width
;
23073 /* Get the width of the region to shift right. */
23074 shifted_region_width
= (window_box_width (w
, updated_area
)
23079 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23080 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23082 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23083 line_height
, shift_by_width
);
23085 /* Write the glyphs. */
23086 hpos
= start
- row
->glyphs
[updated_area
];
23087 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23089 DRAW_NORMAL_TEXT
, 0);
23091 /* Advance the output cursor. */
23092 output_cursor
.hpos
+= len
;
23093 output_cursor
.x
+= shift_by_width
;
23099 Erase the current text line from the nominal cursor position
23100 (inclusive) to pixel column TO_X (exclusive). The idea is that
23101 everything from TO_X onward is already erased.
23103 TO_X is a pixel position relative to updated_area of
23104 updated_window. TO_X == -1 means clear to the end of this area. */
23107 x_clear_end_of_line (int to_x
)
23110 struct window
*w
= updated_window
;
23111 int max_x
, min_y
, max_y
;
23112 int from_x
, from_y
, to_y
;
23114 xassert (updated_window
&& updated_row
);
23115 f
= XFRAME (w
->frame
);
23117 if (updated_row
->full_width_p
)
23118 max_x
= WINDOW_TOTAL_WIDTH (w
);
23120 max_x
= window_box_width (w
, updated_area
);
23121 max_y
= window_text_bottom_y (w
);
23123 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23124 of window. For TO_X > 0, truncate to end of drawing area. */
23130 to_x
= min (to_x
, max_x
);
23132 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23134 /* Notice if the cursor will be cleared by this operation. */
23135 if (!updated_row
->full_width_p
)
23136 notice_overwritten_cursor (w
, updated_area
,
23137 output_cursor
.x
, -1,
23139 MATRIX_ROW_BOTTOM_Y (updated_row
));
23141 from_x
= output_cursor
.x
;
23143 /* Translate to frame coordinates. */
23144 if (updated_row
->full_width_p
)
23146 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23147 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23151 int area_left
= window_box_left (w
, updated_area
);
23152 from_x
+= area_left
;
23156 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23157 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23158 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23160 /* Prevent inadvertently clearing to end of the X window. */
23161 if (to_x
> from_x
&& to_y
> from_y
)
23164 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23165 to_x
- from_x
, to_y
- from_y
);
23170 #endif /* HAVE_WINDOW_SYSTEM */
23174 /***********************************************************************
23176 ***********************************************************************/
23178 /* Value is the internal representation of the specified cursor type
23179 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23180 of the bar cursor. */
23182 static enum text_cursor_kinds
23183 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23185 enum text_cursor_kinds type
;
23190 if (EQ (arg
, Qbox
))
23191 return FILLED_BOX_CURSOR
;
23193 if (EQ (arg
, Qhollow
))
23194 return HOLLOW_BOX_CURSOR
;
23196 if (EQ (arg
, Qbar
))
23203 && EQ (XCAR (arg
), Qbar
)
23204 && INTEGERP (XCDR (arg
))
23205 && XINT (XCDR (arg
)) >= 0)
23207 *width
= XINT (XCDR (arg
));
23211 if (EQ (arg
, Qhbar
))
23214 return HBAR_CURSOR
;
23218 && EQ (XCAR (arg
), Qhbar
)
23219 && INTEGERP (XCDR (arg
))
23220 && XINT (XCDR (arg
)) >= 0)
23222 *width
= XINT (XCDR (arg
));
23223 return HBAR_CURSOR
;
23226 /* Treat anything unknown as "hollow box cursor".
23227 It was bad to signal an error; people have trouble fixing
23228 .Xdefaults with Emacs, when it has something bad in it. */
23229 type
= HOLLOW_BOX_CURSOR
;
23234 /* Set the default cursor types for specified frame. */
23236 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23241 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23242 FRAME_CURSOR_WIDTH (f
) = width
;
23244 /* By default, set up the blink-off state depending on the on-state. */
23246 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23249 FRAME_BLINK_OFF_CURSOR (f
)
23250 = get_specified_cursor_type (XCDR (tem
), &width
);
23251 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23254 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23258 #ifdef HAVE_WINDOW_SYSTEM
23260 /* Return the cursor we want to be displayed in window W. Return
23261 width of bar/hbar cursor through WIDTH arg. Return with
23262 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23263 (i.e. if the `system caret' should track this cursor).
23265 In a mini-buffer window, we want the cursor only to appear if we
23266 are reading input from this window. For the selected window, we
23267 want the cursor type given by the frame parameter or buffer local
23268 setting of cursor-type. If explicitly marked off, draw no cursor.
23269 In all other cases, we want a hollow box cursor. */
23271 static enum text_cursor_kinds
23272 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23273 int *active_cursor
)
23275 struct frame
*f
= XFRAME (w
->frame
);
23276 struct buffer
*b
= XBUFFER (w
->buffer
);
23277 int cursor_type
= DEFAULT_CURSOR
;
23278 Lisp_Object alt_cursor
;
23279 int non_selected
= 0;
23281 *active_cursor
= 1;
23284 if (cursor_in_echo_area
23285 && FRAME_HAS_MINIBUF_P (f
)
23286 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23288 if (w
== XWINDOW (echo_area_window
))
23290 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23292 *width
= FRAME_CURSOR_WIDTH (f
);
23293 return FRAME_DESIRED_CURSOR (f
);
23296 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23299 *active_cursor
= 0;
23303 /* Detect a nonselected window or nonselected frame. */
23304 else if (w
!= XWINDOW (f
->selected_window
)
23305 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23307 *active_cursor
= 0;
23309 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23315 /* Never display a cursor in a window in which cursor-type is nil. */
23316 if (NILP (BVAR (b
, cursor_type
)))
23319 /* Get the normal cursor type for this window. */
23320 if (EQ (BVAR (b
, cursor_type
), Qt
))
23322 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23323 *width
= FRAME_CURSOR_WIDTH (f
);
23326 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23328 /* Use cursor-in-non-selected-windows instead
23329 for non-selected window or frame. */
23332 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23333 if (!EQ (Qt
, alt_cursor
))
23334 return get_specified_cursor_type (alt_cursor
, width
);
23335 /* t means modify the normal cursor type. */
23336 if (cursor_type
== FILLED_BOX_CURSOR
)
23337 cursor_type
= HOLLOW_BOX_CURSOR
;
23338 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23340 return cursor_type
;
23343 /* Use normal cursor if not blinked off. */
23344 if (!w
->cursor_off_p
)
23346 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23348 if (cursor_type
== FILLED_BOX_CURSOR
)
23350 /* Using a block cursor on large images can be very annoying.
23351 So use a hollow cursor for "large" images.
23352 If image is not transparent (no mask), also use hollow cursor. */
23353 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23354 if (img
!= NULL
&& IMAGEP (img
->spec
))
23356 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23357 where N = size of default frame font size.
23358 This should cover most of the "tiny" icons people may use. */
23360 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23361 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23362 cursor_type
= HOLLOW_BOX_CURSOR
;
23365 else if (cursor_type
!= NO_CURSOR
)
23367 /* Display current only supports BOX and HOLLOW cursors for images.
23368 So for now, unconditionally use a HOLLOW cursor when cursor is
23369 not a solid box cursor. */
23370 cursor_type
= HOLLOW_BOX_CURSOR
;
23373 return cursor_type
;
23376 /* Cursor is blinked off, so determine how to "toggle" it. */
23378 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23379 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23380 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23382 /* Then see if frame has specified a specific blink off cursor type. */
23383 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23385 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23386 return FRAME_BLINK_OFF_CURSOR (f
);
23390 /* Some people liked having a permanently visible blinking cursor,
23391 while others had very strong opinions against it. So it was
23392 decided to remove it. KFS 2003-09-03 */
23394 /* Finally perform built-in cursor blinking:
23395 filled box <-> hollow box
23396 wide [h]bar <-> narrow [h]bar
23397 narrow [h]bar <-> no cursor
23398 other type <-> no cursor */
23400 if (cursor_type
== FILLED_BOX_CURSOR
)
23401 return HOLLOW_BOX_CURSOR
;
23403 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23406 return cursor_type
;
23414 /* Notice when the text cursor of window W has been completely
23415 overwritten by a drawing operation that outputs glyphs in AREA
23416 starting at X0 and ending at X1 in the line starting at Y0 and
23417 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23418 the rest of the line after X0 has been written. Y coordinates
23419 are window-relative. */
23422 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23423 int x0
, int x1
, int y0
, int y1
)
23425 int cx0
, cx1
, cy0
, cy1
;
23426 struct glyph_row
*row
;
23428 if (!w
->phys_cursor_on_p
)
23430 if (area
!= TEXT_AREA
)
23433 if (w
->phys_cursor
.vpos
< 0
23434 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23435 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23436 !(row
->enabled_p
&& row
->displays_text_p
)))
23439 if (row
->cursor_in_fringe_p
)
23441 row
->cursor_in_fringe_p
= 0;
23442 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23443 w
->phys_cursor_on_p
= 0;
23447 cx0
= w
->phys_cursor
.x
;
23448 cx1
= cx0
+ w
->phys_cursor_width
;
23449 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23452 /* The cursor image will be completely removed from the
23453 screen if the output area intersects the cursor area in
23454 y-direction. When we draw in [y0 y1[, and some part of
23455 the cursor is at y < y0, that part must have been drawn
23456 before. When scrolling, the cursor is erased before
23457 actually scrolling, so we don't come here. When not
23458 scrolling, the rows above the old cursor row must have
23459 changed, and in this case these rows must have written
23460 over the cursor image.
23462 Likewise if part of the cursor is below y1, with the
23463 exception of the cursor being in the first blank row at
23464 the buffer and window end because update_text_area
23465 doesn't draw that row. (Except when it does, but
23466 that's handled in update_text_area.) */
23468 cy0
= w
->phys_cursor
.y
;
23469 cy1
= cy0
+ w
->phys_cursor_height
;
23470 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23473 w
->phys_cursor_on_p
= 0;
23476 #endif /* HAVE_WINDOW_SYSTEM */
23479 /************************************************************************
23481 ************************************************************************/
23483 #ifdef HAVE_WINDOW_SYSTEM
23486 Fix the display of area AREA of overlapping row ROW in window W
23487 with respect to the overlapping part OVERLAPS. */
23490 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23491 enum glyph_row_area area
, int overlaps
)
23498 for (i
= 0; i
< row
->used
[area
];)
23500 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23502 int start
= i
, start_x
= x
;
23506 x
+= row
->glyphs
[area
][i
].pixel_width
;
23509 while (i
< row
->used
[area
]
23510 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23512 draw_glyphs (w
, start_x
, row
, area
,
23514 DRAW_NORMAL_TEXT
, overlaps
);
23518 x
+= row
->glyphs
[area
][i
].pixel_width
;
23528 Draw the cursor glyph of window W in glyph row ROW. See the
23529 comment of draw_glyphs for the meaning of HL. */
23532 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23533 enum draw_glyphs_face hl
)
23535 /* If cursor hpos is out of bounds, don't draw garbage. This can
23536 happen in mini-buffer windows when switching between echo area
23537 glyphs and mini-buffer. */
23538 if ((row
->reversed_p
23539 ? (w
->phys_cursor
.hpos
>= 0)
23540 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23542 int on_p
= w
->phys_cursor_on_p
;
23544 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23545 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23547 w
->phys_cursor_on_p
= on_p
;
23549 if (hl
== DRAW_CURSOR
)
23550 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23551 /* When we erase the cursor, and ROW is overlapped by other
23552 rows, make sure that these overlapping parts of other rows
23554 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23556 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23558 if (row
> w
->current_matrix
->rows
23559 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23560 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23561 OVERLAPS_ERASED_CURSOR
);
23563 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23564 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23565 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23566 OVERLAPS_ERASED_CURSOR
);
23573 Erase the image of a cursor of window W from the screen. */
23576 erase_phys_cursor (struct window
*w
)
23578 struct frame
*f
= XFRAME (w
->frame
);
23579 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23580 int hpos
= w
->phys_cursor
.hpos
;
23581 int vpos
= w
->phys_cursor
.vpos
;
23582 int mouse_face_here_p
= 0;
23583 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23584 struct glyph_row
*cursor_row
;
23585 struct glyph
*cursor_glyph
;
23586 enum draw_glyphs_face hl
;
23588 /* No cursor displayed or row invalidated => nothing to do on the
23590 if (w
->phys_cursor_type
== NO_CURSOR
)
23591 goto mark_cursor_off
;
23593 /* VPOS >= active_glyphs->nrows means that window has been resized.
23594 Don't bother to erase the cursor. */
23595 if (vpos
>= active_glyphs
->nrows
)
23596 goto mark_cursor_off
;
23598 /* If row containing cursor is marked invalid, there is nothing we
23600 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23601 if (!cursor_row
->enabled_p
)
23602 goto mark_cursor_off
;
23604 /* If line spacing is > 0, old cursor may only be partially visible in
23605 window after split-window. So adjust visible height. */
23606 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23607 window_text_bottom_y (w
) - cursor_row
->y
);
23609 /* If row is completely invisible, don't attempt to delete a cursor which
23610 isn't there. This can happen if cursor is at top of a window, and
23611 we switch to a buffer with a header line in that window. */
23612 if (cursor_row
->visible_height
<= 0)
23613 goto mark_cursor_off
;
23615 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23616 if (cursor_row
->cursor_in_fringe_p
)
23618 cursor_row
->cursor_in_fringe_p
= 0;
23619 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23620 goto mark_cursor_off
;
23623 /* This can happen when the new row is shorter than the old one.
23624 In this case, either draw_glyphs or clear_end_of_line
23625 should have cleared the cursor. Note that we wouldn't be
23626 able to erase the cursor in this case because we don't have a
23627 cursor glyph at hand. */
23628 if ((cursor_row
->reversed_p
23629 ? (w
->phys_cursor
.hpos
< 0)
23630 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23631 goto mark_cursor_off
;
23633 /* If the cursor is in the mouse face area, redisplay that when
23634 we clear the cursor. */
23635 if (! NILP (hlinfo
->mouse_face_window
)
23636 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23637 /* Don't redraw the cursor's spot in mouse face if it is at the
23638 end of a line (on a newline). The cursor appears there, but
23639 mouse highlighting does not. */
23640 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23641 mouse_face_here_p
= 1;
23643 /* Maybe clear the display under the cursor. */
23644 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23647 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23650 cursor_glyph
= get_phys_cursor_glyph (w
);
23651 if (cursor_glyph
== NULL
)
23652 goto mark_cursor_off
;
23654 width
= cursor_glyph
->pixel_width
;
23655 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23656 x
= w
->phys_cursor
.x
;
23658 width
-= left_x
- x
;
23659 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23660 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23661 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23664 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23667 /* Erase the cursor by redrawing the character underneath it. */
23668 if (mouse_face_here_p
)
23669 hl
= DRAW_MOUSE_FACE
;
23671 hl
= DRAW_NORMAL_TEXT
;
23672 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23675 w
->phys_cursor_on_p
= 0;
23676 w
->phys_cursor_type
= NO_CURSOR
;
23681 Display or clear cursor of window W. If ON is zero, clear the
23682 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23683 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23686 display_and_set_cursor (struct window
*w
, int on
,
23687 int hpos
, int vpos
, int x
, int y
)
23689 struct frame
*f
= XFRAME (w
->frame
);
23690 int new_cursor_type
;
23691 int new_cursor_width
;
23693 struct glyph_row
*glyph_row
;
23694 struct glyph
*glyph
;
23696 /* This is pointless on invisible frames, and dangerous on garbaged
23697 windows and frames; in the latter case, the frame or window may
23698 be in the midst of changing its size, and x and y may be off the
23700 if (! FRAME_VISIBLE_P (f
)
23701 || FRAME_GARBAGED_P (f
)
23702 || vpos
>= w
->current_matrix
->nrows
23703 || hpos
>= w
->current_matrix
->matrix_w
)
23706 /* If cursor is off and we want it off, return quickly. */
23707 if (!on
&& !w
->phys_cursor_on_p
)
23710 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23711 /* If cursor row is not enabled, we don't really know where to
23712 display the cursor. */
23713 if (!glyph_row
->enabled_p
)
23715 w
->phys_cursor_on_p
= 0;
23720 if (!glyph_row
->exact_window_width_line_p
23721 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23722 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23724 xassert (interrupt_input_blocked
);
23726 /* Set new_cursor_type to the cursor we want to be displayed. */
23727 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23728 &new_cursor_width
, &active_cursor
);
23730 /* If cursor is currently being shown and we don't want it to be or
23731 it is in the wrong place, or the cursor type is not what we want,
23733 if (w
->phys_cursor_on_p
23735 || w
->phys_cursor
.x
!= x
23736 || w
->phys_cursor
.y
!= y
23737 || new_cursor_type
!= w
->phys_cursor_type
23738 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23739 && new_cursor_width
!= w
->phys_cursor_width
)))
23740 erase_phys_cursor (w
);
23742 /* Don't check phys_cursor_on_p here because that flag is only set
23743 to zero in some cases where we know that the cursor has been
23744 completely erased, to avoid the extra work of erasing the cursor
23745 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23746 still not be visible, or it has only been partly erased. */
23749 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23750 w
->phys_cursor_height
= glyph_row
->height
;
23752 /* Set phys_cursor_.* before x_draw_.* is called because some
23753 of them may need the information. */
23754 w
->phys_cursor
.x
= x
;
23755 w
->phys_cursor
.y
= glyph_row
->y
;
23756 w
->phys_cursor
.hpos
= hpos
;
23757 w
->phys_cursor
.vpos
= vpos
;
23760 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23761 new_cursor_type
, new_cursor_width
,
23762 on
, active_cursor
);
23766 /* Switch the display of W's cursor on or off, according to the value
23770 update_window_cursor (struct window
*w
, int on
)
23772 /* Don't update cursor in windows whose frame is in the process
23773 of being deleted. */
23774 if (w
->current_matrix
)
23777 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23778 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23784 /* Call update_window_cursor with parameter ON_P on all leaf windows
23785 in the window tree rooted at W. */
23788 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23792 if (!NILP (w
->hchild
))
23793 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23794 else if (!NILP (w
->vchild
))
23795 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23797 update_window_cursor (w
, on_p
);
23799 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23805 Display the cursor on window W, or clear it, according to ON_P.
23806 Don't change the cursor's position. */
23809 x_update_cursor (struct frame
*f
, int on_p
)
23811 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23816 Clear the cursor of window W to background color, and mark the
23817 cursor as not shown. This is used when the text where the cursor
23818 is about to be rewritten. */
23821 x_clear_cursor (struct window
*w
)
23823 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23824 update_window_cursor (w
, 0);
23827 #endif /* HAVE_WINDOW_SYSTEM */
23829 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23832 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23833 int start_hpos
, int end_hpos
,
23834 enum draw_glyphs_face draw
)
23836 #ifdef HAVE_WINDOW_SYSTEM
23837 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23839 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23843 #if defined (HAVE_GPM) || defined (MSDOS)
23844 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23849 Display the active region described by mouse_face_* according to DRAW. */
23852 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23854 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23855 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23857 if (/* If window is in the process of being destroyed, don't bother
23859 w
->current_matrix
!= NULL
23860 /* Don't update mouse highlight if hidden */
23861 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23862 /* Recognize when we are called to operate on rows that don't exist
23863 anymore. This can happen when a window is split. */
23864 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23866 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23867 struct glyph_row
*row
, *first
, *last
;
23869 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23870 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23872 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23874 int start_hpos
, end_hpos
, start_x
;
23876 /* For all but the first row, the highlight starts at column 0. */
23879 /* R2L rows have BEG and END in reversed order, but the
23880 screen drawing geometry is always left to right. So
23881 we need to mirror the beginning and end of the
23882 highlighted area in R2L rows. */
23883 if (!row
->reversed_p
)
23885 start_hpos
= hlinfo
->mouse_face_beg_col
;
23886 start_x
= hlinfo
->mouse_face_beg_x
;
23888 else if (row
== last
)
23890 start_hpos
= hlinfo
->mouse_face_end_col
;
23891 start_x
= hlinfo
->mouse_face_end_x
;
23899 else if (row
->reversed_p
&& row
== last
)
23901 start_hpos
= hlinfo
->mouse_face_end_col
;
23902 start_x
= hlinfo
->mouse_face_end_x
;
23912 if (!row
->reversed_p
)
23913 end_hpos
= hlinfo
->mouse_face_end_col
;
23914 else if (row
== first
)
23915 end_hpos
= hlinfo
->mouse_face_beg_col
;
23918 end_hpos
= row
->used
[TEXT_AREA
];
23919 if (draw
== DRAW_NORMAL_TEXT
)
23920 row
->fill_line_p
= 1; /* Clear to end of line */
23923 else if (row
->reversed_p
&& row
== first
)
23924 end_hpos
= hlinfo
->mouse_face_beg_col
;
23927 end_hpos
= row
->used
[TEXT_AREA
];
23928 if (draw
== DRAW_NORMAL_TEXT
)
23929 row
->fill_line_p
= 1; /* Clear to end of line */
23932 if (end_hpos
> start_hpos
)
23934 draw_row_with_mouse_face (w
, start_x
, row
,
23935 start_hpos
, end_hpos
, draw
);
23938 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23942 #ifdef HAVE_WINDOW_SYSTEM
23943 /* When we've written over the cursor, arrange for it to
23944 be displayed again. */
23945 if (FRAME_WINDOW_P (f
)
23946 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23949 display_and_set_cursor (w
, 1,
23950 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23951 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23954 #endif /* HAVE_WINDOW_SYSTEM */
23957 #ifdef HAVE_WINDOW_SYSTEM
23958 /* Change the mouse cursor. */
23959 if (FRAME_WINDOW_P (f
))
23961 if (draw
== DRAW_NORMAL_TEXT
23962 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
23963 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23964 else if (draw
== DRAW_MOUSE_FACE
)
23965 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23967 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23969 #endif /* HAVE_WINDOW_SYSTEM */
23973 Clear out the mouse-highlighted active region.
23974 Redraw it un-highlighted first. Value is non-zero if mouse
23975 face was actually drawn unhighlighted. */
23978 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
23982 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
23984 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
23988 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
23989 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
23990 hlinfo
->mouse_face_window
= Qnil
;
23991 hlinfo
->mouse_face_overlay
= Qnil
;
23995 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
23996 within the mouse face on that window. */
23998 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24000 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24002 /* Quickly resolve the easy cases. */
24003 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24004 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24006 if (vpos
< hlinfo
->mouse_face_beg_row
24007 || vpos
> hlinfo
->mouse_face_end_row
)
24009 if (vpos
> hlinfo
->mouse_face_beg_row
24010 && vpos
< hlinfo
->mouse_face_end_row
)
24013 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24015 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24017 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24020 else if ((vpos
== hlinfo
->mouse_face_beg_row
24021 && hpos
>= hlinfo
->mouse_face_beg_col
)
24022 || (vpos
== hlinfo
->mouse_face_end_row
24023 && hpos
< hlinfo
->mouse_face_end_col
))
24028 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24030 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24033 else if ((vpos
== hlinfo
->mouse_face_beg_row
24034 && hpos
<= hlinfo
->mouse_face_beg_col
)
24035 || (vpos
== hlinfo
->mouse_face_end_row
24036 && hpos
> hlinfo
->mouse_face_end_col
))
24044 Non-zero if physical cursor of window W is within mouse face. */
24047 cursor_in_mouse_face_p (struct window
*w
)
24049 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24054 /* Find the glyph rows START_ROW and END_ROW of window W that display
24055 characters between buffer positions START_CHARPOS and END_CHARPOS
24056 (excluding END_CHARPOS). This is similar to row_containing_pos,
24057 but is more accurate when bidi reordering makes buffer positions
24058 change non-linearly with glyph rows. */
24060 rows_from_pos_range (struct window
*w
,
24061 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24062 struct glyph_row
**start
, struct glyph_row
**end
)
24064 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24065 int last_y
= window_text_bottom_y (w
);
24066 struct glyph_row
*row
;
24071 while (!first
->enabled_p
24072 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24075 /* Find the START row. */
24077 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24080 /* A row can potentially be the START row if the range of the
24081 characters it displays intersects the range
24082 [START_CHARPOS..END_CHARPOS). */
24083 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24084 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24085 /* See the commentary in row_containing_pos, for the
24086 explanation of the complicated way to check whether
24087 some position is beyond the end of the characters
24088 displayed by a row. */
24089 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24090 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24091 && !row
->ends_at_zv_p
24092 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24093 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24094 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24095 && !row
->ends_at_zv_p
24096 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24098 /* Found a candidate row. Now make sure at least one of the
24099 glyphs it displays has a charpos from the range
24100 [START_CHARPOS..END_CHARPOS).
24102 This is not obvious because bidi reordering could make
24103 buffer positions of a row be 1,2,3,102,101,100, and if we
24104 want to highlight characters in [50..60), we don't want
24105 this row, even though [50..60) does intersect [1..103),
24106 the range of character positions given by the row's start
24107 and end positions. */
24108 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24109 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24113 if (BUFFERP (g
->object
)
24114 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24123 /* Find the END row. */
24125 /* If the last row is partially visible, start looking for END
24126 from that row, instead of starting from FIRST. */
24127 && !(row
->enabled_p
24128 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24130 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24132 struct glyph_row
*next
= row
+ 1;
24134 if (!next
->enabled_p
24135 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24136 /* The first row >= START whose range of displayed characters
24137 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24138 is the row END + 1. */
24139 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24140 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24141 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24142 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24143 && !next
->ends_at_zv_p
24144 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24145 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24146 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24147 && !next
->ends_at_zv_p
24148 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24155 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24156 but none of the characters it displays are in the range, it is
24158 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24159 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24163 if (BUFFERP (g
->object
)
24164 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24177 /* This function sets the mouse_face_* elements of HLINFO, assuming
24178 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24179 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24180 for the overlay or run of text properties specifying the mouse
24181 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24182 before-string and after-string that must also be highlighted.
24183 COVER_STRING, if non-nil, is a display string that may cover some
24184 or all of the highlighted text. */
24187 mouse_face_from_buffer_pos (Lisp_Object window
,
24188 Mouse_HLInfo
*hlinfo
,
24189 EMACS_INT mouse_charpos
,
24190 EMACS_INT start_charpos
,
24191 EMACS_INT end_charpos
,
24192 Lisp_Object before_string
,
24193 Lisp_Object after_string
,
24194 Lisp_Object cover_string
)
24196 struct window
*w
= XWINDOW (window
);
24197 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24198 struct glyph_row
*r1
, *r2
;
24199 struct glyph
*glyph
, *end
;
24200 EMACS_INT ignore
, pos
;
24203 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24204 xassert (NILP (before_string
) || STRINGP (before_string
));
24205 xassert (NILP (after_string
) || STRINGP (after_string
));
24207 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24208 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24210 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24211 /* If the before-string or display-string contains newlines,
24212 rows_from_pos_range skips to its last row. Move back. */
24213 if (!NILP (before_string
) || !NILP (cover_string
))
24215 struct glyph_row
*prev
;
24216 while ((prev
= r1
- 1, prev
>= first
)
24217 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24218 && prev
->used
[TEXT_AREA
] > 0)
24220 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24221 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24222 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24224 || !(EQ (glyph
->object
, before_string
)
24225 || EQ (glyph
->object
, cover_string
)))
24232 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24233 hlinfo
->mouse_face_past_end
= 1;
24235 else if (!NILP (after_string
))
24237 /* If the after-string has newlines, advance to its last row. */
24238 struct glyph_row
*next
;
24239 struct glyph_row
*last
24240 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24242 for (next
= r2
+ 1;
24244 && next
->used
[TEXT_AREA
] > 0
24245 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24249 /* The rest of the display engine assumes that mouse_face_beg_row is
24250 either above below mouse_face_end_row or identical to it. But
24251 with bidi-reordered continued lines, the row for START_CHARPOS
24252 could be below the row for END_CHARPOS. If so, swap the rows and
24253 store them in correct order. */
24256 struct glyph_row
*tem
= r2
;
24262 hlinfo
->mouse_face_beg_y
= r1
->y
;
24263 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24264 hlinfo
->mouse_face_end_y
= r2
->y
;
24265 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24267 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24268 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24269 could be anywhere in the row and in any order. The strategy
24270 below is to find the leftmost and the rightmost glyph that
24271 belongs to either of these 3 strings, or whose position is
24272 between START_CHARPOS and END_CHARPOS, and highlight all the
24273 glyphs between those two. This may cover more than just the text
24274 between START_CHARPOS and END_CHARPOS if the range of characters
24275 strides the bidi level boundary, e.g. if the beginning is in R2L
24276 text while the end is in L2R text or vice versa. */
24277 if (!r1
->reversed_p
)
24279 /* This row is in a left to right paragraph. Scan it left to
24281 glyph
= r1
->glyphs
[TEXT_AREA
];
24282 end
= glyph
+ r1
->used
[TEXT_AREA
];
24285 /* Skip truncation glyphs at the start of the glyph row. */
24286 if (r1
->displays_text_p
)
24288 && INTEGERP (glyph
->object
)
24289 && glyph
->charpos
< 0;
24291 x
+= glyph
->pixel_width
;
24293 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24294 or COVER_STRING, and the first glyph from buffer whose
24295 position is between START_CHARPOS and END_CHARPOS. */
24297 && !INTEGERP (glyph
->object
)
24298 && !EQ (glyph
->object
, cover_string
)
24299 && !(BUFFERP (glyph
->object
)
24300 && (glyph
->charpos
>= start_charpos
24301 && glyph
->charpos
< end_charpos
));
24304 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24305 are present at buffer positions between START_CHARPOS and
24306 END_CHARPOS, or if they come from an overlay. */
24307 if (EQ (glyph
->object
, before_string
))
24309 pos
= string_buffer_position (w
, before_string
,
24311 /* If pos == 0, it means before_string came from an
24312 overlay, not from a buffer position. */
24313 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24316 else if (EQ (glyph
->object
, after_string
))
24318 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24319 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24322 x
+= glyph
->pixel_width
;
24324 hlinfo
->mouse_face_beg_x
= x
;
24325 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24329 /* This row is in a right to left paragraph. Scan it right to
24333 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24334 glyph
= end
+ r1
->used
[TEXT_AREA
];
24336 /* Skip truncation glyphs at the start of the glyph row. */
24337 if (r1
->displays_text_p
)
24339 && INTEGERP (glyph
->object
)
24340 && glyph
->charpos
< 0;
24344 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24345 or COVER_STRING, and the first glyph from buffer whose
24346 position is between START_CHARPOS and END_CHARPOS. */
24348 && !INTEGERP (glyph
->object
)
24349 && !EQ (glyph
->object
, cover_string
)
24350 && !(BUFFERP (glyph
->object
)
24351 && (glyph
->charpos
>= start_charpos
24352 && glyph
->charpos
< end_charpos
));
24355 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24356 are present at buffer positions between START_CHARPOS and
24357 END_CHARPOS, or if they come from an overlay. */
24358 if (EQ (glyph
->object
, before_string
))
24360 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24361 /* If pos == 0, it means before_string came from an
24362 overlay, not from a buffer position. */
24363 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24366 else if (EQ (glyph
->object
, after_string
))
24368 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24369 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24374 glyph
++; /* first glyph to the right of the highlighted area */
24375 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24376 x
+= g
->pixel_width
;
24377 hlinfo
->mouse_face_beg_x
= x
;
24378 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24381 /* If the highlight ends in a different row, compute GLYPH and END
24382 for the end row. Otherwise, reuse the values computed above for
24383 the row where the highlight begins. */
24386 if (!r2
->reversed_p
)
24388 glyph
= r2
->glyphs
[TEXT_AREA
];
24389 end
= glyph
+ r2
->used
[TEXT_AREA
];
24394 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24395 glyph
= end
+ r2
->used
[TEXT_AREA
];
24399 if (!r2
->reversed_p
)
24401 /* Skip truncation and continuation glyphs near the end of the
24402 row, and also blanks and stretch glyphs inserted by
24403 extend_face_to_end_of_line. */
24405 && INTEGERP ((end
- 1)->object
)
24406 && (end
- 1)->charpos
<= 0)
24408 /* Scan the rest of the glyph row from the end, looking for the
24409 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24410 COVER_STRING, or whose position is between START_CHARPOS
24414 && !INTEGERP (end
->object
)
24415 && !EQ (end
->object
, cover_string
)
24416 && !(BUFFERP (end
->object
)
24417 && (end
->charpos
>= start_charpos
24418 && end
->charpos
< end_charpos
));
24421 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24422 are present at buffer positions between START_CHARPOS and
24423 END_CHARPOS, or if they come from an overlay. */
24424 if (EQ (end
->object
, before_string
))
24426 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24427 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24430 else if (EQ (end
->object
, after_string
))
24432 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24433 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24437 /* Find the X coordinate of the last glyph to be highlighted. */
24438 for (; glyph
<= end
; ++glyph
)
24439 x
+= glyph
->pixel_width
;
24441 hlinfo
->mouse_face_end_x
= x
;
24442 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24446 /* Skip truncation and continuation glyphs near the end of the
24447 row, and also blanks and stretch glyphs inserted by
24448 extend_face_to_end_of_line. */
24452 && INTEGERP (end
->object
)
24453 && end
->charpos
<= 0)
24455 x
+= end
->pixel_width
;
24458 /* Scan the rest of the glyph row from the end, looking for the
24459 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24460 COVER_STRING, or whose position is between START_CHARPOS
24464 && !INTEGERP (end
->object
)
24465 && !EQ (end
->object
, cover_string
)
24466 && !(BUFFERP (end
->object
)
24467 && (end
->charpos
>= start_charpos
24468 && end
->charpos
< end_charpos
));
24471 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24472 are present at buffer positions between START_CHARPOS and
24473 END_CHARPOS, or if they come from an overlay. */
24474 if (EQ (end
->object
, before_string
))
24476 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24477 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24480 else if (EQ (end
->object
, after_string
))
24482 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24483 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24486 x
+= end
->pixel_width
;
24488 hlinfo
->mouse_face_end_x
= x
;
24489 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24492 hlinfo
->mouse_face_window
= window
;
24493 hlinfo
->mouse_face_face_id
24494 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24496 !hlinfo
->mouse_face_hidden
, -1);
24497 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24500 /* The following function is not used anymore (replaced with
24501 mouse_face_from_string_pos), but I leave it here for the time
24502 being, in case someone would. */
24504 #if 0 /* not used */
24506 /* Find the position of the glyph for position POS in OBJECT in
24507 window W's current matrix, and return in *X, *Y the pixel
24508 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24510 RIGHT_P non-zero means return the position of the right edge of the
24511 glyph, RIGHT_P zero means return the left edge position.
24513 If no glyph for POS exists in the matrix, return the position of
24514 the glyph with the next smaller position that is in the matrix, if
24515 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24516 exists in the matrix, return the position of the glyph with the
24517 next larger position in OBJECT.
24519 Value is non-zero if a glyph was found. */
24522 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24523 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24525 int yb
= window_text_bottom_y (w
);
24526 struct glyph_row
*r
;
24527 struct glyph
*best_glyph
= NULL
;
24528 struct glyph_row
*best_row
= NULL
;
24531 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24532 r
->enabled_p
&& r
->y
< yb
;
24535 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24536 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24539 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24540 if (EQ (g
->object
, object
))
24542 if (g
->charpos
== pos
)
24549 else if (best_glyph
== NULL
24550 || ((eabs (g
->charpos
- pos
)
24551 < eabs (best_glyph
->charpos
- pos
))
24554 : g
->charpos
> pos
)))
24568 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24572 *x
+= best_glyph
->pixel_width
;
24577 *vpos
= best_row
- w
->current_matrix
->rows
;
24580 return best_glyph
!= NULL
;
24582 #endif /* not used */
24584 /* Find the positions of the first and the last glyphs in window W's
24585 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24586 (assumed to be a string), and return in HLINFO's mouse_face_*
24587 members the pixel and column/row coordinates of those glyphs. */
24590 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24591 Lisp_Object object
,
24592 EMACS_INT startpos
, EMACS_INT endpos
)
24594 int yb
= window_text_bottom_y (w
);
24595 struct glyph_row
*r
;
24596 struct glyph
*g
, *e
;
24600 /* Find the glyph row with at least one position in the range
24601 [STARTPOS..ENDPOS], and the first glyph in that row whose
24602 position belongs to that range. */
24603 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24604 r
->enabled_p
&& r
->y
< yb
;
24607 if (!r
->reversed_p
)
24609 g
= r
->glyphs
[TEXT_AREA
];
24610 e
= g
+ r
->used
[TEXT_AREA
];
24611 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24612 if (EQ (g
->object
, object
)
24613 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24615 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24616 hlinfo
->mouse_face_beg_y
= r
->y
;
24617 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24618 hlinfo
->mouse_face_beg_x
= gx
;
24627 e
= r
->glyphs
[TEXT_AREA
];
24628 g
= e
+ r
->used
[TEXT_AREA
];
24629 for ( ; g
> e
; --g
)
24630 if (EQ ((g
-1)->object
, object
)
24631 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24633 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24634 hlinfo
->mouse_face_beg_y
= r
->y
;
24635 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24636 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24637 gx
+= g1
->pixel_width
;
24638 hlinfo
->mouse_face_beg_x
= gx
;
24650 /* Starting with the next row, look for the first row which does NOT
24651 include any glyphs whose positions are in the range. */
24652 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24654 g
= r
->glyphs
[TEXT_AREA
];
24655 e
= g
+ r
->used
[TEXT_AREA
];
24657 for ( ; g
< e
; ++g
)
24658 if (EQ (g
->object
, object
)
24659 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24668 /* The highlighted region ends on the previous row. */
24671 /* Set the end row and its vertical pixel coordinate. */
24672 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24673 hlinfo
->mouse_face_end_y
= r
->y
;
24675 /* Compute and set the end column and the end column's horizontal
24676 pixel coordinate. */
24677 if (!r
->reversed_p
)
24679 g
= r
->glyphs
[TEXT_AREA
];
24680 e
= g
+ r
->used
[TEXT_AREA
];
24681 for ( ; e
> g
; --e
)
24682 if (EQ ((e
-1)->object
, object
)
24683 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24685 hlinfo
->mouse_face_end_col
= e
- g
;
24687 for (gx
= r
->x
; g
< e
; ++g
)
24688 gx
+= g
->pixel_width
;
24689 hlinfo
->mouse_face_end_x
= gx
;
24693 e
= r
->glyphs
[TEXT_AREA
];
24694 g
= e
+ r
->used
[TEXT_AREA
];
24695 for (gx
= r
->x
; e
< g
; ++e
)
24697 if (EQ (e
->object
, object
)
24698 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24700 gx
+= e
->pixel_width
;
24702 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24703 hlinfo
->mouse_face_end_x
= gx
;
24707 #ifdef HAVE_WINDOW_SYSTEM
24709 /* See if position X, Y is within a hot-spot of an image. */
24712 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24714 if (!CONSP (hot_spot
))
24717 if (EQ (XCAR (hot_spot
), Qrect
))
24719 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24720 Lisp_Object rect
= XCDR (hot_spot
);
24724 if (!CONSP (XCAR (rect
)))
24726 if (!CONSP (XCDR (rect
)))
24728 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24730 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24732 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24734 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24738 else if (EQ (XCAR (hot_spot
), Qcircle
))
24740 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24741 Lisp_Object circ
= XCDR (hot_spot
);
24742 Lisp_Object lr
, lx0
, ly0
;
24744 && CONSP (XCAR (circ
))
24745 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24746 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24747 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24749 double r
= XFLOATINT (lr
);
24750 double dx
= XINT (lx0
) - x
;
24751 double dy
= XINT (ly0
) - y
;
24752 return (dx
* dx
+ dy
* dy
<= r
* r
);
24755 else if (EQ (XCAR (hot_spot
), Qpoly
))
24757 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24758 if (VECTORP (XCDR (hot_spot
)))
24760 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24761 Lisp_Object
*poly
= v
->contents
;
24765 Lisp_Object lx
, ly
;
24768 /* Need an even number of coordinates, and at least 3 edges. */
24769 if (n
< 6 || n
& 1)
24772 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24773 If count is odd, we are inside polygon. Pixels on edges
24774 may or may not be included depending on actual geometry of the
24776 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24777 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24779 x0
= XINT (lx
), y0
= XINT (ly
);
24780 for (i
= 0; i
< n
; i
+= 2)
24782 int x1
= x0
, y1
= y0
;
24783 if ((lx
= poly
[i
], !INTEGERP (lx
))
24784 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24786 x0
= XINT (lx
), y0
= XINT (ly
);
24788 /* Does this segment cross the X line? */
24796 if (y
> y0
&& y
> y1
)
24798 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24808 find_hot_spot (Lisp_Object map
, int x
, int y
)
24810 while (CONSP (map
))
24812 if (CONSP (XCAR (map
))
24813 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24821 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24823 doc
: /* Lookup in image map MAP coordinates X and Y.
24824 An image map is an alist where each element has the format (AREA ID PLIST).
24825 An AREA is specified as either a rectangle, a circle, or a polygon:
24826 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24827 pixel coordinates of the upper left and bottom right corners.
24828 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24829 and the radius of the circle; r may be a float or integer.
24830 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24831 vector describes one corner in the polygon.
24832 Returns the alist element for the first matching AREA in MAP. */)
24833 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24841 return find_hot_spot (map
, XINT (x
), XINT (y
));
24845 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24847 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24849 /* Do not change cursor shape while dragging mouse. */
24850 if (!NILP (do_mouse_tracking
))
24853 if (!NILP (pointer
))
24855 if (EQ (pointer
, Qarrow
))
24856 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24857 else if (EQ (pointer
, Qhand
))
24858 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24859 else if (EQ (pointer
, Qtext
))
24860 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24861 else if (EQ (pointer
, intern ("hdrag")))
24862 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24863 #ifdef HAVE_X_WINDOWS
24864 else if (EQ (pointer
, intern ("vdrag")))
24865 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24867 else if (EQ (pointer
, intern ("hourglass")))
24868 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24869 else if (EQ (pointer
, Qmodeline
))
24870 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24872 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24875 if (cursor
!= No_Cursor
)
24876 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24879 #endif /* HAVE_WINDOW_SYSTEM */
24881 /* Take proper action when mouse has moved to the mode or header line
24882 or marginal area AREA of window W, x-position X and y-position Y.
24883 X is relative to the start of the text display area of W, so the
24884 width of bitmap areas and scroll bars must be subtracted to get a
24885 position relative to the start of the mode line. */
24888 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24889 enum window_part area
)
24891 struct window
*w
= XWINDOW (window
);
24892 struct frame
*f
= XFRAME (w
->frame
);
24893 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24894 #ifdef HAVE_WINDOW_SYSTEM
24895 Display_Info
*dpyinfo
;
24897 Cursor cursor
= No_Cursor
;
24898 Lisp_Object pointer
= Qnil
;
24899 int dx
, dy
, width
, height
;
24901 Lisp_Object string
, object
= Qnil
;
24902 Lisp_Object pos
, help
;
24904 Lisp_Object mouse_face
;
24905 int original_x_pixel
= x
;
24906 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24907 struct glyph_row
*row
;
24909 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24914 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24915 returns them in row/column units! */
24916 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24917 &object
, &dx
, &dy
, &width
, &height
);
24919 row
= (area
== ON_MODE_LINE
24920 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24921 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24923 /* Find the glyph under the mouse pointer. */
24924 if (row
->mode_line_p
&& row
->enabled_p
)
24926 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24927 end
= glyph
+ row
->used
[TEXT_AREA
];
24929 for (x0
= original_x_pixel
;
24930 glyph
< end
&& x0
>= glyph
->pixel_width
;
24932 x0
-= glyph
->pixel_width
;
24940 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24941 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24942 returns them in row/column units! */
24943 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24944 &object
, &dx
, &dy
, &width
, &height
);
24949 #ifdef HAVE_WINDOW_SYSTEM
24950 if (IMAGEP (object
))
24952 Lisp_Object image_map
, hotspot
;
24953 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24955 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24957 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24959 Lisp_Object area_id
, plist
;
24961 area_id
= XCAR (hotspot
);
24962 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24963 If so, we could look for mouse-enter, mouse-leave
24964 properties in PLIST (and do something...). */
24965 hotspot
= XCDR (hotspot
);
24966 if (CONSP (hotspot
)
24967 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24969 pointer
= Fplist_get (plist
, Qpointer
);
24970 if (NILP (pointer
))
24972 help
= Fplist_get (plist
, Qhelp_echo
);
24975 help_echo_string
= help
;
24976 /* Is this correct? ++kfs */
24977 XSETWINDOW (help_echo_window
, w
);
24978 help_echo_object
= w
->buffer
;
24979 help_echo_pos
= charpos
;
24983 if (NILP (pointer
))
24984 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24986 #endif /* HAVE_WINDOW_SYSTEM */
24988 if (STRINGP (string
))
24990 pos
= make_number (charpos
);
24991 /* If we're on a string with `help-echo' text property, arrange
24992 for the help to be displayed. This is done by setting the
24993 global variable help_echo_string to the help string. */
24996 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24999 help_echo_string
= help
;
25000 XSETWINDOW (help_echo_window
, w
);
25001 help_echo_object
= string
;
25002 help_echo_pos
= charpos
;
25006 #ifdef HAVE_WINDOW_SYSTEM
25007 if (FRAME_WINDOW_P (f
))
25009 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25010 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25011 if (NILP (pointer
))
25012 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25014 /* Change the mouse pointer according to what is under X/Y. */
25016 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25019 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25020 if (!KEYMAPP (map
))
25021 map
= Fget_text_property (pos
, Qkeymap
, string
);
25022 if (!KEYMAPP (map
))
25023 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25028 /* Change the mouse face according to what is under X/Y. */
25029 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25030 if (!NILP (mouse_face
)
25031 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25036 struct glyph
* tmp_glyph
;
25040 int total_pixel_width
;
25041 EMACS_INT begpos
, endpos
, ignore
;
25045 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25046 Qmouse_face
, string
, Qnil
);
25052 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25054 endpos
= SCHARS (string
);
25058 /* Calculate the glyph position GPOS of GLYPH in the
25059 displayed string, relative to the beginning of the
25060 highlighted part of the string.
25062 Note: GPOS is different from CHARPOS. CHARPOS is the
25063 position of GLYPH in the internal string object. A mode
25064 line string format has structures which are converted to
25065 a flattened string by the Emacs Lisp interpreter. The
25066 internal string is an element of those structures. The
25067 displayed string is the flattened string. */
25068 tmp_glyph
= row_start_glyph
;
25069 while (tmp_glyph
< glyph
25070 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25071 && begpos
<= tmp_glyph
->charpos
25072 && tmp_glyph
->charpos
< endpos
)))
25074 gpos
= glyph
- tmp_glyph
;
25076 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25077 the highlighted part of the displayed string to which
25078 GLYPH belongs. Note: GSEQ_LENGTH is different from
25079 SCHARS (STRING), because the latter returns the length of
25080 the internal string. */
25081 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25083 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25084 && begpos
<= tmp_glyph
->charpos
25085 && tmp_glyph
->charpos
< endpos
));
25088 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25090 /* Calculate the total pixel width of all the glyphs between
25091 the beginning of the highlighted area and GLYPH. */
25092 total_pixel_width
= 0;
25093 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25094 total_pixel_width
+= tmp_glyph
->pixel_width
;
25096 /* Pre calculation of re-rendering position. Note: X is in
25097 column units here, after the call to mode_line_string or
25098 marginal_area_string. */
25100 vpos
= (area
== ON_MODE_LINE
25101 ? (w
->current_matrix
)->nrows
- 1
25104 /* If GLYPH's position is included in the region that is
25105 already drawn in mouse face, we have nothing to do. */
25106 if ( EQ (window
, hlinfo
->mouse_face_window
)
25107 && (!row
->reversed_p
25108 ? (hlinfo
->mouse_face_beg_col
<= hpos
25109 && hpos
< hlinfo
->mouse_face_end_col
)
25110 /* In R2L rows we swap BEG and END, see below. */
25111 : (hlinfo
->mouse_face_end_col
<= hpos
25112 && hpos
< hlinfo
->mouse_face_beg_col
))
25113 && hlinfo
->mouse_face_beg_row
== vpos
)
25116 if (clear_mouse_face (hlinfo
))
25117 cursor
= No_Cursor
;
25119 if (!row
->reversed_p
)
25121 hlinfo
->mouse_face_beg_col
= hpos
;
25122 hlinfo
->mouse_face_beg_x
= original_x_pixel
25123 - (total_pixel_width
+ dx
);
25124 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25125 hlinfo
->mouse_face_end_x
= 0;
25129 /* In R2L rows, show_mouse_face expects BEG and END
25130 coordinates to be swapped. */
25131 hlinfo
->mouse_face_end_col
= hpos
;
25132 hlinfo
->mouse_face_end_x
= original_x_pixel
25133 - (total_pixel_width
+ dx
);
25134 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25135 hlinfo
->mouse_face_beg_x
= 0;
25138 hlinfo
->mouse_face_beg_row
= vpos
;
25139 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25140 hlinfo
->mouse_face_beg_y
= 0;
25141 hlinfo
->mouse_face_end_y
= 0;
25142 hlinfo
->mouse_face_past_end
= 0;
25143 hlinfo
->mouse_face_window
= window
;
25145 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25151 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25153 if (NILP (pointer
))
25156 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25157 clear_mouse_face (hlinfo
);
25159 #ifdef HAVE_WINDOW_SYSTEM
25160 if (FRAME_WINDOW_P (f
))
25161 define_frame_cursor1 (f
, cursor
, pointer
);
25167 Take proper action when the mouse has moved to position X, Y on
25168 frame F as regards highlighting characters that have mouse-face
25169 properties. Also de-highlighting chars where the mouse was before.
25170 X and Y can be negative or out of range. */
25173 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25175 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25176 enum window_part part
;
25177 Lisp_Object window
;
25179 Cursor cursor
= No_Cursor
;
25180 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25183 /* When a menu is active, don't highlight because this looks odd. */
25184 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25185 if (popup_activated ())
25189 if (NILP (Vmouse_highlight
)
25190 || !f
->glyphs_initialized_p
25191 || f
->pointer_invisible
)
25194 hlinfo
->mouse_face_mouse_x
= x
;
25195 hlinfo
->mouse_face_mouse_y
= y
;
25196 hlinfo
->mouse_face_mouse_frame
= f
;
25198 if (hlinfo
->mouse_face_defer
)
25201 if (gc_in_progress
)
25203 hlinfo
->mouse_face_deferred_gc
= 1;
25207 /* Which window is that in? */
25208 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25210 /* If we were displaying active text in another window, clear that.
25211 Also clear if we move out of text area in same window. */
25212 if (! EQ (window
, hlinfo
->mouse_face_window
)
25213 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25214 && !NILP (hlinfo
->mouse_face_window
)))
25215 clear_mouse_face (hlinfo
);
25217 /* Not on a window -> return. */
25218 if (!WINDOWP (window
))
25221 /* Reset help_echo_string. It will get recomputed below. */
25222 help_echo_string
= Qnil
;
25224 /* Convert to window-relative pixel coordinates. */
25225 w
= XWINDOW (window
);
25226 frame_to_window_pixel_xy (w
, &x
, &y
);
25228 #ifdef HAVE_WINDOW_SYSTEM
25229 /* Handle tool-bar window differently since it doesn't display a
25231 if (EQ (window
, f
->tool_bar_window
))
25233 note_tool_bar_highlight (f
, x
, y
);
25238 /* Mouse is on the mode, header line or margin? */
25239 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25240 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25242 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25246 #ifdef HAVE_WINDOW_SYSTEM
25247 if (part
== ON_VERTICAL_BORDER
)
25249 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25250 help_echo_string
= build_string ("drag-mouse-1: resize");
25252 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25253 || part
== ON_SCROLL_BAR
)
25254 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25256 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25259 /* Are we in a window whose display is up to date?
25260 And verify the buffer's text has not changed. */
25261 b
= XBUFFER (w
->buffer
);
25262 if (part
== ON_TEXT
25263 && EQ (w
->window_end_valid
, w
->buffer
)
25264 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25265 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25267 int hpos
, vpos
, i
, dx
, dy
, area
;
25269 struct glyph
*glyph
;
25270 Lisp_Object object
;
25271 Lisp_Object mouse_face
= Qnil
, position
;
25272 Lisp_Object
*overlay_vec
= NULL
;
25274 struct buffer
*obuf
;
25275 EMACS_INT obegv
, ozv
;
25278 /* Find the glyph under X/Y. */
25279 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25281 #ifdef HAVE_WINDOW_SYSTEM
25282 /* Look for :pointer property on image. */
25283 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25285 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25286 if (img
!= NULL
&& IMAGEP (img
->spec
))
25288 Lisp_Object image_map
, hotspot
;
25289 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25291 && (hotspot
= find_hot_spot (image_map
,
25292 glyph
->slice
.img
.x
+ dx
,
25293 glyph
->slice
.img
.y
+ dy
),
25295 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25297 Lisp_Object area_id
, plist
;
25299 area_id
= XCAR (hotspot
);
25300 /* Could check AREA_ID to see if we enter/leave this hot-spot.
25301 If so, we could look for mouse-enter, mouse-leave
25302 properties in PLIST (and do something...). */
25303 hotspot
= XCDR (hotspot
);
25304 if (CONSP (hotspot
)
25305 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25307 pointer
= Fplist_get (plist
, Qpointer
);
25308 if (NILP (pointer
))
25310 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25311 if (!NILP (help_echo_string
))
25313 help_echo_window
= window
;
25314 help_echo_object
= glyph
->object
;
25315 help_echo_pos
= glyph
->charpos
;
25319 if (NILP (pointer
))
25320 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25323 #endif /* HAVE_WINDOW_SYSTEM */
25325 /* Clear mouse face if X/Y not over text. */
25327 || area
!= TEXT_AREA
25328 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25329 /* Glyph's OBJECT is an integer for glyphs inserted by the
25330 display engine for its internal purposes, like truncation
25331 and continuation glyphs and blanks beyond the end of
25332 line's text on text terminals. If we are over such a
25333 glyph, we are not over any text. */
25334 || INTEGERP (glyph
->object
)
25335 /* R2L rows have a stretch glyph at their front, which
25336 stands for no text, whereas L2R rows have no glyphs at
25337 all beyond the end of text. Treat such stretch glyphs
25338 like we do with NULL glyphs in L2R rows. */
25339 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25340 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25341 && glyph
->type
== STRETCH_GLYPH
25342 && glyph
->avoid_cursor_p
))
25344 if (clear_mouse_face (hlinfo
))
25345 cursor
= No_Cursor
;
25346 #ifdef HAVE_WINDOW_SYSTEM
25347 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25349 if (area
!= TEXT_AREA
)
25350 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25352 pointer
= Vvoid_text_area_pointer
;
25358 pos
= glyph
->charpos
;
25359 object
= glyph
->object
;
25360 if (!STRINGP (object
) && !BUFFERP (object
))
25363 /* If we get an out-of-range value, return now; avoid an error. */
25364 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25367 /* Make the window's buffer temporarily current for
25368 overlays_at and compute_char_face. */
25369 obuf
= current_buffer
;
25370 current_buffer
= b
;
25376 /* Is this char mouse-active or does it have help-echo? */
25377 position
= make_number (pos
);
25379 if (BUFFERP (object
))
25381 /* Put all the overlays we want in a vector in overlay_vec. */
25382 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25383 /* Sort overlays into increasing priority order. */
25384 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25389 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25392 cursor
= No_Cursor
;
25394 /* Check mouse-face highlighting. */
25396 /* If there exists an overlay with mouse-face overlapping
25397 the one we are currently highlighting, we have to
25398 check if we enter the overlapping overlay, and then
25399 highlight only that. */
25400 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25401 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25403 /* Find the highest priority overlay with a mouse-face. */
25404 Lisp_Object overlay
= Qnil
;
25405 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25407 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25408 if (!NILP (mouse_face
))
25409 overlay
= overlay_vec
[i
];
25412 /* If we're highlighting the same overlay as before, there's
25413 no need to do that again. */
25414 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25415 goto check_help_echo
;
25416 hlinfo
->mouse_face_overlay
= overlay
;
25418 /* Clear the display of the old active region, if any. */
25419 if (clear_mouse_face (hlinfo
))
25420 cursor
= No_Cursor
;
25422 /* If no overlay applies, get a text property. */
25423 if (NILP (overlay
))
25424 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25426 /* Next, compute the bounds of the mouse highlighting and
25428 if (!NILP (mouse_face
) && STRINGP (object
))
25430 /* The mouse-highlighting comes from a display string
25431 with a mouse-face. */
25435 s
= Fprevious_single_property_change
25436 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25437 e
= Fnext_single_property_change
25438 (position
, Qmouse_face
, object
, Qnil
);
25440 s
= make_number (0);
25442 e
= make_number (SCHARS (object
) - 1);
25443 mouse_face_from_string_pos (w
, hlinfo
, object
,
25444 XINT (s
), XINT (e
));
25445 hlinfo
->mouse_face_past_end
= 0;
25446 hlinfo
->mouse_face_window
= window
;
25447 hlinfo
->mouse_face_face_id
25448 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25449 glyph
->face_id
, 1);
25450 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25451 cursor
= No_Cursor
;
25455 /* The mouse-highlighting, if any, comes from an overlay
25456 or text property in the buffer. */
25457 Lisp_Object buffer
, cover_string
;
25459 if (STRINGP (object
))
25461 /* If we are on a display string with no mouse-face,
25462 check if the text under it has one. */
25463 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25464 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25465 pos
= string_buffer_position (w
, object
, start
);
25468 mouse_face
= get_char_property_and_overlay
25469 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25470 buffer
= w
->buffer
;
25471 cover_string
= object
;
25477 cover_string
= Qnil
;
25480 if (!NILP (mouse_face
))
25482 Lisp_Object before
, after
;
25483 Lisp_Object before_string
, after_string
;
25484 /* To correctly find the limits of mouse highlight
25485 in a bidi-reordered buffer, we must not use the
25486 optimization of limiting the search in
25487 previous-single-property-change and
25488 next-single-property-change, because
25489 rows_from_pos_range needs the real start and end
25490 positions to DTRT in this case. That's because
25491 the first row visible in a window does not
25492 necessarily display the character whose position
25493 is the smallest. */
25495 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25496 ? Fmarker_position (w
->start
)
25499 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25500 ? make_number (BUF_Z (XBUFFER (buffer
))
25501 - XFASTINT (w
->window_end_pos
))
25504 if (NILP (overlay
))
25506 /* Handle the text property case. */
25507 before
= Fprevious_single_property_change
25508 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25509 after
= Fnext_single_property_change
25510 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25511 before_string
= after_string
= Qnil
;
25515 /* Handle the overlay case. */
25516 before
= Foverlay_start (overlay
);
25517 after
= Foverlay_end (overlay
);
25518 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25519 after_string
= Foverlay_get (overlay
, Qafter_string
);
25521 if (!STRINGP (before_string
)) before_string
= Qnil
;
25522 if (!STRINGP (after_string
)) after_string
= Qnil
;
25525 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25528 before_string
, after_string
,
25530 cursor
= No_Cursor
;
25537 /* Look for a `help-echo' property. */
25538 if (NILP (help_echo_string
)) {
25539 Lisp_Object help
, overlay
;
25541 /* Check overlays first. */
25542 help
= overlay
= Qnil
;
25543 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25545 overlay
= overlay_vec
[i
];
25546 help
= Foverlay_get (overlay
, Qhelp_echo
);
25551 help_echo_string
= help
;
25552 help_echo_window
= window
;
25553 help_echo_object
= overlay
;
25554 help_echo_pos
= pos
;
25558 Lisp_Object obj
= glyph
->object
;
25559 EMACS_INT charpos
= glyph
->charpos
;
25561 /* Try text properties. */
25564 && charpos
< SCHARS (obj
))
25566 help
= Fget_text_property (make_number (charpos
),
25570 /* If the string itself doesn't specify a help-echo,
25571 see if the buffer text ``under'' it does. */
25572 struct glyph_row
*r
25573 = MATRIX_ROW (w
->current_matrix
, vpos
);
25574 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25575 EMACS_INT p
= string_buffer_position (w
, obj
, start
);
25578 help
= Fget_char_property (make_number (p
),
25579 Qhelp_echo
, w
->buffer
);
25588 else if (BUFFERP (obj
)
25591 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25596 help_echo_string
= help
;
25597 help_echo_window
= window
;
25598 help_echo_object
= obj
;
25599 help_echo_pos
= charpos
;
25604 #ifdef HAVE_WINDOW_SYSTEM
25605 /* Look for a `pointer' property. */
25606 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25608 /* Check overlays first. */
25609 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25610 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25612 if (NILP (pointer
))
25614 Lisp_Object obj
= glyph
->object
;
25615 EMACS_INT charpos
= glyph
->charpos
;
25617 /* Try text properties. */
25620 && charpos
< SCHARS (obj
))
25622 pointer
= Fget_text_property (make_number (charpos
),
25624 if (NILP (pointer
))
25626 /* If the string itself doesn't specify a pointer,
25627 see if the buffer text ``under'' it does. */
25628 struct glyph_row
*r
25629 = MATRIX_ROW (w
->current_matrix
, vpos
);
25630 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25631 EMACS_INT p
= string_buffer_position (w
, obj
, start
);
25633 pointer
= Fget_char_property (make_number (p
),
25634 Qpointer
, w
->buffer
);
25637 else if (BUFFERP (obj
)
25640 pointer
= Fget_text_property (make_number (charpos
),
25644 #endif /* HAVE_WINDOW_SYSTEM */
25648 current_buffer
= obuf
;
25653 #ifdef HAVE_WINDOW_SYSTEM
25654 if (FRAME_WINDOW_P (f
))
25655 define_frame_cursor1 (f
, cursor
, pointer
);
25657 /* This is here to prevent a compiler error, about "label at end of
25658 compound statement". */
25665 Clear any mouse-face on window W. This function is part of the
25666 redisplay interface, and is called from try_window_id and similar
25667 functions to ensure the mouse-highlight is off. */
25670 x_clear_window_mouse_face (struct window
*w
)
25672 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25673 Lisp_Object window
;
25676 XSETWINDOW (window
, w
);
25677 if (EQ (window
, hlinfo
->mouse_face_window
))
25678 clear_mouse_face (hlinfo
);
25684 Just discard the mouse face information for frame F, if any.
25685 This is used when the size of F is changed. */
25688 cancel_mouse_face (struct frame
*f
)
25690 Lisp_Object window
;
25691 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25693 window
= hlinfo
->mouse_face_window
;
25694 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25696 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25697 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25698 hlinfo
->mouse_face_window
= Qnil
;
25704 /***********************************************************************
25706 ***********************************************************************/
25708 #ifdef HAVE_WINDOW_SYSTEM
25710 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25711 which intersects rectangle R. R is in window-relative coordinates. */
25714 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25715 enum glyph_row_area area
)
25717 struct glyph
*first
= row
->glyphs
[area
];
25718 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25719 struct glyph
*last
;
25720 int first_x
, start_x
, x
;
25722 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25723 /* If row extends face to end of line write the whole line. */
25724 draw_glyphs (w
, 0, row
, area
,
25725 0, row
->used
[area
],
25726 DRAW_NORMAL_TEXT
, 0);
25729 /* Set START_X to the window-relative start position for drawing glyphs of
25730 AREA. The first glyph of the text area can be partially visible.
25731 The first glyphs of other areas cannot. */
25732 start_x
= window_box_left_offset (w
, area
);
25734 if (area
== TEXT_AREA
)
25737 /* Find the first glyph that must be redrawn. */
25739 && x
+ first
->pixel_width
< r
->x
)
25741 x
+= first
->pixel_width
;
25745 /* Find the last one. */
25749 && x
< r
->x
+ r
->width
)
25751 x
+= last
->pixel_width
;
25757 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25758 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25759 DRAW_NORMAL_TEXT
, 0);
25764 /* Redraw the parts of the glyph row ROW on window W intersecting
25765 rectangle R. R is in window-relative coordinates. Value is
25766 non-zero if mouse-face was overwritten. */
25769 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25771 xassert (row
->enabled_p
);
25773 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25774 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25775 0, row
->used
[TEXT_AREA
],
25776 DRAW_NORMAL_TEXT
, 0);
25779 if (row
->used
[LEFT_MARGIN_AREA
])
25780 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25781 if (row
->used
[TEXT_AREA
])
25782 expose_area (w
, row
, r
, TEXT_AREA
);
25783 if (row
->used
[RIGHT_MARGIN_AREA
])
25784 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25785 draw_row_fringe_bitmaps (w
, row
);
25788 return row
->mouse_face_p
;
25792 /* Redraw those parts of glyphs rows during expose event handling that
25793 overlap other rows. Redrawing of an exposed line writes over parts
25794 of lines overlapping that exposed line; this function fixes that.
25796 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25797 row in W's current matrix that is exposed and overlaps other rows.
25798 LAST_OVERLAPPING_ROW is the last such row. */
25801 expose_overlaps (struct window
*w
,
25802 struct glyph_row
*first_overlapping_row
,
25803 struct glyph_row
*last_overlapping_row
,
25806 struct glyph_row
*row
;
25808 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25809 if (row
->overlapping_p
)
25811 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25814 if (row
->used
[LEFT_MARGIN_AREA
])
25815 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25817 if (row
->used
[TEXT_AREA
])
25818 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25820 if (row
->used
[RIGHT_MARGIN_AREA
])
25821 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25827 /* Return non-zero if W's cursor intersects rectangle R. */
25830 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25832 XRectangle cr
, result
;
25833 struct glyph
*cursor_glyph
;
25834 struct glyph_row
*row
;
25836 if (w
->phys_cursor
.vpos
>= 0
25837 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25838 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25840 && row
->cursor_in_fringe_p
)
25842 /* Cursor is in the fringe. */
25843 cr
.x
= window_box_right_offset (w
,
25844 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25845 ? RIGHT_MARGIN_AREA
25848 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25849 cr
.height
= row
->height
;
25850 return x_intersect_rectangles (&cr
, r
, &result
);
25853 cursor_glyph
= get_phys_cursor_glyph (w
);
25856 /* r is relative to W's box, but w->phys_cursor.x is relative
25857 to left edge of W's TEXT area. Adjust it. */
25858 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25859 cr
.y
= w
->phys_cursor
.y
;
25860 cr
.width
= cursor_glyph
->pixel_width
;
25861 cr
.height
= w
->phys_cursor_height
;
25862 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25863 I assume the effect is the same -- and this is portable. */
25864 return x_intersect_rectangles (&cr
, r
, &result
);
25866 /* If we don't understand the format, pretend we're not in the hot-spot. */
25872 Draw a vertical window border to the right of window W if W doesn't
25873 have vertical scroll bars. */
25876 x_draw_vertical_border (struct window
*w
)
25878 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25880 /* We could do better, if we knew what type of scroll-bar the adjacent
25881 windows (on either side) have... But we don't :-(
25882 However, I think this works ok. ++KFS 2003-04-25 */
25884 /* Redraw borders between horizontally adjacent windows. Don't
25885 do it for frames with vertical scroll bars because either the
25886 right scroll bar of a window, or the left scroll bar of its
25887 neighbor will suffice as a border. */
25888 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25891 if (!WINDOW_RIGHTMOST_P (w
)
25892 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25894 int x0
, x1
, y0
, y1
;
25896 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25899 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25902 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25904 else if (!WINDOW_LEFTMOST_P (w
)
25905 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25907 int x0
, x1
, y0
, y1
;
25909 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25912 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25915 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25920 /* Redraw the part of window W intersection rectangle FR. Pixel
25921 coordinates in FR are frame-relative. Call this function with
25922 input blocked. Value is non-zero if the exposure overwrites
25926 expose_window (struct window
*w
, XRectangle
*fr
)
25928 struct frame
*f
= XFRAME (w
->frame
);
25930 int mouse_face_overwritten_p
= 0;
25932 /* If window is not yet fully initialized, do nothing. This can
25933 happen when toolkit scroll bars are used and a window is split.
25934 Reconfiguring the scroll bar will generate an expose for a newly
25936 if (w
->current_matrix
== NULL
)
25939 /* When we're currently updating the window, display and current
25940 matrix usually don't agree. Arrange for a thorough display
25942 if (w
== updated_window
)
25944 SET_FRAME_GARBAGED (f
);
25948 /* Frame-relative pixel rectangle of W. */
25949 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25950 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25951 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25952 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25954 if (x_intersect_rectangles (fr
, &wr
, &r
))
25956 int yb
= window_text_bottom_y (w
);
25957 struct glyph_row
*row
;
25958 int cursor_cleared_p
;
25959 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25961 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25962 r
.x
, r
.y
, r
.width
, r
.height
));
25964 /* Convert to window coordinates. */
25965 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25966 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25968 /* Turn off the cursor. */
25969 if (!w
->pseudo_window_p
25970 && phys_cursor_in_rect_p (w
, &r
))
25972 x_clear_cursor (w
);
25973 cursor_cleared_p
= 1;
25976 cursor_cleared_p
= 0;
25978 /* Update lines intersecting rectangle R. */
25979 first_overlapping_row
= last_overlapping_row
= NULL
;
25980 for (row
= w
->current_matrix
->rows
;
25985 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25987 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25988 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25989 || (r
.y
>= y0
&& r
.y
< y1
)
25990 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25992 /* A header line may be overlapping, but there is no need
25993 to fix overlapping areas for them. KFS 2005-02-12 */
25994 if (row
->overlapping_p
&& !row
->mode_line_p
)
25996 if (first_overlapping_row
== NULL
)
25997 first_overlapping_row
= row
;
25998 last_overlapping_row
= row
;
26002 if (expose_line (w
, row
, &r
))
26003 mouse_face_overwritten_p
= 1;
26006 else if (row
->overlapping_p
)
26008 /* We must redraw a row overlapping the exposed area. */
26010 ? y0
+ row
->phys_height
> r
.y
26011 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26013 if (first_overlapping_row
== NULL
)
26014 first_overlapping_row
= row
;
26015 last_overlapping_row
= row
;
26023 /* Display the mode line if there is one. */
26024 if (WINDOW_WANTS_MODELINE_P (w
)
26025 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26027 && row
->y
< r
.y
+ r
.height
)
26029 if (expose_line (w
, row
, &r
))
26030 mouse_face_overwritten_p
= 1;
26033 if (!w
->pseudo_window_p
)
26035 /* Fix the display of overlapping rows. */
26036 if (first_overlapping_row
)
26037 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26040 /* Draw border between windows. */
26041 x_draw_vertical_border (w
);
26043 /* Turn the cursor on again. */
26044 if (cursor_cleared_p
)
26045 update_window_cursor (w
, 1);
26049 return mouse_face_overwritten_p
;
26054 /* Redraw (parts) of all windows in the window tree rooted at W that
26055 intersect R. R contains frame pixel coordinates. Value is
26056 non-zero if the exposure overwrites mouse-face. */
26059 expose_window_tree (struct window
*w
, XRectangle
*r
)
26061 struct frame
*f
= XFRAME (w
->frame
);
26062 int mouse_face_overwritten_p
= 0;
26064 while (w
&& !FRAME_GARBAGED_P (f
))
26066 if (!NILP (w
->hchild
))
26067 mouse_face_overwritten_p
26068 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26069 else if (!NILP (w
->vchild
))
26070 mouse_face_overwritten_p
26071 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26073 mouse_face_overwritten_p
|= expose_window (w
, r
);
26075 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26078 return mouse_face_overwritten_p
;
26083 Redisplay an exposed area of frame F. X and Y are the upper-left
26084 corner of the exposed rectangle. W and H are width and height of
26085 the exposed area. All are pixel values. W or H zero means redraw
26086 the entire frame. */
26089 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26092 int mouse_face_overwritten_p
= 0;
26094 TRACE ((stderr
, "expose_frame "));
26096 /* No need to redraw if frame will be redrawn soon. */
26097 if (FRAME_GARBAGED_P (f
))
26099 TRACE ((stderr
, " garbaged\n"));
26103 /* If basic faces haven't been realized yet, there is no point in
26104 trying to redraw anything. This can happen when we get an expose
26105 event while Emacs is starting, e.g. by moving another window. */
26106 if (FRAME_FACE_CACHE (f
) == NULL
26107 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26109 TRACE ((stderr
, " no faces\n"));
26113 if (w
== 0 || h
== 0)
26116 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26117 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26127 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26128 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26130 if (WINDOWP (f
->tool_bar_window
))
26131 mouse_face_overwritten_p
26132 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26134 #ifdef HAVE_X_WINDOWS
26136 #ifndef USE_X_TOOLKIT
26137 if (WINDOWP (f
->menu_bar_window
))
26138 mouse_face_overwritten_p
26139 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26140 #endif /* not USE_X_TOOLKIT */
26144 /* Some window managers support a focus-follows-mouse style with
26145 delayed raising of frames. Imagine a partially obscured frame,
26146 and moving the mouse into partially obscured mouse-face on that
26147 frame. The visible part of the mouse-face will be highlighted,
26148 then the WM raises the obscured frame. With at least one WM, KDE
26149 2.1, Emacs is not getting any event for the raising of the frame
26150 (even tried with SubstructureRedirectMask), only Expose events.
26151 These expose events will draw text normally, i.e. not
26152 highlighted. Which means we must redo the highlight here.
26153 Subsume it under ``we love X''. --gerd 2001-08-15 */
26154 /* Included in Windows version because Windows most likely does not
26155 do the right thing if any third party tool offers
26156 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26157 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26159 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26160 if (f
== hlinfo
->mouse_face_mouse_frame
)
26162 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26163 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26164 clear_mouse_face (hlinfo
);
26165 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26172 Determine the intersection of two rectangles R1 and R2. Return
26173 the intersection in *RESULT. Value is non-zero if RESULT is not
26177 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26179 XRectangle
*left
, *right
;
26180 XRectangle
*upper
, *lower
;
26181 int intersection_p
= 0;
26183 /* Rearrange so that R1 is the left-most rectangle. */
26185 left
= r1
, right
= r2
;
26187 left
= r2
, right
= r1
;
26189 /* X0 of the intersection is right.x0, if this is inside R1,
26190 otherwise there is no intersection. */
26191 if (right
->x
<= left
->x
+ left
->width
)
26193 result
->x
= right
->x
;
26195 /* The right end of the intersection is the minimum of the
26196 the right ends of left and right. */
26197 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26200 /* Same game for Y. */
26202 upper
= r1
, lower
= r2
;
26204 upper
= r2
, lower
= r1
;
26206 /* The upper end of the intersection is lower.y0, if this is inside
26207 of upper. Otherwise, there is no intersection. */
26208 if (lower
->y
<= upper
->y
+ upper
->height
)
26210 result
->y
= lower
->y
;
26212 /* The lower end of the intersection is the minimum of the lower
26213 ends of upper and lower. */
26214 result
->height
= (min (lower
->y
+ lower
->height
,
26215 upper
->y
+ upper
->height
)
26217 intersection_p
= 1;
26221 return intersection_p
;
26224 #endif /* HAVE_WINDOW_SYSTEM */
26227 /***********************************************************************
26229 ***********************************************************************/
26232 syms_of_xdisp (void)
26234 Vwith_echo_area_save_vector
= Qnil
;
26235 staticpro (&Vwith_echo_area_save_vector
);
26237 Vmessage_stack
= Qnil
;
26238 staticpro (&Vmessage_stack
);
26240 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26241 staticpro (&Qinhibit_redisplay
);
26243 message_dolog_marker1
= Fmake_marker ();
26244 staticpro (&message_dolog_marker1
);
26245 message_dolog_marker2
= Fmake_marker ();
26246 staticpro (&message_dolog_marker2
);
26247 message_dolog_marker3
= Fmake_marker ();
26248 staticpro (&message_dolog_marker3
);
26251 defsubr (&Sdump_frame_glyph_matrix
);
26252 defsubr (&Sdump_glyph_matrix
);
26253 defsubr (&Sdump_glyph_row
);
26254 defsubr (&Sdump_tool_bar_row
);
26255 defsubr (&Strace_redisplay
);
26256 defsubr (&Strace_to_stderr
);
26258 #ifdef HAVE_WINDOW_SYSTEM
26259 defsubr (&Stool_bar_lines_needed
);
26260 defsubr (&Slookup_image_map
);
26262 defsubr (&Sformat_mode_line
);
26263 defsubr (&Sinvisible_p
);
26264 defsubr (&Scurrent_bidi_paragraph_direction
);
26266 staticpro (&Qmenu_bar_update_hook
);
26267 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26269 staticpro (&Qoverriding_terminal_local_map
);
26270 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26272 staticpro (&Qoverriding_local_map
);
26273 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26275 staticpro (&Qwindow_scroll_functions
);
26276 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26278 staticpro (&Qwindow_text_change_functions
);
26279 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26281 staticpro (&Qredisplay_end_trigger_functions
);
26282 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26284 staticpro (&Qinhibit_point_motion_hooks
);
26285 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26287 Qeval
= intern_c_string ("eval");
26288 staticpro (&Qeval
);
26290 QCdata
= intern_c_string (":data");
26291 staticpro (&QCdata
);
26292 Qdisplay
= intern_c_string ("display");
26293 staticpro (&Qdisplay
);
26294 Qspace_width
= intern_c_string ("space-width");
26295 staticpro (&Qspace_width
);
26296 Qraise
= intern_c_string ("raise");
26297 staticpro (&Qraise
);
26298 Qslice
= intern_c_string ("slice");
26299 staticpro (&Qslice
);
26300 Qspace
= intern_c_string ("space");
26301 staticpro (&Qspace
);
26302 Qmargin
= intern_c_string ("margin");
26303 staticpro (&Qmargin
);
26304 Qpointer
= intern_c_string ("pointer");
26305 staticpro (&Qpointer
);
26306 Qleft_margin
= intern_c_string ("left-margin");
26307 staticpro (&Qleft_margin
);
26308 Qright_margin
= intern_c_string ("right-margin");
26309 staticpro (&Qright_margin
);
26310 Qcenter
= intern_c_string ("center");
26311 staticpro (&Qcenter
);
26312 Qline_height
= intern_c_string ("line-height");
26313 staticpro (&Qline_height
);
26314 QCalign_to
= intern_c_string (":align-to");
26315 staticpro (&QCalign_to
);
26316 QCrelative_width
= intern_c_string (":relative-width");
26317 staticpro (&QCrelative_width
);
26318 QCrelative_height
= intern_c_string (":relative-height");
26319 staticpro (&QCrelative_height
);
26320 QCeval
= intern_c_string (":eval");
26321 staticpro (&QCeval
);
26322 QCpropertize
= intern_c_string (":propertize");
26323 staticpro (&QCpropertize
);
26324 QCfile
= intern_c_string (":file");
26325 staticpro (&QCfile
);
26326 Qfontified
= intern_c_string ("fontified");
26327 staticpro (&Qfontified
);
26328 Qfontification_functions
= intern_c_string ("fontification-functions");
26329 staticpro (&Qfontification_functions
);
26330 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26331 staticpro (&Qtrailing_whitespace
);
26332 Qescape_glyph
= intern_c_string ("escape-glyph");
26333 staticpro (&Qescape_glyph
);
26334 Qnobreak_space
= intern_c_string ("nobreak-space");
26335 staticpro (&Qnobreak_space
);
26336 Qimage
= intern_c_string ("image");
26337 staticpro (&Qimage
);
26338 Qtext
= intern_c_string ("text");
26339 staticpro (&Qtext
);
26340 Qboth
= intern_c_string ("both");
26341 staticpro (&Qboth
);
26342 Qboth_horiz
= intern_c_string ("both-horiz");
26343 staticpro (&Qboth_horiz
);
26344 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26345 staticpro (&Qtext_image_horiz
);
26346 QCmap
= intern_c_string (":map");
26347 staticpro (&QCmap
);
26348 QCpointer
= intern_c_string (":pointer");
26349 staticpro (&QCpointer
);
26350 Qrect
= intern_c_string ("rect");
26351 staticpro (&Qrect
);
26352 Qcircle
= intern_c_string ("circle");
26353 staticpro (&Qcircle
);
26354 Qpoly
= intern_c_string ("poly");
26355 staticpro (&Qpoly
);
26356 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26357 staticpro (&Qmessage_truncate_lines
);
26358 Qgrow_only
= intern_c_string ("grow-only");
26359 staticpro (&Qgrow_only
);
26360 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26361 staticpro (&Qinhibit_menubar_update
);
26362 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26363 staticpro (&Qinhibit_eval_during_redisplay
);
26364 Qposition
= intern_c_string ("position");
26365 staticpro (&Qposition
);
26366 Qbuffer_position
= intern_c_string ("buffer-position");
26367 staticpro (&Qbuffer_position
);
26368 Qobject
= intern_c_string ("object");
26369 staticpro (&Qobject
);
26370 Qbar
= intern_c_string ("bar");
26372 Qhbar
= intern_c_string ("hbar");
26373 staticpro (&Qhbar
);
26374 Qbox
= intern_c_string ("box");
26376 Qhollow
= intern_c_string ("hollow");
26377 staticpro (&Qhollow
);
26378 Qhand
= intern_c_string ("hand");
26379 staticpro (&Qhand
);
26380 Qarrow
= intern_c_string ("arrow");
26381 staticpro (&Qarrow
);
26382 Qtext
= intern_c_string ("text");
26383 staticpro (&Qtext
);
26384 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26385 staticpro (&Qinhibit_free_realized_faces
);
26387 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26388 Fcons (intern_c_string ("void-variable"), Qnil
)),
26390 staticpro (&list_of_error
);
26392 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26393 staticpro (&Qlast_arrow_position
);
26394 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26395 staticpro (&Qlast_arrow_string
);
26397 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26398 staticpro (&Qoverlay_arrow_string
);
26399 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26400 staticpro (&Qoverlay_arrow_bitmap
);
26402 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26403 staticpro (&echo_buffer
[0]);
26404 staticpro (&echo_buffer
[1]);
26406 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26407 staticpro (&echo_area_buffer
[0]);
26408 staticpro (&echo_area_buffer
[1]);
26410 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26411 staticpro (&Vmessages_buffer_name
);
26413 mode_line_proptrans_alist
= Qnil
;
26414 staticpro (&mode_line_proptrans_alist
);
26415 mode_line_string_list
= Qnil
;
26416 staticpro (&mode_line_string_list
);
26417 mode_line_string_face
= Qnil
;
26418 staticpro (&mode_line_string_face
);
26419 mode_line_string_face_prop
= Qnil
;
26420 staticpro (&mode_line_string_face_prop
);
26421 Vmode_line_unwind_vector
= Qnil
;
26422 staticpro (&Vmode_line_unwind_vector
);
26424 help_echo_string
= Qnil
;
26425 staticpro (&help_echo_string
);
26426 help_echo_object
= Qnil
;
26427 staticpro (&help_echo_object
);
26428 help_echo_window
= Qnil
;
26429 staticpro (&help_echo_window
);
26430 previous_help_echo_string
= Qnil
;
26431 staticpro (&previous_help_echo_string
);
26432 help_echo_pos
= -1;
26434 Qright_to_left
= intern_c_string ("right-to-left");
26435 staticpro (&Qright_to_left
);
26436 Qleft_to_right
= intern_c_string ("left-to-right");
26437 staticpro (&Qleft_to_right
);
26439 #ifdef HAVE_WINDOW_SYSTEM
26440 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26441 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26442 For example, if a block cursor is over a tab, it will be drawn as
26443 wide as that tab on the display. */);
26444 x_stretch_cursor_p
= 0;
26447 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26448 doc
: /* *Non-nil means highlight trailing whitespace.
26449 The face used for trailing whitespace is `trailing-whitespace'. */);
26450 Vshow_trailing_whitespace
= Qnil
;
26452 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26453 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26454 A value of t means highlight the character itself (for nobreak space,
26455 use face `nobreak-space').
26456 A value of nil means no highlighting.
26457 Other values mean display the escape glyph followed by an ordinary
26458 space or ordinary hyphen. */);
26459 Vnobreak_char_display
= Qt
;
26461 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26462 doc
: /* *The pointer shape to show in void text areas.
26463 A value of nil means to show the text pointer. Other options are `arrow',
26464 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26465 Vvoid_text_area_pointer
= Qarrow
;
26467 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26468 doc
: /* Non-nil means don't actually do any redisplay.
26469 This is used for internal purposes. */);
26470 Vinhibit_redisplay
= Qnil
;
26472 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26473 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26474 Vglobal_mode_string
= Qnil
;
26476 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26477 doc
: /* Marker for where to display an arrow on top of the buffer text.
26478 This must be the beginning of a line in order to work.
26479 See also `overlay-arrow-string'. */);
26480 Voverlay_arrow_position
= Qnil
;
26482 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26483 doc
: /* String to display as an arrow in non-window frames.
26484 See also `overlay-arrow-position'. */);
26485 Voverlay_arrow_string
= make_pure_c_string ("=>");
26487 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26488 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26489 The symbols on this list are examined during redisplay to determine
26490 where to display overlay arrows. */);
26491 Voverlay_arrow_variable_list
26492 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26494 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26495 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26496 If that fails to bring point back on frame, point is centered instead.
26497 If this is zero, point is always centered after it moves off frame.
26498 If you want scrolling to always be a line at a time, you should set
26499 `scroll-conservatively' to a large value rather than set this to 1. */);
26501 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26502 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26503 If point moves off-screen, redisplay will scroll by up to
26504 `scroll-conservatively' lines in order to bring point just barely
26505 onto the screen again. If that cannot be done, then redisplay
26506 recenters point as usual.
26508 A value of zero means always recenter point if it moves off screen. */);
26509 scroll_conservatively
= 0;
26511 DEFVAR_INT ("scroll-margin", scroll_margin
,
26512 doc
: /* *Number of lines of margin at the top and bottom of a window.
26513 Recenter the window whenever point gets within this many lines
26514 of the top or bottom of the window. */);
26517 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26518 doc
: /* Pixels per inch value for non-window system displays.
26519 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26520 Vdisplay_pixels_per_inch
= make_float (72.0);
26523 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26526 DEFVAR_LISP ("truncate-partial-width-windows",
26527 Vtruncate_partial_width_windows
,
26528 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26529 For an integer value, truncate lines in each window narrower than the
26530 full frame width, provided the window width is less than that integer;
26531 otherwise, respect the value of `truncate-lines'.
26533 For any other non-nil value, truncate lines in all windows that do
26534 not span the full frame width.
26536 A value of nil means to respect the value of `truncate-lines'.
26538 If `word-wrap' is enabled, you might want to reduce this. */);
26539 Vtruncate_partial_width_windows
= make_number (50);
26541 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26542 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26543 Any other value means to use the appropriate face, `mode-line',
26544 `header-line', or `menu' respectively. */);
26545 mode_line_inverse_video
= 1;
26547 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26548 doc
: /* *Maximum buffer size for which line number should be displayed.
26549 If the buffer is bigger than this, the line number does not appear
26550 in the mode line. A value of nil means no limit. */);
26551 Vline_number_display_limit
= Qnil
;
26553 DEFVAR_INT ("line-number-display-limit-width",
26554 line_number_display_limit_width
,
26555 doc
: /* *Maximum line width (in characters) for line number display.
26556 If the average length of the lines near point is bigger than this, then the
26557 line number may be omitted from the mode line. */);
26558 line_number_display_limit_width
= 200;
26560 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26561 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26562 highlight_nonselected_windows
= 0;
26564 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26565 doc
: /* Non-nil if more than one frame is visible on this display.
26566 Minibuffer-only frames don't count, but iconified frames do.
26567 This variable is not guaranteed to be accurate except while processing
26568 `frame-title-format' and `icon-title-format'. */);
26570 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26571 doc
: /* Template for displaying the title bar of visible frames.
26572 \(Assuming the window manager supports this feature.)
26574 This variable has the same structure as `mode-line-format', except that
26575 the %c and %l constructs are ignored. It is used only on frames for
26576 which no explicit name has been set \(see `modify-frame-parameters'). */);
26578 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26579 doc
: /* Template for displaying the title bar of an iconified frame.
26580 \(Assuming the window manager supports this feature.)
26581 This variable has the same structure as `mode-line-format' (which see),
26582 and is used only on frames for which no explicit name has been set
26583 \(see `modify-frame-parameters'). */);
26585 = Vframe_title_format
26586 = pure_cons (intern_c_string ("multiple-frames"),
26587 pure_cons (make_pure_c_string ("%b"),
26588 pure_cons (pure_cons (empty_unibyte_string
,
26589 pure_cons (intern_c_string ("invocation-name"),
26590 pure_cons (make_pure_c_string ("@"),
26591 pure_cons (intern_c_string ("system-name"),
26595 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26596 doc
: /* Maximum number of lines to keep in the message log buffer.
26597 If nil, disable message logging. If t, log messages but don't truncate
26598 the buffer when it becomes large. */);
26599 Vmessage_log_max
= make_number (100);
26601 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26602 doc
: /* Functions called before redisplay, if window sizes have changed.
26603 The value should be a list of functions that take one argument.
26604 Just before redisplay, for each frame, if any of its windows have changed
26605 size since the last redisplay, or have been split or deleted,
26606 all the functions in the list are called, with the frame as argument. */);
26607 Vwindow_size_change_functions
= Qnil
;
26609 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26610 doc
: /* List of functions to call before redisplaying a window with scrolling.
26611 Each function is called with two arguments, the window and its new
26612 display-start position. Note that these functions are also called by
26613 `set-window-buffer'. Also note that the value of `window-end' is not
26614 valid when these functions are called. */);
26615 Vwindow_scroll_functions
= Qnil
;
26617 DEFVAR_LISP ("window-text-change-functions",
26618 Vwindow_text_change_functions
,
26619 doc
: /* Functions to call in redisplay when text in the window might change. */);
26620 Vwindow_text_change_functions
= Qnil
;
26622 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26623 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26624 Each function is called with two arguments, the window and the end trigger value.
26625 See `set-window-redisplay-end-trigger'. */);
26626 Vredisplay_end_trigger_functions
= Qnil
;
26628 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26629 doc
: /* *Non-nil means autoselect window with mouse pointer.
26630 If nil, do not autoselect windows.
26631 A positive number means delay autoselection by that many seconds: a
26632 window is autoselected only after the mouse has remained in that
26633 window for the duration of the delay.
26634 A negative number has a similar effect, but causes windows to be
26635 autoselected only after the mouse has stopped moving. \(Because of
26636 the way Emacs compares mouse events, you will occasionally wait twice
26637 that time before the window gets selected.\)
26638 Any other value means to autoselect window instantaneously when the
26639 mouse pointer enters it.
26641 Autoselection selects the minibuffer only if it is active, and never
26642 unselects the minibuffer if it is active.
26644 When customizing this variable make sure that the actual value of
26645 `focus-follows-mouse' matches the behavior of your window manager. */);
26646 Vmouse_autoselect_window
= Qnil
;
26648 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26649 doc
: /* *Non-nil means automatically resize tool-bars.
26650 This dynamically changes the tool-bar's height to the minimum height
26651 that is needed to make all tool-bar items visible.
26652 If value is `grow-only', the tool-bar's height is only increased
26653 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26654 Vauto_resize_tool_bars
= Qt
;
26656 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26657 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26658 auto_raise_tool_bar_buttons_p
= 1;
26660 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26661 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26662 make_cursor_line_fully_visible_p
= 1;
26664 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26665 doc
: /* *Border below tool-bar in pixels.
26666 If an integer, use it as the height of the border.
26667 If it is one of `internal-border-width' or `border-width', use the
26668 value of the corresponding frame parameter.
26669 Otherwise, no border is added below the tool-bar. */);
26670 Vtool_bar_border
= Qinternal_border_width
;
26672 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26673 doc
: /* *Margin around tool-bar buttons in pixels.
26674 If an integer, use that for both horizontal and vertical margins.
26675 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26676 HORZ specifying the horizontal margin, and VERT specifying the
26677 vertical margin. */);
26678 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26680 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26681 doc
: /* *Relief thickness of tool-bar buttons. */);
26682 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26684 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26685 doc
: /* Tool bar style to use.
26687 image - show images only
26688 text - show text only
26689 both - show both, text below image
26690 both-horiz - show text to the right of the image
26691 text-image-horiz - show text to the left of the image
26692 any other - use system default or image if no system default. */);
26693 Vtool_bar_style
= Qnil
;
26695 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26696 doc
: /* *Maximum number of characters a label can have to be shown.
26697 The tool bar style must also show labels for this to have any effect, see
26698 `tool-bar-style'. */);
26699 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26701 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26702 doc
: /* List of functions to call to fontify regions of text.
26703 Each function is called with one argument POS. Functions must
26704 fontify a region starting at POS in the current buffer, and give
26705 fontified regions the property `fontified'. */);
26706 Vfontification_functions
= Qnil
;
26707 Fmake_variable_buffer_local (Qfontification_functions
);
26709 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26710 unibyte_display_via_language_environment
,
26711 doc
: /* *Non-nil means display unibyte text according to language environment.
26712 Specifically, this means that raw bytes in the range 160-255 decimal
26713 are displayed by converting them to the equivalent multibyte characters
26714 according to the current language environment. As a result, they are
26715 displayed according to the current fontset.
26717 Note that this variable affects only how these bytes are displayed,
26718 but does not change the fact they are interpreted as raw bytes. */);
26719 unibyte_display_via_language_environment
= 0;
26721 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26722 doc
: /* *Maximum height for resizing mini-windows.
26723 If a float, it specifies a fraction of the mini-window frame's height.
26724 If an integer, it specifies a number of lines. */);
26725 Vmax_mini_window_height
= make_float (0.25);
26727 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26728 doc
: /* *How to resize mini-windows.
26729 A value of nil means don't automatically resize mini-windows.
26730 A value of t means resize them to fit the text displayed in them.
26731 A value of `grow-only', the default, means let mini-windows grow
26732 only, until their display becomes empty, at which point the windows
26733 go back to their normal size. */);
26734 Vresize_mini_windows
= Qgrow_only
;
26736 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26737 doc
: /* Alist specifying how to blink the cursor off.
26738 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26739 `cursor-type' frame-parameter or variable equals ON-STATE,
26740 comparing using `equal', Emacs uses OFF-STATE to specify
26741 how to blink it off. ON-STATE and OFF-STATE are values for
26742 the `cursor-type' frame parameter.
26744 If a frame's ON-STATE has no entry in this list,
26745 the frame's other specifications determine how to blink the cursor off. */);
26746 Vblink_cursor_alist
= Qnil
;
26748 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26749 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26750 If non-nil, windows are automatically scrolled horizontally to make
26751 point visible. */);
26752 automatic_hscrolling_p
= 1;
26753 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26754 staticpro (&Qauto_hscroll_mode
);
26756 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26757 doc
: /* *How many columns away from the window edge point is allowed to get
26758 before automatic hscrolling will horizontally scroll the window. */);
26759 hscroll_margin
= 5;
26761 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26762 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26763 When point is less than `hscroll-margin' columns from the window
26764 edge, automatic hscrolling will scroll the window by the amount of columns
26765 determined by this variable. If its value is a positive integer, scroll that
26766 many columns. If it's a positive floating-point number, it specifies the
26767 fraction of the window's width to scroll. If it's nil or zero, point will be
26768 centered horizontally after the scroll. Any other value, including negative
26769 numbers, are treated as if the value were zero.
26771 Automatic hscrolling always moves point outside the scroll margin, so if
26772 point was more than scroll step columns inside the margin, the window will
26773 scroll more than the value given by the scroll step.
26775 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26776 and `scroll-right' overrides this variable's effect. */);
26777 Vhscroll_step
= make_number (0);
26779 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26780 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26781 Bind this around calls to `message' to let it take effect. */);
26782 message_truncate_lines
= 0;
26784 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26785 doc
: /* Normal hook run to update the menu bar definitions.
26786 Redisplay runs this hook before it redisplays the menu bar.
26787 This is used to update submenus such as Buffers,
26788 whose contents depend on various data. */);
26789 Vmenu_bar_update_hook
= Qnil
;
26791 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26792 doc
: /* Frame for which we are updating a menu.
26793 The enable predicate for a menu binding should check this variable. */);
26794 Vmenu_updating_frame
= Qnil
;
26796 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26797 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26798 inhibit_menubar_update
= 0;
26800 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26801 doc
: /* Prefix prepended to all continuation lines at display time.
26802 The value may be a string, an image, or a stretch-glyph; it is
26803 interpreted in the same way as the value of a `display' text property.
26805 This variable is overridden by any `wrap-prefix' text or overlay
26808 To add a prefix to non-continuation lines, use `line-prefix'. */);
26809 Vwrap_prefix
= Qnil
;
26810 staticpro (&Qwrap_prefix
);
26811 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26812 Fmake_variable_buffer_local (Qwrap_prefix
);
26814 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26815 doc
: /* Prefix prepended to all non-continuation lines at display time.
26816 The value may be a string, an image, or a stretch-glyph; it is
26817 interpreted in the same way as the value of a `display' text property.
26819 This variable is overridden by any `line-prefix' text or overlay
26822 To add a prefix to continuation lines, use `wrap-prefix'. */);
26823 Vline_prefix
= Qnil
;
26824 staticpro (&Qline_prefix
);
26825 Qline_prefix
= intern_c_string ("line-prefix");
26826 Fmake_variable_buffer_local (Qline_prefix
);
26828 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26829 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26830 inhibit_eval_during_redisplay
= 0;
26832 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26833 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26834 inhibit_free_realized_faces
= 0;
26837 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26838 doc
: /* Inhibit try_window_id display optimization. */);
26839 inhibit_try_window_id
= 0;
26841 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26842 doc
: /* Inhibit try_window_reusing display optimization. */);
26843 inhibit_try_window_reusing
= 0;
26845 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26846 doc
: /* Inhibit try_cursor_movement display optimization. */);
26847 inhibit_try_cursor_movement
= 0;
26848 #endif /* GLYPH_DEBUG */
26850 DEFVAR_INT ("overline-margin", overline_margin
,
26851 doc
: /* *Space between overline and text, in pixels.
26852 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26853 margin to the caracter height. */);
26854 overline_margin
= 2;
26856 DEFVAR_INT ("underline-minimum-offset",
26857 underline_minimum_offset
,
26858 doc
: /* Minimum distance between baseline and underline.
26859 This can improve legibility of underlined text at small font sizes,
26860 particularly when using variable `x-use-underline-position-properties'
26861 with fonts that specify an UNDERLINE_POSITION relatively close to the
26862 baseline. The default value is 1. */);
26863 underline_minimum_offset
= 1;
26865 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26866 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26867 This feature only works when on a window system that can change
26868 cursor shapes. */);
26869 display_hourglass_p
= 1;
26871 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26872 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26873 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26875 hourglass_atimer
= NULL
;
26876 hourglass_shown_p
= 0;
26878 DEFSYM (Qglyphless_char
, "glyphless-char");
26879 DEFSYM (Qhex_code
, "hex-code");
26880 DEFSYM (Qempty_box
, "empty-box");
26881 DEFSYM (Qthin_space
, "thin-space");
26882 DEFSYM (Qzero_width
, "zero-width");
26884 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26885 /* Intern this now in case it isn't already done.
26886 Setting this variable twice is harmless.
26887 But don't staticpro it here--that is done in alloc.c. */
26888 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26889 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26891 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26892 doc
: /* Char-table to control displaying of glyphless characters.
26893 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26894 or one of these symbols:
26895 hex-code: display the hexadecimal code of a character in a box
26896 empty-box: display as an empty box
26897 thin-space: display as 1-pixel width space
26898 zero-width: don't display
26900 It has one extra slot to control the display of a character for which
26901 no font is found. The value of the slot is `hex-code' or `empty-box'.
26902 The default is `empty-box'. */);
26903 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26904 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26909 /* Initialize this module when Emacs starts. */
26914 Lisp_Object root_window
;
26915 struct window
*mini_w
;
26917 current_header_line_height
= current_mode_line_height
= -1;
26919 CHARPOS (this_line_start_pos
) = 0;
26921 mini_w
= XWINDOW (minibuf_window
);
26922 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26924 if (!noninteractive
)
26926 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26929 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26930 set_window_height (root_window
,
26931 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26933 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26934 set_window_height (minibuf_window
, 1, 0);
26936 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26937 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26939 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26940 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26941 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26943 /* The default ellipsis glyphs `...'. */
26944 for (i
= 0; i
< 3; ++i
)
26945 default_invis_vector
[i
] = make_number ('.');
26949 /* Allocate the buffer for frame titles.
26950 Also used for `format-mode-line'. */
26952 mode_line_noprop_buf
= (char *) xmalloc (size
);
26953 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26954 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26955 mode_line_target
= MODE_LINE_DISPLAY
;
26958 help_echo_showing_p
= 0;
26961 /* Since w32 does not support atimers, it defines its own implementation of
26962 the following three functions in w32fns.c. */
26965 /* Platform-independent portion of hourglass implementation. */
26967 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26969 hourglass_started (void)
26971 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26974 /* Cancel a currently active hourglass timer, and start a new one. */
26976 start_hourglass (void)
26978 #if defined (HAVE_WINDOW_SYSTEM)
26980 int secs
, usecs
= 0;
26982 cancel_hourglass ();
26984 if (INTEGERP (Vhourglass_delay
)
26985 && XINT (Vhourglass_delay
) > 0)
26986 secs
= XFASTINT (Vhourglass_delay
);
26987 else if (FLOATP (Vhourglass_delay
)
26988 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26991 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26992 secs
= XFASTINT (tem
);
26993 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26996 secs
= DEFAULT_HOURGLASS_DELAY
;
26998 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26999 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27000 show_hourglass
, NULL
);
27005 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27008 cancel_hourglass (void)
27010 #if defined (HAVE_WINDOW_SYSTEM)
27011 if (hourglass_atimer
)
27013 cancel_atimer (hourglass_atimer
);
27014 hourglass_atimer
= NULL
;
27017 if (hourglass_shown_p
)
27021 #endif /* ! WINDOWSNT */