1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator.
133 Calls to get_next_display_element fill the iterator structure with
134 relevant information about the next thing to display. Calls to
135 set_iterator_to_next move the iterator to the next thing.
137 Besides this, an iterator also contains information about the
138 display environment in which glyphs for display elements are to be
139 produced. It has fields for the width and height of the display,
140 the information whether long lines are truncated or continued, a
141 current X and Y position, and lots of other stuff you can better
144 Glyphs in a desired matrix are normally constructed in a loop
145 calling get_next_display_element and then PRODUCE_GLYPHS. The call
146 to PRODUCE_GLYPHS will fill the iterator structure with pixel
147 information about the element being displayed and at the same time
148 produce glyphs for it. If the display element fits on the line
149 being displayed, set_iterator_to_next is called next, otherwise the
150 glyphs produced are discarded. The function display_line is the
151 workhorse of filling glyph rows in the desired matrix with glyphs.
152 In addition to producing glyphs, it also handles line truncation
153 and continuation, word wrap, and cursor positioning (for the
154 latter, see also set_cursor_from_row).
158 That just couldn't be all, could it? What about terminal types not
159 supporting operations on sub-windows of the screen? To update the
160 display on such a terminal, window-based glyph matrices are not
161 well suited. To be able to reuse part of the display (scrolling
162 lines up and down), we must instead have a view of the whole
163 screen. This is what `frame matrices' are for. They are a trick.
165 Frames on terminals like above have a glyph pool. Windows on such
166 a frame sub-allocate their glyph memory from their frame's glyph
167 pool. The frame itself is given its own glyph matrices. By
168 coincidence---or maybe something else---rows in window glyph
169 matrices are slices of corresponding rows in frame matrices. Thus
170 writing to window matrices implicitly updates a frame matrix which
171 provides us with the view of the whole screen that we originally
172 wanted to have without having to move many bytes around. To be
173 honest, there is a little bit more done, but not much more. If you
174 plan to extend that code, take a look at dispnew.c. The function
175 build_frame_matrix is a good starting point.
177 Bidirectional display.
179 Bidirectional display adds quite some hair to this already complex
180 design. The good news are that a large portion of that hairy stuff
181 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
182 reordering engine which is called by set_iterator_to_next and
183 returns the next character to display in the visual order. See
184 commentary on bidi.c for more details. As far as redisplay is
185 concerned, the effect of calling bidi_move_to_visually_next, the
186 main interface of the reordering engine, is that the iterator gets
187 magically placed on the buffer or string position that is to be
188 displayed next. In other words, a linear iteration through the
189 buffer/string is replaced with a non-linear one. All the rest of
190 the redisplay is oblivious to the bidi reordering.
192 Well, almost oblivious---there are still complications, most of
193 them due to the fact that buffer and string positions no longer
194 change monotonously with glyph indices in a glyph row. Moreover,
195 for continued lines, the buffer positions may not even be
196 monotonously changing with vertical positions. Also, accounting
197 for face changes, overlays, etc. becomes more complex because
198 non-linear iteration could potentially skip many positions with
199 changes, and then cross them again on the way back...
201 One other prominent effect of bidirectional display is that some
202 paragraphs of text need to be displayed starting at the right
203 margin of the window---the so-called right-to-left, or R2L
204 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
205 which have their reversed_p flag set. The bidi reordering engine
206 produces characters in such rows starting from the character which
207 should be the rightmost on display. PRODUCE_GLYPHS then reverses
208 the order, when it fills up the glyph row whose reversed_p flag is
209 set, by prepending each new glyph to what is already there, instead
210 of appending it. When the glyph row is complete, the function
211 extend_face_to_end_of_line fills the empty space to the left of the
212 leftmost character with special glyphs, which will display as,
213 well, empty. On text terminals, these special glyphs are simply
214 blank characters. On graphics terminals, there's a single stretch
215 glyph of a suitably computed width. Both the blanks and the
216 stretch glyph are given the face of the background of the line.
217 This way, the terminal-specific back-end can still draw the glyphs
218 left to right, even for R2L lines.
220 Bidirectional display and character compositions
222 Some scripts cannot be displayed by drawing each character
223 individually, because adjacent characters change each other's shape
224 on display. For example, Arabic and Indic scripts belong to this
227 Emacs display supports this by providing "character compositions",
228 most of which is implemented in composite.c. During the buffer
229 scan that delivers characters to PRODUCE_GLYPHS, if the next
230 character to be delivered is a composed character, the iteration
231 calls composition_reseat_it and next_element_from_composition. If
232 they succeed to compose the character with one or more of the
233 following characters, the whole sequence of characters that where
234 composed is recorded in the `struct composition_it' object that is
235 part of the buffer iterator. The composed sequence could produce
236 one or more font glyphs (called "grapheme clusters") on the screen.
237 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
238 in the direction corresponding to the current bidi scan direction
239 (recorded in the scan_dir member of the `struct bidi_it' object
240 that is part of the buffer iterator). In particular, if the bidi
241 iterator currently scans the buffer backwards, the grapheme
242 clusters are delivered back to front. This reorders the grapheme
243 clusters as appropriate for the current bidi context. Note that
244 this means that the grapheme clusters are always stored in the
245 LGSTRING object (see composite.c) in the logical order.
247 Moving an iterator in bidirectional text
248 without producing glyphs
250 Note one important detail mentioned above: that the bidi reordering
251 engine, driven by the iterator, produces characters in R2L rows
252 starting at the character that will be the rightmost on display.
253 As far as the iterator is concerned, the geometry of such rows is
254 still left to right, i.e. the iterator "thinks" the first character
255 is at the leftmost pixel position. The iterator does not know that
256 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
257 delivers. This is important when functions from the the move_it_*
258 family are used to get to certain screen position or to match
259 screen coordinates with buffer coordinates: these functions use the
260 iterator geometry, which is left to right even in R2L paragraphs.
261 This works well with most callers of move_it_*, because they need
262 to get to a specific column, and columns are still numbered in the
263 reading order, i.e. the rightmost character in a R2L paragraph is
264 still column zero. But some callers do not get well with this; a
265 notable example is mouse clicks that need to find the character
266 that corresponds to certain pixel coordinates. See
267 buffer_posn_from_coords in dispnew.c for how this is handled. */
275 #include "keyboard.h"
278 #include "termchar.h"
279 #include "dispextern.h"
281 #include "character.h"
284 #include "commands.h"
288 #include "termhooks.h"
289 #include "termopts.h"
290 #include "intervals.h"
293 #include "region-cache.h"
296 #include "blockinput.h"
298 #ifdef HAVE_X_WINDOWS
313 #ifndef FRAME_X_OUTPUT
314 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
317 #define INFINITY 10000000
319 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
320 Lisp_Object Qwindow_scroll_functions
;
321 Lisp_Object Qwindow_text_change_functions
;
322 Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
325 Lisp_Object Qfontified
;
326 Lisp_Object Qgrow_only
;
327 Lisp_Object Qinhibit_eval_during_redisplay
;
328 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
329 Lisp_Object Qright_to_left
, Qleft_to_right
;
332 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
335 Lisp_Object Qarrow
, Qhand
, Qtext
;
337 /* Holds the list (error). */
338 Lisp_Object list_of_error
;
340 Lisp_Object Qfontification_functions
;
342 Lisp_Object Qwrap_prefix
;
343 Lisp_Object Qline_prefix
;
345 /* Non-nil means don't actually do any redisplay. */
347 Lisp_Object Qinhibit_redisplay
;
349 /* Names of text properties relevant for redisplay. */
351 Lisp_Object Qdisplay
;
353 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
354 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
357 Lisp_Object Qmargin
, Qpointer
;
358 Lisp_Object Qline_height
;
360 #ifdef HAVE_WINDOW_SYSTEM
362 /* Test if overflow newline into fringe. Called with iterator IT
363 at or past right window margin, and with IT->current_x set. */
365 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
366 (!NILP (Voverflow_newline_into_fringe) \
367 && FRAME_WINDOW_P ((IT)->f) \
368 && ((IT)->bidi_it.paragraph_dir == R2L \
369 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
370 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
371 && (IT)->current_x == (IT)->last_visible_x \
372 && (IT)->line_wrap != WORD_WRAP)
374 #else /* !HAVE_WINDOW_SYSTEM */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
376 #endif /* HAVE_WINDOW_SYSTEM */
378 /* Test if the display element loaded in IT is a space or tab
379 character. This is used to determine word wrapping. */
381 #define IT_DISPLAYING_WHITESPACE(it) \
382 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
384 /* Name of the face used to highlight trailing whitespace. */
386 Lisp_Object Qtrailing_whitespace
;
388 /* Name and number of the face used to highlight escape glyphs. */
390 Lisp_Object Qescape_glyph
;
392 /* Name and number of the face used to highlight non-breaking spaces. */
394 Lisp_Object Qnobreak_space
;
396 /* The symbol `image' which is the car of the lists used to represent
397 images in Lisp. Also a tool bar style. */
401 /* The image map types. */
402 Lisp_Object QCmap
, QCpointer
;
403 Lisp_Object Qrect
, Qcircle
, Qpoly
;
405 /* Tool bar styles */
406 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
408 /* Non-zero means print newline to stdout before next mini-buffer
411 int noninteractive_need_newline
;
413 /* Non-zero means print newline to message log before next message. */
415 static int message_log_need_newline
;
417 /* Three markers that message_dolog uses.
418 It could allocate them itself, but that causes trouble
419 in handling memory-full errors. */
420 static Lisp_Object message_dolog_marker1
;
421 static Lisp_Object message_dolog_marker2
;
422 static Lisp_Object message_dolog_marker3
;
424 /* The buffer position of the first character appearing entirely or
425 partially on the line of the selected window which contains the
426 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
427 redisplay optimization in redisplay_internal. */
429 static struct text_pos this_line_start_pos
;
431 /* Number of characters past the end of the line above, including the
432 terminating newline. */
434 static struct text_pos this_line_end_pos
;
436 /* The vertical positions and the height of this line. */
438 static int this_line_vpos
;
439 static int this_line_y
;
440 static int this_line_pixel_height
;
442 /* X position at which this display line starts. Usually zero;
443 negative if first character is partially visible. */
445 static int this_line_start_x
;
447 /* The smallest character position seen by move_it_* functions as they
448 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
449 hscrolled lines, see display_line. */
451 static struct text_pos this_line_min_pos
;
453 /* Buffer that this_line_.* variables are referring to. */
455 static struct buffer
*this_line_buffer
;
458 /* Values of those variables at last redisplay are stored as
459 properties on `overlay-arrow-position' symbol. However, if
460 Voverlay_arrow_position is a marker, last-arrow-position is its
461 numerical position. */
463 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
465 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
466 properties on a symbol in overlay-arrow-variable-list. */
468 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
470 Lisp_Object Qmenu_bar_update_hook
;
472 /* Nonzero if an overlay arrow has been displayed in this window. */
474 static int overlay_arrow_seen
;
476 /* Number of windows showing the buffer of the selected window (or
477 another buffer with the same base buffer). keyboard.c refers to
482 /* Vector containing glyphs for an ellipsis `...'. */
484 static Lisp_Object default_invis_vector
[3];
486 /* This is the window where the echo area message was displayed. It
487 is always a mini-buffer window, but it may not be the same window
488 currently active as a mini-buffer. */
490 Lisp_Object echo_area_window
;
492 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
493 pushes the current message and the value of
494 message_enable_multibyte on the stack, the function restore_message
495 pops the stack and displays MESSAGE again. */
497 Lisp_Object Vmessage_stack
;
499 /* Nonzero means multibyte characters were enabled when the echo area
500 message was specified. */
502 int message_enable_multibyte
;
504 /* Nonzero if we should redraw the mode lines on the next redisplay. */
506 int update_mode_lines
;
508 /* Nonzero if window sizes or contents have changed since last
509 redisplay that finished. */
511 int windows_or_buffers_changed
;
513 /* Nonzero means a frame's cursor type has been changed. */
515 int cursor_type_changed
;
517 /* Nonzero after display_mode_line if %l was used and it displayed a
520 int line_number_displayed
;
522 /* The name of the *Messages* buffer, a string. */
524 static Lisp_Object Vmessages_buffer_name
;
526 /* Current, index 0, and last displayed echo area message. Either
527 buffers from echo_buffers, or nil to indicate no message. */
529 Lisp_Object echo_area_buffer
[2];
531 /* The buffers referenced from echo_area_buffer. */
533 static Lisp_Object echo_buffer
[2];
535 /* A vector saved used in with_area_buffer to reduce consing. */
537 static Lisp_Object Vwith_echo_area_save_vector
;
539 /* Non-zero means display_echo_area should display the last echo area
540 message again. Set by redisplay_preserve_echo_area. */
542 static int display_last_displayed_message_p
;
544 /* Nonzero if echo area is being used by print; zero if being used by
547 int message_buf_print
;
549 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
551 Lisp_Object Qinhibit_menubar_update
;
552 Lisp_Object Qmessage_truncate_lines
;
554 /* Set to 1 in clear_message to make redisplay_internal aware
555 of an emptied echo area. */
557 static int message_cleared_p
;
559 /* A scratch glyph row with contents used for generating truncation
560 glyphs. Also used in direct_output_for_insert. */
562 #define MAX_SCRATCH_GLYPHS 100
563 struct glyph_row scratch_glyph_row
;
564 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
566 /* Ascent and height of the last line processed by move_it_to. */
568 static int last_max_ascent
, last_height
;
570 /* Non-zero if there's a help-echo in the echo area. */
572 int help_echo_showing_p
;
574 /* If >= 0, computed, exact values of mode-line and header-line height
575 to use in the macros CURRENT_MODE_LINE_HEIGHT and
576 CURRENT_HEADER_LINE_HEIGHT. */
578 int current_mode_line_height
, current_header_line_height
;
580 /* The maximum distance to look ahead for text properties. Values
581 that are too small let us call compute_char_face and similar
582 functions too often which is expensive. Values that are too large
583 let us call compute_char_face and alike too often because we
584 might not be interested in text properties that far away. */
586 #define TEXT_PROP_DISTANCE_LIMIT 100
590 /* Non-zero means print traces of redisplay if compiled with
593 int trace_redisplay_p
;
595 #endif /* GLYPH_DEBUG */
597 #ifdef DEBUG_TRACE_MOVE
598 /* Non-zero means trace with TRACE_MOVE to stderr. */
601 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
603 #define TRACE_MOVE(x) (void) 0
606 Lisp_Object Qauto_hscroll_mode
;
608 /* Buffer being redisplayed -- for redisplay_window_error. */
610 struct buffer
*displayed_buffer
;
612 /* Value returned from text property handlers (see below). */
617 HANDLED_RECOMPUTE_PROPS
,
618 HANDLED_OVERLAY_STRING_CONSUMED
,
622 /* A description of text properties that redisplay is interested
627 /* The name of the property. */
630 /* A unique index for the property. */
633 /* A handler function called to set up iterator IT from the property
634 at IT's current position. Value is used to steer handle_stop. */
635 enum prop_handled (*handler
) (struct it
*it
);
638 static enum prop_handled
handle_face_prop (struct it
*);
639 static enum prop_handled
handle_invisible_prop (struct it
*);
640 static enum prop_handled
handle_display_prop (struct it
*);
641 static enum prop_handled
handle_composition_prop (struct it
*);
642 static enum prop_handled
handle_overlay_change (struct it
*);
643 static enum prop_handled
handle_fontified_prop (struct it
*);
645 /* Properties handled by iterators. */
647 static struct props it_props
[] =
649 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
650 /* Handle `face' before `display' because some sub-properties of
651 `display' need to know the face. */
652 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
653 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
654 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
655 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
659 /* Value is the position described by X. If X is a marker, value is
660 the marker_position of X. Otherwise, value is X. */
662 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
664 /* Enumeration returned by some move_it_.* functions internally. */
668 /* Not used. Undefined value. */
671 /* Move ended at the requested buffer position or ZV. */
672 MOVE_POS_MATCH_OR_ZV
,
674 /* Move ended at the requested X pixel position. */
677 /* Move within a line ended at the end of a line that must be
681 /* Move within a line ended at the end of a line that would
682 be displayed truncated. */
685 /* Move within a line ended at a line end. */
689 /* This counter is used to clear the face cache every once in a while
690 in redisplay_internal. It is incremented for each redisplay.
691 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
694 #define CLEAR_FACE_CACHE_COUNT 500
695 static int clear_face_cache_count
;
697 /* Similarly for the image cache. */
699 #ifdef HAVE_WINDOW_SYSTEM
700 #define CLEAR_IMAGE_CACHE_COUNT 101
701 static int clear_image_cache_count
;
703 /* Null glyph slice */
704 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
707 /* Non-zero while redisplay_internal is in progress. */
711 Lisp_Object Qinhibit_free_realized_faces
;
713 /* If a string, XTread_socket generates an event to display that string.
714 (The display is done in read_char.) */
716 Lisp_Object help_echo_string
;
717 Lisp_Object help_echo_window
;
718 Lisp_Object help_echo_object
;
719 EMACS_INT help_echo_pos
;
721 /* Temporary variable for XTread_socket. */
723 Lisp_Object previous_help_echo_string
;
725 /* Platform-independent portion of hourglass implementation. */
727 /* Non-zero means an hourglass cursor is currently shown. */
728 int hourglass_shown_p
;
730 /* If non-null, an asynchronous timer that, when it expires, displays
731 an hourglass cursor on all frames. */
732 struct atimer
*hourglass_atimer
;
734 /* Name of the face used to display glyphless characters. */
735 Lisp_Object Qglyphless_char
;
737 /* Symbol for the purpose of Vglyphless_char_display. */
738 Lisp_Object Qglyphless_char_display
;
740 /* Method symbols for Vglyphless_char_display. */
741 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
743 /* Default pixel width of `thin-space' display method. */
744 #define THIN_SPACE_WIDTH 1
746 /* Default number of seconds to wait before displaying an hourglass
748 #define DEFAULT_HOURGLASS_DELAY 1
751 /* Function prototypes. */
753 static void setup_for_ellipsis (struct it
*, int);
754 static void mark_window_display_accurate_1 (struct window
*, int);
755 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
756 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
757 static int cursor_row_p (struct glyph_row
*);
758 static int redisplay_mode_lines (Lisp_Object
, int);
759 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
761 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
763 static void handle_line_prefix (struct it
*);
765 static void pint2str (char *, int, EMACS_INT
);
766 static void pint2hrstr (char *, int, int);
767 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
769 static void reconsider_clip_changes (struct window
*, struct buffer
*);
770 static int text_outside_line_unchanged_p (struct window
*,
771 EMACS_INT
, EMACS_INT
);
772 static void store_mode_line_noprop_char (char);
773 static int store_mode_line_noprop (const char *, int, int);
774 static void handle_stop (struct it
*);
775 static void handle_stop_backwards (struct it
*, EMACS_INT
);
776 static int single_display_spec_intangible_p (Lisp_Object
);
777 static void ensure_echo_area_buffers (void);
778 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
779 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
780 static int with_echo_area_buffer (struct window
*, int,
781 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
782 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
783 static void clear_garbaged_frames (void);
784 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
785 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
786 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
787 static int display_echo_area (struct window
*);
788 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
789 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static Lisp_Object
unwind_redisplay (Lisp_Object
);
791 static int string_char_and_length (const unsigned char *, int *);
792 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
794 static int compute_window_start_on_continuation_line (struct window
*);
795 static Lisp_Object
safe_eval_handler (Lisp_Object
);
796 static void insert_left_trunc_glyphs (struct it
*);
797 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
799 static void extend_face_to_end_of_line (struct it
*);
800 static int append_space_for_newline (struct it
*, int);
801 static int cursor_row_fully_visible_p (struct window
*, int, int);
802 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
803 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
804 static int trailing_whitespace_p (EMACS_INT
);
805 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
806 static void push_it (struct it
*);
807 static void pop_it (struct it
*);
808 static void sync_frame_with_window_matrix_rows (struct window
*);
809 static void select_frame_for_redisplay (Lisp_Object
);
810 static void redisplay_internal ();
811 static int echo_area_display (int);
812 static void redisplay_windows (Lisp_Object
);
813 static void redisplay_window (Lisp_Object
, int);
814 static Lisp_Object
redisplay_window_error (Lisp_Object
);
815 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
816 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
817 static int update_menu_bar (struct frame
*, int, int);
818 static int try_window_reusing_current_matrix (struct window
*);
819 static int try_window_id (struct window
*);
820 static int display_line (struct it
*);
821 static int display_mode_lines (struct window
*);
822 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
823 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
824 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
825 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
826 static void display_menu_bar (struct window
*);
827 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
829 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
830 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
831 static void compute_line_metrics (struct it
*);
832 static void run_redisplay_end_trigger_hook (struct it
*);
833 static int get_overlay_strings (struct it
*, EMACS_INT
);
834 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
835 static void next_overlay_string (struct it
*);
836 static void reseat (struct it
*, struct text_pos
, int);
837 static void reseat_1 (struct it
*, struct text_pos
, int);
838 static void back_to_previous_visible_line_start (struct it
*);
839 void reseat_at_previous_visible_line_start (struct it
*);
840 static void reseat_at_next_visible_line_start (struct it
*, int);
841 static int next_element_from_ellipsis (struct it
*);
842 static int next_element_from_display_vector (struct it
*);
843 static int next_element_from_string (struct it
*);
844 static int next_element_from_c_string (struct it
*);
845 static int next_element_from_buffer (struct it
*);
846 static int next_element_from_composition (struct it
*);
847 static int next_element_from_image (struct it
*);
848 static int next_element_from_stretch (struct it
*);
849 static void load_overlay_strings (struct it
*, EMACS_INT
);
850 static int init_from_display_pos (struct it
*, struct window
*,
851 struct display_pos
*);
852 static void reseat_to_string (struct it
*, const char *,
853 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
854 static enum move_it_result
855 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
856 enum move_operation_enum
);
857 void move_it_vertically_backward (struct it
*, int);
858 static void init_to_row_start (struct it
*, struct window
*,
860 static int init_to_row_end (struct it
*, struct window
*,
862 static void back_to_previous_line_start (struct it
*);
863 static int forward_to_next_line_start (struct it
*, int *);
864 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
865 Lisp_Object
, EMACS_INT
);
866 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
867 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
868 static EMACS_INT
number_of_chars (const char *, int);
869 static void compute_stop_pos (struct it
*);
870 static void compute_string_pos (struct text_pos
*, struct text_pos
,
872 static int face_before_or_after_it_pos (struct it
*, int);
873 static EMACS_INT
next_overlay_change (EMACS_INT
);
874 static int handle_single_display_spec (struct it
*, Lisp_Object
,
875 Lisp_Object
, Lisp_Object
,
876 struct text_pos
*, int);
877 static int underlying_face_id (struct it
*);
878 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
881 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
882 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
884 #ifdef HAVE_WINDOW_SYSTEM
886 static void x_consider_frame_title (Lisp_Object
);
887 static int tool_bar_lines_needed (struct frame
*, int *);
888 static void update_tool_bar (struct frame
*, int);
889 static void build_desired_tool_bar_string (struct frame
*f
);
890 static int redisplay_tool_bar (struct frame
*);
891 static void display_tool_bar_line (struct it
*, int);
892 static void notice_overwritten_cursor (struct window
*,
895 static void append_stretch_glyph (struct it
*, Lisp_Object
,
899 #endif /* HAVE_WINDOW_SYSTEM */
901 static int coords_in_mouse_face_p (struct window
*, int, int);
905 /***********************************************************************
906 Window display dimensions
907 ***********************************************************************/
909 /* Return the bottom boundary y-position for text lines in window W.
910 This is the first y position at which a line cannot start.
911 It is relative to the top of the window.
913 This is the height of W minus the height of a mode line, if any. */
916 window_text_bottom_y (struct window
*w
)
918 int height
= WINDOW_TOTAL_HEIGHT (w
);
920 if (WINDOW_WANTS_MODELINE_P (w
))
921 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
925 /* Return the pixel width of display area AREA of window W. AREA < 0
926 means return the total width of W, not including fringes to
927 the left and right of the window. */
930 window_box_width (struct window
*w
, int area
)
932 int cols
= XFASTINT (w
->total_cols
);
935 if (!w
->pseudo_window_p
)
937 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
939 if (area
== TEXT_AREA
)
941 if (INTEGERP (w
->left_margin_cols
))
942 cols
-= XFASTINT (w
->left_margin_cols
);
943 if (INTEGERP (w
->right_margin_cols
))
944 cols
-= XFASTINT (w
->right_margin_cols
);
945 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
947 else if (area
== LEFT_MARGIN_AREA
)
949 cols
= (INTEGERP (w
->left_margin_cols
)
950 ? XFASTINT (w
->left_margin_cols
) : 0);
953 else if (area
== RIGHT_MARGIN_AREA
)
955 cols
= (INTEGERP (w
->right_margin_cols
)
956 ? XFASTINT (w
->right_margin_cols
) : 0);
961 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
965 /* Return the pixel height of the display area of window W, not
966 including mode lines of W, if any. */
969 window_box_height (struct window
*w
)
971 struct frame
*f
= XFRAME (w
->frame
);
972 int height
= WINDOW_TOTAL_HEIGHT (w
);
974 xassert (height
>= 0);
976 /* Note: the code below that determines the mode-line/header-line
977 height is essentially the same as that contained in the macro
978 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
979 the appropriate glyph row has its `mode_line_p' flag set,
980 and if it doesn't, uses estimate_mode_line_height instead. */
982 if (WINDOW_WANTS_MODELINE_P (w
))
984 struct glyph_row
*ml_row
985 = (w
->current_matrix
&& w
->current_matrix
->rows
986 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
988 if (ml_row
&& ml_row
->mode_line_p
)
989 height
-= ml_row
->height
;
991 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
994 if (WINDOW_WANTS_HEADER_LINE_P (w
))
996 struct glyph_row
*hl_row
997 = (w
->current_matrix
&& w
->current_matrix
->rows
998 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1000 if (hl_row
&& hl_row
->mode_line_p
)
1001 height
-= hl_row
->height
;
1003 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1006 /* With a very small font and a mode-line that's taller than
1007 default, we might end up with a negative height. */
1008 return max (0, height
);
1011 /* Return the window-relative coordinate of the left edge of display
1012 area AREA of window W. AREA < 0 means return the left edge of the
1013 whole window, to the right of the left fringe of W. */
1016 window_box_left_offset (struct window
*w
, int area
)
1020 if (w
->pseudo_window_p
)
1023 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1025 if (area
== TEXT_AREA
)
1026 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1027 + window_box_width (w
, LEFT_MARGIN_AREA
));
1028 else if (area
== RIGHT_MARGIN_AREA
)
1029 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1030 + window_box_width (w
, LEFT_MARGIN_AREA
)
1031 + window_box_width (w
, TEXT_AREA
)
1032 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1034 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1035 else if (area
== LEFT_MARGIN_AREA
1036 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1037 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1043 /* Return the window-relative coordinate of the right edge of display
1044 area AREA of window W. AREA < 0 means return the right edge of the
1045 whole window, to the left of the right fringe of W. */
1048 window_box_right_offset (struct window
*w
, int area
)
1050 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1053 /* Return the frame-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left (struct window
*w
, int area
)
1060 struct frame
*f
= XFRAME (w
->frame
);
1063 if (w
->pseudo_window_p
)
1064 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1066 x
= (WINDOW_LEFT_EDGE_X (w
)
1067 + window_box_left_offset (w
, area
));
1073 /* Return the frame-relative coordinate of the right edge of display
1074 area AREA of window W. AREA < 0 means return the right edge of the
1075 whole window, to the left of the right fringe of W. */
1078 window_box_right (struct window
*w
, int area
)
1080 return window_box_left (w
, area
) + window_box_width (w
, area
);
1083 /* Get the bounding box of the display area AREA of window W, without
1084 mode lines, in frame-relative coordinates. AREA < 0 means the
1085 whole window, not including the left and right fringes of
1086 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1087 coordinates of the upper-left corner of the box. Return in
1088 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1091 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1092 int *box_width
, int *box_height
)
1095 *box_width
= window_box_width (w
, area
);
1097 *box_height
= window_box_height (w
);
1099 *box_x
= window_box_left (w
, area
);
1102 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1103 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1104 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1109 /* Get the bounding box of the display area AREA of window W, without
1110 mode lines. AREA < 0 means the whole window, not including the
1111 left and right fringe of the window. Return in *TOP_LEFT_X
1112 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1113 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1114 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1118 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1119 int *bottom_right_x
, int *bottom_right_y
)
1121 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1123 *bottom_right_x
+= *top_left_x
;
1124 *bottom_right_y
+= *top_left_y
;
1129 /***********************************************************************
1131 ***********************************************************************/
1133 /* Return the bottom y-position of the line the iterator IT is in.
1134 This can modify IT's settings. */
1137 line_bottom_y (struct it
*it
)
1139 int line_height
= it
->max_ascent
+ it
->max_descent
;
1140 int line_top_y
= it
->current_y
;
1142 if (line_height
== 0)
1145 line_height
= last_height
;
1146 else if (IT_CHARPOS (*it
) < ZV
)
1148 move_it_by_lines (it
, 1);
1149 line_height
= (it
->max_ascent
|| it
->max_descent
1150 ? it
->max_ascent
+ it
->max_descent
1155 struct glyph_row
*row
= it
->glyph_row
;
1157 /* Use the default character height. */
1158 it
->glyph_row
= NULL
;
1159 it
->what
= IT_CHARACTER
;
1162 PRODUCE_GLYPHS (it
);
1163 line_height
= it
->ascent
+ it
->descent
;
1164 it
->glyph_row
= row
;
1168 return line_top_y
+ line_height
;
1172 /* Return 1 if position CHARPOS is visible in window W.
1173 CHARPOS < 0 means return info about WINDOW_END position.
1174 If visible, set *X and *Y to pixel coordinates of top left corner.
1175 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1176 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1179 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1180 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1183 struct text_pos top
;
1185 struct buffer
*old_buffer
= NULL
;
1187 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1190 if (XBUFFER (w
->buffer
) != current_buffer
)
1192 old_buffer
= current_buffer
;
1193 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1196 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1198 /* Compute exact mode line heights. */
1199 if (WINDOW_WANTS_MODELINE_P (w
))
1200 current_mode_line_height
1201 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1202 BVAR (current_buffer
, mode_line_format
));
1204 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1205 current_header_line_height
1206 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1207 BVAR (current_buffer
, header_line_format
));
1209 start_display (&it
, w
, top
);
1210 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1211 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1213 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1215 /* We have reached CHARPOS, or passed it. How the call to
1216 move_it_to can overshoot: (i) If CHARPOS is on invisible
1217 text, move_it_to stops at the end of the invisible text,
1218 after CHARPOS. (ii) If CHARPOS is in a display vector,
1219 move_it_to stops on its last glyph. */
1220 int top_x
= it
.current_x
;
1221 int top_y
= it
.current_y
;
1222 enum it_method it_method
= it
.method
;
1223 /* Calling line_bottom_y may change it.method, it.position, etc. */
1224 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1225 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1227 if (top_y
< window_top_y
)
1228 visible_p
= bottom_y
> window_top_y
;
1229 else if (top_y
< it
.last_visible_y
)
1233 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1235 /* We stopped on the last glyph of a display vector.
1236 Try and recompute. Hack alert! */
1237 if (charpos
< 2 || top
.charpos
>= charpos
)
1238 top_x
= it
.glyph_row
->x
;
1242 start_display (&it2
, w
, top
);
1243 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1244 get_next_display_element (&it2
);
1245 PRODUCE_GLYPHS (&it2
);
1246 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1247 || it2
.current_x
> it2
.last_visible_x
)
1248 top_x
= it
.glyph_row
->x
;
1251 top_x
= it2
.current_x
;
1252 top_y
= it2
.current_y
;
1258 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1259 *rtop
= max (0, window_top_y
- top_y
);
1260 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1261 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1262 - max (top_y
, window_top_y
)));
1271 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1272 move_it_by_lines (&it
, 1);
1273 if (charpos
< IT_CHARPOS (it
)
1274 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1277 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1279 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1280 *rtop
= max (0, -it2
.current_y
);
1281 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1282 - it
.last_visible_y
));
1283 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1285 - max (it2
.current_y
,
1286 WINDOW_HEADER_LINE_HEIGHT (w
))));
1292 set_buffer_internal_1 (old_buffer
);
1294 current_header_line_height
= current_mode_line_height
= -1;
1296 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1297 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1300 /* Debugging code. */
1302 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1303 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1305 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1312 /* Return the next character from STR. Return in *LEN the length of
1313 the character. This is like STRING_CHAR_AND_LENGTH but never
1314 returns an invalid character. If we find one, we return a `?', but
1315 with the length of the invalid character. */
1318 string_char_and_length (const unsigned char *str
, int *len
)
1322 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1323 if (!CHAR_VALID_P (c
, 1))
1324 /* We may not change the length here because other places in Emacs
1325 don't use this function, i.e. they silently accept invalid
1334 /* Given a position POS containing a valid character and byte position
1335 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1337 static struct text_pos
1338 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1340 xassert (STRINGP (string
) && nchars
>= 0);
1342 if (STRING_MULTIBYTE (string
))
1344 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1349 string_char_and_length (p
, &len
);
1352 BYTEPOS (pos
) += len
;
1356 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1362 /* Value is the text position, i.e. character and byte position,
1363 for character position CHARPOS in STRING. */
1365 static INLINE
struct text_pos
1366 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1368 struct text_pos pos
;
1369 xassert (STRINGP (string
));
1370 xassert (charpos
>= 0);
1371 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1376 /* Value is a text position, i.e. character and byte position, for
1377 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1378 means recognize multibyte characters. */
1380 static struct text_pos
1381 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1383 struct text_pos pos
;
1385 xassert (s
!= NULL
);
1386 xassert (charpos
>= 0);
1392 SET_TEXT_POS (pos
, 0, 0);
1395 string_char_and_length ((const unsigned char *) s
, &len
);
1398 BYTEPOS (pos
) += len
;
1402 SET_TEXT_POS (pos
, charpos
, charpos
);
1408 /* Value is the number of characters in C string S. MULTIBYTE_P
1409 non-zero means recognize multibyte characters. */
1412 number_of_chars (const char *s
, int multibyte_p
)
1418 EMACS_INT rest
= strlen (s
);
1420 const unsigned char *p
= (const unsigned char *) s
;
1422 for (nchars
= 0; rest
> 0; ++nchars
)
1424 string_char_and_length (p
, &len
);
1425 rest
-= len
, p
+= len
;
1429 nchars
= strlen (s
);
1435 /* Compute byte position NEWPOS->bytepos corresponding to
1436 NEWPOS->charpos. POS is a known position in string STRING.
1437 NEWPOS->charpos must be >= POS.charpos. */
1440 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1442 xassert (STRINGP (string
));
1443 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1445 if (STRING_MULTIBYTE (string
))
1446 *newpos
= string_pos_nchars_ahead (pos
, string
,
1447 CHARPOS (*newpos
) - CHARPOS (pos
));
1449 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1453 Return an estimation of the pixel height of mode or header lines on
1454 frame F. FACE_ID specifies what line's height to estimate. */
1457 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1459 #ifdef HAVE_WINDOW_SYSTEM
1460 if (FRAME_WINDOW_P (f
))
1462 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1464 /* This function is called so early when Emacs starts that the face
1465 cache and mode line face are not yet initialized. */
1466 if (FRAME_FACE_CACHE (f
))
1468 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1472 height
= FONT_HEIGHT (face
->font
);
1473 if (face
->box_line_width
> 0)
1474 height
+= 2 * face
->box_line_width
;
1485 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1486 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1487 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1488 not force the value into range. */
1491 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1492 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1495 #ifdef HAVE_WINDOW_SYSTEM
1496 if (FRAME_WINDOW_P (f
))
1498 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1499 even for negative values. */
1501 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1503 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1505 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1506 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1509 STORE_NATIVE_RECT (*bounds
,
1510 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1511 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1512 FRAME_COLUMN_WIDTH (f
) - 1,
1513 FRAME_LINE_HEIGHT (f
) - 1);
1519 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1520 pix_x
= FRAME_TOTAL_COLS (f
);
1524 else if (pix_y
> FRAME_LINES (f
))
1525 pix_y
= FRAME_LINES (f
);
1535 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1536 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1537 can't tell the positions because W's display is not up to date,
1541 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1542 int *frame_x
, int *frame_y
)
1544 #ifdef HAVE_WINDOW_SYSTEM
1545 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1549 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1550 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1552 if (display_completed
)
1554 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1555 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1556 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1562 hpos
+= glyph
->pixel_width
;
1566 /* If first glyph is partially visible, its first visible position is still 0. */
1578 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1579 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1590 /* Find the glyph under window-relative coordinates X/Y in window W.
1591 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1592 strings. Return in *HPOS and *VPOS the row and column number of
1593 the glyph found. Return in *AREA the glyph area containing X.
1594 Value is a pointer to the glyph found or null if X/Y is not on
1595 text, or we can't tell because W's current matrix is not up to
1600 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1601 int *dx
, int *dy
, int *area
)
1603 struct glyph
*glyph
, *end
;
1604 struct glyph_row
*row
= NULL
;
1607 /* Find row containing Y. Give up if some row is not enabled. */
1608 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1610 row
= MATRIX_ROW (w
->current_matrix
, i
);
1611 if (!row
->enabled_p
)
1613 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1620 /* Give up if Y is not in the window. */
1621 if (i
== w
->current_matrix
->nrows
)
1624 /* Get the glyph area containing X. */
1625 if (w
->pseudo_window_p
)
1632 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1634 *area
= LEFT_MARGIN_AREA
;
1635 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1637 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1640 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1644 *area
= RIGHT_MARGIN_AREA
;
1645 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1649 /* Find glyph containing X. */
1650 glyph
= row
->glyphs
[*area
];
1651 end
= glyph
+ row
->used
[*area
];
1653 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1655 x
-= glyph
->pixel_width
;
1665 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1668 *hpos
= glyph
- row
->glyphs
[*area
];
1673 Convert frame-relative x/y to coordinates relative to window W.
1674 Takes pseudo-windows into account. */
1677 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1679 if (w
->pseudo_window_p
)
1681 /* A pseudo-window is always full-width, and starts at the
1682 left edge of the frame, plus a frame border. */
1683 struct frame
*f
= XFRAME (w
->frame
);
1684 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1685 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1689 *x
-= WINDOW_LEFT_EDGE_X (w
);
1690 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1694 #ifdef HAVE_WINDOW_SYSTEM
1697 Return in RECTS[] at most N clipping rectangles for glyph string S.
1698 Return the number of stored rectangles. */
1701 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1708 if (s
->row
->full_width_p
)
1710 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1711 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1712 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1714 /* Unless displaying a mode or menu bar line, which are always
1715 fully visible, clip to the visible part of the row. */
1716 if (s
->w
->pseudo_window_p
)
1717 r
.height
= s
->row
->visible_height
;
1719 r
.height
= s
->height
;
1723 /* This is a text line that may be partially visible. */
1724 r
.x
= window_box_left (s
->w
, s
->area
);
1725 r
.width
= window_box_width (s
->w
, s
->area
);
1726 r
.height
= s
->row
->visible_height
;
1730 if (r
.x
< s
->clip_head
->x
)
1732 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1733 r
.width
-= s
->clip_head
->x
- r
.x
;
1736 r
.x
= s
->clip_head
->x
;
1739 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1741 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1742 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1747 /* If S draws overlapping rows, it's sufficient to use the top and
1748 bottom of the window for clipping because this glyph string
1749 intentionally draws over other lines. */
1750 if (s
->for_overlaps
)
1752 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1753 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1755 /* Alas, the above simple strategy does not work for the
1756 environments with anti-aliased text: if the same text is
1757 drawn onto the same place multiple times, it gets thicker.
1758 If the overlap we are processing is for the erased cursor, we
1759 take the intersection with the rectagle of the cursor. */
1760 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1762 XRectangle rc
, r_save
= r
;
1764 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1765 rc
.y
= s
->w
->phys_cursor
.y
;
1766 rc
.width
= s
->w
->phys_cursor_width
;
1767 rc
.height
= s
->w
->phys_cursor_height
;
1769 x_intersect_rectangles (&r_save
, &rc
, &r
);
1774 /* Don't use S->y for clipping because it doesn't take partially
1775 visible lines into account. For example, it can be negative for
1776 partially visible lines at the top of a window. */
1777 if (!s
->row
->full_width_p
1778 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1779 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1781 r
.y
= max (0, s
->row
->y
);
1784 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1786 /* If drawing the cursor, don't let glyph draw outside its
1787 advertised boundaries. Cleartype does this under some circumstances. */
1788 if (s
->hl
== DRAW_CURSOR
)
1790 struct glyph
*glyph
= s
->first_glyph
;
1795 r
.width
-= s
->x
- r
.x
;
1798 r
.width
= min (r
.width
, glyph
->pixel_width
);
1800 /* If r.y is below window bottom, ensure that we still see a cursor. */
1801 height
= min (glyph
->ascent
+ glyph
->descent
,
1802 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1803 max_y
= window_text_bottom_y (s
->w
) - height
;
1804 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1805 if (s
->ybase
- glyph
->ascent
> max_y
)
1812 /* Don't draw cursor glyph taller than our actual glyph. */
1813 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1814 if (height
< r
.height
)
1816 max_y
= r
.y
+ r
.height
;
1817 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1818 r
.height
= min (max_y
- r
.y
, height
);
1825 XRectangle r_save
= r
;
1827 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1831 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1832 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1834 #ifdef CONVERT_FROM_XRECT
1835 CONVERT_FROM_XRECT (r
, *rects
);
1843 /* If we are processing overlapping and allowed to return
1844 multiple clipping rectangles, we exclude the row of the glyph
1845 string from the clipping rectangle. This is to avoid drawing
1846 the same text on the environment with anti-aliasing. */
1847 #ifdef CONVERT_FROM_XRECT
1850 XRectangle
*rs
= rects
;
1852 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1854 if (s
->for_overlaps
& OVERLAPS_PRED
)
1857 if (r
.y
+ r
.height
> row_y
)
1860 rs
[i
].height
= row_y
- r
.y
;
1866 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1869 if (r
.y
< row_y
+ s
->row
->visible_height
)
1871 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1873 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1874 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1883 #ifdef CONVERT_FROM_XRECT
1884 for (i
= 0; i
< n
; i
++)
1885 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1892 Return in *NR the clipping rectangle for glyph string S. */
1895 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1897 get_glyph_string_clip_rects (s
, nr
, 1);
1902 Return the position and height of the phys cursor in window W.
1903 Set w->phys_cursor_width to width of phys cursor.
1907 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1908 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1910 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1911 int x
, y
, wd
, h
, h0
, y0
;
1913 /* Compute the width of the rectangle to draw. If on a stretch
1914 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1915 rectangle as wide as the glyph, but use a canonical character
1917 wd
= glyph
->pixel_width
- 1;
1918 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1922 x
= w
->phys_cursor
.x
;
1929 if (glyph
->type
== STRETCH_GLYPH
1930 && !x_stretch_cursor_p
)
1931 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1932 w
->phys_cursor_width
= wd
;
1934 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1936 /* If y is below window bottom, ensure that we still see a cursor. */
1937 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1939 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1940 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1942 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1945 h
= max (h
- (y0
- y
) + 1, h0
);
1950 y0
= window_text_bottom_y (w
) - h0
;
1958 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1959 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1964 * Remember which glyph the mouse is over.
1968 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1972 struct glyph_row
*r
, *gr
, *end_row
;
1973 enum window_part part
;
1974 enum glyph_row_area area
;
1975 int x
, y
, width
, height
;
1977 /* Try to determine frame pixel position and size of the glyph under
1978 frame pixel coordinates X/Y on frame F. */
1980 if (!f
->glyphs_initialized_p
1981 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1984 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1985 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1989 w
= XWINDOW (window
);
1990 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1991 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1993 x
= window_relative_x_coord (w
, part
, gx
);
1994 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1996 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1997 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1999 if (w
->pseudo_window_p
)
2002 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2008 case ON_LEFT_MARGIN
:
2009 area
= LEFT_MARGIN_AREA
;
2012 case ON_RIGHT_MARGIN
:
2013 area
= RIGHT_MARGIN_AREA
;
2016 case ON_HEADER_LINE
:
2018 gr
= (part
== ON_HEADER_LINE
2019 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2020 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2023 goto text_glyph_row_found
;
2030 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2031 if (r
->y
+ r
->height
> y
)
2037 text_glyph_row_found
:
2040 struct glyph
*g
= gr
->glyphs
[area
];
2041 struct glyph
*end
= g
+ gr
->used
[area
];
2043 height
= gr
->height
;
2044 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2045 if (gx
+ g
->pixel_width
> x
)
2050 if (g
->type
== IMAGE_GLYPH
)
2052 /* Don't remember when mouse is over image, as
2053 image may have hot-spots. */
2054 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2057 width
= g
->pixel_width
;
2061 /* Use nominal char spacing at end of line. */
2063 gx
+= (x
/ width
) * width
;
2066 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2067 gx
+= window_box_left_offset (w
, area
);
2071 /* Use nominal line height at end of window. */
2072 gx
= (x
/ width
) * width
;
2074 gy
+= (y
/ height
) * height
;
2078 case ON_LEFT_FRINGE
:
2079 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2080 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2081 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2082 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2085 case ON_RIGHT_FRINGE
:
2086 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2087 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2088 : window_box_right_offset (w
, TEXT_AREA
));
2089 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2093 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2095 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2096 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2097 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2099 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2103 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2104 if (r
->y
+ r
->height
> y
)
2111 height
= gr
->height
;
2114 /* Use nominal line height at end of window. */
2116 gy
+= (y
/ height
) * height
;
2123 /* If there is no glyph under the mouse, then we divide the screen
2124 into a grid of the smallest glyph in the frame, and use that
2127 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2128 round down even for negative values. */
2134 gx
= (gx
/ width
) * width
;
2135 gy
= (gy
/ height
) * height
;
2140 gx
+= WINDOW_LEFT_EDGE_X (w
);
2141 gy
+= WINDOW_TOP_EDGE_Y (w
);
2144 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2146 /* Visible feedback for debugging. */
2149 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2150 f
->output_data
.x
->normal_gc
,
2151 gx
, gy
, width
, height
);
2157 #endif /* HAVE_WINDOW_SYSTEM */
2160 /***********************************************************************
2161 Lisp form evaluation
2162 ***********************************************************************/
2164 /* Error handler for safe_eval and safe_call. */
2167 safe_eval_handler (Lisp_Object arg
)
2169 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2174 /* Evaluate SEXPR and return the result, or nil if something went
2175 wrong. Prevent redisplay during the evaluation. */
2177 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2178 Return the result, or nil if something went wrong. Prevent
2179 redisplay during the evaluation. */
2182 safe_call (size_t nargs
, Lisp_Object
*args
)
2186 if (inhibit_eval_during_redisplay
)
2190 int count
= SPECPDL_INDEX ();
2191 struct gcpro gcpro1
;
2194 gcpro1
.nvars
= nargs
;
2195 specbind (Qinhibit_redisplay
, Qt
);
2196 /* Use Qt to ensure debugger does not run,
2197 so there is no possibility of wanting to redisplay. */
2198 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2201 val
= unbind_to (count
, val
);
2208 /* Call function FN with one argument ARG.
2209 Return the result, or nil if something went wrong. */
2212 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2214 Lisp_Object args
[2];
2217 return safe_call (2, args
);
2220 static Lisp_Object Qeval
;
2223 safe_eval (Lisp_Object sexpr
)
2225 return safe_call1 (Qeval
, sexpr
);
2228 /* Call function FN with one argument ARG.
2229 Return the result, or nil if something went wrong. */
2232 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2234 Lisp_Object args
[3];
2238 return safe_call (3, args
);
2243 /***********************************************************************
2245 ***********************************************************************/
2249 /* Define CHECK_IT to perform sanity checks on iterators.
2250 This is for debugging. It is too slow to do unconditionally. */
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (w
)
2295 if (!MINI_WINDOW_P (w
)
2296 && !NILP (w
->window_end_valid
))
2298 struct glyph_row
*row
;
2299 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2300 XFASTINT (w
->window_end_vpos
)),
2302 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2303 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2307 #define CHECK_WINDOW_END(W) check_window_end ((W))
2309 #else /* not GLYPH_DEBUG */
2311 #define CHECK_WINDOW_END(W) (void) 0
2313 #endif /* not GLYPH_DEBUG */
2317 /***********************************************************************
2318 Iterator initialization
2319 ***********************************************************************/
2321 /* Initialize IT for displaying current_buffer in window W, starting
2322 at character position CHARPOS. CHARPOS < 0 means that no buffer
2323 position is specified which is useful when the iterator is assigned
2324 a position later. BYTEPOS is the byte position corresponding to
2325 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2327 If ROW is not null, calls to produce_glyphs with IT as parameter
2328 will produce glyphs in that row.
2330 BASE_FACE_ID is the id of a base face to use. It must be one of
2331 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2332 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2333 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2335 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2336 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2337 will be initialized to use the corresponding mode line glyph row of
2338 the desired matrix of W. */
2341 init_iterator (struct it
*it
, struct window
*w
,
2342 EMACS_INT charpos
, EMACS_INT bytepos
,
2343 struct glyph_row
*row
, enum face_id base_face_id
)
2345 int highlight_region_p
;
2346 enum face_id remapped_base_face_id
= base_face_id
;
2348 /* Some precondition checks. */
2349 xassert (w
!= NULL
&& it
!= NULL
);
2350 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2353 /* If face attributes have been changed since the last redisplay,
2354 free realized faces now because they depend on face definitions
2355 that might have changed. Don't free faces while there might be
2356 desired matrices pending which reference these faces. */
2357 if (face_change_count
&& !inhibit_free_realized_faces
)
2359 face_change_count
= 0;
2360 free_all_realized_faces (Qnil
);
2363 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2364 if (! NILP (Vface_remapping_alist
))
2365 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2367 /* Use one of the mode line rows of W's desired matrix if
2371 if (base_face_id
== MODE_LINE_FACE_ID
2372 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2373 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2374 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2375 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2379 memset (it
, 0, sizeof *it
);
2380 it
->current
.overlay_string_index
= -1;
2381 it
->current
.dpvec_index
= -1;
2382 it
->base_face_id
= remapped_base_face_id
;
2384 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2386 /* The window in which we iterate over current_buffer: */
2387 XSETWINDOW (it
->window
, w
);
2389 it
->f
= XFRAME (w
->frame
);
2393 /* Extra space between lines (on window systems only). */
2394 if (base_face_id
== DEFAULT_FACE_ID
2395 && FRAME_WINDOW_P (it
->f
))
2397 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2398 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2399 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2400 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2401 * FRAME_LINE_HEIGHT (it
->f
));
2402 else if (it
->f
->extra_line_spacing
> 0)
2403 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2404 it
->max_extra_line_spacing
= 0;
2407 /* If realized faces have been removed, e.g. because of face
2408 attribute changes of named faces, recompute them. When running
2409 in batch mode, the face cache of the initial frame is null. If
2410 we happen to get called, make a dummy face cache. */
2411 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2412 init_frame_faces (it
->f
);
2413 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2414 recompute_basic_faces (it
->f
);
2416 /* Current value of the `slice', `space-width', and 'height' properties. */
2417 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2418 it
->space_width
= Qnil
;
2419 it
->font_height
= Qnil
;
2420 it
->override_ascent
= -1;
2422 /* Are control characters displayed as `^C'? */
2423 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2425 /* -1 means everything between a CR and the following line end
2426 is invisible. >0 means lines indented more than this value are
2428 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2429 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2430 : (!NILP (BVAR (current_buffer
, selective_display
))
2432 it
->selective_display_ellipsis_p
2433 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2435 /* Display table to use. */
2436 it
->dp
= window_display_table (w
);
2438 /* Are multibyte characters enabled in current_buffer? */
2439 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2441 /* Do we need to reorder bidirectional text? Not if this is a
2442 unibyte buffer: by definition, none of the single-byte characters
2443 are strong R2L, so no reordering is needed. And bidi.c doesn't
2444 support unibyte buffers anyway. */
2446 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2448 /* Non-zero if we should highlight the region. */
2450 = (!NILP (Vtransient_mark_mode
)
2451 && !NILP (BVAR (current_buffer
, mark_active
))
2452 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2454 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2455 start and end of a visible region in window IT->w. Set both to
2456 -1 to indicate no region. */
2457 if (highlight_region_p
2458 /* Maybe highlight only in selected window. */
2459 && (/* Either show region everywhere. */
2460 highlight_nonselected_windows
2461 /* Or show region in the selected window. */
2462 || w
== XWINDOW (selected_window
)
2463 /* Or show the region if we are in the mini-buffer and W is
2464 the window the mini-buffer refers to. */
2465 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2466 && WINDOWP (minibuf_selected_window
)
2467 && w
== XWINDOW (minibuf_selected_window
))))
2469 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2470 it
->region_beg_charpos
= min (PT
, markpos
);
2471 it
->region_end_charpos
= max (PT
, markpos
);
2474 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2476 /* Get the position at which the redisplay_end_trigger hook should
2477 be run, if it is to be run at all. */
2478 if (MARKERP (w
->redisplay_end_trigger
)
2479 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2480 it
->redisplay_end_trigger_charpos
2481 = marker_position (w
->redisplay_end_trigger
);
2482 else if (INTEGERP (w
->redisplay_end_trigger
))
2483 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2485 /* Correct bogus values of tab_width. */
2486 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2487 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2490 /* Are lines in the display truncated? */
2491 if (base_face_id
!= DEFAULT_FACE_ID
2492 || XINT (it
->w
->hscroll
)
2493 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2494 && ((!NILP (Vtruncate_partial_width_windows
)
2495 && !INTEGERP (Vtruncate_partial_width_windows
))
2496 || (INTEGERP (Vtruncate_partial_width_windows
)
2497 && (WINDOW_TOTAL_COLS (it
->w
)
2498 < XINT (Vtruncate_partial_width_windows
))))))
2499 it
->line_wrap
= TRUNCATE
;
2500 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2501 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2502 ? WINDOW_WRAP
: WORD_WRAP
;
2504 it
->line_wrap
= TRUNCATE
;
2506 /* Get dimensions of truncation and continuation glyphs. These are
2507 displayed as fringe bitmaps under X, so we don't need them for such
2509 if (!FRAME_WINDOW_P (it
->f
))
2511 if (it
->line_wrap
== TRUNCATE
)
2513 /* We will need the truncation glyph. */
2514 xassert (it
->glyph_row
== NULL
);
2515 produce_special_glyphs (it
, IT_TRUNCATION
);
2516 it
->truncation_pixel_width
= it
->pixel_width
;
2520 /* We will need the continuation glyph. */
2521 xassert (it
->glyph_row
== NULL
);
2522 produce_special_glyphs (it
, IT_CONTINUATION
);
2523 it
->continuation_pixel_width
= it
->pixel_width
;
2526 /* Reset these values to zero because the produce_special_glyphs
2527 above has changed them. */
2528 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2529 it
->phys_ascent
= it
->phys_descent
= 0;
2532 /* Set this after getting the dimensions of truncation and
2533 continuation glyphs, so that we don't produce glyphs when calling
2534 produce_special_glyphs, above. */
2535 it
->glyph_row
= row
;
2536 it
->area
= TEXT_AREA
;
2538 /* Forget any previous info about this row being reversed. */
2540 it
->glyph_row
->reversed_p
= 0;
2542 /* Get the dimensions of the display area. The display area
2543 consists of the visible window area plus a horizontally scrolled
2544 part to the left of the window. All x-values are relative to the
2545 start of this total display area. */
2546 if (base_face_id
!= DEFAULT_FACE_ID
)
2548 /* Mode lines, menu bar in terminal frames. */
2549 it
->first_visible_x
= 0;
2550 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2555 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2556 it
->last_visible_x
= (it
->first_visible_x
2557 + window_box_width (w
, TEXT_AREA
));
2559 /* If we truncate lines, leave room for the truncator glyph(s) at
2560 the right margin. Otherwise, leave room for the continuation
2561 glyph(s). Truncation and continuation glyphs are not inserted
2562 for window-based redisplay. */
2563 if (!FRAME_WINDOW_P (it
->f
))
2565 if (it
->line_wrap
== TRUNCATE
)
2566 it
->last_visible_x
-= it
->truncation_pixel_width
;
2568 it
->last_visible_x
-= it
->continuation_pixel_width
;
2571 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2572 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2575 /* Leave room for a border glyph. */
2576 if (!FRAME_WINDOW_P (it
->f
)
2577 && !WINDOW_RIGHTMOST_P (it
->w
))
2578 it
->last_visible_x
-= 1;
2580 it
->last_visible_y
= window_text_bottom_y (w
);
2582 /* For mode lines and alike, arrange for the first glyph having a
2583 left box line if the face specifies a box. */
2584 if (base_face_id
!= DEFAULT_FACE_ID
)
2588 it
->face_id
= remapped_base_face_id
;
2590 /* If we have a boxed mode line, make the first character appear
2591 with a left box line. */
2592 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2593 if (face
->box
!= FACE_NO_BOX
)
2594 it
->start_of_box_run_p
= 1;
2597 /* If we are to reorder bidirectional text, init the bidi
2601 /* Note the paragraph direction that this buffer wants to
2603 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2604 it
->paragraph_embedding
= L2R
;
2605 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2606 it
->paragraph_embedding
= R2L
;
2608 it
->paragraph_embedding
= NEUTRAL_DIR
;
2609 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2612 /* If a buffer position was specified, set the iterator there,
2613 getting overlays and face properties from that position. */
2614 if (charpos
>= BUF_BEG (current_buffer
))
2616 it
->end_charpos
= ZV
;
2618 IT_CHARPOS (*it
) = charpos
;
2620 /* Compute byte position if not specified. */
2621 if (bytepos
< charpos
)
2622 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2624 IT_BYTEPOS (*it
) = bytepos
;
2626 it
->start
= it
->current
;
2628 /* Compute faces etc. */
2629 reseat (it
, it
->current
.pos
, 1);
2636 /* Initialize IT for the display of window W with window start POS. */
2639 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2641 struct glyph_row
*row
;
2642 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2644 row
= w
->desired_matrix
->rows
+ first_vpos
;
2645 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2646 it
->first_vpos
= first_vpos
;
2648 /* Don't reseat to previous visible line start if current start
2649 position is in a string or image. */
2650 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2652 int start_at_line_beg_p
;
2653 int first_y
= it
->current_y
;
2655 /* If window start is not at a line start, skip forward to POS to
2656 get the correct continuation lines width. */
2657 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2658 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2659 if (!start_at_line_beg_p
)
2663 reseat_at_previous_visible_line_start (it
);
2664 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2666 new_x
= it
->current_x
+ it
->pixel_width
;
2668 /* If lines are continued, this line may end in the middle
2669 of a multi-glyph character (e.g. a control character
2670 displayed as \003, or in the middle of an overlay
2671 string). In this case move_it_to above will not have
2672 taken us to the start of the continuation line but to the
2673 end of the continued line. */
2674 if (it
->current_x
> 0
2675 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2676 && (/* And glyph doesn't fit on the line. */
2677 new_x
> it
->last_visible_x
2678 /* Or it fits exactly and we're on a window
2680 || (new_x
== it
->last_visible_x
2681 && FRAME_WINDOW_P (it
->f
))))
2683 if (it
->current
.dpvec_index
>= 0
2684 || it
->current
.overlay_string_index
>= 0)
2686 set_iterator_to_next (it
, 1);
2687 move_it_in_display_line_to (it
, -1, -1, 0);
2690 it
->continuation_lines_width
+= it
->current_x
;
2693 /* We're starting a new display line, not affected by the
2694 height of the continued line, so clear the appropriate
2695 fields in the iterator structure. */
2696 it
->max_ascent
= it
->max_descent
= 0;
2697 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2699 it
->current_y
= first_y
;
2701 it
->current_x
= it
->hpos
= 0;
2707 /* Return 1 if POS is a position in ellipses displayed for invisible
2708 text. W is the window we display, for text property lookup. */
2711 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2713 Lisp_Object prop
, window
;
2715 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2717 /* If POS specifies a position in a display vector, this might
2718 be for an ellipsis displayed for invisible text. We won't
2719 get the iterator set up for delivering that ellipsis unless
2720 we make sure that it gets aware of the invisible text. */
2721 if (pos
->dpvec_index
>= 0
2722 && pos
->overlay_string_index
< 0
2723 && CHARPOS (pos
->string_pos
) < 0
2725 && (XSETWINDOW (window
, w
),
2726 prop
= Fget_char_property (make_number (charpos
),
2727 Qinvisible
, window
),
2728 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2730 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2732 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2739 /* Initialize IT for stepping through current_buffer in window W,
2740 starting at position POS that includes overlay string and display
2741 vector/ control character translation position information. Value
2742 is zero if there are overlay strings with newlines at POS. */
2745 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2747 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2748 int i
, overlay_strings_with_newlines
= 0;
2750 /* If POS specifies a position in a display vector, this might
2751 be for an ellipsis displayed for invisible text. We won't
2752 get the iterator set up for delivering that ellipsis unless
2753 we make sure that it gets aware of the invisible text. */
2754 if (in_ellipses_for_invisible_text_p (pos
, w
))
2760 /* Keep in mind: the call to reseat in init_iterator skips invisible
2761 text, so we might end up at a position different from POS. This
2762 is only a problem when POS is a row start after a newline and an
2763 overlay starts there with an after-string, and the overlay has an
2764 invisible property. Since we don't skip invisible text in
2765 display_line and elsewhere immediately after consuming the
2766 newline before the row start, such a POS will not be in a string,
2767 but the call to init_iterator below will move us to the
2769 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2771 /* This only scans the current chunk -- it should scan all chunks.
2772 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2773 to 16 in 22.1 to make this a lesser problem. */
2774 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2776 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2777 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2779 while (s
< e
&& *s
!= '\n')
2784 overlay_strings_with_newlines
= 1;
2789 /* If position is within an overlay string, set up IT to the right
2791 if (pos
->overlay_string_index
>= 0)
2795 /* If the first overlay string happens to have a `display'
2796 property for an image, the iterator will be set up for that
2797 image, and we have to undo that setup first before we can
2798 correct the overlay string index. */
2799 if (it
->method
== GET_FROM_IMAGE
)
2802 /* We already have the first chunk of overlay strings in
2803 IT->overlay_strings. Load more until the one for
2804 pos->overlay_string_index is in IT->overlay_strings. */
2805 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2807 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2808 it
->current
.overlay_string_index
= 0;
2811 load_overlay_strings (it
, 0);
2812 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2816 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2817 relative_index
= (it
->current
.overlay_string_index
2818 % OVERLAY_STRING_CHUNK_SIZE
);
2819 it
->string
= it
->overlay_strings
[relative_index
];
2820 xassert (STRINGP (it
->string
));
2821 it
->current
.string_pos
= pos
->string_pos
;
2822 it
->method
= GET_FROM_STRING
;
2825 if (CHARPOS (pos
->string_pos
) >= 0)
2827 /* Recorded position is not in an overlay string, but in another
2828 string. This can only be a string from a `display' property.
2829 IT should already be filled with that string. */
2830 it
->current
.string_pos
= pos
->string_pos
;
2831 xassert (STRINGP (it
->string
));
2834 /* Restore position in display vector translations, control
2835 character translations or ellipses. */
2836 if (pos
->dpvec_index
>= 0)
2838 if (it
->dpvec
== NULL
)
2839 get_next_display_element (it
);
2840 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2841 it
->current
.dpvec_index
= pos
->dpvec_index
;
2845 return !overlay_strings_with_newlines
;
2849 /* Initialize IT for stepping through current_buffer in window W
2850 starting at ROW->start. */
2853 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2855 init_from_display_pos (it
, w
, &row
->start
);
2856 it
->start
= row
->start
;
2857 it
->continuation_lines_width
= row
->continuation_lines_width
;
2862 /* Initialize IT for stepping through current_buffer in window W
2863 starting in the line following ROW, i.e. starting at ROW->end.
2864 Value is zero if there are overlay strings with newlines at ROW's
2868 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2872 if (init_from_display_pos (it
, w
, &row
->end
))
2874 if (row
->continued_p
)
2875 it
->continuation_lines_width
2876 = row
->continuation_lines_width
+ row
->pixel_width
;
2887 /***********************************************************************
2889 ***********************************************************************/
2891 /* Called when IT reaches IT->stop_charpos. Handle text property and
2892 overlay changes. Set IT->stop_charpos to the next position where
2896 handle_stop (struct it
*it
)
2898 enum prop_handled handled
;
2899 int handle_overlay_change_p
;
2903 it
->current
.dpvec_index
= -1;
2904 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2905 it
->ignore_overlay_strings_at_pos_p
= 0;
2908 /* Use face of preceding text for ellipsis (if invisible) */
2909 if (it
->selective_display_ellipsis_p
)
2910 it
->saved_face_id
= it
->face_id
;
2914 handled
= HANDLED_NORMALLY
;
2916 /* Call text property handlers. */
2917 for (p
= it_props
; p
->handler
; ++p
)
2919 handled
= p
->handler (it
);
2921 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2923 else if (handled
== HANDLED_RETURN
)
2925 /* We still want to show before and after strings from
2926 overlays even if the actual buffer text is replaced. */
2927 if (!handle_overlay_change_p
2929 || !get_overlay_strings_1 (it
, 0, 0))
2932 setup_for_ellipsis (it
, 0);
2933 /* When handling a display spec, we might load an
2934 empty string. In that case, discard it here. We
2935 used to discard it in handle_single_display_spec,
2936 but that causes get_overlay_strings_1, above, to
2937 ignore overlay strings that we must check. */
2938 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2942 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2946 it
->ignore_overlay_strings_at_pos_p
= 1;
2947 it
->string_from_display_prop_p
= 0;
2948 handle_overlay_change_p
= 0;
2950 handled
= HANDLED_RECOMPUTE_PROPS
;
2953 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2954 handle_overlay_change_p
= 0;
2957 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2959 /* Don't check for overlay strings below when set to deliver
2960 characters from a display vector. */
2961 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2962 handle_overlay_change_p
= 0;
2964 /* Handle overlay changes.
2965 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2966 if it finds overlays. */
2967 if (handle_overlay_change_p
)
2968 handled
= handle_overlay_change (it
);
2973 setup_for_ellipsis (it
, 0);
2977 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2979 /* Determine where to stop next. */
2980 if (handled
== HANDLED_NORMALLY
)
2981 compute_stop_pos (it
);
2985 /* Compute IT->stop_charpos from text property and overlay change
2986 information for IT's current position. */
2989 compute_stop_pos (struct it
*it
)
2991 register INTERVAL iv
, next_iv
;
2992 Lisp_Object object
, limit
, position
;
2993 EMACS_INT charpos
, bytepos
;
2995 /* If nowhere else, stop at the end. */
2996 it
->stop_charpos
= it
->end_charpos
;
2998 if (STRINGP (it
->string
))
3000 /* Strings are usually short, so don't limit the search for
3002 object
= it
->string
;
3004 charpos
= IT_STRING_CHARPOS (*it
);
3005 bytepos
= IT_STRING_BYTEPOS (*it
);
3011 /* If next overlay change is in front of the current stop pos
3012 (which is IT->end_charpos), stop there. Note: value of
3013 next_overlay_change is point-max if no overlay change
3015 charpos
= IT_CHARPOS (*it
);
3016 bytepos
= IT_BYTEPOS (*it
);
3017 pos
= next_overlay_change (charpos
);
3018 if (pos
< it
->stop_charpos
)
3019 it
->stop_charpos
= pos
;
3021 /* If showing the region, we have to stop at the region
3022 start or end because the face might change there. */
3023 if (it
->region_beg_charpos
> 0)
3025 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3026 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3027 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3028 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3031 /* Set up variables for computing the stop position from text
3032 property changes. */
3033 XSETBUFFER (object
, current_buffer
);
3034 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3037 /* Get the interval containing IT's position. Value is a null
3038 interval if there isn't such an interval. */
3039 position
= make_number (charpos
);
3040 iv
= validate_interval_range (object
, &position
, &position
, 0);
3041 if (!NULL_INTERVAL_P (iv
))
3043 Lisp_Object values_here
[LAST_PROP_IDX
];
3046 /* Get properties here. */
3047 for (p
= it_props
; p
->handler
; ++p
)
3048 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3050 /* Look for an interval following iv that has different
3052 for (next_iv
= next_interval (iv
);
3053 (!NULL_INTERVAL_P (next_iv
)
3055 || XFASTINT (limit
) > next_iv
->position
));
3056 next_iv
= next_interval (next_iv
))
3058 for (p
= it_props
; p
->handler
; ++p
)
3060 Lisp_Object new_value
;
3062 new_value
= textget (next_iv
->plist
, *p
->name
);
3063 if (!EQ (values_here
[p
->idx
], new_value
))
3071 if (!NULL_INTERVAL_P (next_iv
))
3073 if (INTEGERP (limit
)
3074 && next_iv
->position
>= XFASTINT (limit
))
3075 /* No text property change up to limit. */
3076 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3078 /* Text properties change in next_iv. */
3079 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3083 if (it
->cmp_it
.id
< 0)
3085 EMACS_INT stoppos
= it
->end_charpos
;
3087 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3089 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3090 stoppos
, it
->string
);
3093 xassert (STRINGP (it
->string
)
3094 || (it
->stop_charpos
>= BEGV
3095 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3099 /* Return the position of the next overlay change after POS in
3100 current_buffer. Value is point-max if no overlay change
3101 follows. This is like `next-overlay-change' but doesn't use
3105 next_overlay_change (EMACS_INT pos
)
3109 Lisp_Object
*overlays
;
3112 /* Get all overlays at the given position. */
3113 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3115 /* If any of these overlays ends before endpos,
3116 use its ending point instead. */
3117 for (i
= 0; i
< noverlays
; ++i
)
3122 oend
= OVERLAY_END (overlays
[i
]);
3123 oendpos
= OVERLAY_POSITION (oend
);
3124 endpos
= min (endpos
, oendpos
);
3132 /***********************************************************************
3134 ***********************************************************************/
3136 /* Handle changes in the `fontified' property of the current buffer by
3137 calling hook functions from Qfontification_functions to fontify
3140 static enum prop_handled
3141 handle_fontified_prop (struct it
*it
)
3143 Lisp_Object prop
, pos
;
3144 enum prop_handled handled
= HANDLED_NORMALLY
;
3146 if (!NILP (Vmemory_full
))
3149 /* Get the value of the `fontified' property at IT's current buffer
3150 position. (The `fontified' property doesn't have a special
3151 meaning in strings.) If the value is nil, call functions from
3152 Qfontification_functions. */
3153 if (!STRINGP (it
->string
)
3155 && !NILP (Vfontification_functions
)
3156 && !NILP (Vrun_hooks
)
3157 && (pos
= make_number (IT_CHARPOS (*it
)),
3158 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3159 /* Ignore the special cased nil value always present at EOB since
3160 no amount of fontifying will be able to change it. */
3161 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3163 int count
= SPECPDL_INDEX ();
3165 struct buffer
*obuf
= current_buffer
;
3166 int begv
= BEGV
, zv
= ZV
;
3167 int old_clip_changed
= current_buffer
->clip_changed
;
3169 val
= Vfontification_functions
;
3170 specbind (Qfontification_functions
, Qnil
);
3172 xassert (it
->end_charpos
== ZV
);
3174 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3175 safe_call1 (val
, pos
);
3178 Lisp_Object fns
, fn
;
3179 struct gcpro gcpro1
, gcpro2
;
3184 for (; CONSP (val
); val
= XCDR (val
))
3190 /* A value of t indicates this hook has a local
3191 binding; it means to run the global binding too.
3192 In a global value, t should not occur. If it
3193 does, we must ignore it to avoid an endless
3195 for (fns
= Fdefault_value (Qfontification_functions
);
3201 safe_call1 (fn
, pos
);
3205 safe_call1 (fn
, pos
);
3211 unbind_to (count
, Qnil
);
3213 /* Fontification functions routinely call `save-restriction'.
3214 Normally, this tags clip_changed, which can confuse redisplay
3215 (see discussion in Bug#6671). Since we don't perform any
3216 special handling of fontification changes in the case where
3217 `save-restriction' isn't called, there's no point doing so in
3218 this case either. So, if the buffer's restrictions are
3219 actually left unchanged, reset clip_changed. */
3220 if (obuf
== current_buffer
)
3222 if (begv
== BEGV
&& zv
== ZV
)
3223 current_buffer
->clip_changed
= old_clip_changed
;
3225 /* There isn't much we can reasonably do to protect against
3226 misbehaving fontification, but here's a fig leaf. */
3227 else if (!NILP (BVAR (obuf
, name
)))
3228 set_buffer_internal_1 (obuf
);
3230 /* The fontification code may have added/removed text.
3231 It could do even a lot worse, but let's at least protect against
3232 the most obvious case where only the text past `pos' gets changed',
3233 as is/was done in grep.el where some escapes sequences are turned
3234 into face properties (bug#7876). */
3235 it
->end_charpos
= ZV
;
3237 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3238 something. This avoids an endless loop if they failed to
3239 fontify the text for which reason ever. */
3240 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3241 handled
= HANDLED_RECOMPUTE_PROPS
;
3249 /***********************************************************************
3251 ***********************************************************************/
3253 /* Set up iterator IT from face properties at its current position.
3254 Called from handle_stop. */
3256 static enum prop_handled
3257 handle_face_prop (struct it
*it
)
3260 EMACS_INT next_stop
;
3262 if (!STRINGP (it
->string
))
3265 = face_at_buffer_position (it
->w
,
3267 it
->region_beg_charpos
,
3268 it
->region_end_charpos
,
3271 + TEXT_PROP_DISTANCE_LIMIT
),
3272 0, it
->base_face_id
);
3274 /* Is this a start of a run of characters with box face?
3275 Caveat: this can be called for a freshly initialized
3276 iterator; face_id is -1 in this case. We know that the new
3277 face will not change until limit, i.e. if the new face has a
3278 box, all characters up to limit will have one. But, as
3279 usual, we don't know whether limit is really the end. */
3280 if (new_face_id
!= it
->face_id
)
3282 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3284 /* If new face has a box but old face has not, this is
3285 the start of a run of characters with box, i.e. it has
3286 a shadow on the left side. The value of face_id of the
3287 iterator will be -1 if this is the initial call that gets
3288 the face. In this case, we have to look in front of IT's
3289 position and see whether there is a face != new_face_id. */
3290 it
->start_of_box_run_p
3291 = (new_face
->box
!= FACE_NO_BOX
3292 && (it
->face_id
>= 0
3293 || IT_CHARPOS (*it
) == BEG
3294 || new_face_id
!= face_before_it_pos (it
)));
3295 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3303 Lisp_Object from_overlay
3304 = (it
->current
.overlay_string_index
>= 0
3305 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3308 /* See if we got to this string directly or indirectly from
3309 an overlay property. That includes the before-string or
3310 after-string of an overlay, strings in display properties
3311 provided by an overlay, their text properties, etc.
3313 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3314 if (! NILP (from_overlay
))
3315 for (i
= it
->sp
- 1; i
>= 0; i
--)
3317 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3319 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3320 else if (! NILP (it
->stack
[i
].from_overlay
))
3321 from_overlay
= it
->stack
[i
].from_overlay
;
3323 if (!NILP (from_overlay
))
3327 if (! NILP (from_overlay
))
3329 bufpos
= IT_CHARPOS (*it
);
3330 /* For a string from an overlay, the base face depends
3331 only on text properties and ignores overlays. */
3333 = face_for_overlay_string (it
->w
,
3335 it
->region_beg_charpos
,
3336 it
->region_end_charpos
,
3339 + TEXT_PROP_DISTANCE_LIMIT
),
3347 /* For strings from a `display' property, use the face at
3348 IT's current buffer position as the base face to merge
3349 with, so that overlay strings appear in the same face as
3350 surrounding text, unless they specify their own
3352 base_face_id
= underlying_face_id (it
);
3355 new_face_id
= face_at_string_position (it
->w
,
3357 IT_STRING_CHARPOS (*it
),
3359 it
->region_beg_charpos
,
3360 it
->region_end_charpos
,
3364 /* Is this a start of a run of characters with box? Caveat:
3365 this can be called for a freshly allocated iterator; face_id
3366 is -1 is this case. We know that the new face will not
3367 change until the next check pos, i.e. if the new face has a
3368 box, all characters up to that position will have a
3369 box. But, as usual, we don't know whether that position
3370 is really the end. */
3371 if (new_face_id
!= it
->face_id
)
3373 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3374 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3376 /* If new face has a box but old face hasn't, this is the
3377 start of a run of characters with box, i.e. it has a
3378 shadow on the left side. */
3379 it
->start_of_box_run_p
3380 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3381 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3385 it
->face_id
= new_face_id
;
3386 return HANDLED_NORMALLY
;
3390 /* Return the ID of the face ``underlying'' IT's current position,
3391 which is in a string. If the iterator is associated with a
3392 buffer, return the face at IT's current buffer position.
3393 Otherwise, use the iterator's base_face_id. */
3396 underlying_face_id (struct it
*it
)
3398 int face_id
= it
->base_face_id
, i
;
3400 xassert (STRINGP (it
->string
));
3402 for (i
= it
->sp
- 1; i
>= 0; --i
)
3403 if (NILP (it
->stack
[i
].string
))
3404 face_id
= it
->stack
[i
].face_id
;
3410 /* Compute the face one character before or after the current position
3411 of IT. BEFORE_P non-zero means get the face in front of IT's
3412 position. Value is the id of the face. */
3415 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3418 EMACS_INT next_check_charpos
;
3419 struct text_pos pos
;
3421 xassert (it
->s
== NULL
);
3423 if (STRINGP (it
->string
))
3428 /* No face change past the end of the string (for the case
3429 we are padding with spaces). No face change before the
3431 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3432 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3435 /* Set pos to the position before or after IT's current position. */
3437 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3439 /* For composition, we must check the character after the
3441 pos
= (it
->what
== IT_COMPOSITION
3442 ? string_pos (IT_STRING_CHARPOS (*it
)
3443 + it
->cmp_it
.nchars
, it
->string
)
3444 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3446 if (it
->current
.overlay_string_index
>= 0)
3447 bufpos
= IT_CHARPOS (*it
);
3451 base_face_id
= underlying_face_id (it
);
3453 /* Get the face for ASCII, or unibyte. */
3454 face_id
= face_at_string_position (it
->w
,
3458 it
->region_beg_charpos
,
3459 it
->region_end_charpos
,
3460 &next_check_charpos
,
3463 /* Correct the face for charsets different from ASCII. Do it
3464 for the multibyte case only. The face returned above is
3465 suitable for unibyte text if IT->string is unibyte. */
3466 if (STRING_MULTIBYTE (it
->string
))
3468 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3470 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3472 c
= string_char_and_length (p
, &len
);
3473 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3478 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3479 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3482 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3483 pos
= it
->current
.pos
;
3486 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3489 if (it
->what
== IT_COMPOSITION
)
3490 /* For composition, we must check the position after the
3492 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3494 INC_TEXT_POS (pos
, it
->multibyte_p
);
3497 /* Determine face for CHARSET_ASCII, or unibyte. */
3498 face_id
= face_at_buffer_position (it
->w
,
3500 it
->region_beg_charpos
,
3501 it
->region_end_charpos
,
3502 &next_check_charpos
,
3505 /* Correct the face for charsets different from ASCII. Do it
3506 for the multibyte case only. The face returned above is
3507 suitable for unibyte text if current_buffer is unibyte. */
3508 if (it
->multibyte_p
)
3510 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3511 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3512 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3521 /***********************************************************************
3523 ***********************************************************************/
3525 /* Set up iterator IT from invisible properties at its current
3526 position. Called from handle_stop. */
3528 static enum prop_handled
3529 handle_invisible_prop (struct it
*it
)
3531 enum prop_handled handled
= HANDLED_NORMALLY
;
3533 if (STRINGP (it
->string
))
3535 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3537 /* Get the value of the invisible text property at the
3538 current position. Value will be nil if there is no such
3540 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3541 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3544 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3546 handled
= HANDLED_RECOMPUTE_PROPS
;
3548 /* Get the position at which the next change of the
3549 invisible text property can be found in IT->string.
3550 Value will be nil if the property value is the same for
3551 all the rest of IT->string. */
3552 XSETINT (limit
, SCHARS (it
->string
));
3553 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3556 /* Text at current position is invisible. The next
3557 change in the property is at position end_charpos.
3558 Move IT's current position to that position. */
3559 if (INTEGERP (end_charpos
)
3560 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3562 struct text_pos old
;
3563 old
= it
->current
.string_pos
;
3564 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3565 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3569 /* The rest of the string is invisible. If this is an
3570 overlay string, proceed with the next overlay string
3571 or whatever comes and return a character from there. */
3572 if (it
->current
.overlay_string_index
>= 0)
3574 next_overlay_string (it
);
3575 /* Don't check for overlay strings when we just
3576 finished processing them. */
3577 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3581 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3582 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3590 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3591 Lisp_Object pos
, prop
, overlay
;
3593 /* First of all, is there invisible text at this position? */
3594 tem
= start_charpos
= IT_CHARPOS (*it
);
3595 pos
= make_number (tem
);
3596 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3598 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3600 /* If we are on invisible text, skip over it. */
3601 if (invis_p
&& start_charpos
< it
->end_charpos
)
3603 /* Record whether we have to display an ellipsis for the
3605 int display_ellipsis_p
= invis_p
== 2;
3607 handled
= HANDLED_RECOMPUTE_PROPS
;
3609 /* Loop skipping over invisible text. The loop is left at
3610 ZV or with IT on the first char being visible again. */
3613 /* Try to skip some invisible text. Return value is the
3614 position reached which can be equal to where we start
3615 if there is nothing invisible there. This skips both
3616 over invisible text properties and overlays with
3617 invisible property. */
3618 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3620 /* If we skipped nothing at all we weren't at invisible
3621 text in the first place. If everything to the end of
3622 the buffer was skipped, end the loop. */
3623 if (newpos
== tem
|| newpos
>= ZV
)
3627 /* We skipped some characters but not necessarily
3628 all there are. Check if we ended up on visible
3629 text. Fget_char_property returns the property of
3630 the char before the given position, i.e. if we
3631 get invis_p = 0, this means that the char at
3632 newpos is visible. */
3633 pos
= make_number (newpos
);
3634 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3635 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3638 /* If we ended up on invisible text, proceed to
3639 skip starting with next_stop. */
3643 /* If there are adjacent invisible texts, don't lose the
3644 second one's ellipsis. */
3646 display_ellipsis_p
= 1;
3650 /* The position newpos is now either ZV or on visible text. */
3651 if (it
->bidi_p
&& newpos
< ZV
)
3653 /* With bidi iteration, the region of invisible text
3654 could start and/or end in the middle of a non-base
3655 embedding level. Therefore, we need to skip
3656 invisible text using the bidi iterator, starting at
3657 IT's current position, until we find ourselves
3658 outside the invisible text. Skipping invisible text
3659 _after_ bidi iteration avoids affecting the visual
3660 order of the displayed text when invisible properties
3661 are added or removed. */
3662 if (it
->bidi_it
.first_elt
)
3664 /* If we were `reseat'ed to a new paragraph,
3665 determine the paragraph base direction. We need
3666 to do it now because next_element_from_buffer may
3667 not have a chance to do it, if we are going to
3668 skip any text at the beginning, which resets the
3670 bidi_paragraph_init (it
->paragraph_embedding
,
3675 bidi_move_to_visually_next (&it
->bidi_it
);
3677 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3678 && it
->bidi_it
.charpos
< newpos
);
3679 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3680 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3681 /* If we overstepped NEWPOS, record its position in the
3682 iterator, so that we skip invisible text if later the
3683 bidi iteration lands us in the invisible region
3685 if (IT_CHARPOS (*it
) >= newpos
)
3686 it
->prev_stop
= newpos
;
3690 IT_CHARPOS (*it
) = newpos
;
3691 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3694 /* If there are before-strings at the start of invisible
3695 text, and the text is invisible because of a text
3696 property, arrange to show before-strings because 20.x did
3697 it that way. (If the text is invisible because of an
3698 overlay property instead of a text property, this is
3699 already handled in the overlay code.) */
3701 && get_overlay_strings (it
, it
->stop_charpos
))
3703 handled
= HANDLED_RECOMPUTE_PROPS
;
3704 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3706 else if (display_ellipsis_p
)
3708 /* Make sure that the glyphs of the ellipsis will get
3709 correct `charpos' values. If we would not update
3710 it->position here, the glyphs would belong to the
3711 last visible character _before_ the invisible
3712 text, which confuses `set_cursor_from_row'.
3714 We use the last invisible position instead of the
3715 first because this way the cursor is always drawn on
3716 the first "." of the ellipsis, whenever PT is inside
3717 the invisible text. Otherwise the cursor would be
3718 placed _after_ the ellipsis when the point is after the
3719 first invisible character. */
3720 if (!STRINGP (it
->object
))
3722 it
->position
.charpos
= newpos
- 1;
3723 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3726 /* Let the ellipsis display before
3727 considering any properties of the following char.
3728 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3729 handled
= HANDLED_RETURN
;
3738 /* Make iterator IT return `...' next.
3739 Replaces LEN characters from buffer. */
3742 setup_for_ellipsis (struct it
*it
, int len
)
3744 /* Use the display table definition for `...'. Invalid glyphs
3745 will be handled by the method returning elements from dpvec. */
3746 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3748 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3749 it
->dpvec
= v
->contents
;
3750 it
->dpend
= v
->contents
+ v
->size
;
3754 /* Default `...'. */
3755 it
->dpvec
= default_invis_vector
;
3756 it
->dpend
= default_invis_vector
+ 3;
3759 it
->dpvec_char_len
= len
;
3760 it
->current
.dpvec_index
= 0;
3761 it
->dpvec_face_id
= -1;
3763 /* Remember the current face id in case glyphs specify faces.
3764 IT's face is restored in set_iterator_to_next.
3765 saved_face_id was set to preceding char's face in handle_stop. */
3766 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3767 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3769 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3775 /***********************************************************************
3777 ***********************************************************************/
3779 /* Set up iterator IT from `display' property at its current position.
3780 Called from handle_stop.
3781 We return HANDLED_RETURN if some part of the display property
3782 overrides the display of the buffer text itself.
3783 Otherwise we return HANDLED_NORMALLY. */
3785 static enum prop_handled
3786 handle_display_prop (struct it
*it
)
3788 Lisp_Object prop
, object
, overlay
;
3789 struct text_pos
*position
;
3790 /* Nonzero if some property replaces the display of the text itself. */
3791 int display_replaced_p
= 0;
3793 if (STRINGP (it
->string
))
3795 object
= it
->string
;
3796 position
= &it
->current
.string_pos
;
3800 XSETWINDOW (object
, it
->w
);
3801 position
= &it
->current
.pos
;
3804 /* Reset those iterator values set from display property values. */
3805 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3806 it
->space_width
= Qnil
;
3807 it
->font_height
= Qnil
;
3810 /* We don't support recursive `display' properties, i.e. string
3811 values that have a string `display' property, that have a string
3812 `display' property etc. */
3813 if (!it
->string_from_display_prop_p
)
3814 it
->area
= TEXT_AREA
;
3816 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3817 Qdisplay
, object
, &overlay
);
3819 return HANDLED_NORMALLY
;
3820 /* Now OVERLAY is the overlay that gave us this property, or nil
3821 if it was a text property. */
3823 if (!STRINGP (it
->string
))
3824 object
= it
->w
->buffer
;
3827 /* Simple properties. */
3828 && !EQ (XCAR (prop
), Qimage
)
3829 && !EQ (XCAR (prop
), Qspace
)
3830 && !EQ (XCAR (prop
), Qwhen
)
3831 && !EQ (XCAR (prop
), Qslice
)
3832 && !EQ (XCAR (prop
), Qspace_width
)
3833 && !EQ (XCAR (prop
), Qheight
)
3834 && !EQ (XCAR (prop
), Qraise
)
3835 /* Marginal area specifications. */
3836 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3837 && !EQ (XCAR (prop
), Qleft_fringe
)
3838 && !EQ (XCAR (prop
), Qright_fringe
)
3839 && !NILP (XCAR (prop
)))
3841 for (; CONSP (prop
); prop
= XCDR (prop
))
3843 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3844 position
, display_replaced_p
))
3846 display_replaced_p
= 1;
3847 /* If some text in a string is replaced, `position' no
3848 longer points to the position of `object'. */
3849 if (STRINGP (object
))
3854 else if (VECTORP (prop
))
3857 for (i
= 0; i
< ASIZE (prop
); ++i
)
3858 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3859 position
, display_replaced_p
))
3861 display_replaced_p
= 1;
3862 /* If some text in a string is replaced, `position' no
3863 longer points to the position of `object'. */
3864 if (STRINGP (object
))
3870 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3872 display_replaced_p
= 1;
3875 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3879 /* Value is the position of the end of the `display' property starting
3880 at START_POS in OBJECT. */
3882 static struct text_pos
3883 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3886 struct text_pos end_pos
;
3888 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3889 Qdisplay
, object
, Qnil
);
3890 CHARPOS (end_pos
) = XFASTINT (end
);
3891 if (STRINGP (object
))
3892 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3894 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3900 /* Set up IT from a single `display' specification PROP. OBJECT
3901 is the object in which the `display' property was found. *POSITION
3902 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3903 means that we previously saw a display specification which already
3904 replaced text display with something else, for example an image;
3905 we ignore such properties after the first one has been processed.
3907 OVERLAY is the overlay this `display' property came from,
3908 or nil if it was a text property.
3910 If PROP is a `space' or `image' specification, and in some other
3911 cases too, set *POSITION to the position where the `display'
3914 Value is non-zero if something was found which replaces the display
3915 of buffer or string text. */
3918 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3919 Lisp_Object overlay
, struct text_pos
*position
,
3920 int display_replaced_before_p
)
3923 Lisp_Object location
, value
;
3924 struct text_pos start_pos
, save_pos
;
3927 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3928 If the result is non-nil, use VALUE instead of SPEC. */
3930 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3939 if (!NILP (form
) && !EQ (form
, Qt
))
3941 int count
= SPECPDL_INDEX ();
3942 struct gcpro gcpro1
;
3944 /* Bind `object' to the object having the `display' property, a
3945 buffer or string. Bind `position' to the position in the
3946 object where the property was found, and `buffer-position'
3947 to the current position in the buffer. */
3948 specbind (Qobject
, object
);
3949 specbind (Qposition
, make_number (CHARPOS (*position
)));
3950 specbind (Qbuffer_position
,
3951 make_number (STRINGP (object
)
3952 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3954 form
= safe_eval (form
);
3956 unbind_to (count
, Qnil
);
3962 /* Handle `(height HEIGHT)' specifications. */
3964 && EQ (XCAR (spec
), Qheight
)
3965 && CONSP (XCDR (spec
)))
3967 if (!FRAME_WINDOW_P (it
->f
))
3970 it
->font_height
= XCAR (XCDR (spec
));
3971 if (!NILP (it
->font_height
))
3973 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3974 int new_height
= -1;
3976 if (CONSP (it
->font_height
)
3977 && (EQ (XCAR (it
->font_height
), Qplus
)
3978 || EQ (XCAR (it
->font_height
), Qminus
))
3979 && CONSP (XCDR (it
->font_height
))
3980 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3982 /* `(+ N)' or `(- N)' where N is an integer. */
3983 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3984 if (EQ (XCAR (it
->font_height
), Qplus
))
3986 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3988 else if (FUNCTIONP (it
->font_height
))
3990 /* Call function with current height as argument.
3991 Value is the new height. */
3993 height
= safe_call1 (it
->font_height
,
3994 face
->lface
[LFACE_HEIGHT_INDEX
]);
3995 if (NUMBERP (height
))
3996 new_height
= XFLOATINT (height
);
3998 else if (NUMBERP (it
->font_height
))
4000 /* Value is a multiple of the canonical char height. */
4003 f
= FACE_FROM_ID (it
->f
,
4004 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4005 new_height
= (XFLOATINT (it
->font_height
)
4006 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4010 /* Evaluate IT->font_height with `height' bound to the
4011 current specified height to get the new height. */
4012 int count
= SPECPDL_INDEX ();
4014 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4015 value
= safe_eval (it
->font_height
);
4016 unbind_to (count
, Qnil
);
4018 if (NUMBERP (value
))
4019 new_height
= XFLOATINT (value
);
4023 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4029 /* Handle `(space-width WIDTH)'. */
4031 && EQ (XCAR (spec
), Qspace_width
)
4032 && CONSP (XCDR (spec
)))
4034 if (!FRAME_WINDOW_P (it
->f
))
4037 value
= XCAR (XCDR (spec
));
4038 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4039 it
->space_width
= value
;
4044 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4046 && EQ (XCAR (spec
), Qslice
))
4050 if (!FRAME_WINDOW_P (it
->f
))
4053 if (tem
= XCDR (spec
), CONSP (tem
))
4055 it
->slice
.x
= XCAR (tem
);
4056 if (tem
= XCDR (tem
), CONSP (tem
))
4058 it
->slice
.y
= XCAR (tem
);
4059 if (tem
= XCDR (tem
), CONSP (tem
))
4061 it
->slice
.width
= XCAR (tem
);
4062 if (tem
= XCDR (tem
), CONSP (tem
))
4063 it
->slice
.height
= XCAR (tem
);
4071 /* Handle `(raise FACTOR)'. */
4073 && EQ (XCAR (spec
), Qraise
)
4074 && CONSP (XCDR (spec
)))
4076 if (!FRAME_WINDOW_P (it
->f
))
4079 #ifdef HAVE_WINDOW_SYSTEM
4080 value
= XCAR (XCDR (spec
));
4081 if (NUMBERP (value
))
4083 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4084 it
->voffset
= - (XFLOATINT (value
)
4085 * (FONT_HEIGHT (face
->font
)));
4087 #endif /* HAVE_WINDOW_SYSTEM */
4092 /* Don't handle the other kinds of display specifications
4093 inside a string that we got from a `display' property. */
4094 if (it
->string_from_display_prop_p
)
4097 /* Characters having this form of property are not displayed, so
4098 we have to find the end of the property. */
4099 start_pos
= *position
;
4100 *position
= display_prop_end (it
, object
, start_pos
);
4103 /* Stop the scan at that end position--we assume that all
4104 text properties change there. */
4105 it
->stop_charpos
= position
->charpos
;
4107 /* Handle `(left-fringe BITMAP [FACE])'
4108 and `(right-fringe BITMAP [FACE])'. */
4110 && (EQ (XCAR (spec
), Qleft_fringe
)
4111 || EQ (XCAR (spec
), Qright_fringe
))
4112 && CONSP (XCDR (spec
)))
4114 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4117 if (!FRAME_WINDOW_P (it
->f
))
4118 /* If we return here, POSITION has been advanced
4119 across the text with this property. */
4122 #ifdef HAVE_WINDOW_SYSTEM
4123 value
= XCAR (XCDR (spec
));
4124 if (!SYMBOLP (value
)
4125 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4126 /* If we return here, POSITION has been advanced
4127 across the text with this property. */
4130 if (CONSP (XCDR (XCDR (spec
))))
4132 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4133 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4139 /* Save current settings of IT so that we can restore them
4140 when we are finished with the glyph property value. */
4142 save_pos
= it
->position
;
4143 it
->position
= *position
;
4145 it
->position
= save_pos
;
4147 it
->area
= TEXT_AREA
;
4148 it
->what
= IT_IMAGE
;
4149 it
->image_id
= -1; /* no image */
4150 it
->position
= start_pos
;
4151 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4152 it
->method
= GET_FROM_IMAGE
;
4153 it
->from_overlay
= Qnil
;
4154 it
->face_id
= face_id
;
4156 /* Say that we haven't consumed the characters with
4157 `display' property yet. The call to pop_it in
4158 set_iterator_to_next will clean this up. */
4159 *position
= start_pos
;
4161 if (EQ (XCAR (spec
), Qleft_fringe
))
4163 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4164 it
->left_user_fringe_face_id
= face_id
;
4168 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4169 it
->right_user_fringe_face_id
= face_id
;
4171 #endif /* HAVE_WINDOW_SYSTEM */
4175 /* Prepare to handle `((margin left-margin) ...)',
4176 `((margin right-margin) ...)' and `((margin nil) ...)'
4177 prefixes for display specifications. */
4178 location
= Qunbound
;
4179 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4183 value
= XCDR (spec
);
4185 value
= XCAR (value
);
4188 if (EQ (XCAR (tem
), Qmargin
)
4189 && (tem
= XCDR (tem
),
4190 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4192 || EQ (tem
, Qleft_margin
)
4193 || EQ (tem
, Qright_margin
))))
4197 if (EQ (location
, Qunbound
))
4203 /* After this point, VALUE is the property after any
4204 margin prefix has been stripped. It must be a string,
4205 an image specification, or `(space ...)'.
4207 LOCATION specifies where to display: `left-margin',
4208 `right-margin' or nil. */
4210 valid_p
= (STRINGP (value
)
4211 #ifdef HAVE_WINDOW_SYSTEM
4212 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4213 #endif /* not HAVE_WINDOW_SYSTEM */
4214 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4216 if (valid_p
&& !display_replaced_before_p
)
4218 /* Save current settings of IT so that we can restore them
4219 when we are finished with the glyph property value. */
4220 save_pos
= it
->position
;
4221 it
->position
= *position
;
4223 it
->position
= save_pos
;
4224 it
->from_overlay
= overlay
;
4226 if (NILP (location
))
4227 it
->area
= TEXT_AREA
;
4228 else if (EQ (location
, Qleft_margin
))
4229 it
->area
= LEFT_MARGIN_AREA
;
4231 it
->area
= RIGHT_MARGIN_AREA
;
4233 if (STRINGP (value
))
4236 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4237 it
->current
.overlay_string_index
= -1;
4238 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4239 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4240 it
->method
= GET_FROM_STRING
;
4241 it
->stop_charpos
= 0;
4242 it
->string_from_display_prop_p
= 1;
4243 /* Say that we haven't consumed the characters with
4244 `display' property yet. The call to pop_it in
4245 set_iterator_to_next will clean this up. */
4246 if (BUFFERP (object
))
4247 *position
= start_pos
;
4249 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4251 it
->method
= GET_FROM_STRETCH
;
4253 *position
= it
->position
= start_pos
;
4255 #ifdef HAVE_WINDOW_SYSTEM
4258 it
->what
= IT_IMAGE
;
4259 it
->image_id
= lookup_image (it
->f
, value
);
4260 it
->position
= start_pos
;
4261 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4262 it
->method
= GET_FROM_IMAGE
;
4264 /* Say that we haven't consumed the characters with
4265 `display' property yet. The call to pop_it in
4266 set_iterator_to_next will clean this up. */
4267 *position
= start_pos
;
4269 #endif /* HAVE_WINDOW_SYSTEM */
4274 /* Invalid property or property not supported. Restore
4275 POSITION to what it was before. */
4276 *position
= start_pos
;
4281 /* Check if SPEC is a display sub-property value whose text should be
4282 treated as intangible. */
4285 single_display_spec_intangible_p (Lisp_Object prop
)
4287 /* Skip over `when FORM'. */
4288 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4302 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4303 we don't need to treat text as intangible. */
4304 if (EQ (XCAR (prop
), Qmargin
))
4312 || EQ (XCAR (prop
), Qleft_margin
)
4313 || EQ (XCAR (prop
), Qright_margin
))
4317 return (CONSP (prop
)
4318 && (EQ (XCAR (prop
), Qimage
)
4319 || EQ (XCAR (prop
), Qspace
)));
4323 /* Check if PROP is a display property value whose text should be
4324 treated as intangible. */
4327 display_prop_intangible_p (Lisp_Object prop
)
4330 && CONSP (XCAR (prop
))
4331 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4333 /* A list of sub-properties. */
4334 while (CONSP (prop
))
4336 if (single_display_spec_intangible_p (XCAR (prop
)))
4341 else if (VECTORP (prop
))
4343 /* A vector of sub-properties. */
4345 for (i
= 0; i
< ASIZE (prop
); ++i
)
4346 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4350 return single_display_spec_intangible_p (prop
);
4356 /* Return 1 if PROP is a display sub-property value containing STRING. */
4359 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4361 if (EQ (string
, prop
))
4364 /* Skip over `when FORM'. */
4365 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4374 /* Skip over `margin LOCATION'. */
4375 if (EQ (XCAR (prop
), Qmargin
))
4386 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4390 /* Return 1 if STRING appears in the `display' property PROP. */
4393 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4396 && CONSP (XCAR (prop
))
4397 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4399 /* A list of sub-properties. */
4400 while (CONSP (prop
))
4402 if (single_display_spec_string_p (XCAR (prop
), string
))
4407 else if (VECTORP (prop
))
4409 /* A vector of sub-properties. */
4411 for (i
= 0; i
< ASIZE (prop
); ++i
)
4412 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4416 return single_display_spec_string_p (prop
, string
);
4421 /* Look for STRING in overlays and text properties in the current
4422 buffer, between character positions FROM and TO (excluding TO).
4423 BACK_P non-zero means look back (in this case, TO is supposed to be
4425 Value is the first character position where STRING was found, or
4426 zero if it wasn't found before hitting TO.
4428 This function may only use code that doesn't eval because it is
4429 called asynchronously from note_mouse_highlight. */
4432 string_buffer_position_lim (Lisp_Object string
,
4433 EMACS_INT from
, EMACS_INT to
, int back_p
)
4435 Lisp_Object limit
, prop
, pos
;
4438 pos
= make_number (from
);
4440 if (!back_p
) /* looking forward */
4442 limit
= make_number (min (to
, ZV
));
4443 while (!found
&& !EQ (pos
, limit
))
4445 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4446 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4449 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4453 else /* looking back */
4455 limit
= make_number (max (to
, BEGV
));
4456 while (!found
&& !EQ (pos
, limit
))
4458 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4459 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4462 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4467 return found
? XINT (pos
) : 0;
4470 /* Determine which buffer position in current buffer STRING comes from.
4471 AROUND_CHARPOS is an approximate position where it could come from.
4472 Value is the buffer position or 0 if it couldn't be determined.
4474 This function is necessary because we don't record buffer positions
4475 in glyphs generated from strings (to keep struct glyph small).
4476 This function may only use code that doesn't eval because it is
4477 called asynchronously from note_mouse_highlight. */
4480 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4482 const int MAX_DISTANCE
= 1000;
4483 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4484 around_charpos
+ MAX_DISTANCE
,
4488 found
= string_buffer_position_lim (string
, around_charpos
,
4489 around_charpos
- MAX_DISTANCE
, 1);
4495 /***********************************************************************
4496 `composition' property
4497 ***********************************************************************/
4499 /* Set up iterator IT from `composition' property at its current
4500 position. Called from handle_stop. */
4502 static enum prop_handled
4503 handle_composition_prop (struct it
*it
)
4505 Lisp_Object prop
, string
;
4506 EMACS_INT pos
, pos_byte
, start
, end
;
4508 if (STRINGP (it
->string
))
4512 pos
= IT_STRING_CHARPOS (*it
);
4513 pos_byte
= IT_STRING_BYTEPOS (*it
);
4514 string
= it
->string
;
4515 s
= SDATA (string
) + pos_byte
;
4516 it
->c
= STRING_CHAR (s
);
4520 pos
= IT_CHARPOS (*it
);
4521 pos_byte
= IT_BYTEPOS (*it
);
4523 it
->c
= FETCH_CHAR (pos_byte
);
4526 /* If there's a valid composition and point is not inside of the
4527 composition (in the case that the composition is from the current
4528 buffer), draw a glyph composed from the composition components. */
4529 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4530 && COMPOSITION_VALID_P (start
, end
, prop
)
4531 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4535 if (STRINGP (it
->string
))
4536 pos_byte
= string_char_to_byte (it
->string
, start
);
4538 pos_byte
= CHAR_TO_BYTE (start
);
4540 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4543 if (it
->cmp_it
.id
>= 0)
4546 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4547 it
->cmp_it
.nglyphs
= -1;
4551 return HANDLED_NORMALLY
;
4556 /***********************************************************************
4558 ***********************************************************************/
4560 /* The following structure is used to record overlay strings for
4561 later sorting in load_overlay_strings. */
4563 struct overlay_entry
4565 Lisp_Object overlay
;
4572 /* Set up iterator IT from overlay strings at its current position.
4573 Called from handle_stop. */
4575 static enum prop_handled
4576 handle_overlay_change (struct it
*it
)
4578 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4579 return HANDLED_RECOMPUTE_PROPS
;
4581 return HANDLED_NORMALLY
;
4585 /* Set up the next overlay string for delivery by IT, if there is an
4586 overlay string to deliver. Called by set_iterator_to_next when the
4587 end of the current overlay string is reached. If there are more
4588 overlay strings to display, IT->string and
4589 IT->current.overlay_string_index are set appropriately here.
4590 Otherwise IT->string is set to nil. */
4593 next_overlay_string (struct it
*it
)
4595 ++it
->current
.overlay_string_index
;
4596 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4598 /* No more overlay strings. Restore IT's settings to what
4599 they were before overlay strings were processed, and
4600 continue to deliver from current_buffer. */
4602 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4605 || (NILP (it
->string
)
4606 && it
->method
== GET_FROM_BUFFER
4607 && it
->stop_charpos
>= BEGV
4608 && it
->stop_charpos
<= it
->end_charpos
));
4609 it
->current
.overlay_string_index
= -1;
4610 it
->n_overlay_strings
= 0;
4611 it
->overlay_strings_charpos
= -1;
4613 /* If we're at the end of the buffer, record that we have
4614 processed the overlay strings there already, so that
4615 next_element_from_buffer doesn't try it again. */
4616 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4617 it
->overlay_strings_at_end_processed_p
= 1;
4621 /* There are more overlay strings to process. If
4622 IT->current.overlay_string_index has advanced to a position
4623 where we must load IT->overlay_strings with more strings, do
4624 it. We must load at the IT->overlay_strings_charpos where
4625 IT->n_overlay_strings was originally computed; when invisible
4626 text is present, this might not be IT_CHARPOS (Bug#7016). */
4627 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4629 if (it
->current
.overlay_string_index
&& i
== 0)
4630 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4632 /* Initialize IT to deliver display elements from the overlay
4634 it
->string
= it
->overlay_strings
[i
];
4635 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4636 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4637 it
->method
= GET_FROM_STRING
;
4638 it
->stop_charpos
= 0;
4639 if (it
->cmp_it
.stop_pos
>= 0)
4640 it
->cmp_it
.stop_pos
= 0;
4647 /* Compare two overlay_entry structures E1 and E2. Used as a
4648 comparison function for qsort in load_overlay_strings. Overlay
4649 strings for the same position are sorted so that
4651 1. All after-strings come in front of before-strings, except
4652 when they come from the same overlay.
4654 2. Within after-strings, strings are sorted so that overlay strings
4655 from overlays with higher priorities come first.
4657 2. Within before-strings, strings are sorted so that overlay
4658 strings from overlays with higher priorities come last.
4660 Value is analogous to strcmp. */
4664 compare_overlay_entries (const void *e1
, const void *e2
)
4666 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4667 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4670 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4672 /* Let after-strings appear in front of before-strings if
4673 they come from different overlays. */
4674 if (EQ (entry1
->overlay
, entry2
->overlay
))
4675 result
= entry1
->after_string_p
? 1 : -1;
4677 result
= entry1
->after_string_p
? -1 : 1;
4679 else if (entry1
->after_string_p
)
4680 /* After-strings sorted in order of decreasing priority. */
4681 result
= entry2
->priority
- entry1
->priority
;
4683 /* Before-strings sorted in order of increasing priority. */
4684 result
= entry1
->priority
- entry2
->priority
;
4690 /* Load the vector IT->overlay_strings with overlay strings from IT's
4691 current buffer position, or from CHARPOS if that is > 0. Set
4692 IT->n_overlays to the total number of overlay strings found.
4694 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4695 a time. On entry into load_overlay_strings,
4696 IT->current.overlay_string_index gives the number of overlay
4697 strings that have already been loaded by previous calls to this
4700 IT->add_overlay_start contains an additional overlay start
4701 position to consider for taking overlay strings from, if non-zero.
4702 This position comes into play when the overlay has an `invisible'
4703 property, and both before and after-strings. When we've skipped to
4704 the end of the overlay, because of its `invisible' property, we
4705 nevertheless want its before-string to appear.
4706 IT->add_overlay_start will contain the overlay start position
4709 Overlay strings are sorted so that after-string strings come in
4710 front of before-string strings. Within before and after-strings,
4711 strings are sorted by overlay priority. See also function
4712 compare_overlay_entries. */
4715 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4717 Lisp_Object overlay
, window
, str
, invisible
;
4718 struct Lisp_Overlay
*ov
;
4719 EMACS_INT start
, end
;
4721 int n
= 0, i
, j
, invis_p
;
4722 struct overlay_entry
*entries
4723 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4726 charpos
= IT_CHARPOS (*it
);
4728 /* Append the overlay string STRING of overlay OVERLAY to vector
4729 `entries' which has size `size' and currently contains `n'
4730 elements. AFTER_P non-zero means STRING is an after-string of
4732 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4735 Lisp_Object priority; \
4739 int new_size = 2 * size; \
4740 struct overlay_entry *old = entries; \
4742 (struct overlay_entry *) alloca (new_size \
4743 * sizeof *entries); \
4744 memcpy (entries, old, size * sizeof *entries); \
4748 entries[n].string = (STRING); \
4749 entries[n].overlay = (OVERLAY); \
4750 priority = Foverlay_get ((OVERLAY), Qpriority); \
4751 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4752 entries[n].after_string_p = (AFTER_P); \
4757 /* Process overlay before the overlay center. */
4758 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4760 XSETMISC (overlay
, ov
);
4761 xassert (OVERLAYP (overlay
));
4762 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4763 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4768 /* Skip this overlay if it doesn't start or end at IT's current
4770 if (end
!= charpos
&& start
!= charpos
)
4773 /* Skip this overlay if it doesn't apply to IT->w. */
4774 window
= Foverlay_get (overlay
, Qwindow
);
4775 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4778 /* If the text ``under'' the overlay is invisible, both before-
4779 and after-strings from this overlay are visible; start and
4780 end position are indistinguishable. */
4781 invisible
= Foverlay_get (overlay
, Qinvisible
);
4782 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4784 /* If overlay has a non-empty before-string, record it. */
4785 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4786 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4788 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4790 /* If overlay has a non-empty after-string, record it. */
4791 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4792 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4794 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4797 /* Process overlays after the overlay center. */
4798 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4800 XSETMISC (overlay
, ov
);
4801 xassert (OVERLAYP (overlay
));
4802 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4803 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4805 if (start
> charpos
)
4808 /* Skip this overlay if it doesn't start or end at IT's current
4810 if (end
!= charpos
&& start
!= charpos
)
4813 /* Skip this overlay if it doesn't apply to IT->w. */
4814 window
= Foverlay_get (overlay
, Qwindow
);
4815 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4818 /* If the text ``under'' the overlay is invisible, it has a zero
4819 dimension, and both before- and after-strings apply. */
4820 invisible
= Foverlay_get (overlay
, Qinvisible
);
4821 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4823 /* If overlay has a non-empty before-string, record it. */
4824 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4825 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4827 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4829 /* If overlay has a non-empty after-string, record it. */
4830 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4831 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4833 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4836 #undef RECORD_OVERLAY_STRING
4840 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4842 /* Record number of overlay strings, and where we computed it. */
4843 it
->n_overlay_strings
= n
;
4844 it
->overlay_strings_charpos
= charpos
;
4846 /* IT->current.overlay_string_index is the number of overlay strings
4847 that have already been consumed by IT. Copy some of the
4848 remaining overlay strings to IT->overlay_strings. */
4850 j
= it
->current
.overlay_string_index
;
4851 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4853 it
->overlay_strings
[i
] = entries
[j
].string
;
4854 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4861 /* Get the first chunk of overlay strings at IT's current buffer
4862 position, or at CHARPOS if that is > 0. Value is non-zero if at
4863 least one overlay string was found. */
4866 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4868 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4869 process. This fills IT->overlay_strings with strings, and sets
4870 IT->n_overlay_strings to the total number of strings to process.
4871 IT->pos.overlay_string_index has to be set temporarily to zero
4872 because load_overlay_strings needs this; it must be set to -1
4873 when no overlay strings are found because a zero value would
4874 indicate a position in the first overlay string. */
4875 it
->current
.overlay_string_index
= 0;
4876 load_overlay_strings (it
, charpos
);
4878 /* If we found overlay strings, set up IT to deliver display
4879 elements from the first one. Otherwise set up IT to deliver
4880 from current_buffer. */
4881 if (it
->n_overlay_strings
)
4883 /* Make sure we know settings in current_buffer, so that we can
4884 restore meaningful values when we're done with the overlay
4887 compute_stop_pos (it
);
4888 xassert (it
->face_id
>= 0);
4890 /* Save IT's settings. They are restored after all overlay
4891 strings have been processed. */
4892 xassert (!compute_stop_p
|| it
->sp
== 0);
4894 /* When called from handle_stop, there might be an empty display
4895 string loaded. In that case, don't bother saving it. */
4896 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4899 /* Set up IT to deliver display elements from the first overlay
4901 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4902 it
->string
= it
->overlay_strings
[0];
4903 it
->from_overlay
= Qnil
;
4904 it
->stop_charpos
= 0;
4905 xassert (STRINGP (it
->string
));
4906 it
->end_charpos
= SCHARS (it
->string
);
4907 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4908 it
->method
= GET_FROM_STRING
;
4912 it
->current
.overlay_string_index
= -1;
4917 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4920 it
->method
= GET_FROM_BUFFER
;
4922 (void) get_overlay_strings_1 (it
, charpos
, 1);
4926 /* Value is non-zero if we found at least one overlay string. */
4927 return STRINGP (it
->string
);
4932 /***********************************************************************
4933 Saving and restoring state
4934 ***********************************************************************/
4936 /* Save current settings of IT on IT->stack. Called, for example,
4937 before setting up IT for an overlay string, to be able to restore
4938 IT's settings to what they were after the overlay string has been
4942 push_it (struct it
*it
)
4944 struct iterator_stack_entry
*p
;
4946 xassert (it
->sp
< IT_STACK_SIZE
);
4947 p
= it
->stack
+ it
->sp
;
4949 p
->stop_charpos
= it
->stop_charpos
;
4950 p
->prev_stop
= it
->prev_stop
;
4951 p
->base_level_stop
= it
->base_level_stop
;
4952 p
->cmp_it
= it
->cmp_it
;
4953 xassert (it
->face_id
>= 0);
4954 p
->face_id
= it
->face_id
;
4955 p
->string
= it
->string
;
4956 p
->method
= it
->method
;
4957 p
->from_overlay
= it
->from_overlay
;
4960 case GET_FROM_IMAGE
:
4961 p
->u
.image
.object
= it
->object
;
4962 p
->u
.image
.image_id
= it
->image_id
;
4963 p
->u
.image
.slice
= it
->slice
;
4965 case GET_FROM_STRETCH
:
4966 p
->u
.stretch
.object
= it
->object
;
4969 p
->position
= it
->position
;
4970 p
->current
= it
->current
;
4971 p
->end_charpos
= it
->end_charpos
;
4972 p
->string_nchars
= it
->string_nchars
;
4974 p
->multibyte_p
= it
->multibyte_p
;
4975 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4976 p
->space_width
= it
->space_width
;
4977 p
->font_height
= it
->font_height
;
4978 p
->voffset
= it
->voffset
;
4979 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4980 p
->display_ellipsis_p
= 0;
4981 p
->line_wrap
= it
->line_wrap
;
4986 iterate_out_of_display_property (struct it
*it
)
4988 /* Maybe initialize paragraph direction. If we are at the beginning
4989 of a new paragraph, next_element_from_buffer may not have a
4990 chance to do that. */
4991 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4992 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4993 /* prev_stop can be zero, so check against BEGV as well. */
4994 while (it
->bidi_it
.charpos
>= BEGV
4995 && it
->prev_stop
<= it
->bidi_it
.charpos
4996 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4997 bidi_move_to_visually_next (&it
->bidi_it
);
4998 /* Record the stop_pos we just crossed, for when we cross it
5000 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5001 it
->prev_stop
= CHARPOS (it
->position
);
5002 /* If we ended up not where pop_it put us, resync IT's
5003 positional members with the bidi iterator. */
5004 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5006 SET_TEXT_POS (it
->position
,
5007 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5008 it
->current
.pos
= it
->position
;
5012 /* Restore IT's settings from IT->stack. Called, for example, when no
5013 more overlay strings must be processed, and we return to delivering
5014 display elements from a buffer, or when the end of a string from a
5015 `display' property is reached and we return to delivering display
5016 elements from an overlay string, or from a buffer. */
5019 pop_it (struct it
*it
)
5021 struct iterator_stack_entry
*p
;
5023 xassert (it
->sp
> 0);
5025 p
= it
->stack
+ it
->sp
;
5026 it
->stop_charpos
= p
->stop_charpos
;
5027 it
->prev_stop
= p
->prev_stop
;
5028 it
->base_level_stop
= p
->base_level_stop
;
5029 it
->cmp_it
= p
->cmp_it
;
5030 it
->face_id
= p
->face_id
;
5031 it
->current
= p
->current
;
5032 it
->position
= p
->position
;
5033 it
->string
= p
->string
;
5034 it
->from_overlay
= p
->from_overlay
;
5035 if (NILP (it
->string
))
5036 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5037 it
->method
= p
->method
;
5040 case GET_FROM_IMAGE
:
5041 it
->image_id
= p
->u
.image
.image_id
;
5042 it
->object
= p
->u
.image
.object
;
5043 it
->slice
= p
->u
.image
.slice
;
5045 case GET_FROM_STRETCH
:
5046 it
->object
= p
->u
.comp
.object
;
5048 case GET_FROM_BUFFER
:
5049 it
->object
= it
->w
->buffer
;
5052 /* Bidi-iterate until we get out of the portion of text, if
5053 any, covered by a `display' text property or an overlay
5054 with `display' property. (We cannot just jump there,
5055 because the internal coherency of the bidi iterator state
5056 can not be preserved across such jumps.) We also must
5057 determine the paragraph base direction if the overlay we
5058 just processed is at the beginning of a new
5060 iterate_out_of_display_property (it
);
5063 case GET_FROM_STRING
:
5064 it
->object
= it
->string
;
5066 case GET_FROM_DISPLAY_VECTOR
:
5068 it
->method
= GET_FROM_C_STRING
;
5069 else if (STRINGP (it
->string
))
5070 it
->method
= GET_FROM_STRING
;
5073 it
->method
= GET_FROM_BUFFER
;
5074 it
->object
= it
->w
->buffer
;
5077 it
->end_charpos
= p
->end_charpos
;
5078 it
->string_nchars
= p
->string_nchars
;
5080 it
->multibyte_p
= p
->multibyte_p
;
5081 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5082 it
->space_width
= p
->space_width
;
5083 it
->font_height
= p
->font_height
;
5084 it
->voffset
= p
->voffset
;
5085 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5086 it
->line_wrap
= p
->line_wrap
;
5091 /***********************************************************************
5093 ***********************************************************************/
5095 /* Set IT's current position to the previous line start. */
5098 back_to_previous_line_start (struct it
*it
)
5100 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5101 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5105 /* Move IT to the next line start.
5107 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5108 we skipped over part of the text (as opposed to moving the iterator
5109 continuously over the text). Otherwise, don't change the value
5112 Newlines may come from buffer text, overlay strings, or strings
5113 displayed via the `display' property. That's the reason we can't
5114 simply use find_next_newline_no_quit.
5116 Note that this function may not skip over invisible text that is so
5117 because of text properties and immediately follows a newline. If
5118 it would, function reseat_at_next_visible_line_start, when called
5119 from set_iterator_to_next, would effectively make invisible
5120 characters following a newline part of the wrong glyph row, which
5121 leads to wrong cursor motion. */
5124 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5126 int old_selective
, newline_found_p
, n
;
5127 const int MAX_NEWLINE_DISTANCE
= 500;
5129 /* If already on a newline, just consume it to avoid unintended
5130 skipping over invisible text below. */
5131 if (it
->what
== IT_CHARACTER
5133 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5135 set_iterator_to_next (it
, 0);
5140 /* Don't handle selective display in the following. It's (a)
5141 unnecessary because it's done by the caller, and (b) leads to an
5142 infinite recursion because next_element_from_ellipsis indirectly
5143 calls this function. */
5144 old_selective
= it
->selective
;
5147 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5148 from buffer text. */
5149 for (n
= newline_found_p
= 0;
5150 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5151 n
+= STRINGP (it
->string
) ? 0 : 1)
5153 if (!get_next_display_element (it
))
5155 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5156 set_iterator_to_next (it
, 0);
5159 /* If we didn't find a newline near enough, see if we can use a
5161 if (!newline_found_p
)
5163 EMACS_INT start
= IT_CHARPOS (*it
);
5164 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5167 xassert (!STRINGP (it
->string
));
5169 /* If there isn't any `display' property in sight, and no
5170 overlays, we can just use the position of the newline in
5172 if (it
->stop_charpos
>= limit
5173 || ((pos
= Fnext_single_property_change (make_number (start
),
5175 Qnil
, make_number (limit
)),
5177 && next_overlay_change (start
) == ZV
))
5179 IT_CHARPOS (*it
) = limit
;
5180 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5181 *skipped_p
= newline_found_p
= 1;
5185 while (get_next_display_element (it
)
5186 && !newline_found_p
)
5188 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5189 set_iterator_to_next (it
, 0);
5194 it
->selective
= old_selective
;
5195 return newline_found_p
;
5199 /* Set IT's current position to the previous visible line start. Skip
5200 invisible text that is so either due to text properties or due to
5201 selective display. Caution: this does not change IT->current_x and
5205 back_to_previous_visible_line_start (struct it
*it
)
5207 while (IT_CHARPOS (*it
) > BEGV
)
5209 back_to_previous_line_start (it
);
5211 if (IT_CHARPOS (*it
) <= BEGV
)
5214 /* If selective > 0, then lines indented more than its value are
5216 if (it
->selective
> 0
5217 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5218 (double) it
->selective
)) /* iftc */
5221 /* Check the newline before point for invisibility. */
5224 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5225 Qinvisible
, it
->window
);
5226 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5230 if (IT_CHARPOS (*it
) <= BEGV
)
5237 Lisp_Object val
, overlay
;
5239 /* If newline is part of a composition, continue from start of composition */
5240 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5241 && beg
< IT_CHARPOS (*it
))
5244 /* If newline is replaced by a display property, find start of overlay
5245 or interval and continue search from that point. */
5247 pos
= --IT_CHARPOS (it2
);
5250 it2
.string_from_display_prop_p
= 0;
5251 if (handle_display_prop (&it2
) == HANDLED_RETURN
5252 && !NILP (val
= get_char_property_and_overlay
5253 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5254 && (OVERLAYP (overlay
)
5255 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5256 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5259 /* Newline is not replaced by anything -- so we are done. */
5265 IT_CHARPOS (*it
) = beg
;
5266 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5270 it
->continuation_lines_width
= 0;
5272 xassert (IT_CHARPOS (*it
) >= BEGV
);
5273 xassert (IT_CHARPOS (*it
) == BEGV
5274 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5279 /* Reseat iterator IT at the previous visible line start. Skip
5280 invisible text that is so either due to text properties or due to
5281 selective display. At the end, update IT's overlay information,
5282 face information etc. */
5285 reseat_at_previous_visible_line_start (struct it
*it
)
5287 back_to_previous_visible_line_start (it
);
5288 reseat (it
, it
->current
.pos
, 1);
5293 /* Reseat iterator IT on the next visible line start in the current
5294 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5295 preceding the line start. Skip over invisible text that is so
5296 because of selective display. Compute faces, overlays etc at the
5297 new position. Note that this function does not skip over text that
5298 is invisible because of text properties. */
5301 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5303 int newline_found_p
, skipped_p
= 0;
5305 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5307 /* Skip over lines that are invisible because they are indented
5308 more than the value of IT->selective. */
5309 if (it
->selective
> 0)
5310 while (IT_CHARPOS (*it
) < ZV
5311 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5312 (double) it
->selective
)) /* iftc */
5314 xassert (IT_BYTEPOS (*it
) == BEGV
5315 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5316 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5319 /* Position on the newline if that's what's requested. */
5320 if (on_newline_p
&& newline_found_p
)
5322 if (STRINGP (it
->string
))
5324 if (IT_STRING_CHARPOS (*it
) > 0)
5326 --IT_STRING_CHARPOS (*it
);
5327 --IT_STRING_BYTEPOS (*it
);
5330 else if (IT_CHARPOS (*it
) > BEGV
)
5334 reseat (it
, it
->current
.pos
, 0);
5338 reseat (it
, it
->current
.pos
, 0);
5345 /***********************************************************************
5346 Changing an iterator's position
5347 ***********************************************************************/
5349 /* Change IT's current position to POS in current_buffer. If FORCE_P
5350 is non-zero, always check for text properties at the new position.
5351 Otherwise, text properties are only looked up if POS >=
5352 IT->check_charpos of a property. */
5355 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5357 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5359 reseat_1 (it
, pos
, 0);
5361 /* Determine where to check text properties. Avoid doing it
5362 where possible because text property lookup is very expensive. */
5364 || CHARPOS (pos
) > it
->stop_charpos
5365 || CHARPOS (pos
) < original_pos
)
5369 /* For bidi iteration, we need to prime prev_stop and
5370 base_level_stop with our best estimations. */
5371 if (CHARPOS (pos
) < it
->prev_stop
)
5373 handle_stop_backwards (it
, BEGV
);
5374 if (CHARPOS (pos
) < it
->base_level_stop
)
5375 it
->base_level_stop
= 0;
5377 else if (CHARPOS (pos
) > it
->stop_charpos
5378 && it
->stop_charpos
>= BEGV
)
5379 handle_stop_backwards (it
, it
->stop_charpos
);
5386 it
->prev_stop
= it
->base_level_stop
= 0;
5395 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5396 IT->stop_pos to POS, also. */
5399 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5401 /* Don't call this function when scanning a C string. */
5402 xassert (it
->s
== NULL
);
5404 /* POS must be a reasonable value. */
5405 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5407 it
->current
.pos
= it
->position
= pos
;
5408 it
->end_charpos
= ZV
;
5410 it
->current
.dpvec_index
= -1;
5411 it
->current
.overlay_string_index
= -1;
5412 IT_STRING_CHARPOS (*it
) = -1;
5413 IT_STRING_BYTEPOS (*it
) = -1;
5415 it
->string_from_display_prop_p
= 0;
5416 it
->method
= GET_FROM_BUFFER
;
5417 it
->object
= it
->w
->buffer
;
5418 it
->area
= TEXT_AREA
;
5419 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5421 it
->string_from_display_prop_p
= 0;
5422 it
->face_before_selective_p
= 0;
5425 it
->bidi_it
.first_elt
= 1;
5426 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5431 it
->stop_charpos
= CHARPOS (pos
);
5432 it
->base_level_stop
= CHARPOS (pos
);
5437 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5438 If S is non-null, it is a C string to iterate over. Otherwise,
5439 STRING gives a Lisp string to iterate over.
5441 If PRECISION > 0, don't return more then PRECISION number of
5442 characters from the string.
5444 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5445 characters have been returned. FIELD_WIDTH < 0 means an infinite
5448 MULTIBYTE = 0 means disable processing of multibyte characters,
5449 MULTIBYTE > 0 means enable it,
5450 MULTIBYTE < 0 means use IT->multibyte_p.
5452 IT must be initialized via a prior call to init_iterator before
5453 calling this function. */
5456 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5457 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5460 /* No region in strings. */
5461 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5463 /* No text property checks performed by default, but see below. */
5464 it
->stop_charpos
= -1;
5466 /* Set iterator position and end position. */
5467 memset (&it
->current
, 0, sizeof it
->current
);
5468 it
->current
.overlay_string_index
= -1;
5469 it
->current
.dpvec_index
= -1;
5470 xassert (charpos
>= 0);
5472 /* If STRING is specified, use its multibyteness, otherwise use the
5473 setting of MULTIBYTE, if specified. */
5475 it
->multibyte_p
= multibyte
> 0;
5479 xassert (STRINGP (string
));
5480 it
->string
= string
;
5482 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5483 it
->method
= GET_FROM_STRING
;
5484 it
->current
.string_pos
= string_pos (charpos
, string
);
5488 it
->s
= (const unsigned char *) s
;
5491 /* Note that we use IT->current.pos, not it->current.string_pos,
5492 for displaying C strings. */
5493 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5494 if (it
->multibyte_p
)
5496 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5497 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5501 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5502 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5505 it
->method
= GET_FROM_C_STRING
;
5508 /* PRECISION > 0 means don't return more than PRECISION characters
5510 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5511 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5513 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5514 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5515 FIELD_WIDTH < 0 means infinite field width. This is useful for
5516 padding with `-' at the end of a mode line. */
5517 if (field_width
< 0)
5518 field_width
= INFINITY
;
5519 if (field_width
> it
->end_charpos
- charpos
)
5520 it
->end_charpos
= charpos
+ field_width
;
5522 /* Use the standard display table for displaying strings. */
5523 if (DISP_TABLE_P (Vstandard_display_table
))
5524 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5526 it
->stop_charpos
= charpos
;
5527 if (s
== NULL
&& it
->multibyte_p
)
5529 EMACS_INT endpos
= SCHARS (it
->string
);
5530 if (endpos
> it
->end_charpos
)
5531 endpos
= it
->end_charpos
;
5532 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5540 /***********************************************************************
5542 ***********************************************************************/
5544 /* Map enum it_method value to corresponding next_element_from_* function. */
5546 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5548 next_element_from_buffer
,
5549 next_element_from_display_vector
,
5550 next_element_from_string
,
5551 next_element_from_c_string
,
5552 next_element_from_image
,
5553 next_element_from_stretch
5556 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5559 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5560 (possibly with the following characters). */
5562 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5563 ((IT)->cmp_it.id >= 0 \
5564 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5565 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5566 END_CHARPOS, (IT)->w, \
5567 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5571 /* Lookup the char-table Vglyphless_char_display for character C (-1
5572 if we want information for no-font case), and return the display
5573 method symbol. By side-effect, update it->what and
5574 it->glyphless_method. This function is called from
5575 get_next_display_element for each character element, and from
5576 x_produce_glyphs when no suitable font was found. */
5579 lookup_glyphless_char_display (int c
, struct it
*it
)
5581 Lisp_Object glyphless_method
= Qnil
;
5583 if (CHAR_TABLE_P (Vglyphless_char_display
)
5584 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5585 glyphless_method
= (c
>= 0
5586 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5587 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5589 if (NILP (glyphless_method
))
5592 /* The default is to display the character by a proper font. */
5594 /* The default for the no-font case is to display an empty box. */
5595 glyphless_method
= Qempty_box
;
5597 if (EQ (glyphless_method
, Qzero_width
))
5600 return glyphless_method
;
5601 /* This method can't be used for the no-font case. */
5602 glyphless_method
= Qempty_box
;
5604 if (EQ (glyphless_method
, Qthin_space
))
5605 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5606 else if (EQ (glyphless_method
, Qempty_box
))
5607 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5608 else if (EQ (glyphless_method
, Qhex_code
))
5609 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5610 else if (STRINGP (glyphless_method
))
5611 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5614 /* Invalid value. We use the default method. */
5615 glyphless_method
= Qnil
;
5618 it
->what
= IT_GLYPHLESS
;
5619 return glyphless_method
;
5622 /* Load IT's display element fields with information about the next
5623 display element from the current position of IT. Value is zero if
5624 end of buffer (or C string) is reached. */
5626 static struct frame
*last_escape_glyph_frame
= NULL
;
5627 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5628 static int last_escape_glyph_merged_face_id
= 0;
5630 struct frame
*last_glyphless_glyph_frame
= NULL
;
5631 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5632 int last_glyphless_glyph_merged_face_id
= 0;
5635 get_next_display_element (struct it
*it
)
5637 /* Non-zero means that we found a display element. Zero means that
5638 we hit the end of what we iterate over. Performance note: the
5639 function pointer `method' used here turns out to be faster than
5640 using a sequence of if-statements. */
5644 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5646 if (it
->what
== IT_CHARACTER
)
5648 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5649 and only if (a) the resolved directionality of that character
5651 /* FIXME: Do we need an exception for characters from display
5653 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5654 it
->c
= bidi_mirror_char (it
->c
);
5655 /* Map via display table or translate control characters.
5656 IT->c, IT->len etc. have been set to the next character by
5657 the function call above. If we have a display table, and it
5658 contains an entry for IT->c, translate it. Don't do this if
5659 IT->c itself comes from a display table, otherwise we could
5660 end up in an infinite recursion. (An alternative could be to
5661 count the recursion depth of this function and signal an
5662 error when a certain maximum depth is reached.) Is it worth
5664 if (success_p
&& it
->dpvec
== NULL
)
5667 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5668 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5669 nbsp_or_shy
= char_is_other
;
5670 int c
= it
->c
; /* This is the character to display. */
5672 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5674 xassert (SINGLE_BYTE_CHAR_P (c
));
5675 if (unibyte_display_via_language_environment
)
5677 c
= DECODE_CHAR (unibyte
, c
);
5679 c
= BYTE8_TO_CHAR (it
->c
);
5682 c
= BYTE8_TO_CHAR (it
->c
);
5686 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5689 struct Lisp_Vector
*v
= XVECTOR (dv
);
5691 /* Return the first character from the display table
5692 entry, if not empty. If empty, don't display the
5693 current character. */
5696 it
->dpvec_char_len
= it
->len
;
5697 it
->dpvec
= v
->contents
;
5698 it
->dpend
= v
->contents
+ v
->size
;
5699 it
->current
.dpvec_index
= 0;
5700 it
->dpvec_face_id
= -1;
5701 it
->saved_face_id
= it
->face_id
;
5702 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5707 set_iterator_to_next (it
, 0);
5712 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5714 if (it
->what
== IT_GLYPHLESS
)
5716 /* Don't display this character. */
5717 set_iterator_to_next (it
, 0);
5721 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5722 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5723 : c
== 0xAD ? char_is_soft_hyphen
5726 /* Translate control characters into `\003' or `^C' form.
5727 Control characters coming from a display table entry are
5728 currently not translated because we use IT->dpvec to hold
5729 the translation. This could easily be changed but I
5730 don't believe that it is worth doing.
5732 NBSP and SOFT-HYPEN are property translated too.
5734 Non-printable characters and raw-byte characters are also
5735 translated to octal form. */
5736 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5737 ? (it
->area
!= TEXT_AREA
5738 /* In mode line, treat \n, \t like other crl chars. */
5741 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5742 || (c
!= '\n' && c
!= '\t'))
5745 || ! CHAR_PRINTABLE_P (c
))))
5747 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5748 or a non-printable character which must be displayed
5749 either as '\003' or as `^C' where the '\\' and '^'
5750 can be defined in the display table. Fill
5751 IT->ctl_chars with glyphs for what we have to
5752 display. Then, set IT->dpvec to these glyphs. */
5755 int face_id
, lface_id
= 0 ;
5758 /* Handle control characters with ^. */
5760 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5764 g
= '^'; /* default glyph for Control */
5765 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5767 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5768 && GLYPH_CODE_CHAR_VALID_P (gc
))
5770 g
= GLYPH_CODE_CHAR (gc
);
5771 lface_id
= GLYPH_CODE_FACE (gc
);
5775 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5777 else if (it
->f
== last_escape_glyph_frame
5778 && it
->face_id
== last_escape_glyph_face_id
)
5780 face_id
= last_escape_glyph_merged_face_id
;
5784 /* Merge the escape-glyph face into the current face. */
5785 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5787 last_escape_glyph_frame
= it
->f
;
5788 last_escape_glyph_face_id
= it
->face_id
;
5789 last_escape_glyph_merged_face_id
= face_id
;
5792 XSETINT (it
->ctl_chars
[0], g
);
5793 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5795 goto display_control
;
5798 /* Handle non-break space in the mode where it only gets
5801 if (EQ (Vnobreak_char_display
, Qt
)
5802 && nbsp_or_shy
== char_is_nbsp
)
5804 /* Merge the no-break-space face into the current face. */
5805 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5809 XSETINT (it
->ctl_chars
[0], ' ');
5811 goto display_control
;
5814 /* Handle sequences that start with the "escape glyph". */
5816 /* the default escape glyph is \. */
5817 escape_glyph
= '\\';
5820 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5821 && GLYPH_CODE_CHAR_VALID_P (gc
))
5823 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5824 lface_id
= GLYPH_CODE_FACE (gc
);
5828 /* The display table specified a face.
5829 Merge it into face_id and also into escape_glyph. */
5830 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5833 else if (it
->f
== last_escape_glyph_frame
5834 && it
->face_id
== last_escape_glyph_face_id
)
5836 face_id
= last_escape_glyph_merged_face_id
;
5840 /* Merge the escape-glyph face into the current face. */
5841 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5843 last_escape_glyph_frame
= it
->f
;
5844 last_escape_glyph_face_id
= it
->face_id
;
5845 last_escape_glyph_merged_face_id
= face_id
;
5848 /* Handle soft hyphens in the mode where they only get
5851 if (EQ (Vnobreak_char_display
, Qt
)
5852 && nbsp_or_shy
== char_is_soft_hyphen
)
5854 XSETINT (it
->ctl_chars
[0], '-');
5856 goto display_control
;
5859 /* Handle non-break space and soft hyphen
5860 with the escape glyph. */
5864 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5865 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5866 XSETINT (it
->ctl_chars
[1], c
);
5868 goto display_control
;
5875 if (CHAR_BYTE8_P (c
))
5876 /* Display \200 instead of \17777600. */
5877 c
= CHAR_TO_BYTE8 (c
);
5878 len
= sprintf (str
, "%03o", c
);
5880 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5881 for (i
= 0; i
< len
; i
++)
5882 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5887 /* Set up IT->dpvec and return first character from it. */
5888 it
->dpvec_char_len
= it
->len
;
5889 it
->dpvec
= it
->ctl_chars
;
5890 it
->dpend
= it
->dpvec
+ ctl_len
;
5891 it
->current
.dpvec_index
= 0;
5892 it
->dpvec_face_id
= face_id
;
5893 it
->saved_face_id
= it
->face_id
;
5894 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5898 it
->char_to_display
= c
;
5902 it
->char_to_display
= it
->c
;
5906 #ifdef HAVE_WINDOW_SYSTEM
5907 /* Adjust face id for a multibyte character. There are no multibyte
5908 character in unibyte text. */
5909 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5912 && FRAME_WINDOW_P (it
->f
))
5914 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5916 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5918 /* Automatic composition with glyph-string. */
5919 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5921 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5925 EMACS_INT pos
= (it
->s
? -1
5926 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5927 : IT_CHARPOS (*it
));
5929 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5936 /* Is this character the last one of a run of characters with
5937 box? If yes, set IT->end_of_box_run_p to 1. */
5941 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5943 int face_id
= underlying_face_id (it
);
5944 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5948 if (face
->box
== FACE_NO_BOX
)
5950 /* If the box comes from face properties in a
5951 display string, check faces in that string. */
5952 int string_face_id
= face_after_it_pos (it
);
5953 it
->end_of_box_run_p
5954 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5957 /* Otherwise, the box comes from the underlying face.
5958 If this is the last string character displayed, check
5959 the next buffer location. */
5960 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5961 && (it
->current
.overlay_string_index
5962 == it
->n_overlay_strings
- 1))
5966 struct text_pos pos
= it
->current
.pos
;
5967 INC_TEXT_POS (pos
, it
->multibyte_p
);
5969 next_face_id
= face_at_buffer_position
5970 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5971 it
->region_end_charpos
, &ignore
,
5972 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5974 it
->end_of_box_run_p
5975 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5982 int face_id
= face_after_it_pos (it
);
5983 it
->end_of_box_run_p
5984 = (face_id
!= it
->face_id
5985 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5989 /* Value is 0 if end of buffer or string reached. */
5994 /* Move IT to the next display element.
5996 RESEAT_P non-zero means if called on a newline in buffer text,
5997 skip to the next visible line start.
5999 Functions get_next_display_element and set_iterator_to_next are
6000 separate because I find this arrangement easier to handle than a
6001 get_next_display_element function that also increments IT's
6002 position. The way it is we can first look at an iterator's current
6003 display element, decide whether it fits on a line, and if it does,
6004 increment the iterator position. The other way around we probably
6005 would either need a flag indicating whether the iterator has to be
6006 incremented the next time, or we would have to implement a
6007 decrement position function which would not be easy to write. */
6010 set_iterator_to_next (struct it
*it
, int reseat_p
)
6012 /* Reset flags indicating start and end of a sequence of characters
6013 with box. Reset them at the start of this function because
6014 moving the iterator to a new position might set them. */
6015 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6019 case GET_FROM_BUFFER
:
6020 /* The current display element of IT is a character from
6021 current_buffer. Advance in the buffer, and maybe skip over
6022 invisible lines that are so because of selective display. */
6023 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6024 reseat_at_next_visible_line_start (it
, 0);
6025 else if (it
->cmp_it
.id
>= 0)
6027 /* We are currently getting glyphs from a composition. */
6032 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6033 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6034 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6036 it
->cmp_it
.from
= it
->cmp_it
.to
;
6041 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6043 it
->end_charpos
, Qnil
);
6046 else if (! it
->cmp_it
.reversed_p
)
6048 /* Composition created while scanning forward. */
6049 /* Update IT's char/byte positions to point to the first
6050 character of the next grapheme cluster, or to the
6051 character visually after the current composition. */
6052 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6053 bidi_move_to_visually_next (&it
->bidi_it
);
6054 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6055 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6057 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6059 /* Proceed to the next grapheme cluster. */
6060 it
->cmp_it
.from
= it
->cmp_it
.to
;
6064 /* No more grapheme clusters in this composition.
6065 Find the next stop position. */
6066 EMACS_INT stop
= it
->end_charpos
;
6067 if (it
->bidi_it
.scan_dir
< 0)
6068 /* Now we are scanning backward and don't know
6071 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6072 IT_BYTEPOS (*it
), stop
, Qnil
);
6077 /* Composition created while scanning backward. */
6078 /* Update IT's char/byte positions to point to the last
6079 character of the previous grapheme cluster, or the
6080 character visually after the current composition. */
6081 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6082 bidi_move_to_visually_next (&it
->bidi_it
);
6083 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6084 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6085 if (it
->cmp_it
.from
> 0)
6087 /* Proceed to the previous grapheme cluster. */
6088 it
->cmp_it
.to
= it
->cmp_it
.from
;
6092 /* No more grapheme clusters in this composition.
6093 Find the next stop position. */
6094 EMACS_INT stop
= it
->end_charpos
;
6095 if (it
->bidi_it
.scan_dir
< 0)
6096 /* Now we are scanning backward and don't know
6099 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6100 IT_BYTEPOS (*it
), stop
, Qnil
);
6106 xassert (it
->len
!= 0);
6110 IT_BYTEPOS (*it
) += it
->len
;
6111 IT_CHARPOS (*it
) += 1;
6115 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6116 /* If this is a new paragraph, determine its base
6117 direction (a.k.a. its base embedding level). */
6118 if (it
->bidi_it
.new_paragraph
)
6119 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6120 bidi_move_to_visually_next (&it
->bidi_it
);
6121 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6122 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6123 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6125 /* As the scan direction was changed, we must
6126 re-compute the stop position for composition. */
6127 EMACS_INT stop
= it
->end_charpos
;
6128 if (it
->bidi_it
.scan_dir
< 0)
6130 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6131 IT_BYTEPOS (*it
), stop
, Qnil
);
6134 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6138 case GET_FROM_C_STRING
:
6139 /* Current display element of IT is from a C string. */
6140 IT_BYTEPOS (*it
) += it
->len
;
6141 IT_CHARPOS (*it
) += 1;
6144 case GET_FROM_DISPLAY_VECTOR
:
6145 /* Current display element of IT is from a display table entry.
6146 Advance in the display table definition. Reset it to null if
6147 end reached, and continue with characters from buffers/
6149 ++it
->current
.dpvec_index
;
6151 /* Restore face of the iterator to what they were before the
6152 display vector entry (these entries may contain faces). */
6153 it
->face_id
= it
->saved_face_id
;
6155 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6157 int recheck_faces
= it
->ellipsis_p
;
6160 it
->method
= GET_FROM_C_STRING
;
6161 else if (STRINGP (it
->string
))
6162 it
->method
= GET_FROM_STRING
;
6165 it
->method
= GET_FROM_BUFFER
;
6166 it
->object
= it
->w
->buffer
;
6170 it
->current
.dpvec_index
= -1;
6172 /* Skip over characters which were displayed via IT->dpvec. */
6173 if (it
->dpvec_char_len
< 0)
6174 reseat_at_next_visible_line_start (it
, 1);
6175 else if (it
->dpvec_char_len
> 0)
6177 if (it
->method
== GET_FROM_STRING
6178 && it
->n_overlay_strings
> 0)
6179 it
->ignore_overlay_strings_at_pos_p
= 1;
6180 it
->len
= it
->dpvec_char_len
;
6181 set_iterator_to_next (it
, reseat_p
);
6184 /* Maybe recheck faces after display vector */
6186 it
->stop_charpos
= IT_CHARPOS (*it
);
6190 case GET_FROM_STRING
:
6191 /* Current display element is a character from a Lisp string. */
6192 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6193 if (it
->cmp_it
.id
>= 0)
6195 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6196 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6197 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6198 it
->cmp_it
.from
= it
->cmp_it
.to
;
6202 composition_compute_stop_pos (&it
->cmp_it
,
6203 IT_STRING_CHARPOS (*it
),
6204 IT_STRING_BYTEPOS (*it
),
6205 it
->end_charpos
, it
->string
);
6210 IT_STRING_BYTEPOS (*it
) += it
->len
;
6211 IT_STRING_CHARPOS (*it
) += 1;
6214 consider_string_end
:
6216 if (it
->current
.overlay_string_index
>= 0)
6218 /* IT->string is an overlay string. Advance to the
6219 next, if there is one. */
6220 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6223 next_overlay_string (it
);
6225 setup_for_ellipsis (it
, 0);
6230 /* IT->string is not an overlay string. If we reached
6231 its end, and there is something on IT->stack, proceed
6232 with what is on the stack. This can be either another
6233 string, this time an overlay string, or a buffer. */
6234 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6238 if (it
->method
== GET_FROM_STRING
)
6239 goto consider_string_end
;
6244 case GET_FROM_IMAGE
:
6245 case GET_FROM_STRETCH
:
6246 /* The position etc with which we have to proceed are on
6247 the stack. The position may be at the end of a string,
6248 if the `display' property takes up the whole string. */
6249 xassert (it
->sp
> 0);
6251 if (it
->method
== GET_FROM_STRING
)
6252 goto consider_string_end
;
6256 /* There are no other methods defined, so this should be a bug. */
6260 xassert (it
->method
!= GET_FROM_STRING
6261 || (STRINGP (it
->string
)
6262 && IT_STRING_CHARPOS (*it
) >= 0));
6265 /* Load IT's display element fields with information about the next
6266 display element which comes from a display table entry or from the
6267 result of translating a control character to one of the forms `^C'
6270 IT->dpvec holds the glyphs to return as characters.
6271 IT->saved_face_id holds the face id before the display vector--it
6272 is restored into IT->face_id in set_iterator_to_next. */
6275 next_element_from_display_vector (struct it
*it
)
6280 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6282 it
->face_id
= it
->saved_face_id
;
6284 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6285 That seemed totally bogus - so I changed it... */
6286 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6288 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6290 it
->c
= GLYPH_CODE_CHAR (gc
);
6291 it
->len
= CHAR_BYTES (it
->c
);
6293 /* The entry may contain a face id to use. Such a face id is
6294 the id of a Lisp face, not a realized face. A face id of
6295 zero means no face is specified. */
6296 if (it
->dpvec_face_id
>= 0)
6297 it
->face_id
= it
->dpvec_face_id
;
6300 int lface_id
= GLYPH_CODE_FACE (gc
);
6302 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6307 /* Display table entry is invalid. Return a space. */
6308 it
->c
= ' ', it
->len
= 1;
6310 /* Don't change position and object of the iterator here. They are
6311 still the values of the character that had this display table
6312 entry or was translated, and that's what we want. */
6313 it
->what
= IT_CHARACTER
;
6318 /* Load IT with the next display element from Lisp string IT->string.
6319 IT->current.string_pos is the current position within the string.
6320 If IT->current.overlay_string_index >= 0, the Lisp string is an
6324 next_element_from_string (struct it
*it
)
6326 struct text_pos position
;
6328 xassert (STRINGP (it
->string
));
6329 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6330 position
= it
->current
.string_pos
;
6332 /* Time to check for invisible text? */
6333 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6334 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6338 /* Since a handler may have changed IT->method, we must
6340 return GET_NEXT_DISPLAY_ELEMENT (it
);
6343 if (it
->current
.overlay_string_index
>= 0)
6345 /* Get the next character from an overlay string. In overlay
6346 strings, There is no field width or padding with spaces to
6348 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6353 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6354 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6355 && next_element_from_composition (it
))
6359 else if (STRING_MULTIBYTE (it
->string
))
6361 const unsigned char *s
= (SDATA (it
->string
)
6362 + IT_STRING_BYTEPOS (*it
));
6363 it
->c
= string_char_and_length (s
, &it
->len
);
6367 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6373 /* Get the next character from a Lisp string that is not an
6374 overlay string. Such strings come from the mode line, for
6375 example. We may have to pad with spaces, or truncate the
6376 string. See also next_element_from_c_string. */
6377 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6382 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6384 /* Pad with spaces. */
6385 it
->c
= ' ', it
->len
= 1;
6386 CHARPOS (position
) = BYTEPOS (position
) = -1;
6388 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6389 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6390 && next_element_from_composition (it
))
6394 else if (STRING_MULTIBYTE (it
->string
))
6396 const unsigned char *s
= (SDATA (it
->string
)
6397 + IT_STRING_BYTEPOS (*it
));
6398 it
->c
= string_char_and_length (s
, &it
->len
);
6402 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6407 /* Record what we have and where it came from. */
6408 it
->what
= IT_CHARACTER
;
6409 it
->object
= it
->string
;
6410 it
->position
= position
;
6415 /* Load IT with next display element from C string IT->s.
6416 IT->string_nchars is the maximum number of characters to return
6417 from the string. IT->end_charpos may be greater than
6418 IT->string_nchars when this function is called, in which case we
6419 may have to return padding spaces. Value is zero if end of string
6420 reached, including padding spaces. */
6423 next_element_from_c_string (struct it
*it
)
6428 it
->what
= IT_CHARACTER
;
6429 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6432 /* IT's position can be greater IT->string_nchars in case a field
6433 width or precision has been specified when the iterator was
6435 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6437 /* End of the game. */
6441 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6443 /* Pad with spaces. */
6444 it
->c
= ' ', it
->len
= 1;
6445 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6447 else if (it
->multibyte_p
)
6448 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6450 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6456 /* Set up IT to return characters from an ellipsis, if appropriate.
6457 The definition of the ellipsis glyphs may come from a display table
6458 entry. This function fills IT with the first glyph from the
6459 ellipsis if an ellipsis is to be displayed. */
6462 next_element_from_ellipsis (struct it
*it
)
6464 if (it
->selective_display_ellipsis_p
)
6465 setup_for_ellipsis (it
, it
->len
);
6468 /* The face at the current position may be different from the
6469 face we find after the invisible text. Remember what it
6470 was in IT->saved_face_id, and signal that it's there by
6471 setting face_before_selective_p. */
6472 it
->saved_face_id
= it
->face_id
;
6473 it
->method
= GET_FROM_BUFFER
;
6474 it
->object
= it
->w
->buffer
;
6475 reseat_at_next_visible_line_start (it
, 1);
6476 it
->face_before_selective_p
= 1;
6479 return GET_NEXT_DISPLAY_ELEMENT (it
);
6483 /* Deliver an image display element. The iterator IT is already
6484 filled with image information (done in handle_display_prop). Value
6489 next_element_from_image (struct it
*it
)
6491 it
->what
= IT_IMAGE
;
6492 it
->ignore_overlay_strings_at_pos_p
= 0;
6497 /* Fill iterator IT with next display element from a stretch glyph
6498 property. IT->object is the value of the text property. Value is
6502 next_element_from_stretch (struct it
*it
)
6504 it
->what
= IT_STRETCH
;
6508 /* Scan forward from CHARPOS in the current buffer, until we find a
6509 stop position > current IT's position. Then handle the stop
6510 position before that. This is called when we bump into a stop
6511 position while reordering bidirectional text. CHARPOS should be
6512 the last previously processed stop_pos (or BEGV, if none were
6513 processed yet) whose position is less that IT's current
6517 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6519 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6520 struct display_pos save_current
= it
->current
;
6521 struct text_pos save_position
= it
->position
;
6522 struct text_pos pos1
;
6523 EMACS_INT next_stop
;
6525 /* Scan in strict logical order. */
6529 it
->prev_stop
= charpos
;
6530 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6531 reseat_1 (it
, pos1
, 0);
6532 compute_stop_pos (it
);
6533 /* We must advance forward, right? */
6534 if (it
->stop_charpos
<= it
->prev_stop
)
6536 charpos
= it
->stop_charpos
;
6538 while (charpos
<= where_we_are
);
6540 next_stop
= it
->stop_charpos
;
6541 it
->stop_charpos
= it
->prev_stop
;
6543 it
->current
= save_current
;
6544 it
->position
= save_position
;
6546 it
->stop_charpos
= next_stop
;
6549 /* Load IT with the next display element from current_buffer. Value
6550 is zero if end of buffer reached. IT->stop_charpos is the next
6551 position at which to stop and check for text properties or buffer
6555 next_element_from_buffer (struct it
*it
)
6559 xassert (IT_CHARPOS (*it
) >= BEGV
);
6561 /* With bidi reordering, the character to display might not be the
6562 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6563 we were reseat()ed to a new buffer position, which is potentially
6564 a different paragraph. */
6565 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6567 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6568 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6569 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6571 /* Nothing to do, but reset the FIRST_ELT flag, like
6572 bidi_paragraph_init does, because we are not going to
6574 it
->bidi_it
.first_elt
= 0;
6576 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6577 /* FIXME: Should support all Unicode line separators. */
6578 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6579 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6581 /* If we are at the beginning of a line, we can produce the
6582 next element right away. */
6583 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6584 bidi_move_to_visually_next (&it
->bidi_it
);
6588 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6590 /* We need to prime the bidi iterator starting at the line's
6591 beginning, before we will be able to produce the next
6593 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6594 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6595 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6596 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6597 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6600 /* Now return to buffer position where we were asked to
6601 get the next display element, and produce that. */
6602 bidi_move_to_visually_next (&it
->bidi_it
);
6604 while (it
->bidi_it
.bytepos
!= orig_bytepos
6605 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6608 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6609 /* Adjust IT's position information to where we ended up. */
6610 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6611 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6612 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6614 EMACS_INT stop
= it
->end_charpos
;
6615 if (it
->bidi_it
.scan_dir
< 0)
6617 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6618 IT_BYTEPOS (*it
), stop
, Qnil
);
6622 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6624 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6626 int overlay_strings_follow_p
;
6628 /* End of the game, except when overlay strings follow that
6629 haven't been returned yet. */
6630 if (it
->overlay_strings_at_end_processed_p
)
6631 overlay_strings_follow_p
= 0;
6634 it
->overlay_strings_at_end_processed_p
= 1;
6635 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6638 if (overlay_strings_follow_p
)
6639 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6643 it
->position
= it
->current
.pos
;
6647 else if (!(!it
->bidi_p
6648 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6649 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6651 /* With bidi non-linear iteration, we could find ourselves
6652 far beyond the last computed stop_charpos, with several
6653 other stop positions in between that we missed. Scan
6654 them all now, in buffer's logical order, until we find
6655 and handle the last stop_charpos that precedes our
6656 current position. */
6657 handle_stop_backwards (it
, it
->stop_charpos
);
6658 return GET_NEXT_DISPLAY_ELEMENT (it
);
6664 /* Take note of the stop position we just moved across,
6665 for when we will move back across it. */
6666 it
->prev_stop
= it
->stop_charpos
;
6667 /* If we are at base paragraph embedding level, take
6668 note of the last stop position seen at this
6670 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6671 it
->base_level_stop
= it
->stop_charpos
;
6674 return GET_NEXT_DISPLAY_ELEMENT (it
);
6678 /* We can sometimes back up for reasons that have nothing
6679 to do with bidi reordering. E.g., compositions. The
6680 code below is only needed when we are above the base
6681 embedding level, so test for that explicitly. */
6682 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6683 && IT_CHARPOS (*it
) < it
->prev_stop
)
6685 if (it
->base_level_stop
<= 0)
6686 it
->base_level_stop
= BEGV
;
6687 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6689 handle_stop_backwards (it
, it
->base_level_stop
);
6690 return GET_NEXT_DISPLAY_ELEMENT (it
);
6694 /* No face changes, overlays etc. in sight, so just return a
6695 character from current_buffer. */
6699 /* Maybe run the redisplay end trigger hook. Performance note:
6700 This doesn't seem to cost measurable time. */
6701 if (it
->redisplay_end_trigger_charpos
6703 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6704 run_redisplay_end_trigger_hook (it
);
6706 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6707 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6709 && next_element_from_composition (it
))
6714 /* Get the next character, maybe multibyte. */
6715 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6716 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6717 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6719 it
->c
= *p
, it
->len
= 1;
6721 /* Record what we have and where it came from. */
6722 it
->what
= IT_CHARACTER
;
6723 it
->object
= it
->w
->buffer
;
6724 it
->position
= it
->current
.pos
;
6726 /* Normally we return the character found above, except when we
6727 really want to return an ellipsis for selective display. */
6732 /* A value of selective > 0 means hide lines indented more
6733 than that number of columns. */
6734 if (it
->selective
> 0
6735 && IT_CHARPOS (*it
) + 1 < ZV
6736 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6737 IT_BYTEPOS (*it
) + 1,
6738 (double) it
->selective
)) /* iftc */
6740 success_p
= next_element_from_ellipsis (it
);
6741 it
->dpvec_char_len
= -1;
6744 else if (it
->c
== '\r' && it
->selective
== -1)
6746 /* A value of selective == -1 means that everything from the
6747 CR to the end of the line is invisible, with maybe an
6748 ellipsis displayed for it. */
6749 success_p
= next_element_from_ellipsis (it
);
6750 it
->dpvec_char_len
= -1;
6755 /* Value is zero if end of buffer reached. */
6756 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6761 /* Run the redisplay end trigger hook for IT. */
6764 run_redisplay_end_trigger_hook (struct it
*it
)
6766 Lisp_Object args
[3];
6768 /* IT->glyph_row should be non-null, i.e. we should be actually
6769 displaying something, or otherwise we should not run the hook. */
6770 xassert (it
->glyph_row
);
6772 /* Set up hook arguments. */
6773 args
[0] = Qredisplay_end_trigger_functions
;
6774 args
[1] = it
->window
;
6775 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6776 it
->redisplay_end_trigger_charpos
= 0;
6778 /* Since we are *trying* to run these functions, don't try to run
6779 them again, even if they get an error. */
6780 it
->w
->redisplay_end_trigger
= Qnil
;
6781 Frun_hook_with_args (3, args
);
6783 /* Notice if it changed the face of the character we are on. */
6784 handle_face_prop (it
);
6788 /* Deliver a composition display element. Unlike the other
6789 next_element_from_XXX, this function is not registered in the array
6790 get_next_element[]. It is called from next_element_from_buffer and
6791 next_element_from_string when necessary. */
6794 next_element_from_composition (struct it
*it
)
6796 it
->what
= IT_COMPOSITION
;
6797 it
->len
= it
->cmp_it
.nbytes
;
6798 if (STRINGP (it
->string
))
6802 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6803 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6806 it
->position
= it
->current
.string_pos
;
6807 it
->object
= it
->string
;
6808 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6809 IT_STRING_BYTEPOS (*it
), it
->string
);
6815 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6816 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6819 if (it
->bidi_it
.new_paragraph
)
6820 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6821 /* Resync the bidi iterator with IT's new position.
6822 FIXME: this doesn't support bidirectional text. */
6823 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6824 bidi_move_to_visually_next (&it
->bidi_it
);
6828 it
->position
= it
->current
.pos
;
6829 it
->object
= it
->w
->buffer
;
6830 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6831 IT_BYTEPOS (*it
), Qnil
);
6838 /***********************************************************************
6839 Moving an iterator without producing glyphs
6840 ***********************************************************************/
6842 /* Check if iterator is at a position corresponding to a valid buffer
6843 position after some move_it_ call. */
6845 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6846 ((it)->method == GET_FROM_STRING \
6847 ? IT_STRING_CHARPOS (*it) == 0 \
6851 /* Move iterator IT to a specified buffer or X position within one
6852 line on the display without producing glyphs.
6854 OP should be a bit mask including some or all of these bits:
6855 MOVE_TO_X: Stop upon reaching x-position TO_X.
6856 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6857 Regardless of OP's value, stop upon reaching the end of the display line.
6859 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6860 This means, in particular, that TO_X includes window's horizontal
6863 The return value has several possible values that
6864 say what condition caused the scan to stop:
6866 MOVE_POS_MATCH_OR_ZV
6867 - when TO_POS or ZV was reached.
6870 -when TO_X was reached before TO_POS or ZV were reached.
6873 - when we reached the end of the display area and the line must
6877 - when we reached the end of the display area and the line is
6881 - when we stopped at a line end, i.e. a newline or a CR and selective
6884 static enum move_it_result
6885 move_it_in_display_line_to (struct it
*it
,
6886 EMACS_INT to_charpos
, int to_x
,
6887 enum move_operation_enum op
)
6889 enum move_it_result result
= MOVE_UNDEFINED
;
6890 struct glyph_row
*saved_glyph_row
;
6891 struct it wrap_it
, atpos_it
, atx_it
;
6893 enum it_method prev_method
= it
->method
;
6894 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6896 /* Don't produce glyphs in produce_glyphs. */
6897 saved_glyph_row
= it
->glyph_row
;
6898 it
->glyph_row
= NULL
;
6900 /* Use wrap_it to save a copy of IT wherever a word wrap could
6901 occur. Use atpos_it to save a copy of IT at the desired buffer
6902 position, if found, so that we can scan ahead and check if the
6903 word later overshoots the window edge. Use atx_it similarly, for
6909 #define BUFFER_POS_REACHED_P() \
6910 ((op & MOVE_TO_POS) != 0 \
6911 && BUFFERP (it->object) \
6912 && (IT_CHARPOS (*it) == to_charpos \
6913 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6914 && (it->method == GET_FROM_BUFFER \
6915 || (it->method == GET_FROM_DISPLAY_VECTOR \
6916 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6918 /* If there's a line-/wrap-prefix, handle it. */
6919 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6920 && it
->current_y
< it
->last_visible_y
)
6921 handle_line_prefix (it
);
6923 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6924 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6928 int x
, i
, ascent
= 0, descent
= 0;
6930 /* Utility macro to reset an iterator with x, ascent, and descent. */
6931 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6932 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6933 (IT)->max_descent = descent)
6935 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6937 if ((op
& MOVE_TO_POS
) != 0
6938 && BUFFERP (it
->object
)
6939 && it
->method
== GET_FROM_BUFFER
6940 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6942 && (prev_method
== GET_FROM_IMAGE
6943 || prev_method
== GET_FROM_STRETCH
)
6944 /* Passed TO_CHARPOS from left to right. */
6945 && ((prev_pos
< to_charpos
6946 && IT_CHARPOS (*it
) > to_charpos
)
6947 /* Passed TO_CHARPOS from right to left. */
6948 || (prev_pos
> to_charpos
6949 && IT_CHARPOS (*it
) < to_charpos
)))))
6951 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6953 result
= MOVE_POS_MATCH_OR_ZV
;
6956 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6957 /* If wrap_it is valid, the current position might be in a
6958 word that is wrapped. So, save the iterator in
6959 atpos_it and continue to see if wrapping happens. */
6963 prev_method
= it
->method
;
6964 if (it
->method
== GET_FROM_BUFFER
)
6965 prev_pos
= IT_CHARPOS (*it
);
6966 /* Stop when ZV reached.
6967 We used to stop here when TO_CHARPOS reached as well, but that is
6968 too soon if this glyph does not fit on this line. So we handle it
6969 explicitly below. */
6970 if (!get_next_display_element (it
))
6972 result
= MOVE_POS_MATCH_OR_ZV
;
6976 if (it
->line_wrap
== TRUNCATE
)
6978 if (BUFFER_POS_REACHED_P ())
6980 result
= MOVE_POS_MATCH_OR_ZV
;
6986 if (it
->line_wrap
== WORD_WRAP
)
6988 if (IT_DISPLAYING_WHITESPACE (it
))
6992 /* We have reached a glyph that follows one or more
6993 whitespace characters. If the position is
6994 already found, we are done. */
6995 if (atpos_it
.sp
>= 0)
6998 result
= MOVE_POS_MATCH_OR_ZV
;
7004 result
= MOVE_X_REACHED
;
7007 /* Otherwise, we can wrap here. */
7014 /* Remember the line height for the current line, in case
7015 the next element doesn't fit on the line. */
7016 ascent
= it
->max_ascent
;
7017 descent
= it
->max_descent
;
7019 /* The call to produce_glyphs will get the metrics of the
7020 display element IT is loaded with. Record the x-position
7021 before this display element, in case it doesn't fit on the
7025 PRODUCE_GLYPHS (it
);
7027 if (it
->area
!= TEXT_AREA
)
7029 set_iterator_to_next (it
, 1);
7030 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7031 SET_TEXT_POS (this_line_min_pos
,
7032 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7036 /* The number of glyphs we get back in IT->nglyphs will normally
7037 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7038 character on a terminal frame, or (iii) a line end. For the
7039 second case, IT->nglyphs - 1 padding glyphs will be present.
7040 (On X frames, there is only one glyph produced for a
7041 composite character.)
7043 The behavior implemented below means, for continuation lines,
7044 that as many spaces of a TAB as fit on the current line are
7045 displayed there. For terminal frames, as many glyphs of a
7046 multi-glyph character are displayed in the current line, too.
7047 This is what the old redisplay code did, and we keep it that
7048 way. Under X, the whole shape of a complex character must
7049 fit on the line or it will be completely displayed in the
7052 Note that both for tabs and padding glyphs, all glyphs have
7056 /* More than one glyph or glyph doesn't fit on line. All
7057 glyphs have the same width. */
7058 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7060 int x_before_this_char
= x
;
7061 int hpos_before_this_char
= it
->hpos
;
7063 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7065 new_x
= x
+ single_glyph_width
;
7067 /* We want to leave anything reaching TO_X to the caller. */
7068 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7070 if (BUFFER_POS_REACHED_P ())
7072 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7073 goto buffer_pos_reached
;
7074 if (atpos_it
.sp
< 0)
7077 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7082 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7085 result
= MOVE_X_REACHED
;
7091 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7096 if (/* Lines are continued. */
7097 it
->line_wrap
!= TRUNCATE
7098 && (/* And glyph doesn't fit on the line. */
7099 new_x
> it
->last_visible_x
7100 /* Or it fits exactly and we're on a window
7102 || (new_x
== it
->last_visible_x
7103 && FRAME_WINDOW_P (it
->f
))))
7105 if (/* IT->hpos == 0 means the very first glyph
7106 doesn't fit on the line, e.g. a wide image. */
7108 || (new_x
== it
->last_visible_x
7109 && FRAME_WINDOW_P (it
->f
)))
7112 it
->current_x
= new_x
;
7114 /* The character's last glyph just barely fits
7116 if (i
== it
->nglyphs
- 1)
7118 /* If this is the destination position,
7119 return a position *before* it in this row,
7120 now that we know it fits in this row. */
7121 if (BUFFER_POS_REACHED_P ())
7123 if (it
->line_wrap
!= WORD_WRAP
7126 it
->hpos
= hpos_before_this_char
;
7127 it
->current_x
= x_before_this_char
;
7128 result
= MOVE_POS_MATCH_OR_ZV
;
7131 if (it
->line_wrap
== WORD_WRAP
7135 atpos_it
.current_x
= x_before_this_char
;
7136 atpos_it
.hpos
= hpos_before_this_char
;
7140 set_iterator_to_next (it
, 1);
7141 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7142 SET_TEXT_POS (this_line_min_pos
,
7143 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7144 /* On graphical terminals, newlines may
7145 "overflow" into the fringe if
7146 overflow-newline-into-fringe is non-nil.
7147 On text-only terminals, newlines may
7148 overflow into the last glyph on the
7150 if (!FRAME_WINDOW_P (it
->f
)
7151 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7153 if (!get_next_display_element (it
))
7155 result
= MOVE_POS_MATCH_OR_ZV
;
7158 if (BUFFER_POS_REACHED_P ())
7160 if (ITERATOR_AT_END_OF_LINE_P (it
))
7161 result
= MOVE_POS_MATCH_OR_ZV
;
7163 result
= MOVE_LINE_CONTINUED
;
7166 if (ITERATOR_AT_END_OF_LINE_P (it
))
7168 result
= MOVE_NEWLINE_OR_CR
;
7175 IT_RESET_X_ASCENT_DESCENT (it
);
7177 if (wrap_it
.sp
>= 0)
7184 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7186 result
= MOVE_LINE_CONTINUED
;
7190 if (BUFFER_POS_REACHED_P ())
7192 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7193 goto buffer_pos_reached
;
7194 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7197 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7201 if (new_x
> it
->first_visible_x
)
7203 /* Glyph is visible. Increment number of glyphs that
7204 would be displayed. */
7209 if (result
!= MOVE_UNDEFINED
)
7212 else if (BUFFER_POS_REACHED_P ())
7215 IT_RESET_X_ASCENT_DESCENT (it
);
7216 result
= MOVE_POS_MATCH_OR_ZV
;
7219 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7221 /* Stop when TO_X specified and reached. This check is
7222 necessary here because of lines consisting of a line end,
7223 only. The line end will not produce any glyphs and we
7224 would never get MOVE_X_REACHED. */
7225 xassert (it
->nglyphs
== 0);
7226 result
= MOVE_X_REACHED
;
7230 /* Is this a line end? If yes, we're done. */
7231 if (ITERATOR_AT_END_OF_LINE_P (it
))
7233 result
= MOVE_NEWLINE_OR_CR
;
7237 if (it
->method
== GET_FROM_BUFFER
)
7238 prev_pos
= IT_CHARPOS (*it
);
7239 /* The current display element has been consumed. Advance
7241 set_iterator_to_next (it
, 1);
7242 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7243 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7245 /* Stop if lines are truncated and IT's current x-position is
7246 past the right edge of the window now. */
7247 if (it
->line_wrap
== TRUNCATE
7248 && it
->current_x
>= it
->last_visible_x
)
7250 if (!FRAME_WINDOW_P (it
->f
)
7251 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7253 if (!get_next_display_element (it
)
7254 || BUFFER_POS_REACHED_P ())
7256 result
= MOVE_POS_MATCH_OR_ZV
;
7259 if (ITERATOR_AT_END_OF_LINE_P (it
))
7261 result
= MOVE_NEWLINE_OR_CR
;
7265 result
= MOVE_LINE_TRUNCATED
;
7268 #undef IT_RESET_X_ASCENT_DESCENT
7271 #undef BUFFER_POS_REACHED_P
7273 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7274 restore the saved iterator. */
7275 if (atpos_it
.sp
>= 0)
7277 else if (atx_it
.sp
>= 0)
7282 /* Restore the iterator settings altered at the beginning of this
7284 it
->glyph_row
= saved_glyph_row
;
7288 /* For external use. */
7290 move_it_in_display_line (struct it
*it
,
7291 EMACS_INT to_charpos
, int to_x
,
7292 enum move_operation_enum op
)
7294 if (it
->line_wrap
== WORD_WRAP
7295 && (op
& MOVE_TO_X
))
7297 struct it save_it
= *it
;
7298 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7299 /* When word-wrap is on, TO_X may lie past the end
7300 of a wrapped line. Then it->current is the
7301 character on the next line, so backtrack to the
7302 space before the wrap point. */
7303 if (skip
== MOVE_LINE_CONTINUED
)
7305 int prev_x
= max (it
->current_x
- 1, 0);
7307 move_it_in_display_line_to
7308 (it
, -1, prev_x
, MOVE_TO_X
);
7312 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7316 /* Move IT forward until it satisfies one or more of the criteria in
7317 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7319 OP is a bit-mask that specifies where to stop, and in particular,
7320 which of those four position arguments makes a difference. See the
7321 description of enum move_operation_enum.
7323 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7324 screen line, this function will set IT to the next position >
7328 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7330 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7331 int line_height
, line_start_x
= 0, reached
= 0;
7335 if (op
& MOVE_TO_VPOS
)
7337 /* If no TO_CHARPOS and no TO_X specified, stop at the
7338 start of the line TO_VPOS. */
7339 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7341 if (it
->vpos
== to_vpos
)
7347 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7351 /* TO_VPOS >= 0 means stop at TO_X in the line at
7352 TO_VPOS, or at TO_POS, whichever comes first. */
7353 if (it
->vpos
== to_vpos
)
7359 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7361 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7366 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7368 /* We have reached TO_X but not in the line we want. */
7369 skip
= move_it_in_display_line_to (it
, to_charpos
,
7371 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7379 else if (op
& MOVE_TO_Y
)
7381 struct it it_backup
;
7383 if (it
->line_wrap
== WORD_WRAP
)
7386 /* TO_Y specified means stop at TO_X in the line containing
7387 TO_Y---or at TO_CHARPOS if this is reached first. The
7388 problem is that we can't really tell whether the line
7389 contains TO_Y before we have completely scanned it, and
7390 this may skip past TO_X. What we do is to first scan to
7393 If TO_X is not specified, use a TO_X of zero. The reason
7394 is to make the outcome of this function more predictable.
7395 If we didn't use TO_X == 0, we would stop at the end of
7396 the line which is probably not what a caller would expect
7398 skip
= move_it_in_display_line_to
7399 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7400 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7402 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7403 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7405 else if (skip
== MOVE_X_REACHED
)
7407 /* If TO_X was reached, we want to know whether TO_Y is
7408 in the line. We know this is the case if the already
7409 scanned glyphs make the line tall enough. Otherwise,
7410 we must check by scanning the rest of the line. */
7411 line_height
= it
->max_ascent
+ it
->max_descent
;
7412 if (to_y
>= it
->current_y
7413 && to_y
< it
->current_y
+ line_height
)
7419 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7420 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7422 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7423 line_height
= it
->max_ascent
+ it
->max_descent
;
7424 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7426 if (to_y
>= it
->current_y
7427 && to_y
< it
->current_y
+ line_height
)
7429 /* If TO_Y is in this line and TO_X was reached
7430 above, we scanned too far. We have to restore
7431 IT's settings to the ones before skipping. */
7438 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7444 /* Check whether TO_Y is in this line. */
7445 line_height
= it
->max_ascent
+ it
->max_descent
;
7446 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7448 if (to_y
>= it
->current_y
7449 && to_y
< it
->current_y
+ line_height
)
7451 /* When word-wrap is on, TO_X may lie past the end
7452 of a wrapped line. Then it->current is the
7453 character on the next line, so backtrack to the
7454 space before the wrap point. */
7455 if (skip
== MOVE_LINE_CONTINUED
7456 && it
->line_wrap
== WORD_WRAP
)
7458 int prev_x
= max (it
->current_x
- 1, 0);
7460 skip
= move_it_in_display_line_to
7461 (it
, -1, prev_x
, MOVE_TO_X
);
7470 else if (BUFFERP (it
->object
)
7471 && (it
->method
== GET_FROM_BUFFER
7472 || it
->method
== GET_FROM_STRETCH
)
7473 && IT_CHARPOS (*it
) >= to_charpos
)
7474 skip
= MOVE_POS_MATCH_OR_ZV
;
7476 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7480 case MOVE_POS_MATCH_OR_ZV
:
7484 case MOVE_NEWLINE_OR_CR
:
7485 set_iterator_to_next (it
, 1);
7486 it
->continuation_lines_width
= 0;
7489 case MOVE_LINE_TRUNCATED
:
7490 it
->continuation_lines_width
= 0;
7491 reseat_at_next_visible_line_start (it
, 0);
7492 if ((op
& MOVE_TO_POS
) != 0
7493 && IT_CHARPOS (*it
) > to_charpos
)
7500 case MOVE_LINE_CONTINUED
:
7501 /* For continued lines ending in a tab, some of the glyphs
7502 associated with the tab are displayed on the current
7503 line. Since it->current_x does not include these glyphs,
7504 we use it->last_visible_x instead. */
7507 it
->continuation_lines_width
+= it
->last_visible_x
;
7508 /* When moving by vpos, ensure that the iterator really
7509 advances to the next line (bug#847, bug#969). Fixme:
7510 do we need to do this in other circumstances? */
7511 if (it
->current_x
!= it
->last_visible_x
7512 && (op
& MOVE_TO_VPOS
)
7513 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7515 line_start_x
= it
->current_x
+ it
->pixel_width
7516 - it
->last_visible_x
;
7517 set_iterator_to_next (it
, 0);
7521 it
->continuation_lines_width
+= it
->current_x
;
7528 /* Reset/increment for the next run. */
7529 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7530 it
->current_x
= line_start_x
;
7533 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7535 last_height
= it
->max_ascent
+ it
->max_descent
;
7536 last_max_ascent
= it
->max_ascent
;
7537 it
->max_ascent
= it
->max_descent
= 0;
7542 /* On text terminals, we may stop at the end of a line in the middle
7543 of a multi-character glyph. If the glyph itself is continued,
7544 i.e. it is actually displayed on the next line, don't treat this
7545 stopping point as valid; move to the next line instead (unless
7546 that brings us offscreen). */
7547 if (!FRAME_WINDOW_P (it
->f
)
7549 && IT_CHARPOS (*it
) == to_charpos
7550 && it
->what
== IT_CHARACTER
7552 && it
->line_wrap
== WINDOW_WRAP
7553 && it
->current_x
== it
->last_visible_x
- 1
7556 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7558 it
->continuation_lines_width
+= it
->current_x
;
7559 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7560 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7562 last_height
= it
->max_ascent
+ it
->max_descent
;
7563 last_max_ascent
= it
->max_ascent
;
7566 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7570 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7572 If DY > 0, move IT backward at least that many pixels. DY = 0
7573 means move IT backward to the preceding line start or BEGV. This
7574 function may move over more than DY pixels if IT->current_y - DY
7575 ends up in the middle of a line; in this case IT->current_y will be
7576 set to the top of the line moved to. */
7579 move_it_vertically_backward (struct it
*it
, int dy
)
7583 EMACS_INT start_pos
;
7588 start_pos
= IT_CHARPOS (*it
);
7590 /* Estimate how many newlines we must move back. */
7591 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7593 /* Set the iterator's position that many lines back. */
7594 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7595 back_to_previous_visible_line_start (it
);
7597 /* Reseat the iterator here. When moving backward, we don't want
7598 reseat to skip forward over invisible text, set up the iterator
7599 to deliver from overlay strings at the new position etc. So,
7600 use reseat_1 here. */
7601 reseat_1 (it
, it
->current
.pos
, 1);
7603 /* We are now surely at a line start. */
7604 it
->current_x
= it
->hpos
= 0;
7605 it
->continuation_lines_width
= 0;
7607 /* Move forward and see what y-distance we moved. First move to the
7608 start of the next line so that we get its height. We need this
7609 height to be able to tell whether we reached the specified
7612 it2
.max_ascent
= it2
.max_descent
= 0;
7615 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7616 MOVE_TO_POS
| MOVE_TO_VPOS
);
7618 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7619 xassert (IT_CHARPOS (*it
) >= BEGV
);
7622 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7623 xassert (IT_CHARPOS (*it
) >= BEGV
);
7624 /* H is the actual vertical distance from the position in *IT
7625 and the starting position. */
7626 h
= it2
.current_y
- it
->current_y
;
7627 /* NLINES is the distance in number of lines. */
7628 nlines
= it2
.vpos
- it
->vpos
;
7630 /* Correct IT's y and vpos position
7631 so that they are relative to the starting point. */
7637 /* DY == 0 means move to the start of the screen line. The
7638 value of nlines is > 0 if continuation lines were involved. */
7640 move_it_by_lines (it
, nlines
);
7644 /* The y-position we try to reach, relative to *IT.
7645 Note that H has been subtracted in front of the if-statement. */
7646 int target_y
= it
->current_y
+ h
- dy
;
7647 int y0
= it3
.current_y
;
7648 int y1
= line_bottom_y (&it3
);
7649 int line_height
= y1
- y0
;
7651 /* If we did not reach target_y, try to move further backward if
7652 we can. If we moved too far backward, try to move forward. */
7653 if (target_y
< it
->current_y
7654 /* This is heuristic. In a window that's 3 lines high, with
7655 a line height of 13 pixels each, recentering with point
7656 on the bottom line will try to move -39/2 = 19 pixels
7657 backward. Try to avoid moving into the first line. */
7658 && (it
->current_y
- target_y
7659 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7660 && IT_CHARPOS (*it
) > BEGV
)
7662 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7663 target_y
- it
->current_y
));
7664 dy
= it
->current_y
- target_y
;
7665 goto move_further_back
;
7667 else if (target_y
>= it
->current_y
+ line_height
7668 && IT_CHARPOS (*it
) < ZV
)
7670 /* Should move forward by at least one line, maybe more.
7672 Note: Calling move_it_by_lines can be expensive on
7673 terminal frames, where compute_motion is used (via
7674 vmotion) to do the job, when there are very long lines
7675 and truncate-lines is nil. That's the reason for
7676 treating terminal frames specially here. */
7678 if (!FRAME_WINDOW_P (it
->f
))
7679 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7684 move_it_by_lines (it
, 1);
7686 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7693 /* Move IT by a specified amount of pixel lines DY. DY negative means
7694 move backwards. DY = 0 means move to start of screen line. At the
7695 end, IT will be on the start of a screen line. */
7698 move_it_vertically (struct it
*it
, int dy
)
7701 move_it_vertically_backward (it
, -dy
);
7704 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7705 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7706 MOVE_TO_POS
| MOVE_TO_Y
);
7707 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7709 /* If buffer ends in ZV without a newline, move to the start of
7710 the line to satisfy the post-condition. */
7711 if (IT_CHARPOS (*it
) == ZV
7713 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7714 move_it_by_lines (it
, 0);
7719 /* Move iterator IT past the end of the text line it is in. */
7722 move_it_past_eol (struct it
*it
)
7724 enum move_it_result rc
;
7726 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7727 if (rc
== MOVE_NEWLINE_OR_CR
)
7728 set_iterator_to_next (it
, 0);
7732 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7733 negative means move up. DVPOS == 0 means move to the start of the
7736 Optimization idea: If we would know that IT->f doesn't use
7737 a face with proportional font, we could be faster for
7738 truncate-lines nil. */
7741 move_it_by_lines (struct it
*it
, int dvpos
)
7744 /* The commented-out optimization uses vmotion on terminals. This
7745 gives bad results, because elements like it->what, on which
7746 callers such as pos_visible_p rely, aren't updated. */
7747 /* struct position pos;
7748 if (!FRAME_WINDOW_P (it->f))
7750 struct text_pos textpos;
7752 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7753 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7754 reseat (it, textpos, 1);
7755 it->vpos += pos.vpos;
7756 it->current_y += pos.vpos;
7762 /* DVPOS == 0 means move to the start of the screen line. */
7763 move_it_vertically_backward (it
, 0);
7764 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7765 /* Let next call to line_bottom_y calculate real line height */
7770 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7771 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7772 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7777 EMACS_INT start_charpos
, i
;
7779 /* Start at the beginning of the screen line containing IT's
7780 position. This may actually move vertically backwards,
7781 in case of overlays, so adjust dvpos accordingly. */
7783 move_it_vertically_backward (it
, 0);
7786 /* Go back -DVPOS visible lines and reseat the iterator there. */
7787 start_charpos
= IT_CHARPOS (*it
);
7788 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7789 back_to_previous_visible_line_start (it
);
7790 reseat (it
, it
->current
.pos
, 1);
7792 /* Move further back if we end up in a string or an image. */
7793 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7795 /* First try to move to start of display line. */
7797 move_it_vertically_backward (it
, 0);
7799 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7801 /* If start of line is still in string or image,
7802 move further back. */
7803 back_to_previous_visible_line_start (it
);
7804 reseat (it
, it
->current
.pos
, 1);
7808 it
->current_x
= it
->hpos
= 0;
7810 /* Above call may have moved too far if continuation lines
7811 are involved. Scan forward and see if it did. */
7813 it2
.vpos
= it2
.current_y
= 0;
7814 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7815 it
->vpos
-= it2
.vpos
;
7816 it
->current_y
-= it2
.current_y
;
7817 it
->current_x
= it
->hpos
= 0;
7819 /* If we moved too far back, move IT some lines forward. */
7820 if (it2
.vpos
> -dvpos
)
7822 int delta
= it2
.vpos
+ dvpos
;
7824 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7825 /* Move back again if we got too far ahead. */
7826 if (IT_CHARPOS (*it
) >= start_charpos
)
7832 /* Return 1 if IT points into the middle of a display vector. */
7835 in_display_vector_p (struct it
*it
)
7837 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7838 && it
->current
.dpvec_index
> 0
7839 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7843 /***********************************************************************
7845 ***********************************************************************/
7848 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7852 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7854 Lisp_Object args
[3];
7855 Lisp_Object msg
, fmt
;
7858 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7861 /* Do nothing if called asynchronously. Inserting text into
7862 a buffer may call after-change-functions and alike and
7863 that would means running Lisp asynchronously. */
7864 if (handling_signal
)
7868 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7870 args
[0] = fmt
= build_string (format
);
7873 msg
= Fformat (3, args
);
7875 len
= SBYTES (msg
) + 1;
7876 SAFE_ALLOCA (buffer
, char *, len
);
7877 memcpy (buffer
, SDATA (msg
), len
);
7879 message_dolog (buffer
, len
- 1, 1, 0);
7886 /* Output a newline in the *Messages* buffer if "needs" one. */
7889 message_log_maybe_newline (void)
7891 if (message_log_need_newline
)
7892 message_dolog ("", 0, 1, 0);
7896 /* Add a string M of length NBYTES to the message log, optionally
7897 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7898 nonzero, means interpret the contents of M as multibyte. This
7899 function calls low-level routines in order to bypass text property
7900 hooks, etc. which might not be safe to run.
7902 This may GC (insert may run before/after change hooks),
7903 so the buffer M must NOT point to a Lisp string. */
7906 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7908 const unsigned char *msg
= (const unsigned char *) m
;
7910 if (!NILP (Vmemory_full
))
7913 if (!NILP (Vmessage_log_max
))
7915 struct buffer
*oldbuf
;
7916 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7917 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7918 EMACS_INT point_at_end
= 0;
7919 EMACS_INT zv_at_end
= 0;
7920 Lisp_Object old_deactivate_mark
, tem
;
7921 struct gcpro gcpro1
;
7923 old_deactivate_mark
= Vdeactivate_mark
;
7924 oldbuf
= current_buffer
;
7925 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7926 BVAR (current_buffer
, undo_list
) = Qt
;
7928 oldpoint
= message_dolog_marker1
;
7929 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7930 oldbegv
= message_dolog_marker2
;
7931 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7932 oldzv
= message_dolog_marker3
;
7933 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7934 GCPRO1 (old_deactivate_mark
);
7942 BEGV_BYTE
= BEG_BYTE
;
7945 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7947 /* Insert the string--maybe converting multibyte to single byte
7948 or vice versa, so that all the text fits the buffer. */
7950 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7956 /* Convert a multibyte string to single-byte
7957 for the *Message* buffer. */
7958 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7960 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7961 work
[0] = (ASCII_CHAR_P (c
)
7963 : multibyte_char_to_unibyte (c
));
7964 insert_1_both (work
, 1, 1, 1, 0, 0);
7967 else if (! multibyte
7968 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7972 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7973 /* Convert a single-byte string to multibyte
7974 for the *Message* buffer. */
7975 for (i
= 0; i
< nbytes
; i
++)
7978 MAKE_CHAR_MULTIBYTE (c
);
7979 char_bytes
= CHAR_STRING (c
, str
);
7980 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7984 insert_1 (m
, nbytes
, 1, 0, 0);
7988 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7989 unsigned long int dups
;
7990 insert_1 ("\n", 1, 1, 0, 0);
7992 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7994 this_bol_byte
= PT_BYTE
;
7996 /* See if this line duplicates the previous one.
7997 If so, combine duplicates. */
8000 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8002 prev_bol_byte
= PT_BYTE
;
8004 dups
= message_log_check_duplicate (prev_bol_byte
,
8008 del_range_both (prev_bol
, prev_bol_byte
,
8009 this_bol
, this_bol_byte
, 0);
8015 /* If you change this format, don't forget to also
8016 change message_log_check_duplicate. */
8017 sprintf (dupstr
, " [%lu times]", dups
);
8018 duplen
= strlen (dupstr
);
8019 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8020 insert_1 (dupstr
, duplen
, 1, 0, 1);
8025 /* If we have more than the desired maximum number of lines
8026 in the *Messages* buffer now, delete the oldest ones.
8027 This is safe because we don't have undo in this buffer. */
8029 if (NATNUMP (Vmessage_log_max
))
8031 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8032 -XFASTINT (Vmessage_log_max
) - 1, 0);
8033 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8036 BEGV
= XMARKER (oldbegv
)->charpos
;
8037 BEGV_BYTE
= marker_byte_position (oldbegv
);
8046 ZV
= XMARKER (oldzv
)->charpos
;
8047 ZV_BYTE
= marker_byte_position (oldzv
);
8051 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8053 /* We can't do Fgoto_char (oldpoint) because it will run some
8055 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8056 XMARKER (oldpoint
)->bytepos
);
8059 unchain_marker (XMARKER (oldpoint
));
8060 unchain_marker (XMARKER (oldbegv
));
8061 unchain_marker (XMARKER (oldzv
));
8063 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8064 set_buffer_internal (oldbuf
);
8066 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8067 message_log_need_newline
= !nlflag
;
8068 Vdeactivate_mark
= old_deactivate_mark
;
8073 /* We are at the end of the buffer after just having inserted a newline.
8074 (Note: We depend on the fact we won't be crossing the gap.)
8075 Check to see if the most recent message looks a lot like the previous one.
8076 Return 0 if different, 1 if the new one should just replace it, or a
8077 value N > 1 if we should also append " [N times]". */
8079 static unsigned long int
8080 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8083 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8085 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8086 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8088 for (i
= 0; i
< len
; i
++)
8090 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8098 if (*p1
++ == ' ' && *p1
++ == '[')
8101 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8102 if (strncmp (pend
, " times]\n", 8) == 0)
8109 /* Display an echo area message M with a specified length of NBYTES
8110 bytes. The string may include null characters. If M is 0, clear
8111 out any existing message, and let the mini-buffer text show
8114 This may GC, so the buffer M must NOT point to a Lisp string. */
8117 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8119 /* First flush out any partial line written with print. */
8120 message_log_maybe_newline ();
8122 message_dolog (m
, nbytes
, 1, multibyte
);
8123 message2_nolog (m
, nbytes
, multibyte
);
8127 /* The non-logging counterpart of message2. */
8130 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8132 struct frame
*sf
= SELECTED_FRAME ();
8133 message_enable_multibyte
= multibyte
;
8135 if (FRAME_INITIAL_P (sf
))
8137 if (noninteractive_need_newline
)
8138 putc ('\n', stderr
);
8139 noninteractive_need_newline
= 0;
8141 fwrite (m
, nbytes
, 1, stderr
);
8142 if (cursor_in_echo_area
== 0)
8143 fprintf (stderr
, "\n");
8146 /* A null message buffer means that the frame hasn't really been
8147 initialized yet. Error messages get reported properly by
8148 cmd_error, so this must be just an informative message; toss it. */
8149 else if (INTERACTIVE
8150 && sf
->glyphs_initialized_p
8151 && FRAME_MESSAGE_BUF (sf
))
8153 Lisp_Object mini_window
;
8156 /* Get the frame containing the mini-buffer
8157 that the selected frame is using. */
8158 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8159 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8161 FRAME_SAMPLE_VISIBILITY (f
);
8162 if (FRAME_VISIBLE_P (sf
)
8163 && ! FRAME_VISIBLE_P (f
))
8164 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8168 set_message (m
, Qnil
, nbytes
, multibyte
);
8169 if (minibuffer_auto_raise
)
8170 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8173 clear_message (1, 1);
8175 do_pending_window_change (0);
8176 echo_area_display (1);
8177 do_pending_window_change (0);
8178 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8179 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8184 /* Display an echo area message M with a specified length of NBYTES
8185 bytes. The string may include null characters. If M is not a
8186 string, clear out any existing message, and let the mini-buffer
8189 This function cancels echoing. */
8192 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8194 struct gcpro gcpro1
;
8197 clear_message (1,1);
8200 /* First flush out any partial line written with print. */
8201 message_log_maybe_newline ();
8207 SAFE_ALLOCA (buffer
, char *, nbytes
);
8208 memcpy (buffer
, SDATA (m
), nbytes
);
8209 message_dolog (buffer
, nbytes
, 1, multibyte
);
8212 message3_nolog (m
, nbytes
, multibyte
);
8218 /* The non-logging version of message3.
8219 This does not cancel echoing, because it is used for echoing.
8220 Perhaps we need to make a separate function for echoing
8221 and make this cancel echoing. */
8224 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8226 struct frame
*sf
= SELECTED_FRAME ();
8227 message_enable_multibyte
= multibyte
;
8229 if (FRAME_INITIAL_P (sf
))
8231 if (noninteractive_need_newline
)
8232 putc ('\n', stderr
);
8233 noninteractive_need_newline
= 0;
8235 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8236 if (cursor_in_echo_area
== 0)
8237 fprintf (stderr
, "\n");
8240 /* A null message buffer means that the frame hasn't really been
8241 initialized yet. Error messages get reported properly by
8242 cmd_error, so this must be just an informative message; toss it. */
8243 else if (INTERACTIVE
8244 && sf
->glyphs_initialized_p
8245 && FRAME_MESSAGE_BUF (sf
))
8247 Lisp_Object mini_window
;
8251 /* Get the frame containing the mini-buffer
8252 that the selected frame is using. */
8253 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8254 frame
= XWINDOW (mini_window
)->frame
;
8257 FRAME_SAMPLE_VISIBILITY (f
);
8258 if (FRAME_VISIBLE_P (sf
)
8259 && !FRAME_VISIBLE_P (f
))
8260 Fmake_frame_visible (frame
);
8262 if (STRINGP (m
) && SCHARS (m
) > 0)
8264 set_message (NULL
, m
, nbytes
, multibyte
);
8265 if (minibuffer_auto_raise
)
8266 Fraise_frame (frame
);
8267 /* Assume we are not echoing.
8268 (If we are, echo_now will override this.) */
8269 echo_message_buffer
= Qnil
;
8272 clear_message (1, 1);
8274 do_pending_window_change (0);
8275 echo_area_display (1);
8276 do_pending_window_change (0);
8277 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8278 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8283 /* Display a null-terminated echo area message M. If M is 0, clear
8284 out any existing message, and let the mini-buffer text show through.
8286 The buffer M must continue to exist until after the echo area gets
8287 cleared or some other message gets displayed there. Do not pass
8288 text that is stored in a Lisp string. Do not pass text in a buffer
8289 that was alloca'd. */
8292 message1 (const char *m
)
8294 message2 (m
, (m
? strlen (m
) : 0), 0);
8298 /* The non-logging counterpart of message1. */
8301 message1_nolog (const char *m
)
8303 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8306 /* Display a message M which contains a single %s
8307 which gets replaced with STRING. */
8310 message_with_string (const char *m
, Lisp_Object string
, int log
)
8312 CHECK_STRING (string
);
8318 if (noninteractive_need_newline
)
8319 putc ('\n', stderr
);
8320 noninteractive_need_newline
= 0;
8321 fprintf (stderr
, m
, SDATA (string
));
8322 if (!cursor_in_echo_area
)
8323 fprintf (stderr
, "\n");
8327 else if (INTERACTIVE
)
8329 /* The frame whose minibuffer we're going to display the message on.
8330 It may be larger than the selected frame, so we need
8331 to use its buffer, not the selected frame's buffer. */
8332 Lisp_Object mini_window
;
8333 struct frame
*f
, *sf
= SELECTED_FRAME ();
8335 /* Get the frame containing the minibuffer
8336 that the selected frame is using. */
8337 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8338 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8340 /* A null message buffer means that the frame hasn't really been
8341 initialized yet. Error messages get reported properly by
8342 cmd_error, so this must be just an informative message; toss it. */
8343 if (FRAME_MESSAGE_BUF (f
))
8345 Lisp_Object args
[2], msg
;
8346 struct gcpro gcpro1
, gcpro2
;
8348 args
[0] = build_string (m
);
8349 args
[1] = msg
= string
;
8350 GCPRO2 (args
[0], msg
);
8353 msg
= Fformat (2, args
);
8356 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8358 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8362 /* Print should start at the beginning of the message
8363 buffer next time. */
8364 message_buf_print
= 0;
8370 /* Dump an informative message to the minibuf. If M is 0, clear out
8371 any existing message, and let the mini-buffer text show through. */
8374 vmessage (const char *m
, va_list ap
)
8380 if (noninteractive_need_newline
)
8381 putc ('\n', stderr
);
8382 noninteractive_need_newline
= 0;
8383 vfprintf (stderr
, m
, ap
);
8384 if (cursor_in_echo_area
== 0)
8385 fprintf (stderr
, "\n");
8389 else if (INTERACTIVE
)
8391 /* The frame whose mini-buffer we're going to display the message
8392 on. It may be larger than the selected frame, so we need to
8393 use its buffer, not the selected frame's buffer. */
8394 Lisp_Object mini_window
;
8395 struct frame
*f
, *sf
= SELECTED_FRAME ();
8397 /* Get the frame containing the mini-buffer
8398 that the selected frame is using. */
8399 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8400 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8402 /* A null message buffer means that the frame hasn't really been
8403 initialized yet. Error messages get reported properly by
8404 cmd_error, so this must be just an informative message; toss
8406 if (FRAME_MESSAGE_BUF (f
))
8412 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8413 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8415 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8420 /* Print should start at the beginning of the message
8421 buffer next time. */
8422 message_buf_print
= 0;
8428 message (const char *m
, ...)
8437 /* The non-logging version of message. */
8440 message_nolog (const char *m
, ...)
8442 Lisp_Object old_log_max
;
8445 old_log_max
= Vmessage_log_max
;
8446 Vmessage_log_max
= Qnil
;
8448 Vmessage_log_max
= old_log_max
;
8453 /* Display the current message in the current mini-buffer. This is
8454 only called from error handlers in process.c, and is not time
8458 update_echo_area (void)
8460 if (!NILP (echo_area_buffer
[0]))
8463 string
= Fcurrent_message ();
8464 message3 (string
, SBYTES (string
),
8465 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8470 /* Make sure echo area buffers in `echo_buffers' are live.
8471 If they aren't, make new ones. */
8474 ensure_echo_area_buffers (void)
8478 for (i
= 0; i
< 2; ++i
)
8479 if (!BUFFERP (echo_buffer
[i
])
8480 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8483 Lisp_Object old_buffer
;
8486 old_buffer
= echo_buffer
[i
];
8487 sprintf (name
, " *Echo Area %d*", i
);
8488 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8489 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8490 /* to force word wrap in echo area -
8491 it was decided to postpone this*/
8492 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8494 for (j
= 0; j
< 2; ++j
)
8495 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8496 echo_area_buffer
[j
] = echo_buffer
[i
];
8501 /* Call FN with args A1..A4 with either the current or last displayed
8502 echo_area_buffer as current buffer.
8504 WHICH zero means use the current message buffer
8505 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8506 from echo_buffer[] and clear it.
8508 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8509 suitable buffer from echo_buffer[] and clear it.
8511 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8512 that the current message becomes the last displayed one, make
8513 choose a suitable buffer for echo_area_buffer[0], and clear it.
8515 Value is what FN returns. */
8518 with_echo_area_buffer (struct window
*w
, int which
,
8519 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8520 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8523 int this_one
, the_other
, clear_buffer_p
, rc
;
8524 int count
= SPECPDL_INDEX ();
8526 /* If buffers aren't live, make new ones. */
8527 ensure_echo_area_buffers ();
8532 this_one
= 0, the_other
= 1;
8534 this_one
= 1, the_other
= 0;
8537 this_one
= 0, the_other
= 1;
8540 /* We need a fresh one in case the current echo buffer equals
8541 the one containing the last displayed echo area message. */
8542 if (!NILP (echo_area_buffer
[this_one
])
8543 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8544 echo_area_buffer
[this_one
] = Qnil
;
8547 /* Choose a suitable buffer from echo_buffer[] is we don't
8549 if (NILP (echo_area_buffer
[this_one
]))
8551 echo_area_buffer
[this_one
]
8552 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8553 ? echo_buffer
[the_other
]
8554 : echo_buffer
[this_one
]);
8558 buffer
= echo_area_buffer
[this_one
];
8560 /* Don't get confused by reusing the buffer used for echoing
8561 for a different purpose. */
8562 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8565 record_unwind_protect (unwind_with_echo_area_buffer
,
8566 with_echo_area_buffer_unwind_data (w
));
8568 /* Make the echo area buffer current. Note that for display
8569 purposes, it is not necessary that the displayed window's buffer
8570 == current_buffer, except for text property lookup. So, let's
8571 only set that buffer temporarily here without doing a full
8572 Fset_window_buffer. We must also change w->pointm, though,
8573 because otherwise an assertions in unshow_buffer fails, and Emacs
8575 set_buffer_internal_1 (XBUFFER (buffer
));
8579 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8582 BVAR (current_buffer
, undo_list
) = Qt
;
8583 BVAR (current_buffer
, read_only
) = Qnil
;
8584 specbind (Qinhibit_read_only
, Qt
);
8585 specbind (Qinhibit_modification_hooks
, Qt
);
8587 if (clear_buffer_p
&& Z
> BEG
)
8590 xassert (BEGV
>= BEG
);
8591 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8593 rc
= fn (a1
, a2
, a3
, a4
);
8595 xassert (BEGV
>= BEG
);
8596 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8598 unbind_to (count
, Qnil
);
8603 /* Save state that should be preserved around the call to the function
8604 FN called in with_echo_area_buffer. */
8607 with_echo_area_buffer_unwind_data (struct window
*w
)
8610 Lisp_Object vector
, tmp
;
8612 /* Reduce consing by keeping one vector in
8613 Vwith_echo_area_save_vector. */
8614 vector
= Vwith_echo_area_save_vector
;
8615 Vwith_echo_area_save_vector
= Qnil
;
8618 vector
= Fmake_vector (make_number (7), Qnil
);
8620 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8621 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8622 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8626 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8627 ASET (vector
, i
, w
->buffer
); ++i
;
8628 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8629 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8634 for (; i
< end
; ++i
)
8635 ASET (vector
, i
, Qnil
);
8638 xassert (i
== ASIZE (vector
));
8643 /* Restore global state from VECTOR which was created by
8644 with_echo_area_buffer_unwind_data. */
8647 unwind_with_echo_area_buffer (Lisp_Object vector
)
8649 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8650 Vdeactivate_mark
= AREF (vector
, 1);
8651 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8653 if (WINDOWP (AREF (vector
, 3)))
8656 Lisp_Object buffer
, charpos
, bytepos
;
8658 w
= XWINDOW (AREF (vector
, 3));
8659 buffer
= AREF (vector
, 4);
8660 charpos
= AREF (vector
, 5);
8661 bytepos
= AREF (vector
, 6);
8664 set_marker_both (w
->pointm
, buffer
,
8665 XFASTINT (charpos
), XFASTINT (bytepos
));
8668 Vwith_echo_area_save_vector
= vector
;
8673 /* Set up the echo area for use by print functions. MULTIBYTE_P
8674 non-zero means we will print multibyte. */
8677 setup_echo_area_for_printing (int multibyte_p
)
8679 /* If we can't find an echo area any more, exit. */
8680 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8683 ensure_echo_area_buffers ();
8685 if (!message_buf_print
)
8687 /* A message has been output since the last time we printed.
8688 Choose a fresh echo area buffer. */
8689 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8690 echo_area_buffer
[0] = echo_buffer
[1];
8692 echo_area_buffer
[0] = echo_buffer
[0];
8694 /* Switch to that buffer and clear it. */
8695 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8696 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8700 int count
= SPECPDL_INDEX ();
8701 specbind (Qinhibit_read_only
, Qt
);
8702 /* Note that undo recording is always disabled. */
8704 unbind_to (count
, Qnil
);
8706 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8708 /* Set up the buffer for the multibyteness we need. */
8710 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8711 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8713 /* Raise the frame containing the echo area. */
8714 if (minibuffer_auto_raise
)
8716 struct frame
*sf
= SELECTED_FRAME ();
8717 Lisp_Object mini_window
;
8718 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8719 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8722 message_log_maybe_newline ();
8723 message_buf_print
= 1;
8727 if (NILP (echo_area_buffer
[0]))
8729 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8730 echo_area_buffer
[0] = echo_buffer
[1];
8732 echo_area_buffer
[0] = echo_buffer
[0];
8735 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8737 /* Someone switched buffers between print requests. */
8738 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8739 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8745 /* Display an echo area message in window W. Value is non-zero if W's
8746 height is changed. If display_last_displayed_message_p is
8747 non-zero, display the message that was last displayed, otherwise
8748 display the current message. */
8751 display_echo_area (struct window
*w
)
8753 int i
, no_message_p
, window_height_changed_p
, count
;
8755 /* Temporarily disable garbage collections while displaying the echo
8756 area. This is done because a GC can print a message itself.
8757 That message would modify the echo area buffer's contents while a
8758 redisplay of the buffer is going on, and seriously confuse
8760 count
= inhibit_garbage_collection ();
8762 /* If there is no message, we must call display_echo_area_1
8763 nevertheless because it resizes the window. But we will have to
8764 reset the echo_area_buffer in question to nil at the end because
8765 with_echo_area_buffer will sets it to an empty buffer. */
8766 i
= display_last_displayed_message_p
? 1 : 0;
8767 no_message_p
= NILP (echo_area_buffer
[i
]);
8769 window_height_changed_p
8770 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8771 display_echo_area_1
,
8772 (EMACS_INT
) w
, Qnil
, 0, 0);
8775 echo_area_buffer
[i
] = Qnil
;
8777 unbind_to (count
, Qnil
);
8778 return window_height_changed_p
;
8782 /* Helper for display_echo_area. Display the current buffer which
8783 contains the current echo area message in window W, a mini-window,
8784 a pointer to which is passed in A1. A2..A4 are currently not used.
8785 Change the height of W so that all of the message is displayed.
8786 Value is non-zero if height of W was changed. */
8789 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8791 struct window
*w
= (struct window
*) a1
;
8793 struct text_pos start
;
8794 int window_height_changed_p
= 0;
8796 /* Do this before displaying, so that we have a large enough glyph
8797 matrix for the display. If we can't get enough space for the
8798 whole text, display the last N lines. That works by setting w->start. */
8799 window_height_changed_p
= resize_mini_window (w
, 0);
8801 /* Use the starting position chosen by resize_mini_window. */
8802 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8805 clear_glyph_matrix (w
->desired_matrix
);
8806 XSETWINDOW (window
, w
);
8807 try_window (window
, start
, 0);
8809 return window_height_changed_p
;
8813 /* Resize the echo area window to exactly the size needed for the
8814 currently displayed message, if there is one. If a mini-buffer
8815 is active, don't shrink it. */
8818 resize_echo_area_exactly (void)
8820 if (BUFFERP (echo_area_buffer
[0])
8821 && WINDOWP (echo_area_window
))
8823 struct window
*w
= XWINDOW (echo_area_window
);
8825 Lisp_Object resize_exactly
;
8827 if (minibuf_level
== 0)
8828 resize_exactly
= Qt
;
8830 resize_exactly
= Qnil
;
8832 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8833 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8836 ++windows_or_buffers_changed
;
8837 ++update_mode_lines
;
8838 redisplay_internal ();
8844 /* Callback function for with_echo_area_buffer, when used from
8845 resize_echo_area_exactly. A1 contains a pointer to the window to
8846 resize, EXACTLY non-nil means resize the mini-window exactly to the
8847 size of the text displayed. A3 and A4 are not used. Value is what
8848 resize_mini_window returns. */
8851 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8853 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8857 /* Resize mini-window W to fit the size of its contents. EXACT_P
8858 means size the window exactly to the size needed. Otherwise, it's
8859 only enlarged until W's buffer is empty.
8861 Set W->start to the right place to begin display. If the whole
8862 contents fit, start at the beginning. Otherwise, start so as
8863 to make the end of the contents appear. This is particularly
8864 important for y-or-n-p, but seems desirable generally.
8866 Value is non-zero if the window height has been changed. */
8869 resize_mini_window (struct window
*w
, int exact_p
)
8871 struct frame
*f
= XFRAME (w
->frame
);
8872 int window_height_changed_p
= 0;
8874 xassert (MINI_WINDOW_P (w
));
8876 /* By default, start display at the beginning. */
8877 set_marker_both (w
->start
, w
->buffer
,
8878 BUF_BEGV (XBUFFER (w
->buffer
)),
8879 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8881 /* Don't resize windows while redisplaying a window; it would
8882 confuse redisplay functions when the size of the window they are
8883 displaying changes from under them. Such a resizing can happen,
8884 for instance, when which-func prints a long message while
8885 we are running fontification-functions. We're running these
8886 functions with safe_call which binds inhibit-redisplay to t. */
8887 if (!NILP (Vinhibit_redisplay
))
8890 /* Nil means don't try to resize. */
8891 if (NILP (Vresize_mini_windows
)
8892 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8895 if (!FRAME_MINIBUF_ONLY_P (f
))
8898 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8899 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8900 int height
, max_height
;
8901 int unit
= FRAME_LINE_HEIGHT (f
);
8902 struct text_pos start
;
8903 struct buffer
*old_current_buffer
= NULL
;
8905 if (current_buffer
!= XBUFFER (w
->buffer
))
8907 old_current_buffer
= current_buffer
;
8908 set_buffer_internal (XBUFFER (w
->buffer
));
8911 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8913 /* Compute the max. number of lines specified by the user. */
8914 if (FLOATP (Vmax_mini_window_height
))
8915 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8916 else if (INTEGERP (Vmax_mini_window_height
))
8917 max_height
= XINT (Vmax_mini_window_height
);
8919 max_height
= total_height
/ 4;
8921 /* Correct that max. height if it's bogus. */
8922 max_height
= max (1, max_height
);
8923 max_height
= min (total_height
, max_height
);
8925 /* Find out the height of the text in the window. */
8926 if (it
.line_wrap
== TRUNCATE
)
8931 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8932 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8933 height
= it
.current_y
+ last_height
;
8935 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8936 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8937 height
= (height
+ unit
- 1) / unit
;
8940 /* Compute a suitable window start. */
8941 if (height
> max_height
)
8943 height
= max_height
;
8944 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8945 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8946 start
= it
.current
.pos
;
8949 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8950 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8952 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8954 /* Let it grow only, until we display an empty message, in which
8955 case the window shrinks again. */
8956 if (height
> WINDOW_TOTAL_LINES (w
))
8958 int old_height
= WINDOW_TOTAL_LINES (w
);
8959 freeze_window_starts (f
, 1);
8960 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8961 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8963 else if (height
< WINDOW_TOTAL_LINES (w
)
8964 && (exact_p
|| BEGV
== ZV
))
8966 int old_height
= WINDOW_TOTAL_LINES (w
);
8967 freeze_window_starts (f
, 0);
8968 shrink_mini_window (w
);
8969 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8974 /* Always resize to exact size needed. */
8975 if (height
> WINDOW_TOTAL_LINES (w
))
8977 int old_height
= WINDOW_TOTAL_LINES (w
);
8978 freeze_window_starts (f
, 1);
8979 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8980 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8982 else if (height
< WINDOW_TOTAL_LINES (w
))
8984 int old_height
= WINDOW_TOTAL_LINES (w
);
8985 freeze_window_starts (f
, 0);
8986 shrink_mini_window (w
);
8990 freeze_window_starts (f
, 1);
8991 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8994 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8998 if (old_current_buffer
)
8999 set_buffer_internal (old_current_buffer
);
9002 return window_height_changed_p
;
9006 /* Value is the current message, a string, or nil if there is no
9010 current_message (void)
9014 if (!BUFFERP (echo_area_buffer
[0]))
9018 with_echo_area_buffer (0, 0, current_message_1
,
9019 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9021 echo_area_buffer
[0] = Qnil
;
9029 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9031 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9034 *msg
= make_buffer_string (BEG
, Z
, 1);
9041 /* Push the current message on Vmessage_stack for later restauration
9042 by restore_message. Value is non-zero if the current message isn't
9043 empty. This is a relatively infrequent operation, so it's not
9044 worth optimizing. */
9050 msg
= current_message ();
9051 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9052 return STRINGP (msg
);
9056 /* Restore message display from the top of Vmessage_stack. */
9059 restore_message (void)
9063 xassert (CONSP (Vmessage_stack
));
9064 msg
= XCAR (Vmessage_stack
);
9066 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9068 message3_nolog (msg
, 0, 0);
9072 /* Handler for record_unwind_protect calling pop_message. */
9075 pop_message_unwind (Lisp_Object dummy
)
9081 /* Pop the top-most entry off Vmessage_stack. */
9086 xassert (CONSP (Vmessage_stack
));
9087 Vmessage_stack
= XCDR (Vmessage_stack
);
9091 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9092 exits. If the stack is not empty, we have a missing pop_message
9096 check_message_stack (void)
9098 if (!NILP (Vmessage_stack
))
9103 /* Truncate to NCHARS what will be displayed in the echo area the next
9104 time we display it---but don't redisplay it now. */
9107 truncate_echo_area (EMACS_INT nchars
)
9110 echo_area_buffer
[0] = Qnil
;
9111 /* A null message buffer means that the frame hasn't really been
9112 initialized yet. Error messages get reported properly by
9113 cmd_error, so this must be just an informative message; toss it. */
9114 else if (!noninteractive
9116 && !NILP (echo_area_buffer
[0]))
9118 struct frame
*sf
= SELECTED_FRAME ();
9119 if (FRAME_MESSAGE_BUF (sf
))
9120 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9125 /* Helper function for truncate_echo_area. Truncate the current
9126 message to at most NCHARS characters. */
9129 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9131 if (BEG
+ nchars
< Z
)
9132 del_range (BEG
+ nchars
, Z
);
9134 echo_area_buffer
[0] = Qnil
;
9139 /* Set the current message to a substring of S or STRING.
9141 If STRING is a Lisp string, set the message to the first NBYTES
9142 bytes from STRING. NBYTES zero means use the whole string. If
9143 STRING is multibyte, the message will be displayed multibyte.
9145 If S is not null, set the message to the first LEN bytes of S. LEN
9146 zero means use the whole string. MULTIBYTE_P non-zero means S is
9147 multibyte. Display the message multibyte in that case.
9149 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9150 to t before calling set_message_1 (which calls insert).
9154 set_message (const char *s
, Lisp_Object string
,
9155 EMACS_INT nbytes
, int multibyte_p
)
9157 message_enable_multibyte
9158 = ((s
&& multibyte_p
)
9159 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9161 with_echo_area_buffer (0, -1, set_message_1
,
9162 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9163 message_buf_print
= 0;
9164 help_echo_showing_p
= 0;
9168 /* Helper function for set_message. Arguments have the same meaning
9169 as there, with A1 corresponding to S and A2 corresponding to STRING
9170 This function is called with the echo area buffer being
9174 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9176 const char *s
= (const char *) a1
;
9177 const unsigned char *msg
= (const unsigned char *) s
;
9178 Lisp_Object string
= a2
;
9180 /* Change multibyteness of the echo buffer appropriately. */
9181 if (message_enable_multibyte
9182 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9183 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9185 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9186 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9187 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9189 /* Insert new message at BEG. */
9190 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9192 if (STRINGP (string
))
9197 nbytes
= SBYTES (string
);
9198 nchars
= string_byte_to_char (string
, nbytes
);
9200 /* This function takes care of single/multibyte conversion. We
9201 just have to ensure that the echo area buffer has the right
9202 setting of enable_multibyte_characters. */
9203 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9208 nbytes
= strlen (s
);
9210 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9212 /* Convert from multi-byte to single-byte. */
9217 /* Convert a multibyte string to single-byte. */
9218 for (i
= 0; i
< nbytes
; i
+= n
)
9220 c
= string_char_and_length (msg
+ i
, &n
);
9221 work
[0] = (ASCII_CHAR_P (c
)
9223 : multibyte_char_to_unibyte (c
));
9224 insert_1_both (work
, 1, 1, 1, 0, 0);
9227 else if (!multibyte_p
9228 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9230 /* Convert from single-byte to multi-byte. */
9233 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9235 /* Convert a single-byte string to multibyte. */
9236 for (i
= 0; i
< nbytes
; i
++)
9239 MAKE_CHAR_MULTIBYTE (c
);
9240 n
= CHAR_STRING (c
, str
);
9241 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9245 insert_1 (s
, nbytes
, 1, 0, 0);
9252 /* Clear messages. CURRENT_P non-zero means clear the current
9253 message. LAST_DISPLAYED_P non-zero means clear the message
9257 clear_message (int current_p
, int last_displayed_p
)
9261 echo_area_buffer
[0] = Qnil
;
9262 message_cleared_p
= 1;
9265 if (last_displayed_p
)
9266 echo_area_buffer
[1] = Qnil
;
9268 message_buf_print
= 0;
9271 /* Clear garbaged frames.
9273 This function is used where the old redisplay called
9274 redraw_garbaged_frames which in turn called redraw_frame which in
9275 turn called clear_frame. The call to clear_frame was a source of
9276 flickering. I believe a clear_frame is not necessary. It should
9277 suffice in the new redisplay to invalidate all current matrices,
9278 and ensure a complete redisplay of all windows. */
9281 clear_garbaged_frames (void)
9285 Lisp_Object tail
, frame
;
9286 int changed_count
= 0;
9288 FOR_EACH_FRAME (tail
, frame
)
9290 struct frame
*f
= XFRAME (frame
);
9292 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9296 Fredraw_frame (frame
);
9297 f
->force_flush_display_p
= 1;
9299 clear_current_matrices (f
);
9308 ++windows_or_buffers_changed
;
9313 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9314 is non-zero update selected_frame. Value is non-zero if the
9315 mini-windows height has been changed. */
9318 echo_area_display (int update_frame_p
)
9320 Lisp_Object mini_window
;
9323 int window_height_changed_p
= 0;
9324 struct frame
*sf
= SELECTED_FRAME ();
9326 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9327 w
= XWINDOW (mini_window
);
9328 f
= XFRAME (WINDOW_FRAME (w
));
9330 /* Don't display if frame is invisible or not yet initialized. */
9331 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9334 #ifdef HAVE_WINDOW_SYSTEM
9335 /* When Emacs starts, selected_frame may be the initial terminal
9336 frame. If we let this through, a message would be displayed on
9338 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9340 #endif /* HAVE_WINDOW_SYSTEM */
9342 /* Redraw garbaged frames. */
9344 clear_garbaged_frames ();
9346 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9348 echo_area_window
= mini_window
;
9349 window_height_changed_p
= display_echo_area (w
);
9350 w
->must_be_updated_p
= 1;
9352 /* Update the display, unless called from redisplay_internal.
9353 Also don't update the screen during redisplay itself. The
9354 update will happen at the end of redisplay, and an update
9355 here could cause confusion. */
9356 if (update_frame_p
&& !redisplaying_p
)
9360 /* If the display update has been interrupted by pending
9361 input, update mode lines in the frame. Due to the
9362 pending input, it might have been that redisplay hasn't
9363 been called, so that mode lines above the echo area are
9364 garbaged. This looks odd, so we prevent it here. */
9365 if (!display_completed
)
9366 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9368 if (window_height_changed_p
9369 /* Don't do this if Emacs is shutting down. Redisplay
9370 needs to run hooks. */
9371 && !NILP (Vrun_hooks
))
9373 /* Must update other windows. Likewise as in other
9374 cases, don't let this update be interrupted by
9376 int count
= SPECPDL_INDEX ();
9377 specbind (Qredisplay_dont_pause
, Qt
);
9378 windows_or_buffers_changed
= 1;
9379 redisplay_internal ();
9380 unbind_to (count
, Qnil
);
9382 else if (FRAME_WINDOW_P (f
) && n
== 0)
9384 /* Window configuration is the same as before.
9385 Can do with a display update of the echo area,
9386 unless we displayed some mode lines. */
9387 update_single_window (w
, 1);
9388 FRAME_RIF (f
)->flush_display (f
);
9391 update_frame (f
, 1, 1);
9393 /* If cursor is in the echo area, make sure that the next
9394 redisplay displays the minibuffer, so that the cursor will
9395 be replaced with what the minibuffer wants. */
9396 if (cursor_in_echo_area
)
9397 ++windows_or_buffers_changed
;
9400 else if (!EQ (mini_window
, selected_window
))
9401 windows_or_buffers_changed
++;
9403 /* Last displayed message is now the current message. */
9404 echo_area_buffer
[1] = echo_area_buffer
[0];
9405 /* Inform read_char that we're not echoing. */
9406 echo_message_buffer
= Qnil
;
9408 /* Prevent redisplay optimization in redisplay_internal by resetting
9409 this_line_start_pos. This is done because the mini-buffer now
9410 displays the message instead of its buffer text. */
9411 if (EQ (mini_window
, selected_window
))
9412 CHARPOS (this_line_start_pos
) = 0;
9414 return window_height_changed_p
;
9419 /***********************************************************************
9420 Mode Lines and Frame Titles
9421 ***********************************************************************/
9423 /* A buffer for constructing non-propertized mode-line strings and
9424 frame titles in it; allocated from the heap in init_xdisp and
9425 resized as needed in store_mode_line_noprop_char. */
9427 static char *mode_line_noprop_buf
;
9429 /* The buffer's end, and a current output position in it. */
9431 static char *mode_line_noprop_buf_end
;
9432 static char *mode_line_noprop_ptr
;
9434 #define MODE_LINE_NOPROP_LEN(start) \
9435 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9438 MODE_LINE_DISPLAY
= 0,
9444 /* Alist that caches the results of :propertize.
9445 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9446 static Lisp_Object mode_line_proptrans_alist
;
9448 /* List of strings making up the mode-line. */
9449 static Lisp_Object mode_line_string_list
;
9451 /* Base face property when building propertized mode line string. */
9452 static Lisp_Object mode_line_string_face
;
9453 static Lisp_Object mode_line_string_face_prop
;
9456 /* Unwind data for mode line strings */
9458 static Lisp_Object Vmode_line_unwind_vector
;
9461 format_mode_line_unwind_data (struct buffer
*obuf
,
9465 Lisp_Object vector
, tmp
;
9467 /* Reduce consing by keeping one vector in
9468 Vwith_echo_area_save_vector. */
9469 vector
= Vmode_line_unwind_vector
;
9470 Vmode_line_unwind_vector
= Qnil
;
9473 vector
= Fmake_vector (make_number (8), Qnil
);
9475 ASET (vector
, 0, make_number (mode_line_target
));
9476 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9477 ASET (vector
, 2, mode_line_string_list
);
9478 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9479 ASET (vector
, 4, mode_line_string_face
);
9480 ASET (vector
, 5, mode_line_string_face_prop
);
9483 XSETBUFFER (tmp
, obuf
);
9486 ASET (vector
, 6, tmp
);
9487 ASET (vector
, 7, owin
);
9493 unwind_format_mode_line (Lisp_Object vector
)
9495 mode_line_target
= XINT (AREF (vector
, 0));
9496 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9497 mode_line_string_list
= AREF (vector
, 2);
9498 if (! EQ (AREF (vector
, 3), Qt
))
9499 mode_line_proptrans_alist
= AREF (vector
, 3);
9500 mode_line_string_face
= AREF (vector
, 4);
9501 mode_line_string_face_prop
= AREF (vector
, 5);
9503 if (!NILP (AREF (vector
, 7)))
9504 /* Select window before buffer, since it may change the buffer. */
9505 Fselect_window (AREF (vector
, 7), Qt
);
9507 if (!NILP (AREF (vector
, 6)))
9509 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9510 ASET (vector
, 6, Qnil
);
9513 Vmode_line_unwind_vector
= vector
;
9518 /* Store a single character C for the frame title in mode_line_noprop_buf.
9519 Re-allocate mode_line_noprop_buf if necessary. */
9522 store_mode_line_noprop_char (char c
)
9524 /* If output position has reached the end of the allocated buffer,
9525 double the buffer's size. */
9526 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9528 int len
= MODE_LINE_NOPROP_LEN (0);
9529 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9530 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9531 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9532 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9535 *mode_line_noprop_ptr
++ = c
;
9539 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9540 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9541 characters that yield more columns than PRECISION; PRECISION <= 0
9542 means copy the whole string. Pad with spaces until FIELD_WIDTH
9543 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9544 pad. Called from display_mode_element when it is used to build a
9548 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9550 const unsigned char *str
= (const unsigned char *) string
;
9552 EMACS_INT dummy
, nbytes
;
9554 /* Copy at most PRECISION chars from STR. */
9555 nbytes
= strlen (string
);
9556 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9558 store_mode_line_noprop_char (*str
++);
9560 /* Fill up with spaces until FIELD_WIDTH reached. */
9561 while (field_width
> 0
9564 store_mode_line_noprop_char (' ');
9571 /***********************************************************************
9573 ***********************************************************************/
9575 #ifdef HAVE_WINDOW_SYSTEM
9577 /* Set the title of FRAME, if it has changed. The title format is
9578 Vicon_title_format if FRAME is iconified, otherwise it is
9579 frame_title_format. */
9582 x_consider_frame_title (Lisp_Object frame
)
9584 struct frame
*f
= XFRAME (frame
);
9586 if (FRAME_WINDOW_P (f
)
9587 || FRAME_MINIBUF_ONLY_P (f
)
9588 || f
->explicit_name
)
9590 /* Do we have more than one visible frame on this X display? */
9597 int count
= SPECPDL_INDEX ();
9599 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9601 Lisp_Object other_frame
= XCAR (tail
);
9602 struct frame
*tf
= XFRAME (other_frame
);
9605 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9606 && !FRAME_MINIBUF_ONLY_P (tf
)
9607 && !EQ (other_frame
, tip_frame
)
9608 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9612 /* Set global variable indicating that multiple frames exist. */
9613 multiple_frames
= CONSP (tail
);
9615 /* Switch to the buffer of selected window of the frame. Set up
9616 mode_line_target so that display_mode_element will output into
9617 mode_line_noprop_buf; then display the title. */
9618 record_unwind_protect (unwind_format_mode_line
,
9619 format_mode_line_unwind_data
9620 (current_buffer
, selected_window
, 0));
9622 Fselect_window (f
->selected_window
, Qt
);
9623 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9624 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9626 mode_line_target
= MODE_LINE_TITLE
;
9627 title_start
= MODE_LINE_NOPROP_LEN (0);
9628 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9629 NULL
, DEFAULT_FACE_ID
);
9630 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9631 len
= MODE_LINE_NOPROP_LEN (title_start
);
9632 title
= mode_line_noprop_buf
+ title_start
;
9633 unbind_to (count
, Qnil
);
9635 /* Set the title only if it's changed. This avoids consing in
9636 the common case where it hasn't. (If it turns out that we've
9637 already wasted too much time by walking through the list with
9638 display_mode_element, then we might need to optimize at a
9639 higher level than this.) */
9640 if (! STRINGP (f
->name
)
9641 || SBYTES (f
->name
) != len
9642 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9643 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9647 #endif /* not HAVE_WINDOW_SYSTEM */
9652 /***********************************************************************
9654 ***********************************************************************/
9657 /* Prepare for redisplay by updating menu-bar item lists when
9658 appropriate. This can call eval. */
9661 prepare_menu_bars (void)
9664 struct gcpro gcpro1
, gcpro2
;
9666 Lisp_Object tooltip_frame
;
9668 #ifdef HAVE_WINDOW_SYSTEM
9669 tooltip_frame
= tip_frame
;
9671 tooltip_frame
= Qnil
;
9674 /* Update all frame titles based on their buffer names, etc. We do
9675 this before the menu bars so that the buffer-menu will show the
9676 up-to-date frame titles. */
9677 #ifdef HAVE_WINDOW_SYSTEM
9678 if (windows_or_buffers_changed
|| update_mode_lines
)
9680 Lisp_Object tail
, frame
;
9682 FOR_EACH_FRAME (tail
, frame
)
9685 if (!EQ (frame
, tooltip_frame
)
9686 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9687 x_consider_frame_title (frame
);
9690 #endif /* HAVE_WINDOW_SYSTEM */
9692 /* Update the menu bar item lists, if appropriate. This has to be
9693 done before any actual redisplay or generation of display lines. */
9694 all_windows
= (update_mode_lines
9695 || buffer_shared
> 1
9696 || windows_or_buffers_changed
);
9699 Lisp_Object tail
, frame
;
9700 int count
= SPECPDL_INDEX ();
9701 /* 1 means that update_menu_bar has run its hooks
9702 so any further calls to update_menu_bar shouldn't do so again. */
9703 int menu_bar_hooks_run
= 0;
9705 record_unwind_save_match_data ();
9707 FOR_EACH_FRAME (tail
, frame
)
9711 /* Ignore tooltip frame. */
9712 if (EQ (frame
, tooltip_frame
))
9715 /* If a window on this frame changed size, report that to
9716 the user and clear the size-change flag. */
9717 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9719 Lisp_Object functions
;
9721 /* Clear flag first in case we get an error below. */
9722 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9723 functions
= Vwindow_size_change_functions
;
9724 GCPRO2 (tail
, functions
);
9726 while (CONSP (functions
))
9728 if (!EQ (XCAR (functions
), Qt
))
9729 call1 (XCAR (functions
), frame
);
9730 functions
= XCDR (functions
);
9736 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9737 #ifdef HAVE_WINDOW_SYSTEM
9738 update_tool_bar (f
, 0);
9741 if (windows_or_buffers_changed
9743 ns_set_doc_edited (f
, Fbuffer_modified_p
9744 (XWINDOW (f
->selected_window
)->buffer
));
9749 unbind_to (count
, Qnil
);
9753 struct frame
*sf
= SELECTED_FRAME ();
9754 update_menu_bar (sf
, 1, 0);
9755 #ifdef HAVE_WINDOW_SYSTEM
9756 update_tool_bar (sf
, 1);
9762 /* Update the menu bar item list for frame F. This has to be done
9763 before we start to fill in any display lines, because it can call
9766 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9768 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9769 already ran the menu bar hooks for this redisplay, so there
9770 is no need to run them again. The return value is the
9771 updated value of this flag, to pass to the next call. */
9774 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9777 register struct window
*w
;
9779 /* If called recursively during a menu update, do nothing. This can
9780 happen when, for instance, an activate-menubar-hook causes a
9782 if (inhibit_menubar_update
)
9785 window
= FRAME_SELECTED_WINDOW (f
);
9786 w
= XWINDOW (window
);
9788 if (FRAME_WINDOW_P (f
)
9790 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9791 || defined (HAVE_NS) || defined (USE_GTK)
9792 FRAME_EXTERNAL_MENU_BAR (f
)
9794 FRAME_MENU_BAR_LINES (f
) > 0
9796 : FRAME_MENU_BAR_LINES (f
) > 0)
9798 /* If the user has switched buffers or windows, we need to
9799 recompute to reflect the new bindings. But we'll
9800 recompute when update_mode_lines is set too; that means
9801 that people can use force-mode-line-update to request
9802 that the menu bar be recomputed. The adverse effect on
9803 the rest of the redisplay algorithm is about the same as
9804 windows_or_buffers_changed anyway. */
9805 if (windows_or_buffers_changed
9806 /* This used to test w->update_mode_line, but we believe
9807 there is no need to recompute the menu in that case. */
9808 || update_mode_lines
9809 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9810 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9811 != !NILP (w
->last_had_star
))
9812 || ((!NILP (Vtransient_mark_mode
)
9813 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9814 != !NILP (w
->region_showing
)))
9816 struct buffer
*prev
= current_buffer
;
9817 int count
= SPECPDL_INDEX ();
9819 specbind (Qinhibit_menubar_update
, Qt
);
9821 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9822 if (save_match_data
)
9823 record_unwind_save_match_data ();
9824 if (NILP (Voverriding_local_map_menu_flag
))
9826 specbind (Qoverriding_terminal_local_map
, Qnil
);
9827 specbind (Qoverriding_local_map
, Qnil
);
9832 /* Run the Lucid hook. */
9833 safe_run_hooks (Qactivate_menubar_hook
);
9835 /* If it has changed current-menubar from previous value,
9836 really recompute the menu-bar from the value. */
9837 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9838 call0 (Qrecompute_lucid_menubar
);
9840 safe_run_hooks (Qmenu_bar_update_hook
);
9845 XSETFRAME (Vmenu_updating_frame
, f
);
9846 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9848 /* Redisplay the menu bar in case we changed it. */
9849 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9850 || defined (HAVE_NS) || defined (USE_GTK)
9851 if (FRAME_WINDOW_P (f
))
9853 #if defined (HAVE_NS)
9854 /* All frames on Mac OS share the same menubar. So only
9855 the selected frame should be allowed to set it. */
9856 if (f
== SELECTED_FRAME ())
9858 set_frame_menubar (f
, 0, 0);
9861 /* On a terminal screen, the menu bar is an ordinary screen
9862 line, and this makes it get updated. */
9863 w
->update_mode_line
= Qt
;
9864 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9865 /* In the non-toolkit version, the menu bar is an ordinary screen
9866 line, and this makes it get updated. */
9867 w
->update_mode_line
= Qt
;
9868 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9870 unbind_to (count
, Qnil
);
9871 set_buffer_internal_1 (prev
);
9880 /***********************************************************************
9882 ***********************************************************************/
9884 #ifdef HAVE_WINDOW_SYSTEM
9887 Nominal cursor position -- where to draw output.
9888 HPOS and VPOS are window relative glyph matrix coordinates.
9889 X and Y are window relative pixel coordinates. */
9891 struct cursor_pos output_cursor
;
9895 Set the global variable output_cursor to CURSOR. All cursor
9896 positions are relative to updated_window. */
9899 set_output_cursor (struct cursor_pos
*cursor
)
9901 output_cursor
.hpos
= cursor
->hpos
;
9902 output_cursor
.vpos
= cursor
->vpos
;
9903 output_cursor
.x
= cursor
->x
;
9904 output_cursor
.y
= cursor
->y
;
9909 Set a nominal cursor position.
9911 HPOS and VPOS are column/row positions in a window glyph matrix. X
9912 and Y are window text area relative pixel positions.
9914 If this is done during an update, updated_window will contain the
9915 window that is being updated and the position is the future output
9916 cursor position for that window. If updated_window is null, use
9917 selected_window and display the cursor at the given position. */
9920 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9924 /* If updated_window is not set, work on selected_window. */
9928 w
= XWINDOW (selected_window
);
9930 /* Set the output cursor. */
9931 output_cursor
.hpos
= hpos
;
9932 output_cursor
.vpos
= vpos
;
9933 output_cursor
.x
= x
;
9934 output_cursor
.y
= y
;
9936 /* If not called as part of an update, really display the cursor.
9937 This will also set the cursor position of W. */
9938 if (updated_window
== NULL
)
9941 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9942 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9943 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9948 #endif /* HAVE_WINDOW_SYSTEM */
9951 /***********************************************************************
9953 ***********************************************************************/
9955 #ifdef HAVE_WINDOW_SYSTEM
9957 /* Where the mouse was last time we reported a mouse event. */
9959 FRAME_PTR last_mouse_frame
;
9961 /* Tool-bar item index of the item on which a mouse button was pressed
9964 int last_tool_bar_item
;
9968 update_tool_bar_unwind (Lisp_Object frame
)
9970 selected_frame
= frame
;
9974 /* Update the tool-bar item list for frame F. This has to be done
9975 before we start to fill in any display lines. Called from
9976 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9977 and restore it here. */
9980 update_tool_bar (struct frame
*f
, int save_match_data
)
9982 #if defined (USE_GTK) || defined (HAVE_NS)
9983 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9985 int do_update
= WINDOWP (f
->tool_bar_window
)
9986 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9994 window
= FRAME_SELECTED_WINDOW (f
);
9995 w
= XWINDOW (window
);
9997 /* If the user has switched buffers or windows, we need to
9998 recompute to reflect the new bindings. But we'll
9999 recompute when update_mode_lines is set too; that means
10000 that people can use force-mode-line-update to request
10001 that the menu bar be recomputed. The adverse effect on
10002 the rest of the redisplay algorithm is about the same as
10003 windows_or_buffers_changed anyway. */
10004 if (windows_or_buffers_changed
10005 || !NILP (w
->update_mode_line
)
10006 || update_mode_lines
10007 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10008 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10009 != !NILP (w
->last_had_star
))
10010 || ((!NILP (Vtransient_mark_mode
)
10011 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10012 != !NILP (w
->region_showing
)))
10014 struct buffer
*prev
= current_buffer
;
10015 int count
= SPECPDL_INDEX ();
10016 Lisp_Object frame
, new_tool_bar
;
10017 int new_n_tool_bar
;
10018 struct gcpro gcpro1
;
10020 /* Set current_buffer to the buffer of the selected
10021 window of the frame, so that we get the right local
10023 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10025 /* Save match data, if we must. */
10026 if (save_match_data
)
10027 record_unwind_save_match_data ();
10029 /* Make sure that we don't accidentally use bogus keymaps. */
10030 if (NILP (Voverriding_local_map_menu_flag
))
10032 specbind (Qoverriding_terminal_local_map
, Qnil
);
10033 specbind (Qoverriding_local_map
, Qnil
);
10036 GCPRO1 (new_tool_bar
);
10038 /* We must temporarily set the selected frame to this frame
10039 before calling tool_bar_items, because the calculation of
10040 the tool-bar keymap uses the selected frame (see
10041 `tool-bar-make-keymap' in tool-bar.el). */
10042 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10043 XSETFRAME (frame
, f
);
10044 selected_frame
= frame
;
10046 /* Build desired tool-bar items from keymaps. */
10047 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10050 /* Redisplay the tool-bar if we changed it. */
10051 if (new_n_tool_bar
!= f
->n_tool_bar_items
10052 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10054 /* Redisplay that happens asynchronously due to an expose event
10055 may access f->tool_bar_items. Make sure we update both
10056 variables within BLOCK_INPUT so no such event interrupts. */
10058 f
->tool_bar_items
= new_tool_bar
;
10059 f
->n_tool_bar_items
= new_n_tool_bar
;
10060 w
->update_mode_line
= Qt
;
10066 unbind_to (count
, Qnil
);
10067 set_buffer_internal_1 (prev
);
10073 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10074 F's desired tool-bar contents. F->tool_bar_items must have
10075 been set up previously by calling prepare_menu_bars. */
10078 build_desired_tool_bar_string (struct frame
*f
)
10080 int i
, size
, size_needed
;
10081 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10082 Lisp_Object image
, plist
, props
;
10084 image
= plist
= props
= Qnil
;
10085 GCPRO3 (image
, plist
, props
);
10087 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10088 Otherwise, make a new string. */
10090 /* The size of the string we might be able to reuse. */
10091 size
= (STRINGP (f
->desired_tool_bar_string
)
10092 ? SCHARS (f
->desired_tool_bar_string
)
10095 /* We need one space in the string for each image. */
10096 size_needed
= f
->n_tool_bar_items
;
10098 /* Reuse f->desired_tool_bar_string, if possible. */
10099 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10100 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10101 make_number (' '));
10104 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10105 Fremove_text_properties (make_number (0), make_number (size
),
10106 props
, f
->desired_tool_bar_string
);
10109 /* Put a `display' property on the string for the images to display,
10110 put a `menu_item' property on tool-bar items with a value that
10111 is the index of the item in F's tool-bar item vector. */
10112 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10114 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10116 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10117 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10118 int hmargin
, vmargin
, relief
, idx
, end
;
10120 /* If image is a vector, choose the image according to the
10122 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10123 if (VECTORP (image
))
10127 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10128 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10131 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10132 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10134 xassert (ASIZE (image
) >= idx
);
10135 image
= AREF (image
, idx
);
10140 /* Ignore invalid image specifications. */
10141 if (!valid_image_p (image
))
10144 /* Display the tool-bar button pressed, or depressed. */
10145 plist
= Fcopy_sequence (XCDR (image
));
10147 /* Compute margin and relief to draw. */
10148 relief
= (tool_bar_button_relief
>= 0
10149 ? tool_bar_button_relief
10150 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10151 hmargin
= vmargin
= relief
;
10153 if (INTEGERP (Vtool_bar_button_margin
)
10154 && XINT (Vtool_bar_button_margin
) > 0)
10156 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10157 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10159 else if (CONSP (Vtool_bar_button_margin
))
10161 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10162 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10163 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10165 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10166 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10167 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10170 if (auto_raise_tool_bar_buttons_p
)
10172 /* Add a `:relief' property to the image spec if the item is
10176 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10183 /* If image is selected, display it pressed, i.e. with a
10184 negative relief. If it's not selected, display it with a
10186 plist
= Fplist_put (plist
, QCrelief
,
10188 ? make_number (-relief
)
10189 : make_number (relief
)));
10194 /* Put a margin around the image. */
10195 if (hmargin
|| vmargin
)
10197 if (hmargin
== vmargin
)
10198 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10200 plist
= Fplist_put (plist
, QCmargin
,
10201 Fcons (make_number (hmargin
),
10202 make_number (vmargin
)));
10205 /* If button is not enabled, and we don't have special images
10206 for the disabled state, make the image appear disabled by
10207 applying an appropriate algorithm to it. */
10208 if (!enabled_p
&& idx
< 0)
10209 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10211 /* Put a `display' text property on the string for the image to
10212 display. Put a `menu-item' property on the string that gives
10213 the start of this item's properties in the tool-bar items
10215 image
= Fcons (Qimage
, plist
);
10216 props
= list4 (Qdisplay
, image
,
10217 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10219 /* Let the last image hide all remaining spaces in the tool bar
10220 string. The string can be longer than needed when we reuse a
10221 previous string. */
10222 if (i
+ 1 == f
->n_tool_bar_items
)
10223 end
= SCHARS (f
->desired_tool_bar_string
);
10226 Fadd_text_properties (make_number (i
), make_number (end
),
10227 props
, f
->desired_tool_bar_string
);
10235 /* Display one line of the tool-bar of frame IT->f.
10237 HEIGHT specifies the desired height of the tool-bar line.
10238 If the actual height of the glyph row is less than HEIGHT, the
10239 row's height is increased to HEIGHT, and the icons are centered
10240 vertically in the new height.
10242 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10243 count a final empty row in case the tool-bar width exactly matches
10248 display_tool_bar_line (struct it
*it
, int height
)
10250 struct glyph_row
*row
= it
->glyph_row
;
10251 int max_x
= it
->last_visible_x
;
10252 struct glyph
*last
;
10254 prepare_desired_row (row
);
10255 row
->y
= it
->current_y
;
10257 /* Note that this isn't made use of if the face hasn't a box,
10258 so there's no need to check the face here. */
10259 it
->start_of_box_run_p
= 1;
10261 while (it
->current_x
< max_x
)
10263 int x
, n_glyphs_before
, i
, nglyphs
;
10264 struct it it_before
;
10266 /* Get the next display element. */
10267 if (!get_next_display_element (it
))
10269 /* Don't count empty row if we are counting needed tool-bar lines. */
10270 if (height
< 0 && !it
->hpos
)
10275 /* Produce glyphs. */
10276 n_glyphs_before
= row
->used
[TEXT_AREA
];
10279 PRODUCE_GLYPHS (it
);
10281 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10283 x
= it_before
.current_x
;
10284 while (i
< nglyphs
)
10286 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10288 if (x
+ glyph
->pixel_width
> max_x
)
10290 /* Glyph doesn't fit on line. Backtrack. */
10291 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10293 /* If this is the only glyph on this line, it will never fit on the
10294 tool-bar, so skip it. But ensure there is at least one glyph,
10295 so we don't accidentally disable the tool-bar. */
10296 if (n_glyphs_before
== 0
10297 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10303 x
+= glyph
->pixel_width
;
10307 /* Stop at line ends. */
10308 if (ITERATOR_AT_END_OF_LINE_P (it
))
10311 set_iterator_to_next (it
, 1);
10316 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10318 /* Use default face for the border below the tool bar.
10320 FIXME: When auto-resize-tool-bars is grow-only, there is
10321 no additional border below the possibly empty tool-bar lines.
10322 So to make the extra empty lines look "normal", we have to
10323 use the tool-bar face for the border too. */
10324 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10325 it
->face_id
= DEFAULT_FACE_ID
;
10327 extend_face_to_end_of_line (it
);
10328 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10329 last
->right_box_line_p
= 1;
10330 if (last
== row
->glyphs
[TEXT_AREA
])
10331 last
->left_box_line_p
= 1;
10333 /* Make line the desired height and center it vertically. */
10334 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10336 /* Don't add more than one line height. */
10337 height
%= FRAME_LINE_HEIGHT (it
->f
);
10338 it
->max_ascent
+= height
/ 2;
10339 it
->max_descent
+= (height
+ 1) / 2;
10342 compute_line_metrics (it
);
10344 /* If line is empty, make it occupy the rest of the tool-bar. */
10345 if (!row
->displays_text_p
)
10347 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10348 row
->visible_height
= row
->height
;
10349 row
->ascent
= row
->phys_ascent
= 0;
10350 row
->extra_line_spacing
= 0;
10353 row
->full_width_p
= 1;
10354 row
->continued_p
= 0;
10355 row
->truncated_on_left_p
= 0;
10356 row
->truncated_on_right_p
= 0;
10358 it
->current_x
= it
->hpos
= 0;
10359 it
->current_y
+= row
->height
;
10365 /* Max tool-bar height. */
10367 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10368 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10370 /* Value is the number of screen lines needed to make all tool-bar
10371 items of frame F visible. The number of actual rows needed is
10372 returned in *N_ROWS if non-NULL. */
10375 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10377 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10379 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10380 the desired matrix, so use (unused) mode-line row as temporary row to
10381 avoid destroying the first tool-bar row. */
10382 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10384 /* Initialize an iterator for iteration over
10385 F->desired_tool_bar_string in the tool-bar window of frame F. */
10386 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10387 it
.first_visible_x
= 0;
10388 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10389 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10391 while (!ITERATOR_AT_END_P (&it
))
10393 clear_glyph_row (temp_row
);
10394 it
.glyph_row
= temp_row
;
10395 display_tool_bar_line (&it
, -1);
10397 clear_glyph_row (temp_row
);
10399 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10401 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10403 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10407 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10409 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10410 (Lisp_Object frame
)
10417 frame
= selected_frame
;
10419 CHECK_FRAME (frame
);
10420 f
= XFRAME (frame
);
10422 if (WINDOWP (f
->tool_bar_window
)
10423 || (w
= XWINDOW (f
->tool_bar_window
),
10424 WINDOW_TOTAL_LINES (w
) > 0))
10426 update_tool_bar (f
, 1);
10427 if (f
->n_tool_bar_items
)
10429 build_desired_tool_bar_string (f
);
10430 nlines
= tool_bar_lines_needed (f
, NULL
);
10434 return make_number (nlines
);
10438 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10439 height should be changed. */
10442 redisplay_tool_bar (struct frame
*f
)
10446 struct glyph_row
*row
;
10448 #if defined (USE_GTK) || defined (HAVE_NS)
10449 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10450 update_frame_tool_bar (f
);
10454 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10455 do anything. This means you must start with tool-bar-lines
10456 non-zero to get the auto-sizing effect. Or in other words, you
10457 can turn off tool-bars by specifying tool-bar-lines zero. */
10458 if (!WINDOWP (f
->tool_bar_window
)
10459 || (w
= XWINDOW (f
->tool_bar_window
),
10460 WINDOW_TOTAL_LINES (w
) == 0))
10463 /* Set up an iterator for the tool-bar window. */
10464 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10465 it
.first_visible_x
= 0;
10466 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10467 row
= it
.glyph_row
;
10469 /* Build a string that represents the contents of the tool-bar. */
10470 build_desired_tool_bar_string (f
);
10471 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10473 if (f
->n_tool_bar_rows
== 0)
10477 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10478 nlines
!= WINDOW_TOTAL_LINES (w
)))
10481 int old_height
= WINDOW_TOTAL_LINES (w
);
10483 XSETFRAME (frame
, f
);
10484 Fmodify_frame_parameters (frame
,
10485 Fcons (Fcons (Qtool_bar_lines
,
10486 make_number (nlines
)),
10488 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10490 clear_glyph_matrix (w
->desired_matrix
);
10491 fonts_changed_p
= 1;
10497 /* Display as many lines as needed to display all tool-bar items. */
10499 if (f
->n_tool_bar_rows
> 0)
10501 int border
, rows
, height
, extra
;
10503 if (INTEGERP (Vtool_bar_border
))
10504 border
= XINT (Vtool_bar_border
);
10505 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10506 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10507 else if (EQ (Vtool_bar_border
, Qborder_width
))
10508 border
= f
->border_width
;
10514 rows
= f
->n_tool_bar_rows
;
10515 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10516 extra
= it
.last_visible_y
- border
- height
* rows
;
10518 while (it
.current_y
< it
.last_visible_y
)
10521 if (extra
> 0 && rows
-- > 0)
10523 h
= (extra
+ rows
- 1) / rows
;
10526 display_tool_bar_line (&it
, height
+ h
);
10531 while (it
.current_y
< it
.last_visible_y
)
10532 display_tool_bar_line (&it
, 0);
10535 /* It doesn't make much sense to try scrolling in the tool-bar
10536 window, so don't do it. */
10537 w
->desired_matrix
->no_scrolling_p
= 1;
10538 w
->must_be_updated_p
= 1;
10540 if (!NILP (Vauto_resize_tool_bars
))
10542 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10543 int change_height_p
= 0;
10545 /* If we couldn't display everything, change the tool-bar's
10546 height if there is room for more. */
10547 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10548 && it
.current_y
< max_tool_bar_height
)
10549 change_height_p
= 1;
10551 row
= it
.glyph_row
- 1;
10553 /* If there are blank lines at the end, except for a partially
10554 visible blank line at the end that is smaller than
10555 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10556 if (!row
->displays_text_p
10557 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10558 change_height_p
= 1;
10560 /* If row displays tool-bar items, but is partially visible,
10561 change the tool-bar's height. */
10562 if (row
->displays_text_p
10563 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10564 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10565 change_height_p
= 1;
10567 /* Resize windows as needed by changing the `tool-bar-lines'
10568 frame parameter. */
10569 if (change_height_p
)
10572 int old_height
= WINDOW_TOTAL_LINES (w
);
10574 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10576 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10577 && !f
->minimize_tool_bar_window_p
)
10578 ? (nlines
> old_height
)
10579 : (nlines
!= old_height
));
10580 f
->minimize_tool_bar_window_p
= 0;
10582 if (change_height_p
)
10584 XSETFRAME (frame
, f
);
10585 Fmodify_frame_parameters (frame
,
10586 Fcons (Fcons (Qtool_bar_lines
,
10587 make_number (nlines
)),
10589 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10591 clear_glyph_matrix (w
->desired_matrix
);
10592 f
->n_tool_bar_rows
= nrows
;
10593 fonts_changed_p
= 1;
10600 f
->minimize_tool_bar_window_p
= 0;
10605 /* Get information about the tool-bar item which is displayed in GLYPH
10606 on frame F. Return in *PROP_IDX the index where tool-bar item
10607 properties start in F->tool_bar_items. Value is zero if
10608 GLYPH doesn't display a tool-bar item. */
10611 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10617 /* This function can be called asynchronously, which means we must
10618 exclude any possibility that Fget_text_property signals an
10620 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10621 charpos
= max (0, charpos
);
10623 /* Get the text property `menu-item' at pos. The value of that
10624 property is the start index of this item's properties in
10625 F->tool_bar_items. */
10626 prop
= Fget_text_property (make_number (charpos
),
10627 Qmenu_item
, f
->current_tool_bar_string
);
10628 if (INTEGERP (prop
))
10630 *prop_idx
= XINT (prop
);
10640 /* Get information about the tool-bar item at position X/Y on frame F.
10641 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10642 the current matrix of the tool-bar window of F, or NULL if not
10643 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10644 item in F->tool_bar_items. Value is
10646 -1 if X/Y is not on a tool-bar item
10647 0 if X/Y is on the same item that was highlighted before.
10651 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10652 int *hpos
, int *vpos
, int *prop_idx
)
10654 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10655 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10658 /* Find the glyph under X/Y. */
10659 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10660 if (*glyph
== NULL
)
10663 /* Get the start of this tool-bar item's properties in
10664 f->tool_bar_items. */
10665 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10668 /* Is mouse on the highlighted item? */
10669 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10670 && *vpos
>= hlinfo
->mouse_face_beg_row
10671 && *vpos
<= hlinfo
->mouse_face_end_row
10672 && (*vpos
> hlinfo
->mouse_face_beg_row
10673 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10674 && (*vpos
< hlinfo
->mouse_face_end_row
10675 || *hpos
< hlinfo
->mouse_face_end_col
10676 || hlinfo
->mouse_face_past_end
))
10684 Handle mouse button event on the tool-bar of frame F, at
10685 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10686 0 for button release. MODIFIERS is event modifiers for button
10690 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10691 unsigned int modifiers
)
10693 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10694 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10695 int hpos
, vpos
, prop_idx
;
10696 struct glyph
*glyph
;
10697 Lisp_Object enabled_p
;
10699 /* If not on the highlighted tool-bar item, return. */
10700 frame_to_window_pixel_xy (w
, &x
, &y
);
10701 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10704 /* If item is disabled, do nothing. */
10705 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10706 if (NILP (enabled_p
))
10711 /* Show item in pressed state. */
10712 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10713 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10714 last_tool_bar_item
= prop_idx
;
10718 Lisp_Object key
, frame
;
10719 struct input_event event
;
10720 EVENT_INIT (event
);
10722 /* Show item in released state. */
10723 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10724 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10726 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10728 XSETFRAME (frame
, f
);
10729 event
.kind
= TOOL_BAR_EVENT
;
10730 event
.frame_or_window
= frame
;
10732 kbd_buffer_store_event (&event
);
10734 event
.kind
= TOOL_BAR_EVENT
;
10735 event
.frame_or_window
= frame
;
10737 event
.modifiers
= modifiers
;
10738 kbd_buffer_store_event (&event
);
10739 last_tool_bar_item
= -1;
10744 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10745 tool-bar window-relative coordinates X/Y. Called from
10746 note_mouse_highlight. */
10749 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10751 Lisp_Object window
= f
->tool_bar_window
;
10752 struct window
*w
= XWINDOW (window
);
10753 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10754 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10756 struct glyph
*glyph
;
10757 struct glyph_row
*row
;
10759 Lisp_Object enabled_p
;
10761 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10762 int mouse_down_p
, rc
;
10764 /* Function note_mouse_highlight is called with negative X/Y
10765 values when mouse moves outside of the frame. */
10766 if (x
<= 0 || y
<= 0)
10768 clear_mouse_face (hlinfo
);
10772 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10775 /* Not on tool-bar item. */
10776 clear_mouse_face (hlinfo
);
10780 /* On same tool-bar item as before. */
10781 goto set_help_echo
;
10783 clear_mouse_face (hlinfo
);
10785 /* Mouse is down, but on different tool-bar item? */
10786 mouse_down_p
= (dpyinfo
->grabbed
10787 && f
== last_mouse_frame
10788 && FRAME_LIVE_P (f
));
10790 && last_tool_bar_item
!= prop_idx
)
10793 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10794 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10796 /* If tool-bar item is not enabled, don't highlight it. */
10797 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10798 if (!NILP (enabled_p
))
10800 /* Compute the x-position of the glyph. In front and past the
10801 image is a space. We include this in the highlighted area. */
10802 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10803 for (i
= x
= 0; i
< hpos
; ++i
)
10804 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10806 /* Record this as the current active region. */
10807 hlinfo
->mouse_face_beg_col
= hpos
;
10808 hlinfo
->mouse_face_beg_row
= vpos
;
10809 hlinfo
->mouse_face_beg_x
= x
;
10810 hlinfo
->mouse_face_beg_y
= row
->y
;
10811 hlinfo
->mouse_face_past_end
= 0;
10813 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10814 hlinfo
->mouse_face_end_row
= vpos
;
10815 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10816 hlinfo
->mouse_face_end_y
= row
->y
;
10817 hlinfo
->mouse_face_window
= window
;
10818 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10820 /* Display it as active. */
10821 show_mouse_face (hlinfo
, draw
);
10822 hlinfo
->mouse_face_image_state
= draw
;
10827 /* Set help_echo_string to a help string to display for this tool-bar item.
10828 XTread_socket does the rest. */
10829 help_echo_object
= help_echo_window
= Qnil
;
10830 help_echo_pos
= -1;
10831 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10832 if (NILP (help_echo_string
))
10833 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10836 #endif /* HAVE_WINDOW_SYSTEM */
10840 /************************************************************************
10841 Horizontal scrolling
10842 ************************************************************************/
10844 static int hscroll_window_tree (Lisp_Object
);
10845 static int hscroll_windows (Lisp_Object
);
10847 /* For all leaf windows in the window tree rooted at WINDOW, set their
10848 hscroll value so that PT is (i) visible in the window, and (ii) so
10849 that it is not within a certain margin at the window's left and
10850 right border. Value is non-zero if any window's hscroll has been
10854 hscroll_window_tree (Lisp_Object window
)
10856 int hscrolled_p
= 0;
10857 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10858 int hscroll_step_abs
= 0;
10859 double hscroll_step_rel
= 0;
10861 if (hscroll_relative_p
)
10863 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10864 if (hscroll_step_rel
< 0)
10866 hscroll_relative_p
= 0;
10867 hscroll_step_abs
= 0;
10870 else if (INTEGERP (Vhscroll_step
))
10872 hscroll_step_abs
= XINT (Vhscroll_step
);
10873 if (hscroll_step_abs
< 0)
10874 hscroll_step_abs
= 0;
10877 hscroll_step_abs
= 0;
10879 while (WINDOWP (window
))
10881 struct window
*w
= XWINDOW (window
);
10883 if (WINDOWP (w
->hchild
))
10884 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10885 else if (WINDOWP (w
->vchild
))
10886 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10887 else if (w
->cursor
.vpos
>= 0)
10890 int text_area_width
;
10891 struct glyph_row
*current_cursor_row
10892 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10893 struct glyph_row
*desired_cursor_row
10894 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10895 struct glyph_row
*cursor_row
10896 = (desired_cursor_row
->enabled_p
10897 ? desired_cursor_row
10898 : current_cursor_row
);
10900 text_area_width
= window_box_width (w
, TEXT_AREA
);
10902 /* Scroll when cursor is inside this scroll margin. */
10903 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10905 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10906 && ((XFASTINT (w
->hscroll
)
10907 && w
->cursor
.x
<= h_margin
)
10908 || (cursor_row
->enabled_p
10909 && cursor_row
->truncated_on_right_p
10910 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10914 struct buffer
*saved_current_buffer
;
10918 /* Find point in a display of infinite width. */
10919 saved_current_buffer
= current_buffer
;
10920 current_buffer
= XBUFFER (w
->buffer
);
10922 if (w
== XWINDOW (selected_window
))
10926 pt
= marker_position (w
->pointm
);
10927 pt
= max (BEGV
, pt
);
10931 /* Move iterator to pt starting at cursor_row->start in
10932 a line with infinite width. */
10933 init_to_row_start (&it
, w
, cursor_row
);
10934 it
.last_visible_x
= INFINITY
;
10935 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10936 current_buffer
= saved_current_buffer
;
10938 /* Position cursor in window. */
10939 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10940 hscroll
= max (0, (it
.current_x
10941 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10942 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10943 : (text_area_width
/ 2))))
10944 / FRAME_COLUMN_WIDTH (it
.f
);
10945 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10947 if (hscroll_relative_p
)
10948 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10951 wanted_x
= text_area_width
10952 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10955 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10959 if (hscroll_relative_p
)
10960 wanted_x
= text_area_width
* hscroll_step_rel
10963 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10966 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10968 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10970 /* Don't call Fset_window_hscroll if value hasn't
10971 changed because it will prevent redisplay
10973 if (XFASTINT (w
->hscroll
) != hscroll
)
10975 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10976 w
->hscroll
= make_number (hscroll
);
10985 /* Value is non-zero if hscroll of any leaf window has been changed. */
10986 return hscrolled_p
;
10990 /* Set hscroll so that cursor is visible and not inside horizontal
10991 scroll margins for all windows in the tree rooted at WINDOW. See
10992 also hscroll_window_tree above. Value is non-zero if any window's
10993 hscroll has been changed. If it has, desired matrices on the frame
10994 of WINDOW are cleared. */
10997 hscroll_windows (Lisp_Object window
)
10999 int hscrolled_p
= hscroll_window_tree (window
);
11001 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11002 return hscrolled_p
;
11007 /************************************************************************
11009 ************************************************************************/
11011 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11012 to a non-zero value. This is sometimes handy to have in a debugger
11017 /* First and last unchanged row for try_window_id. */
11019 int debug_first_unchanged_at_end_vpos
;
11020 int debug_last_unchanged_at_beg_vpos
;
11022 /* Delta vpos and y. */
11024 int debug_dvpos
, debug_dy
;
11026 /* Delta in characters and bytes for try_window_id. */
11028 EMACS_INT debug_delta
, debug_delta_bytes
;
11030 /* Values of window_end_pos and window_end_vpos at the end of
11033 EMACS_INT debug_end_vpos
;
11035 /* Append a string to W->desired_matrix->method. FMT is a printf
11036 format string. A1...A9 are a supplement for a variable-length
11037 argument list. If trace_redisplay_p is non-zero also printf the
11038 resulting string to stderr. */
11041 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11044 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11047 char *method
= w
->desired_matrix
->method
;
11048 int len
= strlen (method
);
11049 int size
= sizeof w
->desired_matrix
->method
;
11050 int remaining
= size
- len
- 1;
11052 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11053 if (len
&& remaining
)
11056 --remaining
, ++len
;
11059 strncpy (method
+ len
, buffer
, remaining
);
11061 if (trace_redisplay_p
)
11062 fprintf (stderr
, "%p (%s): %s\n",
11064 ((BUFFERP (w
->buffer
)
11065 && STRINGP (XBUFFER (w
->buffer
)->name
))
11066 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11071 #endif /* GLYPH_DEBUG */
11074 /* Value is non-zero if all changes in window W, which displays
11075 current_buffer, are in the text between START and END. START is a
11076 buffer position, END is given as a distance from Z. Used in
11077 redisplay_internal for display optimization. */
11080 text_outside_line_unchanged_p (struct window
*w
,
11081 EMACS_INT start
, EMACS_INT end
)
11083 int unchanged_p
= 1;
11085 /* If text or overlays have changed, see where. */
11086 if (XFASTINT (w
->last_modified
) < MODIFF
11087 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11089 /* Gap in the line? */
11090 if (GPT
< start
|| Z
- GPT
< end
)
11093 /* Changes start in front of the line, or end after it? */
11095 && (BEG_UNCHANGED
< start
- 1
11096 || END_UNCHANGED
< end
))
11099 /* If selective display, can't optimize if changes start at the
11100 beginning of the line. */
11102 && INTEGERP (BVAR (current_buffer
, selective_display
))
11103 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11104 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11107 /* If there are overlays at the start or end of the line, these
11108 may have overlay strings with newlines in them. A change at
11109 START, for instance, may actually concern the display of such
11110 overlay strings as well, and they are displayed on different
11111 lines. So, quickly rule out this case. (For the future, it
11112 might be desirable to implement something more telling than
11113 just BEG/END_UNCHANGED.) */
11116 if (BEG
+ BEG_UNCHANGED
== start
11117 && overlay_touches_p (start
))
11119 if (END_UNCHANGED
== end
11120 && overlay_touches_p (Z
- end
))
11124 /* Under bidi reordering, adding or deleting a character in the
11125 beginning of a paragraph, before the first strong directional
11126 character, can change the base direction of the paragraph (unless
11127 the buffer specifies a fixed paragraph direction), which will
11128 require to redisplay the whole paragraph. It might be worthwhile
11129 to find the paragraph limits and widen the range of redisplayed
11130 lines to that, but for now just give up this optimization. */
11131 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11132 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11136 return unchanged_p
;
11140 /* Do a frame update, taking possible shortcuts into account. This is
11141 the main external entry point for redisplay.
11143 If the last redisplay displayed an echo area message and that message
11144 is no longer requested, we clear the echo area or bring back the
11145 mini-buffer if that is in use. */
11150 redisplay_internal ();
11155 overlay_arrow_string_or_property (Lisp_Object var
)
11159 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11162 return Voverlay_arrow_string
;
11165 /* Return 1 if there are any overlay-arrows in current_buffer. */
11167 overlay_arrow_in_current_buffer_p (void)
11171 for (vlist
= Voverlay_arrow_variable_list
;
11173 vlist
= XCDR (vlist
))
11175 Lisp_Object var
= XCAR (vlist
);
11178 if (!SYMBOLP (var
))
11180 val
= find_symbol_value (var
);
11182 && current_buffer
== XMARKER (val
)->buffer
)
11189 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11193 overlay_arrows_changed_p (void)
11197 for (vlist
= Voverlay_arrow_variable_list
;
11199 vlist
= XCDR (vlist
))
11201 Lisp_Object var
= XCAR (vlist
);
11202 Lisp_Object val
, pstr
;
11204 if (!SYMBOLP (var
))
11206 val
= find_symbol_value (var
);
11207 if (!MARKERP (val
))
11209 if (! EQ (COERCE_MARKER (val
),
11210 Fget (var
, Qlast_arrow_position
))
11211 || ! (pstr
= overlay_arrow_string_or_property (var
),
11212 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11218 /* Mark overlay arrows to be updated on next redisplay. */
11221 update_overlay_arrows (int up_to_date
)
11225 for (vlist
= Voverlay_arrow_variable_list
;
11227 vlist
= XCDR (vlist
))
11229 Lisp_Object var
= XCAR (vlist
);
11231 if (!SYMBOLP (var
))
11234 if (up_to_date
> 0)
11236 Lisp_Object val
= find_symbol_value (var
);
11237 Fput (var
, Qlast_arrow_position
,
11238 COERCE_MARKER (val
));
11239 Fput (var
, Qlast_arrow_string
,
11240 overlay_arrow_string_or_property (var
));
11242 else if (up_to_date
< 0
11243 || !NILP (Fget (var
, Qlast_arrow_position
)))
11245 Fput (var
, Qlast_arrow_position
, Qt
);
11246 Fput (var
, Qlast_arrow_string
, Qt
);
11252 /* Return overlay arrow string to display at row.
11253 Return integer (bitmap number) for arrow bitmap in left fringe.
11254 Return nil if no overlay arrow. */
11257 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11261 for (vlist
= Voverlay_arrow_variable_list
;
11263 vlist
= XCDR (vlist
))
11265 Lisp_Object var
= XCAR (vlist
);
11268 if (!SYMBOLP (var
))
11271 val
= find_symbol_value (var
);
11274 && current_buffer
== XMARKER (val
)->buffer
11275 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11277 if (FRAME_WINDOW_P (it
->f
)
11278 /* FIXME: if ROW->reversed_p is set, this should test
11279 the right fringe, not the left one. */
11280 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11282 #ifdef HAVE_WINDOW_SYSTEM
11283 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11286 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11287 return make_number (fringe_bitmap
);
11290 return make_number (-1); /* Use default arrow bitmap */
11292 return overlay_arrow_string_or_property (var
);
11299 /* Return 1 if point moved out of or into a composition. Otherwise
11300 return 0. PREV_BUF and PREV_PT are the last point buffer and
11301 position. BUF and PT are the current point buffer and position. */
11304 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11305 struct buffer
*buf
, EMACS_INT pt
)
11307 EMACS_INT start
, end
;
11309 Lisp_Object buffer
;
11311 XSETBUFFER (buffer
, buf
);
11312 /* Check a composition at the last point if point moved within the
11314 if (prev_buf
== buf
)
11317 /* Point didn't move. */
11320 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11321 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11322 && COMPOSITION_VALID_P (start
, end
, prop
)
11323 && start
< prev_pt
&& end
> prev_pt
)
11324 /* The last point was within the composition. Return 1 iff
11325 point moved out of the composition. */
11326 return (pt
<= start
|| pt
>= end
);
11329 /* Check a composition at the current point. */
11330 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11331 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11332 && COMPOSITION_VALID_P (start
, end
, prop
)
11333 && start
< pt
&& end
> pt
);
11337 /* Reconsider the setting of B->clip_changed which is displayed
11341 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11343 if (b
->clip_changed
11344 && !NILP (w
->window_end_valid
)
11345 && w
->current_matrix
->buffer
== b
11346 && w
->current_matrix
->zv
== BUF_ZV (b
)
11347 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11348 b
->clip_changed
= 0;
11350 /* If display wasn't paused, and W is not a tool bar window, see if
11351 point has been moved into or out of a composition. In that case,
11352 we set b->clip_changed to 1 to force updating the screen. If
11353 b->clip_changed has already been set to 1, we can skip this
11355 if (!b
->clip_changed
11356 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11360 if (w
== XWINDOW (selected_window
))
11363 pt
= marker_position (w
->pointm
);
11365 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11366 || pt
!= XINT (w
->last_point
))
11367 && check_point_in_composition (w
->current_matrix
->buffer
,
11368 XINT (w
->last_point
),
11369 XBUFFER (w
->buffer
), pt
))
11370 b
->clip_changed
= 1;
11375 /* Select FRAME to forward the values of frame-local variables into C
11376 variables so that the redisplay routines can access those values
11380 select_frame_for_redisplay (Lisp_Object frame
)
11382 Lisp_Object tail
, tem
;
11383 Lisp_Object old
= selected_frame
;
11384 struct Lisp_Symbol
*sym
;
11386 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11388 selected_frame
= frame
;
11391 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11392 if (CONSP (XCAR (tail
))
11393 && (tem
= XCAR (XCAR (tail
)),
11395 && (sym
= indirect_variable (XSYMBOL (tem
)),
11396 sym
->redirect
== SYMBOL_LOCALIZED
)
11397 && sym
->val
.blv
->frame_local
)
11398 /* Use find_symbol_value rather than Fsymbol_value
11399 to avoid an error if it is void. */
11400 find_symbol_value (tem
);
11401 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11405 #define STOP_POLLING \
11406 do { if (! polling_stopped_here) stop_polling (); \
11407 polling_stopped_here = 1; } while (0)
11409 #define RESUME_POLLING \
11410 do { if (polling_stopped_here) start_polling (); \
11411 polling_stopped_here = 0; } while (0)
11414 /* Perhaps in the future avoid recentering windows if it
11415 is not necessary; currently that causes some problems. */
11418 redisplay_internal ()
11420 struct window
*w
= XWINDOW (selected_window
);
11424 int must_finish
= 0;
11425 struct text_pos tlbufpos
, tlendpos
;
11426 int number_of_visible_frames
;
11429 int polling_stopped_here
= 0;
11430 Lisp_Object old_frame
= selected_frame
;
11432 /* Non-zero means redisplay has to consider all windows on all
11433 frames. Zero means, only selected_window is considered. */
11434 int consider_all_windows_p
;
11436 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11438 /* No redisplay if running in batch mode or frame is not yet fully
11439 initialized, or redisplay is explicitly turned off by setting
11440 Vinhibit_redisplay. */
11441 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11442 || !NILP (Vinhibit_redisplay
))
11445 /* Don't examine these until after testing Vinhibit_redisplay.
11446 When Emacs is shutting down, perhaps because its connection to
11447 X has dropped, we should not look at them at all. */
11448 fr
= XFRAME (w
->frame
);
11449 sf
= SELECTED_FRAME ();
11451 if (!fr
->glyphs_initialized_p
)
11454 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11455 if (popup_activated ())
11459 /* I don't think this happens but let's be paranoid. */
11460 if (redisplaying_p
)
11463 /* Record a function that resets redisplaying_p to its old value
11464 when we leave this function. */
11465 count
= SPECPDL_INDEX ();
11466 record_unwind_protect (unwind_redisplay
,
11467 Fcons (make_number (redisplaying_p
), selected_frame
));
11469 specbind (Qinhibit_free_realized_faces
, Qnil
);
11472 Lisp_Object tail
, frame
;
11474 FOR_EACH_FRAME (tail
, frame
)
11476 struct frame
*f
= XFRAME (frame
);
11477 f
->already_hscrolled_p
= 0;
11482 /* Remember the currently selected window. */
11485 if (!EQ (old_frame
, selected_frame
)
11486 && FRAME_LIVE_P (XFRAME (old_frame
)))
11487 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11488 selected_frame and selected_window to be temporarily out-of-sync so
11489 when we come back here via `goto retry', we need to resync because we
11490 may need to run Elisp code (via prepare_menu_bars). */
11491 select_frame_for_redisplay (old_frame
);
11494 reconsider_clip_changes (w
, current_buffer
);
11495 last_escape_glyph_frame
= NULL
;
11496 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11497 last_glyphless_glyph_frame
= NULL
;
11498 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11500 /* If new fonts have been loaded that make a glyph matrix adjustment
11501 necessary, do it. */
11502 if (fonts_changed_p
)
11504 adjust_glyphs (NULL
);
11505 ++windows_or_buffers_changed
;
11506 fonts_changed_p
= 0;
11509 /* If face_change_count is non-zero, init_iterator will free all
11510 realized faces, which includes the faces referenced from current
11511 matrices. So, we can't reuse current matrices in this case. */
11512 if (face_change_count
)
11513 ++windows_or_buffers_changed
;
11515 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11516 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11518 /* Since frames on a single ASCII terminal share the same
11519 display area, displaying a different frame means redisplay
11520 the whole thing. */
11521 windows_or_buffers_changed
++;
11522 SET_FRAME_GARBAGED (sf
);
11524 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11526 FRAME_TTY (sf
)->previous_frame
= sf
;
11529 /* Set the visible flags for all frames. Do this before checking
11530 for resized or garbaged frames; they want to know if their frames
11531 are visible. See the comment in frame.h for
11532 FRAME_SAMPLE_VISIBILITY. */
11534 Lisp_Object tail
, frame
;
11536 number_of_visible_frames
= 0;
11538 FOR_EACH_FRAME (tail
, frame
)
11540 struct frame
*f
= XFRAME (frame
);
11542 FRAME_SAMPLE_VISIBILITY (f
);
11543 if (FRAME_VISIBLE_P (f
))
11544 ++number_of_visible_frames
;
11545 clear_desired_matrices (f
);
11549 /* Notice any pending interrupt request to change frame size. */
11550 do_pending_window_change (1);
11552 /* do_pending_window_change could change the selected_window due to
11553 frame resizing which makes the selected window too small. */
11554 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11557 reconsider_clip_changes (w
, current_buffer
);
11560 /* Clear frames marked as garbaged. */
11561 if (frame_garbaged
)
11562 clear_garbaged_frames ();
11564 /* Build menubar and tool-bar items. */
11565 if (NILP (Vmemory_full
))
11566 prepare_menu_bars ();
11568 if (windows_or_buffers_changed
)
11569 update_mode_lines
++;
11571 /* Detect case that we need to write or remove a star in the mode line. */
11572 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11574 w
->update_mode_line
= Qt
;
11575 if (buffer_shared
> 1)
11576 update_mode_lines
++;
11579 /* Avoid invocation of point motion hooks by `current_column' below. */
11580 count1
= SPECPDL_INDEX ();
11581 specbind (Qinhibit_point_motion_hooks
, Qt
);
11583 /* If %c is in the mode line, update it if needed. */
11584 if (!NILP (w
->column_number_displayed
)
11585 /* This alternative quickly identifies a common case
11586 where no change is needed. */
11587 && !(PT
== XFASTINT (w
->last_point
)
11588 && XFASTINT (w
->last_modified
) >= MODIFF
11589 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11590 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11591 w
->update_mode_line
= Qt
;
11593 unbind_to (count1
, Qnil
);
11595 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11597 /* The variable buffer_shared is set in redisplay_window and
11598 indicates that we redisplay a buffer in different windows. See
11600 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11601 || cursor_type_changed
);
11603 /* If specs for an arrow have changed, do thorough redisplay
11604 to ensure we remove any arrow that should no longer exist. */
11605 if (overlay_arrows_changed_p ())
11606 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11608 /* Normally the message* functions will have already displayed and
11609 updated the echo area, but the frame may have been trashed, or
11610 the update may have been preempted, so display the echo area
11611 again here. Checking message_cleared_p captures the case that
11612 the echo area should be cleared. */
11613 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11614 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11615 || (message_cleared_p
11616 && minibuf_level
== 0
11617 /* If the mini-window is currently selected, this means the
11618 echo-area doesn't show through. */
11619 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11621 int window_height_changed_p
= echo_area_display (0);
11624 /* If we don't display the current message, don't clear the
11625 message_cleared_p flag, because, if we did, we wouldn't clear
11626 the echo area in the next redisplay which doesn't preserve
11628 if (!display_last_displayed_message_p
)
11629 message_cleared_p
= 0;
11631 if (fonts_changed_p
)
11633 else if (window_height_changed_p
)
11635 consider_all_windows_p
= 1;
11636 ++update_mode_lines
;
11637 ++windows_or_buffers_changed
;
11639 /* If window configuration was changed, frames may have been
11640 marked garbaged. Clear them or we will experience
11641 surprises wrt scrolling. */
11642 if (frame_garbaged
)
11643 clear_garbaged_frames ();
11646 else if (EQ (selected_window
, minibuf_window
)
11647 && (current_buffer
->clip_changed
11648 || XFASTINT (w
->last_modified
) < MODIFF
11649 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11650 && resize_mini_window (w
, 0))
11652 /* Resized active mini-window to fit the size of what it is
11653 showing if its contents might have changed. */
11655 /* FIXME: this causes all frames to be updated, which seems unnecessary
11656 since only the current frame needs to be considered. This function needs
11657 to be rewritten with two variables, consider_all_windows and
11658 consider_all_frames. */
11659 consider_all_windows_p
= 1;
11660 ++windows_or_buffers_changed
;
11661 ++update_mode_lines
;
11663 /* If window configuration was changed, frames may have been
11664 marked garbaged. Clear them or we will experience
11665 surprises wrt scrolling. */
11666 if (frame_garbaged
)
11667 clear_garbaged_frames ();
11671 /* If showing the region, and mark has changed, we must redisplay
11672 the whole window. The assignment to this_line_start_pos prevents
11673 the optimization directly below this if-statement. */
11674 if (((!NILP (Vtransient_mark_mode
)
11675 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11676 != !NILP (w
->region_showing
))
11677 || (!NILP (w
->region_showing
)
11678 && !EQ (w
->region_showing
,
11679 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11680 CHARPOS (this_line_start_pos
) = 0;
11682 /* Optimize the case that only the line containing the cursor in the
11683 selected window has changed. Variables starting with this_ are
11684 set in display_line and record information about the line
11685 containing the cursor. */
11686 tlbufpos
= this_line_start_pos
;
11687 tlendpos
= this_line_end_pos
;
11688 if (!consider_all_windows_p
11689 && CHARPOS (tlbufpos
) > 0
11690 && NILP (w
->update_mode_line
)
11691 && !current_buffer
->clip_changed
11692 && !current_buffer
->prevent_redisplay_optimizations_p
11693 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11694 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11695 /* Make sure recorded data applies to current buffer, etc. */
11696 && this_line_buffer
== current_buffer
11697 && current_buffer
== XBUFFER (w
->buffer
)
11698 && NILP (w
->force_start
)
11699 && NILP (w
->optional_new_start
)
11700 /* Point must be on the line that we have info recorded about. */
11701 && PT
>= CHARPOS (tlbufpos
)
11702 && PT
<= Z
- CHARPOS (tlendpos
)
11703 /* All text outside that line, including its final newline,
11704 must be unchanged. */
11705 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11706 CHARPOS (tlendpos
)))
11708 if (CHARPOS (tlbufpos
) > BEGV
11709 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11710 && (CHARPOS (tlbufpos
) == ZV
11711 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11712 /* Former continuation line has disappeared by becoming empty. */
11714 else if (XFASTINT (w
->last_modified
) < MODIFF
11715 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11716 || MINI_WINDOW_P (w
))
11718 /* We have to handle the case of continuation around a
11719 wide-column character (see the comment in indent.c around
11722 For instance, in the following case:
11724 -------- Insert --------
11725 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11726 J_I_ ==> J_I_ `^^' are cursors.
11730 As we have to redraw the line above, we cannot use this
11734 int line_height_before
= this_line_pixel_height
;
11736 /* Note that start_display will handle the case that the
11737 line starting at tlbufpos is a continuation line. */
11738 start_display (&it
, w
, tlbufpos
);
11740 /* Implementation note: It this still necessary? */
11741 if (it
.current_x
!= this_line_start_x
)
11744 TRACE ((stderr
, "trying display optimization 1\n"));
11745 w
->cursor
.vpos
= -1;
11746 overlay_arrow_seen
= 0;
11747 it
.vpos
= this_line_vpos
;
11748 it
.current_y
= this_line_y
;
11749 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11750 display_line (&it
);
11752 /* If line contains point, is not continued,
11753 and ends at same distance from eob as before, we win. */
11754 if (w
->cursor
.vpos
>= 0
11755 /* Line is not continued, otherwise this_line_start_pos
11756 would have been set to 0 in display_line. */
11757 && CHARPOS (this_line_start_pos
)
11758 /* Line ends as before. */
11759 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11760 /* Line has same height as before. Otherwise other lines
11761 would have to be shifted up or down. */
11762 && this_line_pixel_height
== line_height_before
)
11764 /* If this is not the window's last line, we must adjust
11765 the charstarts of the lines below. */
11766 if (it
.current_y
< it
.last_visible_y
)
11768 struct glyph_row
*row
11769 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11770 EMACS_INT delta
, delta_bytes
;
11772 /* We used to distinguish between two cases here,
11773 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11774 when the line ends in a newline or the end of the
11775 buffer's accessible portion. But both cases did
11776 the same, so they were collapsed. */
11778 - CHARPOS (tlendpos
)
11779 - MATRIX_ROW_START_CHARPOS (row
));
11780 delta_bytes
= (Z_BYTE
11781 - BYTEPOS (tlendpos
)
11782 - MATRIX_ROW_START_BYTEPOS (row
));
11784 increment_matrix_positions (w
->current_matrix
,
11785 this_line_vpos
+ 1,
11786 w
->current_matrix
->nrows
,
11787 delta
, delta_bytes
);
11790 /* If this row displays text now but previously didn't,
11791 or vice versa, w->window_end_vpos may have to be
11793 if ((it
.glyph_row
- 1)->displays_text_p
)
11795 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11796 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11798 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11799 && this_line_vpos
> 0)
11800 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11801 w
->window_end_valid
= Qnil
;
11803 /* Update hint: No need to try to scroll in update_window. */
11804 w
->desired_matrix
->no_scrolling_p
= 1;
11807 *w
->desired_matrix
->method
= 0;
11808 debug_method_add (w
, "optimization 1");
11810 #ifdef HAVE_WINDOW_SYSTEM
11811 update_window_fringes (w
, 0);
11818 else if (/* Cursor position hasn't changed. */
11819 PT
== XFASTINT (w
->last_point
)
11820 /* Make sure the cursor was last displayed
11821 in this window. Otherwise we have to reposition it. */
11822 && 0 <= w
->cursor
.vpos
11823 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11827 do_pending_window_change (1);
11828 /* If selected_window changed, redisplay again. */
11829 if (WINDOWP (selected_window
)
11830 && (w
= XWINDOW (selected_window
)) != sw
)
11833 /* We used to always goto end_of_redisplay here, but this
11834 isn't enough if we have a blinking cursor. */
11835 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11836 goto end_of_redisplay
;
11840 /* If highlighting the region, or if the cursor is in the echo area,
11841 then we can't just move the cursor. */
11842 else if (! (!NILP (Vtransient_mark_mode
)
11843 && !NILP (BVAR (current_buffer
, mark_active
)))
11844 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11845 || highlight_nonselected_windows
)
11846 && NILP (w
->region_showing
)
11847 && NILP (Vshow_trailing_whitespace
)
11848 && !cursor_in_echo_area
)
11851 struct glyph_row
*row
;
11853 /* Skip from tlbufpos to PT and see where it is. Note that
11854 PT may be in invisible text. If so, we will end at the
11855 next visible position. */
11856 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11857 NULL
, DEFAULT_FACE_ID
);
11858 it
.current_x
= this_line_start_x
;
11859 it
.current_y
= this_line_y
;
11860 it
.vpos
= this_line_vpos
;
11862 /* The call to move_it_to stops in front of PT, but
11863 moves over before-strings. */
11864 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11866 if (it
.vpos
== this_line_vpos
11867 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11870 xassert (this_line_vpos
== it
.vpos
);
11871 xassert (this_line_y
== it
.current_y
);
11872 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11874 *w
->desired_matrix
->method
= 0;
11875 debug_method_add (w
, "optimization 3");
11884 /* Text changed drastically or point moved off of line. */
11885 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11888 CHARPOS (this_line_start_pos
) = 0;
11889 consider_all_windows_p
|= buffer_shared
> 1;
11890 ++clear_face_cache_count
;
11891 #ifdef HAVE_WINDOW_SYSTEM
11892 ++clear_image_cache_count
;
11895 /* Build desired matrices, and update the display. If
11896 consider_all_windows_p is non-zero, do it for all windows on all
11897 frames. Otherwise do it for selected_window, only. */
11899 if (consider_all_windows_p
)
11901 Lisp_Object tail
, frame
;
11903 FOR_EACH_FRAME (tail
, frame
)
11904 XFRAME (frame
)->updated_p
= 0;
11906 /* Recompute # windows showing selected buffer. This will be
11907 incremented each time such a window is displayed. */
11910 FOR_EACH_FRAME (tail
, frame
)
11912 struct frame
*f
= XFRAME (frame
);
11914 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11916 if (! EQ (frame
, selected_frame
))
11917 /* Select the frame, for the sake of frame-local
11919 select_frame_for_redisplay (frame
);
11921 /* Mark all the scroll bars to be removed; we'll redeem
11922 the ones we want when we redisplay their windows. */
11923 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11924 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11926 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11927 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11929 /* The X error handler may have deleted that frame. */
11930 if (!FRAME_LIVE_P (f
))
11933 /* Any scroll bars which redisplay_windows should have
11934 nuked should now go away. */
11935 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11936 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11938 /* If fonts changed, display again. */
11939 /* ??? rms: I suspect it is a mistake to jump all the way
11940 back to retry here. It should just retry this frame. */
11941 if (fonts_changed_p
)
11944 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11946 /* See if we have to hscroll. */
11947 if (!f
->already_hscrolled_p
)
11949 f
->already_hscrolled_p
= 1;
11950 if (hscroll_windows (f
->root_window
))
11954 /* Prevent various kinds of signals during display
11955 update. stdio is not robust about handling
11956 signals, which can cause an apparent I/O
11958 if (interrupt_input
)
11959 unrequest_sigio ();
11962 /* Update the display. */
11963 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11964 pending
|= update_frame (f
, 0, 0);
11970 if (!EQ (old_frame
, selected_frame
)
11971 && FRAME_LIVE_P (XFRAME (old_frame
)))
11972 /* We played a bit fast-and-loose above and allowed selected_frame
11973 and selected_window to be temporarily out-of-sync but let's make
11974 sure this stays contained. */
11975 select_frame_for_redisplay (old_frame
);
11976 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11980 /* Do the mark_window_display_accurate after all windows have
11981 been redisplayed because this call resets flags in buffers
11982 which are needed for proper redisplay. */
11983 FOR_EACH_FRAME (tail
, frame
)
11985 struct frame
*f
= XFRAME (frame
);
11988 mark_window_display_accurate (f
->root_window
, 1);
11989 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11990 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11995 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11997 Lisp_Object mini_window
;
11998 struct frame
*mini_frame
;
12000 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12001 /* Use list_of_error, not Qerror, so that
12002 we catch only errors and don't run the debugger. */
12003 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12005 redisplay_window_error
);
12007 /* Compare desired and current matrices, perform output. */
12010 /* If fonts changed, display again. */
12011 if (fonts_changed_p
)
12014 /* Prevent various kinds of signals during display update.
12015 stdio is not robust about handling signals,
12016 which can cause an apparent I/O error. */
12017 if (interrupt_input
)
12018 unrequest_sigio ();
12021 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12023 if (hscroll_windows (selected_window
))
12026 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12027 pending
= update_frame (sf
, 0, 0);
12030 /* We may have called echo_area_display at the top of this
12031 function. If the echo area is on another frame, that may
12032 have put text on a frame other than the selected one, so the
12033 above call to update_frame would not have caught it. Catch
12035 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12036 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12038 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12040 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12041 pending
|= update_frame (mini_frame
, 0, 0);
12042 if (!pending
&& hscroll_windows (mini_window
))
12047 /* If display was paused because of pending input, make sure we do a
12048 thorough update the next time. */
12051 /* Prevent the optimization at the beginning of
12052 redisplay_internal that tries a single-line update of the
12053 line containing the cursor in the selected window. */
12054 CHARPOS (this_line_start_pos
) = 0;
12056 /* Let the overlay arrow be updated the next time. */
12057 update_overlay_arrows (0);
12059 /* If we pause after scrolling, some rows in the current
12060 matrices of some windows are not valid. */
12061 if (!WINDOW_FULL_WIDTH_P (w
)
12062 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12063 update_mode_lines
= 1;
12067 if (!consider_all_windows_p
)
12069 /* This has already been done above if
12070 consider_all_windows_p is set. */
12071 mark_window_display_accurate_1 (w
, 1);
12073 /* Say overlay arrows are up to date. */
12074 update_overlay_arrows (1);
12076 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12077 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12080 update_mode_lines
= 0;
12081 windows_or_buffers_changed
= 0;
12082 cursor_type_changed
= 0;
12085 /* Start SIGIO interrupts coming again. Having them off during the
12086 code above makes it less likely one will discard output, but not
12087 impossible, since there might be stuff in the system buffer here.
12088 But it is much hairier to try to do anything about that. */
12089 if (interrupt_input
)
12093 /* If a frame has become visible which was not before, redisplay
12094 again, so that we display it. Expose events for such a frame
12095 (which it gets when becoming visible) don't call the parts of
12096 redisplay constructing glyphs, so simply exposing a frame won't
12097 display anything in this case. So, we have to display these
12098 frames here explicitly. */
12101 Lisp_Object tail
, frame
;
12104 FOR_EACH_FRAME (tail
, frame
)
12106 int this_is_visible
= 0;
12108 if (XFRAME (frame
)->visible
)
12109 this_is_visible
= 1;
12110 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12111 if (XFRAME (frame
)->visible
)
12112 this_is_visible
= 1;
12114 if (this_is_visible
)
12118 if (new_count
!= number_of_visible_frames
)
12119 windows_or_buffers_changed
++;
12122 /* Change frame size now if a change is pending. */
12123 do_pending_window_change (1);
12125 /* If we just did a pending size change, or have additional
12126 visible frames, or selected_window changed, redisplay again. */
12127 if ((windows_or_buffers_changed
&& !pending
)
12128 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12131 /* Clear the face and image caches.
12133 We used to do this only if consider_all_windows_p. But the cache
12134 needs to be cleared if a timer creates images in the current
12135 buffer (e.g. the test case in Bug#6230). */
12137 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12139 clear_face_cache (0);
12140 clear_face_cache_count
= 0;
12143 #ifdef HAVE_WINDOW_SYSTEM
12144 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12146 clear_image_caches (Qnil
);
12147 clear_image_cache_count
= 0;
12149 #endif /* HAVE_WINDOW_SYSTEM */
12152 unbind_to (count
, Qnil
);
12157 /* Redisplay, but leave alone any recent echo area message unless
12158 another message has been requested in its place.
12160 This is useful in situations where you need to redisplay but no
12161 user action has occurred, making it inappropriate for the message
12162 area to be cleared. See tracking_off and
12163 wait_reading_process_output for examples of these situations.
12165 FROM_WHERE is an integer saying from where this function was
12166 called. This is useful for debugging. */
12169 redisplay_preserve_echo_area (int from_where
)
12171 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12173 if (!NILP (echo_area_buffer
[1]))
12175 /* We have a previously displayed message, but no current
12176 message. Redisplay the previous message. */
12177 display_last_displayed_message_p
= 1;
12178 redisplay_internal ();
12179 display_last_displayed_message_p
= 0;
12182 redisplay_internal ();
12184 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12185 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12186 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12190 /* Function registered with record_unwind_protect in
12191 redisplay_internal. Reset redisplaying_p to the value it had
12192 before redisplay_internal was called, and clear
12193 prevent_freeing_realized_faces_p. It also selects the previously
12194 selected frame, unless it has been deleted (by an X connection
12195 failure during redisplay, for example). */
12198 unwind_redisplay (Lisp_Object val
)
12200 Lisp_Object old_redisplaying_p
, old_frame
;
12202 old_redisplaying_p
= XCAR (val
);
12203 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12204 old_frame
= XCDR (val
);
12205 if (! EQ (old_frame
, selected_frame
)
12206 && FRAME_LIVE_P (XFRAME (old_frame
)))
12207 select_frame_for_redisplay (old_frame
);
12212 /* Mark the display of window W as accurate or inaccurate. If
12213 ACCURATE_P is non-zero mark display of W as accurate. If
12214 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12215 redisplay_internal is called. */
12218 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12220 if (BUFFERP (w
->buffer
))
12222 struct buffer
*b
= XBUFFER (w
->buffer
);
12225 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12226 w
->last_overlay_modified
12227 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12229 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12233 b
->clip_changed
= 0;
12234 b
->prevent_redisplay_optimizations_p
= 0;
12236 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12237 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12238 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12239 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12241 w
->current_matrix
->buffer
= b
;
12242 w
->current_matrix
->begv
= BUF_BEGV (b
);
12243 w
->current_matrix
->zv
= BUF_ZV (b
);
12245 w
->last_cursor
= w
->cursor
;
12246 w
->last_cursor_off_p
= w
->cursor_off_p
;
12248 if (w
== XWINDOW (selected_window
))
12249 w
->last_point
= make_number (BUF_PT (b
));
12251 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12257 w
->window_end_valid
= w
->buffer
;
12258 w
->update_mode_line
= Qnil
;
12263 /* Mark the display of windows in the window tree rooted at WINDOW as
12264 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12265 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12266 be redisplayed the next time redisplay_internal is called. */
12269 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12273 for (; !NILP (window
); window
= w
->next
)
12275 w
= XWINDOW (window
);
12276 mark_window_display_accurate_1 (w
, accurate_p
);
12278 if (!NILP (w
->vchild
))
12279 mark_window_display_accurate (w
->vchild
, accurate_p
);
12280 if (!NILP (w
->hchild
))
12281 mark_window_display_accurate (w
->hchild
, accurate_p
);
12286 update_overlay_arrows (1);
12290 /* Force a thorough redisplay the next time by setting
12291 last_arrow_position and last_arrow_string to t, which is
12292 unequal to any useful value of Voverlay_arrow_... */
12293 update_overlay_arrows (-1);
12298 /* Return value in display table DP (Lisp_Char_Table *) for character
12299 C. Since a display table doesn't have any parent, we don't have to
12300 follow parent. Do not call this function directly but use the
12301 macro DISP_CHAR_VECTOR. */
12304 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12308 if (ASCII_CHAR_P (c
))
12311 if (SUB_CHAR_TABLE_P (val
))
12312 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12318 XSETCHAR_TABLE (table
, dp
);
12319 val
= char_table_ref (table
, c
);
12328 /***********************************************************************
12330 ***********************************************************************/
12332 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12335 redisplay_windows (Lisp_Object window
)
12337 while (!NILP (window
))
12339 struct window
*w
= XWINDOW (window
);
12341 if (!NILP (w
->hchild
))
12342 redisplay_windows (w
->hchild
);
12343 else if (!NILP (w
->vchild
))
12344 redisplay_windows (w
->vchild
);
12345 else if (!NILP (w
->buffer
))
12347 displayed_buffer
= XBUFFER (w
->buffer
);
12348 /* Use list_of_error, not Qerror, so that
12349 we catch only errors and don't run the debugger. */
12350 internal_condition_case_1 (redisplay_window_0
, window
,
12352 redisplay_window_error
);
12360 redisplay_window_error (Lisp_Object ignore
)
12362 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12367 redisplay_window_0 (Lisp_Object window
)
12369 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12370 redisplay_window (window
, 0);
12375 redisplay_window_1 (Lisp_Object window
)
12377 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12378 redisplay_window (window
, 1);
12383 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12384 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12385 which positions recorded in ROW differ from current buffer
12388 Return 0 if cursor is not on this row, 1 otherwise. */
12391 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12392 struct glyph_matrix
*matrix
,
12393 EMACS_INT delta
, EMACS_INT delta_bytes
,
12396 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12397 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12398 struct glyph
*cursor
= NULL
;
12399 /* The last known character position in row. */
12400 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12402 EMACS_INT pt_old
= PT
- delta
;
12403 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12404 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12405 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12406 /* A glyph beyond the edge of TEXT_AREA which we should never
12408 struct glyph
*glyphs_end
= end
;
12409 /* Non-zero means we've found a match for cursor position, but that
12410 glyph has the avoid_cursor_p flag set. */
12411 int match_with_avoid_cursor
= 0;
12412 /* Non-zero means we've seen at least one glyph that came from a
12414 int string_seen
= 0;
12415 /* Largest and smalles buffer positions seen so far during scan of
12417 EMACS_INT bpos_max
= pos_before
;
12418 EMACS_INT bpos_min
= pos_after
;
12419 /* Last buffer position covered by an overlay string with an integer
12420 `cursor' property. */
12421 EMACS_INT bpos_covered
= 0;
12423 /* Skip over glyphs not having an object at the start and the end of
12424 the row. These are special glyphs like truncation marks on
12425 terminal frames. */
12426 if (row
->displays_text_p
)
12428 if (!row
->reversed_p
)
12431 && INTEGERP (glyph
->object
)
12432 && glyph
->charpos
< 0)
12434 x
+= glyph
->pixel_width
;
12438 && INTEGERP ((end
- 1)->object
)
12439 /* CHARPOS is zero for blanks and stretch glyphs
12440 inserted by extend_face_to_end_of_line. */
12441 && (end
- 1)->charpos
<= 0)
12443 glyph_before
= glyph
- 1;
12450 /* If the glyph row is reversed, we need to process it from back
12451 to front, so swap the edge pointers. */
12452 glyphs_end
= end
= glyph
- 1;
12453 glyph
+= row
->used
[TEXT_AREA
] - 1;
12455 while (glyph
> end
+ 1
12456 && INTEGERP (glyph
->object
)
12457 && glyph
->charpos
< 0)
12460 x
-= glyph
->pixel_width
;
12462 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12464 /* By default, in reversed rows we put the cursor on the
12465 rightmost (first in the reading order) glyph. */
12466 for (g
= end
+ 1; g
< glyph
; g
++)
12467 x
+= g
->pixel_width
;
12469 && INTEGERP ((end
+ 1)->object
)
12470 && (end
+ 1)->charpos
<= 0)
12472 glyph_before
= glyph
+ 1;
12476 else if (row
->reversed_p
)
12478 /* In R2L rows that don't display text, put the cursor on the
12479 rightmost glyph. Case in point: an empty last line that is
12480 part of an R2L paragraph. */
12482 /* Avoid placing the cursor on the last glyph of the row, where
12483 on terminal frames we hold the vertical border between
12484 adjacent windows. */
12485 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12486 && !WINDOW_RIGHTMOST_P (w
)
12487 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12489 x
= -1; /* will be computed below, at label compute_x */
12492 /* Step 1: Try to find the glyph whose character position
12493 corresponds to point. If that's not possible, find 2 glyphs
12494 whose character positions are the closest to point, one before
12495 point, the other after it. */
12496 if (!row
->reversed_p
)
12497 while (/* not marched to end of glyph row */
12499 /* glyph was not inserted by redisplay for internal purposes */
12500 && !INTEGERP (glyph
->object
))
12502 if (BUFFERP (glyph
->object
))
12504 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12506 if (glyph
->charpos
> bpos_max
)
12507 bpos_max
= glyph
->charpos
;
12508 if (glyph
->charpos
< bpos_min
)
12509 bpos_min
= glyph
->charpos
;
12510 if (!glyph
->avoid_cursor_p
)
12512 /* If we hit point, we've found the glyph on which to
12513 display the cursor. */
12516 match_with_avoid_cursor
= 0;
12519 /* See if we've found a better approximation to
12520 POS_BEFORE or to POS_AFTER. Note that we want the
12521 first (leftmost) glyph of all those that are the
12522 closest from below, and the last (rightmost) of all
12523 those from above. */
12524 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12526 pos_before
= glyph
->charpos
;
12527 glyph_before
= glyph
;
12529 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12531 pos_after
= glyph
->charpos
;
12532 glyph_after
= glyph
;
12535 else if (dpos
== 0)
12536 match_with_avoid_cursor
= 1;
12538 else if (STRINGP (glyph
->object
))
12540 Lisp_Object chprop
;
12541 EMACS_INT glyph_pos
= glyph
->charpos
;
12543 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12545 if (INTEGERP (chprop
))
12547 bpos_covered
= bpos_max
+ XINT (chprop
);
12548 /* If the `cursor' property covers buffer positions up
12549 to and including point, we should display cursor on
12550 this glyph. Note that overlays and text properties
12551 with string values stop bidi reordering, so every
12552 buffer position to the left of the string is always
12553 smaller than any position to the right of the
12554 string. Therefore, if a `cursor' property on one
12555 of the string's characters has an integer value, we
12556 will break out of the loop below _before_ we get to
12557 the position match above. IOW, integer values of
12558 the `cursor' property override the "exact match for
12559 point" strategy of positioning the cursor. */
12560 /* Implementation note: bpos_max == pt_old when, e.g.,
12561 we are in an empty line, where bpos_max is set to
12562 MATRIX_ROW_START_CHARPOS, see above. */
12563 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12572 x
+= glyph
->pixel_width
;
12575 else if (glyph
> end
) /* row is reversed */
12576 while (!INTEGERP (glyph
->object
))
12578 if (BUFFERP (glyph
->object
))
12580 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12582 if (glyph
->charpos
> bpos_max
)
12583 bpos_max
= glyph
->charpos
;
12584 if (glyph
->charpos
< bpos_min
)
12585 bpos_min
= glyph
->charpos
;
12586 if (!glyph
->avoid_cursor_p
)
12590 match_with_avoid_cursor
= 0;
12593 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12595 pos_before
= glyph
->charpos
;
12596 glyph_before
= glyph
;
12598 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12600 pos_after
= glyph
->charpos
;
12601 glyph_after
= glyph
;
12604 else if (dpos
== 0)
12605 match_with_avoid_cursor
= 1;
12607 else if (STRINGP (glyph
->object
))
12609 Lisp_Object chprop
;
12610 EMACS_INT glyph_pos
= glyph
->charpos
;
12612 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12614 if (INTEGERP (chprop
))
12616 bpos_covered
= bpos_max
+ XINT (chprop
);
12617 /* If the `cursor' property covers buffer positions up
12618 to and including point, we should display cursor on
12620 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12629 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12631 x
--; /* can't use any pixel_width */
12634 x
-= glyph
->pixel_width
;
12637 /* Step 2: If we didn't find an exact match for point, we need to
12638 look for a proper place to put the cursor among glyphs between
12639 GLYPH_BEFORE and GLYPH_AFTER. */
12640 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12641 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12642 && bpos_covered
< pt_old
)
12644 /* An empty line has a single glyph whose OBJECT is zero and
12645 whose CHARPOS is the position of a newline on that line.
12646 Note that on a TTY, there are more glyphs after that, which
12647 were produced by extend_face_to_end_of_line, but their
12648 CHARPOS is zero or negative. */
12650 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12651 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12653 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12655 EMACS_INT ellipsis_pos
;
12657 /* Scan back over the ellipsis glyphs. */
12658 if (!row
->reversed_p
)
12660 ellipsis_pos
= (glyph
- 1)->charpos
;
12661 while (glyph
> row
->glyphs
[TEXT_AREA
]
12662 && (glyph
- 1)->charpos
== ellipsis_pos
)
12663 glyph
--, x
-= glyph
->pixel_width
;
12664 /* That loop always goes one position too far, including
12665 the glyph before the ellipsis. So scan forward over
12667 x
+= glyph
->pixel_width
;
12670 else /* row is reversed */
12672 ellipsis_pos
= (glyph
+ 1)->charpos
;
12673 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12674 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12675 glyph
++, x
+= glyph
->pixel_width
;
12676 x
-= glyph
->pixel_width
;
12680 else if (match_with_avoid_cursor
12681 /* A truncated row may not include PT among its
12682 character positions. Setting the cursor inside the
12683 scroll margin will trigger recalculation of hscroll
12684 in hscroll_window_tree. */
12685 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12686 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12687 /* Zero-width characters produce no glyphs. */
12690 && (row
->reversed_p
12691 ? glyph_after
> glyphs_end
12692 : glyph_after
< glyphs_end
)))
12694 cursor
= glyph_after
;
12697 else if (string_seen
)
12699 int incr
= row
->reversed_p
? -1 : +1;
12701 /* Need to find the glyph that came out of a string which is
12702 present at point. That glyph is somewhere between
12703 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12704 positioned between POS_BEFORE and POS_AFTER in the
12706 struct glyph
*stop
= glyph_after
;
12707 EMACS_INT pos
= pos_before
;
12710 for (glyph
= glyph_before
+ incr
;
12711 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12714 /* Any glyphs that come from the buffer are here because
12715 of bidi reordering. Skip them, and only pay
12716 attention to glyphs that came from some string. */
12717 if (STRINGP (glyph
->object
))
12722 str
= glyph
->object
;
12723 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12724 if (tem
== 0 /* from overlay */
12727 /* If the string from which this glyph came is
12728 found in the buffer at point, then we've
12729 found the glyph we've been looking for. If
12730 it comes from an overlay (tem == 0), and it
12731 has the `cursor' property on one of its
12732 glyphs, record that glyph as a candidate for
12733 displaying the cursor. (As in the
12734 unidirectional version, we will display the
12735 cursor on the last candidate we find.) */
12736 if (tem
== 0 || tem
== pt_old
)
12738 /* The glyphs from this string could have
12739 been reordered. Find the one with the
12740 smallest string position. Or there could
12741 be a character in the string with the
12742 `cursor' property, which means display
12743 cursor on that character's glyph. */
12744 EMACS_INT strpos
= glyph
->charpos
;
12749 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12750 && EQ (glyph
->object
, str
);
12754 EMACS_INT gpos
= glyph
->charpos
;
12756 cprop
= Fget_char_property (make_number (gpos
),
12764 if (tem
&& glyph
->charpos
< strpos
)
12766 strpos
= glyph
->charpos
;
12775 pos
= tem
+ 1; /* don't find previous instances */
12777 /* This string is not what we want; skip all of the
12778 glyphs that came from it. */
12779 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12780 && EQ (glyph
->object
, str
))
12787 /* If we reached the end of the line, and END was from a string,
12788 the cursor is not on this line. */
12790 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12791 && STRINGP (end
->object
)
12792 && row
->continued_p
)
12798 if (cursor
!= NULL
)
12804 /* Need to compute x that corresponds to GLYPH. */
12805 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12807 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12809 x
+= g
->pixel_width
;
12813 /* ROW could be part of a continued line, which, under bidi
12814 reordering, might have other rows whose start and end charpos
12815 occlude point. Only set w->cursor if we found a better
12816 approximation to the cursor position than we have from previously
12817 examined candidate rows belonging to the same continued line. */
12818 if (/* we already have a candidate row */
12819 w
->cursor
.vpos
>= 0
12820 /* that candidate is not the row we are processing */
12821 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12822 /* the row we are processing is part of a continued line */
12823 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12824 /* Make sure cursor.vpos specifies a row whose start and end
12825 charpos occlude point. This is because some callers of this
12826 function leave cursor.vpos at the row where the cursor was
12827 displayed during the last redisplay cycle. */
12828 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12829 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12832 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12834 /* Don't consider glyphs that are outside TEXT_AREA. */
12835 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12837 /* Keep the candidate whose buffer position is the closest to
12839 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12840 w
->cursor
.hpos
>= 0
12841 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12842 && BUFFERP (g1
->object
)
12843 && (g1
->charpos
== pt_old
/* an exact match always wins */
12844 || (BUFFERP (glyph
->object
)
12845 && eabs (g1
->charpos
- pt_old
)
12846 < eabs (glyph
->charpos
- pt_old
))))
12848 /* If this candidate gives an exact match, use that. */
12849 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12850 /* Otherwise, keep the candidate that comes from a row
12851 spanning less buffer positions. This may win when one or
12852 both candidate positions are on glyphs that came from
12853 display strings, for which we cannot compare buffer
12855 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12856 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12857 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12860 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12862 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12863 w
->cursor
.y
= row
->y
+ dy
;
12865 if (w
== XWINDOW (selected_window
))
12867 if (!row
->continued_p
12868 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12871 this_line_buffer
= XBUFFER (w
->buffer
);
12873 CHARPOS (this_line_start_pos
)
12874 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12875 BYTEPOS (this_line_start_pos
)
12876 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12878 CHARPOS (this_line_end_pos
)
12879 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12880 BYTEPOS (this_line_end_pos
)
12881 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12883 this_line_y
= w
->cursor
.y
;
12884 this_line_pixel_height
= row
->height
;
12885 this_line_vpos
= w
->cursor
.vpos
;
12886 this_line_start_x
= row
->x
;
12889 CHARPOS (this_line_start_pos
) = 0;
12896 /* Run window scroll functions, if any, for WINDOW with new window
12897 start STARTP. Sets the window start of WINDOW to that position.
12899 We assume that the window's buffer is really current. */
12901 static INLINE
struct text_pos
12902 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12904 struct window
*w
= XWINDOW (window
);
12905 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12907 if (current_buffer
!= XBUFFER (w
->buffer
))
12910 if (!NILP (Vwindow_scroll_functions
))
12912 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12913 make_number (CHARPOS (startp
)));
12914 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12915 /* In case the hook functions switch buffers. */
12916 if (current_buffer
!= XBUFFER (w
->buffer
))
12917 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12924 /* Make sure the line containing the cursor is fully visible.
12925 A value of 1 means there is nothing to be done.
12926 (Either the line is fully visible, or it cannot be made so,
12927 or we cannot tell.)
12929 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12930 is higher than window.
12932 A value of 0 means the caller should do scrolling
12933 as if point had gone off the screen. */
12936 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12938 struct glyph_matrix
*matrix
;
12939 struct glyph_row
*row
;
12942 if (!make_cursor_line_fully_visible_p
)
12945 /* It's not always possible to find the cursor, e.g, when a window
12946 is full of overlay strings. Don't do anything in that case. */
12947 if (w
->cursor
.vpos
< 0)
12950 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12951 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12953 /* If the cursor row is not partially visible, there's nothing to do. */
12954 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12957 /* If the row the cursor is in is taller than the window's height,
12958 it's not clear what to do, so do nothing. */
12959 window_height
= window_box_height (w
);
12960 if (row
->height
>= window_height
)
12962 if (!force_p
|| MINI_WINDOW_P (w
)
12963 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12970 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12971 non-zero means only WINDOW is redisplayed in redisplay_internal.
12972 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12973 in redisplay_window to bring a partially visible line into view in
12974 the case that only the cursor has moved.
12976 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12977 last screen line's vertical height extends past the end of the screen.
12981 1 if scrolling succeeded
12983 0 if scrolling didn't find point.
12985 -1 if new fonts have been loaded so that we must interrupt
12986 redisplay, adjust glyph matrices, and try again. */
12992 SCROLLING_NEED_LARGER_MATRICES
12995 /* If scroll-conservatively is more than this, never recenter.
12997 If you change this, don't forget to update the doc string of
12998 `scroll-conservatively' and the Emacs manual. */
12999 #define SCROLL_LIMIT 100
13002 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13003 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13004 int temp_scroll_step
, int last_line_misfit
)
13006 struct window
*w
= XWINDOW (window
);
13007 struct frame
*f
= XFRAME (w
->frame
);
13008 struct text_pos pos
, startp
;
13010 int this_scroll_margin
, scroll_max
, rc
, height
;
13011 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13012 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13013 Lisp_Object aggressive
;
13014 /* We will never try scrolling more than this number of lines. */
13015 int scroll_limit
= SCROLL_LIMIT
;
13018 debug_method_add (w
, "try_scrolling");
13021 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13023 /* Compute scroll margin height in pixels. We scroll when point is
13024 within this distance from the top or bottom of the window. */
13025 if (scroll_margin
> 0)
13026 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13027 * FRAME_LINE_HEIGHT (f
);
13029 this_scroll_margin
= 0;
13031 /* Force arg_scroll_conservatively to have a reasonable value, to
13032 avoid scrolling too far away with slow move_it_* functions. Note
13033 that the user can supply scroll-conservatively equal to
13034 `most-positive-fixnum', which can be larger than INT_MAX. */
13035 if (arg_scroll_conservatively
> scroll_limit
)
13037 arg_scroll_conservatively
= scroll_limit
+ 1;
13038 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13040 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13041 /* Compute how much we should try to scroll maximally to bring
13042 point into view. */
13043 scroll_max
= (max (scroll_step
,
13044 max (arg_scroll_conservatively
, temp_scroll_step
))
13045 * FRAME_LINE_HEIGHT (f
));
13046 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13047 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13048 /* We're trying to scroll because of aggressive scrolling but no
13049 scroll_step is set. Choose an arbitrary one. */
13050 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13056 /* Decide whether to scroll down. */
13057 if (PT
> CHARPOS (startp
))
13059 int scroll_margin_y
;
13061 /* Compute the pixel ypos of the scroll margin, then move it to
13062 either that ypos or PT, whichever comes first. */
13063 start_display (&it
, w
, startp
);
13064 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13065 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13066 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13067 (MOVE_TO_POS
| MOVE_TO_Y
));
13069 if (PT
> CHARPOS (it
.current
.pos
))
13071 int y0
= line_bottom_y (&it
);
13072 /* Compute how many pixels below window bottom to stop searching
13073 for PT. This avoids costly search for PT that is far away if
13074 the user limited scrolling by a small number of lines, but
13075 always finds PT if scroll_conservatively is set to a large
13076 number, such as most-positive-fixnum. */
13077 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13078 int y_to_move
= it
.last_visible_y
+ slack
;
13080 /* Compute the distance from the scroll margin to PT or to
13081 the scroll limit, whichever comes first. This should
13082 include the height of the cursor line, to make that line
13084 move_it_to (&it
, PT
, -1, y_to_move
,
13085 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13086 dy
= line_bottom_y (&it
) - y0
;
13088 if (dy
> scroll_max
)
13089 return SCROLLING_FAILED
;
13097 /* Point is in or below the bottom scroll margin, so move the
13098 window start down. If scrolling conservatively, move it just
13099 enough down to make point visible. If scroll_step is set,
13100 move it down by scroll_step. */
13101 if (arg_scroll_conservatively
)
13103 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13104 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13105 else if (scroll_step
|| temp_scroll_step
)
13106 amount_to_scroll
= scroll_max
;
13109 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13110 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13111 if (NUMBERP (aggressive
))
13113 double float_amount
= XFLOATINT (aggressive
) * height
;
13114 amount_to_scroll
= float_amount
;
13115 if (amount_to_scroll
== 0 && float_amount
> 0)
13116 amount_to_scroll
= 1;
13117 /* Don't let point enter the scroll margin near top of
13119 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13120 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13124 if (amount_to_scroll
<= 0)
13125 return SCROLLING_FAILED
;
13127 start_display (&it
, w
, startp
);
13128 if (arg_scroll_conservatively
<= scroll_limit
)
13129 move_it_vertically (&it
, amount_to_scroll
);
13132 /* Extra precision for users who set scroll-conservatively
13133 to a large number: make sure the amount we scroll
13134 the window start is never less than amount_to_scroll,
13135 which was computed as distance from window bottom to
13136 point. This matters when lines at window top and lines
13137 below window bottom have different height. */
13138 struct it it1
= it
;
13139 /* We use a temporary it1 because line_bottom_y can modify
13140 its argument, if it moves one line down; see there. */
13141 int start_y
= line_bottom_y (&it1
);
13144 move_it_by_lines (&it
, 1);
13146 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13149 /* If STARTP is unchanged, move it down another screen line. */
13150 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13151 move_it_by_lines (&it
, 1);
13152 startp
= it
.current
.pos
;
13156 struct text_pos scroll_margin_pos
= startp
;
13158 /* See if point is inside the scroll margin at the top of the
13160 if (this_scroll_margin
)
13162 start_display (&it
, w
, startp
);
13163 move_it_vertically (&it
, this_scroll_margin
);
13164 scroll_margin_pos
= it
.current
.pos
;
13167 if (PT
< CHARPOS (scroll_margin_pos
))
13169 /* Point is in the scroll margin at the top of the window or
13170 above what is displayed in the window. */
13173 /* Compute the vertical distance from PT to the scroll
13174 margin position. Move as far as scroll_max allows, or
13175 one screenful, or 10 screen lines, whichever is largest.
13176 Give up if distance is greater than scroll_max. */
13177 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13178 start_display (&it
, w
, pos
);
13180 y_to_move
= max (it
.last_visible_y
,
13181 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13182 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13184 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13185 dy
= it
.current_y
- y0
;
13186 if (dy
> scroll_max
)
13187 return SCROLLING_FAILED
;
13189 /* Compute new window start. */
13190 start_display (&it
, w
, startp
);
13192 if (arg_scroll_conservatively
)
13193 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13194 max (scroll_step
, temp_scroll_step
));
13195 else if (scroll_step
|| temp_scroll_step
)
13196 amount_to_scroll
= scroll_max
;
13199 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13200 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13201 if (NUMBERP (aggressive
))
13203 double float_amount
= XFLOATINT (aggressive
) * height
;
13204 amount_to_scroll
= float_amount
;
13205 if (amount_to_scroll
== 0 && float_amount
> 0)
13206 amount_to_scroll
= 1;
13207 amount_to_scroll
-=
13208 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13209 /* Don't let point enter the scroll margin near
13210 bottom of the window. */
13211 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13212 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13216 if (amount_to_scroll
<= 0)
13217 return SCROLLING_FAILED
;
13219 move_it_vertically_backward (&it
, amount_to_scroll
);
13220 startp
= it
.current
.pos
;
13224 /* Run window scroll functions. */
13225 startp
= run_window_scroll_functions (window
, startp
);
13227 /* Display the window. Give up if new fonts are loaded, or if point
13229 if (!try_window (window
, startp
, 0))
13230 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13231 else if (w
->cursor
.vpos
< 0)
13233 clear_glyph_matrix (w
->desired_matrix
);
13234 rc
= SCROLLING_FAILED
;
13238 /* Maybe forget recorded base line for line number display. */
13239 if (!just_this_one_p
13240 || current_buffer
->clip_changed
13241 || BEG_UNCHANGED
< CHARPOS (startp
))
13242 w
->base_line_number
= Qnil
;
13244 /* If cursor ends up on a partially visible line,
13245 treat that as being off the bottom of the screen. */
13246 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13247 /* It's possible that the cursor is on the first line of the
13248 buffer, which is partially obscured due to a vscroll
13249 (Bug#7537). In that case, avoid looping forever . */
13250 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13252 clear_glyph_matrix (w
->desired_matrix
);
13253 ++extra_scroll_margin_lines
;
13256 rc
= SCROLLING_SUCCESS
;
13263 /* Compute a suitable window start for window W if display of W starts
13264 on a continuation line. Value is non-zero if a new window start
13267 The new window start will be computed, based on W's width, starting
13268 from the start of the continued line. It is the start of the
13269 screen line with the minimum distance from the old start W->start. */
13272 compute_window_start_on_continuation_line (struct window
*w
)
13274 struct text_pos pos
, start_pos
;
13275 int window_start_changed_p
= 0;
13277 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13279 /* If window start is on a continuation line... Window start may be
13280 < BEGV in case there's invisible text at the start of the
13281 buffer (M-x rmail, for example). */
13282 if (CHARPOS (start_pos
) > BEGV
13283 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13286 struct glyph_row
*row
;
13288 /* Handle the case that the window start is out of range. */
13289 if (CHARPOS (start_pos
) < BEGV
)
13290 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13291 else if (CHARPOS (start_pos
) > ZV
)
13292 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13294 /* Find the start of the continued line. This should be fast
13295 because scan_buffer is fast (newline cache). */
13296 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13297 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13298 row
, DEFAULT_FACE_ID
);
13299 reseat_at_previous_visible_line_start (&it
);
13301 /* If the line start is "too far" away from the window start,
13302 say it takes too much time to compute a new window start. */
13303 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13304 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13306 int min_distance
, distance
;
13308 /* Move forward by display lines to find the new window
13309 start. If window width was enlarged, the new start can
13310 be expected to be > the old start. If window width was
13311 decreased, the new window start will be < the old start.
13312 So, we're looking for the display line start with the
13313 minimum distance from the old window start. */
13314 pos
= it
.current
.pos
;
13315 min_distance
= INFINITY
;
13316 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13317 distance
< min_distance
)
13319 min_distance
= distance
;
13320 pos
= it
.current
.pos
;
13321 move_it_by_lines (&it
, 1);
13324 /* Set the window start there. */
13325 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13326 window_start_changed_p
= 1;
13330 return window_start_changed_p
;
13334 /* Try cursor movement in case text has not changed in window WINDOW,
13335 with window start STARTP. Value is
13337 CURSOR_MOVEMENT_SUCCESS if successful
13339 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13341 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13342 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13343 we want to scroll as if scroll-step were set to 1. See the code.
13345 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13346 which case we have to abort this redisplay, and adjust matrices
13351 CURSOR_MOVEMENT_SUCCESS
,
13352 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13353 CURSOR_MOVEMENT_MUST_SCROLL
,
13354 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13358 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13360 struct window
*w
= XWINDOW (window
);
13361 struct frame
*f
= XFRAME (w
->frame
);
13362 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13365 if (inhibit_try_cursor_movement
)
13369 /* Handle case where text has not changed, only point, and it has
13370 not moved off the frame. */
13371 if (/* Point may be in this window. */
13372 PT
>= CHARPOS (startp
)
13373 /* Selective display hasn't changed. */
13374 && !current_buffer
->clip_changed
13375 /* Function force-mode-line-update is used to force a thorough
13376 redisplay. It sets either windows_or_buffers_changed or
13377 update_mode_lines. So don't take a shortcut here for these
13379 && !update_mode_lines
13380 && !windows_or_buffers_changed
13381 && !cursor_type_changed
13382 /* Can't use this case if highlighting a region. When a
13383 region exists, cursor movement has to do more than just
13385 && !(!NILP (Vtransient_mark_mode
)
13386 && !NILP (BVAR (current_buffer
, mark_active
)))
13387 && NILP (w
->region_showing
)
13388 && NILP (Vshow_trailing_whitespace
)
13389 /* Right after splitting windows, last_point may be nil. */
13390 && INTEGERP (w
->last_point
)
13391 /* This code is not used for mini-buffer for the sake of the case
13392 of redisplaying to replace an echo area message; since in
13393 that case the mini-buffer contents per se are usually
13394 unchanged. This code is of no real use in the mini-buffer
13395 since the handling of this_line_start_pos, etc., in redisplay
13396 handles the same cases. */
13397 && !EQ (window
, minibuf_window
)
13398 /* When splitting windows or for new windows, it happens that
13399 redisplay is called with a nil window_end_vpos or one being
13400 larger than the window. This should really be fixed in
13401 window.c. I don't have this on my list, now, so we do
13402 approximately the same as the old redisplay code. --gerd. */
13403 && INTEGERP (w
->window_end_vpos
)
13404 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13405 && (FRAME_WINDOW_P (f
)
13406 || !overlay_arrow_in_current_buffer_p ()))
13408 int this_scroll_margin
, top_scroll_margin
;
13409 struct glyph_row
*row
= NULL
;
13412 debug_method_add (w
, "cursor movement");
13415 /* Scroll if point within this distance from the top or bottom
13416 of the window. This is a pixel value. */
13417 if (scroll_margin
> 0)
13419 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13420 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13423 this_scroll_margin
= 0;
13425 top_scroll_margin
= this_scroll_margin
;
13426 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13427 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13429 /* Start with the row the cursor was displayed during the last
13430 not paused redisplay. Give up if that row is not valid. */
13431 if (w
->last_cursor
.vpos
< 0
13432 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13433 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13436 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13437 if (row
->mode_line_p
)
13439 if (!row
->enabled_p
)
13440 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13443 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13445 int scroll_p
= 0, must_scroll
= 0;
13446 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13448 if (PT
> XFASTINT (w
->last_point
))
13450 /* Point has moved forward. */
13451 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13452 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13454 xassert (row
->enabled_p
);
13458 /* If the end position of a row equals the start
13459 position of the next row, and PT is at that position,
13460 we would rather display cursor in the next line. */
13461 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13462 && MATRIX_ROW_END_CHARPOS (row
) == PT
13463 && row
< w
->current_matrix
->rows
13464 + w
->current_matrix
->nrows
- 1
13465 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13466 && !cursor_row_p (row
))
13469 /* If within the scroll margin, scroll. Note that
13470 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13471 the next line would be drawn, and that
13472 this_scroll_margin can be zero. */
13473 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13474 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13475 /* Line is completely visible last line in window
13476 and PT is to be set in the next line. */
13477 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13478 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13479 && !row
->ends_at_zv_p
13480 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13483 else if (PT
< XFASTINT (w
->last_point
))
13485 /* Cursor has to be moved backward. Note that PT >=
13486 CHARPOS (startp) because of the outer if-statement. */
13487 while (!row
->mode_line_p
13488 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13489 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13490 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13491 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13492 row
> w
->current_matrix
->rows
13493 && (row
-1)->ends_in_newline_from_string_p
))))
13494 && (row
->y
> top_scroll_margin
13495 || CHARPOS (startp
) == BEGV
))
13497 xassert (row
->enabled_p
);
13501 /* Consider the following case: Window starts at BEGV,
13502 there is invisible, intangible text at BEGV, so that
13503 display starts at some point START > BEGV. It can
13504 happen that we are called with PT somewhere between
13505 BEGV and START. Try to handle that case. */
13506 if (row
< w
->current_matrix
->rows
13507 || row
->mode_line_p
)
13509 row
= w
->current_matrix
->rows
;
13510 if (row
->mode_line_p
)
13514 /* Due to newlines in overlay strings, we may have to
13515 skip forward over overlay strings. */
13516 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13517 && MATRIX_ROW_END_CHARPOS (row
) == PT
13518 && !cursor_row_p (row
))
13521 /* If within the scroll margin, scroll. */
13522 if (row
->y
< top_scroll_margin
13523 && CHARPOS (startp
) != BEGV
)
13528 /* Cursor did not move. So don't scroll even if cursor line
13529 is partially visible, as it was so before. */
13530 rc
= CURSOR_MOVEMENT_SUCCESS
;
13533 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13534 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13536 /* if PT is not in the glyph row, give up. */
13537 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13540 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13541 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13543 /* If rows are bidi-reordered and point moved, back up
13544 until we find a row that does not belong to a
13545 continuation line. This is because we must consider
13546 all rows of a continued line as candidates for the
13547 new cursor positioning, since row start and end
13548 positions change non-linearly with vertical position
13550 /* FIXME: Revisit this when glyph ``spilling'' in
13551 continuation lines' rows is implemented for
13552 bidi-reordered rows. */
13553 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13555 xassert (row
->enabled_p
);
13557 /* If we hit the beginning of the displayed portion
13558 without finding the first row of a continued
13560 if (row
<= w
->current_matrix
->rows
)
13562 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13570 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13571 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13572 && make_cursor_line_fully_visible_p
)
13574 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13575 && !row
->ends_at_zv_p
13576 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13577 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13578 else if (row
->height
> window_box_height (w
))
13580 /* If we end up in a partially visible line, let's
13581 make it fully visible, except when it's taller
13582 than the window, in which case we can't do much
13585 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13589 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13590 if (!cursor_row_fully_visible_p (w
, 0, 1))
13591 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13593 rc
= CURSOR_MOVEMENT_SUCCESS
;
13597 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13598 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13599 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13601 /* With bidi-reordered rows, there could be more than
13602 one candidate row whose start and end positions
13603 occlude point. We need to let set_cursor_from_row
13604 find the best candidate. */
13605 /* FIXME: Revisit this when glyph ``spilling'' in
13606 continuation lines' rows is implemented for
13607 bidi-reordered rows. */
13612 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13613 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13614 && cursor_row_p (row
))
13615 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13617 /* As soon as we've found the first suitable row
13618 whose ends_at_zv_p flag is set, we are done. */
13620 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13622 rc
= CURSOR_MOVEMENT_SUCCESS
;
13627 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13628 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13629 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13630 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13631 /* If we didn't find any candidate rows, or exited the
13632 loop before all the candidates were examined, signal
13633 to the caller that this method failed. */
13634 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13635 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13636 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13638 rc
= CURSOR_MOVEMENT_SUCCESS
;
13644 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13646 rc
= CURSOR_MOVEMENT_SUCCESS
;
13651 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13652 && MATRIX_ROW_START_CHARPOS (row
) == PT
13653 && cursor_row_p (row
));
13662 set_vertical_scroll_bar (struct window
*w
)
13664 EMACS_INT start
, end
, whole
;
13666 /* Calculate the start and end positions for the current window.
13667 At some point, it would be nice to choose between scrollbars
13668 which reflect the whole buffer size, with special markers
13669 indicating narrowing, and scrollbars which reflect only the
13672 Note that mini-buffers sometimes aren't displaying any text. */
13673 if (!MINI_WINDOW_P (w
)
13674 || (w
== XWINDOW (minibuf_window
)
13675 && NILP (echo_area_buffer
[0])))
13677 struct buffer
*buf
= XBUFFER (w
->buffer
);
13678 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13679 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13680 /* I don't think this is guaranteed to be right. For the
13681 moment, we'll pretend it is. */
13682 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13686 if (whole
< (end
- start
))
13687 whole
= end
- start
;
13690 start
= end
= whole
= 0;
13692 /* Indicate what this scroll bar ought to be displaying now. */
13693 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13694 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13695 (w
, end
- start
, whole
, start
);
13699 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13700 selected_window is redisplayed.
13702 We can return without actually redisplaying the window if
13703 fonts_changed_p is nonzero. In that case, redisplay_internal will
13707 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13709 struct window
*w
= XWINDOW (window
);
13710 struct frame
*f
= XFRAME (w
->frame
);
13711 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13712 struct buffer
*old
= current_buffer
;
13713 struct text_pos lpoint
, opoint
, startp
;
13714 int update_mode_line
;
13717 /* Record it now because it's overwritten. */
13718 int current_matrix_up_to_date_p
= 0;
13719 int used_current_matrix_p
= 0;
13720 /* This is less strict than current_matrix_up_to_date_p.
13721 It indictes that the buffer contents and narrowing are unchanged. */
13722 int buffer_unchanged_p
= 0;
13723 int temp_scroll_step
= 0;
13724 int count
= SPECPDL_INDEX ();
13726 int centering_position
= -1;
13727 int last_line_misfit
= 0;
13728 EMACS_INT beg_unchanged
, end_unchanged
;
13730 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13733 /* W must be a leaf window here. */
13734 xassert (!NILP (w
->buffer
));
13736 *w
->desired_matrix
->method
= 0;
13740 reconsider_clip_changes (w
, buffer
);
13742 /* Has the mode line to be updated? */
13743 update_mode_line
= (!NILP (w
->update_mode_line
)
13744 || update_mode_lines
13745 || buffer
->clip_changed
13746 || buffer
->prevent_redisplay_optimizations_p
);
13748 if (MINI_WINDOW_P (w
))
13750 if (w
== XWINDOW (echo_area_window
)
13751 && !NILP (echo_area_buffer
[0]))
13753 if (update_mode_line
)
13754 /* We may have to update a tty frame's menu bar or a
13755 tool-bar. Example `M-x C-h C-h C-g'. */
13756 goto finish_menu_bars
;
13758 /* We've already displayed the echo area glyphs in this window. */
13759 goto finish_scroll_bars
;
13761 else if ((w
!= XWINDOW (minibuf_window
)
13762 || minibuf_level
== 0)
13763 /* When buffer is nonempty, redisplay window normally. */
13764 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13765 /* Quail displays non-mini buffers in minibuffer window.
13766 In that case, redisplay the window normally. */
13767 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13769 /* W is a mini-buffer window, but it's not active, so clear
13771 int yb
= window_text_bottom_y (w
);
13772 struct glyph_row
*row
;
13775 for (y
= 0, row
= w
->desired_matrix
->rows
;
13777 y
+= row
->height
, ++row
)
13778 blank_row (w
, row
, y
);
13779 goto finish_scroll_bars
;
13782 clear_glyph_matrix (w
->desired_matrix
);
13785 /* Otherwise set up data on this window; select its buffer and point
13787 /* Really select the buffer, for the sake of buffer-local
13789 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13791 current_matrix_up_to_date_p
13792 = (!NILP (w
->window_end_valid
)
13793 && !current_buffer
->clip_changed
13794 && !current_buffer
->prevent_redisplay_optimizations_p
13795 && XFASTINT (w
->last_modified
) >= MODIFF
13796 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13798 /* Run the window-bottom-change-functions
13799 if it is possible that the text on the screen has changed
13800 (either due to modification of the text, or any other reason). */
13801 if (!current_matrix_up_to_date_p
13802 && !NILP (Vwindow_text_change_functions
))
13804 safe_run_hooks (Qwindow_text_change_functions
);
13808 beg_unchanged
= BEG_UNCHANGED
;
13809 end_unchanged
= END_UNCHANGED
;
13811 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13813 specbind (Qinhibit_point_motion_hooks
, Qt
);
13816 = (!NILP (w
->window_end_valid
)
13817 && !current_buffer
->clip_changed
13818 && XFASTINT (w
->last_modified
) >= MODIFF
13819 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13821 /* When windows_or_buffers_changed is non-zero, we can't rely on
13822 the window end being valid, so set it to nil there. */
13823 if (windows_or_buffers_changed
)
13825 /* If window starts on a continuation line, maybe adjust the
13826 window start in case the window's width changed. */
13827 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13828 compute_window_start_on_continuation_line (w
);
13830 w
->window_end_valid
= Qnil
;
13833 /* Some sanity checks. */
13834 CHECK_WINDOW_END (w
);
13835 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13837 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13840 /* If %c is in mode line, update it if needed. */
13841 if (!NILP (w
->column_number_displayed
)
13842 /* This alternative quickly identifies a common case
13843 where no change is needed. */
13844 && !(PT
== XFASTINT (w
->last_point
)
13845 && XFASTINT (w
->last_modified
) >= MODIFF
13846 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13847 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13848 update_mode_line
= 1;
13850 /* Count number of windows showing the selected buffer. An indirect
13851 buffer counts as its base buffer. */
13852 if (!just_this_one_p
)
13854 struct buffer
*current_base
, *window_base
;
13855 current_base
= current_buffer
;
13856 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13857 if (current_base
->base_buffer
)
13858 current_base
= current_base
->base_buffer
;
13859 if (window_base
->base_buffer
)
13860 window_base
= window_base
->base_buffer
;
13861 if (current_base
== window_base
)
13865 /* Point refers normally to the selected window. For any other
13866 window, set up appropriate value. */
13867 if (!EQ (window
, selected_window
))
13869 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13870 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13874 new_pt_byte
= BEGV_BYTE
;
13875 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13877 else if (new_pt
> (ZV
- 1))
13880 new_pt_byte
= ZV_BYTE
;
13881 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13884 /* We don't use SET_PT so that the point-motion hooks don't run. */
13885 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13888 /* If any of the character widths specified in the display table
13889 have changed, invalidate the width run cache. It's true that
13890 this may be a bit late to catch such changes, but the rest of
13891 redisplay goes (non-fatally) haywire when the display table is
13892 changed, so why should we worry about doing any better? */
13893 if (current_buffer
->width_run_cache
)
13895 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13897 if (! disptab_matches_widthtab (disptab
,
13898 XVECTOR (BVAR (current_buffer
, width_table
))))
13900 invalidate_region_cache (current_buffer
,
13901 current_buffer
->width_run_cache
,
13903 recompute_width_table (current_buffer
, disptab
);
13907 /* If window-start is screwed up, choose a new one. */
13908 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13911 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13913 /* If someone specified a new starting point but did not insist,
13914 check whether it can be used. */
13915 if (!NILP (w
->optional_new_start
)
13916 && CHARPOS (startp
) >= BEGV
13917 && CHARPOS (startp
) <= ZV
)
13919 w
->optional_new_start
= Qnil
;
13920 start_display (&it
, w
, startp
);
13921 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13922 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13923 if (IT_CHARPOS (it
) == PT
)
13924 w
->force_start
= Qt
;
13925 /* IT may overshoot PT if text at PT is invisible. */
13926 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13927 w
->force_start
= Qt
;
13932 /* Handle case where place to start displaying has been specified,
13933 unless the specified location is outside the accessible range. */
13934 if (!NILP (w
->force_start
)
13935 || w
->frozen_window_start_p
)
13937 /* We set this later on if we have to adjust point. */
13940 w
->force_start
= Qnil
;
13942 w
->window_end_valid
= Qnil
;
13944 /* Forget any recorded base line for line number display. */
13945 if (!buffer_unchanged_p
)
13946 w
->base_line_number
= Qnil
;
13948 /* Redisplay the mode line. Select the buffer properly for that.
13949 Also, run the hook window-scroll-functions
13950 because we have scrolled. */
13951 /* Note, we do this after clearing force_start because
13952 if there's an error, it is better to forget about force_start
13953 than to get into an infinite loop calling the hook functions
13954 and having them get more errors. */
13955 if (!update_mode_line
13956 || ! NILP (Vwindow_scroll_functions
))
13958 update_mode_line
= 1;
13959 w
->update_mode_line
= Qt
;
13960 startp
= run_window_scroll_functions (window
, startp
);
13963 w
->last_modified
= make_number (0);
13964 w
->last_overlay_modified
= make_number (0);
13965 if (CHARPOS (startp
) < BEGV
)
13966 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13967 else if (CHARPOS (startp
) > ZV
)
13968 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13970 /* Redisplay, then check if cursor has been set during the
13971 redisplay. Give up if new fonts were loaded. */
13972 /* We used to issue a CHECK_MARGINS argument to try_window here,
13973 but this causes scrolling to fail when point begins inside
13974 the scroll margin (bug#148) -- cyd */
13975 if (!try_window (window
, startp
, 0))
13977 w
->force_start
= Qt
;
13978 clear_glyph_matrix (w
->desired_matrix
);
13979 goto need_larger_matrices
;
13982 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13984 /* If point does not appear, try to move point so it does
13985 appear. The desired matrix has been built above, so we
13986 can use it here. */
13987 new_vpos
= window_box_height (w
) / 2;
13990 if (!cursor_row_fully_visible_p (w
, 0, 0))
13992 /* Point does appear, but on a line partly visible at end of window.
13993 Move it back to a fully-visible line. */
13994 new_vpos
= window_box_height (w
);
13997 /* If we need to move point for either of the above reasons,
13998 now actually do it. */
14001 struct glyph_row
*row
;
14003 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14004 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14007 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14008 MATRIX_ROW_START_BYTEPOS (row
));
14010 if (w
!= XWINDOW (selected_window
))
14011 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14012 else if (current_buffer
== old
)
14013 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14015 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14017 /* If we are highlighting the region, then we just changed
14018 the region, so redisplay to show it. */
14019 if (!NILP (Vtransient_mark_mode
)
14020 && !NILP (BVAR (current_buffer
, mark_active
)))
14022 clear_glyph_matrix (w
->desired_matrix
);
14023 if (!try_window (window
, startp
, 0))
14024 goto need_larger_matrices
;
14029 debug_method_add (w
, "forced window start");
14034 /* Handle case where text has not changed, only point, and it has
14035 not moved off the frame, and we are not retrying after hscroll.
14036 (current_matrix_up_to_date_p is nonzero when retrying.) */
14037 if (current_matrix_up_to_date_p
14038 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14039 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14043 case CURSOR_MOVEMENT_SUCCESS
:
14044 used_current_matrix_p
= 1;
14047 case CURSOR_MOVEMENT_MUST_SCROLL
:
14048 goto try_to_scroll
;
14054 /* If current starting point was originally the beginning of a line
14055 but no longer is, find a new starting point. */
14056 else if (!NILP (w
->start_at_line_beg
)
14057 && !(CHARPOS (startp
) <= BEGV
14058 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14061 debug_method_add (w
, "recenter 1");
14066 /* Try scrolling with try_window_id. Value is > 0 if update has
14067 been done, it is -1 if we know that the same window start will
14068 not work. It is 0 if unsuccessful for some other reason. */
14069 else if ((tem
= try_window_id (w
)) != 0)
14072 debug_method_add (w
, "try_window_id %d", tem
);
14075 if (fonts_changed_p
)
14076 goto need_larger_matrices
;
14080 /* Otherwise try_window_id has returned -1 which means that we
14081 don't want the alternative below this comment to execute. */
14083 else if (CHARPOS (startp
) >= BEGV
14084 && CHARPOS (startp
) <= ZV
14085 && PT
>= CHARPOS (startp
)
14086 && (CHARPOS (startp
) < ZV
14087 /* Avoid starting at end of buffer. */
14088 || CHARPOS (startp
) == BEGV
14089 || (XFASTINT (w
->last_modified
) >= MODIFF
14090 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14093 /* If first window line is a continuation line, and window start
14094 is inside the modified region, but the first change is before
14095 current window start, we must select a new window start.
14097 However, if this is the result of a down-mouse event (e.g. by
14098 extending the mouse-drag-overlay), we don't want to select a
14099 new window start, since that would change the position under
14100 the mouse, resulting in an unwanted mouse-movement rather
14101 than a simple mouse-click. */
14102 if (NILP (w
->start_at_line_beg
)
14103 && NILP (do_mouse_tracking
)
14104 && CHARPOS (startp
) > BEGV
14105 && CHARPOS (startp
) > BEG
+ beg_unchanged
14106 && CHARPOS (startp
) <= Z
- end_unchanged
14107 /* Even if w->start_at_line_beg is nil, a new window may
14108 start at a line_beg, since that's how set_buffer_window
14109 sets it. So, we need to check the return value of
14110 compute_window_start_on_continuation_line. (See also
14112 && XMARKER (w
->start
)->buffer
== current_buffer
14113 && compute_window_start_on_continuation_line (w
))
14115 w
->force_start
= Qt
;
14116 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14121 debug_method_add (w
, "same window start");
14124 /* Try to redisplay starting at same place as before.
14125 If point has not moved off frame, accept the results. */
14126 if (!current_matrix_up_to_date_p
14127 /* Don't use try_window_reusing_current_matrix in this case
14128 because a window scroll function can have changed the
14130 || !NILP (Vwindow_scroll_functions
)
14131 || MINI_WINDOW_P (w
)
14132 || !(used_current_matrix_p
14133 = try_window_reusing_current_matrix (w
)))
14135 IF_DEBUG (debug_method_add (w
, "1"));
14136 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14137 /* -1 means we need to scroll.
14138 0 means we need new matrices, but fonts_changed_p
14139 is set in that case, so we will detect it below. */
14140 goto try_to_scroll
;
14143 if (fonts_changed_p
)
14144 goto need_larger_matrices
;
14146 if (w
->cursor
.vpos
>= 0)
14148 if (!just_this_one_p
14149 || current_buffer
->clip_changed
14150 || BEG_UNCHANGED
< CHARPOS (startp
))
14151 /* Forget any recorded base line for line number display. */
14152 w
->base_line_number
= Qnil
;
14154 if (!cursor_row_fully_visible_p (w
, 1, 0))
14156 clear_glyph_matrix (w
->desired_matrix
);
14157 last_line_misfit
= 1;
14159 /* Drop through and scroll. */
14164 clear_glyph_matrix (w
->desired_matrix
);
14169 w
->last_modified
= make_number (0);
14170 w
->last_overlay_modified
= make_number (0);
14172 /* Redisplay the mode line. Select the buffer properly for that. */
14173 if (!update_mode_line
)
14175 update_mode_line
= 1;
14176 w
->update_mode_line
= Qt
;
14179 /* Try to scroll by specified few lines. */
14180 if ((scroll_conservatively
14181 || emacs_scroll_step
14182 || temp_scroll_step
14183 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14184 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14185 && CHARPOS (startp
) >= BEGV
14186 && CHARPOS (startp
) <= ZV
)
14188 /* The function returns -1 if new fonts were loaded, 1 if
14189 successful, 0 if not successful. */
14190 int ss
= try_scrolling (window
, just_this_one_p
,
14191 scroll_conservatively
,
14193 temp_scroll_step
, last_line_misfit
);
14196 case SCROLLING_SUCCESS
:
14199 case SCROLLING_NEED_LARGER_MATRICES
:
14200 goto need_larger_matrices
;
14202 case SCROLLING_FAILED
:
14210 /* Finally, just choose a place to start which positions point
14211 according to user preferences. */
14216 debug_method_add (w
, "recenter");
14219 /* w->vscroll = 0; */
14221 /* Forget any previously recorded base line for line number display. */
14222 if (!buffer_unchanged_p
)
14223 w
->base_line_number
= Qnil
;
14225 /* Determine the window start relative to point. */
14226 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14227 it
.current_y
= it
.last_visible_y
;
14228 if (centering_position
< 0)
14232 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14234 EMACS_INT margin_pos
= CHARPOS (startp
);
14236 Lisp_Object aggressive
;
14238 /* If there is a scroll margin at the top of the window, find
14239 its character position. */
14244 start_display (&it1
, w
, startp
);
14245 move_it_vertically (&it1
, margin
);
14246 margin_pos
= IT_CHARPOS (it1
);
14248 scrolling_up
= PT
> margin_pos
;
14251 ? BVAR (current_buffer
, scroll_up_aggressively
)
14252 : BVAR (current_buffer
, scroll_down_aggressively
);
14254 if (!MINI_WINDOW_P (w
)
14255 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14259 /* Setting scroll-conservatively overrides
14260 scroll-*-aggressively. */
14261 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14263 double float_amount
= XFLOATINT (aggressive
);
14265 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14266 if (pt_offset
== 0 && float_amount
> 0)
14271 /* Compute how much to move the window start backward from
14272 point so that point will be displayed where the user
14276 centering_position
= it
.last_visible_y
;
14278 centering_position
-= pt_offset
;
14279 centering_position
-=
14280 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14281 /* Don't let point enter the scroll margin near top of
14283 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14284 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14287 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14290 /* Set the window start half the height of the window backward
14292 centering_position
= window_box_height (w
) / 2;
14294 move_it_vertically_backward (&it
, centering_position
);
14296 xassert (IT_CHARPOS (it
) >= BEGV
);
14298 /* The function move_it_vertically_backward may move over more
14299 than the specified y-distance. If it->w is small, e.g. a
14300 mini-buffer window, we may end up in front of the window's
14301 display area. Start displaying at the start of the line
14302 containing PT in this case. */
14303 if (it
.current_y
<= 0)
14305 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14306 move_it_vertically_backward (&it
, 0);
14310 it
.current_x
= it
.hpos
= 0;
14312 /* Set the window start position here explicitly, to avoid an
14313 infinite loop in case the functions in window-scroll-functions
14315 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14317 /* Run scroll hooks. */
14318 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14320 /* Redisplay the window. */
14321 if (!current_matrix_up_to_date_p
14322 || windows_or_buffers_changed
14323 || cursor_type_changed
14324 /* Don't use try_window_reusing_current_matrix in this case
14325 because it can have changed the buffer. */
14326 || !NILP (Vwindow_scroll_functions
)
14327 || !just_this_one_p
14328 || MINI_WINDOW_P (w
)
14329 || !(used_current_matrix_p
14330 = try_window_reusing_current_matrix (w
)))
14331 try_window (window
, startp
, 0);
14333 /* If new fonts have been loaded (due to fontsets), give up. We
14334 have to start a new redisplay since we need to re-adjust glyph
14336 if (fonts_changed_p
)
14337 goto need_larger_matrices
;
14339 /* If cursor did not appear assume that the middle of the window is
14340 in the first line of the window. Do it again with the next line.
14341 (Imagine a window of height 100, displaying two lines of height
14342 60. Moving back 50 from it->last_visible_y will end in the first
14344 if (w
->cursor
.vpos
< 0)
14346 if (!NILP (w
->window_end_valid
)
14347 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14349 clear_glyph_matrix (w
->desired_matrix
);
14350 move_it_by_lines (&it
, 1);
14351 try_window (window
, it
.current
.pos
, 0);
14353 else if (PT
< IT_CHARPOS (it
))
14355 clear_glyph_matrix (w
->desired_matrix
);
14356 move_it_by_lines (&it
, -1);
14357 try_window (window
, it
.current
.pos
, 0);
14361 /* Not much we can do about it. */
14365 /* Consider the following case: Window starts at BEGV, there is
14366 invisible, intangible text at BEGV, so that display starts at
14367 some point START > BEGV. It can happen that we are called with
14368 PT somewhere between BEGV and START. Try to handle that case. */
14369 if (w
->cursor
.vpos
< 0)
14371 struct glyph_row
*row
= w
->current_matrix
->rows
;
14372 if (row
->mode_line_p
)
14374 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14377 if (!cursor_row_fully_visible_p (w
, 0, 0))
14379 /* If vscroll is enabled, disable it and try again. */
14383 clear_glyph_matrix (w
->desired_matrix
);
14387 /* If centering point failed to make the whole line visible,
14388 put point at the top instead. That has to make the whole line
14389 visible, if it can be done. */
14390 if (centering_position
== 0)
14393 clear_glyph_matrix (w
->desired_matrix
);
14394 centering_position
= 0;
14400 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14401 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14402 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14405 /* Display the mode line, if we must. */
14406 if ((update_mode_line
14407 /* If window not full width, must redo its mode line
14408 if (a) the window to its side is being redone and
14409 (b) we do a frame-based redisplay. This is a consequence
14410 of how inverted lines are drawn in frame-based redisplay. */
14411 || (!just_this_one_p
14412 && !FRAME_WINDOW_P (f
)
14413 && !WINDOW_FULL_WIDTH_P (w
))
14414 /* Line number to display. */
14415 || INTEGERP (w
->base_line_pos
)
14416 /* Column number is displayed and different from the one displayed. */
14417 || (!NILP (w
->column_number_displayed
)
14418 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14419 /* This means that the window has a mode line. */
14420 && (WINDOW_WANTS_MODELINE_P (w
)
14421 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14423 display_mode_lines (w
);
14425 /* If mode line height has changed, arrange for a thorough
14426 immediate redisplay using the correct mode line height. */
14427 if (WINDOW_WANTS_MODELINE_P (w
)
14428 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14430 fonts_changed_p
= 1;
14431 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14432 = DESIRED_MODE_LINE_HEIGHT (w
);
14435 /* If header line height has changed, arrange for a thorough
14436 immediate redisplay using the correct header line height. */
14437 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14438 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14440 fonts_changed_p
= 1;
14441 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14442 = DESIRED_HEADER_LINE_HEIGHT (w
);
14445 if (fonts_changed_p
)
14446 goto need_larger_matrices
;
14449 if (!line_number_displayed
14450 && !BUFFERP (w
->base_line_pos
))
14452 w
->base_line_pos
= Qnil
;
14453 w
->base_line_number
= Qnil
;
14458 /* When we reach a frame's selected window, redo the frame's menu bar. */
14459 if (update_mode_line
14460 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14462 int redisplay_menu_p
= 0;
14463 int redisplay_tool_bar_p
= 0;
14465 if (FRAME_WINDOW_P (f
))
14467 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14468 || defined (HAVE_NS) || defined (USE_GTK)
14469 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14471 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14475 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14477 if (redisplay_menu_p
)
14478 display_menu_bar (w
);
14480 #ifdef HAVE_WINDOW_SYSTEM
14481 if (FRAME_WINDOW_P (f
))
14483 #if defined (USE_GTK) || defined (HAVE_NS)
14484 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14486 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14487 && (FRAME_TOOL_BAR_LINES (f
) > 0
14488 || !NILP (Vauto_resize_tool_bars
));
14491 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14493 ignore_mouse_drag_p
= 1;
14499 #ifdef HAVE_WINDOW_SYSTEM
14500 if (FRAME_WINDOW_P (f
)
14501 && update_window_fringes (w
, (just_this_one_p
14502 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14503 || w
->pseudo_window_p
)))
14507 if (draw_window_fringes (w
, 1))
14508 x_draw_vertical_border (w
);
14512 #endif /* HAVE_WINDOW_SYSTEM */
14514 /* We go to this label, with fonts_changed_p nonzero,
14515 if it is necessary to try again using larger glyph matrices.
14516 We have to redeem the scroll bar even in this case,
14517 because the loop in redisplay_internal expects that. */
14518 need_larger_matrices
:
14520 finish_scroll_bars
:
14522 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14524 /* Set the thumb's position and size. */
14525 set_vertical_scroll_bar (w
);
14527 /* Note that we actually used the scroll bar attached to this
14528 window, so it shouldn't be deleted at the end of redisplay. */
14529 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14530 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14533 /* Restore current_buffer and value of point in it. The window
14534 update may have changed the buffer, so first make sure `opoint'
14535 is still valid (Bug#6177). */
14536 if (CHARPOS (opoint
) < BEGV
)
14537 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14538 else if (CHARPOS (opoint
) > ZV
)
14539 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14541 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14543 set_buffer_internal_1 (old
);
14544 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14545 shorter. This can be caused by log truncation in *Messages*. */
14546 if (CHARPOS (lpoint
) <= ZV
)
14547 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14549 unbind_to (count
, Qnil
);
14553 /* Build the complete desired matrix of WINDOW with a window start
14554 buffer position POS.
14556 Value is 1 if successful. It is zero if fonts were loaded during
14557 redisplay which makes re-adjusting glyph matrices necessary, and -1
14558 if point would appear in the scroll margins.
14559 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14560 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14564 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14566 struct window
*w
= XWINDOW (window
);
14568 struct glyph_row
*last_text_row
= NULL
;
14569 struct frame
*f
= XFRAME (w
->frame
);
14571 /* Make POS the new window start. */
14572 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14574 /* Mark cursor position as unknown. No overlay arrow seen. */
14575 w
->cursor
.vpos
= -1;
14576 overlay_arrow_seen
= 0;
14578 /* Initialize iterator and info to start at POS. */
14579 start_display (&it
, w
, pos
);
14581 /* Display all lines of W. */
14582 while (it
.current_y
< it
.last_visible_y
)
14584 if (display_line (&it
))
14585 last_text_row
= it
.glyph_row
- 1;
14586 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14590 /* Don't let the cursor end in the scroll margins. */
14591 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14592 && !MINI_WINDOW_P (w
))
14594 int this_scroll_margin
;
14596 if (scroll_margin
> 0)
14598 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14599 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14602 this_scroll_margin
= 0;
14604 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14605 && w
->cursor
.y
< this_scroll_margin
14606 && CHARPOS (pos
) > BEGV
14607 && IT_CHARPOS (it
) < ZV
)
14608 /* rms: considering make_cursor_line_fully_visible_p here
14609 seems to give wrong results. We don't want to recenter
14610 when the last line is partly visible, we want to allow
14611 that case to be handled in the usual way. */
14612 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14614 w
->cursor
.vpos
= -1;
14615 clear_glyph_matrix (w
->desired_matrix
);
14620 /* If bottom moved off end of frame, change mode line percentage. */
14621 if (XFASTINT (w
->window_end_pos
) <= 0
14622 && Z
!= IT_CHARPOS (it
))
14623 w
->update_mode_line
= Qt
;
14625 /* Set window_end_pos to the offset of the last character displayed
14626 on the window from the end of current_buffer. Set
14627 window_end_vpos to its row number. */
14630 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14631 w
->window_end_bytepos
14632 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14634 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14636 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14637 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14638 ->displays_text_p
);
14642 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14643 w
->window_end_pos
= make_number (Z
- ZV
);
14644 w
->window_end_vpos
= make_number (0);
14647 /* But that is not valid info until redisplay finishes. */
14648 w
->window_end_valid
= Qnil
;
14654 /************************************************************************
14655 Window redisplay reusing current matrix when buffer has not changed
14656 ************************************************************************/
14658 /* Try redisplay of window W showing an unchanged buffer with a
14659 different window start than the last time it was displayed by
14660 reusing its current matrix. Value is non-zero if successful.
14661 W->start is the new window start. */
14664 try_window_reusing_current_matrix (struct window
*w
)
14666 struct frame
*f
= XFRAME (w
->frame
);
14667 struct glyph_row
*bottom_row
;
14670 struct text_pos start
, new_start
;
14671 int nrows_scrolled
, i
;
14672 struct glyph_row
*last_text_row
;
14673 struct glyph_row
*last_reused_text_row
;
14674 struct glyph_row
*start_row
;
14675 int start_vpos
, min_y
, max_y
;
14678 if (inhibit_try_window_reusing
)
14682 if (/* This function doesn't handle terminal frames. */
14683 !FRAME_WINDOW_P (f
)
14684 /* Don't try to reuse the display if windows have been split
14686 || windows_or_buffers_changed
14687 || cursor_type_changed
)
14690 /* Can't do this if region may have changed. */
14691 if ((!NILP (Vtransient_mark_mode
)
14692 && !NILP (BVAR (current_buffer
, mark_active
)))
14693 || !NILP (w
->region_showing
)
14694 || !NILP (Vshow_trailing_whitespace
))
14697 /* If top-line visibility has changed, give up. */
14698 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14699 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14702 /* Give up if old or new display is scrolled vertically. We could
14703 make this function handle this, but right now it doesn't. */
14704 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14705 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14708 /* The variable new_start now holds the new window start. The old
14709 start `start' can be determined from the current matrix. */
14710 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14711 start
= start_row
->minpos
;
14712 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14714 /* Clear the desired matrix for the display below. */
14715 clear_glyph_matrix (w
->desired_matrix
);
14717 if (CHARPOS (new_start
) <= CHARPOS (start
))
14719 /* Don't use this method if the display starts with an ellipsis
14720 displayed for invisible text. It's not easy to handle that case
14721 below, and it's certainly not worth the effort since this is
14722 not a frequent case. */
14723 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14726 IF_DEBUG (debug_method_add (w
, "twu1"));
14728 /* Display up to a row that can be reused. The variable
14729 last_text_row is set to the last row displayed that displays
14730 text. Note that it.vpos == 0 if or if not there is a
14731 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14732 start_display (&it
, w
, new_start
);
14733 w
->cursor
.vpos
= -1;
14734 last_text_row
= last_reused_text_row
= NULL
;
14736 while (it
.current_y
< it
.last_visible_y
14737 && !fonts_changed_p
)
14739 /* If we have reached into the characters in the START row,
14740 that means the line boundaries have changed. So we
14741 can't start copying with the row START. Maybe it will
14742 work to start copying with the following row. */
14743 while (IT_CHARPOS (it
) > CHARPOS (start
))
14745 /* Advance to the next row as the "start". */
14747 start
= start_row
->minpos
;
14748 /* If there are no more rows to try, or just one, give up. */
14749 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14750 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14751 || CHARPOS (start
) == ZV
)
14753 clear_glyph_matrix (w
->desired_matrix
);
14757 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14759 /* If we have reached alignment,
14760 we can copy the rest of the rows. */
14761 if (IT_CHARPOS (it
) == CHARPOS (start
))
14764 if (display_line (&it
))
14765 last_text_row
= it
.glyph_row
- 1;
14768 /* A value of current_y < last_visible_y means that we stopped
14769 at the previous window start, which in turn means that we
14770 have at least one reusable row. */
14771 if (it
.current_y
< it
.last_visible_y
)
14773 struct glyph_row
*row
;
14775 /* IT.vpos always starts from 0; it counts text lines. */
14776 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14778 /* Find PT if not already found in the lines displayed. */
14779 if (w
->cursor
.vpos
< 0)
14781 int dy
= it
.current_y
- start_row
->y
;
14783 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14784 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14786 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14787 dy
, nrows_scrolled
);
14790 clear_glyph_matrix (w
->desired_matrix
);
14795 /* Scroll the display. Do it before the current matrix is
14796 changed. The problem here is that update has not yet
14797 run, i.e. part of the current matrix is not up to date.
14798 scroll_run_hook will clear the cursor, and use the
14799 current matrix to get the height of the row the cursor is
14801 run
.current_y
= start_row
->y
;
14802 run
.desired_y
= it
.current_y
;
14803 run
.height
= it
.last_visible_y
- it
.current_y
;
14805 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14808 FRAME_RIF (f
)->update_window_begin_hook (w
);
14809 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14810 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14811 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14815 /* Shift current matrix down by nrows_scrolled lines. */
14816 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14817 rotate_matrix (w
->current_matrix
,
14819 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14822 /* Disable lines that must be updated. */
14823 for (i
= 0; i
< nrows_scrolled
; ++i
)
14824 (start_row
+ i
)->enabled_p
= 0;
14826 /* Re-compute Y positions. */
14827 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14828 max_y
= it
.last_visible_y
;
14829 for (row
= start_row
+ nrows_scrolled
;
14833 row
->y
= it
.current_y
;
14834 row
->visible_height
= row
->height
;
14836 if (row
->y
< min_y
)
14837 row
->visible_height
-= min_y
- row
->y
;
14838 if (row
->y
+ row
->height
> max_y
)
14839 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14840 row
->redraw_fringe_bitmaps_p
= 1;
14842 it
.current_y
+= row
->height
;
14844 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14845 last_reused_text_row
= row
;
14846 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14850 /* Disable lines in the current matrix which are now
14851 below the window. */
14852 for (++row
; row
< bottom_row
; ++row
)
14853 row
->enabled_p
= row
->mode_line_p
= 0;
14856 /* Update window_end_pos etc.; last_reused_text_row is the last
14857 reused row from the current matrix containing text, if any.
14858 The value of last_text_row is the last displayed line
14859 containing text. */
14860 if (last_reused_text_row
)
14862 w
->window_end_bytepos
14863 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14865 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14867 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14868 w
->current_matrix
));
14870 else if (last_text_row
)
14872 w
->window_end_bytepos
14873 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14875 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14877 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14881 /* This window must be completely empty. */
14882 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14883 w
->window_end_pos
= make_number (Z
- ZV
);
14884 w
->window_end_vpos
= make_number (0);
14886 w
->window_end_valid
= Qnil
;
14888 /* Update hint: don't try scrolling again in update_window. */
14889 w
->desired_matrix
->no_scrolling_p
= 1;
14892 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14896 else if (CHARPOS (new_start
) > CHARPOS (start
))
14898 struct glyph_row
*pt_row
, *row
;
14899 struct glyph_row
*first_reusable_row
;
14900 struct glyph_row
*first_row_to_display
;
14902 int yb
= window_text_bottom_y (w
);
14904 /* Find the row starting at new_start, if there is one. Don't
14905 reuse a partially visible line at the end. */
14906 first_reusable_row
= start_row
;
14907 while (first_reusable_row
->enabled_p
14908 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14909 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14910 < CHARPOS (new_start
)))
14911 ++first_reusable_row
;
14913 /* Give up if there is no row to reuse. */
14914 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14915 || !first_reusable_row
->enabled_p
14916 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14917 != CHARPOS (new_start
)))
14920 /* We can reuse fully visible rows beginning with
14921 first_reusable_row to the end of the window. Set
14922 first_row_to_display to the first row that cannot be reused.
14923 Set pt_row to the row containing point, if there is any. */
14925 for (first_row_to_display
= first_reusable_row
;
14926 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14927 ++first_row_to_display
)
14929 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14930 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14931 pt_row
= first_row_to_display
;
14934 /* Start displaying at the start of first_row_to_display. */
14935 xassert (first_row_to_display
->y
< yb
);
14936 init_to_row_start (&it
, w
, first_row_to_display
);
14938 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14940 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14942 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14943 + WINDOW_HEADER_LINE_HEIGHT (w
));
14945 /* Display lines beginning with first_row_to_display in the
14946 desired matrix. Set last_text_row to the last row displayed
14947 that displays text. */
14948 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14949 if (pt_row
== NULL
)
14950 w
->cursor
.vpos
= -1;
14951 last_text_row
= NULL
;
14952 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14953 if (display_line (&it
))
14954 last_text_row
= it
.glyph_row
- 1;
14956 /* If point is in a reused row, adjust y and vpos of the cursor
14960 w
->cursor
.vpos
-= nrows_scrolled
;
14961 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14964 /* Give up if point isn't in a row displayed or reused. (This
14965 also handles the case where w->cursor.vpos < nrows_scrolled
14966 after the calls to display_line, which can happen with scroll
14967 margins. See bug#1295.) */
14968 if (w
->cursor
.vpos
< 0)
14970 clear_glyph_matrix (w
->desired_matrix
);
14974 /* Scroll the display. */
14975 run
.current_y
= first_reusable_row
->y
;
14976 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14977 run
.height
= it
.last_visible_y
- run
.current_y
;
14978 dy
= run
.current_y
- run
.desired_y
;
14983 FRAME_RIF (f
)->update_window_begin_hook (w
);
14984 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14985 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14986 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14990 /* Adjust Y positions of reused rows. */
14991 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14992 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14993 max_y
= it
.last_visible_y
;
14994 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14997 row
->visible_height
= row
->height
;
14998 if (row
->y
< min_y
)
14999 row
->visible_height
-= min_y
- row
->y
;
15000 if (row
->y
+ row
->height
> max_y
)
15001 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15002 row
->redraw_fringe_bitmaps_p
= 1;
15005 /* Scroll the current matrix. */
15006 xassert (nrows_scrolled
> 0);
15007 rotate_matrix (w
->current_matrix
,
15009 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15012 /* Disable rows not reused. */
15013 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15014 row
->enabled_p
= 0;
15016 /* Point may have moved to a different line, so we cannot assume that
15017 the previous cursor position is valid; locate the correct row. */
15020 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15021 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15025 w
->cursor
.y
= row
->y
;
15027 if (row
< bottom_row
)
15029 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15030 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15032 /* Can't use this optimization with bidi-reordered glyph
15033 rows, unless cursor is already at point. */
15034 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15036 if (!(w
->cursor
.hpos
>= 0
15037 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15038 && BUFFERP (glyph
->object
)
15039 && glyph
->charpos
== PT
))
15044 && (!BUFFERP (glyph
->object
)
15045 || glyph
->charpos
< PT
);
15049 w
->cursor
.x
+= glyph
->pixel_width
;
15054 /* Adjust window end. A null value of last_text_row means that
15055 the window end is in reused rows which in turn means that
15056 only its vpos can have changed. */
15059 w
->window_end_bytepos
15060 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15062 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15064 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15069 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15072 w
->window_end_valid
= Qnil
;
15073 w
->desired_matrix
->no_scrolling_p
= 1;
15076 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15086 /************************************************************************
15087 Window redisplay reusing current matrix when buffer has changed
15088 ************************************************************************/
15090 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15091 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15092 EMACS_INT
*, EMACS_INT
*);
15093 static struct glyph_row
*
15094 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15095 struct glyph_row
*);
15098 /* Return the last row in MATRIX displaying text. If row START is
15099 non-null, start searching with that row. IT gives the dimensions
15100 of the display. Value is null if matrix is empty; otherwise it is
15101 a pointer to the row found. */
15103 static struct glyph_row
*
15104 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15105 struct glyph_row
*start
)
15107 struct glyph_row
*row
, *row_found
;
15109 /* Set row_found to the last row in IT->w's current matrix
15110 displaying text. The loop looks funny but think of partially
15113 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15114 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15116 xassert (row
->enabled_p
);
15118 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15127 /* Return the last row in the current matrix of W that is not affected
15128 by changes at the start of current_buffer that occurred since W's
15129 current matrix was built. Value is null if no such row exists.
15131 BEG_UNCHANGED us the number of characters unchanged at the start of
15132 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15133 first changed character in current_buffer. Characters at positions <
15134 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15135 when the current matrix was built. */
15137 static struct glyph_row
*
15138 find_last_unchanged_at_beg_row (struct window
*w
)
15140 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15141 struct glyph_row
*row
;
15142 struct glyph_row
*row_found
= NULL
;
15143 int yb
= window_text_bottom_y (w
);
15145 /* Find the last row displaying unchanged text. */
15146 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15147 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15148 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15151 if (/* If row ends before first_changed_pos, it is unchanged,
15152 except in some case. */
15153 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15154 /* When row ends in ZV and we write at ZV it is not
15156 && !row
->ends_at_zv_p
15157 /* When first_changed_pos is the end of a continued line,
15158 row is not unchanged because it may be no longer
15160 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15161 && (row
->continued_p
15162 || row
->exact_window_width_line_p
)))
15165 /* Stop if last visible row. */
15166 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15174 /* Find the first glyph row in the current matrix of W that is not
15175 affected by changes at the end of current_buffer since the
15176 time W's current matrix was built.
15178 Return in *DELTA the number of chars by which buffer positions in
15179 unchanged text at the end of current_buffer must be adjusted.
15181 Return in *DELTA_BYTES the corresponding number of bytes.
15183 Value is null if no such row exists, i.e. all rows are affected by
15186 static struct glyph_row
*
15187 find_first_unchanged_at_end_row (struct window
*w
,
15188 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15190 struct glyph_row
*row
;
15191 struct glyph_row
*row_found
= NULL
;
15193 *delta
= *delta_bytes
= 0;
15195 /* Display must not have been paused, otherwise the current matrix
15196 is not up to date. */
15197 eassert (!NILP (w
->window_end_valid
));
15199 /* A value of window_end_pos >= END_UNCHANGED means that the window
15200 end is in the range of changed text. If so, there is no
15201 unchanged row at the end of W's current matrix. */
15202 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15205 /* Set row to the last row in W's current matrix displaying text. */
15206 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15208 /* If matrix is entirely empty, no unchanged row exists. */
15209 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15211 /* The value of row is the last glyph row in the matrix having a
15212 meaningful buffer position in it. The end position of row
15213 corresponds to window_end_pos. This allows us to translate
15214 buffer positions in the current matrix to current buffer
15215 positions for characters not in changed text. */
15217 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15218 EMACS_INT Z_BYTE_old
=
15219 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15220 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15221 struct glyph_row
*first_text_row
15222 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15224 *delta
= Z
- Z_old
;
15225 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15227 /* Set last_unchanged_pos to the buffer position of the last
15228 character in the buffer that has not been changed. Z is the
15229 index + 1 of the last character in current_buffer, i.e. by
15230 subtracting END_UNCHANGED we get the index of the last
15231 unchanged character, and we have to add BEG to get its buffer
15233 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15234 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15236 /* Search backward from ROW for a row displaying a line that
15237 starts at a minimum position >= last_unchanged_pos_old. */
15238 for (; row
> first_text_row
; --row
)
15240 /* This used to abort, but it can happen.
15241 It is ok to just stop the search instead here. KFS. */
15242 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15245 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15250 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15256 /* Make sure that glyph rows in the current matrix of window W
15257 reference the same glyph memory as corresponding rows in the
15258 frame's frame matrix. This function is called after scrolling W's
15259 current matrix on a terminal frame in try_window_id and
15260 try_window_reusing_current_matrix. */
15263 sync_frame_with_window_matrix_rows (struct window
*w
)
15265 struct frame
*f
= XFRAME (w
->frame
);
15266 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15268 /* Preconditions: W must be a leaf window and full-width. Its frame
15269 must have a frame matrix. */
15270 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15271 xassert (WINDOW_FULL_WIDTH_P (w
));
15272 xassert (!FRAME_WINDOW_P (f
));
15274 /* If W is a full-width window, glyph pointers in W's current matrix
15275 have, by definition, to be the same as glyph pointers in the
15276 corresponding frame matrix. Note that frame matrices have no
15277 marginal areas (see build_frame_matrix). */
15278 window_row
= w
->current_matrix
->rows
;
15279 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15280 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15281 while (window_row
< window_row_end
)
15283 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15284 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15286 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15287 frame_row
->glyphs
[TEXT_AREA
] = start
;
15288 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15289 frame_row
->glyphs
[LAST_AREA
] = end
;
15291 /* Disable frame rows whose corresponding window rows have
15292 been disabled in try_window_id. */
15293 if (!window_row
->enabled_p
)
15294 frame_row
->enabled_p
= 0;
15296 ++window_row
, ++frame_row
;
15301 /* Find the glyph row in window W containing CHARPOS. Consider all
15302 rows between START and END (not inclusive). END null means search
15303 all rows to the end of the display area of W. Value is the row
15304 containing CHARPOS or null. */
15307 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15308 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15310 struct glyph_row
*row
= start
;
15311 struct glyph_row
*best_row
= NULL
;
15312 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15315 /* If we happen to start on a header-line, skip that. */
15316 if (row
->mode_line_p
)
15319 if ((end
&& row
>= end
) || !row
->enabled_p
)
15322 last_y
= window_text_bottom_y (w
) - dy
;
15326 /* Give up if we have gone too far. */
15327 if (end
&& row
>= end
)
15329 /* This formerly returned if they were equal.
15330 I think that both quantities are of a "last plus one" type;
15331 if so, when they are equal, the row is within the screen. -- rms. */
15332 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15335 /* If it is in this row, return this row. */
15336 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15337 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15338 /* The end position of a row equals the start
15339 position of the next row. If CHARPOS is there, we
15340 would rather display it in the next line, except
15341 when this line ends in ZV. */
15342 && !row
->ends_at_zv_p
15343 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15344 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15348 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15349 || (!best_row
&& !row
->continued_p
))
15351 /* In bidi-reordered rows, there could be several rows
15352 occluding point, all of them belonging to the same
15353 continued line. We need to find the row which fits
15354 CHARPOS the best. */
15355 for (g
= row
->glyphs
[TEXT_AREA
];
15356 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15359 if (!STRINGP (g
->object
))
15361 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15363 mindif
= eabs (g
->charpos
- charpos
);
15365 /* Exact match always wins. */
15372 else if (best_row
&& !row
->continued_p
)
15379 /* Try to redisplay window W by reusing its existing display. W's
15380 current matrix must be up to date when this function is called,
15381 i.e. window_end_valid must not be nil.
15385 1 if display has been updated
15386 0 if otherwise unsuccessful
15387 -1 if redisplay with same window start is known not to succeed
15389 The following steps are performed:
15391 1. Find the last row in the current matrix of W that is not
15392 affected by changes at the start of current_buffer. If no such row
15395 2. Find the first row in W's current matrix that is not affected by
15396 changes at the end of current_buffer. Maybe there is no such row.
15398 3. Display lines beginning with the row + 1 found in step 1 to the
15399 row found in step 2 or, if step 2 didn't find a row, to the end of
15402 4. If cursor is not known to appear on the window, give up.
15404 5. If display stopped at the row found in step 2, scroll the
15405 display and current matrix as needed.
15407 6. Maybe display some lines at the end of W, if we must. This can
15408 happen under various circumstances, like a partially visible line
15409 becoming fully visible, or because newly displayed lines are displayed
15410 in smaller font sizes.
15412 7. Update W's window end information. */
15415 try_window_id (struct window
*w
)
15417 struct frame
*f
= XFRAME (w
->frame
);
15418 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15419 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15420 struct glyph_row
*last_unchanged_at_beg_row
;
15421 struct glyph_row
*first_unchanged_at_end_row
;
15422 struct glyph_row
*row
;
15423 struct glyph_row
*bottom_row
;
15426 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15428 struct text_pos start_pos
;
15430 int first_unchanged_at_end_vpos
= 0;
15431 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15432 struct text_pos start
;
15433 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15436 if (inhibit_try_window_id
)
15440 /* This is handy for debugging. */
15442 #define GIVE_UP(X) \
15444 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15448 #define GIVE_UP(X) return 0
15451 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15453 /* Don't use this for mini-windows because these can show
15454 messages and mini-buffers, and we don't handle that here. */
15455 if (MINI_WINDOW_P (w
))
15458 /* This flag is used to prevent redisplay optimizations. */
15459 if (windows_or_buffers_changed
|| cursor_type_changed
)
15462 /* Verify that narrowing has not changed.
15463 Also verify that we were not told to prevent redisplay optimizations.
15464 It would be nice to further
15465 reduce the number of cases where this prevents try_window_id. */
15466 if (current_buffer
->clip_changed
15467 || current_buffer
->prevent_redisplay_optimizations_p
)
15470 /* Window must either use window-based redisplay or be full width. */
15471 if (!FRAME_WINDOW_P (f
)
15472 && (!FRAME_LINE_INS_DEL_OK (f
)
15473 || !WINDOW_FULL_WIDTH_P (w
)))
15476 /* Give up if point is known NOT to appear in W. */
15477 if (PT
< CHARPOS (start
))
15480 /* Another way to prevent redisplay optimizations. */
15481 if (XFASTINT (w
->last_modified
) == 0)
15484 /* Verify that window is not hscrolled. */
15485 if (XFASTINT (w
->hscroll
) != 0)
15488 /* Verify that display wasn't paused. */
15489 if (NILP (w
->window_end_valid
))
15492 /* Can't use this if highlighting a region because a cursor movement
15493 will do more than just set the cursor. */
15494 if (!NILP (Vtransient_mark_mode
)
15495 && !NILP (BVAR (current_buffer
, mark_active
)))
15498 /* Likewise if highlighting trailing whitespace. */
15499 if (!NILP (Vshow_trailing_whitespace
))
15502 /* Likewise if showing a region. */
15503 if (!NILP (w
->region_showing
))
15506 /* Can't use this if overlay arrow position and/or string have
15508 if (overlay_arrows_changed_p ())
15511 /* When word-wrap is on, adding a space to the first word of a
15512 wrapped line can change the wrap position, altering the line
15513 above it. It might be worthwhile to handle this more
15514 intelligently, but for now just redisplay from scratch. */
15515 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15518 /* Under bidi reordering, adding or deleting a character in the
15519 beginning of a paragraph, before the first strong directional
15520 character, can change the base direction of the paragraph (unless
15521 the buffer specifies a fixed paragraph direction), which will
15522 require to redisplay the whole paragraph. It might be worthwhile
15523 to find the paragraph limits and widen the range of redisplayed
15524 lines to that, but for now just give up this optimization and
15525 redisplay from scratch. */
15526 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15527 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15530 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15531 only if buffer has really changed. The reason is that the gap is
15532 initially at Z for freshly visited files. The code below would
15533 set end_unchanged to 0 in that case. */
15534 if (MODIFF
> SAVE_MODIFF
15535 /* This seems to happen sometimes after saving a buffer. */
15536 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15538 if (GPT
- BEG
< BEG_UNCHANGED
)
15539 BEG_UNCHANGED
= GPT
- BEG
;
15540 if (Z
- GPT
< END_UNCHANGED
)
15541 END_UNCHANGED
= Z
- GPT
;
15544 /* The position of the first and last character that has been changed. */
15545 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15546 last_changed_charpos
= Z
- END_UNCHANGED
;
15548 /* If window starts after a line end, and the last change is in
15549 front of that newline, then changes don't affect the display.
15550 This case happens with stealth-fontification. Note that although
15551 the display is unchanged, glyph positions in the matrix have to
15552 be adjusted, of course. */
15553 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15554 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15555 && ((last_changed_charpos
< CHARPOS (start
)
15556 && CHARPOS (start
) == BEGV
)
15557 || (last_changed_charpos
< CHARPOS (start
) - 1
15558 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15560 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15561 struct glyph_row
*r0
;
15563 /* Compute how many chars/bytes have been added to or removed
15564 from the buffer. */
15565 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15566 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15567 Z_delta
= Z
- Z_old
;
15568 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15570 /* Give up if PT is not in the window. Note that it already has
15571 been checked at the start of try_window_id that PT is not in
15572 front of the window start. */
15573 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15576 /* If window start is unchanged, we can reuse the whole matrix
15577 as is, after adjusting glyph positions. No need to compute
15578 the window end again, since its offset from Z hasn't changed. */
15579 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15580 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15581 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15582 /* PT must not be in a partially visible line. */
15583 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15584 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15586 /* Adjust positions in the glyph matrix. */
15587 if (Z_delta
|| Z_delta_bytes
)
15589 struct glyph_row
*r1
15590 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15591 increment_matrix_positions (w
->current_matrix
,
15592 MATRIX_ROW_VPOS (r0
, current_matrix
),
15593 MATRIX_ROW_VPOS (r1
, current_matrix
),
15594 Z_delta
, Z_delta_bytes
);
15597 /* Set the cursor. */
15598 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15600 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15607 /* Handle the case that changes are all below what is displayed in
15608 the window, and that PT is in the window. This shortcut cannot
15609 be taken if ZV is visible in the window, and text has been added
15610 there that is visible in the window. */
15611 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15612 /* ZV is not visible in the window, or there are no
15613 changes at ZV, actually. */
15614 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15615 || first_changed_charpos
== last_changed_charpos
))
15617 struct glyph_row
*r0
;
15619 /* Give up if PT is not in the window. Note that it already has
15620 been checked at the start of try_window_id that PT is not in
15621 front of the window start. */
15622 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15625 /* If window start is unchanged, we can reuse the whole matrix
15626 as is, without changing glyph positions since no text has
15627 been added/removed in front of the window end. */
15628 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15629 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15630 /* PT must not be in a partially visible line. */
15631 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15632 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15634 /* We have to compute the window end anew since text
15635 could have been added/removed after it. */
15637 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15638 w
->window_end_bytepos
15639 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15641 /* Set the cursor. */
15642 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15644 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15651 /* Give up if window start is in the changed area.
15653 The condition used to read
15655 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15657 but why that was tested escapes me at the moment. */
15658 if (CHARPOS (start
) >= first_changed_charpos
15659 && CHARPOS (start
) <= last_changed_charpos
)
15662 /* Check that window start agrees with the start of the first glyph
15663 row in its current matrix. Check this after we know the window
15664 start is not in changed text, otherwise positions would not be
15666 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15667 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15670 /* Give up if the window ends in strings. Overlay strings
15671 at the end are difficult to handle, so don't try. */
15672 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15673 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15676 /* Compute the position at which we have to start displaying new
15677 lines. Some of the lines at the top of the window might be
15678 reusable because they are not displaying changed text. Find the
15679 last row in W's current matrix not affected by changes at the
15680 start of current_buffer. Value is null if changes start in the
15681 first line of window. */
15682 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15683 if (last_unchanged_at_beg_row
)
15685 /* Avoid starting to display in the moddle of a character, a TAB
15686 for instance. This is easier than to set up the iterator
15687 exactly, and it's not a frequent case, so the additional
15688 effort wouldn't really pay off. */
15689 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15690 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15691 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15692 --last_unchanged_at_beg_row
;
15694 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15697 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15699 start_pos
= it
.current
.pos
;
15701 /* Start displaying new lines in the desired matrix at the same
15702 vpos we would use in the current matrix, i.e. below
15703 last_unchanged_at_beg_row. */
15704 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15706 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15707 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15709 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15713 /* There are no reusable lines at the start of the window.
15714 Start displaying in the first text line. */
15715 start_display (&it
, w
, start
);
15716 it
.vpos
= it
.first_vpos
;
15717 start_pos
= it
.current
.pos
;
15720 /* Find the first row that is not affected by changes at the end of
15721 the buffer. Value will be null if there is no unchanged row, in
15722 which case we must redisplay to the end of the window. delta
15723 will be set to the value by which buffer positions beginning with
15724 first_unchanged_at_end_row have to be adjusted due to text
15726 first_unchanged_at_end_row
15727 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15728 IF_DEBUG (debug_delta
= delta
);
15729 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15731 /* Set stop_pos to the buffer position up to which we will have to
15732 display new lines. If first_unchanged_at_end_row != NULL, this
15733 is the buffer position of the start of the line displayed in that
15734 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15735 that we don't stop at a buffer position. */
15737 if (first_unchanged_at_end_row
)
15739 xassert (last_unchanged_at_beg_row
== NULL
15740 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15742 /* If this is a continuation line, move forward to the next one
15743 that isn't. Changes in lines above affect this line.
15744 Caution: this may move first_unchanged_at_end_row to a row
15745 not displaying text. */
15746 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15747 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15748 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15749 < it
.last_visible_y
))
15750 ++first_unchanged_at_end_row
;
15752 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15753 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15754 >= it
.last_visible_y
))
15755 first_unchanged_at_end_row
= NULL
;
15758 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15760 first_unchanged_at_end_vpos
15761 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15762 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15765 else if (last_unchanged_at_beg_row
== NULL
)
15771 /* Either there is no unchanged row at the end, or the one we have
15772 now displays text. This is a necessary condition for the window
15773 end pos calculation at the end of this function. */
15774 xassert (first_unchanged_at_end_row
== NULL
15775 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15777 debug_last_unchanged_at_beg_vpos
15778 = (last_unchanged_at_beg_row
15779 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15781 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15783 #endif /* GLYPH_DEBUG != 0 */
15786 /* Display new lines. Set last_text_row to the last new line
15787 displayed which has text on it, i.e. might end up as being the
15788 line where the window_end_vpos is. */
15789 w
->cursor
.vpos
= -1;
15790 last_text_row
= NULL
;
15791 overlay_arrow_seen
= 0;
15792 while (it
.current_y
< it
.last_visible_y
15793 && !fonts_changed_p
15794 && (first_unchanged_at_end_row
== NULL
15795 || IT_CHARPOS (it
) < stop_pos
))
15797 if (display_line (&it
))
15798 last_text_row
= it
.glyph_row
- 1;
15801 if (fonts_changed_p
)
15805 /* Compute differences in buffer positions, y-positions etc. for
15806 lines reused at the bottom of the window. Compute what we can
15808 if (first_unchanged_at_end_row
15809 /* No lines reused because we displayed everything up to the
15810 bottom of the window. */
15811 && it
.current_y
< it
.last_visible_y
)
15814 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15816 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15817 run
.current_y
= first_unchanged_at_end_row
->y
;
15818 run
.desired_y
= run
.current_y
+ dy
;
15819 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15823 delta
= delta_bytes
= dvpos
= dy
15824 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15825 first_unchanged_at_end_row
= NULL
;
15827 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15830 /* Find the cursor if not already found. We have to decide whether
15831 PT will appear on this window (it sometimes doesn't, but this is
15832 not a very frequent case.) This decision has to be made before
15833 the current matrix is altered. A value of cursor.vpos < 0 means
15834 that PT is either in one of the lines beginning at
15835 first_unchanged_at_end_row or below the window. Don't care for
15836 lines that might be displayed later at the window end; as
15837 mentioned, this is not a frequent case. */
15838 if (w
->cursor
.vpos
< 0)
15840 /* Cursor in unchanged rows at the top? */
15841 if (PT
< CHARPOS (start_pos
)
15842 && last_unchanged_at_beg_row
)
15844 row
= row_containing_pos (w
, PT
,
15845 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15846 last_unchanged_at_beg_row
+ 1, 0);
15848 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15851 /* Start from first_unchanged_at_end_row looking for PT. */
15852 else if (first_unchanged_at_end_row
)
15854 row
= row_containing_pos (w
, PT
- delta
,
15855 first_unchanged_at_end_row
, NULL
, 0);
15857 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15858 delta_bytes
, dy
, dvpos
);
15861 /* Give up if cursor was not found. */
15862 if (w
->cursor
.vpos
< 0)
15864 clear_glyph_matrix (w
->desired_matrix
);
15869 /* Don't let the cursor end in the scroll margins. */
15871 int this_scroll_margin
, cursor_height
;
15873 this_scroll_margin
= max (0, scroll_margin
);
15874 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15875 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15876 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15878 if ((w
->cursor
.y
< this_scroll_margin
15879 && CHARPOS (start
) > BEGV
)
15880 /* Old redisplay didn't take scroll margin into account at the bottom,
15881 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15882 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15883 ? cursor_height
+ this_scroll_margin
15884 : 1)) > it
.last_visible_y
)
15886 w
->cursor
.vpos
= -1;
15887 clear_glyph_matrix (w
->desired_matrix
);
15892 /* Scroll the display. Do it before changing the current matrix so
15893 that xterm.c doesn't get confused about where the cursor glyph is
15895 if (dy
&& run
.height
)
15899 if (FRAME_WINDOW_P (f
))
15901 FRAME_RIF (f
)->update_window_begin_hook (w
);
15902 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15903 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15904 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15908 /* Terminal frame. In this case, dvpos gives the number of
15909 lines to scroll by; dvpos < 0 means scroll up. */
15911 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15912 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15913 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15914 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15915 + window_internal_height (w
));
15917 #if defined (HAVE_GPM) || defined (MSDOS)
15918 x_clear_window_mouse_face (w
);
15920 /* Perform the operation on the screen. */
15923 /* Scroll last_unchanged_at_beg_row to the end of the
15924 window down dvpos lines. */
15925 set_terminal_window (f
, end
);
15927 /* On dumb terminals delete dvpos lines at the end
15928 before inserting dvpos empty lines. */
15929 if (!FRAME_SCROLL_REGION_OK (f
))
15930 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15932 /* Insert dvpos empty lines in front of
15933 last_unchanged_at_beg_row. */
15934 ins_del_lines (f
, from
, dvpos
);
15936 else if (dvpos
< 0)
15938 /* Scroll up last_unchanged_at_beg_vpos to the end of
15939 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15940 set_terminal_window (f
, end
);
15942 /* Delete dvpos lines in front of
15943 last_unchanged_at_beg_vpos. ins_del_lines will set
15944 the cursor to the given vpos and emit |dvpos| delete
15946 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15948 /* On a dumb terminal insert dvpos empty lines at the
15950 if (!FRAME_SCROLL_REGION_OK (f
))
15951 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15954 set_terminal_window (f
, 0);
15960 /* Shift reused rows of the current matrix to the right position.
15961 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15963 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15964 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15967 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15968 bottom_vpos
, dvpos
);
15969 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15972 else if (dvpos
> 0)
15974 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15975 bottom_vpos
, dvpos
);
15976 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15977 first_unchanged_at_end_vpos
+ dvpos
, 0);
15980 /* For frame-based redisplay, make sure that current frame and window
15981 matrix are in sync with respect to glyph memory. */
15982 if (!FRAME_WINDOW_P (f
))
15983 sync_frame_with_window_matrix_rows (w
);
15985 /* Adjust buffer positions in reused rows. */
15986 if (delta
|| delta_bytes
)
15987 increment_matrix_positions (current_matrix
,
15988 first_unchanged_at_end_vpos
+ dvpos
,
15989 bottom_vpos
, delta
, delta_bytes
);
15991 /* Adjust Y positions. */
15993 shift_glyph_matrix (w
, current_matrix
,
15994 first_unchanged_at_end_vpos
+ dvpos
,
15997 if (first_unchanged_at_end_row
)
15999 first_unchanged_at_end_row
+= dvpos
;
16000 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16001 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16002 first_unchanged_at_end_row
= NULL
;
16005 /* If scrolling up, there may be some lines to display at the end of
16007 last_text_row_at_end
= NULL
;
16010 /* Scrolling up can leave for example a partially visible line
16011 at the end of the window to be redisplayed. */
16012 /* Set last_row to the glyph row in the current matrix where the
16013 window end line is found. It has been moved up or down in
16014 the matrix by dvpos. */
16015 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16016 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16018 /* If last_row is the window end line, it should display text. */
16019 xassert (last_row
->displays_text_p
);
16021 /* If window end line was partially visible before, begin
16022 displaying at that line. Otherwise begin displaying with the
16023 line following it. */
16024 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16026 init_to_row_start (&it
, w
, last_row
);
16027 it
.vpos
= last_vpos
;
16028 it
.current_y
= last_row
->y
;
16032 init_to_row_end (&it
, w
, last_row
);
16033 it
.vpos
= 1 + last_vpos
;
16034 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16038 /* We may start in a continuation line. If so, we have to
16039 get the right continuation_lines_width and current_x. */
16040 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16041 it
.hpos
= it
.current_x
= 0;
16043 /* Display the rest of the lines at the window end. */
16044 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16045 while (it
.current_y
< it
.last_visible_y
16046 && !fonts_changed_p
)
16048 /* Is it always sure that the display agrees with lines in
16049 the current matrix? I don't think so, so we mark rows
16050 displayed invalid in the current matrix by setting their
16051 enabled_p flag to zero. */
16052 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16053 if (display_line (&it
))
16054 last_text_row_at_end
= it
.glyph_row
- 1;
16058 /* Update window_end_pos and window_end_vpos. */
16059 if (first_unchanged_at_end_row
16060 && !last_text_row_at_end
)
16062 /* Window end line if one of the preserved rows from the current
16063 matrix. Set row to the last row displaying text in current
16064 matrix starting at first_unchanged_at_end_row, after
16066 xassert (first_unchanged_at_end_row
->displays_text_p
);
16067 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16068 first_unchanged_at_end_row
);
16069 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16071 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16072 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16074 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16075 xassert (w
->window_end_bytepos
>= 0);
16076 IF_DEBUG (debug_method_add (w
, "A"));
16078 else if (last_text_row_at_end
)
16081 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16082 w
->window_end_bytepos
16083 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16085 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16086 xassert (w
->window_end_bytepos
>= 0);
16087 IF_DEBUG (debug_method_add (w
, "B"));
16089 else if (last_text_row
)
16091 /* We have displayed either to the end of the window or at the
16092 end of the window, i.e. the last row with text is to be found
16093 in the desired matrix. */
16095 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16096 w
->window_end_bytepos
16097 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16099 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16100 xassert (w
->window_end_bytepos
>= 0);
16102 else if (first_unchanged_at_end_row
== NULL
16103 && last_text_row
== NULL
16104 && last_text_row_at_end
== NULL
)
16106 /* Displayed to end of window, but no line containing text was
16107 displayed. Lines were deleted at the end of the window. */
16108 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16109 int vpos
= XFASTINT (w
->window_end_vpos
);
16110 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16111 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16114 row
== NULL
&& vpos
>= first_vpos
;
16115 --vpos
, --current_row
, --desired_row
)
16117 if (desired_row
->enabled_p
)
16119 if (desired_row
->displays_text_p
)
16122 else if (current_row
->displays_text_p
)
16126 xassert (row
!= NULL
);
16127 w
->window_end_vpos
= make_number (vpos
+ 1);
16128 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16129 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16130 xassert (w
->window_end_bytepos
>= 0);
16131 IF_DEBUG (debug_method_add (w
, "C"));
16136 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16137 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16139 /* Record that display has not been completed. */
16140 w
->window_end_valid
= Qnil
;
16141 w
->desired_matrix
->no_scrolling_p
= 1;
16149 /***********************************************************************
16150 More debugging support
16151 ***********************************************************************/
16155 void dump_glyph_row (struct glyph_row
*, int, int);
16156 void dump_glyph_matrix (struct glyph_matrix
*, int);
16157 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16160 /* Dump the contents of glyph matrix MATRIX on stderr.
16162 GLYPHS 0 means don't show glyph contents.
16163 GLYPHS 1 means show glyphs in short form
16164 GLYPHS > 1 means show glyphs in long form. */
16167 dump_glyph_matrix (matrix
, glyphs
)
16168 struct glyph_matrix
*matrix
;
16172 for (i
= 0; i
< matrix
->nrows
; ++i
)
16173 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16177 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16178 the glyph row and area where the glyph comes from. */
16181 dump_glyph (row
, glyph
, area
)
16182 struct glyph_row
*row
;
16183 struct glyph
*glyph
;
16186 if (glyph
->type
== CHAR_GLYPH
)
16189 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16190 glyph
- row
->glyphs
[TEXT_AREA
],
16193 (BUFFERP (glyph
->object
)
16195 : (STRINGP (glyph
->object
)
16198 glyph
->pixel_width
,
16200 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16204 glyph
->left_box_line_p
,
16205 glyph
->right_box_line_p
);
16207 else if (glyph
->type
== STRETCH_GLYPH
)
16210 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16211 glyph
- row
->glyphs
[TEXT_AREA
],
16214 (BUFFERP (glyph
->object
)
16216 : (STRINGP (glyph
->object
)
16219 glyph
->pixel_width
,
16223 glyph
->left_box_line_p
,
16224 glyph
->right_box_line_p
);
16226 else if (glyph
->type
== IMAGE_GLYPH
)
16229 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16230 glyph
- row
->glyphs
[TEXT_AREA
],
16233 (BUFFERP (glyph
->object
)
16235 : (STRINGP (glyph
->object
)
16238 glyph
->pixel_width
,
16242 glyph
->left_box_line_p
,
16243 glyph
->right_box_line_p
);
16245 else if (glyph
->type
== COMPOSITE_GLYPH
)
16248 " %5d %4c %6d %c %3d 0x%05x",
16249 glyph
- row
->glyphs
[TEXT_AREA
],
16252 (BUFFERP (glyph
->object
)
16254 : (STRINGP (glyph
->object
)
16257 glyph
->pixel_width
,
16259 if (glyph
->u
.cmp
.automatic
)
16262 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16263 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16265 glyph
->left_box_line_p
,
16266 glyph
->right_box_line_p
);
16271 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16272 GLYPHS 0 means don't show glyph contents.
16273 GLYPHS 1 means show glyphs in short form
16274 GLYPHS > 1 means show glyphs in long form. */
16277 dump_glyph_row (row
, vpos
, glyphs
)
16278 struct glyph_row
*row
;
16283 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16284 fprintf (stderr
, "======================================================================\n");
16286 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16287 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16289 MATRIX_ROW_START_CHARPOS (row
),
16290 MATRIX_ROW_END_CHARPOS (row
),
16291 row
->used
[TEXT_AREA
],
16292 row
->contains_overlapping_glyphs_p
,
16294 row
->truncated_on_left_p
,
16295 row
->truncated_on_right_p
,
16297 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16298 row
->displays_text_p
,
16301 row
->ends_in_middle_of_char_p
,
16302 row
->starts_in_middle_of_char_p
,
16308 row
->visible_height
,
16311 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16312 row
->end
.overlay_string_index
,
16313 row
->continuation_lines_width
);
16314 fprintf (stderr
, "%9d %5d\n",
16315 CHARPOS (row
->start
.string_pos
),
16316 CHARPOS (row
->end
.string_pos
));
16317 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16318 row
->end
.dpvec_index
);
16325 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16327 struct glyph
*glyph
= row
->glyphs
[area
];
16328 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16330 /* Glyph for a line end in text. */
16331 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16334 if (glyph
< glyph_end
)
16335 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16337 for (; glyph
< glyph_end
; ++glyph
)
16338 dump_glyph (row
, glyph
, area
);
16341 else if (glyphs
== 1)
16345 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16347 char *s
= (char *) alloca (row
->used
[area
] + 1);
16350 for (i
= 0; i
< row
->used
[area
]; ++i
)
16352 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16353 if (glyph
->type
== CHAR_GLYPH
16354 && glyph
->u
.ch
< 0x80
16355 && glyph
->u
.ch
>= ' ')
16356 s
[i
] = glyph
->u
.ch
;
16362 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16368 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16369 Sdump_glyph_matrix
, 0, 1, "p",
16370 doc
: /* Dump the current matrix of the selected window to stderr.
16371 Shows contents of glyph row structures. With non-nil
16372 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16373 glyphs in short form, otherwise show glyphs in long form. */)
16374 (Lisp_Object glyphs
)
16376 struct window
*w
= XWINDOW (selected_window
);
16377 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16379 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16380 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16381 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16382 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16383 fprintf (stderr
, "=============================================\n");
16384 dump_glyph_matrix (w
->current_matrix
,
16385 NILP (glyphs
) ? 0 : XINT (glyphs
));
16390 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16391 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16394 struct frame
*f
= XFRAME (selected_frame
);
16395 dump_glyph_matrix (f
->current_matrix
, 1);
16400 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16401 doc
: /* Dump glyph row ROW to stderr.
16402 GLYPH 0 means don't dump glyphs.
16403 GLYPH 1 means dump glyphs in short form.
16404 GLYPH > 1 or omitted means dump glyphs in long form. */)
16405 (Lisp_Object row
, Lisp_Object glyphs
)
16407 struct glyph_matrix
*matrix
;
16410 CHECK_NUMBER (row
);
16411 matrix
= XWINDOW (selected_window
)->current_matrix
;
16413 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16414 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16416 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16421 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16422 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16423 GLYPH 0 means don't dump glyphs.
16424 GLYPH 1 means dump glyphs in short form.
16425 GLYPH > 1 or omitted means dump glyphs in long form. */)
16426 (Lisp_Object row
, Lisp_Object glyphs
)
16428 struct frame
*sf
= SELECTED_FRAME ();
16429 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16432 CHECK_NUMBER (row
);
16434 if (vpos
>= 0 && vpos
< m
->nrows
)
16435 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16436 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16441 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16442 doc
: /* Toggle tracing of redisplay.
16443 With ARG, turn tracing on if and only if ARG is positive. */)
16447 trace_redisplay_p
= !trace_redisplay_p
;
16450 arg
= Fprefix_numeric_value (arg
);
16451 trace_redisplay_p
= XINT (arg
) > 0;
16458 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16459 doc
: /* Like `format', but print result to stderr.
16460 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16461 (size_t nargs
, Lisp_Object
*args
)
16463 Lisp_Object s
= Fformat (nargs
, args
);
16464 fprintf (stderr
, "%s", SDATA (s
));
16468 #endif /* GLYPH_DEBUG */
16472 /***********************************************************************
16473 Building Desired Matrix Rows
16474 ***********************************************************************/
16476 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16477 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16479 static struct glyph_row
*
16480 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16482 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16483 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16484 struct buffer
*old
= current_buffer
;
16485 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16486 int arrow_len
= SCHARS (overlay_arrow_string
);
16487 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16488 const unsigned char *p
;
16491 int n_glyphs_before
;
16493 set_buffer_temp (buffer
);
16494 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16495 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16496 SET_TEXT_POS (it
.position
, 0, 0);
16498 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16500 while (p
< arrow_end
)
16502 Lisp_Object face
, ilisp
;
16504 /* Get the next character. */
16506 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16509 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16510 if (! ASCII_CHAR_P (it
.c
))
16511 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16515 /* Get its face. */
16516 ilisp
= make_number (p
- arrow_string
);
16517 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16518 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16520 /* Compute its width, get its glyphs. */
16521 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16522 SET_TEXT_POS (it
.position
, -1, -1);
16523 PRODUCE_GLYPHS (&it
);
16525 /* If this character doesn't fit any more in the line, we have
16526 to remove some glyphs. */
16527 if (it
.current_x
> it
.last_visible_x
)
16529 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16534 set_buffer_temp (old
);
16535 return it
.glyph_row
;
16539 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16540 glyphs are only inserted for terminal frames since we can't really
16541 win with truncation glyphs when partially visible glyphs are
16542 involved. Which glyphs to insert is determined by
16543 produce_special_glyphs. */
16546 insert_left_trunc_glyphs (struct it
*it
)
16548 struct it truncate_it
;
16549 struct glyph
*from
, *end
, *to
, *toend
;
16551 xassert (!FRAME_WINDOW_P (it
->f
));
16553 /* Get the truncation glyphs. */
16555 truncate_it
.current_x
= 0;
16556 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16557 truncate_it
.glyph_row
= &scratch_glyph_row
;
16558 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16559 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16560 truncate_it
.object
= make_number (0);
16561 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16563 /* Overwrite glyphs from IT with truncation glyphs. */
16564 if (!it
->glyph_row
->reversed_p
)
16566 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16567 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16568 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16569 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16574 /* There may be padding glyphs left over. Overwrite them too. */
16575 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16577 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16583 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16587 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16588 that back to front. */
16589 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16590 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16591 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16592 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16594 while (from
>= end
&& to
>= toend
)
16596 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16599 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16600 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16601 while (from
>= end
&& to
>= toend
)
16606 /* Need to free some room before prepending additional
16608 int move_by
= from
- end
+ 1;
16609 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16610 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16612 for ( ; g
>= g0
; g
--)
16614 while (from
>= end
)
16616 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16622 /* Compute the pixel height and width of IT->glyph_row.
16624 Most of the time, ascent and height of a display line will be equal
16625 to the max_ascent and max_height values of the display iterator
16626 structure. This is not the case if
16628 1. We hit ZV without displaying anything. In this case, max_ascent
16629 and max_height will be zero.
16631 2. We have some glyphs that don't contribute to the line height.
16632 (The glyph row flag contributes_to_line_height_p is for future
16633 pixmap extensions).
16635 The first case is easily covered by using default values because in
16636 these cases, the line height does not really matter, except that it
16637 must not be zero. */
16640 compute_line_metrics (struct it
*it
)
16642 struct glyph_row
*row
= it
->glyph_row
;
16644 if (FRAME_WINDOW_P (it
->f
))
16646 int i
, min_y
, max_y
;
16648 /* The line may consist of one space only, that was added to
16649 place the cursor on it. If so, the row's height hasn't been
16651 if (row
->height
== 0)
16653 if (it
->max_ascent
+ it
->max_descent
== 0)
16654 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16655 row
->ascent
= it
->max_ascent
;
16656 row
->height
= it
->max_ascent
+ it
->max_descent
;
16657 row
->phys_ascent
= it
->max_phys_ascent
;
16658 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16659 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16662 /* Compute the width of this line. */
16663 row
->pixel_width
= row
->x
;
16664 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16665 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16667 xassert (row
->pixel_width
>= 0);
16668 xassert (row
->ascent
>= 0 && row
->height
> 0);
16670 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16671 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16673 /* If first line's physical ascent is larger than its logical
16674 ascent, use the physical ascent, and make the row taller.
16675 This makes accented characters fully visible. */
16676 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16677 && row
->phys_ascent
> row
->ascent
)
16679 row
->height
+= row
->phys_ascent
- row
->ascent
;
16680 row
->ascent
= row
->phys_ascent
;
16683 /* Compute how much of the line is visible. */
16684 row
->visible_height
= row
->height
;
16686 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16687 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16689 if (row
->y
< min_y
)
16690 row
->visible_height
-= min_y
- row
->y
;
16691 if (row
->y
+ row
->height
> max_y
)
16692 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16696 row
->pixel_width
= row
->used
[TEXT_AREA
];
16697 if (row
->continued_p
)
16698 row
->pixel_width
-= it
->continuation_pixel_width
;
16699 else if (row
->truncated_on_right_p
)
16700 row
->pixel_width
-= it
->truncation_pixel_width
;
16701 row
->ascent
= row
->phys_ascent
= 0;
16702 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16703 row
->extra_line_spacing
= 0;
16706 /* Compute a hash code for this row. */
16710 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16711 for (i
= 0; i
< row
->used
[area
]; ++i
)
16712 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16713 + row
->glyphs
[area
][i
].u
.val
16714 + row
->glyphs
[area
][i
].face_id
16715 + row
->glyphs
[area
][i
].padding_p
16716 + (row
->glyphs
[area
][i
].type
<< 2));
16719 it
->max_ascent
= it
->max_descent
= 0;
16720 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16724 /* Append one space to the glyph row of iterator IT if doing a
16725 window-based redisplay. The space has the same face as
16726 IT->face_id. Value is non-zero if a space was added.
16728 This function is called to make sure that there is always one glyph
16729 at the end of a glyph row that the cursor can be set on under
16730 window-systems. (If there weren't such a glyph we would not know
16731 how wide and tall a box cursor should be displayed).
16733 At the same time this space let's a nicely handle clearing to the
16734 end of the line if the row ends in italic text. */
16737 append_space_for_newline (struct it
*it
, int default_face_p
)
16739 if (FRAME_WINDOW_P (it
->f
))
16741 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16743 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16744 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16746 /* Save some values that must not be changed.
16747 Must save IT->c and IT->len because otherwise
16748 ITERATOR_AT_END_P wouldn't work anymore after
16749 append_space_for_newline has been called. */
16750 enum display_element_type saved_what
= it
->what
;
16751 int saved_c
= it
->c
, saved_len
= it
->len
;
16752 int saved_char_to_display
= it
->char_to_display
;
16753 int saved_x
= it
->current_x
;
16754 int saved_face_id
= it
->face_id
;
16755 struct text_pos saved_pos
;
16756 Lisp_Object saved_object
;
16759 saved_object
= it
->object
;
16760 saved_pos
= it
->position
;
16762 it
->what
= IT_CHARACTER
;
16763 memset (&it
->position
, 0, sizeof it
->position
);
16764 it
->object
= make_number (0);
16765 it
->c
= it
->char_to_display
= ' ';
16768 if (default_face_p
)
16769 it
->face_id
= DEFAULT_FACE_ID
;
16770 else if (it
->face_before_selective_p
)
16771 it
->face_id
= it
->saved_face_id
;
16772 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16773 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16775 PRODUCE_GLYPHS (it
);
16777 it
->override_ascent
= -1;
16778 it
->constrain_row_ascent_descent_p
= 0;
16779 it
->current_x
= saved_x
;
16780 it
->object
= saved_object
;
16781 it
->position
= saved_pos
;
16782 it
->what
= saved_what
;
16783 it
->face_id
= saved_face_id
;
16784 it
->len
= saved_len
;
16786 it
->char_to_display
= saved_char_to_display
;
16795 /* Extend the face of the last glyph in the text area of IT->glyph_row
16796 to the end of the display line. Called from display_line. If the
16797 glyph row is empty, add a space glyph to it so that we know the
16798 face to draw. Set the glyph row flag fill_line_p. If the glyph
16799 row is R2L, prepend a stretch glyph to cover the empty space to the
16800 left of the leftmost glyph. */
16803 extend_face_to_end_of_line (struct it
*it
)
16806 struct frame
*f
= it
->f
;
16808 /* If line is already filled, do nothing. Non window-system frames
16809 get a grace of one more ``pixel'' because their characters are
16810 1-``pixel'' wide, so they hit the equality too early. This grace
16811 is needed only for R2L rows that are not continued, to produce
16812 one extra blank where we could display the cursor. */
16813 if (it
->current_x
>= it
->last_visible_x
16814 + (!FRAME_WINDOW_P (f
)
16815 && it
->glyph_row
->reversed_p
16816 && !it
->glyph_row
->continued_p
))
16819 /* Face extension extends the background and box of IT->face_id
16820 to the end of the line. If the background equals the background
16821 of the frame, we don't have to do anything. */
16822 if (it
->face_before_selective_p
)
16823 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16825 face
= FACE_FROM_ID (f
, it
->face_id
);
16827 if (FRAME_WINDOW_P (f
)
16828 && it
->glyph_row
->displays_text_p
16829 && face
->box
== FACE_NO_BOX
16830 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16832 && !it
->glyph_row
->reversed_p
)
16835 /* Set the glyph row flag indicating that the face of the last glyph
16836 in the text area has to be drawn to the end of the text area. */
16837 it
->glyph_row
->fill_line_p
= 1;
16839 /* If current character of IT is not ASCII, make sure we have the
16840 ASCII face. This will be automatically undone the next time
16841 get_next_display_element returns a multibyte character. Note
16842 that the character will always be single byte in unibyte
16844 if (!ASCII_CHAR_P (it
->c
))
16846 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16849 if (FRAME_WINDOW_P (f
))
16851 /* If the row is empty, add a space with the current face of IT,
16852 so that we know which face to draw. */
16853 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16855 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16856 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16857 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16859 #ifdef HAVE_WINDOW_SYSTEM
16860 if (it
->glyph_row
->reversed_p
)
16862 /* Prepend a stretch glyph to the row, such that the
16863 rightmost glyph will be drawn flushed all the way to the
16864 right margin of the window. The stretch glyph that will
16865 occupy the empty space, if any, to the left of the
16867 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16868 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16869 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16871 int row_width
, stretch_ascent
, stretch_width
;
16872 struct text_pos saved_pos
;
16873 int saved_face_id
, saved_avoid_cursor
;
16875 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16876 row_width
+= g
->pixel_width
;
16877 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16878 if (stretch_width
> 0)
16881 (((it
->ascent
+ it
->descent
)
16882 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16883 saved_pos
= it
->position
;
16884 memset (&it
->position
, 0, sizeof it
->position
);
16885 saved_avoid_cursor
= it
->avoid_cursor_p
;
16886 it
->avoid_cursor_p
= 1;
16887 saved_face_id
= it
->face_id
;
16888 /* The last row's stretch glyph should get the default
16889 face, to avoid painting the rest of the window with
16890 the region face, if the region ends at ZV. */
16891 if (it
->glyph_row
->ends_at_zv_p
)
16892 it
->face_id
= DEFAULT_FACE_ID
;
16894 it
->face_id
= face
->id
;
16895 append_stretch_glyph (it
, make_number (0), stretch_width
,
16896 it
->ascent
+ it
->descent
, stretch_ascent
);
16897 it
->position
= saved_pos
;
16898 it
->avoid_cursor_p
= saved_avoid_cursor
;
16899 it
->face_id
= saved_face_id
;
16902 #endif /* HAVE_WINDOW_SYSTEM */
16906 /* Save some values that must not be changed. */
16907 int saved_x
= it
->current_x
;
16908 struct text_pos saved_pos
;
16909 Lisp_Object saved_object
;
16910 enum display_element_type saved_what
= it
->what
;
16911 int saved_face_id
= it
->face_id
;
16913 saved_object
= it
->object
;
16914 saved_pos
= it
->position
;
16916 it
->what
= IT_CHARACTER
;
16917 memset (&it
->position
, 0, sizeof it
->position
);
16918 it
->object
= make_number (0);
16919 it
->c
= it
->char_to_display
= ' ';
16921 /* The last row's blank glyphs should get the default face, to
16922 avoid painting the rest of the window with the region face,
16923 if the region ends at ZV. */
16924 if (it
->glyph_row
->ends_at_zv_p
)
16925 it
->face_id
= DEFAULT_FACE_ID
;
16927 it
->face_id
= face
->id
;
16929 PRODUCE_GLYPHS (it
);
16931 while (it
->current_x
<= it
->last_visible_x
)
16932 PRODUCE_GLYPHS (it
);
16934 /* Don't count these blanks really. It would let us insert a left
16935 truncation glyph below and make us set the cursor on them, maybe. */
16936 it
->current_x
= saved_x
;
16937 it
->object
= saved_object
;
16938 it
->position
= saved_pos
;
16939 it
->what
= saved_what
;
16940 it
->face_id
= saved_face_id
;
16945 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16946 trailing whitespace. */
16949 trailing_whitespace_p (EMACS_INT charpos
)
16951 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16954 while (bytepos
< ZV_BYTE
16955 && (c
= FETCH_CHAR (bytepos
),
16956 c
== ' ' || c
== '\t'))
16959 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16961 if (bytepos
!= PT_BYTE
)
16968 /* Highlight trailing whitespace, if any, in ROW. */
16971 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16973 int used
= row
->used
[TEXT_AREA
];
16977 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16978 struct glyph
*glyph
= start
+ used
- 1;
16980 if (row
->reversed_p
)
16982 /* Right-to-left rows need to be processed in the opposite
16983 direction, so swap the edge pointers. */
16985 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16988 /* Skip over glyphs inserted to display the cursor at the
16989 end of a line, for extending the face of the last glyph
16990 to the end of the line on terminals, and for truncation
16991 and continuation glyphs. */
16992 if (!row
->reversed_p
)
16994 while (glyph
>= start
16995 && glyph
->type
== CHAR_GLYPH
16996 && INTEGERP (glyph
->object
))
17001 while (glyph
<= start
17002 && glyph
->type
== CHAR_GLYPH
17003 && INTEGERP (glyph
->object
))
17007 /* If last glyph is a space or stretch, and it's trailing
17008 whitespace, set the face of all trailing whitespace glyphs in
17009 IT->glyph_row to `trailing-whitespace'. */
17010 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17011 && BUFFERP (glyph
->object
)
17012 && (glyph
->type
== STRETCH_GLYPH
17013 || (glyph
->type
== CHAR_GLYPH
17014 && glyph
->u
.ch
== ' '))
17015 && trailing_whitespace_p (glyph
->charpos
))
17017 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17021 if (!row
->reversed_p
)
17023 while (glyph
>= start
17024 && BUFFERP (glyph
->object
)
17025 && (glyph
->type
== STRETCH_GLYPH
17026 || (glyph
->type
== CHAR_GLYPH
17027 && glyph
->u
.ch
== ' ')))
17028 (glyph
--)->face_id
= face_id
;
17032 while (glyph
<= start
17033 && BUFFERP (glyph
->object
)
17034 && (glyph
->type
== STRETCH_GLYPH
17035 || (glyph
->type
== CHAR_GLYPH
17036 && glyph
->u
.ch
== ' ')))
17037 (glyph
++)->face_id
= face_id
;
17044 /* Value is non-zero if glyph row ROW should be
17045 used to hold the cursor. */
17048 cursor_row_p (struct glyph_row
*row
)
17052 if (PT
== CHARPOS (row
->end
.pos
))
17054 /* Suppose the row ends on a string.
17055 Unless the row is continued, that means it ends on a newline
17056 in the string. If it's anything other than a display string
17057 (e.g. a before-string from an overlay), we don't want the
17058 cursor there. (This heuristic seems to give the optimal
17059 behavior for the various types of multi-line strings.) */
17060 if (CHARPOS (row
->end
.string_pos
) >= 0)
17062 if (row
->continued_p
)
17066 /* Check for `display' property. */
17067 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17068 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17069 struct glyph
*glyph
;
17072 for (glyph
= end
; glyph
>= beg
; --glyph
)
17073 if (STRINGP (glyph
->object
))
17076 = Fget_char_property (make_number (PT
),
17080 && display_prop_string_p (prop
, glyph
->object
));
17085 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17087 /* If the row ends in middle of a real character,
17088 and the line is continued, we want the cursor here.
17089 That's because CHARPOS (ROW->end.pos) would equal
17090 PT if PT is before the character. */
17091 if (!row
->ends_in_ellipsis_p
)
17092 result
= row
->continued_p
;
17094 /* If the row ends in an ellipsis, then
17095 CHARPOS (ROW->end.pos) will equal point after the
17096 invisible text. We want that position to be displayed
17097 after the ellipsis. */
17100 /* If the row ends at ZV, display the cursor at the end of that
17101 row instead of at the start of the row below. */
17102 else if (row
->ends_at_zv_p
)
17113 /* Push the display property PROP so that it will be rendered at the
17114 current position in IT. Return 1 if PROP was successfully pushed,
17118 push_display_prop (struct it
*it
, Lisp_Object prop
)
17122 if (STRINGP (prop
))
17124 if (SCHARS (prop
) == 0)
17131 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17132 it
->current
.overlay_string_index
= -1;
17133 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17134 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17135 it
->method
= GET_FROM_STRING
;
17136 it
->stop_charpos
= 0;
17138 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17140 it
->method
= GET_FROM_STRETCH
;
17143 #ifdef HAVE_WINDOW_SYSTEM
17144 else if (IMAGEP (prop
))
17146 it
->what
= IT_IMAGE
;
17147 it
->image_id
= lookup_image (it
->f
, prop
);
17148 it
->method
= GET_FROM_IMAGE
;
17150 #endif /* HAVE_WINDOW_SYSTEM */
17153 pop_it (it
); /* bogus display property, give up */
17160 /* Return the character-property PROP at the current position in IT. */
17163 get_it_property (struct it
*it
, Lisp_Object prop
)
17165 Lisp_Object position
;
17167 if (STRINGP (it
->object
))
17168 position
= make_number (IT_STRING_CHARPOS (*it
));
17169 else if (BUFFERP (it
->object
))
17170 position
= make_number (IT_CHARPOS (*it
));
17174 return Fget_char_property (position
, prop
, it
->object
);
17177 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17180 handle_line_prefix (struct it
*it
)
17182 Lisp_Object prefix
;
17183 if (it
->continuation_lines_width
> 0)
17185 prefix
= get_it_property (it
, Qwrap_prefix
);
17187 prefix
= Vwrap_prefix
;
17191 prefix
= get_it_property (it
, Qline_prefix
);
17193 prefix
= Vline_prefix
;
17195 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17197 /* If the prefix is wider than the window, and we try to wrap
17198 it, it would acquire its own wrap prefix, and so on till the
17199 iterator stack overflows. So, don't wrap the prefix. */
17200 it
->line_wrap
= TRUNCATE
;
17201 it
->avoid_cursor_p
= 1;
17207 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17208 only for R2L lines from display_line, when it decides that too many
17209 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17212 unproduce_glyphs (struct it
*it
, int n
)
17214 struct glyph
*glyph
, *end
;
17216 xassert (it
->glyph_row
);
17217 xassert (it
->glyph_row
->reversed_p
);
17218 xassert (it
->area
== TEXT_AREA
);
17219 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17221 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17222 n
= it
->glyph_row
->used
[TEXT_AREA
];
17223 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17224 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17225 for ( ; glyph
< end
; glyph
++)
17226 glyph
[-n
] = *glyph
;
17229 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17230 and ROW->maxpos. */
17232 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17233 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17234 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17236 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17237 lines' rows is implemented for bidi-reordered rows. */
17239 /* ROW->minpos is the value of min_pos, the minimal buffer position
17242 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17244 /* We didn't find _any_ valid buffer positions in any of the
17245 glyphs, so we must trust the iterator's computed positions. */
17246 row
->minpos
= row
->start
.pos
;
17249 max_pos
= CHARPOS (it
->current
.pos
);
17250 max_bpos
= BYTEPOS (it
->current
.pos
);
17253 /* Here are the various use-cases for ending the row, and the
17254 corresponding values for ROW->maxpos:
17256 Line ends in a newline from buffer eol_pos + 1
17257 Line is continued from buffer max_pos + 1
17258 Line is truncated on right it->current.pos
17259 Line ends in a newline from string max_pos
17260 Line is continued from string max_pos
17261 Line is continued from display vector max_pos
17262 Line is entirely from a string min_pos == max_pos
17263 Line is entirely from a display vector min_pos == max_pos
17264 Line that ends at ZV ZV
17266 If you discover other use-cases, please add them here as
17268 if (row
->ends_at_zv_p
)
17269 row
->maxpos
= it
->current
.pos
;
17270 else if (row
->used
[TEXT_AREA
])
17272 if (row
->ends_in_newline_from_string_p
)
17273 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17274 else if (CHARPOS (it
->eol_pos
) > 0)
17275 SET_TEXT_POS (row
->maxpos
,
17276 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17277 else if (row
->continued_p
)
17279 /* If max_pos is different from IT's current position, it
17280 means IT->method does not belong to the display element
17281 at max_pos. However, it also means that the display
17282 element at max_pos was displayed in its entirety on this
17283 line, which is equivalent to saying that the next line
17284 starts at the next buffer position. */
17285 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17286 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17289 INC_BOTH (max_pos
, max_bpos
);
17290 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17293 else if (row
->truncated_on_right_p
)
17294 /* display_line already called reseat_at_next_visible_line_start,
17295 which puts the iterator at the beginning of the next line, in
17296 the logical order. */
17297 row
->maxpos
= it
->current
.pos
;
17298 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17299 /* A line that is entirely from a string/image/stretch... */
17300 row
->maxpos
= row
->minpos
;
17305 row
->maxpos
= it
->current
.pos
;
17308 /* Construct the glyph row IT->glyph_row in the desired matrix of
17309 IT->w from text at the current position of IT. See dispextern.h
17310 for an overview of struct it. Value is non-zero if
17311 IT->glyph_row displays text, as opposed to a line displaying ZV
17315 display_line (struct it
*it
)
17317 struct glyph_row
*row
= it
->glyph_row
;
17318 Lisp_Object overlay_arrow_string
;
17320 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17321 int wrap_row_used
= -1;
17322 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17323 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17324 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17325 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17326 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17328 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17329 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17331 /* We always start displaying at hpos zero even if hscrolled. */
17332 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17334 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17335 >= it
->w
->desired_matrix
->nrows
)
17337 it
->w
->nrows_scale_factor
++;
17338 fonts_changed_p
= 1;
17342 /* Is IT->w showing the region? */
17343 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17345 /* Clear the result glyph row and enable it. */
17346 prepare_desired_row (row
);
17348 row
->y
= it
->current_y
;
17349 row
->start
= it
->start
;
17350 row
->continuation_lines_width
= it
->continuation_lines_width
;
17351 row
->displays_text_p
= 1;
17352 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17353 it
->starts_in_middle_of_char_p
= 0;
17355 /* Arrange the overlays nicely for our purposes. Usually, we call
17356 display_line on only one line at a time, in which case this
17357 can't really hurt too much, or we call it on lines which appear
17358 one after another in the buffer, in which case all calls to
17359 recenter_overlay_lists but the first will be pretty cheap. */
17360 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17362 /* Move over display elements that are not visible because we are
17363 hscrolled. This may stop at an x-position < IT->first_visible_x
17364 if the first glyph is partially visible or if we hit a line end. */
17365 if (it
->current_x
< it
->first_visible_x
)
17367 this_line_min_pos
= row
->start
.pos
;
17368 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17369 MOVE_TO_POS
| MOVE_TO_X
);
17370 /* Record the smallest positions seen while we moved over
17371 display elements that are not visible. This is needed by
17372 redisplay_internal for optimizing the case where the cursor
17373 stays inside the same line. The rest of this function only
17374 considers positions that are actually displayed, so
17375 RECORD_MAX_MIN_POS will not otherwise record positions that
17376 are hscrolled to the left of the left edge of the window. */
17377 min_pos
= CHARPOS (this_line_min_pos
);
17378 min_bpos
= BYTEPOS (this_line_min_pos
);
17382 /* We only do this when not calling `move_it_in_display_line_to'
17383 above, because move_it_in_display_line_to calls
17384 handle_line_prefix itself. */
17385 handle_line_prefix (it
);
17388 /* Get the initial row height. This is either the height of the
17389 text hscrolled, if there is any, or zero. */
17390 row
->ascent
= it
->max_ascent
;
17391 row
->height
= it
->max_ascent
+ it
->max_descent
;
17392 row
->phys_ascent
= it
->max_phys_ascent
;
17393 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17394 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17396 /* Utility macro to record max and min buffer positions seen until now. */
17397 #define RECORD_MAX_MIN_POS(IT) \
17400 if (IT_CHARPOS (*(IT)) < min_pos) \
17402 min_pos = IT_CHARPOS (*(IT)); \
17403 min_bpos = IT_BYTEPOS (*(IT)); \
17405 if (IT_CHARPOS (*(IT)) > max_pos) \
17407 max_pos = IT_CHARPOS (*(IT)); \
17408 max_bpos = IT_BYTEPOS (*(IT)); \
17413 /* Loop generating characters. The loop is left with IT on the next
17414 character to display. */
17417 int n_glyphs_before
, hpos_before
, x_before
;
17419 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17421 /* Retrieve the next thing to display. Value is zero if end of
17423 if (!get_next_display_element (it
))
17425 /* Maybe add a space at the end of this line that is used to
17426 display the cursor there under X. Set the charpos of the
17427 first glyph of blank lines not corresponding to any text
17429 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17430 row
->exact_window_width_line_p
= 1;
17431 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17432 || row
->used
[TEXT_AREA
] == 0)
17434 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17435 row
->displays_text_p
= 0;
17437 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17438 && (!MINI_WINDOW_P (it
->w
)
17439 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17440 row
->indicate_empty_line_p
= 1;
17443 it
->continuation_lines_width
= 0;
17444 row
->ends_at_zv_p
= 1;
17445 /* A row that displays right-to-left text must always have
17446 its last face extended all the way to the end of line,
17447 even if this row ends in ZV, because we still write to
17448 the screen left to right. */
17449 if (row
->reversed_p
)
17450 extend_face_to_end_of_line (it
);
17454 /* Now, get the metrics of what we want to display. This also
17455 generates glyphs in `row' (which is IT->glyph_row). */
17456 n_glyphs_before
= row
->used
[TEXT_AREA
];
17459 /* Remember the line height so far in case the next element doesn't
17460 fit on the line. */
17461 if (it
->line_wrap
!= TRUNCATE
)
17463 ascent
= it
->max_ascent
;
17464 descent
= it
->max_descent
;
17465 phys_ascent
= it
->max_phys_ascent
;
17466 phys_descent
= it
->max_phys_descent
;
17468 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17470 if (IT_DISPLAYING_WHITESPACE (it
))
17476 wrap_row_used
= row
->used
[TEXT_AREA
];
17477 wrap_row_ascent
= row
->ascent
;
17478 wrap_row_height
= row
->height
;
17479 wrap_row_phys_ascent
= row
->phys_ascent
;
17480 wrap_row_phys_height
= row
->phys_height
;
17481 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17482 wrap_row_min_pos
= min_pos
;
17483 wrap_row_min_bpos
= min_bpos
;
17484 wrap_row_max_pos
= max_pos
;
17485 wrap_row_max_bpos
= max_bpos
;
17491 PRODUCE_GLYPHS (it
);
17493 /* If this display element was in marginal areas, continue with
17495 if (it
->area
!= TEXT_AREA
)
17497 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17498 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17499 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17500 row
->phys_height
= max (row
->phys_height
,
17501 it
->max_phys_ascent
+ it
->max_phys_descent
);
17502 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17503 it
->max_extra_line_spacing
);
17504 set_iterator_to_next (it
, 1);
17508 /* Does the display element fit on the line? If we truncate
17509 lines, we should draw past the right edge of the window. If
17510 we don't truncate, we want to stop so that we can display the
17511 continuation glyph before the right margin. If lines are
17512 continued, there are two possible strategies for characters
17513 resulting in more than 1 glyph (e.g. tabs): Display as many
17514 glyphs as possible in this line and leave the rest for the
17515 continuation line, or display the whole element in the next
17516 line. Original redisplay did the former, so we do it also. */
17517 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17518 hpos_before
= it
->hpos
;
17521 if (/* Not a newline. */
17523 /* Glyphs produced fit entirely in the line. */
17524 && it
->current_x
< it
->last_visible_x
)
17526 it
->hpos
+= nglyphs
;
17527 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17528 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17529 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17530 row
->phys_height
= max (row
->phys_height
,
17531 it
->max_phys_ascent
+ it
->max_phys_descent
);
17532 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17533 it
->max_extra_line_spacing
);
17534 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17535 row
->x
= x
- it
->first_visible_x
;
17536 /* Record the maximum and minimum buffer positions seen so
17537 far in glyphs that will be displayed by this row. */
17539 RECORD_MAX_MIN_POS (it
);
17544 struct glyph
*glyph
;
17546 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17548 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17549 new_x
= x
+ glyph
->pixel_width
;
17551 if (/* Lines are continued. */
17552 it
->line_wrap
!= TRUNCATE
17553 && (/* Glyph doesn't fit on the line. */
17554 new_x
> it
->last_visible_x
17555 /* Or it fits exactly on a window system frame. */
17556 || (new_x
== it
->last_visible_x
17557 && FRAME_WINDOW_P (it
->f
))))
17559 /* End of a continued line. */
17562 || (new_x
== it
->last_visible_x
17563 && FRAME_WINDOW_P (it
->f
)))
17565 /* Current glyph is the only one on the line or
17566 fits exactly on the line. We must continue
17567 the line because we can't draw the cursor
17568 after the glyph. */
17569 row
->continued_p
= 1;
17570 it
->current_x
= new_x
;
17571 it
->continuation_lines_width
+= new_x
;
17573 /* Record the maximum and minimum buffer
17574 positions seen so far in glyphs that will be
17575 displayed by this row. */
17577 RECORD_MAX_MIN_POS (it
);
17578 if (i
== nglyphs
- 1)
17580 /* If line-wrap is on, check if a previous
17581 wrap point was found. */
17582 if (wrap_row_used
> 0
17583 /* Even if there is a previous wrap
17584 point, continue the line here as
17585 usual, if (i) the previous character
17586 was a space or tab AND (ii) the
17587 current character is not. */
17589 || IT_DISPLAYING_WHITESPACE (it
)))
17592 set_iterator_to_next (it
, 1);
17593 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17595 if (!get_next_display_element (it
))
17597 row
->exact_window_width_line_p
= 1;
17598 it
->continuation_lines_width
= 0;
17599 row
->continued_p
= 0;
17600 row
->ends_at_zv_p
= 1;
17602 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17604 row
->continued_p
= 0;
17605 row
->exact_window_width_line_p
= 1;
17610 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17611 && !FRAME_WINDOW_P (it
->f
))
17613 /* A padding glyph that doesn't fit on this line.
17614 This means the whole character doesn't fit
17616 if (row
->reversed_p
)
17617 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17618 - n_glyphs_before
);
17619 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17621 /* Fill the rest of the row with continuation
17622 glyphs like in 20.x. */
17623 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17624 < row
->glyphs
[1 + TEXT_AREA
])
17625 produce_special_glyphs (it
, IT_CONTINUATION
);
17627 row
->continued_p
= 1;
17628 it
->current_x
= x_before
;
17629 it
->continuation_lines_width
+= x_before
;
17631 /* Restore the height to what it was before the
17632 element not fitting on the line. */
17633 it
->max_ascent
= ascent
;
17634 it
->max_descent
= descent
;
17635 it
->max_phys_ascent
= phys_ascent
;
17636 it
->max_phys_descent
= phys_descent
;
17638 else if (wrap_row_used
> 0)
17641 if (row
->reversed_p
)
17642 unproduce_glyphs (it
,
17643 row
->used
[TEXT_AREA
] - wrap_row_used
);
17645 it
->continuation_lines_width
+= wrap_x
;
17646 row
->used
[TEXT_AREA
] = wrap_row_used
;
17647 row
->ascent
= wrap_row_ascent
;
17648 row
->height
= wrap_row_height
;
17649 row
->phys_ascent
= wrap_row_phys_ascent
;
17650 row
->phys_height
= wrap_row_phys_height
;
17651 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17652 min_pos
= wrap_row_min_pos
;
17653 min_bpos
= wrap_row_min_bpos
;
17654 max_pos
= wrap_row_max_pos
;
17655 max_bpos
= wrap_row_max_bpos
;
17656 row
->continued_p
= 1;
17657 row
->ends_at_zv_p
= 0;
17658 row
->exact_window_width_line_p
= 0;
17659 it
->continuation_lines_width
+= x
;
17661 /* Make sure that a non-default face is extended
17662 up to the right margin of the window. */
17663 extend_face_to_end_of_line (it
);
17665 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17667 /* A TAB that extends past the right edge of the
17668 window. This produces a single glyph on
17669 window system frames. We leave the glyph in
17670 this row and let it fill the row, but don't
17671 consume the TAB. */
17672 it
->continuation_lines_width
+= it
->last_visible_x
;
17673 row
->ends_in_middle_of_char_p
= 1;
17674 row
->continued_p
= 1;
17675 glyph
->pixel_width
= it
->last_visible_x
- x
;
17676 it
->starts_in_middle_of_char_p
= 1;
17680 /* Something other than a TAB that draws past
17681 the right edge of the window. Restore
17682 positions to values before the element. */
17683 if (row
->reversed_p
)
17684 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17685 - (n_glyphs_before
+ i
));
17686 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17688 /* Display continuation glyphs. */
17689 if (!FRAME_WINDOW_P (it
->f
))
17690 produce_special_glyphs (it
, IT_CONTINUATION
);
17691 row
->continued_p
= 1;
17693 it
->current_x
= x_before
;
17694 it
->continuation_lines_width
+= x
;
17695 extend_face_to_end_of_line (it
);
17697 if (nglyphs
> 1 && i
> 0)
17699 row
->ends_in_middle_of_char_p
= 1;
17700 it
->starts_in_middle_of_char_p
= 1;
17703 /* Restore the height to what it was before the
17704 element not fitting on the line. */
17705 it
->max_ascent
= ascent
;
17706 it
->max_descent
= descent
;
17707 it
->max_phys_ascent
= phys_ascent
;
17708 it
->max_phys_descent
= phys_descent
;
17713 else if (new_x
> it
->first_visible_x
)
17715 /* Increment number of glyphs actually displayed. */
17718 /* Record the maximum and minimum buffer positions
17719 seen so far in glyphs that will be displayed by
17722 RECORD_MAX_MIN_POS (it
);
17724 if (x
< it
->first_visible_x
)
17725 /* Glyph is partially visible, i.e. row starts at
17726 negative X position. */
17727 row
->x
= x
- it
->first_visible_x
;
17731 /* Glyph is completely off the left margin of the
17732 window. This should not happen because of the
17733 move_it_in_display_line at the start of this
17734 function, unless the text display area of the
17735 window is empty. */
17736 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17740 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17741 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17742 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17743 row
->phys_height
= max (row
->phys_height
,
17744 it
->max_phys_ascent
+ it
->max_phys_descent
);
17745 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17746 it
->max_extra_line_spacing
);
17748 /* End of this display line if row is continued. */
17749 if (row
->continued_p
|| row
->ends_at_zv_p
)
17754 /* Is this a line end? If yes, we're also done, after making
17755 sure that a non-default face is extended up to the right
17756 margin of the window. */
17757 if (ITERATOR_AT_END_OF_LINE_P (it
))
17759 int used_before
= row
->used
[TEXT_AREA
];
17761 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17763 /* Add a space at the end of the line that is used to
17764 display the cursor there. */
17765 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17766 append_space_for_newline (it
, 0);
17768 /* Extend the face to the end of the line. */
17769 extend_face_to_end_of_line (it
);
17771 /* Make sure we have the position. */
17772 if (used_before
== 0)
17773 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17775 /* Record the position of the newline, for use in
17777 it
->eol_pos
= it
->current
.pos
;
17779 /* Consume the line end. This skips over invisible lines. */
17780 set_iterator_to_next (it
, 1);
17781 it
->continuation_lines_width
= 0;
17785 /* Proceed with next display element. Note that this skips
17786 over lines invisible because of selective display. */
17787 set_iterator_to_next (it
, 1);
17789 /* If we truncate lines, we are done when the last displayed
17790 glyphs reach past the right margin of the window. */
17791 if (it
->line_wrap
== TRUNCATE
17792 && (FRAME_WINDOW_P (it
->f
)
17793 ? (it
->current_x
>= it
->last_visible_x
)
17794 : (it
->current_x
> it
->last_visible_x
)))
17796 /* Maybe add truncation glyphs. */
17797 if (!FRAME_WINDOW_P (it
->f
))
17801 if (!row
->reversed_p
)
17803 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17804 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17809 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17810 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17812 /* Remove any padding glyphs at the front of ROW, to
17813 make room for the truncation glyphs we will be
17814 adding below. The loop below always inserts at
17815 least one truncation glyph, so also remove the
17816 last glyph added to ROW. */
17817 unproduce_glyphs (it
, i
+ 1);
17818 /* Adjust i for the loop below. */
17819 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17822 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17824 row
->used
[TEXT_AREA
] = i
;
17825 produce_special_glyphs (it
, IT_TRUNCATION
);
17828 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17830 /* Don't truncate if we can overflow newline into fringe. */
17831 if (!get_next_display_element (it
))
17833 it
->continuation_lines_width
= 0;
17834 row
->ends_at_zv_p
= 1;
17835 row
->exact_window_width_line_p
= 1;
17838 if (ITERATOR_AT_END_OF_LINE_P (it
))
17840 row
->exact_window_width_line_p
= 1;
17841 goto at_end_of_line
;
17845 row
->truncated_on_right_p
= 1;
17846 it
->continuation_lines_width
= 0;
17847 reseat_at_next_visible_line_start (it
, 0);
17848 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17849 it
->hpos
= hpos_before
;
17850 it
->current_x
= x_before
;
17855 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17856 at the left window margin. */
17857 if (it
->first_visible_x
17858 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17860 if (!FRAME_WINDOW_P (it
->f
))
17861 insert_left_trunc_glyphs (it
);
17862 row
->truncated_on_left_p
= 1;
17865 /* Remember the position at which this line ends.
17867 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17868 cannot be before the call to find_row_edges below, since that is
17869 where these positions are determined. */
17870 row
->end
= it
->current
;
17873 row
->minpos
= row
->start
.pos
;
17874 row
->maxpos
= row
->end
.pos
;
17878 /* ROW->minpos and ROW->maxpos must be the smallest and
17879 `1 + the largest' buffer positions in ROW. But if ROW was
17880 bidi-reordered, these two positions can be anywhere in the
17881 row, so we must determine them now. */
17882 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17885 /* If the start of this line is the overlay arrow-position, then
17886 mark this glyph row as the one containing the overlay arrow.
17887 This is clearly a mess with variable size fonts. It would be
17888 better to let it be displayed like cursors under X. */
17889 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17890 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17891 !NILP (overlay_arrow_string
)))
17893 /* Overlay arrow in window redisplay is a fringe bitmap. */
17894 if (STRINGP (overlay_arrow_string
))
17896 struct glyph_row
*arrow_row
17897 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17898 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17899 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17900 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17901 struct glyph
*p2
, *end
;
17903 /* Copy the arrow glyphs. */
17904 while (glyph
< arrow_end
)
17907 /* Throw away padding glyphs. */
17909 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17910 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17916 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17921 xassert (INTEGERP (overlay_arrow_string
));
17922 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17924 overlay_arrow_seen
= 1;
17927 /* Compute pixel dimensions of this line. */
17928 compute_line_metrics (it
);
17930 /* Record whether this row ends inside an ellipsis. */
17931 row
->ends_in_ellipsis_p
17932 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17933 && it
->ellipsis_p
);
17935 /* Save fringe bitmaps in this row. */
17936 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17937 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17938 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17939 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17941 it
->left_user_fringe_bitmap
= 0;
17942 it
->left_user_fringe_face_id
= 0;
17943 it
->right_user_fringe_bitmap
= 0;
17944 it
->right_user_fringe_face_id
= 0;
17946 /* Maybe set the cursor. */
17947 cvpos
= it
->w
->cursor
.vpos
;
17949 /* In bidi-reordered rows, keep checking for proper cursor
17950 position even if one has been found already, because buffer
17951 positions in such rows change non-linearly with ROW->VPOS,
17952 when a line is continued. One exception: when we are at ZV,
17953 display cursor on the first suitable glyph row, since all
17954 the empty rows after that also have their position set to ZV. */
17955 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17956 lines' rows is implemented for bidi-reordered rows. */
17958 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17959 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17960 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17961 && cursor_row_p (row
))
17962 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17964 /* Highlight trailing whitespace. */
17965 if (!NILP (Vshow_trailing_whitespace
))
17966 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17968 /* Prepare for the next line. This line starts horizontally at (X
17969 HPOS) = (0 0). Vertical positions are incremented. As a
17970 convenience for the caller, IT->glyph_row is set to the next
17972 it
->current_x
= it
->hpos
= 0;
17973 it
->current_y
+= row
->height
;
17974 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17977 /* The next row should by default use the same value of the
17978 reversed_p flag as this one. set_iterator_to_next decides when
17979 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17980 the flag accordingly. */
17981 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17982 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17983 it
->start
= row
->end
;
17984 return row
->displays_text_p
;
17986 #undef RECORD_MAX_MIN_POS
17989 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17990 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17991 doc
: /* Return paragraph direction at point in BUFFER.
17992 Value is either `left-to-right' or `right-to-left'.
17993 If BUFFER is omitted or nil, it defaults to the current buffer.
17995 Paragraph direction determines how the text in the paragraph is displayed.
17996 In left-to-right paragraphs, text begins at the left margin of the window
17997 and the reading direction is generally left to right. In right-to-left
17998 paragraphs, text begins at the right margin and is read from right to left.
18000 See also `bidi-paragraph-direction'. */)
18001 (Lisp_Object buffer
)
18003 struct buffer
*buf
= current_buffer
;
18004 struct buffer
*old
= buf
;
18006 if (! NILP (buffer
))
18008 CHECK_BUFFER (buffer
);
18009 buf
= XBUFFER (buffer
);
18012 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18013 return Qleft_to_right
;
18014 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18015 return BVAR (buf
, bidi_paragraph_direction
);
18018 /* Determine the direction from buffer text. We could try to
18019 use current_matrix if it is up to date, but this seems fast
18020 enough as it is. */
18021 struct bidi_it itb
;
18022 EMACS_INT pos
= BUF_PT (buf
);
18023 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18026 set_buffer_temp (buf
);
18027 /* bidi_paragraph_init finds the base direction of the paragraph
18028 by searching forward from paragraph start. We need the base
18029 direction of the current or _previous_ paragraph, so we need
18030 to make sure we are within that paragraph. To that end, find
18031 the previous non-empty line. */
18032 if (pos
>= ZV
&& pos
> BEGV
)
18035 bytepos
= CHAR_TO_BYTE (pos
);
18037 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18038 || c
== ' ' || c
== '\t' || c
== '\f')
18040 if (bytepos
<= BEGV_BYTE
)
18045 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18048 itb
.bytepos
= bytepos
;
18050 itb
.separator_limit
= -1;
18051 itb
.paragraph_dir
= NEUTRAL_DIR
;
18053 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18054 set_buffer_temp (old
);
18055 switch (itb
.paragraph_dir
)
18058 return Qleft_to_right
;
18061 return Qright_to_left
;
18071 /***********************************************************************
18073 ***********************************************************************/
18075 /* Redisplay the menu bar in the frame for window W.
18077 The menu bar of X frames that don't have X toolkit support is
18078 displayed in a special window W->frame->menu_bar_window.
18080 The menu bar of terminal frames is treated specially as far as
18081 glyph matrices are concerned. Menu bar lines are not part of
18082 windows, so the update is done directly on the frame matrix rows
18083 for the menu bar. */
18086 display_menu_bar (struct window
*w
)
18088 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18093 /* Don't do all this for graphical frames. */
18095 if (FRAME_W32_P (f
))
18098 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18104 if (FRAME_NS_P (f
))
18106 #endif /* HAVE_NS */
18108 #ifdef USE_X_TOOLKIT
18109 xassert (!FRAME_WINDOW_P (f
));
18110 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18111 it
.first_visible_x
= 0;
18112 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18113 #else /* not USE_X_TOOLKIT */
18114 if (FRAME_WINDOW_P (f
))
18116 /* Menu bar lines are displayed in the desired matrix of the
18117 dummy window menu_bar_window. */
18118 struct window
*menu_w
;
18119 xassert (WINDOWP (f
->menu_bar_window
));
18120 menu_w
= XWINDOW (f
->menu_bar_window
);
18121 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18123 it
.first_visible_x
= 0;
18124 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18128 /* This is a TTY frame, i.e. character hpos/vpos are used as
18130 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18132 it
.first_visible_x
= 0;
18133 it
.last_visible_x
= FRAME_COLS (f
);
18135 #endif /* not USE_X_TOOLKIT */
18137 if (! mode_line_inverse_video
)
18138 /* Force the menu-bar to be displayed in the default face. */
18139 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18141 /* Clear all rows of the menu bar. */
18142 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18144 struct glyph_row
*row
= it
.glyph_row
+ i
;
18145 clear_glyph_row (row
);
18146 row
->enabled_p
= 1;
18147 row
->full_width_p
= 1;
18150 /* Display all items of the menu bar. */
18151 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18152 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18154 Lisp_Object string
;
18156 /* Stop at nil string. */
18157 string
= AREF (items
, i
+ 1);
18161 /* Remember where item was displayed. */
18162 ASET (items
, i
+ 3, make_number (it
.hpos
));
18164 /* Display the item, pad with one space. */
18165 if (it
.current_x
< it
.last_visible_x
)
18166 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18167 SCHARS (string
) + 1, 0, 0, -1);
18170 /* Fill out the line with spaces. */
18171 if (it
.current_x
< it
.last_visible_x
)
18172 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18174 /* Compute the total height of the lines. */
18175 compute_line_metrics (&it
);
18180 /***********************************************************************
18182 ***********************************************************************/
18184 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18185 FORCE is non-zero, redisplay mode lines unconditionally.
18186 Otherwise, redisplay only mode lines that are garbaged. Value is
18187 the number of windows whose mode lines were redisplayed. */
18190 redisplay_mode_lines (Lisp_Object window
, int force
)
18194 while (!NILP (window
))
18196 struct window
*w
= XWINDOW (window
);
18198 if (WINDOWP (w
->hchild
))
18199 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18200 else if (WINDOWP (w
->vchild
))
18201 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18203 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18204 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18206 struct text_pos lpoint
;
18207 struct buffer
*old
= current_buffer
;
18209 /* Set the window's buffer for the mode line display. */
18210 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18211 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18213 /* Point refers normally to the selected window. For any
18214 other window, set up appropriate value. */
18215 if (!EQ (window
, selected_window
))
18217 struct text_pos pt
;
18219 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18220 if (CHARPOS (pt
) < BEGV
)
18221 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18222 else if (CHARPOS (pt
) > (ZV
- 1))
18223 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18225 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18228 /* Display mode lines. */
18229 clear_glyph_matrix (w
->desired_matrix
);
18230 if (display_mode_lines (w
))
18233 w
->must_be_updated_p
= 1;
18236 /* Restore old settings. */
18237 set_buffer_internal_1 (old
);
18238 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18248 /* Display the mode and/or header line of window W. Value is the
18249 sum number of mode lines and header lines displayed. */
18252 display_mode_lines (struct window
*w
)
18254 Lisp_Object old_selected_window
, old_selected_frame
;
18257 old_selected_frame
= selected_frame
;
18258 selected_frame
= w
->frame
;
18259 old_selected_window
= selected_window
;
18260 XSETWINDOW (selected_window
, w
);
18262 /* These will be set while the mode line specs are processed. */
18263 line_number_displayed
= 0;
18264 w
->column_number_displayed
= Qnil
;
18266 if (WINDOW_WANTS_MODELINE_P (w
))
18268 struct window
*sel_w
= XWINDOW (old_selected_window
);
18270 /* Select mode line face based on the real selected window. */
18271 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18272 BVAR (current_buffer
, mode_line_format
));
18276 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18278 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18279 BVAR (current_buffer
, header_line_format
));
18283 selected_frame
= old_selected_frame
;
18284 selected_window
= old_selected_window
;
18289 /* Display mode or header line of window W. FACE_ID specifies which
18290 line to display; it is either MODE_LINE_FACE_ID or
18291 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18292 display. Value is the pixel height of the mode/header line
18296 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18300 int count
= SPECPDL_INDEX ();
18302 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18303 /* Don't extend on a previously drawn mode-line.
18304 This may happen if called from pos_visible_p. */
18305 it
.glyph_row
->enabled_p
= 0;
18306 prepare_desired_row (it
.glyph_row
);
18308 it
.glyph_row
->mode_line_p
= 1;
18310 if (! mode_line_inverse_video
)
18311 /* Force the mode-line to be displayed in the default face. */
18312 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18314 record_unwind_protect (unwind_format_mode_line
,
18315 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18317 mode_line_target
= MODE_LINE_DISPLAY
;
18319 /* Temporarily make frame's keyboard the current kboard so that
18320 kboard-local variables in the mode_line_format will get the right
18322 push_kboard (FRAME_KBOARD (it
.f
));
18323 record_unwind_save_match_data ();
18324 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18327 unbind_to (count
, Qnil
);
18329 /* Fill up with spaces. */
18330 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18332 compute_line_metrics (&it
);
18333 it
.glyph_row
->full_width_p
= 1;
18334 it
.glyph_row
->continued_p
= 0;
18335 it
.glyph_row
->truncated_on_left_p
= 0;
18336 it
.glyph_row
->truncated_on_right_p
= 0;
18338 /* Make a 3D mode-line have a shadow at its right end. */
18339 face
= FACE_FROM_ID (it
.f
, face_id
);
18340 extend_face_to_end_of_line (&it
);
18341 if (face
->box
!= FACE_NO_BOX
)
18343 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18344 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18345 last
->right_box_line_p
= 1;
18348 return it
.glyph_row
->height
;
18351 /* Move element ELT in LIST to the front of LIST.
18352 Return the updated list. */
18355 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18357 register Lisp_Object tail
, prev
;
18358 register Lisp_Object tem
;
18362 while (CONSP (tail
))
18368 /* Splice out the link TAIL. */
18370 list
= XCDR (tail
);
18372 Fsetcdr (prev
, XCDR (tail
));
18374 /* Now make it the first. */
18375 Fsetcdr (tail
, list
);
18380 tail
= XCDR (tail
);
18384 /* Not found--return unchanged LIST. */
18388 /* Contribute ELT to the mode line for window IT->w. How it
18389 translates into text depends on its data type.
18391 IT describes the display environment in which we display, as usual.
18393 DEPTH is the depth in recursion. It is used to prevent
18394 infinite recursion here.
18396 FIELD_WIDTH is the number of characters the display of ELT should
18397 occupy in the mode line, and PRECISION is the maximum number of
18398 characters to display from ELT's representation. See
18399 display_string for details.
18401 Returns the hpos of the end of the text generated by ELT.
18403 PROPS is a property list to add to any string we encounter.
18405 If RISKY is nonzero, remove (disregard) any properties in any string
18406 we encounter, and ignore :eval and :propertize.
18408 The global variable `mode_line_target' determines whether the
18409 output is passed to `store_mode_line_noprop',
18410 `store_mode_line_string', or `display_string'. */
18413 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18414 Lisp_Object elt
, Lisp_Object props
, int risky
)
18416 int n
= 0, field
, prec
;
18421 elt
= build_string ("*too-deep*");
18425 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18429 /* A string: output it and check for %-constructs within it. */
18431 EMACS_INT offset
= 0;
18433 if (SCHARS (elt
) > 0
18434 && (!NILP (props
) || risky
))
18436 Lisp_Object oprops
, aelt
;
18437 oprops
= Ftext_properties_at (make_number (0), elt
);
18439 /* If the starting string's properties are not what
18440 we want, translate the string. Also, if the string
18441 is risky, do that anyway. */
18443 if (NILP (Fequal (props
, oprops
)) || risky
)
18445 /* If the starting string has properties,
18446 merge the specified ones onto the existing ones. */
18447 if (! NILP (oprops
) && !risky
)
18451 oprops
= Fcopy_sequence (oprops
);
18453 while (CONSP (tem
))
18455 oprops
= Fplist_put (oprops
, XCAR (tem
),
18456 XCAR (XCDR (tem
)));
18457 tem
= XCDR (XCDR (tem
));
18462 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18463 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18465 /* AELT is what we want. Move it to the front
18466 without consing. */
18468 mode_line_proptrans_alist
18469 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18475 /* If AELT has the wrong props, it is useless.
18476 so get rid of it. */
18478 mode_line_proptrans_alist
18479 = Fdelq (aelt
, mode_line_proptrans_alist
);
18481 elt
= Fcopy_sequence (elt
);
18482 Fset_text_properties (make_number (0), Flength (elt
),
18484 /* Add this item to mode_line_proptrans_alist. */
18485 mode_line_proptrans_alist
18486 = Fcons (Fcons (elt
, props
),
18487 mode_line_proptrans_alist
);
18488 /* Truncate mode_line_proptrans_alist
18489 to at most 50 elements. */
18490 tem
= Fnthcdr (make_number (50),
18491 mode_line_proptrans_alist
);
18493 XSETCDR (tem
, Qnil
);
18502 prec
= precision
- n
;
18503 switch (mode_line_target
)
18505 case MODE_LINE_NOPROP
:
18506 case MODE_LINE_TITLE
:
18507 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18509 case MODE_LINE_STRING
:
18510 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18512 case MODE_LINE_DISPLAY
:
18513 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18514 0, prec
, 0, STRING_MULTIBYTE (elt
));
18521 /* Handle the non-literal case. */
18523 while ((precision
<= 0 || n
< precision
)
18524 && SREF (elt
, offset
) != 0
18525 && (mode_line_target
!= MODE_LINE_DISPLAY
18526 || it
->current_x
< it
->last_visible_x
))
18528 EMACS_INT last_offset
= offset
;
18530 /* Advance to end of string or next format specifier. */
18531 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18534 if (offset
- 1 != last_offset
)
18536 EMACS_INT nchars
, nbytes
;
18538 /* Output to end of string or up to '%'. Field width
18539 is length of string. Don't output more than
18540 PRECISION allows us. */
18543 prec
= c_string_width (SDATA (elt
) + last_offset
,
18544 offset
- last_offset
, precision
- n
,
18547 switch (mode_line_target
)
18549 case MODE_LINE_NOPROP
:
18550 case MODE_LINE_TITLE
:
18551 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18553 case MODE_LINE_STRING
:
18555 EMACS_INT bytepos
= last_offset
;
18556 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18557 EMACS_INT endpos
= (precision
<= 0
18558 ? string_byte_to_char (elt
, offset
)
18559 : charpos
+ nchars
);
18561 n
+= store_mode_line_string (NULL
,
18562 Fsubstring (elt
, make_number (charpos
),
18563 make_number (endpos
)),
18567 case MODE_LINE_DISPLAY
:
18569 EMACS_INT bytepos
= last_offset
;
18570 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18572 if (precision
<= 0)
18573 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18574 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18576 STRING_MULTIBYTE (elt
));
18581 else /* c == '%' */
18583 EMACS_INT percent_position
= offset
;
18585 /* Get the specified minimum width. Zero means
18588 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18589 field
= field
* 10 + c
- '0';
18591 /* Don't pad beyond the total padding allowed. */
18592 if (field_width
- n
> 0 && field
> field_width
- n
)
18593 field
= field_width
- n
;
18595 /* Note that either PRECISION <= 0 or N < PRECISION. */
18596 prec
= precision
- n
;
18599 n
+= display_mode_element (it
, depth
, field
, prec
,
18600 Vglobal_mode_string
, props
,
18605 EMACS_INT bytepos
, charpos
;
18607 Lisp_Object string
;
18609 bytepos
= percent_position
;
18610 charpos
= (STRING_MULTIBYTE (elt
)
18611 ? string_byte_to_char (elt
, bytepos
)
18613 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18614 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18616 switch (mode_line_target
)
18618 case MODE_LINE_NOPROP
:
18619 case MODE_LINE_TITLE
:
18620 n
+= store_mode_line_noprop (spec
, field
, prec
);
18622 case MODE_LINE_STRING
:
18624 int len
= strlen (spec
);
18625 Lisp_Object tem
= make_string (spec
, len
);
18626 props
= Ftext_properties_at (make_number (charpos
), elt
);
18627 /* Should only keep face property in props */
18628 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18631 case MODE_LINE_DISPLAY
:
18633 int nglyphs_before
, nwritten
;
18635 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18636 nwritten
= display_string (spec
, string
, elt
,
18641 /* Assign to the glyphs written above the
18642 string where the `%x' came from, position
18646 struct glyph
*glyph
18647 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18651 for (i
= 0; i
< nwritten
; ++i
)
18653 glyph
[i
].object
= elt
;
18654 glyph
[i
].charpos
= charpos
;
18671 /* A symbol: process the value of the symbol recursively
18672 as if it appeared here directly. Avoid error if symbol void.
18673 Special case: if value of symbol is a string, output the string
18676 register Lisp_Object tem
;
18678 /* If the variable is not marked as risky to set
18679 then its contents are risky to use. */
18680 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18683 tem
= Fboundp (elt
);
18686 tem
= Fsymbol_value (elt
);
18687 /* If value is a string, output that string literally:
18688 don't check for % within it. */
18692 if (!EQ (tem
, elt
))
18694 /* Give up right away for nil or t. */
18704 register Lisp_Object car
, tem
;
18706 /* A cons cell: five distinct cases.
18707 If first element is :eval or :propertize, do something special.
18708 If first element is a string or a cons, process all the elements
18709 and effectively concatenate them.
18710 If first element is a negative number, truncate displaying cdr to
18711 at most that many characters. If positive, pad (with spaces)
18712 to at least that many characters.
18713 If first element is a symbol, process the cadr or caddr recursively
18714 according to whether the symbol's value is non-nil or nil. */
18716 if (EQ (car
, QCeval
))
18718 /* An element of the form (:eval FORM) means evaluate FORM
18719 and use the result as mode line elements. */
18724 if (CONSP (XCDR (elt
)))
18727 spec
= safe_eval (XCAR (XCDR (elt
)));
18728 n
+= display_mode_element (it
, depth
, field_width
- n
,
18729 precision
- n
, spec
, props
,
18733 else if (EQ (car
, QCpropertize
))
18735 /* An element of the form (:propertize ELT PROPS...)
18736 means display ELT but applying properties PROPS. */
18741 if (CONSP (XCDR (elt
)))
18742 n
+= display_mode_element (it
, depth
, field_width
- n
,
18743 precision
- n
, XCAR (XCDR (elt
)),
18744 XCDR (XCDR (elt
)), risky
);
18746 else if (SYMBOLP (car
))
18748 tem
= Fboundp (car
);
18752 /* elt is now the cdr, and we know it is a cons cell.
18753 Use its car if CAR has a non-nil value. */
18756 tem
= Fsymbol_value (car
);
18763 /* Symbol's value is nil (or symbol is unbound)
18764 Get the cddr of the original list
18765 and if possible find the caddr and use that. */
18769 else if (!CONSP (elt
))
18774 else if (INTEGERP (car
))
18776 register int lim
= XINT (car
);
18780 /* Negative int means reduce maximum width. */
18781 if (precision
<= 0)
18784 precision
= min (precision
, -lim
);
18788 /* Padding specified. Don't let it be more than
18789 current maximum. */
18791 lim
= min (precision
, lim
);
18793 /* If that's more padding than already wanted, queue it.
18794 But don't reduce padding already specified even if
18795 that is beyond the current truncation point. */
18796 field_width
= max (lim
, field_width
);
18800 else if (STRINGP (car
) || CONSP (car
))
18802 Lisp_Object halftail
= elt
;
18806 && (precision
<= 0 || n
< precision
))
18808 n
+= display_mode_element (it
, depth
,
18809 /* Do padding only after the last
18810 element in the list. */
18811 (! CONSP (XCDR (elt
))
18814 precision
- n
, XCAR (elt
),
18818 if ((len
& 1) == 0)
18819 halftail
= XCDR (halftail
);
18820 /* Check for cycle. */
18821 if (EQ (halftail
, elt
))
18830 elt
= build_string ("*invalid*");
18834 /* Pad to FIELD_WIDTH. */
18835 if (field_width
> 0 && n
< field_width
)
18837 switch (mode_line_target
)
18839 case MODE_LINE_NOPROP
:
18840 case MODE_LINE_TITLE
:
18841 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18843 case MODE_LINE_STRING
:
18844 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18846 case MODE_LINE_DISPLAY
:
18847 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18856 /* Store a mode-line string element in mode_line_string_list.
18858 If STRING is non-null, display that C string. Otherwise, the Lisp
18859 string LISP_STRING is displayed.
18861 FIELD_WIDTH is the minimum number of output glyphs to produce.
18862 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18863 with spaces. FIELD_WIDTH <= 0 means don't pad.
18865 PRECISION is the maximum number of characters to output from
18866 STRING. PRECISION <= 0 means don't truncate the string.
18868 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18869 properties to the string.
18871 PROPS are the properties to add to the string.
18872 The mode_line_string_face face property is always added to the string.
18876 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18877 int field_width
, int precision
, Lisp_Object props
)
18882 if (string
!= NULL
)
18884 len
= strlen (string
);
18885 if (precision
> 0 && len
> precision
)
18887 lisp_string
= make_string (string
, len
);
18889 props
= mode_line_string_face_prop
;
18890 else if (!NILP (mode_line_string_face
))
18892 Lisp_Object face
= Fplist_get (props
, Qface
);
18893 props
= Fcopy_sequence (props
);
18895 face
= mode_line_string_face
;
18897 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18898 props
= Fplist_put (props
, Qface
, face
);
18900 Fadd_text_properties (make_number (0), make_number (len
),
18901 props
, lisp_string
);
18905 len
= XFASTINT (Flength (lisp_string
));
18906 if (precision
> 0 && len
> precision
)
18909 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18912 if (!NILP (mode_line_string_face
))
18916 props
= Ftext_properties_at (make_number (0), lisp_string
);
18917 face
= Fplist_get (props
, Qface
);
18919 face
= mode_line_string_face
;
18921 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18922 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18924 lisp_string
= Fcopy_sequence (lisp_string
);
18927 Fadd_text_properties (make_number (0), make_number (len
),
18928 props
, lisp_string
);
18933 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18937 if (field_width
> len
)
18939 field_width
-= len
;
18940 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18942 Fadd_text_properties (make_number (0), make_number (field_width
),
18943 props
, lisp_string
);
18944 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18952 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18954 doc
: /* Format a string out of a mode line format specification.
18955 First arg FORMAT specifies the mode line format (see `mode-line-format'
18956 for details) to use.
18958 By default, the format is evaluated for the currently selected window.
18960 Optional second arg FACE specifies the face property to put on all
18961 characters for which no face is specified. The value nil means the
18962 default face. The value t means whatever face the window's mode line
18963 currently uses (either `mode-line' or `mode-line-inactive',
18964 depending on whether the window is the selected window or not).
18965 An integer value means the value string has no text
18968 Optional third and fourth args WINDOW and BUFFER specify the window
18969 and buffer to use as the context for the formatting (defaults
18970 are the selected window and the WINDOW's buffer). */)
18971 (Lisp_Object format
, Lisp_Object face
,
18972 Lisp_Object window
, Lisp_Object buffer
)
18977 struct buffer
*old_buffer
= NULL
;
18979 int no_props
= INTEGERP (face
);
18980 int count
= SPECPDL_INDEX ();
18982 int string_start
= 0;
18985 window
= selected_window
;
18986 CHECK_WINDOW (window
);
18987 w
= XWINDOW (window
);
18990 buffer
= w
->buffer
;
18991 CHECK_BUFFER (buffer
);
18993 /* Make formatting the modeline a non-op when noninteractive, otherwise
18994 there will be problems later caused by a partially initialized frame. */
18995 if (NILP (format
) || noninteractive
)
18996 return empty_unibyte_string
;
19001 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19002 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19003 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19004 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19005 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19006 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19007 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19010 if (XBUFFER (buffer
) != current_buffer
)
19011 old_buffer
= current_buffer
;
19013 /* Save things including mode_line_proptrans_alist,
19014 and set that to nil so that we don't alter the outer value. */
19015 record_unwind_protect (unwind_format_mode_line
,
19016 format_mode_line_unwind_data
19017 (old_buffer
, selected_window
, 1));
19018 mode_line_proptrans_alist
= Qnil
;
19020 Fselect_window (window
, Qt
);
19022 set_buffer_internal_1 (XBUFFER (buffer
));
19024 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19028 mode_line_target
= MODE_LINE_NOPROP
;
19029 mode_line_string_face_prop
= Qnil
;
19030 mode_line_string_list
= Qnil
;
19031 string_start
= MODE_LINE_NOPROP_LEN (0);
19035 mode_line_target
= MODE_LINE_STRING
;
19036 mode_line_string_list
= Qnil
;
19037 mode_line_string_face
= face
;
19038 mode_line_string_face_prop
19039 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19042 push_kboard (FRAME_KBOARD (it
.f
));
19043 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19048 len
= MODE_LINE_NOPROP_LEN (string_start
);
19049 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19053 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19054 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19055 empty_unibyte_string
);
19058 unbind_to (count
, Qnil
);
19062 /* Write a null-terminated, right justified decimal representation of
19063 the positive integer D to BUF using a minimal field width WIDTH. */
19066 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19068 register char *p
= buf
;
19076 *p
++ = d
% 10 + '0';
19081 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19092 /* Write a null-terminated, right justified decimal and "human
19093 readable" representation of the nonnegative integer D to BUF using
19094 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19096 static const char power_letter
[] =
19110 pint2hrstr (char *buf
, int width
, int d
)
19112 /* We aim to represent the nonnegative integer D as
19113 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19116 /* -1 means: do not use TENTHS. */
19120 /* Length of QUOTIENT.TENTHS as a string. */
19126 if (1000 <= quotient
)
19128 /* Scale to the appropriate EXPONENT. */
19131 remainder
= quotient
% 1000;
19135 while (1000 <= quotient
);
19137 /* Round to nearest and decide whether to use TENTHS or not. */
19140 tenths
= remainder
/ 100;
19141 if (50 <= remainder
% 100)
19148 if (quotient
== 10)
19156 if (500 <= remainder
)
19158 if (quotient
< 999)
19169 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19170 if (tenths
== -1 && quotient
<= 99)
19177 p
= psuffix
= buf
+ max (width
, length
);
19179 /* Print EXPONENT. */
19180 *psuffix
++ = power_letter
[exponent
];
19183 /* Print TENTHS. */
19186 *--p
= '0' + tenths
;
19190 /* Print QUOTIENT. */
19193 int digit
= quotient
% 10;
19194 *--p
= '0' + digit
;
19196 while ((quotient
/= 10) != 0);
19198 /* Print leading spaces. */
19203 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19204 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19205 type of CODING_SYSTEM. Return updated pointer into BUF. */
19207 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19210 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19213 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19214 const unsigned char *eol_str
;
19216 /* The EOL conversion we are using. */
19217 Lisp_Object eoltype
;
19219 val
= CODING_SYSTEM_SPEC (coding_system
);
19222 if (!VECTORP (val
)) /* Not yet decided. */
19227 eoltype
= eol_mnemonic_undecided
;
19228 /* Don't mention EOL conversion if it isn't decided. */
19233 Lisp_Object eolvalue
;
19235 attrs
= AREF (val
, 0);
19236 eolvalue
= AREF (val
, 2);
19239 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19243 /* The EOL conversion that is normal on this system. */
19245 if (NILP (eolvalue
)) /* Not yet decided. */
19246 eoltype
= eol_mnemonic_undecided
;
19247 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19248 eoltype
= eol_mnemonic_undecided
;
19249 else /* eolvalue is Qunix, Qdos, or Qmac. */
19250 eoltype
= (EQ (eolvalue
, Qunix
)
19251 ? eol_mnemonic_unix
19252 : (EQ (eolvalue
, Qdos
) == 1
19253 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19259 /* Mention the EOL conversion if it is not the usual one. */
19260 if (STRINGP (eoltype
))
19262 eol_str
= SDATA (eoltype
);
19263 eol_str_len
= SBYTES (eoltype
);
19265 else if (CHARACTERP (eoltype
))
19267 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19268 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19273 eol_str
= invalid_eol_type
;
19274 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19276 memcpy (buf
, eol_str
, eol_str_len
);
19277 buf
+= eol_str_len
;
19283 /* Return a string for the output of a mode line %-spec for window W,
19284 generated by character C. FIELD_WIDTH > 0 means pad the string
19285 returned with spaces to that value. Return a Lisp string in
19286 *STRING if the resulting string is taken from that Lisp string.
19288 Note we operate on the current buffer for most purposes,
19289 the exception being w->base_line_pos. */
19291 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19293 static const char *
19294 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19295 Lisp_Object
*string
)
19298 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19299 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19300 struct buffer
*b
= current_buffer
;
19308 if (!NILP (BVAR (b
, read_only
)))
19310 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19315 /* This differs from %* only for a modified read-only buffer. */
19316 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19318 if (!NILP (BVAR (b
, read_only
)))
19323 /* This differs from %* in ignoring read-only-ness. */
19324 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19336 if (command_loop_level
> 5)
19338 p
= decode_mode_spec_buf
;
19339 for (i
= 0; i
< command_loop_level
; i
++)
19342 return decode_mode_spec_buf
;
19350 if (command_loop_level
> 5)
19352 p
= decode_mode_spec_buf
;
19353 for (i
= 0; i
< command_loop_level
; i
++)
19356 return decode_mode_spec_buf
;
19363 /* Let lots_of_dashes be a string of infinite length. */
19364 if (mode_line_target
== MODE_LINE_NOPROP
||
19365 mode_line_target
== MODE_LINE_STRING
)
19367 if (field_width
<= 0
19368 || field_width
> sizeof (lots_of_dashes
))
19370 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19371 decode_mode_spec_buf
[i
] = '-';
19372 decode_mode_spec_buf
[i
] = '\0';
19373 return decode_mode_spec_buf
;
19376 return lots_of_dashes
;
19380 obj
= BVAR (b
, name
);
19384 /* %c and %l are ignored in `frame-title-format'.
19385 (In redisplay_internal, the frame title is drawn _before_ the
19386 windows are updated, so the stuff which depends on actual
19387 window contents (such as %l) may fail to render properly, or
19388 even crash emacs.) */
19389 if (mode_line_target
== MODE_LINE_TITLE
)
19393 EMACS_INT col
= current_column ();
19394 w
->column_number_displayed
= make_number (col
);
19395 pint2str (decode_mode_spec_buf
, field_width
, col
);
19396 return decode_mode_spec_buf
;
19400 #ifndef SYSTEM_MALLOC
19402 if (NILP (Vmemory_full
))
19405 return "!MEM FULL! ";
19412 /* %F displays the frame name. */
19413 if (!NILP (f
->title
))
19414 return SSDATA (f
->title
);
19415 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19416 return SSDATA (f
->name
);
19420 obj
= BVAR (b
, filename
);
19425 EMACS_INT size
= ZV
- BEGV
;
19426 pint2str (decode_mode_spec_buf
, field_width
, size
);
19427 return decode_mode_spec_buf
;
19432 EMACS_INT size
= ZV
- BEGV
;
19433 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19434 return decode_mode_spec_buf
;
19439 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19440 int topline
, nlines
, height
;
19443 /* %c and %l are ignored in `frame-title-format'. */
19444 if (mode_line_target
== MODE_LINE_TITLE
)
19447 startpos
= XMARKER (w
->start
)->charpos
;
19448 startpos_byte
= marker_byte_position (w
->start
);
19449 height
= WINDOW_TOTAL_LINES (w
);
19451 /* If we decided that this buffer isn't suitable for line numbers,
19452 don't forget that too fast. */
19453 if (EQ (w
->base_line_pos
, w
->buffer
))
19455 /* But do forget it, if the window shows a different buffer now. */
19456 else if (BUFFERP (w
->base_line_pos
))
19457 w
->base_line_pos
= Qnil
;
19459 /* If the buffer is very big, don't waste time. */
19460 if (INTEGERP (Vline_number_display_limit
)
19461 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19463 w
->base_line_pos
= Qnil
;
19464 w
->base_line_number
= Qnil
;
19468 if (INTEGERP (w
->base_line_number
)
19469 && INTEGERP (w
->base_line_pos
)
19470 && XFASTINT (w
->base_line_pos
) <= startpos
)
19472 line
= XFASTINT (w
->base_line_number
);
19473 linepos
= XFASTINT (w
->base_line_pos
);
19474 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19479 linepos
= BUF_BEGV (b
);
19480 linepos_byte
= BUF_BEGV_BYTE (b
);
19483 /* Count lines from base line to window start position. */
19484 nlines
= display_count_lines (linepos
, linepos_byte
,
19488 topline
= nlines
+ line
;
19490 /* Determine a new base line, if the old one is too close
19491 or too far away, or if we did not have one.
19492 "Too close" means it's plausible a scroll-down would
19493 go back past it. */
19494 if (startpos
== BUF_BEGV (b
))
19496 w
->base_line_number
= make_number (topline
);
19497 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19499 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19500 || linepos
== BUF_BEGV (b
))
19502 EMACS_INT limit
= BUF_BEGV (b
);
19503 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19504 EMACS_INT position
;
19505 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19507 if (startpos
- distance
> limit
)
19509 limit
= startpos
- distance
;
19510 limit_byte
= CHAR_TO_BYTE (limit
);
19513 nlines
= display_count_lines (startpos
, startpos_byte
,
19515 - (height
* 2 + 30),
19517 /* If we couldn't find the lines we wanted within
19518 line_number_display_limit_width chars per line,
19519 give up on line numbers for this window. */
19520 if (position
== limit_byte
&& limit
== startpos
- distance
)
19522 w
->base_line_pos
= w
->buffer
;
19523 w
->base_line_number
= Qnil
;
19527 w
->base_line_number
= make_number (topline
- nlines
);
19528 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19531 /* Now count lines from the start pos to point. */
19532 nlines
= display_count_lines (startpos
, startpos_byte
,
19533 PT_BYTE
, PT
, &junk
);
19535 /* Record that we did display the line number. */
19536 line_number_displayed
= 1;
19538 /* Make the string to show. */
19539 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19540 return decode_mode_spec_buf
;
19543 char* p
= decode_mode_spec_buf
;
19544 int pad
= field_width
- 2;
19550 return decode_mode_spec_buf
;
19556 obj
= BVAR (b
, mode_name
);
19560 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19566 EMACS_INT pos
= marker_position (w
->start
);
19567 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19569 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19571 if (pos
<= BUF_BEGV (b
))
19576 else if (pos
<= BUF_BEGV (b
))
19580 if (total
> 1000000)
19581 /* Do it differently for a large value, to avoid overflow. */
19582 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19584 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19585 /* We can't normally display a 3-digit number,
19586 so get us a 2-digit number that is close. */
19589 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19590 return decode_mode_spec_buf
;
19594 /* Display percentage of size above the bottom of the screen. */
19597 EMACS_INT toppos
= marker_position (w
->start
);
19598 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19599 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19601 if (botpos
>= BUF_ZV (b
))
19603 if (toppos
<= BUF_BEGV (b
))
19610 if (total
> 1000000)
19611 /* Do it differently for a large value, to avoid overflow. */
19612 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19614 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19615 /* We can't normally display a 3-digit number,
19616 so get us a 2-digit number that is close. */
19619 if (toppos
<= BUF_BEGV (b
))
19620 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19622 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19623 return decode_mode_spec_buf
;
19628 /* status of process */
19629 obj
= Fget_buffer_process (Fcurrent_buffer ());
19631 return "no process";
19633 obj
= Fsymbol_name (Fprocess_status (obj
));
19639 int count
= inhibit_garbage_collection ();
19640 Lisp_Object val
= call1 (intern ("file-remote-p"),
19641 BVAR (current_buffer
, directory
));
19642 unbind_to (count
, Qnil
);
19650 case 't': /* indicate TEXT or BINARY */
19654 /* coding-system (not including end-of-line format) */
19656 /* coding-system (including end-of-line type) */
19658 int eol_flag
= (c
== 'Z');
19659 char *p
= decode_mode_spec_buf
;
19661 if (! FRAME_WINDOW_P (f
))
19663 /* No need to mention EOL here--the terminal never needs
19664 to do EOL conversion. */
19665 p
= decode_mode_spec_coding (CODING_ID_NAME
19666 (FRAME_KEYBOARD_CODING (f
)->id
),
19668 p
= decode_mode_spec_coding (CODING_ID_NAME
19669 (FRAME_TERMINAL_CODING (f
)->id
),
19672 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19675 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19676 #ifdef subprocesses
19677 obj
= Fget_buffer_process (Fcurrent_buffer ());
19678 if (PROCESSP (obj
))
19680 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19682 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19685 #endif /* subprocesses */
19688 return decode_mode_spec_buf
;
19695 return SSDATA (obj
);
19702 /* Count up to COUNT lines starting from START / START_BYTE.
19703 But don't go beyond LIMIT_BYTE.
19704 Return the number of lines thus found (always nonnegative).
19706 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19709 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19710 EMACS_INT limit_byte
, int count
,
19711 EMACS_INT
*byte_pos_ptr
)
19713 register unsigned char *cursor
;
19714 unsigned char *base
;
19716 register int ceiling
;
19717 register unsigned char *ceiling_addr
;
19718 int orig_count
= count
;
19720 /* If we are not in selective display mode,
19721 check only for newlines. */
19722 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19723 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19727 while (start_byte
< limit_byte
)
19729 ceiling
= BUFFER_CEILING_OF (start_byte
);
19730 ceiling
= min (limit_byte
- 1, ceiling
);
19731 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19732 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19735 if (selective_display
)
19736 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19739 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19742 if (cursor
!= ceiling_addr
)
19746 start_byte
+= cursor
- base
+ 1;
19747 *byte_pos_ptr
= start_byte
;
19751 if (++cursor
== ceiling_addr
)
19757 start_byte
+= cursor
- base
;
19762 while (start_byte
> limit_byte
)
19764 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19765 ceiling
= max (limit_byte
, ceiling
);
19766 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19767 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19770 if (selective_display
)
19771 while (--cursor
!= ceiling_addr
19772 && *cursor
!= '\n' && *cursor
!= 015)
19775 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19778 if (cursor
!= ceiling_addr
)
19782 start_byte
+= cursor
- base
+ 1;
19783 *byte_pos_ptr
= start_byte
;
19784 /* When scanning backwards, we should
19785 not count the newline posterior to which we stop. */
19786 return - orig_count
- 1;
19792 /* Here we add 1 to compensate for the last decrement
19793 of CURSOR, which took it past the valid range. */
19794 start_byte
+= cursor
- base
+ 1;
19798 *byte_pos_ptr
= limit_byte
;
19801 return - orig_count
+ count
;
19802 return orig_count
- count
;
19808 /***********************************************************************
19810 ***********************************************************************/
19812 /* Display a NUL-terminated string, starting with index START.
19814 If STRING is non-null, display that C string. Otherwise, the Lisp
19815 string LISP_STRING is displayed. There's a case that STRING is
19816 non-null and LISP_STRING is not nil. It means STRING is a string
19817 data of LISP_STRING. In that case, we display LISP_STRING while
19818 ignoring its text properties.
19820 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19821 FACE_STRING. Display STRING or LISP_STRING with the face at
19822 FACE_STRING_POS in FACE_STRING:
19824 Display the string in the environment given by IT, but use the
19825 standard display table, temporarily.
19827 FIELD_WIDTH is the minimum number of output glyphs to produce.
19828 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19829 with spaces. If STRING has more characters, more than FIELD_WIDTH
19830 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19832 PRECISION is the maximum number of characters to output from
19833 STRING. PRECISION < 0 means don't truncate the string.
19835 This is roughly equivalent to printf format specifiers:
19837 FIELD_WIDTH PRECISION PRINTF
19838 ----------------------------------------
19844 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19845 display them, and < 0 means obey the current buffer's value of
19846 enable_multibyte_characters.
19848 Value is the number of columns displayed. */
19851 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19852 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19853 int field_width
, int precision
, int max_x
, int multibyte
)
19855 int hpos_at_start
= it
->hpos
;
19856 int saved_face_id
= it
->face_id
;
19857 struct glyph_row
*row
= it
->glyph_row
;
19859 /* Initialize the iterator IT for iteration over STRING beginning
19860 with index START. */
19861 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19862 precision
, field_width
, multibyte
);
19863 if (string
&& STRINGP (lisp_string
))
19864 /* LISP_STRING is the one returned by decode_mode_spec. We should
19865 ignore its text properties. */
19866 it
->stop_charpos
= -1;
19868 /* If displaying STRING, set up the face of the iterator
19869 from LISP_STRING, if that's given. */
19870 if (STRINGP (face_string
))
19876 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19877 0, it
->region_beg_charpos
,
19878 it
->region_end_charpos
,
19879 &endptr
, it
->base_face_id
, 0);
19880 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19881 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19884 /* Set max_x to the maximum allowed X position. Don't let it go
19885 beyond the right edge of the window. */
19887 max_x
= it
->last_visible_x
;
19889 max_x
= min (max_x
, it
->last_visible_x
);
19891 /* Skip over display elements that are not visible. because IT->w is
19893 if (it
->current_x
< it
->first_visible_x
)
19894 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19895 MOVE_TO_POS
| MOVE_TO_X
);
19897 row
->ascent
= it
->max_ascent
;
19898 row
->height
= it
->max_ascent
+ it
->max_descent
;
19899 row
->phys_ascent
= it
->max_phys_ascent
;
19900 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19901 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19903 /* This condition is for the case that we are called with current_x
19904 past last_visible_x. */
19905 while (it
->current_x
< max_x
)
19907 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19909 /* Get the next display element. */
19910 if (!get_next_display_element (it
))
19913 /* Produce glyphs. */
19914 x_before
= it
->current_x
;
19915 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19916 PRODUCE_GLYPHS (it
);
19918 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19921 while (i
< nglyphs
)
19923 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19925 if (it
->line_wrap
!= TRUNCATE
19926 && x
+ glyph
->pixel_width
> max_x
)
19928 /* End of continued line or max_x reached. */
19929 if (CHAR_GLYPH_PADDING_P (*glyph
))
19931 /* A wide character is unbreakable. */
19932 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19933 it
->current_x
= x_before
;
19937 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19942 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19944 /* Glyph is at least partially visible. */
19946 if (x
< it
->first_visible_x
)
19947 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19951 /* Glyph is off the left margin of the display area.
19952 Should not happen. */
19956 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19957 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19958 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19959 row
->phys_height
= max (row
->phys_height
,
19960 it
->max_phys_ascent
+ it
->max_phys_descent
);
19961 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19962 it
->max_extra_line_spacing
);
19963 x
+= glyph
->pixel_width
;
19967 /* Stop if max_x reached. */
19971 /* Stop at line ends. */
19972 if (ITERATOR_AT_END_OF_LINE_P (it
))
19974 it
->continuation_lines_width
= 0;
19978 set_iterator_to_next (it
, 1);
19980 /* Stop if truncating at the right edge. */
19981 if (it
->line_wrap
== TRUNCATE
19982 && it
->current_x
>= it
->last_visible_x
)
19984 /* Add truncation mark, but don't do it if the line is
19985 truncated at a padding space. */
19986 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19988 if (!FRAME_WINDOW_P (it
->f
))
19992 if (it
->current_x
> it
->last_visible_x
)
19994 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19995 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19997 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19999 row
->used
[TEXT_AREA
] = ii
;
20000 produce_special_glyphs (it
, IT_TRUNCATION
);
20003 produce_special_glyphs (it
, IT_TRUNCATION
);
20005 it
->glyph_row
->truncated_on_right_p
= 1;
20011 /* Maybe insert a truncation at the left. */
20012 if (it
->first_visible_x
20013 && IT_CHARPOS (*it
) > 0)
20015 if (!FRAME_WINDOW_P (it
->f
))
20016 insert_left_trunc_glyphs (it
);
20017 it
->glyph_row
->truncated_on_left_p
= 1;
20020 it
->face_id
= saved_face_id
;
20022 /* Value is number of columns displayed. */
20023 return it
->hpos
- hpos_at_start
;
20028 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20029 appears as an element of LIST or as the car of an element of LIST.
20030 If PROPVAL is a list, compare each element against LIST in that
20031 way, and return 1/2 if any element of PROPVAL is found in LIST.
20032 Otherwise return 0. This function cannot quit.
20033 The return value is 2 if the text is invisible but with an ellipsis
20034 and 1 if it's invisible and without an ellipsis. */
20037 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20039 register Lisp_Object tail
, proptail
;
20041 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20043 register Lisp_Object tem
;
20045 if (EQ (propval
, tem
))
20047 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20048 return NILP (XCDR (tem
)) ? 1 : 2;
20051 if (CONSP (propval
))
20053 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20055 Lisp_Object propelt
;
20056 propelt
= XCAR (proptail
);
20057 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20059 register Lisp_Object tem
;
20061 if (EQ (propelt
, tem
))
20063 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20064 return NILP (XCDR (tem
)) ? 1 : 2;
20072 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20073 doc
: /* Non-nil if the property makes the text invisible.
20074 POS-OR-PROP can be a marker or number, in which case it is taken to be
20075 a position in the current buffer and the value of the `invisible' property
20076 is checked; or it can be some other value, which is then presumed to be the
20077 value of the `invisible' property of the text of interest.
20078 The non-nil value returned can be t for truly invisible text or something
20079 else if the text is replaced by an ellipsis. */)
20080 (Lisp_Object pos_or_prop
)
20083 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20084 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20086 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20087 return (invis
== 0 ? Qnil
20089 : make_number (invis
));
20092 /* Calculate a width or height in pixels from a specification using
20093 the following elements:
20096 NUM - a (fractional) multiple of the default font width/height
20097 (NUM) - specifies exactly NUM pixels
20098 UNIT - a fixed number of pixels, see below.
20099 ELEMENT - size of a display element in pixels, see below.
20100 (NUM . SPEC) - equals NUM * SPEC
20101 (+ SPEC SPEC ...) - add pixel values
20102 (- SPEC SPEC ...) - subtract pixel values
20103 (- SPEC) - negate pixel value
20106 INT or FLOAT - a number constant
20107 SYMBOL - use symbol's (buffer local) variable binding.
20110 in - pixels per inch *)
20111 mm - pixels per 1/1000 meter *)
20112 cm - pixels per 1/100 meter *)
20113 width - width of current font in pixels.
20114 height - height of current font in pixels.
20116 *) using the ratio(s) defined in display-pixels-per-inch.
20120 left-fringe - left fringe width in pixels
20121 right-fringe - right fringe width in pixels
20123 left-margin - left margin width in pixels
20124 right-margin - right margin width in pixels
20126 scroll-bar - scroll-bar area width in pixels
20130 Pixels corresponding to 5 inches:
20133 Total width of non-text areas on left side of window (if scroll-bar is on left):
20134 '(space :width (+ left-fringe left-margin scroll-bar))
20136 Align to first text column (in header line):
20137 '(space :align-to 0)
20139 Align to middle of text area minus half the width of variable `my-image'
20140 containing a loaded image:
20141 '(space :align-to (0.5 . (- text my-image)))
20143 Width of left margin minus width of 1 character in the default font:
20144 '(space :width (- left-margin 1))
20146 Width of left margin minus width of 2 characters in the current font:
20147 '(space :width (- left-margin (2 . width)))
20149 Center 1 character over left-margin (in header line):
20150 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20152 Different ways to express width of left fringe plus left margin minus one pixel:
20153 '(space :width (- (+ left-fringe left-margin) (1)))
20154 '(space :width (+ left-fringe left-margin (- (1))))
20155 '(space :width (+ left-fringe left-margin (-1)))
20159 #define NUMVAL(X) \
20160 ((INTEGERP (X) || FLOATP (X)) \
20165 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20166 struct font
*font
, int width_p
, int *align_to
)
20170 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20171 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20174 return OK_PIXELS (0);
20176 xassert (FRAME_LIVE_P (it
->f
));
20178 if (SYMBOLP (prop
))
20180 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20182 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20184 if (unit
[0] == 'i' && unit
[1] == 'n')
20186 else if (unit
[0] == 'm' && unit
[1] == 'm')
20188 else if (unit
[0] == 'c' && unit
[1] == 'm')
20195 #ifdef HAVE_WINDOW_SYSTEM
20196 if (FRAME_WINDOW_P (it
->f
)
20198 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20199 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20201 return OK_PIXELS (ppi
/ pixels
);
20204 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20205 || (CONSP (Vdisplay_pixels_per_inch
)
20207 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20208 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20210 return OK_PIXELS (ppi
/ pixels
);
20216 #ifdef HAVE_WINDOW_SYSTEM
20217 if (EQ (prop
, Qheight
))
20218 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20219 if (EQ (prop
, Qwidth
))
20220 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20222 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20223 return OK_PIXELS (1);
20226 if (EQ (prop
, Qtext
))
20227 return OK_PIXELS (width_p
20228 ? window_box_width (it
->w
, TEXT_AREA
)
20229 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20231 if (align_to
&& *align_to
< 0)
20234 if (EQ (prop
, Qleft
))
20235 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20236 if (EQ (prop
, Qright
))
20237 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20238 if (EQ (prop
, Qcenter
))
20239 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20240 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20241 if (EQ (prop
, Qleft_fringe
))
20242 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20243 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20244 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20245 if (EQ (prop
, Qright_fringe
))
20246 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20247 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20248 : window_box_right_offset (it
->w
, TEXT_AREA
));
20249 if (EQ (prop
, Qleft_margin
))
20250 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20251 if (EQ (prop
, Qright_margin
))
20252 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20253 if (EQ (prop
, Qscroll_bar
))
20254 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20256 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20257 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20258 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20263 if (EQ (prop
, Qleft_fringe
))
20264 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20265 if (EQ (prop
, Qright_fringe
))
20266 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20267 if (EQ (prop
, Qleft_margin
))
20268 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20269 if (EQ (prop
, Qright_margin
))
20270 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20271 if (EQ (prop
, Qscroll_bar
))
20272 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20275 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20278 if (INTEGERP (prop
) || FLOATP (prop
))
20280 int base_unit
= (width_p
20281 ? FRAME_COLUMN_WIDTH (it
->f
)
20282 : FRAME_LINE_HEIGHT (it
->f
));
20283 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20288 Lisp_Object car
= XCAR (prop
);
20289 Lisp_Object cdr
= XCDR (prop
);
20293 #ifdef HAVE_WINDOW_SYSTEM
20294 if (FRAME_WINDOW_P (it
->f
)
20295 && valid_image_p (prop
))
20297 int id
= lookup_image (it
->f
, prop
);
20298 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20300 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20303 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20309 while (CONSP (cdr
))
20311 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20312 font
, width_p
, align_to
))
20315 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20320 if (EQ (car
, Qminus
))
20322 return OK_PIXELS (pixels
);
20325 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20328 if (INTEGERP (car
) || FLOATP (car
))
20331 pixels
= XFLOATINT (car
);
20333 return OK_PIXELS (pixels
);
20334 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20335 font
, width_p
, align_to
))
20336 return OK_PIXELS (pixels
* fact
);
20347 /***********************************************************************
20349 ***********************************************************************/
20351 #ifdef HAVE_WINDOW_SYSTEM
20356 dump_glyph_string (s
)
20357 struct glyph_string
*s
;
20359 fprintf (stderr
, "glyph string\n");
20360 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20361 s
->x
, s
->y
, s
->width
, s
->height
);
20362 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20363 fprintf (stderr
, " hl = %d\n", s
->hl
);
20364 fprintf (stderr
, " left overhang = %d, right = %d\n",
20365 s
->left_overhang
, s
->right_overhang
);
20366 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20367 fprintf (stderr
, " extends to end of line = %d\n",
20368 s
->extends_to_end_of_line_p
);
20369 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20370 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20373 #endif /* GLYPH_DEBUG */
20375 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20376 of XChar2b structures for S; it can't be allocated in
20377 init_glyph_string because it must be allocated via `alloca'. W
20378 is the window on which S is drawn. ROW and AREA are the glyph row
20379 and area within the row from which S is constructed. START is the
20380 index of the first glyph structure covered by S. HL is a
20381 face-override for drawing S. */
20384 #define OPTIONAL_HDC(hdc) HDC hdc,
20385 #define DECLARE_HDC(hdc) HDC hdc;
20386 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20387 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20390 #ifndef OPTIONAL_HDC
20391 #define OPTIONAL_HDC(hdc)
20392 #define DECLARE_HDC(hdc)
20393 #define ALLOCATE_HDC(hdc, f)
20394 #define RELEASE_HDC(hdc, f)
20398 init_glyph_string (struct glyph_string
*s
,
20400 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20401 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20403 memset (s
, 0, sizeof *s
);
20405 s
->f
= XFRAME (w
->frame
);
20409 s
->display
= FRAME_X_DISPLAY (s
->f
);
20410 s
->window
= FRAME_X_WINDOW (s
->f
);
20411 s
->char2b
= char2b
;
20415 s
->first_glyph
= row
->glyphs
[area
] + start
;
20416 s
->height
= row
->height
;
20417 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20418 s
->ybase
= s
->y
+ row
->ascent
;
20422 /* Append the list of glyph strings with head H and tail T to the list
20423 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20426 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20427 struct glyph_string
*h
, struct glyph_string
*t
)
20441 /* Prepend the list of glyph strings with head H and tail T to the
20442 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20446 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20447 struct glyph_string
*h
, struct glyph_string
*t
)
20461 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20462 Set *HEAD and *TAIL to the resulting list. */
20465 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20466 struct glyph_string
*s
)
20468 s
->next
= s
->prev
= NULL
;
20469 append_glyph_string_lists (head
, tail
, s
, s
);
20473 /* Get face and two-byte form of character C in face FACE_ID on frame
20474 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20475 means we want to display multibyte text. DISPLAY_P non-zero means
20476 make sure that X resources for the face returned are allocated.
20477 Value is a pointer to a realized face that is ready for display if
20478 DISPLAY_P is non-zero. */
20480 static INLINE
struct face
*
20481 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20482 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20484 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20488 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20490 if (code
!= FONT_INVALID_CODE
)
20491 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20493 STORE_XCHAR2B (char2b
, 0, 0);
20496 /* Make sure X resources of the face are allocated. */
20497 #ifdef HAVE_X_WINDOWS
20501 xassert (face
!= NULL
);
20502 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20509 /* Get face and two-byte form of character glyph GLYPH on frame F.
20510 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20511 a pointer to a realized face that is ready for display. */
20513 static INLINE
struct face
*
20514 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20515 XChar2b
*char2b
, int *two_byte_p
)
20519 xassert (glyph
->type
== CHAR_GLYPH
);
20520 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20529 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20530 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20532 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20534 if (code
!= FONT_INVALID_CODE
)
20535 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20537 STORE_XCHAR2B (char2b
, 0, 0);
20540 /* Make sure X resources of the face are allocated. */
20541 xassert (face
!= NULL
);
20542 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20547 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20548 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20551 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20555 if (CHAR_BYTE8_P (c
))
20556 code
= CHAR_TO_BYTE8 (c
);
20558 code
= font
->driver
->encode_char (font
, c
);
20560 if (code
== FONT_INVALID_CODE
)
20562 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20567 /* Fill glyph string S with composition components specified by S->cmp.
20569 BASE_FACE is the base face of the composition.
20570 S->cmp_from is the index of the first component for S.
20572 OVERLAPS non-zero means S should draw the foreground only, and use
20573 its physical height for clipping. See also draw_glyphs.
20575 Value is the index of a component not in S. */
20578 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20582 /* For all glyphs of this composition, starting at the offset
20583 S->cmp_from, until we reach the end of the definition or encounter a
20584 glyph that requires the different face, add it to S. */
20589 s
->for_overlaps
= overlaps
;
20592 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20594 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20598 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20601 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20602 s
->char2b
+ i
, 1, 1);
20608 s
->font
= s
->face
->font
;
20610 else if (s
->face
!= face
)
20618 /* All glyph strings for the same composition has the same width,
20619 i.e. the width set for the first component of the composition. */
20620 s
->width
= s
->first_glyph
->pixel_width
;
20622 /* If the specified font could not be loaded, use the frame's
20623 default font, but record the fact that we couldn't load it in
20624 the glyph string so that we can draw rectangles for the
20625 characters of the glyph string. */
20626 if (s
->font
== NULL
)
20628 s
->font_not_found_p
= 1;
20629 s
->font
= FRAME_FONT (s
->f
);
20632 /* Adjust base line for subscript/superscript text. */
20633 s
->ybase
+= s
->first_glyph
->voffset
;
20635 /* This glyph string must always be drawn with 16-bit functions. */
20642 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20643 int start
, int end
, int overlaps
)
20645 struct glyph
*glyph
, *last
;
20646 Lisp_Object lgstring
;
20649 s
->for_overlaps
= overlaps
;
20650 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20651 last
= s
->row
->glyphs
[s
->area
] + end
;
20652 s
->cmp_id
= glyph
->u
.cmp
.id
;
20653 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20654 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20655 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20656 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20657 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20659 while (glyph
< last
20660 && glyph
->u
.cmp
.automatic
20661 && glyph
->u
.cmp
.id
== s
->cmp_id
20662 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20663 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20665 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20667 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20668 unsigned code
= LGLYPH_CODE (lglyph
);
20670 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20672 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20673 return glyph
- s
->row
->glyphs
[s
->area
];
20677 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20678 See the comment of fill_glyph_string for arguments.
20679 Value is the index of the first glyph not in S. */
20683 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20684 int start
, int end
, int overlaps
)
20686 struct glyph
*glyph
, *last
;
20689 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20690 s
->for_overlaps
= overlaps
;
20691 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20692 last
= s
->row
->glyphs
[s
->area
] + end
;
20693 voffset
= glyph
->voffset
;
20694 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20695 s
->font
= s
->face
->font
;
20697 s
->width
= glyph
->pixel_width
;
20699 while (glyph
< last
20700 && glyph
->type
== GLYPHLESS_GLYPH
20701 && glyph
->voffset
== voffset
20702 && glyph
->face_id
== face_id
)
20705 s
->width
+= glyph
->pixel_width
;
20708 s
->ybase
+= voffset
;
20709 return glyph
- s
->row
->glyphs
[s
->area
];
20713 /* Fill glyph string S from a sequence of character glyphs.
20715 FACE_ID is the face id of the string. START is the index of the
20716 first glyph to consider, END is the index of the last + 1.
20717 OVERLAPS non-zero means S should draw the foreground only, and use
20718 its physical height for clipping. See also draw_glyphs.
20720 Value is the index of the first glyph not in S. */
20723 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20724 int start
, int end
, int overlaps
)
20726 struct glyph
*glyph
, *last
;
20728 int glyph_not_available_p
;
20730 xassert (s
->f
== XFRAME (s
->w
->frame
));
20731 xassert (s
->nchars
== 0);
20732 xassert (start
>= 0 && end
> start
);
20734 s
->for_overlaps
= overlaps
;
20735 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20736 last
= s
->row
->glyphs
[s
->area
] + end
;
20737 voffset
= glyph
->voffset
;
20738 s
->padding_p
= glyph
->padding_p
;
20739 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20741 while (glyph
< last
20742 && glyph
->type
== CHAR_GLYPH
20743 && glyph
->voffset
== voffset
20744 /* Same face id implies same font, nowadays. */
20745 && glyph
->face_id
== face_id
20746 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20750 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20751 s
->char2b
+ s
->nchars
,
20753 s
->two_byte_p
= two_byte_p
;
20755 xassert (s
->nchars
<= end
- start
);
20756 s
->width
+= glyph
->pixel_width
;
20757 if (glyph
++->padding_p
!= s
->padding_p
)
20761 s
->font
= s
->face
->font
;
20763 /* If the specified font could not be loaded, use the frame's font,
20764 but record the fact that we couldn't load it in
20765 S->font_not_found_p so that we can draw rectangles for the
20766 characters of the glyph string. */
20767 if (s
->font
== NULL
|| glyph_not_available_p
)
20769 s
->font_not_found_p
= 1;
20770 s
->font
= FRAME_FONT (s
->f
);
20773 /* Adjust base line for subscript/superscript text. */
20774 s
->ybase
+= voffset
;
20776 xassert (s
->face
&& s
->face
->gc
);
20777 return glyph
- s
->row
->glyphs
[s
->area
];
20781 /* Fill glyph string S from image glyph S->first_glyph. */
20784 fill_image_glyph_string (struct glyph_string
*s
)
20786 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20787 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20789 s
->slice
= s
->first_glyph
->slice
.img
;
20790 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20791 s
->font
= s
->face
->font
;
20792 s
->width
= s
->first_glyph
->pixel_width
;
20794 /* Adjust base line for subscript/superscript text. */
20795 s
->ybase
+= s
->first_glyph
->voffset
;
20799 /* Fill glyph string S from a sequence of stretch glyphs.
20801 ROW is the glyph row in which the glyphs are found, AREA is the
20802 area within the row. START is the index of the first glyph to
20803 consider, END is the index of the last + 1.
20805 Value is the index of the first glyph not in S. */
20808 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20809 enum glyph_row_area area
, int start
, int end
)
20811 struct glyph
*glyph
, *last
;
20812 int voffset
, face_id
;
20814 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20816 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20817 last
= s
->row
->glyphs
[s
->area
] + end
;
20818 face_id
= glyph
->face_id
;
20819 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20820 s
->font
= s
->face
->font
;
20821 s
->width
= glyph
->pixel_width
;
20823 voffset
= glyph
->voffset
;
20827 && glyph
->type
== STRETCH_GLYPH
20828 && glyph
->voffset
== voffset
20829 && glyph
->face_id
== face_id
);
20831 s
->width
+= glyph
->pixel_width
;
20833 /* Adjust base line for subscript/superscript text. */
20834 s
->ybase
+= voffset
;
20836 /* The case that face->gc == 0 is handled when drawing the glyph
20837 string by calling PREPARE_FACE_FOR_DISPLAY. */
20839 return glyph
- s
->row
->glyphs
[s
->area
];
20842 static struct font_metrics
*
20843 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20845 static struct font_metrics metrics
;
20846 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20848 if (! font
|| code
== FONT_INVALID_CODE
)
20850 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20855 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20856 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20857 assumed to be zero. */
20860 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20862 *left
= *right
= 0;
20864 if (glyph
->type
== CHAR_GLYPH
)
20868 struct font_metrics
*pcm
;
20870 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20871 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20873 if (pcm
->rbearing
> pcm
->width
)
20874 *right
= pcm
->rbearing
- pcm
->width
;
20875 if (pcm
->lbearing
< 0)
20876 *left
= -pcm
->lbearing
;
20879 else if (glyph
->type
== COMPOSITE_GLYPH
)
20881 if (! glyph
->u
.cmp
.automatic
)
20883 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20885 if (cmp
->rbearing
> cmp
->pixel_width
)
20886 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20887 if (cmp
->lbearing
< 0)
20888 *left
= - cmp
->lbearing
;
20892 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20893 struct font_metrics metrics
;
20895 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20896 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20897 if (metrics
.rbearing
> metrics
.width
)
20898 *right
= metrics
.rbearing
- metrics
.width
;
20899 if (metrics
.lbearing
< 0)
20900 *left
= - metrics
.lbearing
;
20906 /* Return the index of the first glyph preceding glyph string S that
20907 is overwritten by S because of S's left overhang. Value is -1
20908 if no glyphs are overwritten. */
20911 left_overwritten (struct glyph_string
*s
)
20915 if (s
->left_overhang
)
20918 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20919 int first
= s
->first_glyph
- glyphs
;
20921 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20922 x
-= glyphs
[i
].pixel_width
;
20933 /* Return the index of the first glyph preceding glyph string S that
20934 is overwriting S because of its right overhang. Value is -1 if no
20935 glyph in front of S overwrites S. */
20938 left_overwriting (struct glyph_string
*s
)
20941 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20942 int first
= s
->first_glyph
- glyphs
;
20946 for (i
= first
- 1; i
>= 0; --i
)
20949 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20952 x
-= glyphs
[i
].pixel_width
;
20959 /* Return the index of the last glyph following glyph string S that is
20960 overwritten by S because of S's right overhang. Value is -1 if
20961 no such glyph is found. */
20964 right_overwritten (struct glyph_string
*s
)
20968 if (s
->right_overhang
)
20971 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20972 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20973 int end
= s
->row
->used
[s
->area
];
20975 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20976 x
+= glyphs
[i
].pixel_width
;
20985 /* Return the index of the last glyph following glyph string S that
20986 overwrites S because of its left overhang. Value is negative
20987 if no such glyph is found. */
20990 right_overwriting (struct glyph_string
*s
)
20993 int end
= s
->row
->used
[s
->area
];
20994 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20995 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20999 for (i
= first
; i
< end
; ++i
)
21002 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21005 x
+= glyphs
[i
].pixel_width
;
21012 /* Set background width of glyph string S. START is the index of the
21013 first glyph following S. LAST_X is the right-most x-position + 1
21014 in the drawing area. */
21017 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21019 /* If the face of this glyph string has to be drawn to the end of
21020 the drawing area, set S->extends_to_end_of_line_p. */
21022 if (start
== s
->row
->used
[s
->area
]
21023 && s
->area
== TEXT_AREA
21024 && ((s
->row
->fill_line_p
21025 && (s
->hl
== DRAW_NORMAL_TEXT
21026 || s
->hl
== DRAW_IMAGE_RAISED
21027 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21028 || s
->hl
== DRAW_MOUSE_FACE
))
21029 s
->extends_to_end_of_line_p
= 1;
21031 /* If S extends its face to the end of the line, set its
21032 background_width to the distance to the right edge of the drawing
21034 if (s
->extends_to_end_of_line_p
)
21035 s
->background_width
= last_x
- s
->x
+ 1;
21037 s
->background_width
= s
->width
;
21041 /* Compute overhangs and x-positions for glyph string S and its
21042 predecessors, or successors. X is the starting x-position for S.
21043 BACKWARD_P non-zero means process predecessors. */
21046 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21052 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21053 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21063 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21064 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21074 /* The following macros are only called from draw_glyphs below.
21075 They reference the following parameters of that function directly:
21076 `w', `row', `area', and `overlap_p'
21077 as well as the following local variables:
21078 `s', `f', and `hdc' (in W32) */
21081 /* On W32, silently add local `hdc' variable to argument list of
21082 init_glyph_string. */
21083 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21084 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21086 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21087 init_glyph_string (s, char2b, w, row, area, start, hl)
21090 /* Add a glyph string for a stretch glyph to the list of strings
21091 between HEAD and TAIL. START is the index of the stretch glyph in
21092 row area AREA of glyph row ROW. END is the index of the last glyph
21093 in that glyph row area. X is the current output position assigned
21094 to the new glyph string constructed. HL overrides that face of the
21095 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21096 is the right-most x-position of the drawing area. */
21098 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21099 and below -- keep them on one line. */
21100 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21103 s = (struct glyph_string *) alloca (sizeof *s); \
21104 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21105 START = fill_stretch_glyph_string (s, row, area, START, END); \
21106 append_glyph_string (&HEAD, &TAIL, s); \
21112 /* Add a glyph string for an image glyph to the list of strings
21113 between HEAD and TAIL. START is the index of the image glyph in
21114 row area AREA of glyph row ROW. END is the index of the last glyph
21115 in that glyph row area. X is the current output position assigned
21116 to the new glyph string constructed. HL overrides that face of the
21117 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21118 is the right-most x-position of the drawing area. */
21120 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21123 s = (struct glyph_string *) alloca (sizeof *s); \
21124 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21125 fill_image_glyph_string (s); \
21126 append_glyph_string (&HEAD, &TAIL, s); \
21133 /* Add a glyph string for a sequence of character glyphs to the list
21134 of strings between HEAD and TAIL. START is the index of the first
21135 glyph in row area AREA of glyph row ROW that is part of the new
21136 glyph string. END is the index of the last glyph in that glyph row
21137 area. X is the current output position assigned to the new glyph
21138 string constructed. HL overrides that face of the glyph; e.g. it
21139 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21140 right-most x-position of the drawing area. */
21142 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21148 face_id = (row)->glyphs[area][START].face_id; \
21150 s = (struct glyph_string *) alloca (sizeof *s); \
21151 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21152 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21153 append_glyph_string (&HEAD, &TAIL, s); \
21155 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21160 /* Add a glyph string for a composite sequence to the list of strings
21161 between HEAD and TAIL. START is the index of the first glyph in
21162 row area AREA of glyph row ROW that is part of the new glyph
21163 string. END is the index of the last glyph in that glyph row area.
21164 X is the current output position assigned to the new glyph string
21165 constructed. HL overrides that face of the glyph; e.g. it is
21166 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21167 x-position of the drawing area. */
21169 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21171 int face_id = (row)->glyphs[area][START].face_id; \
21172 struct face *base_face = FACE_FROM_ID (f, face_id); \
21173 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21174 struct composition *cmp = composition_table[cmp_id]; \
21176 struct glyph_string *first_s IF_LINT (= NULL); \
21179 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21181 /* Make glyph_strings for each glyph sequence that is drawable by \
21182 the same face, and append them to HEAD/TAIL. */ \
21183 for (n = 0; n < cmp->glyph_len;) \
21185 s = (struct glyph_string *) alloca (sizeof *s); \
21186 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21187 append_glyph_string (&(HEAD), &(TAIL), s); \
21193 n = fill_composite_glyph_string (s, base_face, overlaps); \
21201 /* Add a glyph string for a glyph-string sequence to the list of strings
21202 between HEAD and TAIL. */
21204 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21208 Lisp_Object gstring; \
21210 face_id = (row)->glyphs[area][START].face_id; \
21211 gstring = (composition_gstring_from_id \
21212 ((row)->glyphs[area][START].u.cmp.id)); \
21213 s = (struct glyph_string *) alloca (sizeof *s); \
21214 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21215 * LGSTRING_GLYPH_LEN (gstring)); \
21216 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21217 append_glyph_string (&(HEAD), &(TAIL), s); \
21219 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21223 /* Add a glyph string for a sequence of glyphless character's glyphs
21224 to the list of strings between HEAD and TAIL. The meanings of
21225 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21227 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21232 face_id = (row)->glyphs[area][START].face_id; \
21234 s = (struct glyph_string *) alloca (sizeof *s); \
21235 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21236 append_glyph_string (&HEAD, &TAIL, s); \
21238 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21244 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21245 of AREA of glyph row ROW on window W between indices START and END.
21246 HL overrides the face for drawing glyph strings, e.g. it is
21247 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21248 x-positions of the drawing area.
21250 This is an ugly monster macro construct because we must use alloca
21251 to allocate glyph strings (because draw_glyphs can be called
21252 asynchronously). */
21254 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21257 HEAD = TAIL = NULL; \
21258 while (START < END) \
21260 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21261 switch (first_glyph->type) \
21264 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21268 case COMPOSITE_GLYPH: \
21269 if (first_glyph->u.cmp.automatic) \
21270 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21273 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21277 case STRETCH_GLYPH: \
21278 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21282 case IMAGE_GLYPH: \
21283 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21287 case GLYPHLESS_GLYPH: \
21288 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21298 set_glyph_string_background_width (s, START, LAST_X); \
21305 /* Draw glyphs between START and END in AREA of ROW on window W,
21306 starting at x-position X. X is relative to AREA in W. HL is a
21307 face-override with the following meaning:
21309 DRAW_NORMAL_TEXT draw normally
21310 DRAW_CURSOR draw in cursor face
21311 DRAW_MOUSE_FACE draw in mouse face.
21312 DRAW_INVERSE_VIDEO draw in mode line face
21313 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21314 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21316 If OVERLAPS is non-zero, draw only the foreground of characters and
21317 clip to the physical height of ROW. Non-zero value also defines
21318 the overlapping part to be drawn:
21320 OVERLAPS_PRED overlap with preceding rows
21321 OVERLAPS_SUCC overlap with succeeding rows
21322 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21323 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21325 Value is the x-position reached, relative to AREA of W. */
21328 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21329 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21330 enum draw_glyphs_face hl
, int overlaps
)
21332 struct glyph_string
*head
, *tail
;
21333 struct glyph_string
*s
;
21334 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21335 int i
, j
, x_reached
, last_x
, area_left
= 0;
21336 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21339 ALLOCATE_HDC (hdc
, f
);
21341 /* Let's rather be paranoid than getting a SEGV. */
21342 end
= min (end
, row
->used
[area
]);
21343 start
= max (0, start
);
21344 start
= min (end
, start
);
21346 /* Translate X to frame coordinates. Set last_x to the right
21347 end of the drawing area. */
21348 if (row
->full_width_p
)
21350 /* X is relative to the left edge of W, without scroll bars
21352 area_left
= WINDOW_LEFT_EDGE_X (w
);
21353 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21357 area_left
= window_box_left (w
, area
);
21358 last_x
= area_left
+ window_box_width (w
, area
);
21362 /* Build a doubly-linked list of glyph_string structures between
21363 head and tail from what we have to draw. Note that the macro
21364 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21365 the reason we use a separate variable `i'. */
21367 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21369 x_reached
= tail
->x
+ tail
->background_width
;
21373 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21374 the row, redraw some glyphs in front or following the glyph
21375 strings built above. */
21376 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21378 struct glyph_string
*h
, *t
;
21379 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21380 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21381 int check_mouse_face
= 0;
21384 /* If mouse highlighting is on, we may need to draw adjacent
21385 glyphs using mouse-face highlighting. */
21386 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21388 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21390 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21391 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21393 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21395 check_mouse_face
= 1;
21396 mouse_beg_col
= (row
== mouse_beg_row
)
21397 ? hlinfo
->mouse_face_beg_col
: 0;
21398 mouse_end_col
= (row
== mouse_end_row
)
21399 ? hlinfo
->mouse_face_end_col
21400 : row
->used
[TEXT_AREA
];
21404 /* Compute overhangs for all glyph strings. */
21405 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21406 for (s
= head
; s
; s
= s
->next
)
21407 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21409 /* Prepend glyph strings for glyphs in front of the first glyph
21410 string that are overwritten because of the first glyph
21411 string's left overhang. The background of all strings
21412 prepended must be drawn because the first glyph string
21414 i
= left_overwritten (head
);
21417 enum draw_glyphs_face overlap_hl
;
21419 /* If this row contains mouse highlighting, attempt to draw
21420 the overlapped glyphs with the correct highlight. This
21421 code fails if the overlap encompasses more than one glyph
21422 and mouse-highlight spans only some of these glyphs.
21423 However, making it work perfectly involves a lot more
21424 code, and I don't know if the pathological case occurs in
21425 practice, so we'll stick to this for now. --- cyd */
21426 if (check_mouse_face
21427 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21428 overlap_hl
= DRAW_MOUSE_FACE
;
21430 overlap_hl
= DRAW_NORMAL_TEXT
;
21433 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21434 overlap_hl
, dummy_x
, last_x
);
21436 compute_overhangs_and_x (t
, head
->x
, 1);
21437 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21441 /* Prepend glyph strings for glyphs in front of the first glyph
21442 string that overwrite that glyph string because of their
21443 right overhang. For these strings, only the foreground must
21444 be drawn, because it draws over the glyph string at `head'.
21445 The background must not be drawn because this would overwrite
21446 right overhangs of preceding glyphs for which no glyph
21448 i
= left_overwriting (head
);
21451 enum draw_glyphs_face overlap_hl
;
21453 if (check_mouse_face
21454 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21455 overlap_hl
= DRAW_MOUSE_FACE
;
21457 overlap_hl
= DRAW_NORMAL_TEXT
;
21460 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21461 overlap_hl
, dummy_x
, last_x
);
21462 for (s
= h
; s
; s
= s
->next
)
21463 s
->background_filled_p
= 1;
21464 compute_overhangs_and_x (t
, head
->x
, 1);
21465 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21468 /* Append glyphs strings for glyphs following the last glyph
21469 string tail that are overwritten by tail. The background of
21470 these strings has to be drawn because tail's foreground draws
21472 i
= right_overwritten (tail
);
21475 enum draw_glyphs_face overlap_hl
;
21477 if (check_mouse_face
21478 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21479 overlap_hl
= DRAW_MOUSE_FACE
;
21481 overlap_hl
= DRAW_NORMAL_TEXT
;
21483 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21484 overlap_hl
, x
, last_x
);
21485 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21486 we don't have `end = i;' here. */
21487 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21488 append_glyph_string_lists (&head
, &tail
, h
, t
);
21492 /* Append glyph strings for glyphs following the last glyph
21493 string tail that overwrite tail. The foreground of such
21494 glyphs has to be drawn because it writes into the background
21495 of tail. The background must not be drawn because it could
21496 paint over the foreground of following glyphs. */
21497 i
= right_overwriting (tail
);
21500 enum draw_glyphs_face overlap_hl
;
21501 if (check_mouse_face
21502 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21503 overlap_hl
= DRAW_MOUSE_FACE
;
21505 overlap_hl
= DRAW_NORMAL_TEXT
;
21508 i
++; /* We must include the Ith glyph. */
21509 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21510 overlap_hl
, x
, last_x
);
21511 for (s
= h
; s
; s
= s
->next
)
21512 s
->background_filled_p
= 1;
21513 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21514 append_glyph_string_lists (&head
, &tail
, h
, t
);
21516 if (clip_head
|| clip_tail
)
21517 for (s
= head
; s
; s
= s
->next
)
21519 s
->clip_head
= clip_head
;
21520 s
->clip_tail
= clip_tail
;
21524 /* Draw all strings. */
21525 for (s
= head
; s
; s
= s
->next
)
21526 FRAME_RIF (f
)->draw_glyph_string (s
);
21529 /* When focus a sole frame and move horizontally, this sets on_p to 0
21530 causing a failure to erase prev cursor position. */
21531 if (area
== TEXT_AREA
21532 && !row
->full_width_p
21533 /* When drawing overlapping rows, only the glyph strings'
21534 foreground is drawn, which doesn't erase a cursor
21538 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21539 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21540 : (tail
? tail
->x
+ tail
->background_width
: x
));
21544 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21545 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21549 /* Value is the x-position up to which drawn, relative to AREA of W.
21550 This doesn't include parts drawn because of overhangs. */
21551 if (row
->full_width_p
)
21552 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21554 x_reached
-= area_left
;
21556 RELEASE_HDC (hdc
, f
);
21561 /* Expand row matrix if too narrow. Don't expand if area
21564 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21566 if (!fonts_changed_p \
21567 && (it->glyph_row->glyphs[area] \
21568 < it->glyph_row->glyphs[area + 1])) \
21570 it->w->ncols_scale_factor++; \
21571 fonts_changed_p = 1; \
21575 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21576 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21579 append_glyph (struct it
*it
)
21581 struct glyph
*glyph
;
21582 enum glyph_row_area area
= it
->area
;
21584 xassert (it
->glyph_row
);
21585 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21587 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21588 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21590 /* If the glyph row is reversed, we need to prepend the glyph
21591 rather than append it. */
21592 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21596 /* Make room for the additional glyph. */
21597 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21599 glyph
= it
->glyph_row
->glyphs
[area
];
21601 glyph
->charpos
= CHARPOS (it
->position
);
21602 glyph
->object
= it
->object
;
21603 if (it
->pixel_width
> 0)
21605 glyph
->pixel_width
= it
->pixel_width
;
21606 glyph
->padding_p
= 0;
21610 /* Assure at least 1-pixel width. Otherwise, cursor can't
21611 be displayed correctly. */
21612 glyph
->pixel_width
= 1;
21613 glyph
->padding_p
= 1;
21615 glyph
->ascent
= it
->ascent
;
21616 glyph
->descent
= it
->descent
;
21617 glyph
->voffset
= it
->voffset
;
21618 glyph
->type
= CHAR_GLYPH
;
21619 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21620 glyph
->multibyte_p
= it
->multibyte_p
;
21621 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21622 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21623 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21624 || it
->phys_descent
> it
->descent
);
21625 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21626 glyph
->face_id
= it
->face_id
;
21627 glyph
->u
.ch
= it
->char_to_display
;
21628 glyph
->slice
.img
= null_glyph_slice
;
21629 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21632 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21633 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21635 glyph
->bidi_type
= it
->bidi_it
.type
;
21639 glyph
->resolved_level
= 0;
21640 glyph
->bidi_type
= UNKNOWN_BT
;
21642 ++it
->glyph_row
->used
[area
];
21645 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21648 /* Store one glyph for the composition IT->cmp_it.id in
21649 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21653 append_composite_glyph (struct it
*it
)
21655 struct glyph
*glyph
;
21656 enum glyph_row_area area
= it
->area
;
21658 xassert (it
->glyph_row
);
21660 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21661 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21663 /* If the glyph row is reversed, we need to prepend the glyph
21664 rather than append it. */
21665 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21669 /* Make room for the new glyph. */
21670 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21672 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21674 glyph
->charpos
= it
->cmp_it
.charpos
;
21675 glyph
->object
= it
->object
;
21676 glyph
->pixel_width
= it
->pixel_width
;
21677 glyph
->ascent
= it
->ascent
;
21678 glyph
->descent
= it
->descent
;
21679 glyph
->voffset
= it
->voffset
;
21680 glyph
->type
= COMPOSITE_GLYPH
;
21681 if (it
->cmp_it
.ch
< 0)
21683 glyph
->u
.cmp
.automatic
= 0;
21684 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21685 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21689 glyph
->u
.cmp
.automatic
= 1;
21690 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21691 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21692 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21694 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21695 glyph
->multibyte_p
= it
->multibyte_p
;
21696 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21697 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21698 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21699 || it
->phys_descent
> it
->descent
);
21700 glyph
->padding_p
= 0;
21701 glyph
->glyph_not_available_p
= 0;
21702 glyph
->face_id
= it
->face_id
;
21703 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21706 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21707 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21709 glyph
->bidi_type
= it
->bidi_it
.type
;
21711 ++it
->glyph_row
->used
[area
];
21714 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21718 /* Change IT->ascent and IT->height according to the setting of
21722 take_vertical_position_into_account (struct it
*it
)
21726 if (it
->voffset
< 0)
21727 /* Increase the ascent so that we can display the text higher
21729 it
->ascent
-= it
->voffset
;
21731 /* Increase the descent so that we can display the text lower
21733 it
->descent
+= it
->voffset
;
21738 /* Produce glyphs/get display metrics for the image IT is loaded with.
21739 See the description of struct display_iterator in dispextern.h for
21740 an overview of struct display_iterator. */
21743 produce_image_glyph (struct it
*it
)
21747 int glyph_ascent
, crop
;
21748 struct glyph_slice slice
;
21750 xassert (it
->what
== IT_IMAGE
);
21752 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21754 /* Make sure X resources of the face is loaded. */
21755 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21757 if (it
->image_id
< 0)
21759 /* Fringe bitmap. */
21760 it
->ascent
= it
->phys_ascent
= 0;
21761 it
->descent
= it
->phys_descent
= 0;
21762 it
->pixel_width
= 0;
21767 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21769 /* Make sure X resources of the image is loaded. */
21770 prepare_image_for_display (it
->f
, img
);
21772 slice
.x
= slice
.y
= 0;
21773 slice
.width
= img
->width
;
21774 slice
.height
= img
->height
;
21776 if (INTEGERP (it
->slice
.x
))
21777 slice
.x
= XINT (it
->slice
.x
);
21778 else if (FLOATP (it
->slice
.x
))
21779 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21781 if (INTEGERP (it
->slice
.y
))
21782 slice
.y
= XINT (it
->slice
.y
);
21783 else if (FLOATP (it
->slice
.y
))
21784 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21786 if (INTEGERP (it
->slice
.width
))
21787 slice
.width
= XINT (it
->slice
.width
);
21788 else if (FLOATP (it
->slice
.width
))
21789 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21791 if (INTEGERP (it
->slice
.height
))
21792 slice
.height
= XINT (it
->slice
.height
);
21793 else if (FLOATP (it
->slice
.height
))
21794 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21796 if (slice
.x
>= img
->width
)
21797 slice
.x
= img
->width
;
21798 if (slice
.y
>= img
->height
)
21799 slice
.y
= img
->height
;
21800 if (slice
.x
+ slice
.width
>= img
->width
)
21801 slice
.width
= img
->width
- slice
.x
;
21802 if (slice
.y
+ slice
.height
> img
->height
)
21803 slice
.height
= img
->height
- slice
.y
;
21805 if (slice
.width
== 0 || slice
.height
== 0)
21808 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21810 it
->descent
= slice
.height
- glyph_ascent
;
21812 it
->descent
+= img
->vmargin
;
21813 if (slice
.y
+ slice
.height
== img
->height
)
21814 it
->descent
+= img
->vmargin
;
21815 it
->phys_descent
= it
->descent
;
21817 it
->pixel_width
= slice
.width
;
21819 it
->pixel_width
+= img
->hmargin
;
21820 if (slice
.x
+ slice
.width
== img
->width
)
21821 it
->pixel_width
+= img
->hmargin
;
21823 /* It's quite possible for images to have an ascent greater than
21824 their height, so don't get confused in that case. */
21825 if (it
->descent
< 0)
21830 if (face
->box
!= FACE_NO_BOX
)
21832 if (face
->box_line_width
> 0)
21835 it
->ascent
+= face
->box_line_width
;
21836 if (slice
.y
+ slice
.height
== img
->height
)
21837 it
->descent
+= face
->box_line_width
;
21840 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21841 it
->pixel_width
+= eabs (face
->box_line_width
);
21842 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21843 it
->pixel_width
+= eabs (face
->box_line_width
);
21846 take_vertical_position_into_account (it
);
21848 /* Automatically crop wide image glyphs at right edge so we can
21849 draw the cursor on same display row. */
21850 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21851 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21853 it
->pixel_width
-= crop
;
21854 slice
.width
-= crop
;
21859 struct glyph
*glyph
;
21860 enum glyph_row_area area
= it
->area
;
21862 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21863 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21865 glyph
->charpos
= CHARPOS (it
->position
);
21866 glyph
->object
= it
->object
;
21867 glyph
->pixel_width
= it
->pixel_width
;
21868 glyph
->ascent
= glyph_ascent
;
21869 glyph
->descent
= it
->descent
;
21870 glyph
->voffset
= it
->voffset
;
21871 glyph
->type
= IMAGE_GLYPH
;
21872 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21873 glyph
->multibyte_p
= it
->multibyte_p
;
21874 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21875 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21876 glyph
->overlaps_vertically_p
= 0;
21877 glyph
->padding_p
= 0;
21878 glyph
->glyph_not_available_p
= 0;
21879 glyph
->face_id
= it
->face_id
;
21880 glyph
->u
.img_id
= img
->id
;
21881 glyph
->slice
.img
= slice
;
21882 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21885 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21886 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21888 glyph
->bidi_type
= it
->bidi_it
.type
;
21890 ++it
->glyph_row
->used
[area
];
21893 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21898 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21899 of the glyph, WIDTH and HEIGHT are the width and height of the
21900 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21903 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21904 int width
, int height
, int ascent
)
21906 struct glyph
*glyph
;
21907 enum glyph_row_area area
= it
->area
;
21909 xassert (ascent
>= 0 && ascent
<= height
);
21911 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21912 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21914 /* If the glyph row is reversed, we need to prepend the glyph
21915 rather than append it. */
21916 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21920 /* Make room for the additional glyph. */
21921 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21923 glyph
= it
->glyph_row
->glyphs
[area
];
21925 glyph
->charpos
= CHARPOS (it
->position
);
21926 glyph
->object
= object
;
21927 glyph
->pixel_width
= width
;
21928 glyph
->ascent
= ascent
;
21929 glyph
->descent
= height
- ascent
;
21930 glyph
->voffset
= it
->voffset
;
21931 glyph
->type
= STRETCH_GLYPH
;
21932 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21933 glyph
->multibyte_p
= it
->multibyte_p
;
21934 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21935 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21936 glyph
->overlaps_vertically_p
= 0;
21937 glyph
->padding_p
= 0;
21938 glyph
->glyph_not_available_p
= 0;
21939 glyph
->face_id
= it
->face_id
;
21940 glyph
->u
.stretch
.ascent
= ascent
;
21941 glyph
->u
.stretch
.height
= height
;
21942 glyph
->slice
.img
= null_glyph_slice
;
21943 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21946 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21947 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21949 glyph
->bidi_type
= it
->bidi_it
.type
;
21953 glyph
->resolved_level
= 0;
21954 glyph
->bidi_type
= UNKNOWN_BT
;
21956 ++it
->glyph_row
->used
[area
];
21959 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21963 /* Produce a stretch glyph for iterator IT. IT->object is the value
21964 of the glyph property displayed. The value must be a list
21965 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21968 1. `:width WIDTH' specifies that the space should be WIDTH *
21969 canonical char width wide. WIDTH may be an integer or floating
21972 2. `:relative-width FACTOR' specifies that the width of the stretch
21973 should be computed from the width of the first character having the
21974 `glyph' property, and should be FACTOR times that width.
21976 3. `:align-to HPOS' specifies that the space should be wide enough
21977 to reach HPOS, a value in canonical character units.
21979 Exactly one of the above pairs must be present.
21981 4. `:height HEIGHT' specifies that the height of the stretch produced
21982 should be HEIGHT, measured in canonical character units.
21984 5. `:relative-height FACTOR' specifies that the height of the
21985 stretch should be FACTOR times the height of the characters having
21986 the glyph property.
21988 Either none or exactly one of 4 or 5 must be present.
21990 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21991 of the stretch should be used for the ascent of the stretch.
21992 ASCENT must be in the range 0 <= ASCENT <= 100. */
21995 produce_stretch_glyph (struct it
*it
)
21997 /* (space :width WIDTH :height HEIGHT ...) */
21998 Lisp_Object prop
, plist
;
21999 int width
= 0, height
= 0, align_to
= -1;
22000 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22003 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22004 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22006 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22008 /* List should start with `space'. */
22009 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22010 plist
= XCDR (it
->object
);
22012 /* Compute the width of the stretch. */
22013 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22014 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22016 /* Absolute width `:width WIDTH' specified and valid. */
22017 zero_width_ok_p
= 1;
22020 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22023 /* Relative width `:relative-width FACTOR' specified and valid.
22024 Compute the width of the characters having the `glyph'
22027 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22030 if (it
->multibyte_p
)
22031 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22034 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22035 if (! ASCII_CHAR_P (it2
.c
))
22036 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22039 it2
.glyph_row
= NULL
;
22040 it2
.what
= IT_CHARACTER
;
22041 x_produce_glyphs (&it2
);
22042 width
= NUMVAL (prop
) * it2
.pixel_width
;
22044 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22045 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22047 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22048 align_to
= (align_to
< 0
22050 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22051 else if (align_to
< 0)
22052 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22053 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22054 zero_width_ok_p
= 1;
22057 /* Nothing specified -> width defaults to canonical char width. */
22058 width
= FRAME_COLUMN_WIDTH (it
->f
);
22060 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22063 /* Compute height. */
22064 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22065 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22068 zero_height_ok_p
= 1;
22070 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22072 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22074 height
= FONT_HEIGHT (font
);
22076 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22079 /* Compute percentage of height used for ascent. If
22080 `:ascent ASCENT' is present and valid, use that. Otherwise,
22081 derive the ascent from the font in use. */
22082 if (prop
= Fplist_get (plist
, QCascent
),
22083 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22084 ascent
= height
* NUMVAL (prop
) / 100.0;
22085 else if (!NILP (prop
)
22086 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22087 ascent
= min (max (0, (int)tem
), height
);
22089 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22091 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22092 && it
->current_x
+ width
> it
->last_visible_x
)
22093 width
= it
->last_visible_x
- it
->current_x
- 1;
22095 if (width
> 0 && height
> 0 && it
->glyph_row
)
22097 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22098 if (!STRINGP (object
))
22099 object
= it
->w
->buffer
;
22100 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22103 it
->pixel_width
= width
;
22104 it
->ascent
= it
->phys_ascent
= ascent
;
22105 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22106 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22108 take_vertical_position_into_account (it
);
22111 /* Calculate line-height and line-spacing properties.
22112 An integer value specifies explicit pixel value.
22113 A float value specifies relative value to current face height.
22114 A cons (float . face-name) specifies relative value to
22115 height of specified face font.
22117 Returns height in pixels, or nil. */
22121 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22122 int boff
, int override
)
22124 Lisp_Object face_name
= Qnil
;
22125 int ascent
, descent
, height
;
22127 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22132 face_name
= XCAR (val
);
22134 if (!NUMBERP (val
))
22135 val
= make_number (1);
22136 if (NILP (face_name
))
22138 height
= it
->ascent
+ it
->descent
;
22143 if (NILP (face_name
))
22145 font
= FRAME_FONT (it
->f
);
22146 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22148 else if (EQ (face_name
, Qt
))
22157 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22159 return make_number (-1);
22161 face
= FACE_FROM_ID (it
->f
, face_id
);
22164 return make_number (-1);
22165 boff
= font
->baseline_offset
;
22166 if (font
->vertical_centering
)
22167 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22170 ascent
= FONT_BASE (font
) + boff
;
22171 descent
= FONT_DESCENT (font
) - boff
;
22175 it
->override_ascent
= ascent
;
22176 it
->override_descent
= descent
;
22177 it
->override_boff
= boff
;
22180 height
= ascent
+ descent
;
22184 height
= (int)(XFLOAT_DATA (val
) * height
);
22185 else if (INTEGERP (val
))
22186 height
*= XINT (val
);
22188 return make_number (height
);
22192 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22193 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22194 and only if this is for a character for which no font was found.
22196 If the display method (it->glyphless_method) is
22197 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22198 length of the acronym or the hexadecimal string, UPPER_XOFF and
22199 UPPER_YOFF are pixel offsets for the upper part of the string,
22200 LOWER_XOFF and LOWER_YOFF are for the lower part.
22202 For the other display methods, LEN through LOWER_YOFF are zero. */
22205 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22206 short upper_xoff
, short upper_yoff
,
22207 short lower_xoff
, short lower_yoff
)
22209 struct glyph
*glyph
;
22210 enum glyph_row_area area
= it
->area
;
22212 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22213 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22215 /* If the glyph row is reversed, we need to prepend the glyph
22216 rather than append it. */
22217 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22221 /* Make room for the additional glyph. */
22222 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22224 glyph
= it
->glyph_row
->glyphs
[area
];
22226 glyph
->charpos
= CHARPOS (it
->position
);
22227 glyph
->object
= it
->object
;
22228 glyph
->pixel_width
= it
->pixel_width
;
22229 glyph
->ascent
= it
->ascent
;
22230 glyph
->descent
= it
->descent
;
22231 glyph
->voffset
= it
->voffset
;
22232 glyph
->type
= GLYPHLESS_GLYPH
;
22233 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22234 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22235 glyph
->u
.glyphless
.len
= len
;
22236 glyph
->u
.glyphless
.ch
= it
->c
;
22237 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22238 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22239 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22240 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22241 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22242 glyph
->multibyte_p
= it
->multibyte_p
;
22243 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22244 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22245 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22246 || it
->phys_descent
> it
->descent
);
22247 glyph
->padding_p
= 0;
22248 glyph
->glyph_not_available_p
= 0;
22249 glyph
->face_id
= face_id
;
22250 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22253 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22254 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22256 glyph
->bidi_type
= it
->bidi_it
.type
;
22258 ++it
->glyph_row
->used
[area
];
22261 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22265 /* Produce a glyph for a glyphless character for iterator IT.
22266 IT->glyphless_method specifies which method to use for displaying
22267 the character. See the description of enum
22268 glyphless_display_method in dispextern.h for the detail.
22270 FOR_NO_FONT is nonzero if and only if this is for a character for
22271 which no font was found. ACRONYM, if non-nil, is an acronym string
22272 for the character. */
22275 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22280 int base_width
, base_height
, width
, height
;
22281 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22284 /* Get the metrics of the base font. We always refer to the current
22286 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22287 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22288 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22289 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22290 base_height
= it
->ascent
+ it
->descent
;
22291 base_width
= font
->average_width
;
22293 /* Get a face ID for the glyph by utilizing a cache (the same way as
22294 doen for `escape-glyph' in get_next_display_element). */
22295 if (it
->f
== last_glyphless_glyph_frame
22296 && it
->face_id
== last_glyphless_glyph_face_id
)
22298 face_id
= last_glyphless_glyph_merged_face_id
;
22302 /* Merge the `glyphless-char' face into the current face. */
22303 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22304 last_glyphless_glyph_frame
= it
->f
;
22305 last_glyphless_glyph_face_id
= it
->face_id
;
22306 last_glyphless_glyph_merged_face_id
= face_id
;
22309 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22311 it
->pixel_width
= THIN_SPACE_WIDTH
;
22313 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22315 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22317 width
= CHAR_WIDTH (it
->c
);
22320 else if (width
> 4)
22322 it
->pixel_width
= base_width
* width
;
22324 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22330 unsigned int code
[6];
22332 int ascent
, descent
;
22333 struct font_metrics metrics_upper
, metrics_lower
;
22335 face
= FACE_FROM_ID (it
->f
, face_id
);
22336 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22337 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22339 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22341 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22342 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22343 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22347 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22348 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22351 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22352 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22353 upper_len
= (len
+ 1) / 2;
22354 font
->driver
->text_extents (font
, code
, upper_len
,
22356 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22361 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22362 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22363 upper_xoff
= upper_yoff
= 2; /* the typical case */
22364 if (base_width
>= width
)
22366 /* Align the upper to the left, the lower to the right. */
22367 it
->pixel_width
= base_width
;
22368 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22372 /* Center the shorter one. */
22373 it
->pixel_width
= width
;
22374 if (metrics_upper
.width
>= metrics_lower
.width
)
22375 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22378 /* FIXME: This code doesn't look right. It formerly was
22379 missing the "lower_xoff = 0;", which couldn't have
22380 been right since it left lower_xoff uninitialized. */
22382 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22386 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22387 top, bottom, and between upper and lower strings. */
22388 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22389 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22390 /* Center vertically.
22391 H:base_height, D:base_descent
22392 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22394 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22395 descent = D - H/2 + h/2;
22396 lower_yoff = descent - 2 - ld;
22397 upper_yoff = lower_yoff - la - 1 - ud; */
22398 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22399 descent
= it
->descent
- (base_height
- height
) / 2;
22400 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22401 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22402 - metrics_upper
.descent
);
22403 /* Don't make the height shorter than the base height. */
22404 if (height
> base_height
)
22406 it
->ascent
= ascent
;
22407 it
->descent
= descent
;
22411 it
->phys_ascent
= it
->ascent
;
22412 it
->phys_descent
= it
->descent
;
22414 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22415 upper_xoff
, upper_yoff
,
22416 lower_xoff
, lower_yoff
);
22418 take_vertical_position_into_account (it
);
22423 Produce glyphs/get display metrics for the display element IT is
22424 loaded with. See the description of struct it in dispextern.h
22425 for an overview of struct it. */
22428 x_produce_glyphs (struct it
*it
)
22430 int extra_line_spacing
= it
->extra_line_spacing
;
22432 it
->glyph_not_available_p
= 0;
22434 if (it
->what
== IT_CHARACTER
)
22437 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22438 struct font
*font
= face
->font
;
22439 struct font_metrics
*pcm
= NULL
;
22440 int boff
; /* baseline offset */
22444 /* When no suitable font is found, display this character by
22445 the method specified in the first extra slot of
22446 Vglyphless_char_display. */
22447 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22449 xassert (it
->what
== IT_GLYPHLESS
);
22450 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22454 boff
= font
->baseline_offset
;
22455 if (font
->vertical_centering
)
22456 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22458 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22464 if (it
->override_ascent
>= 0)
22466 it
->ascent
= it
->override_ascent
;
22467 it
->descent
= it
->override_descent
;
22468 boff
= it
->override_boff
;
22472 it
->ascent
= FONT_BASE (font
) + boff
;
22473 it
->descent
= FONT_DESCENT (font
) - boff
;
22476 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22478 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22479 if (pcm
->width
== 0
22480 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22486 it
->phys_ascent
= pcm
->ascent
+ boff
;
22487 it
->phys_descent
= pcm
->descent
- boff
;
22488 it
->pixel_width
= pcm
->width
;
22492 it
->glyph_not_available_p
= 1;
22493 it
->phys_ascent
= it
->ascent
;
22494 it
->phys_descent
= it
->descent
;
22495 it
->pixel_width
= font
->space_width
;
22498 if (it
->constrain_row_ascent_descent_p
)
22500 if (it
->descent
> it
->max_descent
)
22502 it
->ascent
+= it
->descent
- it
->max_descent
;
22503 it
->descent
= it
->max_descent
;
22505 if (it
->ascent
> it
->max_ascent
)
22507 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22508 it
->ascent
= it
->max_ascent
;
22510 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22511 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22512 extra_line_spacing
= 0;
22515 /* If this is a space inside a region of text with
22516 `space-width' property, change its width. */
22517 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22519 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22521 /* If face has a box, add the box thickness to the character
22522 height. If character has a box line to the left and/or
22523 right, add the box line width to the character's width. */
22524 if (face
->box
!= FACE_NO_BOX
)
22526 int thick
= face
->box_line_width
;
22530 it
->ascent
+= thick
;
22531 it
->descent
+= thick
;
22536 if (it
->start_of_box_run_p
)
22537 it
->pixel_width
+= thick
;
22538 if (it
->end_of_box_run_p
)
22539 it
->pixel_width
+= thick
;
22542 /* If face has an overline, add the height of the overline
22543 (1 pixel) and a 1 pixel margin to the character height. */
22544 if (face
->overline_p
)
22545 it
->ascent
+= overline_margin
;
22547 if (it
->constrain_row_ascent_descent_p
)
22549 if (it
->ascent
> it
->max_ascent
)
22550 it
->ascent
= it
->max_ascent
;
22551 if (it
->descent
> it
->max_descent
)
22552 it
->descent
= it
->max_descent
;
22555 take_vertical_position_into_account (it
);
22557 /* If we have to actually produce glyphs, do it. */
22562 /* Translate a space with a `space-width' property
22563 into a stretch glyph. */
22564 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22565 / FONT_HEIGHT (font
));
22566 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22567 it
->ascent
+ it
->descent
, ascent
);
22572 /* If characters with lbearing or rbearing are displayed
22573 in this line, record that fact in a flag of the
22574 glyph row. This is used to optimize X output code. */
22575 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22576 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22578 if (! stretched_p
&& it
->pixel_width
== 0)
22579 /* We assure that all visible glyphs have at least 1-pixel
22581 it
->pixel_width
= 1;
22583 else if (it
->char_to_display
== '\n')
22585 /* A newline has no width, but we need the height of the
22586 line. But if previous part of the line sets a height,
22587 don't increase that height */
22589 Lisp_Object height
;
22590 Lisp_Object total_height
= Qnil
;
22592 it
->override_ascent
= -1;
22593 it
->pixel_width
= 0;
22596 height
= get_it_property (it
, Qline_height
);
22597 /* Split (line-height total-height) list */
22599 && CONSP (XCDR (height
))
22600 && NILP (XCDR (XCDR (height
))))
22602 total_height
= XCAR (XCDR (height
));
22603 height
= XCAR (height
);
22605 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22607 if (it
->override_ascent
>= 0)
22609 it
->ascent
= it
->override_ascent
;
22610 it
->descent
= it
->override_descent
;
22611 boff
= it
->override_boff
;
22615 it
->ascent
= FONT_BASE (font
) + boff
;
22616 it
->descent
= FONT_DESCENT (font
) - boff
;
22619 if (EQ (height
, Qt
))
22621 if (it
->descent
> it
->max_descent
)
22623 it
->ascent
+= it
->descent
- it
->max_descent
;
22624 it
->descent
= it
->max_descent
;
22626 if (it
->ascent
> it
->max_ascent
)
22628 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22629 it
->ascent
= it
->max_ascent
;
22631 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22632 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22633 it
->constrain_row_ascent_descent_p
= 1;
22634 extra_line_spacing
= 0;
22638 Lisp_Object spacing
;
22640 it
->phys_ascent
= it
->ascent
;
22641 it
->phys_descent
= it
->descent
;
22643 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22644 && face
->box
!= FACE_NO_BOX
22645 && face
->box_line_width
> 0)
22647 it
->ascent
+= face
->box_line_width
;
22648 it
->descent
+= face
->box_line_width
;
22651 && XINT (height
) > it
->ascent
+ it
->descent
)
22652 it
->ascent
= XINT (height
) - it
->descent
;
22654 if (!NILP (total_height
))
22655 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22658 spacing
= get_it_property (it
, Qline_spacing
);
22659 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22661 if (INTEGERP (spacing
))
22663 extra_line_spacing
= XINT (spacing
);
22664 if (!NILP (total_height
))
22665 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22669 else /* i.e. (it->char_to_display == '\t') */
22671 if (font
->space_width
> 0)
22673 int tab_width
= it
->tab_width
* font
->space_width
;
22674 int x
= it
->current_x
+ it
->continuation_lines_width
;
22675 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22677 /* If the distance from the current position to the next tab
22678 stop is less than a space character width, use the
22679 tab stop after that. */
22680 if (next_tab_x
- x
< font
->space_width
)
22681 next_tab_x
+= tab_width
;
22683 it
->pixel_width
= next_tab_x
- x
;
22685 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22686 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22690 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22691 it
->ascent
+ it
->descent
, it
->ascent
);
22696 it
->pixel_width
= 0;
22701 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22703 /* A static composition.
22705 Note: A composition is represented as one glyph in the
22706 glyph matrix. There are no padding glyphs.
22708 Important note: pixel_width, ascent, and descent are the
22709 values of what is drawn by draw_glyphs (i.e. the values of
22710 the overall glyphs composed). */
22711 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22712 int boff
; /* baseline offset */
22713 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22714 int glyph_len
= cmp
->glyph_len
;
22715 struct font
*font
= face
->font
;
22719 /* If we have not yet calculated pixel size data of glyphs of
22720 the composition for the current face font, calculate them
22721 now. Theoretically, we have to check all fonts for the
22722 glyphs, but that requires much time and memory space. So,
22723 here we check only the font of the first glyph. This may
22724 lead to incorrect display, but it's very rare, and C-l
22725 (recenter-top-bottom) can correct the display anyway. */
22726 if (! cmp
->font
|| cmp
->font
!= font
)
22728 /* Ascent and descent of the font of the first character
22729 of this composition (adjusted by baseline offset).
22730 Ascent and descent of overall glyphs should not be less
22731 than these, respectively. */
22732 int font_ascent
, font_descent
, font_height
;
22733 /* Bounding box of the overall glyphs. */
22734 int leftmost
, rightmost
, lowest
, highest
;
22735 int lbearing
, rbearing
;
22736 int i
, width
, ascent
, descent
;
22737 int left_padded
= 0, right_padded
= 0;
22740 struct font_metrics
*pcm
;
22741 int font_not_found_p
;
22744 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22745 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22747 if (glyph_len
< cmp
->glyph_len
)
22749 for (i
= 0; i
< glyph_len
; i
++)
22751 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22753 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22758 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22759 : IT_CHARPOS (*it
));
22760 /* If no suitable font is found, use the default font. */
22761 font_not_found_p
= font
== NULL
;
22762 if (font_not_found_p
)
22764 face
= face
->ascii_face
;
22767 boff
= font
->baseline_offset
;
22768 if (font
->vertical_centering
)
22769 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22770 font_ascent
= FONT_BASE (font
) + boff
;
22771 font_descent
= FONT_DESCENT (font
) - boff
;
22772 font_height
= FONT_HEIGHT (font
);
22774 cmp
->font
= (void *) font
;
22777 if (! font_not_found_p
)
22779 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22780 &char2b
, it
->multibyte_p
, 0);
22781 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22784 /* Initialize the bounding box. */
22787 width
= pcm
->width
;
22788 ascent
= pcm
->ascent
;
22789 descent
= pcm
->descent
;
22790 lbearing
= pcm
->lbearing
;
22791 rbearing
= pcm
->rbearing
;
22795 width
= font
->space_width
;
22796 ascent
= FONT_BASE (font
);
22797 descent
= FONT_DESCENT (font
);
22804 lowest
= - descent
+ boff
;
22805 highest
= ascent
+ boff
;
22807 if (! font_not_found_p
22808 && font
->default_ascent
22809 && CHAR_TABLE_P (Vuse_default_ascent
)
22810 && !NILP (Faref (Vuse_default_ascent
,
22811 make_number (it
->char_to_display
))))
22812 highest
= font
->default_ascent
+ boff
;
22814 /* Draw the first glyph at the normal position. It may be
22815 shifted to right later if some other glyphs are drawn
22817 cmp
->offsets
[i
* 2] = 0;
22818 cmp
->offsets
[i
* 2 + 1] = boff
;
22819 cmp
->lbearing
= lbearing
;
22820 cmp
->rbearing
= rbearing
;
22822 /* Set cmp->offsets for the remaining glyphs. */
22823 for (i
++; i
< glyph_len
; i
++)
22825 int left
, right
, btm
, top
;
22826 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22828 struct face
*this_face
;
22832 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22833 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22834 font
= this_face
->font
;
22840 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22841 &char2b
, it
->multibyte_p
, 0);
22842 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22845 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22848 width
= pcm
->width
;
22849 ascent
= pcm
->ascent
;
22850 descent
= pcm
->descent
;
22851 lbearing
= pcm
->lbearing
;
22852 rbearing
= pcm
->rbearing
;
22853 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22855 /* Relative composition with or without
22856 alternate chars. */
22857 left
= (leftmost
+ rightmost
- width
) / 2;
22858 btm
= - descent
+ boff
;
22859 if (font
->relative_compose
22860 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22861 || NILP (Faref (Vignore_relative_composition
,
22862 make_number (ch
)))))
22865 if (- descent
>= font
->relative_compose
)
22866 /* One extra pixel between two glyphs. */
22868 else if (ascent
<= 0)
22869 /* One extra pixel between two glyphs. */
22870 btm
= lowest
- 1 - ascent
- descent
;
22875 /* A composition rule is specified by an integer
22876 value that encodes global and new reference
22877 points (GREF and NREF). GREF and NREF are
22878 specified by numbers as below:
22880 0---1---2 -- ascent
22884 9--10--11 -- center
22886 ---3---4---5--- baseline
22888 6---7---8 -- descent
22890 int rule
= COMPOSITION_RULE (cmp
, i
);
22891 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22893 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22894 grefx
= gref
% 3, nrefx
= nref
% 3;
22895 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22897 xoff
= font_height
* (xoff
- 128) / 256;
22899 yoff
= font_height
* (yoff
- 128) / 256;
22902 + grefx
* (rightmost
- leftmost
) / 2
22903 - nrefx
* width
/ 2
22906 btm
= ((grefy
== 0 ? highest
22908 : grefy
== 2 ? lowest
22909 : (highest
+ lowest
) / 2)
22910 - (nrefy
== 0 ? ascent
+ descent
22911 : nrefy
== 1 ? descent
- boff
22913 : (ascent
+ descent
) / 2)
22917 cmp
->offsets
[i
* 2] = left
;
22918 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22920 /* Update the bounding box of the overall glyphs. */
22923 right
= left
+ width
;
22924 if (left
< leftmost
)
22926 if (right
> rightmost
)
22929 top
= btm
+ descent
+ ascent
;
22935 if (cmp
->lbearing
> left
+ lbearing
)
22936 cmp
->lbearing
= left
+ lbearing
;
22937 if (cmp
->rbearing
< left
+ rbearing
)
22938 cmp
->rbearing
= left
+ rbearing
;
22942 /* If there are glyphs whose x-offsets are negative,
22943 shift all glyphs to the right and make all x-offsets
22947 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22948 cmp
->offsets
[i
* 2] -= leftmost
;
22949 rightmost
-= leftmost
;
22950 cmp
->lbearing
-= leftmost
;
22951 cmp
->rbearing
-= leftmost
;
22954 if (left_padded
&& cmp
->lbearing
< 0)
22956 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22957 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22958 rightmost
-= cmp
->lbearing
;
22959 cmp
->rbearing
-= cmp
->lbearing
;
22962 if (right_padded
&& rightmost
< cmp
->rbearing
)
22964 rightmost
= cmp
->rbearing
;
22967 cmp
->pixel_width
= rightmost
;
22968 cmp
->ascent
= highest
;
22969 cmp
->descent
= - lowest
;
22970 if (cmp
->ascent
< font_ascent
)
22971 cmp
->ascent
= font_ascent
;
22972 if (cmp
->descent
< font_descent
)
22973 cmp
->descent
= font_descent
;
22977 && (cmp
->lbearing
< 0
22978 || cmp
->rbearing
> cmp
->pixel_width
))
22979 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22981 it
->pixel_width
= cmp
->pixel_width
;
22982 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22983 it
->descent
= it
->phys_descent
= cmp
->descent
;
22984 if (face
->box
!= FACE_NO_BOX
)
22986 int thick
= face
->box_line_width
;
22990 it
->ascent
+= thick
;
22991 it
->descent
+= thick
;
22996 if (it
->start_of_box_run_p
)
22997 it
->pixel_width
+= thick
;
22998 if (it
->end_of_box_run_p
)
22999 it
->pixel_width
+= thick
;
23002 /* If face has an overline, add the height of the overline
23003 (1 pixel) and a 1 pixel margin to the character height. */
23004 if (face
->overline_p
)
23005 it
->ascent
+= overline_margin
;
23007 take_vertical_position_into_account (it
);
23008 if (it
->ascent
< 0)
23010 if (it
->descent
< 0)
23014 append_composite_glyph (it
);
23016 else if (it
->what
== IT_COMPOSITION
)
23018 /* A dynamic (automatic) composition. */
23019 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23020 Lisp_Object gstring
;
23021 struct font_metrics metrics
;
23023 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23025 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23028 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23029 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23030 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23031 it
->descent
= it
->phys_descent
= metrics
.descent
;
23032 if (face
->box
!= FACE_NO_BOX
)
23034 int thick
= face
->box_line_width
;
23038 it
->ascent
+= thick
;
23039 it
->descent
+= thick
;
23044 if (it
->start_of_box_run_p
)
23045 it
->pixel_width
+= thick
;
23046 if (it
->end_of_box_run_p
)
23047 it
->pixel_width
+= thick
;
23049 /* If face has an overline, add the height of the overline
23050 (1 pixel) and a 1 pixel margin to the character height. */
23051 if (face
->overline_p
)
23052 it
->ascent
+= overline_margin
;
23053 take_vertical_position_into_account (it
);
23054 if (it
->ascent
< 0)
23056 if (it
->descent
< 0)
23060 append_composite_glyph (it
);
23062 else if (it
->what
== IT_GLYPHLESS
)
23063 produce_glyphless_glyph (it
, 0, Qnil
);
23064 else if (it
->what
== IT_IMAGE
)
23065 produce_image_glyph (it
);
23066 else if (it
->what
== IT_STRETCH
)
23067 produce_stretch_glyph (it
);
23070 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23071 because this isn't true for images with `:ascent 100'. */
23072 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23073 if (it
->area
== TEXT_AREA
)
23074 it
->current_x
+= it
->pixel_width
;
23076 if (extra_line_spacing
> 0)
23078 it
->descent
+= extra_line_spacing
;
23079 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23080 it
->max_extra_line_spacing
= extra_line_spacing
;
23083 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23084 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23085 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23086 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23090 Output LEN glyphs starting at START at the nominal cursor position.
23091 Advance the nominal cursor over the text. The global variable
23092 updated_window contains the window being updated, updated_row is
23093 the glyph row being updated, and updated_area is the area of that
23094 row being updated. */
23097 x_write_glyphs (struct glyph
*start
, int len
)
23101 xassert (updated_window
&& updated_row
);
23104 /* Write glyphs. */
23106 hpos
= start
- updated_row
->glyphs
[updated_area
];
23107 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23108 updated_row
, updated_area
,
23110 DRAW_NORMAL_TEXT
, 0);
23112 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23113 if (updated_area
== TEXT_AREA
23114 && updated_window
->phys_cursor_on_p
23115 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23116 && updated_window
->phys_cursor
.hpos
>= hpos
23117 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23118 updated_window
->phys_cursor_on_p
= 0;
23122 /* Advance the output cursor. */
23123 output_cursor
.hpos
+= len
;
23124 output_cursor
.x
= x
;
23129 Insert LEN glyphs from START at the nominal cursor position. */
23132 x_insert_glyphs (struct glyph
*start
, int len
)
23136 int line_height
, shift_by_width
, shifted_region_width
;
23137 struct glyph_row
*row
;
23138 struct glyph
*glyph
;
23139 int frame_x
, frame_y
;
23142 xassert (updated_window
&& updated_row
);
23144 w
= updated_window
;
23145 f
= XFRAME (WINDOW_FRAME (w
));
23147 /* Get the height of the line we are in. */
23149 line_height
= row
->height
;
23151 /* Get the width of the glyphs to insert. */
23152 shift_by_width
= 0;
23153 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23154 shift_by_width
+= glyph
->pixel_width
;
23156 /* Get the width of the region to shift right. */
23157 shifted_region_width
= (window_box_width (w
, updated_area
)
23162 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23163 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23165 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23166 line_height
, shift_by_width
);
23168 /* Write the glyphs. */
23169 hpos
= start
- row
->glyphs
[updated_area
];
23170 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23172 DRAW_NORMAL_TEXT
, 0);
23174 /* Advance the output cursor. */
23175 output_cursor
.hpos
+= len
;
23176 output_cursor
.x
+= shift_by_width
;
23182 Erase the current text line from the nominal cursor position
23183 (inclusive) to pixel column TO_X (exclusive). The idea is that
23184 everything from TO_X onward is already erased.
23186 TO_X is a pixel position relative to updated_area of
23187 updated_window. TO_X == -1 means clear to the end of this area. */
23190 x_clear_end_of_line (int to_x
)
23193 struct window
*w
= updated_window
;
23194 int max_x
, min_y
, max_y
;
23195 int from_x
, from_y
, to_y
;
23197 xassert (updated_window
&& updated_row
);
23198 f
= XFRAME (w
->frame
);
23200 if (updated_row
->full_width_p
)
23201 max_x
= WINDOW_TOTAL_WIDTH (w
);
23203 max_x
= window_box_width (w
, updated_area
);
23204 max_y
= window_text_bottom_y (w
);
23206 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23207 of window. For TO_X > 0, truncate to end of drawing area. */
23213 to_x
= min (to_x
, max_x
);
23215 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23217 /* Notice if the cursor will be cleared by this operation. */
23218 if (!updated_row
->full_width_p
)
23219 notice_overwritten_cursor (w
, updated_area
,
23220 output_cursor
.x
, -1,
23222 MATRIX_ROW_BOTTOM_Y (updated_row
));
23224 from_x
= output_cursor
.x
;
23226 /* Translate to frame coordinates. */
23227 if (updated_row
->full_width_p
)
23229 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23230 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23234 int area_left
= window_box_left (w
, updated_area
);
23235 from_x
+= area_left
;
23239 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23240 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23241 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23243 /* Prevent inadvertently clearing to end of the X window. */
23244 if (to_x
> from_x
&& to_y
> from_y
)
23247 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23248 to_x
- from_x
, to_y
- from_y
);
23253 #endif /* HAVE_WINDOW_SYSTEM */
23257 /***********************************************************************
23259 ***********************************************************************/
23261 /* Value is the internal representation of the specified cursor type
23262 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23263 of the bar cursor. */
23265 static enum text_cursor_kinds
23266 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23268 enum text_cursor_kinds type
;
23273 if (EQ (arg
, Qbox
))
23274 return FILLED_BOX_CURSOR
;
23276 if (EQ (arg
, Qhollow
))
23277 return HOLLOW_BOX_CURSOR
;
23279 if (EQ (arg
, Qbar
))
23286 && EQ (XCAR (arg
), Qbar
)
23287 && INTEGERP (XCDR (arg
))
23288 && XINT (XCDR (arg
)) >= 0)
23290 *width
= XINT (XCDR (arg
));
23294 if (EQ (arg
, Qhbar
))
23297 return HBAR_CURSOR
;
23301 && EQ (XCAR (arg
), Qhbar
)
23302 && INTEGERP (XCDR (arg
))
23303 && XINT (XCDR (arg
)) >= 0)
23305 *width
= XINT (XCDR (arg
));
23306 return HBAR_CURSOR
;
23309 /* Treat anything unknown as "hollow box cursor".
23310 It was bad to signal an error; people have trouble fixing
23311 .Xdefaults with Emacs, when it has something bad in it. */
23312 type
= HOLLOW_BOX_CURSOR
;
23317 /* Set the default cursor types for specified frame. */
23319 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23324 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23325 FRAME_CURSOR_WIDTH (f
) = width
;
23327 /* By default, set up the blink-off state depending on the on-state. */
23329 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23332 FRAME_BLINK_OFF_CURSOR (f
)
23333 = get_specified_cursor_type (XCDR (tem
), &width
);
23334 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23337 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23341 #ifdef HAVE_WINDOW_SYSTEM
23343 /* Return the cursor we want to be displayed in window W. Return
23344 width of bar/hbar cursor through WIDTH arg. Return with
23345 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23346 (i.e. if the `system caret' should track this cursor).
23348 In a mini-buffer window, we want the cursor only to appear if we
23349 are reading input from this window. For the selected window, we
23350 want the cursor type given by the frame parameter or buffer local
23351 setting of cursor-type. If explicitly marked off, draw no cursor.
23352 In all other cases, we want a hollow box cursor. */
23354 static enum text_cursor_kinds
23355 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23356 int *active_cursor
)
23358 struct frame
*f
= XFRAME (w
->frame
);
23359 struct buffer
*b
= XBUFFER (w
->buffer
);
23360 int cursor_type
= DEFAULT_CURSOR
;
23361 Lisp_Object alt_cursor
;
23362 int non_selected
= 0;
23364 *active_cursor
= 1;
23367 if (cursor_in_echo_area
23368 && FRAME_HAS_MINIBUF_P (f
)
23369 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23371 if (w
== XWINDOW (echo_area_window
))
23373 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23375 *width
= FRAME_CURSOR_WIDTH (f
);
23376 return FRAME_DESIRED_CURSOR (f
);
23379 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23382 *active_cursor
= 0;
23386 /* Detect a nonselected window or nonselected frame. */
23387 else if (w
!= XWINDOW (f
->selected_window
)
23388 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23390 *active_cursor
= 0;
23392 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23398 /* Never display a cursor in a window in which cursor-type is nil. */
23399 if (NILP (BVAR (b
, cursor_type
)))
23402 /* Get the normal cursor type for this window. */
23403 if (EQ (BVAR (b
, cursor_type
), Qt
))
23405 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23406 *width
= FRAME_CURSOR_WIDTH (f
);
23409 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23411 /* Use cursor-in-non-selected-windows instead
23412 for non-selected window or frame. */
23415 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23416 if (!EQ (Qt
, alt_cursor
))
23417 return get_specified_cursor_type (alt_cursor
, width
);
23418 /* t means modify the normal cursor type. */
23419 if (cursor_type
== FILLED_BOX_CURSOR
)
23420 cursor_type
= HOLLOW_BOX_CURSOR
;
23421 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23423 return cursor_type
;
23426 /* Use normal cursor if not blinked off. */
23427 if (!w
->cursor_off_p
)
23429 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23431 if (cursor_type
== FILLED_BOX_CURSOR
)
23433 /* Using a block cursor on large images can be very annoying.
23434 So use a hollow cursor for "large" images.
23435 If image is not transparent (no mask), also use hollow cursor. */
23436 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23437 if (img
!= NULL
&& IMAGEP (img
->spec
))
23439 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23440 where N = size of default frame font size.
23441 This should cover most of the "tiny" icons people may use. */
23443 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23444 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23445 cursor_type
= HOLLOW_BOX_CURSOR
;
23448 else if (cursor_type
!= NO_CURSOR
)
23450 /* Display current only supports BOX and HOLLOW cursors for images.
23451 So for now, unconditionally use a HOLLOW cursor when cursor is
23452 not a solid box cursor. */
23453 cursor_type
= HOLLOW_BOX_CURSOR
;
23456 return cursor_type
;
23459 /* Cursor is blinked off, so determine how to "toggle" it. */
23461 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23462 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23463 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23465 /* Then see if frame has specified a specific blink off cursor type. */
23466 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23468 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23469 return FRAME_BLINK_OFF_CURSOR (f
);
23473 /* Some people liked having a permanently visible blinking cursor,
23474 while others had very strong opinions against it. So it was
23475 decided to remove it. KFS 2003-09-03 */
23477 /* Finally perform built-in cursor blinking:
23478 filled box <-> hollow box
23479 wide [h]bar <-> narrow [h]bar
23480 narrow [h]bar <-> no cursor
23481 other type <-> no cursor */
23483 if (cursor_type
== FILLED_BOX_CURSOR
)
23484 return HOLLOW_BOX_CURSOR
;
23486 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23489 return cursor_type
;
23497 /* Notice when the text cursor of window W has been completely
23498 overwritten by a drawing operation that outputs glyphs in AREA
23499 starting at X0 and ending at X1 in the line starting at Y0 and
23500 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23501 the rest of the line after X0 has been written. Y coordinates
23502 are window-relative. */
23505 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23506 int x0
, int x1
, int y0
, int y1
)
23508 int cx0
, cx1
, cy0
, cy1
;
23509 struct glyph_row
*row
;
23511 if (!w
->phys_cursor_on_p
)
23513 if (area
!= TEXT_AREA
)
23516 if (w
->phys_cursor
.vpos
< 0
23517 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23518 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23519 !(row
->enabled_p
&& row
->displays_text_p
)))
23522 if (row
->cursor_in_fringe_p
)
23524 row
->cursor_in_fringe_p
= 0;
23525 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23526 w
->phys_cursor_on_p
= 0;
23530 cx0
= w
->phys_cursor
.x
;
23531 cx1
= cx0
+ w
->phys_cursor_width
;
23532 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23535 /* The cursor image will be completely removed from the
23536 screen if the output area intersects the cursor area in
23537 y-direction. When we draw in [y0 y1[, and some part of
23538 the cursor is at y < y0, that part must have been drawn
23539 before. When scrolling, the cursor is erased before
23540 actually scrolling, so we don't come here. When not
23541 scrolling, the rows above the old cursor row must have
23542 changed, and in this case these rows must have written
23543 over the cursor image.
23545 Likewise if part of the cursor is below y1, with the
23546 exception of the cursor being in the first blank row at
23547 the buffer and window end because update_text_area
23548 doesn't draw that row. (Except when it does, but
23549 that's handled in update_text_area.) */
23551 cy0
= w
->phys_cursor
.y
;
23552 cy1
= cy0
+ w
->phys_cursor_height
;
23553 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23556 w
->phys_cursor_on_p
= 0;
23559 #endif /* HAVE_WINDOW_SYSTEM */
23562 /************************************************************************
23564 ************************************************************************/
23566 #ifdef HAVE_WINDOW_SYSTEM
23569 Fix the display of area AREA of overlapping row ROW in window W
23570 with respect to the overlapping part OVERLAPS. */
23573 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23574 enum glyph_row_area area
, int overlaps
)
23581 for (i
= 0; i
< row
->used
[area
];)
23583 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23585 int start
= i
, start_x
= x
;
23589 x
+= row
->glyphs
[area
][i
].pixel_width
;
23592 while (i
< row
->used
[area
]
23593 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23595 draw_glyphs (w
, start_x
, row
, area
,
23597 DRAW_NORMAL_TEXT
, overlaps
);
23601 x
+= row
->glyphs
[area
][i
].pixel_width
;
23611 Draw the cursor glyph of window W in glyph row ROW. See the
23612 comment of draw_glyphs for the meaning of HL. */
23615 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23616 enum draw_glyphs_face hl
)
23618 /* If cursor hpos is out of bounds, don't draw garbage. This can
23619 happen in mini-buffer windows when switching between echo area
23620 glyphs and mini-buffer. */
23621 if ((row
->reversed_p
23622 ? (w
->phys_cursor
.hpos
>= 0)
23623 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23625 int on_p
= w
->phys_cursor_on_p
;
23627 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23628 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23630 w
->phys_cursor_on_p
= on_p
;
23632 if (hl
== DRAW_CURSOR
)
23633 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23634 /* When we erase the cursor, and ROW is overlapped by other
23635 rows, make sure that these overlapping parts of other rows
23637 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23639 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23641 if (row
> w
->current_matrix
->rows
23642 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23643 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23644 OVERLAPS_ERASED_CURSOR
);
23646 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23647 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23648 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23649 OVERLAPS_ERASED_CURSOR
);
23656 Erase the image of a cursor of window W from the screen. */
23659 erase_phys_cursor (struct window
*w
)
23661 struct frame
*f
= XFRAME (w
->frame
);
23662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23663 int hpos
= w
->phys_cursor
.hpos
;
23664 int vpos
= w
->phys_cursor
.vpos
;
23665 int mouse_face_here_p
= 0;
23666 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23667 struct glyph_row
*cursor_row
;
23668 struct glyph
*cursor_glyph
;
23669 enum draw_glyphs_face hl
;
23671 /* No cursor displayed or row invalidated => nothing to do on the
23673 if (w
->phys_cursor_type
== NO_CURSOR
)
23674 goto mark_cursor_off
;
23676 /* VPOS >= active_glyphs->nrows means that window has been resized.
23677 Don't bother to erase the cursor. */
23678 if (vpos
>= active_glyphs
->nrows
)
23679 goto mark_cursor_off
;
23681 /* If row containing cursor is marked invalid, there is nothing we
23683 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23684 if (!cursor_row
->enabled_p
)
23685 goto mark_cursor_off
;
23687 /* If line spacing is > 0, old cursor may only be partially visible in
23688 window after split-window. So adjust visible height. */
23689 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23690 window_text_bottom_y (w
) - cursor_row
->y
);
23692 /* If row is completely invisible, don't attempt to delete a cursor which
23693 isn't there. This can happen if cursor is at top of a window, and
23694 we switch to a buffer with a header line in that window. */
23695 if (cursor_row
->visible_height
<= 0)
23696 goto mark_cursor_off
;
23698 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23699 if (cursor_row
->cursor_in_fringe_p
)
23701 cursor_row
->cursor_in_fringe_p
= 0;
23702 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23703 goto mark_cursor_off
;
23706 /* This can happen when the new row is shorter than the old one.
23707 In this case, either draw_glyphs or clear_end_of_line
23708 should have cleared the cursor. Note that we wouldn't be
23709 able to erase the cursor in this case because we don't have a
23710 cursor glyph at hand. */
23711 if ((cursor_row
->reversed_p
23712 ? (w
->phys_cursor
.hpos
< 0)
23713 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23714 goto mark_cursor_off
;
23716 /* If the cursor is in the mouse face area, redisplay that when
23717 we clear the cursor. */
23718 if (! NILP (hlinfo
->mouse_face_window
)
23719 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23720 /* Don't redraw the cursor's spot in mouse face if it is at the
23721 end of a line (on a newline). The cursor appears there, but
23722 mouse highlighting does not. */
23723 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23724 mouse_face_here_p
= 1;
23726 /* Maybe clear the display under the cursor. */
23727 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23730 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23733 cursor_glyph
= get_phys_cursor_glyph (w
);
23734 if (cursor_glyph
== NULL
)
23735 goto mark_cursor_off
;
23737 width
= cursor_glyph
->pixel_width
;
23738 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23739 x
= w
->phys_cursor
.x
;
23741 width
-= left_x
- x
;
23742 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23743 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23744 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23747 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23750 /* Erase the cursor by redrawing the character underneath it. */
23751 if (mouse_face_here_p
)
23752 hl
= DRAW_MOUSE_FACE
;
23754 hl
= DRAW_NORMAL_TEXT
;
23755 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23758 w
->phys_cursor_on_p
= 0;
23759 w
->phys_cursor_type
= NO_CURSOR
;
23764 Display or clear cursor of window W. If ON is zero, clear the
23765 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23766 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23769 display_and_set_cursor (struct window
*w
, int on
,
23770 int hpos
, int vpos
, int x
, int y
)
23772 struct frame
*f
= XFRAME (w
->frame
);
23773 int new_cursor_type
;
23774 int new_cursor_width
;
23776 struct glyph_row
*glyph_row
;
23777 struct glyph
*glyph
;
23779 /* This is pointless on invisible frames, and dangerous on garbaged
23780 windows and frames; in the latter case, the frame or window may
23781 be in the midst of changing its size, and x and y may be off the
23783 if (! FRAME_VISIBLE_P (f
)
23784 || FRAME_GARBAGED_P (f
)
23785 || vpos
>= w
->current_matrix
->nrows
23786 || hpos
>= w
->current_matrix
->matrix_w
)
23789 /* If cursor is off and we want it off, return quickly. */
23790 if (!on
&& !w
->phys_cursor_on_p
)
23793 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23794 /* If cursor row is not enabled, we don't really know where to
23795 display the cursor. */
23796 if (!glyph_row
->enabled_p
)
23798 w
->phys_cursor_on_p
= 0;
23803 if (!glyph_row
->exact_window_width_line_p
23804 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23805 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23807 xassert (interrupt_input_blocked
);
23809 /* Set new_cursor_type to the cursor we want to be displayed. */
23810 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23811 &new_cursor_width
, &active_cursor
);
23813 /* If cursor is currently being shown and we don't want it to be or
23814 it is in the wrong place, or the cursor type is not what we want,
23816 if (w
->phys_cursor_on_p
23818 || w
->phys_cursor
.x
!= x
23819 || w
->phys_cursor
.y
!= y
23820 || new_cursor_type
!= w
->phys_cursor_type
23821 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23822 && new_cursor_width
!= w
->phys_cursor_width
)))
23823 erase_phys_cursor (w
);
23825 /* Don't check phys_cursor_on_p here because that flag is only set
23826 to zero in some cases where we know that the cursor has been
23827 completely erased, to avoid the extra work of erasing the cursor
23828 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23829 still not be visible, or it has only been partly erased. */
23832 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23833 w
->phys_cursor_height
= glyph_row
->height
;
23835 /* Set phys_cursor_.* before x_draw_.* is called because some
23836 of them may need the information. */
23837 w
->phys_cursor
.x
= x
;
23838 w
->phys_cursor
.y
= glyph_row
->y
;
23839 w
->phys_cursor
.hpos
= hpos
;
23840 w
->phys_cursor
.vpos
= vpos
;
23843 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23844 new_cursor_type
, new_cursor_width
,
23845 on
, active_cursor
);
23849 /* Switch the display of W's cursor on or off, according to the value
23853 update_window_cursor (struct window
*w
, int on
)
23855 /* Don't update cursor in windows whose frame is in the process
23856 of being deleted. */
23857 if (w
->current_matrix
)
23860 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23861 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23867 /* Call update_window_cursor with parameter ON_P on all leaf windows
23868 in the window tree rooted at W. */
23871 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23875 if (!NILP (w
->hchild
))
23876 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23877 else if (!NILP (w
->vchild
))
23878 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23880 update_window_cursor (w
, on_p
);
23882 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23888 Display the cursor on window W, or clear it, according to ON_P.
23889 Don't change the cursor's position. */
23892 x_update_cursor (struct frame
*f
, int on_p
)
23894 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23899 Clear the cursor of window W to background color, and mark the
23900 cursor as not shown. This is used when the text where the cursor
23901 is about to be rewritten. */
23904 x_clear_cursor (struct window
*w
)
23906 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23907 update_window_cursor (w
, 0);
23910 #endif /* HAVE_WINDOW_SYSTEM */
23912 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23915 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23916 int start_hpos
, int end_hpos
,
23917 enum draw_glyphs_face draw
)
23919 #ifdef HAVE_WINDOW_SYSTEM
23920 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23922 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23926 #if defined (HAVE_GPM) || defined (MSDOS)
23927 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23932 Display the active region described by mouse_face_* according to DRAW. */
23935 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23937 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23938 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23940 if (/* If window is in the process of being destroyed, don't bother
23942 w
->current_matrix
!= NULL
23943 /* Don't update mouse highlight if hidden */
23944 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23945 /* Recognize when we are called to operate on rows that don't exist
23946 anymore. This can happen when a window is split. */
23947 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23949 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23950 struct glyph_row
*row
, *first
, *last
;
23952 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23953 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23955 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23957 int start_hpos
, end_hpos
, start_x
;
23959 /* For all but the first row, the highlight starts at column 0. */
23962 /* R2L rows have BEG and END in reversed order, but the
23963 screen drawing geometry is always left to right. So
23964 we need to mirror the beginning and end of the
23965 highlighted area in R2L rows. */
23966 if (!row
->reversed_p
)
23968 start_hpos
= hlinfo
->mouse_face_beg_col
;
23969 start_x
= hlinfo
->mouse_face_beg_x
;
23971 else if (row
== last
)
23973 start_hpos
= hlinfo
->mouse_face_end_col
;
23974 start_x
= hlinfo
->mouse_face_end_x
;
23982 else if (row
->reversed_p
&& row
== last
)
23984 start_hpos
= hlinfo
->mouse_face_end_col
;
23985 start_x
= hlinfo
->mouse_face_end_x
;
23995 if (!row
->reversed_p
)
23996 end_hpos
= hlinfo
->mouse_face_end_col
;
23997 else if (row
== first
)
23998 end_hpos
= hlinfo
->mouse_face_beg_col
;
24001 end_hpos
= row
->used
[TEXT_AREA
];
24002 if (draw
== DRAW_NORMAL_TEXT
)
24003 row
->fill_line_p
= 1; /* Clear to end of line */
24006 else if (row
->reversed_p
&& row
== first
)
24007 end_hpos
= hlinfo
->mouse_face_beg_col
;
24010 end_hpos
= row
->used
[TEXT_AREA
];
24011 if (draw
== DRAW_NORMAL_TEXT
)
24012 row
->fill_line_p
= 1; /* Clear to end of line */
24015 if (end_hpos
> start_hpos
)
24017 draw_row_with_mouse_face (w
, start_x
, row
,
24018 start_hpos
, end_hpos
, draw
);
24021 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24025 #ifdef HAVE_WINDOW_SYSTEM
24026 /* When we've written over the cursor, arrange for it to
24027 be displayed again. */
24028 if (FRAME_WINDOW_P (f
)
24029 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24032 display_and_set_cursor (w
, 1,
24033 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24034 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24037 #endif /* HAVE_WINDOW_SYSTEM */
24040 #ifdef HAVE_WINDOW_SYSTEM
24041 /* Change the mouse cursor. */
24042 if (FRAME_WINDOW_P (f
))
24044 if (draw
== DRAW_NORMAL_TEXT
24045 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24046 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24047 else if (draw
== DRAW_MOUSE_FACE
)
24048 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24050 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24052 #endif /* HAVE_WINDOW_SYSTEM */
24056 Clear out the mouse-highlighted active region.
24057 Redraw it un-highlighted first. Value is non-zero if mouse
24058 face was actually drawn unhighlighted. */
24061 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24065 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24067 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24071 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24072 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24073 hlinfo
->mouse_face_window
= Qnil
;
24074 hlinfo
->mouse_face_overlay
= Qnil
;
24078 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24079 within the mouse face on that window. */
24081 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24083 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24085 /* Quickly resolve the easy cases. */
24086 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24087 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24089 if (vpos
< hlinfo
->mouse_face_beg_row
24090 || vpos
> hlinfo
->mouse_face_end_row
)
24092 if (vpos
> hlinfo
->mouse_face_beg_row
24093 && vpos
< hlinfo
->mouse_face_end_row
)
24096 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24098 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24100 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24103 else if ((vpos
== hlinfo
->mouse_face_beg_row
24104 && hpos
>= hlinfo
->mouse_face_beg_col
)
24105 || (vpos
== hlinfo
->mouse_face_end_row
24106 && hpos
< hlinfo
->mouse_face_end_col
))
24111 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24113 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24116 else if ((vpos
== hlinfo
->mouse_face_beg_row
24117 && hpos
<= hlinfo
->mouse_face_beg_col
)
24118 || (vpos
== hlinfo
->mouse_face_end_row
24119 && hpos
> hlinfo
->mouse_face_end_col
))
24127 Non-zero if physical cursor of window W is within mouse face. */
24130 cursor_in_mouse_face_p (struct window
*w
)
24132 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24137 /* Find the glyph rows START_ROW and END_ROW of window W that display
24138 characters between buffer positions START_CHARPOS and END_CHARPOS
24139 (excluding END_CHARPOS). This is similar to row_containing_pos,
24140 but is more accurate when bidi reordering makes buffer positions
24141 change non-linearly with glyph rows. */
24143 rows_from_pos_range (struct window
*w
,
24144 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24145 struct glyph_row
**start
, struct glyph_row
**end
)
24147 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24148 int last_y
= window_text_bottom_y (w
);
24149 struct glyph_row
*row
;
24154 while (!first
->enabled_p
24155 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24158 /* Find the START row. */
24160 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24163 /* A row can potentially be the START row if the range of the
24164 characters it displays intersects the range
24165 [START_CHARPOS..END_CHARPOS). */
24166 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24167 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24168 /* See the commentary in row_containing_pos, for the
24169 explanation of the complicated way to check whether
24170 some position is beyond the end of the characters
24171 displayed by a row. */
24172 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24173 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24174 && !row
->ends_at_zv_p
24175 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24176 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24177 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24178 && !row
->ends_at_zv_p
24179 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24181 /* Found a candidate row. Now make sure at least one of the
24182 glyphs it displays has a charpos from the range
24183 [START_CHARPOS..END_CHARPOS).
24185 This is not obvious because bidi reordering could make
24186 buffer positions of a row be 1,2,3,102,101,100, and if we
24187 want to highlight characters in [50..60), we don't want
24188 this row, even though [50..60) does intersect [1..103),
24189 the range of character positions given by the row's start
24190 and end positions. */
24191 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24192 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24196 if (BUFFERP (g
->object
)
24197 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24206 /* Find the END row. */
24208 /* If the last row is partially visible, start looking for END
24209 from that row, instead of starting from FIRST. */
24210 && !(row
->enabled_p
24211 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24213 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24215 struct glyph_row
*next
= row
+ 1;
24217 if (!next
->enabled_p
24218 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24219 /* The first row >= START whose range of displayed characters
24220 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24221 is the row END + 1. */
24222 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24223 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24224 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24225 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24226 && !next
->ends_at_zv_p
24227 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24228 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24229 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24230 && !next
->ends_at_zv_p
24231 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24238 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24239 but none of the characters it displays are in the range, it is
24241 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24242 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24246 if (BUFFERP (g
->object
)
24247 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24260 /* This function sets the mouse_face_* elements of HLINFO, assuming
24261 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24262 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24263 for the overlay or run of text properties specifying the mouse
24264 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24265 before-string and after-string that must also be highlighted.
24266 COVER_STRING, if non-nil, is a display string that may cover some
24267 or all of the highlighted text. */
24270 mouse_face_from_buffer_pos (Lisp_Object window
,
24271 Mouse_HLInfo
*hlinfo
,
24272 EMACS_INT mouse_charpos
,
24273 EMACS_INT start_charpos
,
24274 EMACS_INT end_charpos
,
24275 Lisp_Object before_string
,
24276 Lisp_Object after_string
,
24277 Lisp_Object cover_string
)
24279 struct window
*w
= XWINDOW (window
);
24280 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24281 struct glyph_row
*r1
, *r2
;
24282 struct glyph
*glyph
, *end
;
24283 EMACS_INT ignore
, pos
;
24286 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24287 xassert (NILP (before_string
) || STRINGP (before_string
));
24288 xassert (NILP (after_string
) || STRINGP (after_string
));
24290 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24291 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24293 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24294 /* If the before-string or display-string contains newlines,
24295 rows_from_pos_range skips to its last row. Move back. */
24296 if (!NILP (before_string
) || !NILP (cover_string
))
24298 struct glyph_row
*prev
;
24299 while ((prev
= r1
- 1, prev
>= first
)
24300 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24301 && prev
->used
[TEXT_AREA
] > 0)
24303 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24304 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24305 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24307 || !(EQ (glyph
->object
, before_string
)
24308 || EQ (glyph
->object
, cover_string
)))
24315 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24316 hlinfo
->mouse_face_past_end
= 1;
24318 else if (!NILP (after_string
))
24320 /* If the after-string has newlines, advance to its last row. */
24321 struct glyph_row
*next
;
24322 struct glyph_row
*last
24323 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24325 for (next
= r2
+ 1;
24327 && next
->used
[TEXT_AREA
] > 0
24328 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24332 /* The rest of the display engine assumes that mouse_face_beg_row is
24333 either above below mouse_face_end_row or identical to it. But
24334 with bidi-reordered continued lines, the row for START_CHARPOS
24335 could be below the row for END_CHARPOS. If so, swap the rows and
24336 store them in correct order. */
24339 struct glyph_row
*tem
= r2
;
24345 hlinfo
->mouse_face_beg_y
= r1
->y
;
24346 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24347 hlinfo
->mouse_face_end_y
= r2
->y
;
24348 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24350 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24351 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24352 could be anywhere in the row and in any order. The strategy
24353 below is to find the leftmost and the rightmost glyph that
24354 belongs to either of these 3 strings, or whose position is
24355 between START_CHARPOS and END_CHARPOS, and highlight all the
24356 glyphs between those two. This may cover more than just the text
24357 between START_CHARPOS and END_CHARPOS if the range of characters
24358 strides the bidi level boundary, e.g. if the beginning is in R2L
24359 text while the end is in L2R text or vice versa. */
24360 if (!r1
->reversed_p
)
24362 /* This row is in a left to right paragraph. Scan it left to
24364 glyph
= r1
->glyphs
[TEXT_AREA
];
24365 end
= glyph
+ r1
->used
[TEXT_AREA
];
24368 /* Skip truncation glyphs at the start of the glyph row. */
24369 if (r1
->displays_text_p
)
24371 && INTEGERP (glyph
->object
)
24372 && glyph
->charpos
< 0;
24374 x
+= glyph
->pixel_width
;
24376 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24377 or COVER_STRING, and the first glyph from buffer whose
24378 position is between START_CHARPOS and END_CHARPOS. */
24380 && !INTEGERP (glyph
->object
)
24381 && !EQ (glyph
->object
, cover_string
)
24382 && !(BUFFERP (glyph
->object
)
24383 && (glyph
->charpos
>= start_charpos
24384 && glyph
->charpos
< end_charpos
));
24387 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24388 are present at buffer positions between START_CHARPOS and
24389 END_CHARPOS, or if they come from an overlay. */
24390 if (EQ (glyph
->object
, before_string
))
24392 pos
= string_buffer_position (before_string
,
24394 /* If pos == 0, it means before_string came from an
24395 overlay, not from a buffer position. */
24396 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24399 else if (EQ (glyph
->object
, after_string
))
24401 pos
= string_buffer_position (after_string
, end_charpos
);
24402 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24405 x
+= glyph
->pixel_width
;
24407 hlinfo
->mouse_face_beg_x
= x
;
24408 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24412 /* This row is in a right to left paragraph. Scan it right to
24416 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24417 glyph
= end
+ r1
->used
[TEXT_AREA
];
24419 /* Skip truncation glyphs at the start of the glyph row. */
24420 if (r1
->displays_text_p
)
24422 && INTEGERP (glyph
->object
)
24423 && glyph
->charpos
< 0;
24427 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24428 or COVER_STRING, and the first glyph from buffer whose
24429 position is between START_CHARPOS and END_CHARPOS. */
24431 && !INTEGERP (glyph
->object
)
24432 && !EQ (glyph
->object
, cover_string
)
24433 && !(BUFFERP (glyph
->object
)
24434 && (glyph
->charpos
>= start_charpos
24435 && glyph
->charpos
< end_charpos
));
24438 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24439 are present at buffer positions between START_CHARPOS and
24440 END_CHARPOS, or if they come from an overlay. */
24441 if (EQ (glyph
->object
, before_string
))
24443 pos
= string_buffer_position (before_string
, start_charpos
);
24444 /* If pos == 0, it means before_string came from an
24445 overlay, not from a buffer position. */
24446 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24449 else if (EQ (glyph
->object
, after_string
))
24451 pos
= string_buffer_position (after_string
, end_charpos
);
24452 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24457 glyph
++; /* first glyph to the right of the highlighted area */
24458 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24459 x
+= g
->pixel_width
;
24460 hlinfo
->mouse_face_beg_x
= x
;
24461 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24464 /* If the highlight ends in a different row, compute GLYPH and END
24465 for the end row. Otherwise, reuse the values computed above for
24466 the row where the highlight begins. */
24469 if (!r2
->reversed_p
)
24471 glyph
= r2
->glyphs
[TEXT_AREA
];
24472 end
= glyph
+ r2
->used
[TEXT_AREA
];
24477 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24478 glyph
= end
+ r2
->used
[TEXT_AREA
];
24482 if (!r2
->reversed_p
)
24484 /* Skip truncation and continuation glyphs near the end of the
24485 row, and also blanks and stretch glyphs inserted by
24486 extend_face_to_end_of_line. */
24488 && INTEGERP ((end
- 1)->object
)
24489 && (end
- 1)->charpos
<= 0)
24491 /* Scan the rest of the glyph row from the end, looking for the
24492 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24493 COVER_STRING, or whose position is between START_CHARPOS
24497 && !INTEGERP (end
->object
)
24498 && !EQ (end
->object
, cover_string
)
24499 && !(BUFFERP (end
->object
)
24500 && (end
->charpos
>= start_charpos
24501 && end
->charpos
< end_charpos
));
24504 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24505 are present at buffer positions between START_CHARPOS and
24506 END_CHARPOS, or if they come from an overlay. */
24507 if (EQ (end
->object
, before_string
))
24509 pos
= string_buffer_position (before_string
, start_charpos
);
24510 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24513 else if (EQ (end
->object
, after_string
))
24515 pos
= string_buffer_position (after_string
, end_charpos
);
24516 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24520 /* Find the X coordinate of the last glyph to be highlighted. */
24521 for (; glyph
<= end
; ++glyph
)
24522 x
+= glyph
->pixel_width
;
24524 hlinfo
->mouse_face_end_x
= x
;
24525 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24529 /* Skip truncation and continuation glyphs near the end of the
24530 row, and also blanks and stretch glyphs inserted by
24531 extend_face_to_end_of_line. */
24535 && INTEGERP (end
->object
)
24536 && end
->charpos
<= 0)
24538 x
+= end
->pixel_width
;
24541 /* Scan the rest of the glyph row from the end, looking for the
24542 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24543 COVER_STRING, or whose position is between START_CHARPOS
24547 && !INTEGERP (end
->object
)
24548 && !EQ (end
->object
, cover_string
)
24549 && !(BUFFERP (end
->object
)
24550 && (end
->charpos
>= start_charpos
24551 && end
->charpos
< end_charpos
));
24554 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24555 are present at buffer positions between START_CHARPOS and
24556 END_CHARPOS, or if they come from an overlay. */
24557 if (EQ (end
->object
, before_string
))
24559 pos
= string_buffer_position (before_string
, start_charpos
);
24560 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24563 else if (EQ (end
->object
, after_string
))
24565 pos
= string_buffer_position (after_string
, end_charpos
);
24566 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24569 x
+= end
->pixel_width
;
24571 hlinfo
->mouse_face_end_x
= x
;
24572 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24575 hlinfo
->mouse_face_window
= window
;
24576 hlinfo
->mouse_face_face_id
24577 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24579 !hlinfo
->mouse_face_hidden
, -1);
24580 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24583 /* The following function is not used anymore (replaced with
24584 mouse_face_from_string_pos), but I leave it here for the time
24585 being, in case someone would. */
24587 #if 0 /* not used */
24589 /* Find the position of the glyph for position POS in OBJECT in
24590 window W's current matrix, and return in *X, *Y the pixel
24591 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24593 RIGHT_P non-zero means return the position of the right edge of the
24594 glyph, RIGHT_P zero means return the left edge position.
24596 If no glyph for POS exists in the matrix, return the position of
24597 the glyph with the next smaller position that is in the matrix, if
24598 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24599 exists in the matrix, return the position of the glyph with the
24600 next larger position in OBJECT.
24602 Value is non-zero if a glyph was found. */
24605 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24606 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24608 int yb
= window_text_bottom_y (w
);
24609 struct glyph_row
*r
;
24610 struct glyph
*best_glyph
= NULL
;
24611 struct glyph_row
*best_row
= NULL
;
24614 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24615 r
->enabled_p
&& r
->y
< yb
;
24618 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24619 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24622 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24623 if (EQ (g
->object
, object
))
24625 if (g
->charpos
== pos
)
24632 else if (best_glyph
== NULL
24633 || ((eabs (g
->charpos
- pos
)
24634 < eabs (best_glyph
->charpos
- pos
))
24637 : g
->charpos
> pos
)))
24651 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24655 *x
+= best_glyph
->pixel_width
;
24660 *vpos
= best_row
- w
->current_matrix
->rows
;
24663 return best_glyph
!= NULL
;
24665 #endif /* not used */
24667 /* Find the positions of the first and the last glyphs in window W's
24668 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24669 (assumed to be a string), and return in HLINFO's mouse_face_*
24670 members the pixel and column/row coordinates of those glyphs. */
24673 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24674 Lisp_Object object
,
24675 EMACS_INT startpos
, EMACS_INT endpos
)
24677 int yb
= window_text_bottom_y (w
);
24678 struct glyph_row
*r
;
24679 struct glyph
*g
, *e
;
24683 /* Find the glyph row with at least one position in the range
24684 [STARTPOS..ENDPOS], and the first glyph in that row whose
24685 position belongs to that range. */
24686 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24687 r
->enabled_p
&& r
->y
< yb
;
24690 if (!r
->reversed_p
)
24692 g
= r
->glyphs
[TEXT_AREA
];
24693 e
= g
+ r
->used
[TEXT_AREA
];
24694 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24695 if (EQ (g
->object
, object
)
24696 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24698 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24699 hlinfo
->mouse_face_beg_y
= r
->y
;
24700 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24701 hlinfo
->mouse_face_beg_x
= gx
;
24710 e
= r
->glyphs
[TEXT_AREA
];
24711 g
= e
+ r
->used
[TEXT_AREA
];
24712 for ( ; g
> e
; --g
)
24713 if (EQ ((g
-1)->object
, object
)
24714 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24716 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24717 hlinfo
->mouse_face_beg_y
= r
->y
;
24718 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24719 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24720 gx
+= g1
->pixel_width
;
24721 hlinfo
->mouse_face_beg_x
= gx
;
24733 /* Starting with the next row, look for the first row which does NOT
24734 include any glyphs whose positions are in the range. */
24735 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24737 g
= r
->glyphs
[TEXT_AREA
];
24738 e
= g
+ r
->used
[TEXT_AREA
];
24740 for ( ; g
< e
; ++g
)
24741 if (EQ (g
->object
, object
)
24742 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24751 /* The highlighted region ends on the previous row. */
24754 /* Set the end row and its vertical pixel coordinate. */
24755 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24756 hlinfo
->mouse_face_end_y
= r
->y
;
24758 /* Compute and set the end column and the end column's horizontal
24759 pixel coordinate. */
24760 if (!r
->reversed_p
)
24762 g
= r
->glyphs
[TEXT_AREA
];
24763 e
= g
+ r
->used
[TEXT_AREA
];
24764 for ( ; e
> g
; --e
)
24765 if (EQ ((e
-1)->object
, object
)
24766 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24768 hlinfo
->mouse_face_end_col
= e
- g
;
24770 for (gx
= r
->x
; g
< e
; ++g
)
24771 gx
+= g
->pixel_width
;
24772 hlinfo
->mouse_face_end_x
= gx
;
24776 e
= r
->glyphs
[TEXT_AREA
];
24777 g
= e
+ r
->used
[TEXT_AREA
];
24778 for (gx
= r
->x
; e
< g
; ++e
)
24780 if (EQ (e
->object
, object
)
24781 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24783 gx
+= e
->pixel_width
;
24785 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24786 hlinfo
->mouse_face_end_x
= gx
;
24790 #ifdef HAVE_WINDOW_SYSTEM
24792 /* See if position X, Y is within a hot-spot of an image. */
24795 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24797 if (!CONSP (hot_spot
))
24800 if (EQ (XCAR (hot_spot
), Qrect
))
24802 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24803 Lisp_Object rect
= XCDR (hot_spot
);
24807 if (!CONSP (XCAR (rect
)))
24809 if (!CONSP (XCDR (rect
)))
24811 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24813 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24815 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24817 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24821 else if (EQ (XCAR (hot_spot
), Qcircle
))
24823 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24824 Lisp_Object circ
= XCDR (hot_spot
);
24825 Lisp_Object lr
, lx0
, ly0
;
24827 && CONSP (XCAR (circ
))
24828 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24829 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24830 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24832 double r
= XFLOATINT (lr
);
24833 double dx
= XINT (lx0
) - x
;
24834 double dy
= XINT (ly0
) - y
;
24835 return (dx
* dx
+ dy
* dy
<= r
* r
);
24838 else if (EQ (XCAR (hot_spot
), Qpoly
))
24840 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24841 if (VECTORP (XCDR (hot_spot
)))
24843 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24844 Lisp_Object
*poly
= v
->contents
;
24848 Lisp_Object lx
, ly
;
24851 /* Need an even number of coordinates, and at least 3 edges. */
24852 if (n
< 6 || n
& 1)
24855 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24856 If count is odd, we are inside polygon. Pixels on edges
24857 may or may not be included depending on actual geometry of the
24859 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24860 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24862 x0
= XINT (lx
), y0
= XINT (ly
);
24863 for (i
= 0; i
< n
; i
+= 2)
24865 int x1
= x0
, y1
= y0
;
24866 if ((lx
= poly
[i
], !INTEGERP (lx
))
24867 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24869 x0
= XINT (lx
), y0
= XINT (ly
);
24871 /* Does this segment cross the X line? */
24879 if (y
> y0
&& y
> y1
)
24881 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24891 find_hot_spot (Lisp_Object map
, int x
, int y
)
24893 while (CONSP (map
))
24895 if (CONSP (XCAR (map
))
24896 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24904 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24906 doc
: /* Lookup in image map MAP coordinates X and Y.
24907 An image map is an alist where each element has the format (AREA ID PLIST).
24908 An AREA is specified as either a rectangle, a circle, or a polygon:
24909 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24910 pixel coordinates of the upper left and bottom right corners.
24911 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24912 and the radius of the circle; r may be a float or integer.
24913 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24914 vector describes one corner in the polygon.
24915 Returns the alist element for the first matching AREA in MAP. */)
24916 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24924 return find_hot_spot (map
, XINT (x
), XINT (y
));
24928 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24930 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24932 /* Do not change cursor shape while dragging mouse. */
24933 if (!NILP (do_mouse_tracking
))
24936 if (!NILP (pointer
))
24938 if (EQ (pointer
, Qarrow
))
24939 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24940 else if (EQ (pointer
, Qhand
))
24941 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24942 else if (EQ (pointer
, Qtext
))
24943 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24944 else if (EQ (pointer
, intern ("hdrag")))
24945 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24946 #ifdef HAVE_X_WINDOWS
24947 else if (EQ (pointer
, intern ("vdrag")))
24948 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24950 else if (EQ (pointer
, intern ("hourglass")))
24951 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24952 else if (EQ (pointer
, Qmodeline
))
24953 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24955 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24958 if (cursor
!= No_Cursor
)
24959 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24962 #endif /* HAVE_WINDOW_SYSTEM */
24964 /* Take proper action when mouse has moved to the mode or header line
24965 or marginal area AREA of window W, x-position X and y-position Y.
24966 X is relative to the start of the text display area of W, so the
24967 width of bitmap areas and scroll bars must be subtracted to get a
24968 position relative to the start of the mode line. */
24971 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24972 enum window_part area
)
24974 struct window
*w
= XWINDOW (window
);
24975 struct frame
*f
= XFRAME (w
->frame
);
24976 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24977 #ifdef HAVE_WINDOW_SYSTEM
24978 Display_Info
*dpyinfo
;
24980 Cursor cursor
= No_Cursor
;
24981 Lisp_Object pointer
= Qnil
;
24982 int dx
, dy
, width
, height
;
24984 Lisp_Object string
, object
= Qnil
;
24985 Lisp_Object pos
, help
;
24987 Lisp_Object mouse_face
;
24988 int original_x_pixel
= x
;
24989 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24990 struct glyph_row
*row
;
24992 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24997 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24998 returns them in row/column units! */
24999 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25000 &object
, &dx
, &dy
, &width
, &height
);
25002 row
= (area
== ON_MODE_LINE
25003 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25004 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25006 /* Find the glyph under the mouse pointer. */
25007 if (row
->mode_line_p
&& row
->enabled_p
)
25009 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25010 end
= glyph
+ row
->used
[TEXT_AREA
];
25012 for (x0
= original_x_pixel
;
25013 glyph
< end
&& x0
>= glyph
->pixel_width
;
25015 x0
-= glyph
->pixel_width
;
25023 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25024 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25025 returns them in row/column units! */
25026 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25027 &object
, &dx
, &dy
, &width
, &height
);
25032 #ifdef HAVE_WINDOW_SYSTEM
25033 if (IMAGEP (object
))
25035 Lisp_Object image_map
, hotspot
;
25036 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25038 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25040 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25044 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25045 If so, we could look for mouse-enter, mouse-leave
25046 properties in PLIST (and do something...). */
25047 hotspot
= XCDR (hotspot
);
25048 if (CONSP (hotspot
)
25049 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25051 pointer
= Fplist_get (plist
, Qpointer
);
25052 if (NILP (pointer
))
25054 help
= Fplist_get (plist
, Qhelp_echo
);
25057 help_echo_string
= help
;
25058 /* Is this correct? ++kfs */
25059 XSETWINDOW (help_echo_window
, w
);
25060 help_echo_object
= w
->buffer
;
25061 help_echo_pos
= charpos
;
25065 if (NILP (pointer
))
25066 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25068 #endif /* HAVE_WINDOW_SYSTEM */
25070 if (STRINGP (string
))
25072 pos
= make_number (charpos
);
25073 /* If we're on a string with `help-echo' text property, arrange
25074 for the help to be displayed. This is done by setting the
25075 global variable help_echo_string to the help string. */
25078 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25081 help_echo_string
= help
;
25082 XSETWINDOW (help_echo_window
, w
);
25083 help_echo_object
= string
;
25084 help_echo_pos
= charpos
;
25088 #ifdef HAVE_WINDOW_SYSTEM
25089 if (FRAME_WINDOW_P (f
))
25091 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25092 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25093 if (NILP (pointer
))
25094 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25096 /* Change the mouse pointer according to what is under X/Y. */
25098 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25101 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25102 if (!KEYMAPP (map
))
25103 map
= Fget_text_property (pos
, Qkeymap
, string
);
25104 if (!KEYMAPP (map
))
25105 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25110 /* Change the mouse face according to what is under X/Y. */
25111 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25112 if (!NILP (mouse_face
)
25113 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25118 struct glyph
* tmp_glyph
;
25122 int total_pixel_width
;
25123 EMACS_INT begpos
, endpos
, ignore
;
25127 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25128 Qmouse_face
, string
, Qnil
);
25134 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25136 endpos
= SCHARS (string
);
25140 /* Calculate the glyph position GPOS of GLYPH in the
25141 displayed string, relative to the beginning of the
25142 highlighted part of the string.
25144 Note: GPOS is different from CHARPOS. CHARPOS is the
25145 position of GLYPH in the internal string object. A mode
25146 line string format has structures which are converted to
25147 a flattened string by the Emacs Lisp interpreter. The
25148 internal string is an element of those structures. The
25149 displayed string is the flattened string. */
25150 tmp_glyph
= row_start_glyph
;
25151 while (tmp_glyph
< glyph
25152 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25153 && begpos
<= tmp_glyph
->charpos
25154 && tmp_glyph
->charpos
< endpos
)))
25156 gpos
= glyph
- tmp_glyph
;
25158 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25159 the highlighted part of the displayed string to which
25160 GLYPH belongs. Note: GSEQ_LENGTH is different from
25161 SCHARS (STRING), because the latter returns the length of
25162 the internal string. */
25163 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25165 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25166 && begpos
<= tmp_glyph
->charpos
25167 && tmp_glyph
->charpos
< endpos
));
25170 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25172 /* Calculate the total pixel width of all the glyphs between
25173 the beginning of the highlighted area and GLYPH. */
25174 total_pixel_width
= 0;
25175 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25176 total_pixel_width
+= tmp_glyph
->pixel_width
;
25178 /* Pre calculation of re-rendering position. Note: X is in
25179 column units here, after the call to mode_line_string or
25180 marginal_area_string. */
25182 vpos
= (area
== ON_MODE_LINE
25183 ? (w
->current_matrix
)->nrows
- 1
25186 /* If GLYPH's position is included in the region that is
25187 already drawn in mouse face, we have nothing to do. */
25188 if ( EQ (window
, hlinfo
->mouse_face_window
)
25189 && (!row
->reversed_p
25190 ? (hlinfo
->mouse_face_beg_col
<= hpos
25191 && hpos
< hlinfo
->mouse_face_end_col
)
25192 /* In R2L rows we swap BEG and END, see below. */
25193 : (hlinfo
->mouse_face_end_col
<= hpos
25194 && hpos
< hlinfo
->mouse_face_beg_col
))
25195 && hlinfo
->mouse_face_beg_row
== vpos
)
25198 if (clear_mouse_face (hlinfo
))
25199 cursor
= No_Cursor
;
25201 if (!row
->reversed_p
)
25203 hlinfo
->mouse_face_beg_col
= hpos
;
25204 hlinfo
->mouse_face_beg_x
= original_x_pixel
25205 - (total_pixel_width
+ dx
);
25206 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25207 hlinfo
->mouse_face_end_x
= 0;
25211 /* In R2L rows, show_mouse_face expects BEG and END
25212 coordinates to be swapped. */
25213 hlinfo
->mouse_face_end_col
= hpos
;
25214 hlinfo
->mouse_face_end_x
= original_x_pixel
25215 - (total_pixel_width
+ dx
);
25216 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25217 hlinfo
->mouse_face_beg_x
= 0;
25220 hlinfo
->mouse_face_beg_row
= vpos
;
25221 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25222 hlinfo
->mouse_face_beg_y
= 0;
25223 hlinfo
->mouse_face_end_y
= 0;
25224 hlinfo
->mouse_face_past_end
= 0;
25225 hlinfo
->mouse_face_window
= window
;
25227 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25233 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25235 if (NILP (pointer
))
25238 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25239 clear_mouse_face (hlinfo
);
25241 #ifdef HAVE_WINDOW_SYSTEM
25242 if (FRAME_WINDOW_P (f
))
25243 define_frame_cursor1 (f
, cursor
, pointer
);
25249 Take proper action when the mouse has moved to position X, Y on
25250 frame F as regards highlighting characters that have mouse-face
25251 properties. Also de-highlighting chars where the mouse was before.
25252 X and Y can be negative or out of range. */
25255 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25257 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25258 enum window_part part
;
25259 Lisp_Object window
;
25261 Cursor cursor
= No_Cursor
;
25262 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25265 /* When a menu is active, don't highlight because this looks odd. */
25266 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25267 if (popup_activated ())
25271 if (NILP (Vmouse_highlight
)
25272 || !f
->glyphs_initialized_p
25273 || f
->pointer_invisible
)
25276 hlinfo
->mouse_face_mouse_x
= x
;
25277 hlinfo
->mouse_face_mouse_y
= y
;
25278 hlinfo
->mouse_face_mouse_frame
= f
;
25280 if (hlinfo
->mouse_face_defer
)
25283 if (gc_in_progress
)
25285 hlinfo
->mouse_face_deferred_gc
= 1;
25289 /* Which window is that in? */
25290 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25292 /* If we were displaying active text in another window, clear that.
25293 Also clear if we move out of text area in same window. */
25294 if (! EQ (window
, hlinfo
->mouse_face_window
)
25295 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25296 && !NILP (hlinfo
->mouse_face_window
)))
25297 clear_mouse_face (hlinfo
);
25299 /* Not on a window -> return. */
25300 if (!WINDOWP (window
))
25303 /* Reset help_echo_string. It will get recomputed below. */
25304 help_echo_string
= Qnil
;
25306 /* Convert to window-relative pixel coordinates. */
25307 w
= XWINDOW (window
);
25308 frame_to_window_pixel_xy (w
, &x
, &y
);
25310 #ifdef HAVE_WINDOW_SYSTEM
25311 /* Handle tool-bar window differently since it doesn't display a
25313 if (EQ (window
, f
->tool_bar_window
))
25315 note_tool_bar_highlight (f
, x
, y
);
25320 /* Mouse is on the mode, header line or margin? */
25321 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25322 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25324 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25328 #ifdef HAVE_WINDOW_SYSTEM
25329 if (part
== ON_VERTICAL_BORDER
)
25331 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25332 help_echo_string
= build_string ("drag-mouse-1: resize");
25334 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25335 || part
== ON_SCROLL_BAR
)
25336 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25338 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25341 /* Are we in a window whose display is up to date?
25342 And verify the buffer's text has not changed. */
25343 b
= XBUFFER (w
->buffer
);
25344 if (part
== ON_TEXT
25345 && EQ (w
->window_end_valid
, w
->buffer
)
25346 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25347 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25349 int hpos
, vpos
, i
, dx
, dy
, area
;
25351 struct glyph
*glyph
;
25352 Lisp_Object object
;
25353 Lisp_Object mouse_face
= Qnil
, position
;
25354 Lisp_Object
*overlay_vec
= NULL
;
25356 struct buffer
*obuf
;
25357 EMACS_INT obegv
, ozv
;
25360 /* Find the glyph under X/Y. */
25361 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25363 #ifdef HAVE_WINDOW_SYSTEM
25364 /* Look for :pointer property on image. */
25365 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25367 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25368 if (img
!= NULL
&& IMAGEP (img
->spec
))
25370 Lisp_Object image_map
, hotspot
;
25371 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25373 && (hotspot
= find_hot_spot (image_map
,
25374 glyph
->slice
.img
.x
+ dx
,
25375 glyph
->slice
.img
.y
+ dy
),
25377 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25381 /* Could check XCAR (hotspot) to see if we enter/leave
25383 If so, we could look for mouse-enter, mouse-leave
25384 properties in PLIST (and do something...). */
25385 hotspot
= XCDR (hotspot
);
25386 if (CONSP (hotspot
)
25387 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25389 pointer
= Fplist_get (plist
, Qpointer
);
25390 if (NILP (pointer
))
25392 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25393 if (!NILP (help_echo_string
))
25395 help_echo_window
= window
;
25396 help_echo_object
= glyph
->object
;
25397 help_echo_pos
= glyph
->charpos
;
25401 if (NILP (pointer
))
25402 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25405 #endif /* HAVE_WINDOW_SYSTEM */
25407 /* Clear mouse face if X/Y not over text. */
25409 || area
!= TEXT_AREA
25410 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25411 /* Glyph's OBJECT is an integer for glyphs inserted by the
25412 display engine for its internal purposes, like truncation
25413 and continuation glyphs and blanks beyond the end of
25414 line's text on text terminals. If we are over such a
25415 glyph, we are not over any text. */
25416 || INTEGERP (glyph
->object
)
25417 /* R2L rows have a stretch glyph at their front, which
25418 stands for no text, whereas L2R rows have no glyphs at
25419 all beyond the end of text. Treat such stretch glyphs
25420 like we do with NULL glyphs in L2R rows. */
25421 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25422 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25423 && glyph
->type
== STRETCH_GLYPH
25424 && glyph
->avoid_cursor_p
))
25426 if (clear_mouse_face (hlinfo
))
25427 cursor
= No_Cursor
;
25428 #ifdef HAVE_WINDOW_SYSTEM
25429 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25431 if (area
!= TEXT_AREA
)
25432 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25434 pointer
= Vvoid_text_area_pointer
;
25440 pos
= glyph
->charpos
;
25441 object
= glyph
->object
;
25442 if (!STRINGP (object
) && !BUFFERP (object
))
25445 /* If we get an out-of-range value, return now; avoid an error. */
25446 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25449 /* Make the window's buffer temporarily current for
25450 overlays_at and compute_char_face. */
25451 obuf
= current_buffer
;
25452 current_buffer
= b
;
25458 /* Is this char mouse-active or does it have help-echo? */
25459 position
= make_number (pos
);
25461 if (BUFFERP (object
))
25463 /* Put all the overlays we want in a vector in overlay_vec. */
25464 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25465 /* Sort overlays into increasing priority order. */
25466 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25471 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25474 cursor
= No_Cursor
;
25476 /* Check mouse-face highlighting. */
25478 /* If there exists an overlay with mouse-face overlapping
25479 the one we are currently highlighting, we have to
25480 check if we enter the overlapping overlay, and then
25481 highlight only that. */
25482 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25483 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25485 /* Find the highest priority overlay with a mouse-face. */
25486 Lisp_Object overlay
= Qnil
;
25487 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25489 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25490 if (!NILP (mouse_face
))
25491 overlay
= overlay_vec
[i
];
25494 /* If we're highlighting the same overlay as before, there's
25495 no need to do that again. */
25496 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25497 goto check_help_echo
;
25498 hlinfo
->mouse_face_overlay
= overlay
;
25500 /* Clear the display of the old active region, if any. */
25501 if (clear_mouse_face (hlinfo
))
25502 cursor
= No_Cursor
;
25504 /* If no overlay applies, get a text property. */
25505 if (NILP (overlay
))
25506 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25508 /* Next, compute the bounds of the mouse highlighting and
25510 if (!NILP (mouse_face
) && STRINGP (object
))
25512 /* The mouse-highlighting comes from a display string
25513 with a mouse-face. */
25517 s
= Fprevious_single_property_change
25518 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25519 e
= Fnext_single_property_change
25520 (position
, Qmouse_face
, object
, Qnil
);
25522 s
= make_number (0);
25524 e
= make_number (SCHARS (object
) - 1);
25525 mouse_face_from_string_pos (w
, hlinfo
, object
,
25526 XINT (s
), XINT (e
));
25527 hlinfo
->mouse_face_past_end
= 0;
25528 hlinfo
->mouse_face_window
= window
;
25529 hlinfo
->mouse_face_face_id
25530 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25531 glyph
->face_id
, 1);
25532 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25533 cursor
= No_Cursor
;
25537 /* The mouse-highlighting, if any, comes from an overlay
25538 or text property in the buffer. */
25539 Lisp_Object buffer
IF_LINT (= Qnil
);
25540 Lisp_Object cover_string
IF_LINT (= Qnil
);
25542 if (STRINGP (object
))
25544 /* If we are on a display string with no mouse-face,
25545 check if the text under it has one. */
25546 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25547 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25548 pos
= string_buffer_position (object
, start
);
25551 mouse_face
= get_char_property_and_overlay
25552 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25553 buffer
= w
->buffer
;
25554 cover_string
= object
;
25560 cover_string
= Qnil
;
25563 if (!NILP (mouse_face
))
25565 Lisp_Object before
, after
;
25566 Lisp_Object before_string
, after_string
;
25567 /* To correctly find the limits of mouse highlight
25568 in a bidi-reordered buffer, we must not use the
25569 optimization of limiting the search in
25570 previous-single-property-change and
25571 next-single-property-change, because
25572 rows_from_pos_range needs the real start and end
25573 positions to DTRT in this case. That's because
25574 the first row visible in a window does not
25575 necessarily display the character whose position
25576 is the smallest. */
25578 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25579 ? Fmarker_position (w
->start
)
25582 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25583 ? make_number (BUF_Z (XBUFFER (buffer
))
25584 - XFASTINT (w
->window_end_pos
))
25587 if (NILP (overlay
))
25589 /* Handle the text property case. */
25590 before
= Fprevious_single_property_change
25591 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25592 after
= Fnext_single_property_change
25593 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25594 before_string
= after_string
= Qnil
;
25598 /* Handle the overlay case. */
25599 before
= Foverlay_start (overlay
);
25600 after
= Foverlay_end (overlay
);
25601 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25602 after_string
= Foverlay_get (overlay
, Qafter_string
);
25604 if (!STRINGP (before_string
)) before_string
= Qnil
;
25605 if (!STRINGP (after_string
)) after_string
= Qnil
;
25608 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25611 before_string
, after_string
,
25613 cursor
= No_Cursor
;
25620 /* Look for a `help-echo' property. */
25621 if (NILP (help_echo_string
)) {
25622 Lisp_Object help
, overlay
;
25624 /* Check overlays first. */
25625 help
= overlay
= Qnil
;
25626 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25628 overlay
= overlay_vec
[i
];
25629 help
= Foverlay_get (overlay
, Qhelp_echo
);
25634 help_echo_string
= help
;
25635 help_echo_window
= window
;
25636 help_echo_object
= overlay
;
25637 help_echo_pos
= pos
;
25641 Lisp_Object obj
= glyph
->object
;
25642 EMACS_INT charpos
= glyph
->charpos
;
25644 /* Try text properties. */
25647 && charpos
< SCHARS (obj
))
25649 help
= Fget_text_property (make_number (charpos
),
25653 /* If the string itself doesn't specify a help-echo,
25654 see if the buffer text ``under'' it does. */
25655 struct glyph_row
*r
25656 = MATRIX_ROW (w
->current_matrix
, vpos
);
25657 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25658 EMACS_INT p
= string_buffer_position (obj
, start
);
25661 help
= Fget_char_property (make_number (p
),
25662 Qhelp_echo
, w
->buffer
);
25671 else if (BUFFERP (obj
)
25674 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25679 help_echo_string
= help
;
25680 help_echo_window
= window
;
25681 help_echo_object
= obj
;
25682 help_echo_pos
= charpos
;
25687 #ifdef HAVE_WINDOW_SYSTEM
25688 /* Look for a `pointer' property. */
25689 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25691 /* Check overlays first. */
25692 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25693 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25695 if (NILP (pointer
))
25697 Lisp_Object obj
= glyph
->object
;
25698 EMACS_INT charpos
= glyph
->charpos
;
25700 /* Try text properties. */
25703 && charpos
< SCHARS (obj
))
25705 pointer
= Fget_text_property (make_number (charpos
),
25707 if (NILP (pointer
))
25709 /* If the string itself doesn't specify a pointer,
25710 see if the buffer text ``under'' it does. */
25711 struct glyph_row
*r
25712 = MATRIX_ROW (w
->current_matrix
, vpos
);
25713 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25714 EMACS_INT p
= string_buffer_position (obj
, start
);
25716 pointer
= Fget_char_property (make_number (p
),
25717 Qpointer
, w
->buffer
);
25720 else if (BUFFERP (obj
)
25723 pointer
= Fget_text_property (make_number (charpos
),
25727 #endif /* HAVE_WINDOW_SYSTEM */
25731 current_buffer
= obuf
;
25736 #ifdef HAVE_WINDOW_SYSTEM
25737 if (FRAME_WINDOW_P (f
))
25738 define_frame_cursor1 (f
, cursor
, pointer
);
25740 /* This is here to prevent a compiler error, about "label at end of
25741 compound statement". */
25748 Clear any mouse-face on window W. This function is part of the
25749 redisplay interface, and is called from try_window_id and similar
25750 functions to ensure the mouse-highlight is off. */
25753 x_clear_window_mouse_face (struct window
*w
)
25755 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25756 Lisp_Object window
;
25759 XSETWINDOW (window
, w
);
25760 if (EQ (window
, hlinfo
->mouse_face_window
))
25761 clear_mouse_face (hlinfo
);
25767 Just discard the mouse face information for frame F, if any.
25768 This is used when the size of F is changed. */
25771 cancel_mouse_face (struct frame
*f
)
25773 Lisp_Object window
;
25774 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25776 window
= hlinfo
->mouse_face_window
;
25777 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25779 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25780 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25781 hlinfo
->mouse_face_window
= Qnil
;
25787 /***********************************************************************
25789 ***********************************************************************/
25791 #ifdef HAVE_WINDOW_SYSTEM
25793 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25794 which intersects rectangle R. R is in window-relative coordinates. */
25797 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25798 enum glyph_row_area area
)
25800 struct glyph
*first
= row
->glyphs
[area
];
25801 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25802 struct glyph
*last
;
25803 int first_x
, start_x
, x
;
25805 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25806 /* If row extends face to end of line write the whole line. */
25807 draw_glyphs (w
, 0, row
, area
,
25808 0, row
->used
[area
],
25809 DRAW_NORMAL_TEXT
, 0);
25812 /* Set START_X to the window-relative start position for drawing glyphs of
25813 AREA. The first glyph of the text area can be partially visible.
25814 The first glyphs of other areas cannot. */
25815 start_x
= window_box_left_offset (w
, area
);
25817 if (area
== TEXT_AREA
)
25820 /* Find the first glyph that must be redrawn. */
25822 && x
+ first
->pixel_width
< r
->x
)
25824 x
+= first
->pixel_width
;
25828 /* Find the last one. */
25832 && x
< r
->x
+ r
->width
)
25834 x
+= last
->pixel_width
;
25840 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25841 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25842 DRAW_NORMAL_TEXT
, 0);
25847 /* Redraw the parts of the glyph row ROW on window W intersecting
25848 rectangle R. R is in window-relative coordinates. Value is
25849 non-zero if mouse-face was overwritten. */
25852 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25854 xassert (row
->enabled_p
);
25856 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25857 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25858 0, row
->used
[TEXT_AREA
],
25859 DRAW_NORMAL_TEXT
, 0);
25862 if (row
->used
[LEFT_MARGIN_AREA
])
25863 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25864 if (row
->used
[TEXT_AREA
])
25865 expose_area (w
, row
, r
, TEXT_AREA
);
25866 if (row
->used
[RIGHT_MARGIN_AREA
])
25867 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25868 draw_row_fringe_bitmaps (w
, row
);
25871 return row
->mouse_face_p
;
25875 /* Redraw those parts of glyphs rows during expose event handling that
25876 overlap other rows. Redrawing of an exposed line writes over parts
25877 of lines overlapping that exposed line; this function fixes that.
25879 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25880 row in W's current matrix that is exposed and overlaps other rows.
25881 LAST_OVERLAPPING_ROW is the last such row. */
25884 expose_overlaps (struct window
*w
,
25885 struct glyph_row
*first_overlapping_row
,
25886 struct glyph_row
*last_overlapping_row
,
25889 struct glyph_row
*row
;
25891 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25892 if (row
->overlapping_p
)
25894 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25897 if (row
->used
[LEFT_MARGIN_AREA
])
25898 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25900 if (row
->used
[TEXT_AREA
])
25901 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25903 if (row
->used
[RIGHT_MARGIN_AREA
])
25904 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25910 /* Return non-zero if W's cursor intersects rectangle R. */
25913 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25915 XRectangle cr
, result
;
25916 struct glyph
*cursor_glyph
;
25917 struct glyph_row
*row
;
25919 if (w
->phys_cursor
.vpos
>= 0
25920 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25921 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25923 && row
->cursor_in_fringe_p
)
25925 /* Cursor is in the fringe. */
25926 cr
.x
= window_box_right_offset (w
,
25927 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25928 ? RIGHT_MARGIN_AREA
25931 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25932 cr
.height
= row
->height
;
25933 return x_intersect_rectangles (&cr
, r
, &result
);
25936 cursor_glyph
= get_phys_cursor_glyph (w
);
25939 /* r is relative to W's box, but w->phys_cursor.x is relative
25940 to left edge of W's TEXT area. Adjust it. */
25941 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25942 cr
.y
= w
->phys_cursor
.y
;
25943 cr
.width
= cursor_glyph
->pixel_width
;
25944 cr
.height
= w
->phys_cursor_height
;
25945 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25946 I assume the effect is the same -- and this is portable. */
25947 return x_intersect_rectangles (&cr
, r
, &result
);
25949 /* If we don't understand the format, pretend we're not in the hot-spot. */
25955 Draw a vertical window border to the right of window W if W doesn't
25956 have vertical scroll bars. */
25959 x_draw_vertical_border (struct window
*w
)
25961 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25963 /* We could do better, if we knew what type of scroll-bar the adjacent
25964 windows (on either side) have... But we don't :-(
25965 However, I think this works ok. ++KFS 2003-04-25 */
25967 /* Redraw borders between horizontally adjacent windows. Don't
25968 do it for frames with vertical scroll bars because either the
25969 right scroll bar of a window, or the left scroll bar of its
25970 neighbor will suffice as a border. */
25971 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25974 if (!WINDOW_RIGHTMOST_P (w
)
25975 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25977 int x0
, x1
, y0
, y1
;
25979 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25982 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25985 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25987 else if (!WINDOW_LEFTMOST_P (w
)
25988 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25990 int x0
, x1
, y0
, y1
;
25992 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25995 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25998 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26003 /* Redraw the part of window W intersection rectangle FR. Pixel
26004 coordinates in FR are frame-relative. Call this function with
26005 input blocked. Value is non-zero if the exposure overwrites
26009 expose_window (struct window
*w
, XRectangle
*fr
)
26011 struct frame
*f
= XFRAME (w
->frame
);
26013 int mouse_face_overwritten_p
= 0;
26015 /* If window is not yet fully initialized, do nothing. This can
26016 happen when toolkit scroll bars are used and a window is split.
26017 Reconfiguring the scroll bar will generate an expose for a newly
26019 if (w
->current_matrix
== NULL
)
26022 /* When we're currently updating the window, display and current
26023 matrix usually don't agree. Arrange for a thorough display
26025 if (w
== updated_window
)
26027 SET_FRAME_GARBAGED (f
);
26031 /* Frame-relative pixel rectangle of W. */
26032 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26033 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26034 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26035 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26037 if (x_intersect_rectangles (fr
, &wr
, &r
))
26039 int yb
= window_text_bottom_y (w
);
26040 struct glyph_row
*row
;
26041 int cursor_cleared_p
;
26042 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26044 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26045 r
.x
, r
.y
, r
.width
, r
.height
));
26047 /* Convert to window coordinates. */
26048 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26049 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26051 /* Turn off the cursor. */
26052 if (!w
->pseudo_window_p
26053 && phys_cursor_in_rect_p (w
, &r
))
26055 x_clear_cursor (w
);
26056 cursor_cleared_p
= 1;
26059 cursor_cleared_p
= 0;
26061 /* Update lines intersecting rectangle R. */
26062 first_overlapping_row
= last_overlapping_row
= NULL
;
26063 for (row
= w
->current_matrix
->rows
;
26068 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26070 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26071 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26072 || (r
.y
>= y0
&& r
.y
< y1
)
26073 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26075 /* A header line may be overlapping, but there is no need
26076 to fix overlapping areas for them. KFS 2005-02-12 */
26077 if (row
->overlapping_p
&& !row
->mode_line_p
)
26079 if (first_overlapping_row
== NULL
)
26080 first_overlapping_row
= row
;
26081 last_overlapping_row
= row
;
26085 if (expose_line (w
, row
, &r
))
26086 mouse_face_overwritten_p
= 1;
26089 else if (row
->overlapping_p
)
26091 /* We must redraw a row overlapping the exposed area. */
26093 ? y0
+ row
->phys_height
> r
.y
26094 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26096 if (first_overlapping_row
== NULL
)
26097 first_overlapping_row
= row
;
26098 last_overlapping_row
= row
;
26106 /* Display the mode line if there is one. */
26107 if (WINDOW_WANTS_MODELINE_P (w
)
26108 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26110 && row
->y
< r
.y
+ r
.height
)
26112 if (expose_line (w
, row
, &r
))
26113 mouse_face_overwritten_p
= 1;
26116 if (!w
->pseudo_window_p
)
26118 /* Fix the display of overlapping rows. */
26119 if (first_overlapping_row
)
26120 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26123 /* Draw border between windows. */
26124 x_draw_vertical_border (w
);
26126 /* Turn the cursor on again. */
26127 if (cursor_cleared_p
)
26128 update_window_cursor (w
, 1);
26132 return mouse_face_overwritten_p
;
26137 /* Redraw (parts) of all windows in the window tree rooted at W that
26138 intersect R. R contains frame pixel coordinates. Value is
26139 non-zero if the exposure overwrites mouse-face. */
26142 expose_window_tree (struct window
*w
, XRectangle
*r
)
26144 struct frame
*f
= XFRAME (w
->frame
);
26145 int mouse_face_overwritten_p
= 0;
26147 while (w
&& !FRAME_GARBAGED_P (f
))
26149 if (!NILP (w
->hchild
))
26150 mouse_face_overwritten_p
26151 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26152 else if (!NILP (w
->vchild
))
26153 mouse_face_overwritten_p
26154 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26156 mouse_face_overwritten_p
|= expose_window (w
, r
);
26158 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26161 return mouse_face_overwritten_p
;
26166 Redisplay an exposed area of frame F. X and Y are the upper-left
26167 corner of the exposed rectangle. W and H are width and height of
26168 the exposed area. All are pixel values. W or H zero means redraw
26169 the entire frame. */
26172 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26175 int mouse_face_overwritten_p
= 0;
26177 TRACE ((stderr
, "expose_frame "));
26179 /* No need to redraw if frame will be redrawn soon. */
26180 if (FRAME_GARBAGED_P (f
))
26182 TRACE ((stderr
, " garbaged\n"));
26186 /* If basic faces haven't been realized yet, there is no point in
26187 trying to redraw anything. This can happen when we get an expose
26188 event while Emacs is starting, e.g. by moving another window. */
26189 if (FRAME_FACE_CACHE (f
) == NULL
26190 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26192 TRACE ((stderr
, " no faces\n"));
26196 if (w
== 0 || h
== 0)
26199 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26200 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26210 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26211 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26213 if (WINDOWP (f
->tool_bar_window
))
26214 mouse_face_overwritten_p
26215 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26217 #ifdef HAVE_X_WINDOWS
26219 #ifndef USE_X_TOOLKIT
26220 if (WINDOWP (f
->menu_bar_window
))
26221 mouse_face_overwritten_p
26222 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26223 #endif /* not USE_X_TOOLKIT */
26227 /* Some window managers support a focus-follows-mouse style with
26228 delayed raising of frames. Imagine a partially obscured frame,
26229 and moving the mouse into partially obscured mouse-face on that
26230 frame. The visible part of the mouse-face will be highlighted,
26231 then the WM raises the obscured frame. With at least one WM, KDE
26232 2.1, Emacs is not getting any event for the raising of the frame
26233 (even tried with SubstructureRedirectMask), only Expose events.
26234 These expose events will draw text normally, i.e. not
26235 highlighted. Which means we must redo the highlight here.
26236 Subsume it under ``we love X''. --gerd 2001-08-15 */
26237 /* Included in Windows version because Windows most likely does not
26238 do the right thing if any third party tool offers
26239 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26240 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26242 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26243 if (f
== hlinfo
->mouse_face_mouse_frame
)
26245 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26246 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26247 clear_mouse_face (hlinfo
);
26248 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26255 Determine the intersection of two rectangles R1 and R2. Return
26256 the intersection in *RESULT. Value is non-zero if RESULT is not
26260 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26262 XRectangle
*left
, *right
;
26263 XRectangle
*upper
, *lower
;
26264 int intersection_p
= 0;
26266 /* Rearrange so that R1 is the left-most rectangle. */
26268 left
= r1
, right
= r2
;
26270 left
= r2
, right
= r1
;
26272 /* X0 of the intersection is right.x0, if this is inside R1,
26273 otherwise there is no intersection. */
26274 if (right
->x
<= left
->x
+ left
->width
)
26276 result
->x
= right
->x
;
26278 /* The right end of the intersection is the minimum of the
26279 the right ends of left and right. */
26280 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26283 /* Same game for Y. */
26285 upper
= r1
, lower
= r2
;
26287 upper
= r2
, lower
= r1
;
26289 /* The upper end of the intersection is lower.y0, if this is inside
26290 of upper. Otherwise, there is no intersection. */
26291 if (lower
->y
<= upper
->y
+ upper
->height
)
26293 result
->y
= lower
->y
;
26295 /* The lower end of the intersection is the minimum of the lower
26296 ends of upper and lower. */
26297 result
->height
= (min (lower
->y
+ lower
->height
,
26298 upper
->y
+ upper
->height
)
26300 intersection_p
= 1;
26304 return intersection_p
;
26307 #endif /* HAVE_WINDOW_SYSTEM */
26310 /***********************************************************************
26312 ***********************************************************************/
26315 syms_of_xdisp (void)
26317 Vwith_echo_area_save_vector
= Qnil
;
26318 staticpro (&Vwith_echo_area_save_vector
);
26320 Vmessage_stack
= Qnil
;
26321 staticpro (&Vmessage_stack
);
26323 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26324 staticpro (&Qinhibit_redisplay
);
26326 message_dolog_marker1
= Fmake_marker ();
26327 staticpro (&message_dolog_marker1
);
26328 message_dolog_marker2
= Fmake_marker ();
26329 staticpro (&message_dolog_marker2
);
26330 message_dolog_marker3
= Fmake_marker ();
26331 staticpro (&message_dolog_marker3
);
26334 defsubr (&Sdump_frame_glyph_matrix
);
26335 defsubr (&Sdump_glyph_matrix
);
26336 defsubr (&Sdump_glyph_row
);
26337 defsubr (&Sdump_tool_bar_row
);
26338 defsubr (&Strace_redisplay
);
26339 defsubr (&Strace_to_stderr
);
26341 #ifdef HAVE_WINDOW_SYSTEM
26342 defsubr (&Stool_bar_lines_needed
);
26343 defsubr (&Slookup_image_map
);
26345 defsubr (&Sformat_mode_line
);
26346 defsubr (&Sinvisible_p
);
26347 defsubr (&Scurrent_bidi_paragraph_direction
);
26349 staticpro (&Qmenu_bar_update_hook
);
26350 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26352 staticpro (&Qoverriding_terminal_local_map
);
26353 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26355 staticpro (&Qoverriding_local_map
);
26356 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26358 staticpro (&Qwindow_scroll_functions
);
26359 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26361 staticpro (&Qwindow_text_change_functions
);
26362 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26364 staticpro (&Qredisplay_end_trigger_functions
);
26365 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26367 staticpro (&Qinhibit_point_motion_hooks
);
26368 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26370 Qeval
= intern_c_string ("eval");
26371 staticpro (&Qeval
);
26373 QCdata
= intern_c_string (":data");
26374 staticpro (&QCdata
);
26375 Qdisplay
= intern_c_string ("display");
26376 staticpro (&Qdisplay
);
26377 Qspace_width
= intern_c_string ("space-width");
26378 staticpro (&Qspace_width
);
26379 Qraise
= intern_c_string ("raise");
26380 staticpro (&Qraise
);
26381 Qslice
= intern_c_string ("slice");
26382 staticpro (&Qslice
);
26383 Qspace
= intern_c_string ("space");
26384 staticpro (&Qspace
);
26385 Qmargin
= intern_c_string ("margin");
26386 staticpro (&Qmargin
);
26387 Qpointer
= intern_c_string ("pointer");
26388 staticpro (&Qpointer
);
26389 Qleft_margin
= intern_c_string ("left-margin");
26390 staticpro (&Qleft_margin
);
26391 Qright_margin
= intern_c_string ("right-margin");
26392 staticpro (&Qright_margin
);
26393 Qcenter
= intern_c_string ("center");
26394 staticpro (&Qcenter
);
26395 Qline_height
= intern_c_string ("line-height");
26396 staticpro (&Qline_height
);
26397 QCalign_to
= intern_c_string (":align-to");
26398 staticpro (&QCalign_to
);
26399 QCrelative_width
= intern_c_string (":relative-width");
26400 staticpro (&QCrelative_width
);
26401 QCrelative_height
= intern_c_string (":relative-height");
26402 staticpro (&QCrelative_height
);
26403 QCeval
= intern_c_string (":eval");
26404 staticpro (&QCeval
);
26405 QCpropertize
= intern_c_string (":propertize");
26406 staticpro (&QCpropertize
);
26407 QCfile
= intern_c_string (":file");
26408 staticpro (&QCfile
);
26409 Qfontified
= intern_c_string ("fontified");
26410 staticpro (&Qfontified
);
26411 Qfontification_functions
= intern_c_string ("fontification-functions");
26412 staticpro (&Qfontification_functions
);
26413 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26414 staticpro (&Qtrailing_whitespace
);
26415 Qescape_glyph
= intern_c_string ("escape-glyph");
26416 staticpro (&Qescape_glyph
);
26417 Qnobreak_space
= intern_c_string ("nobreak-space");
26418 staticpro (&Qnobreak_space
);
26419 Qimage
= intern_c_string ("image");
26420 staticpro (&Qimage
);
26421 Qtext
= intern_c_string ("text");
26422 staticpro (&Qtext
);
26423 Qboth
= intern_c_string ("both");
26424 staticpro (&Qboth
);
26425 Qboth_horiz
= intern_c_string ("both-horiz");
26426 staticpro (&Qboth_horiz
);
26427 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26428 staticpro (&Qtext_image_horiz
);
26429 QCmap
= intern_c_string (":map");
26430 staticpro (&QCmap
);
26431 QCpointer
= intern_c_string (":pointer");
26432 staticpro (&QCpointer
);
26433 Qrect
= intern_c_string ("rect");
26434 staticpro (&Qrect
);
26435 Qcircle
= intern_c_string ("circle");
26436 staticpro (&Qcircle
);
26437 Qpoly
= intern_c_string ("poly");
26438 staticpro (&Qpoly
);
26439 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26440 staticpro (&Qmessage_truncate_lines
);
26441 Qgrow_only
= intern_c_string ("grow-only");
26442 staticpro (&Qgrow_only
);
26443 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26444 staticpro (&Qinhibit_menubar_update
);
26445 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26446 staticpro (&Qinhibit_eval_during_redisplay
);
26447 Qposition
= intern_c_string ("position");
26448 staticpro (&Qposition
);
26449 Qbuffer_position
= intern_c_string ("buffer-position");
26450 staticpro (&Qbuffer_position
);
26451 Qobject
= intern_c_string ("object");
26452 staticpro (&Qobject
);
26453 Qbar
= intern_c_string ("bar");
26455 Qhbar
= intern_c_string ("hbar");
26456 staticpro (&Qhbar
);
26457 Qbox
= intern_c_string ("box");
26459 Qhollow
= intern_c_string ("hollow");
26460 staticpro (&Qhollow
);
26461 Qhand
= intern_c_string ("hand");
26462 staticpro (&Qhand
);
26463 Qarrow
= intern_c_string ("arrow");
26464 staticpro (&Qarrow
);
26465 Qtext
= intern_c_string ("text");
26466 staticpro (&Qtext
);
26467 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26468 staticpro (&Qinhibit_free_realized_faces
);
26470 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26471 Fcons (intern_c_string ("void-variable"), Qnil
)),
26473 staticpro (&list_of_error
);
26475 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26476 staticpro (&Qlast_arrow_position
);
26477 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26478 staticpro (&Qlast_arrow_string
);
26480 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26481 staticpro (&Qoverlay_arrow_string
);
26482 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26483 staticpro (&Qoverlay_arrow_bitmap
);
26485 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26486 staticpro (&echo_buffer
[0]);
26487 staticpro (&echo_buffer
[1]);
26489 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26490 staticpro (&echo_area_buffer
[0]);
26491 staticpro (&echo_area_buffer
[1]);
26493 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26494 staticpro (&Vmessages_buffer_name
);
26496 mode_line_proptrans_alist
= Qnil
;
26497 staticpro (&mode_line_proptrans_alist
);
26498 mode_line_string_list
= Qnil
;
26499 staticpro (&mode_line_string_list
);
26500 mode_line_string_face
= Qnil
;
26501 staticpro (&mode_line_string_face
);
26502 mode_line_string_face_prop
= Qnil
;
26503 staticpro (&mode_line_string_face_prop
);
26504 Vmode_line_unwind_vector
= Qnil
;
26505 staticpro (&Vmode_line_unwind_vector
);
26507 help_echo_string
= Qnil
;
26508 staticpro (&help_echo_string
);
26509 help_echo_object
= Qnil
;
26510 staticpro (&help_echo_object
);
26511 help_echo_window
= Qnil
;
26512 staticpro (&help_echo_window
);
26513 previous_help_echo_string
= Qnil
;
26514 staticpro (&previous_help_echo_string
);
26515 help_echo_pos
= -1;
26517 Qright_to_left
= intern_c_string ("right-to-left");
26518 staticpro (&Qright_to_left
);
26519 Qleft_to_right
= intern_c_string ("left-to-right");
26520 staticpro (&Qleft_to_right
);
26522 #ifdef HAVE_WINDOW_SYSTEM
26523 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26524 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26525 For example, if a block cursor is over a tab, it will be drawn as
26526 wide as that tab on the display. */);
26527 x_stretch_cursor_p
= 0;
26530 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26531 doc
: /* *Non-nil means highlight trailing whitespace.
26532 The face used for trailing whitespace is `trailing-whitespace'. */);
26533 Vshow_trailing_whitespace
= Qnil
;
26535 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26536 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26537 A value of t means highlight the character itself (for nobreak space,
26538 use face `nobreak-space').
26539 A value of nil means no highlighting.
26540 Other values mean display the escape glyph followed by an ordinary
26541 space or ordinary hyphen. */);
26542 Vnobreak_char_display
= Qt
;
26544 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26545 doc
: /* *The pointer shape to show in void text areas.
26546 A value of nil means to show the text pointer. Other options are `arrow',
26547 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26548 Vvoid_text_area_pointer
= Qarrow
;
26550 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26551 doc
: /* Non-nil means don't actually do any redisplay.
26552 This is used for internal purposes. */);
26553 Vinhibit_redisplay
= Qnil
;
26555 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26556 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26557 Vglobal_mode_string
= Qnil
;
26559 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26560 doc
: /* Marker for where to display an arrow on top of the buffer text.
26561 This must be the beginning of a line in order to work.
26562 See also `overlay-arrow-string'. */);
26563 Voverlay_arrow_position
= Qnil
;
26565 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26566 doc
: /* String to display as an arrow in non-window frames.
26567 See also `overlay-arrow-position'. */);
26568 Voverlay_arrow_string
= make_pure_c_string ("=>");
26570 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26571 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26572 The symbols on this list are examined during redisplay to determine
26573 where to display overlay arrows. */);
26574 Voverlay_arrow_variable_list
26575 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26577 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26578 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26579 If that fails to bring point back on frame, point is centered instead.
26580 If this is zero, point is always centered after it moves off frame.
26581 If you want scrolling to always be a line at a time, you should set
26582 `scroll-conservatively' to a large value rather than set this to 1. */);
26584 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26585 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26586 If point moves off-screen, redisplay will scroll by up to
26587 `scroll-conservatively' lines in order to bring point just barely
26588 onto the screen again. If that cannot be done, then redisplay
26589 recenters point as usual.
26591 If the value is greater than 100, redisplay will never recenter point,
26592 but will always scroll just enough text to bring point into view, even
26593 if you move far away.
26595 A value of zero means always recenter point if it moves off screen. */);
26596 scroll_conservatively
= 0;
26598 DEFVAR_INT ("scroll-margin", scroll_margin
,
26599 doc
: /* *Number of lines of margin at the top and bottom of a window.
26600 Recenter the window whenever point gets within this many lines
26601 of the top or bottom of the window. */);
26604 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26605 doc
: /* Pixels per inch value for non-window system displays.
26606 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26607 Vdisplay_pixels_per_inch
= make_float (72.0);
26610 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26613 DEFVAR_LISP ("truncate-partial-width-windows",
26614 Vtruncate_partial_width_windows
,
26615 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26616 For an integer value, truncate lines in each window narrower than the
26617 full frame width, provided the window width is less than that integer;
26618 otherwise, respect the value of `truncate-lines'.
26620 For any other non-nil value, truncate lines in all windows that do
26621 not span the full frame width.
26623 A value of nil means to respect the value of `truncate-lines'.
26625 If `word-wrap' is enabled, you might want to reduce this. */);
26626 Vtruncate_partial_width_windows
= make_number (50);
26628 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26629 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26630 Any other value means to use the appropriate face, `mode-line',
26631 `header-line', or `menu' respectively. */);
26632 mode_line_inverse_video
= 1;
26634 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26635 doc
: /* *Maximum buffer size for which line number should be displayed.
26636 If the buffer is bigger than this, the line number does not appear
26637 in the mode line. A value of nil means no limit. */);
26638 Vline_number_display_limit
= Qnil
;
26640 DEFVAR_INT ("line-number-display-limit-width",
26641 line_number_display_limit_width
,
26642 doc
: /* *Maximum line width (in characters) for line number display.
26643 If the average length of the lines near point is bigger than this, then the
26644 line number may be omitted from the mode line. */);
26645 line_number_display_limit_width
= 200;
26647 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26648 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26649 highlight_nonselected_windows
= 0;
26651 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26652 doc
: /* Non-nil if more than one frame is visible on this display.
26653 Minibuffer-only frames don't count, but iconified frames do.
26654 This variable is not guaranteed to be accurate except while processing
26655 `frame-title-format' and `icon-title-format'. */);
26657 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26658 doc
: /* Template for displaying the title bar of visible frames.
26659 \(Assuming the window manager supports this feature.)
26661 This variable has the same structure as `mode-line-format', except that
26662 the %c and %l constructs are ignored. It is used only on frames for
26663 which no explicit name has been set \(see `modify-frame-parameters'). */);
26665 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26666 doc
: /* Template for displaying the title bar of an iconified frame.
26667 \(Assuming the window manager supports this feature.)
26668 This variable has the same structure as `mode-line-format' (which see),
26669 and is used only on frames for which no explicit name has been set
26670 \(see `modify-frame-parameters'). */);
26672 = Vframe_title_format
26673 = pure_cons (intern_c_string ("multiple-frames"),
26674 pure_cons (make_pure_c_string ("%b"),
26675 pure_cons (pure_cons (empty_unibyte_string
,
26676 pure_cons (intern_c_string ("invocation-name"),
26677 pure_cons (make_pure_c_string ("@"),
26678 pure_cons (intern_c_string ("system-name"),
26682 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26683 doc
: /* Maximum number of lines to keep in the message log buffer.
26684 If nil, disable message logging. If t, log messages but don't truncate
26685 the buffer when it becomes large. */);
26686 Vmessage_log_max
= make_number (100);
26688 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26689 doc
: /* Functions called before redisplay, if window sizes have changed.
26690 The value should be a list of functions that take one argument.
26691 Just before redisplay, for each frame, if any of its windows have changed
26692 size since the last redisplay, or have been split or deleted,
26693 all the functions in the list are called, with the frame as argument. */);
26694 Vwindow_size_change_functions
= Qnil
;
26696 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26697 doc
: /* List of functions to call before redisplaying a window with scrolling.
26698 Each function is called with two arguments, the window and its new
26699 display-start position. Note that these functions are also called by
26700 `set-window-buffer'. Also note that the value of `window-end' is not
26701 valid when these functions are called. */);
26702 Vwindow_scroll_functions
= Qnil
;
26704 DEFVAR_LISP ("window-text-change-functions",
26705 Vwindow_text_change_functions
,
26706 doc
: /* Functions to call in redisplay when text in the window might change. */);
26707 Vwindow_text_change_functions
= Qnil
;
26709 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26710 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26711 Each function is called with two arguments, the window and the end trigger value.
26712 See `set-window-redisplay-end-trigger'. */);
26713 Vredisplay_end_trigger_functions
= Qnil
;
26715 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26716 doc
: /* *Non-nil means autoselect window with mouse pointer.
26717 If nil, do not autoselect windows.
26718 A positive number means delay autoselection by that many seconds: a
26719 window is autoselected only after the mouse has remained in that
26720 window for the duration of the delay.
26721 A negative number has a similar effect, but causes windows to be
26722 autoselected only after the mouse has stopped moving. \(Because of
26723 the way Emacs compares mouse events, you will occasionally wait twice
26724 that time before the window gets selected.\)
26725 Any other value means to autoselect window instantaneously when the
26726 mouse pointer enters it.
26728 Autoselection selects the minibuffer only if it is active, and never
26729 unselects the minibuffer if it is active.
26731 When customizing this variable make sure that the actual value of
26732 `focus-follows-mouse' matches the behavior of your window manager. */);
26733 Vmouse_autoselect_window
= Qnil
;
26735 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26736 doc
: /* *Non-nil means automatically resize tool-bars.
26737 This dynamically changes the tool-bar's height to the minimum height
26738 that is needed to make all tool-bar items visible.
26739 If value is `grow-only', the tool-bar's height is only increased
26740 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26741 Vauto_resize_tool_bars
= Qt
;
26743 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26744 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26745 auto_raise_tool_bar_buttons_p
= 1;
26747 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26748 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26749 make_cursor_line_fully_visible_p
= 1;
26751 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26752 doc
: /* *Border below tool-bar in pixels.
26753 If an integer, use it as the height of the border.
26754 If it is one of `internal-border-width' or `border-width', use the
26755 value of the corresponding frame parameter.
26756 Otherwise, no border is added below the tool-bar. */);
26757 Vtool_bar_border
= Qinternal_border_width
;
26759 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26760 doc
: /* *Margin around tool-bar buttons in pixels.
26761 If an integer, use that for both horizontal and vertical margins.
26762 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26763 HORZ specifying the horizontal margin, and VERT specifying the
26764 vertical margin. */);
26765 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26767 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26768 doc
: /* *Relief thickness of tool-bar buttons. */);
26769 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26771 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26772 doc
: /* Tool bar style to use.
26774 image - show images only
26775 text - show text only
26776 both - show both, text below image
26777 both-horiz - show text to the right of the image
26778 text-image-horiz - show text to the left of the image
26779 any other - use system default or image if no system default. */);
26780 Vtool_bar_style
= Qnil
;
26782 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26783 doc
: /* *Maximum number of characters a label can have to be shown.
26784 The tool bar style must also show labels for this to have any effect, see
26785 `tool-bar-style'. */);
26786 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26788 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26789 doc
: /* List of functions to call to fontify regions of text.
26790 Each function is called with one argument POS. Functions must
26791 fontify a region starting at POS in the current buffer, and give
26792 fontified regions the property `fontified'. */);
26793 Vfontification_functions
= Qnil
;
26794 Fmake_variable_buffer_local (Qfontification_functions
);
26796 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26797 unibyte_display_via_language_environment
,
26798 doc
: /* *Non-nil means display unibyte text according to language environment.
26799 Specifically, this means that raw bytes in the range 160-255 decimal
26800 are displayed by converting them to the equivalent multibyte characters
26801 according to the current language environment. As a result, they are
26802 displayed according to the current fontset.
26804 Note that this variable affects only how these bytes are displayed,
26805 but does not change the fact they are interpreted as raw bytes. */);
26806 unibyte_display_via_language_environment
= 0;
26808 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26809 doc
: /* *Maximum height for resizing mini-windows.
26810 If a float, it specifies a fraction of the mini-window frame's height.
26811 If an integer, it specifies a number of lines. */);
26812 Vmax_mini_window_height
= make_float (0.25);
26814 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26815 doc
: /* *How to resize mini-windows.
26816 A value of nil means don't automatically resize mini-windows.
26817 A value of t means resize them to fit the text displayed in them.
26818 A value of `grow-only', the default, means let mini-windows grow
26819 only, until their display becomes empty, at which point the windows
26820 go back to their normal size. */);
26821 Vresize_mini_windows
= Qgrow_only
;
26823 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26824 doc
: /* Alist specifying how to blink the cursor off.
26825 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26826 `cursor-type' frame-parameter or variable equals ON-STATE,
26827 comparing using `equal', Emacs uses OFF-STATE to specify
26828 how to blink it off. ON-STATE and OFF-STATE are values for
26829 the `cursor-type' frame parameter.
26831 If a frame's ON-STATE has no entry in this list,
26832 the frame's other specifications determine how to blink the cursor off. */);
26833 Vblink_cursor_alist
= Qnil
;
26835 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26836 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26837 If non-nil, windows are automatically scrolled horizontally to make
26838 point visible. */);
26839 automatic_hscrolling_p
= 1;
26840 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26841 staticpro (&Qauto_hscroll_mode
);
26843 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26844 doc
: /* *How many columns away from the window edge point is allowed to get
26845 before automatic hscrolling will horizontally scroll the window. */);
26846 hscroll_margin
= 5;
26848 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26849 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26850 When point is less than `hscroll-margin' columns from the window
26851 edge, automatic hscrolling will scroll the window by the amount of columns
26852 determined by this variable. If its value is a positive integer, scroll that
26853 many columns. If it's a positive floating-point number, it specifies the
26854 fraction of the window's width to scroll. If it's nil or zero, point will be
26855 centered horizontally after the scroll. Any other value, including negative
26856 numbers, are treated as if the value were zero.
26858 Automatic hscrolling always moves point outside the scroll margin, so if
26859 point was more than scroll step columns inside the margin, the window will
26860 scroll more than the value given by the scroll step.
26862 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26863 and `scroll-right' overrides this variable's effect. */);
26864 Vhscroll_step
= make_number (0);
26866 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26867 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26868 Bind this around calls to `message' to let it take effect. */);
26869 message_truncate_lines
= 0;
26871 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26872 doc
: /* Normal hook run to update the menu bar definitions.
26873 Redisplay runs this hook before it redisplays the menu bar.
26874 This is used to update submenus such as Buffers,
26875 whose contents depend on various data. */);
26876 Vmenu_bar_update_hook
= Qnil
;
26878 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26879 doc
: /* Frame for which we are updating a menu.
26880 The enable predicate for a menu binding should check this variable. */);
26881 Vmenu_updating_frame
= Qnil
;
26883 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26884 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26885 inhibit_menubar_update
= 0;
26887 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26888 doc
: /* Prefix prepended to all continuation lines at display time.
26889 The value may be a string, an image, or a stretch-glyph; it is
26890 interpreted in the same way as the value of a `display' text property.
26892 This variable is overridden by any `wrap-prefix' text or overlay
26895 To add a prefix to non-continuation lines, use `line-prefix'. */);
26896 Vwrap_prefix
= Qnil
;
26897 staticpro (&Qwrap_prefix
);
26898 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26899 Fmake_variable_buffer_local (Qwrap_prefix
);
26901 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26902 doc
: /* Prefix prepended to all non-continuation lines at display time.
26903 The value may be a string, an image, or a stretch-glyph; it is
26904 interpreted in the same way as the value of a `display' text property.
26906 This variable is overridden by any `line-prefix' text or overlay
26909 To add a prefix to continuation lines, use `wrap-prefix'. */);
26910 Vline_prefix
= Qnil
;
26911 staticpro (&Qline_prefix
);
26912 Qline_prefix
= intern_c_string ("line-prefix");
26913 Fmake_variable_buffer_local (Qline_prefix
);
26915 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26916 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26917 inhibit_eval_during_redisplay
= 0;
26919 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26920 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26921 inhibit_free_realized_faces
= 0;
26924 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26925 doc
: /* Inhibit try_window_id display optimization. */);
26926 inhibit_try_window_id
= 0;
26928 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26929 doc
: /* Inhibit try_window_reusing display optimization. */);
26930 inhibit_try_window_reusing
= 0;
26932 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26933 doc
: /* Inhibit try_cursor_movement display optimization. */);
26934 inhibit_try_cursor_movement
= 0;
26935 #endif /* GLYPH_DEBUG */
26937 DEFVAR_INT ("overline-margin", overline_margin
,
26938 doc
: /* *Space between overline and text, in pixels.
26939 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26940 margin to the caracter height. */);
26941 overline_margin
= 2;
26943 DEFVAR_INT ("underline-minimum-offset",
26944 underline_minimum_offset
,
26945 doc
: /* Minimum distance between baseline and underline.
26946 This can improve legibility of underlined text at small font sizes,
26947 particularly when using variable `x-use-underline-position-properties'
26948 with fonts that specify an UNDERLINE_POSITION relatively close to the
26949 baseline. The default value is 1. */);
26950 underline_minimum_offset
= 1;
26952 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26953 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26954 This feature only works when on a window system that can change
26955 cursor shapes. */);
26956 display_hourglass_p
= 1;
26958 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26959 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26960 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26962 hourglass_atimer
= NULL
;
26963 hourglass_shown_p
= 0;
26965 DEFSYM (Qglyphless_char
, "glyphless-char");
26966 DEFSYM (Qhex_code
, "hex-code");
26967 DEFSYM (Qempty_box
, "empty-box");
26968 DEFSYM (Qthin_space
, "thin-space");
26969 DEFSYM (Qzero_width
, "zero-width");
26971 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26972 /* Intern this now in case it isn't already done.
26973 Setting this variable twice is harmless.
26974 But don't staticpro it here--that is done in alloc.c. */
26975 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26976 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26978 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26979 doc
: /* Char-table to control displaying of glyphless characters.
26980 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26981 or one of these symbols:
26982 hex-code: display the hexadecimal code of a character in a box
26983 empty-box: display as an empty box
26984 thin-space: display as 1-pixel width space
26985 zero-width: don't display
26987 It has one extra slot to control the display of a character for which
26988 no font is found. The value of the slot is `hex-code' or `empty-box'.
26989 The default is `empty-box'. */);
26990 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26991 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26996 /* Initialize this module when Emacs starts. */
27001 Lisp_Object root_window
;
27002 struct window
*mini_w
;
27004 current_header_line_height
= current_mode_line_height
= -1;
27006 CHARPOS (this_line_start_pos
) = 0;
27008 mini_w
= XWINDOW (minibuf_window
);
27009 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27011 if (!noninteractive
)
27013 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27016 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27017 set_window_height (root_window
,
27018 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27020 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27021 set_window_height (minibuf_window
, 1, 0);
27023 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27024 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27026 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27027 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27028 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27030 /* The default ellipsis glyphs `...'. */
27031 for (i
= 0; i
< 3; ++i
)
27032 default_invis_vector
[i
] = make_number ('.');
27036 /* Allocate the buffer for frame titles.
27037 Also used for `format-mode-line'. */
27039 mode_line_noprop_buf
= (char *) xmalloc (size
);
27040 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27041 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27042 mode_line_target
= MODE_LINE_DISPLAY
;
27045 help_echo_showing_p
= 0;
27048 /* Since w32 does not support atimers, it defines its own implementation of
27049 the following three functions in w32fns.c. */
27052 /* Platform-independent portion of hourglass implementation. */
27054 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27056 hourglass_started (void)
27058 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27061 /* Cancel a currently active hourglass timer, and start a new one. */
27063 start_hourglass (void)
27065 #if defined (HAVE_WINDOW_SYSTEM)
27067 int secs
, usecs
= 0;
27069 cancel_hourglass ();
27071 if (INTEGERP (Vhourglass_delay
)
27072 && XINT (Vhourglass_delay
) > 0)
27073 secs
= XFASTINT (Vhourglass_delay
);
27074 else if (FLOATP (Vhourglass_delay
)
27075 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27078 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27079 secs
= XFASTINT (tem
);
27080 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27083 secs
= DEFAULT_HOURGLASS_DELAY
;
27085 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27086 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27087 show_hourglass
, NULL
);
27092 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27095 cancel_hourglass (void)
27097 #if defined (HAVE_WINDOW_SYSTEM)
27098 if (hourglass_atimer
)
27100 cancel_atimer (hourglass_atimer
);
27101 hourglass_atimer
= NULL
;
27104 if (hourglass_shown_p
)
27108 #endif /* ! WINDOWSNT */