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 static Lisp_Object Qwindow_text_change_functions
;
322 static Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 static Lisp_Object QCeval
, QCpropertize
;
325 Lisp_Object QCfile
, QCdata
;
326 static Lisp_Object Qfontified
;
327 static Lisp_Object Qgrow_only
;
328 static Lisp_Object Qinhibit_eval_during_redisplay
;
329 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
330 static Lisp_Object Qright_to_left
, Qleft_to_right
;
333 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
336 static Lisp_Object Qarrow
, Qhand
;
339 /* Holds the list (error). */
340 static Lisp_Object list_of_error
;
342 static Lisp_Object Qfontification_functions
;
344 static Lisp_Object Qwrap_prefix
;
345 static Lisp_Object Qline_prefix
;
347 /* Non-nil means don't actually do any redisplay. */
349 Lisp_Object Qinhibit_redisplay
;
351 /* Names of text properties relevant for redisplay. */
353 Lisp_Object Qdisplay
;
355 Lisp_Object Qspace
, QCalign_to
;
356 static Lisp_Object QCrelative_width
, QCrelative_height
;
357 Lisp_Object Qleft_margin
, Qright_margin
;
358 static Lisp_Object Qspace_width
, Qraise
;
359 static Lisp_Object Qslice
;
361 static Lisp_Object Qmargin
, Qpointer
;
362 static Lisp_Object Qline_height
;
364 #ifdef HAVE_WINDOW_SYSTEM
366 /* Test if overflow newline into fringe. Called with iterator IT
367 at or past right window margin, and with IT->current_x set. */
369 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
370 (!NILP (Voverflow_newline_into_fringe) \
371 && FRAME_WINDOW_P ((IT)->f) \
372 && ((IT)->bidi_it.paragraph_dir == R2L \
373 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
374 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
375 && (IT)->current_x == (IT)->last_visible_x \
376 && (IT)->line_wrap != WORD_WRAP)
378 #else /* !HAVE_WINDOW_SYSTEM */
379 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
380 #endif /* HAVE_WINDOW_SYSTEM */
382 /* Test if the display element loaded in IT is a space or tab
383 character. This is used to determine word wrapping. */
385 #define IT_DISPLAYING_WHITESPACE(it) \
386 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
388 /* Name of the face used to highlight trailing whitespace. */
390 static Lisp_Object Qtrailing_whitespace
;
392 /* Name and number of the face used to highlight escape glyphs. */
394 static Lisp_Object Qescape_glyph
;
396 /* Name and number of the face used to highlight non-breaking spaces. */
398 static Lisp_Object Qnobreak_space
;
400 /* The symbol `image' which is the car of the lists used to represent
401 images in Lisp. Also a tool bar style. */
405 /* The image map types. */
407 static Lisp_Object QCpointer
;
408 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
410 /* Tool bar styles */
411 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
413 /* Non-zero means print newline to stdout before next mini-buffer
416 int noninteractive_need_newline
;
418 /* Non-zero means print newline to message log before next message. */
420 static int message_log_need_newline
;
422 /* Three markers that message_dolog uses.
423 It could allocate them itself, but that causes trouble
424 in handling memory-full errors. */
425 static Lisp_Object message_dolog_marker1
;
426 static Lisp_Object message_dolog_marker2
;
427 static Lisp_Object message_dolog_marker3
;
429 /* The buffer position of the first character appearing entirely or
430 partially on the line of the selected window which contains the
431 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
432 redisplay optimization in redisplay_internal. */
434 static struct text_pos this_line_start_pos
;
436 /* Number of characters past the end of the line above, including the
437 terminating newline. */
439 static struct text_pos this_line_end_pos
;
441 /* The vertical positions and the height of this line. */
443 static int this_line_vpos
;
444 static int this_line_y
;
445 static int this_line_pixel_height
;
447 /* X position at which this display line starts. Usually zero;
448 negative if first character is partially visible. */
450 static int this_line_start_x
;
452 /* The smallest character position seen by move_it_* functions as they
453 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
454 hscrolled lines, see display_line. */
456 static struct text_pos this_line_min_pos
;
458 /* Buffer that this_line_.* variables are referring to. */
460 static struct buffer
*this_line_buffer
;
463 /* Values of those variables at last redisplay are stored as
464 properties on `overlay-arrow-position' symbol. However, if
465 Voverlay_arrow_position is a marker, last-arrow-position is its
466 numerical position. */
468 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
470 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
471 properties on a symbol in overlay-arrow-variable-list. */
473 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
475 Lisp_Object Qmenu_bar_update_hook
;
477 /* Nonzero if an overlay arrow has been displayed in this window. */
479 static int overlay_arrow_seen
;
481 /* Number of windows showing the buffer of the selected window (or
482 another buffer with the same base buffer). keyboard.c refers to
487 /* Vector containing glyphs for an ellipsis `...'. */
489 static Lisp_Object default_invis_vector
[3];
491 /* This is the window where the echo area message was displayed. It
492 is always a mini-buffer window, but it may not be the same window
493 currently active as a mini-buffer. */
495 Lisp_Object echo_area_window
;
497 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
498 pushes the current message and the value of
499 message_enable_multibyte on the stack, the function restore_message
500 pops the stack and displays MESSAGE again. */
502 static Lisp_Object Vmessage_stack
;
504 /* Nonzero means multibyte characters were enabled when the echo area
505 message was specified. */
507 static int message_enable_multibyte
;
509 /* Nonzero if we should redraw the mode lines on the next redisplay. */
511 int update_mode_lines
;
513 /* Nonzero if window sizes or contents have changed since last
514 redisplay that finished. */
516 int windows_or_buffers_changed
;
518 /* Nonzero means a frame's cursor type has been changed. */
520 int cursor_type_changed
;
522 /* Nonzero after display_mode_line if %l was used and it displayed a
525 static int line_number_displayed
;
527 /* The name of the *Messages* buffer, a string. */
529 static Lisp_Object Vmessages_buffer_name
;
531 /* Current, index 0, and last displayed echo area message. Either
532 buffers from echo_buffers, or nil to indicate no message. */
534 Lisp_Object echo_area_buffer
[2];
536 /* The buffers referenced from echo_area_buffer. */
538 static Lisp_Object echo_buffer
[2];
540 /* A vector saved used in with_area_buffer to reduce consing. */
542 static Lisp_Object Vwith_echo_area_save_vector
;
544 /* Non-zero means display_echo_area should display the last echo area
545 message again. Set by redisplay_preserve_echo_area. */
547 static int display_last_displayed_message_p
;
549 /* Nonzero if echo area is being used by print; zero if being used by
552 static int message_buf_print
;
554 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556 static Lisp_Object Qinhibit_menubar_update
;
557 static Lisp_Object Qmessage_truncate_lines
;
559 /* Set to 1 in clear_message to make redisplay_internal aware
560 of an emptied echo area. */
562 static int message_cleared_p
;
564 /* A scratch glyph row with contents used for generating truncation
565 glyphs. Also used in direct_output_for_insert. */
567 #define MAX_SCRATCH_GLYPHS 100
568 static struct glyph_row scratch_glyph_row
;
569 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
571 /* Ascent and height of the last line processed by move_it_to. */
573 static int last_max_ascent
, last_height
;
575 /* Non-zero if there's a help-echo in the echo area. */
577 int help_echo_showing_p
;
579 /* If >= 0, computed, exact values of mode-line and header-line height
580 to use in the macros CURRENT_MODE_LINE_HEIGHT and
581 CURRENT_HEADER_LINE_HEIGHT. */
583 int current_mode_line_height
, current_header_line_height
;
585 /* The maximum distance to look ahead for text properties. Values
586 that are too small let us call compute_char_face and similar
587 functions too often which is expensive. Values that are too large
588 let us call compute_char_face and alike too often because we
589 might not be interested in text properties that far away. */
591 #define TEXT_PROP_DISTANCE_LIMIT 100
595 /* Non-zero means print traces of redisplay if compiled with
598 int trace_redisplay_p
;
600 #endif /* GLYPH_DEBUG */
602 #ifdef DEBUG_TRACE_MOVE
603 /* Non-zero means trace with TRACE_MOVE to stderr. */
606 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
608 #define TRACE_MOVE(x) (void) 0
611 static Lisp_Object Qauto_hscroll_mode
;
613 /* Buffer being redisplayed -- for redisplay_window_error. */
615 static struct buffer
*displayed_buffer
;
617 /* Value returned from text property handlers (see below). */
622 HANDLED_RECOMPUTE_PROPS
,
623 HANDLED_OVERLAY_STRING_CONSUMED
,
627 /* A description of text properties that redisplay is interested
632 /* The name of the property. */
635 /* A unique index for the property. */
638 /* A handler function called to set up iterator IT from the property
639 at IT's current position. Value is used to steer handle_stop. */
640 enum prop_handled (*handler
) (struct it
*it
);
643 static enum prop_handled
handle_face_prop (struct it
*);
644 static enum prop_handled
handle_invisible_prop (struct it
*);
645 static enum prop_handled
handle_display_prop (struct it
*);
646 static enum prop_handled
handle_composition_prop (struct it
*);
647 static enum prop_handled
handle_overlay_change (struct it
*);
648 static enum prop_handled
handle_fontified_prop (struct it
*);
650 /* Properties handled by iterators. */
652 static struct props it_props
[] =
654 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
655 /* Handle `face' before `display' because some sub-properties of
656 `display' need to know the face. */
657 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
658 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
659 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
660 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
664 /* Value is the position described by X. If X is a marker, value is
665 the marker_position of X. Otherwise, value is X. */
667 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
669 /* Enumeration returned by some move_it_.* functions internally. */
673 /* Not used. Undefined value. */
676 /* Move ended at the requested buffer position or ZV. */
677 MOVE_POS_MATCH_OR_ZV
,
679 /* Move ended at the requested X pixel position. */
682 /* Move within a line ended at the end of a line that must be
686 /* Move within a line ended at the end of a line that would
687 be displayed truncated. */
690 /* Move within a line ended at a line end. */
694 /* This counter is used to clear the face cache every once in a while
695 in redisplay_internal. It is incremented for each redisplay.
696 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
699 #define CLEAR_FACE_CACHE_COUNT 500
700 static int clear_face_cache_count
;
702 /* Similarly for the image cache. */
704 #ifdef HAVE_WINDOW_SYSTEM
705 #define CLEAR_IMAGE_CACHE_COUNT 101
706 static int clear_image_cache_count
;
708 /* Null glyph slice */
709 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
712 /* Non-zero while redisplay_internal is in progress. */
716 static Lisp_Object Qinhibit_free_realized_faces
;
718 /* If a string, XTread_socket generates an event to display that string.
719 (The display is done in read_char.) */
721 Lisp_Object help_echo_string
;
722 Lisp_Object help_echo_window
;
723 Lisp_Object help_echo_object
;
724 EMACS_INT help_echo_pos
;
726 /* Temporary variable for XTread_socket. */
728 Lisp_Object previous_help_echo_string
;
730 /* Platform-independent portion of hourglass implementation. */
732 /* Non-zero means an hourglass cursor is currently shown. */
733 int hourglass_shown_p
;
735 /* If non-null, an asynchronous timer that, when it expires, displays
736 an hourglass cursor on all frames. */
737 struct atimer
*hourglass_atimer
;
739 /* Name of the face used to display glyphless characters. */
740 Lisp_Object Qglyphless_char
;
742 /* Symbol for the purpose of Vglyphless_char_display. */
743 static Lisp_Object Qglyphless_char_display
;
745 /* Method symbols for Vglyphless_char_display. */
746 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
748 /* Default pixel width of `thin-space' display method. */
749 #define THIN_SPACE_WIDTH 1
751 /* Default number of seconds to wait before displaying an hourglass
753 #define DEFAULT_HOURGLASS_DELAY 1
756 /* Function prototypes. */
758 static void setup_for_ellipsis (struct it
*, int);
759 static void set_iterator_to_next (struct it
*, int);
760 static void mark_window_display_accurate_1 (struct window
*, int);
761 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
762 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
763 static int cursor_row_p (struct glyph_row
*);
764 static int redisplay_mode_lines (Lisp_Object
, int);
765 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
767 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
769 static void handle_line_prefix (struct it
*);
771 static void pint2str (char *, int, EMACS_INT
);
772 static void pint2hrstr (char *, int, EMACS_INT
);
773 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
775 static void reconsider_clip_changes (struct window
*, struct buffer
*);
776 static int text_outside_line_unchanged_p (struct window
*,
777 EMACS_INT
, EMACS_INT
);
778 static void store_mode_line_noprop_char (char);
779 static int store_mode_line_noprop (const char *, int, int);
780 static void handle_stop (struct it
*);
781 static void handle_stop_backwards (struct it
*, EMACS_INT
);
782 static int single_display_spec_intangible_p (Lisp_Object
);
783 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
784 static void ensure_echo_area_buffers (void);
785 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
786 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
787 static int with_echo_area_buffer (struct window
*, int,
788 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
789 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static void clear_garbaged_frames (void);
791 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static void pop_message (void);
793 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
794 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
795 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
796 static int display_echo_area (struct window
*);
797 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
799 static Lisp_Object
unwind_redisplay (Lisp_Object
);
800 static int string_char_and_length (const unsigned char *, int *);
801 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
803 static int compute_window_start_on_continuation_line (struct window
*);
804 static Lisp_Object
safe_eval_handler (Lisp_Object
);
805 static void insert_left_trunc_glyphs (struct it
*);
806 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
808 static void extend_face_to_end_of_line (struct it
*);
809 static int append_space_for_newline (struct it
*, int);
810 static int cursor_row_fully_visible_p (struct window
*, int, int);
811 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
812 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
813 static int trailing_whitespace_p (EMACS_INT
);
814 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
815 static void push_it (struct it
*);
816 static void pop_it (struct it
*);
817 static void sync_frame_with_window_matrix_rows (struct window
*);
818 static void select_frame_for_redisplay (Lisp_Object
);
819 static void redisplay_internal (void);
820 static int echo_area_display (int);
821 static void redisplay_windows (Lisp_Object
);
822 static void redisplay_window (Lisp_Object
, int);
823 static Lisp_Object
redisplay_window_error (Lisp_Object
);
824 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
825 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
826 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
827 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
829 static int update_menu_bar (struct frame
*, int, int);
830 static int try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static int display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
836 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
837 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
838 static void display_menu_bar (struct window
*);
839 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
841 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
842 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
843 static void compute_line_metrics (struct it
*);
844 static void run_redisplay_end_trigger_hook (struct it
*);
845 static int get_overlay_strings (struct it
*, EMACS_INT
);
846 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
847 static void next_overlay_string (struct it
*);
848 static void reseat (struct it
*, struct text_pos
, int);
849 static void reseat_1 (struct it
*, struct text_pos
, int);
850 static void back_to_previous_visible_line_start (struct it
*);
851 void reseat_at_previous_visible_line_start (struct it
*);
852 static void reseat_at_next_visible_line_start (struct it
*, int);
853 static int next_element_from_ellipsis (struct it
*);
854 static int next_element_from_display_vector (struct it
*);
855 static int next_element_from_string (struct it
*);
856 static int next_element_from_c_string (struct it
*);
857 static int next_element_from_buffer (struct it
*);
858 static int next_element_from_composition (struct it
*);
859 static int next_element_from_image (struct it
*);
860 static int next_element_from_stretch (struct it
*);
861 static void load_overlay_strings (struct it
*, EMACS_INT
);
862 static int init_from_display_pos (struct it
*, struct window
*,
863 struct display_pos
*);
864 static void reseat_to_string (struct it
*, const char *,
865 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
866 static int get_next_display_element (struct it
*);
867 static enum move_it_result
868 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
869 enum move_operation_enum
);
870 void move_it_vertically_backward (struct it
*, int);
871 static void init_to_row_start (struct it
*, struct window
*,
873 static int init_to_row_end (struct it
*, struct window
*,
875 static void back_to_previous_line_start (struct it
*);
876 static int forward_to_next_line_start (struct it
*, int *);
877 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
878 Lisp_Object
, EMACS_INT
);
879 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
880 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
881 static EMACS_INT
number_of_chars (const char *, int);
882 static void compute_stop_pos (struct it
*);
883 static void compute_string_pos (struct text_pos
*, struct text_pos
,
885 static int face_before_or_after_it_pos (struct it
*, int);
886 static EMACS_INT
next_overlay_change (EMACS_INT
);
887 static int handle_single_display_spec (struct it
*, Lisp_Object
,
888 Lisp_Object
, Lisp_Object
,
889 struct text_pos
*, int);
890 static int underlying_face_id (struct it
*);
891 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
894 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
895 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
897 #ifdef HAVE_WINDOW_SYSTEM
899 static void x_consider_frame_title (Lisp_Object
);
900 static int tool_bar_lines_needed (struct frame
*, int *);
901 static void update_tool_bar (struct frame
*, int);
902 static void build_desired_tool_bar_string (struct frame
*f
);
903 static int redisplay_tool_bar (struct frame
*);
904 static void display_tool_bar_line (struct it
*, int);
905 static void notice_overwritten_cursor (struct window
*,
908 static void append_stretch_glyph (struct it
*, Lisp_Object
,
912 #endif /* HAVE_WINDOW_SYSTEM */
914 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
915 static int coords_in_mouse_face_p (struct window
*, int, int);
919 /***********************************************************************
920 Window display dimensions
921 ***********************************************************************/
923 /* Return the bottom boundary y-position for text lines in window W.
924 This is the first y position at which a line cannot start.
925 It is relative to the top of the window.
927 This is the height of W minus the height of a mode line, if any. */
930 window_text_bottom_y (struct window
*w
)
932 int height
= WINDOW_TOTAL_HEIGHT (w
);
934 if (WINDOW_WANTS_MODELINE_P (w
))
935 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
939 /* Return the pixel width of display area AREA of window W. AREA < 0
940 means return the total width of W, not including fringes to
941 the left and right of the window. */
944 window_box_width (struct window
*w
, int area
)
946 int cols
= XFASTINT (w
->total_cols
);
949 if (!w
->pseudo_window_p
)
951 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
953 if (area
== TEXT_AREA
)
955 if (INTEGERP (w
->left_margin_cols
))
956 cols
-= XFASTINT (w
->left_margin_cols
);
957 if (INTEGERP (w
->right_margin_cols
))
958 cols
-= XFASTINT (w
->right_margin_cols
);
959 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
961 else if (area
== LEFT_MARGIN_AREA
)
963 cols
= (INTEGERP (w
->left_margin_cols
)
964 ? XFASTINT (w
->left_margin_cols
) : 0);
967 else if (area
== RIGHT_MARGIN_AREA
)
969 cols
= (INTEGERP (w
->right_margin_cols
)
970 ? XFASTINT (w
->right_margin_cols
) : 0);
975 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
979 /* Return the pixel height of the display area of window W, not
980 including mode lines of W, if any. */
983 window_box_height (struct window
*w
)
985 struct frame
*f
= XFRAME (w
->frame
);
986 int height
= WINDOW_TOTAL_HEIGHT (w
);
988 xassert (height
>= 0);
990 /* Note: the code below that determines the mode-line/header-line
991 height is essentially the same as that contained in the macro
992 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
993 the appropriate glyph row has its `mode_line_p' flag set,
994 and if it doesn't, uses estimate_mode_line_height instead. */
996 if (WINDOW_WANTS_MODELINE_P (w
))
998 struct glyph_row
*ml_row
999 = (w
->current_matrix
&& w
->current_matrix
->rows
1000 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1002 if (ml_row
&& ml_row
->mode_line_p
)
1003 height
-= ml_row
->height
;
1005 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1008 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1010 struct glyph_row
*hl_row
1011 = (w
->current_matrix
&& w
->current_matrix
->rows
1012 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1014 if (hl_row
&& hl_row
->mode_line_p
)
1015 height
-= hl_row
->height
;
1017 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1020 /* With a very small font and a mode-line that's taller than
1021 default, we might end up with a negative height. */
1022 return max (0, height
);
1025 /* Return the window-relative coordinate of the left edge of display
1026 area AREA of window W. AREA < 0 means return the left edge of the
1027 whole window, to the right of the left fringe of W. */
1030 window_box_left_offset (struct window
*w
, int area
)
1034 if (w
->pseudo_window_p
)
1037 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1039 if (area
== TEXT_AREA
)
1040 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1041 + window_box_width (w
, LEFT_MARGIN_AREA
));
1042 else if (area
== RIGHT_MARGIN_AREA
)
1043 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1044 + window_box_width (w
, LEFT_MARGIN_AREA
)
1045 + window_box_width (w
, TEXT_AREA
)
1046 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1048 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1049 else if (area
== LEFT_MARGIN_AREA
1050 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1051 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1057 /* Return the window-relative coordinate of the right edge of display
1058 area AREA of window W. AREA < 0 means return the right edge of the
1059 whole window, to the left of the right fringe of W. */
1062 window_box_right_offset (struct window
*w
, int area
)
1064 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1067 /* Return the frame-relative coordinate of the left edge of display
1068 area AREA of window W. AREA < 0 means return the left edge of the
1069 whole window, to the right of the left fringe of W. */
1072 window_box_left (struct window
*w
, int area
)
1074 struct frame
*f
= XFRAME (w
->frame
);
1077 if (w
->pseudo_window_p
)
1078 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1080 x
= (WINDOW_LEFT_EDGE_X (w
)
1081 + window_box_left_offset (w
, area
));
1087 /* Return the frame-relative coordinate of the right edge of display
1088 area AREA of window W. AREA < 0 means return the right edge of the
1089 whole window, to the left of the right fringe of W. */
1092 window_box_right (struct window
*w
, int area
)
1094 return window_box_left (w
, area
) + window_box_width (w
, area
);
1097 /* Get the bounding box of the display area AREA of window W, without
1098 mode lines, in frame-relative coordinates. AREA < 0 means the
1099 whole window, not including the left and right fringes of
1100 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1101 coordinates of the upper-left corner of the box. Return in
1102 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1105 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1106 int *box_width
, int *box_height
)
1109 *box_width
= window_box_width (w
, area
);
1111 *box_height
= window_box_height (w
);
1113 *box_x
= window_box_left (w
, area
);
1116 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1117 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1118 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1123 /* Get the bounding box of the display area AREA of window W, without
1124 mode lines. AREA < 0 means the whole window, not including the
1125 left and right fringe of the window. Return in *TOP_LEFT_X
1126 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1127 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1128 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1132 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1133 int *bottom_right_x
, int *bottom_right_y
)
1135 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1137 *bottom_right_x
+= *top_left_x
;
1138 *bottom_right_y
+= *top_left_y
;
1143 /***********************************************************************
1145 ***********************************************************************/
1147 /* Return the bottom y-position of the line the iterator IT is in.
1148 This can modify IT's settings. */
1151 line_bottom_y (struct it
*it
)
1153 int line_height
= it
->max_ascent
+ it
->max_descent
;
1154 int line_top_y
= it
->current_y
;
1156 if (line_height
== 0)
1159 line_height
= last_height
;
1160 else if (IT_CHARPOS (*it
) < ZV
)
1162 move_it_by_lines (it
, 1);
1163 line_height
= (it
->max_ascent
|| it
->max_descent
1164 ? it
->max_ascent
+ it
->max_descent
1169 struct glyph_row
*row
= it
->glyph_row
;
1171 /* Use the default character height. */
1172 it
->glyph_row
= NULL
;
1173 it
->what
= IT_CHARACTER
;
1176 PRODUCE_GLYPHS (it
);
1177 line_height
= it
->ascent
+ it
->descent
;
1178 it
->glyph_row
= row
;
1182 return line_top_y
+ line_height
;
1186 /* Return 1 if position CHARPOS is visible in window W.
1187 CHARPOS < 0 means return info about WINDOW_END position.
1188 If visible, set *X and *Y to pixel coordinates of top left corner.
1189 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1190 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1193 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1194 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1197 struct text_pos top
;
1199 struct buffer
*old_buffer
= NULL
;
1201 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1204 if (XBUFFER (w
->buffer
) != current_buffer
)
1206 old_buffer
= current_buffer
;
1207 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1210 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1212 /* Compute exact mode line heights. */
1213 if (WINDOW_WANTS_MODELINE_P (w
))
1214 current_mode_line_height
1215 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1216 BVAR (current_buffer
, mode_line_format
));
1218 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1219 current_header_line_height
1220 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1221 BVAR (current_buffer
, header_line_format
));
1223 start_display (&it
, w
, top
);
1224 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1225 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1227 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1229 /* We have reached CHARPOS, or passed it. How the call to
1230 move_it_to can overshoot: (i) If CHARPOS is on invisible
1231 text, move_it_to stops at the end of the invisible text,
1232 after CHARPOS. (ii) If CHARPOS is in a display vector,
1233 move_it_to stops on its last glyph. */
1234 int top_x
= it
.current_x
;
1235 int top_y
= it
.current_y
;
1236 enum it_method it_method
= it
.method
;
1237 /* Calling line_bottom_y may change it.method, it.position, etc. */
1238 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1239 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1241 if (top_y
< window_top_y
)
1242 visible_p
= bottom_y
> window_top_y
;
1243 else if (top_y
< it
.last_visible_y
)
1247 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1249 /* We stopped on the last glyph of a display vector.
1250 Try and recompute. Hack alert! */
1251 if (charpos
< 2 || top
.charpos
>= charpos
)
1252 top_x
= it
.glyph_row
->x
;
1256 start_display (&it2
, w
, top
);
1257 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1258 get_next_display_element (&it2
);
1259 PRODUCE_GLYPHS (&it2
);
1260 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1261 || it2
.current_x
> it2
.last_visible_x
)
1262 top_x
= it
.glyph_row
->x
;
1265 top_x
= it2
.current_x
;
1266 top_y
= it2
.current_y
;
1272 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1273 *rtop
= max (0, window_top_y
- top_y
);
1274 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1275 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1276 - max (top_y
, window_top_y
)));
1285 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1286 move_it_by_lines (&it
, 1);
1287 if (charpos
< IT_CHARPOS (it
)
1288 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1291 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1293 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1294 *rtop
= max (0, -it2
.current_y
);
1295 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1296 - it
.last_visible_y
));
1297 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1299 - max (it2
.current_y
,
1300 WINDOW_HEADER_LINE_HEIGHT (w
))));
1306 set_buffer_internal_1 (old_buffer
);
1308 current_header_line_height
= current_mode_line_height
= -1;
1310 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1311 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1314 /* Debugging code. */
1316 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1317 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1319 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1326 /* Return the next character from STR. Return in *LEN the length of
1327 the character. This is like STRING_CHAR_AND_LENGTH but never
1328 returns an invalid character. If we find one, we return a `?', but
1329 with the length of the invalid character. */
1332 string_char_and_length (const unsigned char *str
, int *len
)
1336 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1337 if (!CHAR_VALID_P (c
, 1))
1338 /* We may not change the length here because other places in Emacs
1339 don't use this function, i.e. they silently accept invalid
1348 /* Given a position POS containing a valid character and byte position
1349 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1351 static struct text_pos
1352 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1354 xassert (STRINGP (string
) && nchars
>= 0);
1356 if (STRING_MULTIBYTE (string
))
1358 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1363 string_char_and_length (p
, &len
);
1366 BYTEPOS (pos
) += len
;
1370 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1376 /* Value is the text position, i.e. character and byte position,
1377 for character position CHARPOS in STRING. */
1379 static INLINE
struct text_pos
1380 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1382 struct text_pos pos
;
1383 xassert (STRINGP (string
));
1384 xassert (charpos
>= 0);
1385 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1390 /* Value is a text position, i.e. character and byte position, for
1391 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1392 means recognize multibyte characters. */
1394 static struct text_pos
1395 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1397 struct text_pos pos
;
1399 xassert (s
!= NULL
);
1400 xassert (charpos
>= 0);
1406 SET_TEXT_POS (pos
, 0, 0);
1409 string_char_and_length ((const unsigned char *) s
, &len
);
1412 BYTEPOS (pos
) += len
;
1416 SET_TEXT_POS (pos
, charpos
, charpos
);
1422 /* Value is the number of characters in C string S. MULTIBYTE_P
1423 non-zero means recognize multibyte characters. */
1426 number_of_chars (const char *s
, int multibyte_p
)
1432 EMACS_INT rest
= strlen (s
);
1434 const unsigned char *p
= (const unsigned char *) s
;
1436 for (nchars
= 0; rest
> 0; ++nchars
)
1438 string_char_and_length (p
, &len
);
1439 rest
-= len
, p
+= len
;
1443 nchars
= strlen (s
);
1449 /* Compute byte position NEWPOS->bytepos corresponding to
1450 NEWPOS->charpos. POS is a known position in string STRING.
1451 NEWPOS->charpos must be >= POS.charpos. */
1454 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1456 xassert (STRINGP (string
));
1457 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1459 if (STRING_MULTIBYTE (string
))
1460 *newpos
= string_pos_nchars_ahead (pos
, string
,
1461 CHARPOS (*newpos
) - CHARPOS (pos
));
1463 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1467 Return an estimation of the pixel height of mode or header lines on
1468 frame F. FACE_ID specifies what line's height to estimate. */
1471 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1473 #ifdef HAVE_WINDOW_SYSTEM
1474 if (FRAME_WINDOW_P (f
))
1476 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1478 /* This function is called so early when Emacs starts that the face
1479 cache and mode line face are not yet initialized. */
1480 if (FRAME_FACE_CACHE (f
))
1482 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1486 height
= FONT_HEIGHT (face
->font
);
1487 if (face
->box_line_width
> 0)
1488 height
+= 2 * face
->box_line_width
;
1499 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1500 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1501 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1502 not force the value into range. */
1505 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1506 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1509 #ifdef HAVE_WINDOW_SYSTEM
1510 if (FRAME_WINDOW_P (f
))
1512 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1513 even for negative values. */
1515 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1517 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1519 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1520 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1523 STORE_NATIVE_RECT (*bounds
,
1524 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1525 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1526 FRAME_COLUMN_WIDTH (f
) - 1,
1527 FRAME_LINE_HEIGHT (f
) - 1);
1533 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1534 pix_x
= FRAME_TOTAL_COLS (f
);
1538 else if (pix_y
> FRAME_LINES (f
))
1539 pix_y
= FRAME_LINES (f
);
1549 /* Find the glyph under window-relative coordinates X/Y in window W.
1550 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1551 strings. Return in *HPOS and *VPOS the row and column number of
1552 the glyph found. Return in *AREA the glyph area containing X.
1553 Value is a pointer to the glyph found or null if X/Y is not on
1554 text, or we can't tell because W's current matrix is not up to
1559 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1560 int *dx
, int *dy
, int *area
)
1562 struct glyph
*glyph
, *end
;
1563 struct glyph_row
*row
= NULL
;
1566 /* Find row containing Y. Give up if some row is not enabled. */
1567 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1569 row
= MATRIX_ROW (w
->current_matrix
, i
);
1570 if (!row
->enabled_p
)
1572 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1579 /* Give up if Y is not in the window. */
1580 if (i
== w
->current_matrix
->nrows
)
1583 /* Get the glyph area containing X. */
1584 if (w
->pseudo_window_p
)
1591 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1593 *area
= LEFT_MARGIN_AREA
;
1594 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1596 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1599 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1603 *area
= RIGHT_MARGIN_AREA
;
1604 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1608 /* Find glyph containing X. */
1609 glyph
= row
->glyphs
[*area
];
1610 end
= glyph
+ row
->used
[*area
];
1612 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1614 x
-= glyph
->pixel_width
;
1624 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1627 *hpos
= glyph
- row
->glyphs
[*area
];
1631 /* Convert frame-relative x/y to coordinates relative to window W.
1632 Takes pseudo-windows into account. */
1635 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1637 if (w
->pseudo_window_p
)
1639 /* A pseudo-window is always full-width, and starts at the
1640 left edge of the frame, plus a frame border. */
1641 struct frame
*f
= XFRAME (w
->frame
);
1642 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1643 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1647 *x
-= WINDOW_LEFT_EDGE_X (w
);
1648 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1652 #ifdef HAVE_WINDOW_SYSTEM
1655 Return in RECTS[] at most N clipping rectangles for glyph string S.
1656 Return the number of stored rectangles. */
1659 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1666 if (s
->row
->full_width_p
)
1668 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1669 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1670 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1672 /* Unless displaying a mode or menu bar line, which are always
1673 fully visible, clip to the visible part of the row. */
1674 if (s
->w
->pseudo_window_p
)
1675 r
.height
= s
->row
->visible_height
;
1677 r
.height
= s
->height
;
1681 /* This is a text line that may be partially visible. */
1682 r
.x
= window_box_left (s
->w
, s
->area
);
1683 r
.width
= window_box_width (s
->w
, s
->area
);
1684 r
.height
= s
->row
->visible_height
;
1688 if (r
.x
< s
->clip_head
->x
)
1690 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1691 r
.width
-= s
->clip_head
->x
- r
.x
;
1694 r
.x
= s
->clip_head
->x
;
1697 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1699 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1700 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1705 /* If S draws overlapping rows, it's sufficient to use the top and
1706 bottom of the window for clipping because this glyph string
1707 intentionally draws over other lines. */
1708 if (s
->for_overlaps
)
1710 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1711 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1713 /* Alas, the above simple strategy does not work for the
1714 environments with anti-aliased text: if the same text is
1715 drawn onto the same place multiple times, it gets thicker.
1716 If the overlap we are processing is for the erased cursor, we
1717 take the intersection with the rectagle of the cursor. */
1718 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1720 XRectangle rc
, r_save
= r
;
1722 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1723 rc
.y
= s
->w
->phys_cursor
.y
;
1724 rc
.width
= s
->w
->phys_cursor_width
;
1725 rc
.height
= s
->w
->phys_cursor_height
;
1727 x_intersect_rectangles (&r_save
, &rc
, &r
);
1732 /* Don't use S->y for clipping because it doesn't take partially
1733 visible lines into account. For example, it can be negative for
1734 partially visible lines at the top of a window. */
1735 if (!s
->row
->full_width_p
1736 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1737 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1739 r
.y
= max (0, s
->row
->y
);
1742 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1744 /* If drawing the cursor, don't let glyph draw outside its
1745 advertised boundaries. Cleartype does this under some circumstances. */
1746 if (s
->hl
== DRAW_CURSOR
)
1748 struct glyph
*glyph
= s
->first_glyph
;
1753 r
.width
-= s
->x
- r
.x
;
1756 r
.width
= min (r
.width
, glyph
->pixel_width
);
1758 /* If r.y is below window bottom, ensure that we still see a cursor. */
1759 height
= min (glyph
->ascent
+ glyph
->descent
,
1760 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1761 max_y
= window_text_bottom_y (s
->w
) - height
;
1762 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1763 if (s
->ybase
- glyph
->ascent
> max_y
)
1770 /* Don't draw cursor glyph taller than our actual glyph. */
1771 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1772 if (height
< r
.height
)
1774 max_y
= r
.y
+ r
.height
;
1775 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1776 r
.height
= min (max_y
- r
.y
, height
);
1783 XRectangle r_save
= r
;
1785 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1789 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1790 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1792 #ifdef CONVERT_FROM_XRECT
1793 CONVERT_FROM_XRECT (r
, *rects
);
1801 /* If we are processing overlapping and allowed to return
1802 multiple clipping rectangles, we exclude the row of the glyph
1803 string from the clipping rectangle. This is to avoid drawing
1804 the same text on the environment with anti-aliasing. */
1805 #ifdef CONVERT_FROM_XRECT
1808 XRectangle
*rs
= rects
;
1810 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1812 if (s
->for_overlaps
& OVERLAPS_PRED
)
1815 if (r
.y
+ r
.height
> row_y
)
1818 rs
[i
].height
= row_y
- r
.y
;
1824 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1827 if (r
.y
< row_y
+ s
->row
->visible_height
)
1829 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1831 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1832 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1841 #ifdef CONVERT_FROM_XRECT
1842 for (i
= 0; i
< n
; i
++)
1843 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1850 Return in *NR the clipping rectangle for glyph string S. */
1853 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1855 get_glyph_string_clip_rects (s
, nr
, 1);
1860 Return the position and height of the phys cursor in window W.
1861 Set w->phys_cursor_width to width of phys cursor.
1865 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1866 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1868 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1869 int x
, y
, wd
, h
, h0
, y0
;
1871 /* Compute the width of the rectangle to draw. If on a stretch
1872 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1873 rectangle as wide as the glyph, but use a canonical character
1875 wd
= glyph
->pixel_width
- 1;
1876 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1880 x
= w
->phys_cursor
.x
;
1887 if (glyph
->type
== STRETCH_GLYPH
1888 && !x_stretch_cursor_p
)
1889 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1890 w
->phys_cursor_width
= wd
;
1892 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1894 /* If y is below window bottom, ensure that we still see a cursor. */
1895 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1897 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1898 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1900 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1903 h
= max (h
- (y0
- y
) + 1, h0
);
1908 y0
= window_text_bottom_y (w
) - h0
;
1916 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1917 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1922 * Remember which glyph the mouse is over.
1926 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1930 struct glyph_row
*r
, *gr
, *end_row
;
1931 enum window_part part
;
1932 enum glyph_row_area area
;
1933 int x
, y
, width
, height
;
1935 /* Try to determine frame pixel position and size of the glyph under
1936 frame pixel coordinates X/Y on frame F. */
1938 if (!f
->glyphs_initialized_p
1939 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1942 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1943 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1947 w
= XWINDOW (window
);
1948 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1949 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1951 x
= window_relative_x_coord (w
, part
, gx
);
1952 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1954 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1955 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1957 if (w
->pseudo_window_p
)
1960 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1966 case ON_LEFT_MARGIN
:
1967 area
= LEFT_MARGIN_AREA
;
1970 case ON_RIGHT_MARGIN
:
1971 area
= RIGHT_MARGIN_AREA
;
1974 case ON_HEADER_LINE
:
1976 gr
= (part
== ON_HEADER_LINE
1977 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1978 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
1981 goto text_glyph_row_found
;
1988 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
1989 if (r
->y
+ r
->height
> y
)
1995 text_glyph_row_found
:
1998 struct glyph
*g
= gr
->glyphs
[area
];
1999 struct glyph
*end
= g
+ gr
->used
[area
];
2001 height
= gr
->height
;
2002 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2003 if (gx
+ g
->pixel_width
> x
)
2008 if (g
->type
== IMAGE_GLYPH
)
2010 /* Don't remember when mouse is over image, as
2011 image may have hot-spots. */
2012 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2015 width
= g
->pixel_width
;
2019 /* Use nominal char spacing at end of line. */
2021 gx
+= (x
/ width
) * width
;
2024 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2025 gx
+= window_box_left_offset (w
, area
);
2029 /* Use nominal line height at end of window. */
2030 gx
= (x
/ width
) * width
;
2032 gy
+= (y
/ height
) * height
;
2036 case ON_LEFT_FRINGE
:
2037 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2038 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2039 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2040 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2043 case ON_RIGHT_FRINGE
:
2044 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2045 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2046 : window_box_right_offset (w
, TEXT_AREA
));
2047 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2051 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2053 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2054 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2055 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2057 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2061 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2062 if (r
->y
+ r
->height
> y
)
2069 height
= gr
->height
;
2072 /* Use nominal line height at end of window. */
2074 gy
+= (y
/ height
) * height
;
2081 /* If there is no glyph under the mouse, then we divide the screen
2082 into a grid of the smallest glyph in the frame, and use that
2085 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2086 round down even for negative values. */
2092 gx
= (gx
/ width
) * width
;
2093 gy
= (gy
/ height
) * height
;
2098 gx
+= WINDOW_LEFT_EDGE_X (w
);
2099 gy
+= WINDOW_TOP_EDGE_Y (w
);
2102 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2104 /* Visible feedback for debugging. */
2107 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2108 f
->output_data
.x
->normal_gc
,
2109 gx
, gy
, width
, height
);
2115 #endif /* HAVE_WINDOW_SYSTEM */
2118 /***********************************************************************
2119 Lisp form evaluation
2120 ***********************************************************************/
2122 /* Error handler for safe_eval and safe_call. */
2125 safe_eval_handler (Lisp_Object arg
)
2127 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2132 /* Evaluate SEXPR and return the result, or nil if something went
2133 wrong. Prevent redisplay during the evaluation. */
2135 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2136 Return the result, or nil if something went wrong. Prevent
2137 redisplay during the evaluation. */
2140 safe_call (size_t nargs
, Lisp_Object
*args
)
2144 if (inhibit_eval_during_redisplay
)
2148 int count
= SPECPDL_INDEX ();
2149 struct gcpro gcpro1
;
2152 gcpro1
.nvars
= nargs
;
2153 specbind (Qinhibit_redisplay
, Qt
);
2154 /* Use Qt to ensure debugger does not run,
2155 so there is no possibility of wanting to redisplay. */
2156 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2159 val
= unbind_to (count
, val
);
2166 /* Call function FN with one argument ARG.
2167 Return the result, or nil if something went wrong. */
2170 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2172 Lisp_Object args
[2];
2175 return safe_call (2, args
);
2178 static Lisp_Object Qeval
;
2181 safe_eval (Lisp_Object sexpr
)
2183 return safe_call1 (Qeval
, sexpr
);
2186 /* Call function FN with one argument ARG.
2187 Return the result, or nil if something went wrong. */
2190 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2192 Lisp_Object args
[3];
2196 return safe_call (3, args
);
2201 /***********************************************************************
2203 ***********************************************************************/
2207 /* Define CHECK_IT to perform sanity checks on iterators.
2208 This is for debugging. It is too slow to do unconditionally. */
2214 if (it
->method
== GET_FROM_STRING
)
2216 xassert (STRINGP (it
->string
));
2217 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2221 xassert (IT_STRING_CHARPOS (*it
) < 0);
2222 if (it
->method
== GET_FROM_BUFFER
)
2224 /* Check that character and byte positions agree. */
2225 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2230 xassert (it
->current
.dpvec_index
>= 0);
2232 xassert (it
->current
.dpvec_index
< 0);
2235 #define CHECK_IT(IT) check_it ((IT))
2239 #define CHECK_IT(IT) (void) 0
2246 /* Check that the window end of window W is what we expect it
2247 to be---the last row in the current matrix displaying text. */
2250 check_window_end (w
)
2253 if (!MINI_WINDOW_P (w
)
2254 && !NILP (w
->window_end_valid
))
2256 struct glyph_row
*row
;
2257 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2258 XFASTINT (w
->window_end_vpos
)),
2260 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2261 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2265 #define CHECK_WINDOW_END(W) check_window_end ((W))
2267 #else /* not GLYPH_DEBUG */
2269 #define CHECK_WINDOW_END(W) (void) 0
2271 #endif /* not GLYPH_DEBUG */
2275 /***********************************************************************
2276 Iterator initialization
2277 ***********************************************************************/
2279 /* Initialize IT for displaying current_buffer in window W, starting
2280 at character position CHARPOS. CHARPOS < 0 means that no buffer
2281 position is specified which is useful when the iterator is assigned
2282 a position later. BYTEPOS is the byte position corresponding to
2283 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2285 If ROW is not null, calls to produce_glyphs with IT as parameter
2286 will produce glyphs in that row.
2288 BASE_FACE_ID is the id of a base face to use. It must be one of
2289 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2290 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2291 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2293 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2294 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2295 will be initialized to use the corresponding mode line glyph row of
2296 the desired matrix of W. */
2299 init_iterator (struct it
*it
, struct window
*w
,
2300 EMACS_INT charpos
, EMACS_INT bytepos
,
2301 struct glyph_row
*row
, enum face_id base_face_id
)
2303 int highlight_region_p
;
2304 enum face_id remapped_base_face_id
= base_face_id
;
2306 /* Some precondition checks. */
2307 xassert (w
!= NULL
&& it
!= NULL
);
2308 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2311 /* If face attributes have been changed since the last redisplay,
2312 free realized faces now because they depend on face definitions
2313 that might have changed. Don't free faces while there might be
2314 desired matrices pending which reference these faces. */
2315 if (face_change_count
&& !inhibit_free_realized_faces
)
2317 face_change_count
= 0;
2318 free_all_realized_faces (Qnil
);
2321 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2322 if (! NILP (Vface_remapping_alist
))
2323 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2325 /* Use one of the mode line rows of W's desired matrix if
2329 if (base_face_id
== MODE_LINE_FACE_ID
2330 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2331 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2332 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2333 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2337 memset (it
, 0, sizeof *it
);
2338 it
->current
.overlay_string_index
= -1;
2339 it
->current
.dpvec_index
= -1;
2340 it
->base_face_id
= remapped_base_face_id
;
2342 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2344 /* The window in which we iterate over current_buffer: */
2345 XSETWINDOW (it
->window
, w
);
2347 it
->f
= XFRAME (w
->frame
);
2351 /* Extra space between lines (on window systems only). */
2352 if (base_face_id
== DEFAULT_FACE_ID
2353 && FRAME_WINDOW_P (it
->f
))
2355 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2356 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2357 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2358 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2359 * FRAME_LINE_HEIGHT (it
->f
));
2360 else if (it
->f
->extra_line_spacing
> 0)
2361 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2362 it
->max_extra_line_spacing
= 0;
2365 /* If realized faces have been removed, e.g. because of face
2366 attribute changes of named faces, recompute them. When running
2367 in batch mode, the face cache of the initial frame is null. If
2368 we happen to get called, make a dummy face cache. */
2369 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2370 init_frame_faces (it
->f
);
2371 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2372 recompute_basic_faces (it
->f
);
2374 /* Current value of the `slice', `space-width', and 'height' properties. */
2375 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2376 it
->space_width
= Qnil
;
2377 it
->font_height
= Qnil
;
2378 it
->override_ascent
= -1;
2380 /* Are control characters displayed as `^C'? */
2381 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2383 /* -1 means everything between a CR and the following line end
2384 is invisible. >0 means lines indented more than this value are
2386 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2387 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2388 : (!NILP (BVAR (current_buffer
, selective_display
))
2390 it
->selective_display_ellipsis_p
2391 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2393 /* Display table to use. */
2394 it
->dp
= window_display_table (w
);
2396 /* Are multibyte characters enabled in current_buffer? */
2397 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2399 /* Do we need to reorder bidirectional text? Not if this is a
2400 unibyte buffer: by definition, none of the single-byte characters
2401 are strong R2L, so no reordering is needed. And bidi.c doesn't
2402 support unibyte buffers anyway. */
2404 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2406 /* Non-zero if we should highlight the region. */
2408 = (!NILP (Vtransient_mark_mode
)
2409 && !NILP (BVAR (current_buffer
, mark_active
))
2410 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2412 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2413 start and end of a visible region in window IT->w. Set both to
2414 -1 to indicate no region. */
2415 if (highlight_region_p
2416 /* Maybe highlight only in selected window. */
2417 && (/* Either show region everywhere. */
2418 highlight_nonselected_windows
2419 /* Or show region in the selected window. */
2420 || w
== XWINDOW (selected_window
)
2421 /* Or show the region if we are in the mini-buffer and W is
2422 the window the mini-buffer refers to. */
2423 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2424 && WINDOWP (minibuf_selected_window
)
2425 && w
== XWINDOW (minibuf_selected_window
))))
2427 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2428 it
->region_beg_charpos
= min (PT
, markpos
);
2429 it
->region_end_charpos
= max (PT
, markpos
);
2432 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2434 /* Get the position at which the redisplay_end_trigger hook should
2435 be run, if it is to be run at all. */
2436 if (MARKERP (w
->redisplay_end_trigger
)
2437 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2438 it
->redisplay_end_trigger_charpos
2439 = marker_position (w
->redisplay_end_trigger
);
2440 else if (INTEGERP (w
->redisplay_end_trigger
))
2441 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2443 /* Correct bogus values of tab_width. */
2444 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2445 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2448 /* Are lines in the display truncated? */
2449 if (base_face_id
!= DEFAULT_FACE_ID
2450 || XINT (it
->w
->hscroll
)
2451 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2452 && ((!NILP (Vtruncate_partial_width_windows
)
2453 && !INTEGERP (Vtruncate_partial_width_windows
))
2454 || (INTEGERP (Vtruncate_partial_width_windows
)
2455 && (WINDOW_TOTAL_COLS (it
->w
)
2456 < XINT (Vtruncate_partial_width_windows
))))))
2457 it
->line_wrap
= TRUNCATE
;
2458 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2459 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2460 ? WINDOW_WRAP
: WORD_WRAP
;
2462 it
->line_wrap
= TRUNCATE
;
2464 /* Get dimensions of truncation and continuation glyphs. These are
2465 displayed as fringe bitmaps under X, so we don't need them for such
2467 if (!FRAME_WINDOW_P (it
->f
))
2469 if (it
->line_wrap
== TRUNCATE
)
2471 /* We will need the truncation glyph. */
2472 xassert (it
->glyph_row
== NULL
);
2473 produce_special_glyphs (it
, IT_TRUNCATION
);
2474 it
->truncation_pixel_width
= it
->pixel_width
;
2478 /* We will need the continuation glyph. */
2479 xassert (it
->glyph_row
== NULL
);
2480 produce_special_glyphs (it
, IT_CONTINUATION
);
2481 it
->continuation_pixel_width
= it
->pixel_width
;
2484 /* Reset these values to zero because the produce_special_glyphs
2485 above has changed them. */
2486 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2487 it
->phys_ascent
= it
->phys_descent
= 0;
2490 /* Set this after getting the dimensions of truncation and
2491 continuation glyphs, so that we don't produce glyphs when calling
2492 produce_special_glyphs, above. */
2493 it
->glyph_row
= row
;
2494 it
->area
= TEXT_AREA
;
2496 /* Forget any previous info about this row being reversed. */
2498 it
->glyph_row
->reversed_p
= 0;
2500 /* Get the dimensions of the display area. The display area
2501 consists of the visible window area plus a horizontally scrolled
2502 part to the left of the window. All x-values are relative to the
2503 start of this total display area. */
2504 if (base_face_id
!= DEFAULT_FACE_ID
)
2506 /* Mode lines, menu bar in terminal frames. */
2507 it
->first_visible_x
= 0;
2508 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2513 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2514 it
->last_visible_x
= (it
->first_visible_x
2515 + window_box_width (w
, TEXT_AREA
));
2517 /* If we truncate lines, leave room for the truncator glyph(s) at
2518 the right margin. Otherwise, leave room for the continuation
2519 glyph(s). Truncation and continuation glyphs are not inserted
2520 for window-based redisplay. */
2521 if (!FRAME_WINDOW_P (it
->f
))
2523 if (it
->line_wrap
== TRUNCATE
)
2524 it
->last_visible_x
-= it
->truncation_pixel_width
;
2526 it
->last_visible_x
-= it
->continuation_pixel_width
;
2529 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2530 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2533 /* Leave room for a border glyph. */
2534 if (!FRAME_WINDOW_P (it
->f
)
2535 && !WINDOW_RIGHTMOST_P (it
->w
))
2536 it
->last_visible_x
-= 1;
2538 it
->last_visible_y
= window_text_bottom_y (w
);
2540 /* For mode lines and alike, arrange for the first glyph having a
2541 left box line if the face specifies a box. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2546 it
->face_id
= remapped_base_face_id
;
2548 /* If we have a boxed mode line, make the first character appear
2549 with a left box line. */
2550 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2551 if (face
->box
!= FACE_NO_BOX
)
2552 it
->start_of_box_run_p
= 1;
2555 /* If we are to reorder bidirectional text, init the bidi
2559 /* Note the paragraph direction that this buffer wants to
2561 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2562 it
->paragraph_embedding
= L2R
;
2563 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2564 it
->paragraph_embedding
= R2L
;
2566 it
->paragraph_embedding
= NEUTRAL_DIR
;
2567 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2570 /* If a buffer position was specified, set the iterator there,
2571 getting overlays and face properties from that position. */
2572 if (charpos
>= BUF_BEG (current_buffer
))
2574 it
->end_charpos
= ZV
;
2576 IT_CHARPOS (*it
) = charpos
;
2578 /* Compute byte position if not specified. */
2579 if (bytepos
< charpos
)
2580 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2582 IT_BYTEPOS (*it
) = bytepos
;
2584 it
->start
= it
->current
;
2586 /* Compute faces etc. */
2587 reseat (it
, it
->current
.pos
, 1);
2594 /* Initialize IT for the display of window W with window start POS. */
2597 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2599 struct glyph_row
*row
;
2600 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2602 row
= w
->desired_matrix
->rows
+ first_vpos
;
2603 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2604 it
->first_vpos
= first_vpos
;
2606 /* Don't reseat to previous visible line start if current start
2607 position is in a string or image. */
2608 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2610 int start_at_line_beg_p
;
2611 int first_y
= it
->current_y
;
2613 /* If window start is not at a line start, skip forward to POS to
2614 get the correct continuation lines width. */
2615 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2616 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2617 if (!start_at_line_beg_p
)
2621 reseat_at_previous_visible_line_start (it
);
2622 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2624 new_x
= it
->current_x
+ it
->pixel_width
;
2626 /* If lines are continued, this line may end in the middle
2627 of a multi-glyph character (e.g. a control character
2628 displayed as \003, or in the middle of an overlay
2629 string). In this case move_it_to above will not have
2630 taken us to the start of the continuation line but to the
2631 end of the continued line. */
2632 if (it
->current_x
> 0
2633 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2634 && (/* And glyph doesn't fit on the line. */
2635 new_x
> it
->last_visible_x
2636 /* Or it fits exactly and we're on a window
2638 || (new_x
== it
->last_visible_x
2639 && FRAME_WINDOW_P (it
->f
))))
2641 if (it
->current
.dpvec_index
>= 0
2642 || it
->current
.overlay_string_index
>= 0)
2644 set_iterator_to_next (it
, 1);
2645 move_it_in_display_line_to (it
, -1, -1, 0);
2648 it
->continuation_lines_width
+= it
->current_x
;
2651 /* We're starting a new display line, not affected by the
2652 height of the continued line, so clear the appropriate
2653 fields in the iterator structure. */
2654 it
->max_ascent
= it
->max_descent
= 0;
2655 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2657 it
->current_y
= first_y
;
2659 it
->current_x
= it
->hpos
= 0;
2665 /* Return 1 if POS is a position in ellipses displayed for invisible
2666 text. W is the window we display, for text property lookup. */
2669 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2671 Lisp_Object prop
, window
;
2673 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2675 /* If POS specifies a position in a display vector, this might
2676 be for an ellipsis displayed for invisible text. We won't
2677 get the iterator set up for delivering that ellipsis unless
2678 we make sure that it gets aware of the invisible text. */
2679 if (pos
->dpvec_index
>= 0
2680 && pos
->overlay_string_index
< 0
2681 && CHARPOS (pos
->string_pos
) < 0
2683 && (XSETWINDOW (window
, w
),
2684 prop
= Fget_char_property (make_number (charpos
),
2685 Qinvisible
, window
),
2686 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2688 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2690 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2697 /* Initialize IT for stepping through current_buffer in window W,
2698 starting at position POS that includes overlay string and display
2699 vector/ control character translation position information. Value
2700 is zero if there are overlay strings with newlines at POS. */
2703 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2705 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2706 int i
, overlay_strings_with_newlines
= 0;
2708 /* If POS specifies a position in a display vector, this might
2709 be for an ellipsis displayed for invisible text. We won't
2710 get the iterator set up for delivering that ellipsis unless
2711 we make sure that it gets aware of the invisible text. */
2712 if (in_ellipses_for_invisible_text_p (pos
, w
))
2718 /* Keep in mind: the call to reseat in init_iterator skips invisible
2719 text, so we might end up at a position different from POS. This
2720 is only a problem when POS is a row start after a newline and an
2721 overlay starts there with an after-string, and the overlay has an
2722 invisible property. Since we don't skip invisible text in
2723 display_line and elsewhere immediately after consuming the
2724 newline before the row start, such a POS will not be in a string,
2725 but the call to init_iterator below will move us to the
2727 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2729 /* This only scans the current chunk -- it should scan all chunks.
2730 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2731 to 16 in 22.1 to make this a lesser problem. */
2732 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2734 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2735 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2737 while (s
< e
&& *s
!= '\n')
2742 overlay_strings_with_newlines
= 1;
2747 /* If position is within an overlay string, set up IT to the right
2749 if (pos
->overlay_string_index
>= 0)
2753 /* If the first overlay string happens to have a `display'
2754 property for an image, the iterator will be set up for that
2755 image, and we have to undo that setup first before we can
2756 correct the overlay string index. */
2757 if (it
->method
== GET_FROM_IMAGE
)
2760 /* We already have the first chunk of overlay strings in
2761 IT->overlay_strings. Load more until the one for
2762 pos->overlay_string_index is in IT->overlay_strings. */
2763 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2765 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2766 it
->current
.overlay_string_index
= 0;
2769 load_overlay_strings (it
, 0);
2770 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2774 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2775 relative_index
= (it
->current
.overlay_string_index
2776 % OVERLAY_STRING_CHUNK_SIZE
);
2777 it
->string
= it
->overlay_strings
[relative_index
];
2778 xassert (STRINGP (it
->string
));
2779 it
->current
.string_pos
= pos
->string_pos
;
2780 it
->method
= GET_FROM_STRING
;
2783 if (CHARPOS (pos
->string_pos
) >= 0)
2785 /* Recorded position is not in an overlay string, but in another
2786 string. This can only be a string from a `display' property.
2787 IT should already be filled with that string. */
2788 it
->current
.string_pos
= pos
->string_pos
;
2789 xassert (STRINGP (it
->string
));
2792 /* Restore position in display vector translations, control
2793 character translations or ellipses. */
2794 if (pos
->dpvec_index
>= 0)
2796 if (it
->dpvec
== NULL
)
2797 get_next_display_element (it
);
2798 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2799 it
->current
.dpvec_index
= pos
->dpvec_index
;
2803 return !overlay_strings_with_newlines
;
2807 /* Initialize IT for stepping through current_buffer in window W
2808 starting at ROW->start. */
2811 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2813 init_from_display_pos (it
, w
, &row
->start
);
2814 it
->start
= row
->start
;
2815 it
->continuation_lines_width
= row
->continuation_lines_width
;
2820 /* Initialize IT for stepping through current_buffer in window W
2821 starting in the line following ROW, i.e. starting at ROW->end.
2822 Value is zero if there are overlay strings with newlines at ROW's
2826 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2830 if (init_from_display_pos (it
, w
, &row
->end
))
2832 if (row
->continued_p
)
2833 it
->continuation_lines_width
2834 = row
->continuation_lines_width
+ row
->pixel_width
;
2845 /***********************************************************************
2847 ***********************************************************************/
2849 /* Called when IT reaches IT->stop_charpos. Handle text property and
2850 overlay changes. Set IT->stop_charpos to the next position where
2854 handle_stop (struct it
*it
)
2856 enum prop_handled handled
;
2857 int handle_overlay_change_p
;
2861 it
->current
.dpvec_index
= -1;
2862 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2863 it
->ignore_overlay_strings_at_pos_p
= 0;
2866 /* Use face of preceding text for ellipsis (if invisible) */
2867 if (it
->selective_display_ellipsis_p
)
2868 it
->saved_face_id
= it
->face_id
;
2872 handled
= HANDLED_NORMALLY
;
2874 /* Call text property handlers. */
2875 for (p
= it_props
; p
->handler
; ++p
)
2877 handled
= p
->handler (it
);
2879 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2881 else if (handled
== HANDLED_RETURN
)
2883 /* We still want to show before and after strings from
2884 overlays even if the actual buffer text is replaced. */
2885 if (!handle_overlay_change_p
2887 || !get_overlay_strings_1 (it
, 0, 0))
2890 setup_for_ellipsis (it
, 0);
2891 /* When handling a display spec, we might load an
2892 empty string. In that case, discard it here. We
2893 used to discard it in handle_single_display_spec,
2894 but that causes get_overlay_strings_1, above, to
2895 ignore overlay strings that we must check. */
2896 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2900 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2904 it
->ignore_overlay_strings_at_pos_p
= 1;
2905 it
->string_from_display_prop_p
= 0;
2906 handle_overlay_change_p
= 0;
2908 handled
= HANDLED_RECOMPUTE_PROPS
;
2911 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2912 handle_overlay_change_p
= 0;
2915 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2917 /* Don't check for overlay strings below when set to deliver
2918 characters from a display vector. */
2919 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2920 handle_overlay_change_p
= 0;
2922 /* Handle overlay changes.
2923 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2924 if it finds overlays. */
2925 if (handle_overlay_change_p
)
2926 handled
= handle_overlay_change (it
);
2931 setup_for_ellipsis (it
, 0);
2935 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2937 /* Determine where to stop next. */
2938 if (handled
== HANDLED_NORMALLY
)
2939 compute_stop_pos (it
);
2943 /* Compute IT->stop_charpos from text property and overlay change
2944 information for IT's current position. */
2947 compute_stop_pos (struct it
*it
)
2949 register INTERVAL iv
, next_iv
;
2950 Lisp_Object object
, limit
, position
;
2951 EMACS_INT charpos
, bytepos
;
2953 /* If nowhere else, stop at the end. */
2954 it
->stop_charpos
= it
->end_charpos
;
2956 if (STRINGP (it
->string
))
2958 /* Strings are usually short, so don't limit the search for
2960 object
= it
->string
;
2962 charpos
= IT_STRING_CHARPOS (*it
);
2963 bytepos
= IT_STRING_BYTEPOS (*it
);
2969 /* If next overlay change is in front of the current stop pos
2970 (which is IT->end_charpos), stop there. Note: value of
2971 next_overlay_change is point-max if no overlay change
2973 charpos
= IT_CHARPOS (*it
);
2974 bytepos
= IT_BYTEPOS (*it
);
2975 pos
= next_overlay_change (charpos
);
2976 if (pos
< it
->stop_charpos
)
2977 it
->stop_charpos
= pos
;
2979 /* If showing the region, we have to stop at the region
2980 start or end because the face might change there. */
2981 if (it
->region_beg_charpos
> 0)
2983 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2984 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2985 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2986 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2989 /* Set up variables for computing the stop position from text
2990 property changes. */
2991 XSETBUFFER (object
, current_buffer
);
2992 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2995 /* Get the interval containing IT's position. Value is a null
2996 interval if there isn't such an interval. */
2997 position
= make_number (charpos
);
2998 iv
= validate_interval_range (object
, &position
, &position
, 0);
2999 if (!NULL_INTERVAL_P (iv
))
3001 Lisp_Object values_here
[LAST_PROP_IDX
];
3004 /* Get properties here. */
3005 for (p
= it_props
; p
->handler
; ++p
)
3006 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3008 /* Look for an interval following iv that has different
3010 for (next_iv
= next_interval (iv
);
3011 (!NULL_INTERVAL_P (next_iv
)
3013 || XFASTINT (limit
) > next_iv
->position
));
3014 next_iv
= next_interval (next_iv
))
3016 for (p
= it_props
; p
->handler
; ++p
)
3018 Lisp_Object new_value
;
3020 new_value
= textget (next_iv
->plist
, *p
->name
);
3021 if (!EQ (values_here
[p
->idx
], new_value
))
3029 if (!NULL_INTERVAL_P (next_iv
))
3031 if (INTEGERP (limit
)
3032 && next_iv
->position
>= XFASTINT (limit
))
3033 /* No text property change up to limit. */
3034 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3036 /* Text properties change in next_iv. */
3037 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3041 if (it
->cmp_it
.id
< 0)
3043 EMACS_INT stoppos
= it
->end_charpos
;
3045 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3047 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3048 stoppos
, it
->string
);
3051 xassert (STRINGP (it
->string
)
3052 || (it
->stop_charpos
>= BEGV
3053 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3057 /* Return the position of the next overlay change after POS in
3058 current_buffer. Value is point-max if no overlay change
3059 follows. This is like `next-overlay-change' but doesn't use
3063 next_overlay_change (EMACS_INT pos
)
3067 Lisp_Object
*overlays
;
3070 /* Get all overlays at the given position. */
3071 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3073 /* If any of these overlays ends before endpos,
3074 use its ending point instead. */
3075 for (i
= 0; i
< noverlays
; ++i
)
3080 oend
= OVERLAY_END (overlays
[i
]);
3081 oendpos
= OVERLAY_POSITION (oend
);
3082 endpos
= min (endpos
, oendpos
);
3088 /* Return the byte position of a display string at or after BYTEPOS.
3089 If no display string exist at or after BYTEPOS, return ZV_BYTE. A
3090 display string is either an overlay with `display' property whose
3091 value is a string or a `display' text property whose value is a
3094 compute_display_string_pos (EMACS_INT bytepos
)
3096 if (bytepos
>= ZV_BYTE
)
3104 /***********************************************************************
3106 ***********************************************************************/
3108 /* Handle changes in the `fontified' property of the current buffer by
3109 calling hook functions from Qfontification_functions to fontify
3112 static enum prop_handled
3113 handle_fontified_prop (struct it
*it
)
3115 Lisp_Object prop
, pos
;
3116 enum prop_handled handled
= HANDLED_NORMALLY
;
3118 if (!NILP (Vmemory_full
))
3121 /* Get the value of the `fontified' property at IT's current buffer
3122 position. (The `fontified' property doesn't have a special
3123 meaning in strings.) If the value is nil, call functions from
3124 Qfontification_functions. */
3125 if (!STRINGP (it
->string
)
3127 && !NILP (Vfontification_functions
)
3128 && !NILP (Vrun_hooks
)
3129 && (pos
= make_number (IT_CHARPOS (*it
)),
3130 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3131 /* Ignore the special cased nil value always present at EOB since
3132 no amount of fontifying will be able to change it. */
3133 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3135 int count
= SPECPDL_INDEX ();
3137 struct buffer
*obuf
= current_buffer
;
3138 int begv
= BEGV
, zv
= ZV
;
3139 int old_clip_changed
= current_buffer
->clip_changed
;
3141 val
= Vfontification_functions
;
3142 specbind (Qfontification_functions
, Qnil
);
3144 xassert (it
->end_charpos
== ZV
);
3146 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3147 safe_call1 (val
, pos
);
3150 Lisp_Object fns
, fn
;
3151 struct gcpro gcpro1
, gcpro2
;
3156 for (; CONSP (val
); val
= XCDR (val
))
3162 /* A value of t indicates this hook has a local
3163 binding; it means to run the global binding too.
3164 In a global value, t should not occur. If it
3165 does, we must ignore it to avoid an endless
3167 for (fns
= Fdefault_value (Qfontification_functions
);
3173 safe_call1 (fn
, pos
);
3177 safe_call1 (fn
, pos
);
3183 unbind_to (count
, Qnil
);
3185 /* Fontification functions routinely call `save-restriction'.
3186 Normally, this tags clip_changed, which can confuse redisplay
3187 (see discussion in Bug#6671). Since we don't perform any
3188 special handling of fontification changes in the case where
3189 `save-restriction' isn't called, there's no point doing so in
3190 this case either. So, if the buffer's restrictions are
3191 actually left unchanged, reset clip_changed. */
3192 if (obuf
== current_buffer
)
3194 if (begv
== BEGV
&& zv
== ZV
)
3195 current_buffer
->clip_changed
= old_clip_changed
;
3197 /* There isn't much we can reasonably do to protect against
3198 misbehaving fontification, but here's a fig leaf. */
3199 else if (!NILP (BVAR (obuf
, name
)))
3200 set_buffer_internal_1 (obuf
);
3202 /* The fontification code may have added/removed text.
3203 It could do even a lot worse, but let's at least protect against
3204 the most obvious case where only the text past `pos' gets changed',
3205 as is/was done in grep.el where some escapes sequences are turned
3206 into face properties (bug#7876). */
3207 it
->end_charpos
= ZV
;
3209 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3210 something. This avoids an endless loop if they failed to
3211 fontify the text for which reason ever. */
3212 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3213 handled
= HANDLED_RECOMPUTE_PROPS
;
3221 /***********************************************************************
3223 ***********************************************************************/
3225 /* Set up iterator IT from face properties at its current position.
3226 Called from handle_stop. */
3228 static enum prop_handled
3229 handle_face_prop (struct it
*it
)
3232 EMACS_INT next_stop
;
3234 if (!STRINGP (it
->string
))
3237 = face_at_buffer_position (it
->w
,
3239 it
->region_beg_charpos
,
3240 it
->region_end_charpos
,
3243 + TEXT_PROP_DISTANCE_LIMIT
),
3244 0, it
->base_face_id
);
3246 /* Is this a start of a run of characters with box face?
3247 Caveat: this can be called for a freshly initialized
3248 iterator; face_id is -1 in this case. We know that the new
3249 face will not change until limit, i.e. if the new face has a
3250 box, all characters up to limit will have one. But, as
3251 usual, we don't know whether limit is really the end. */
3252 if (new_face_id
!= it
->face_id
)
3254 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3256 /* If new face has a box but old face has not, this is
3257 the start of a run of characters with box, i.e. it has
3258 a shadow on the left side. The value of face_id of the
3259 iterator will be -1 if this is the initial call that gets
3260 the face. In this case, we have to look in front of IT's
3261 position and see whether there is a face != new_face_id. */
3262 it
->start_of_box_run_p
3263 = (new_face
->box
!= FACE_NO_BOX
3264 && (it
->face_id
>= 0
3265 || IT_CHARPOS (*it
) == BEG
3266 || new_face_id
!= face_before_it_pos (it
)));
3267 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3275 Lisp_Object from_overlay
3276 = (it
->current
.overlay_string_index
>= 0
3277 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3280 /* See if we got to this string directly or indirectly from
3281 an overlay property. That includes the before-string or
3282 after-string of an overlay, strings in display properties
3283 provided by an overlay, their text properties, etc.
3285 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3286 if (! NILP (from_overlay
))
3287 for (i
= it
->sp
- 1; i
>= 0; i
--)
3289 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3291 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3292 else if (! NILP (it
->stack
[i
].from_overlay
))
3293 from_overlay
= it
->stack
[i
].from_overlay
;
3295 if (!NILP (from_overlay
))
3299 if (! NILP (from_overlay
))
3301 bufpos
= IT_CHARPOS (*it
);
3302 /* For a string from an overlay, the base face depends
3303 only on text properties and ignores overlays. */
3305 = face_for_overlay_string (it
->w
,
3307 it
->region_beg_charpos
,
3308 it
->region_end_charpos
,
3311 + TEXT_PROP_DISTANCE_LIMIT
),
3319 /* For strings from a `display' property, use the face at
3320 IT's current buffer position as the base face to merge
3321 with, so that overlay strings appear in the same face as
3322 surrounding text, unless they specify their own
3324 base_face_id
= underlying_face_id (it
);
3327 new_face_id
= face_at_string_position (it
->w
,
3329 IT_STRING_CHARPOS (*it
),
3331 it
->region_beg_charpos
,
3332 it
->region_end_charpos
,
3336 /* Is this a start of a run of characters with box? Caveat:
3337 this can be called for a freshly allocated iterator; face_id
3338 is -1 is this case. We know that the new face will not
3339 change until the next check pos, i.e. if the new face has a
3340 box, all characters up to that position will have a
3341 box. But, as usual, we don't know whether that position
3342 is really the end. */
3343 if (new_face_id
!= it
->face_id
)
3345 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3346 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3348 /* If new face has a box but old face hasn't, this is the
3349 start of a run of characters with box, i.e. it has a
3350 shadow on the left side. */
3351 it
->start_of_box_run_p
3352 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3353 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3357 it
->face_id
= new_face_id
;
3358 return HANDLED_NORMALLY
;
3362 /* Return the ID of the face ``underlying'' IT's current position,
3363 which is in a string. If the iterator is associated with a
3364 buffer, return the face at IT's current buffer position.
3365 Otherwise, use the iterator's base_face_id. */
3368 underlying_face_id (struct it
*it
)
3370 int face_id
= it
->base_face_id
, i
;
3372 xassert (STRINGP (it
->string
));
3374 for (i
= it
->sp
- 1; i
>= 0; --i
)
3375 if (NILP (it
->stack
[i
].string
))
3376 face_id
= it
->stack
[i
].face_id
;
3382 /* Compute the face one character before or after the current position
3383 of IT. BEFORE_P non-zero means get the face in front of IT's
3384 position. Value is the id of the face. */
3387 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3390 EMACS_INT next_check_charpos
;
3391 struct text_pos pos
;
3393 xassert (it
->s
== NULL
);
3395 if (STRINGP (it
->string
))
3400 /* No face change past the end of the string (for the case
3401 we are padding with spaces). No face change before the
3403 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3404 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3407 /* Set pos to the position before or after IT's current position. */
3409 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3411 /* For composition, we must check the character after the
3413 pos
= (it
->what
== IT_COMPOSITION
3414 ? string_pos (IT_STRING_CHARPOS (*it
)
3415 + it
->cmp_it
.nchars
, it
->string
)
3416 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3418 if (it
->current
.overlay_string_index
>= 0)
3419 bufpos
= IT_CHARPOS (*it
);
3423 base_face_id
= underlying_face_id (it
);
3425 /* Get the face for ASCII, or unibyte. */
3426 face_id
= face_at_string_position (it
->w
,
3430 it
->region_beg_charpos
,
3431 it
->region_end_charpos
,
3432 &next_check_charpos
,
3435 /* Correct the face for charsets different from ASCII. Do it
3436 for the multibyte case only. The face returned above is
3437 suitable for unibyte text if IT->string is unibyte. */
3438 if (STRING_MULTIBYTE (it
->string
))
3440 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3442 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3444 c
= string_char_and_length (p
, &len
);
3445 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3450 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3451 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3454 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3455 pos
= it
->current
.pos
;
3458 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3461 if (it
->what
== IT_COMPOSITION
)
3462 /* For composition, we must check the position after the
3464 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3466 INC_TEXT_POS (pos
, it
->multibyte_p
);
3469 /* Determine face for CHARSET_ASCII, or unibyte. */
3470 face_id
= face_at_buffer_position (it
->w
,
3472 it
->region_beg_charpos
,
3473 it
->region_end_charpos
,
3474 &next_check_charpos
,
3477 /* Correct the face for charsets different from ASCII. Do it
3478 for the multibyte case only. The face returned above is
3479 suitable for unibyte text if current_buffer is unibyte. */
3480 if (it
->multibyte_p
)
3482 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3483 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3484 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3493 /***********************************************************************
3495 ***********************************************************************/
3497 /* Set up iterator IT from invisible properties at its current
3498 position. Called from handle_stop. */
3500 static enum prop_handled
3501 handle_invisible_prop (struct it
*it
)
3503 enum prop_handled handled
= HANDLED_NORMALLY
;
3505 if (STRINGP (it
->string
))
3507 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3509 /* Get the value of the invisible text property at the
3510 current position. Value will be nil if there is no such
3512 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3513 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3516 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3518 handled
= HANDLED_RECOMPUTE_PROPS
;
3520 /* Get the position at which the next change of the
3521 invisible text property can be found in IT->string.
3522 Value will be nil if the property value is the same for
3523 all the rest of IT->string. */
3524 XSETINT (limit
, SCHARS (it
->string
));
3525 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3528 /* Text at current position is invisible. The next
3529 change in the property is at position end_charpos.
3530 Move IT's current position to that position. */
3531 if (INTEGERP (end_charpos
)
3532 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3534 struct text_pos old
;
3535 old
= it
->current
.string_pos
;
3536 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3537 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3541 /* The rest of the string is invisible. If this is an
3542 overlay string, proceed with the next overlay string
3543 or whatever comes and return a character from there. */
3544 if (it
->current
.overlay_string_index
>= 0)
3546 next_overlay_string (it
);
3547 /* Don't check for overlay strings when we just
3548 finished processing them. */
3549 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3553 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3554 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3562 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3563 Lisp_Object pos
, prop
, overlay
;
3565 /* First of all, is there invisible text at this position? */
3566 tem
= start_charpos
= IT_CHARPOS (*it
);
3567 pos
= make_number (tem
);
3568 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3570 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3572 /* If we are on invisible text, skip over it. */
3573 if (invis_p
&& start_charpos
< it
->end_charpos
)
3575 /* Record whether we have to display an ellipsis for the
3577 int display_ellipsis_p
= invis_p
== 2;
3579 handled
= HANDLED_RECOMPUTE_PROPS
;
3581 /* Loop skipping over invisible text. The loop is left at
3582 ZV or with IT on the first char being visible again. */
3585 /* Try to skip some invisible text. Return value is the
3586 position reached which can be equal to where we start
3587 if there is nothing invisible there. This skips both
3588 over invisible text properties and overlays with
3589 invisible property. */
3590 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3592 /* If we skipped nothing at all we weren't at invisible
3593 text in the first place. If everything to the end of
3594 the buffer was skipped, end the loop. */
3595 if (newpos
== tem
|| newpos
>= ZV
)
3599 /* We skipped some characters but not necessarily
3600 all there are. Check if we ended up on visible
3601 text. Fget_char_property returns the property of
3602 the char before the given position, i.e. if we
3603 get invis_p = 0, this means that the char at
3604 newpos is visible. */
3605 pos
= make_number (newpos
);
3606 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3607 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3610 /* If we ended up on invisible text, proceed to
3611 skip starting with next_stop. */
3615 /* If there are adjacent invisible texts, don't lose the
3616 second one's ellipsis. */
3618 display_ellipsis_p
= 1;
3622 /* The position newpos is now either ZV or on visible text. */
3623 if (it
->bidi_p
&& newpos
< ZV
)
3625 /* With bidi iteration, the region of invisible text
3626 could start and/or end in the middle of a non-base
3627 embedding level. Therefore, we need to skip
3628 invisible text using the bidi iterator, starting at
3629 IT's current position, until we find ourselves
3630 outside the invisible text. Skipping invisible text
3631 _after_ bidi iteration avoids affecting the visual
3632 order of the displayed text when invisible properties
3633 are added or removed. */
3634 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3636 /* If we were `reseat'ed to a new paragraph,
3637 determine the paragraph base direction. We need
3638 to do it now because next_element_from_buffer may
3639 not have a chance to do it, if we are going to
3640 skip any text at the beginning, which resets the
3642 bidi_paragraph_init (it
->paragraph_embedding
,
3647 bidi_move_to_visually_next (&it
->bidi_it
);
3649 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3650 && it
->bidi_it
.charpos
< newpos
);
3651 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3652 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3653 /* If we overstepped NEWPOS, record its position in the
3654 iterator, so that we skip invisible text if later the
3655 bidi iteration lands us in the invisible region
3657 if (IT_CHARPOS (*it
) >= newpos
)
3658 it
->prev_stop
= newpos
;
3662 IT_CHARPOS (*it
) = newpos
;
3663 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3666 /* If there are before-strings at the start of invisible
3667 text, and the text is invisible because of a text
3668 property, arrange to show before-strings because 20.x did
3669 it that way. (If the text is invisible because of an
3670 overlay property instead of a text property, this is
3671 already handled in the overlay code.) */
3673 && get_overlay_strings (it
, it
->stop_charpos
))
3675 handled
= HANDLED_RECOMPUTE_PROPS
;
3676 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3678 else if (display_ellipsis_p
)
3680 /* Make sure that the glyphs of the ellipsis will get
3681 correct `charpos' values. If we would not update
3682 it->position here, the glyphs would belong to the
3683 last visible character _before_ the invisible
3684 text, which confuses `set_cursor_from_row'.
3686 We use the last invisible position instead of the
3687 first because this way the cursor is always drawn on
3688 the first "." of the ellipsis, whenever PT is inside
3689 the invisible text. Otherwise the cursor would be
3690 placed _after_ the ellipsis when the point is after the
3691 first invisible character. */
3692 if (!STRINGP (it
->object
))
3694 it
->position
.charpos
= newpos
- 1;
3695 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3698 /* Let the ellipsis display before
3699 considering any properties of the following char.
3700 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3701 handled
= HANDLED_RETURN
;
3710 /* Make iterator IT return `...' next.
3711 Replaces LEN characters from buffer. */
3714 setup_for_ellipsis (struct it
*it
, int len
)
3716 /* Use the display table definition for `...'. Invalid glyphs
3717 will be handled by the method returning elements from dpvec. */
3718 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3720 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3721 it
->dpvec
= v
->contents
;
3722 it
->dpend
= v
->contents
+ v
->header
.size
;
3726 /* Default `...'. */
3727 it
->dpvec
= default_invis_vector
;
3728 it
->dpend
= default_invis_vector
+ 3;
3731 it
->dpvec_char_len
= len
;
3732 it
->current
.dpvec_index
= 0;
3733 it
->dpvec_face_id
= -1;
3735 /* Remember the current face id in case glyphs specify faces.
3736 IT's face is restored in set_iterator_to_next.
3737 saved_face_id was set to preceding char's face in handle_stop. */
3738 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3739 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3741 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3747 /***********************************************************************
3749 ***********************************************************************/
3751 /* Set up iterator IT from `display' property at its current position.
3752 Called from handle_stop.
3753 We return HANDLED_RETURN if some part of the display property
3754 overrides the display of the buffer text itself.
3755 Otherwise we return HANDLED_NORMALLY. */
3757 static enum prop_handled
3758 handle_display_prop (struct it
*it
)
3760 Lisp_Object prop
, object
, overlay
;
3761 struct text_pos
*position
;
3762 /* Nonzero if some property replaces the display of the text itself. */
3763 int display_replaced_p
= 0;
3765 if (STRINGP (it
->string
))
3767 object
= it
->string
;
3768 position
= &it
->current
.string_pos
;
3772 XSETWINDOW (object
, it
->w
);
3773 position
= &it
->current
.pos
;
3776 /* Reset those iterator values set from display property values. */
3777 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3778 it
->space_width
= Qnil
;
3779 it
->font_height
= Qnil
;
3782 /* We don't support recursive `display' properties, i.e. string
3783 values that have a string `display' property, that have a string
3784 `display' property etc. */
3785 if (!it
->string_from_display_prop_p
)
3786 it
->area
= TEXT_AREA
;
3788 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3789 Qdisplay
, object
, &overlay
);
3791 return HANDLED_NORMALLY
;
3792 /* Now OVERLAY is the overlay that gave us this property, or nil
3793 if it was a text property. */
3795 if (!STRINGP (it
->string
))
3796 object
= it
->w
->buffer
;
3799 /* Simple properties. */
3800 && !EQ (XCAR (prop
), Qimage
)
3801 && !EQ (XCAR (prop
), Qspace
)
3802 && !EQ (XCAR (prop
), Qwhen
)
3803 && !EQ (XCAR (prop
), Qslice
)
3804 && !EQ (XCAR (prop
), Qspace_width
)
3805 && !EQ (XCAR (prop
), Qheight
)
3806 && !EQ (XCAR (prop
), Qraise
)
3807 /* Marginal area specifications. */
3808 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3809 && !EQ (XCAR (prop
), Qleft_fringe
)
3810 && !EQ (XCAR (prop
), Qright_fringe
)
3811 && !NILP (XCAR (prop
)))
3813 for (; CONSP (prop
); prop
= XCDR (prop
))
3815 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3816 position
, display_replaced_p
))
3818 display_replaced_p
= 1;
3819 /* If some text in a string is replaced, `position' no
3820 longer points to the position of `object'. */
3821 if (STRINGP (object
))
3826 else if (VECTORP (prop
))
3829 for (i
= 0; i
< ASIZE (prop
); ++i
)
3830 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3831 position
, display_replaced_p
))
3833 display_replaced_p
= 1;
3834 /* If some text in a string is replaced, `position' no
3835 longer points to the position of `object'. */
3836 if (STRINGP (object
))
3842 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3844 display_replaced_p
= 1;
3847 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3851 /* Value is the position of the end of the `display' property starting
3852 at START_POS in OBJECT. */
3854 static struct text_pos
3855 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3858 struct text_pos end_pos
;
3860 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3861 Qdisplay
, object
, Qnil
);
3862 CHARPOS (end_pos
) = XFASTINT (end
);
3863 if (STRINGP (object
))
3864 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3866 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3872 /* Set up IT from a single `display' property specification SPEC. OBJECT
3873 is the object in which the `display' property was found. *POSITION
3874 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3875 means that we previously saw a display specification which already
3876 replaced text display with something else, for example an image;
3877 we ignore such properties after the first one has been processed.
3879 OVERLAY is the overlay this `display' property came from,
3880 or nil if it was a text property.
3882 If SPEC is a `space' or `image' specification, and in some other
3883 cases too, set *POSITION to the position where the `display'
3886 Value is non-zero if something was found which replaces the display
3887 of buffer or string text. */
3890 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3891 Lisp_Object overlay
, struct text_pos
*position
,
3892 int display_replaced_p
)
3895 Lisp_Object location
, value
;
3896 struct text_pos start_pos
, save_pos
;
3899 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3900 If the result is non-nil, use VALUE instead of SPEC. */
3902 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3911 if (!NILP (form
) && !EQ (form
, Qt
))
3913 int count
= SPECPDL_INDEX ();
3914 struct gcpro gcpro1
;
3916 /* Bind `object' to the object having the `display' property, a
3917 buffer or string. Bind `position' to the position in the
3918 object where the property was found, and `buffer-position'
3919 to the current position in the buffer. */
3920 specbind (Qobject
, object
);
3921 specbind (Qposition
, make_number (CHARPOS (*position
)));
3922 specbind (Qbuffer_position
,
3923 make_number (STRINGP (object
)
3924 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3926 form
= safe_eval (form
);
3928 unbind_to (count
, Qnil
);
3934 /* Handle `(height HEIGHT)' specifications. */
3936 && EQ (XCAR (spec
), Qheight
)
3937 && CONSP (XCDR (spec
)))
3939 if (!FRAME_WINDOW_P (it
->f
))
3942 it
->font_height
= XCAR (XCDR (spec
));
3943 if (!NILP (it
->font_height
))
3945 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3946 int new_height
= -1;
3948 if (CONSP (it
->font_height
)
3949 && (EQ (XCAR (it
->font_height
), Qplus
)
3950 || EQ (XCAR (it
->font_height
), Qminus
))
3951 && CONSP (XCDR (it
->font_height
))
3952 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3954 /* `(+ N)' or `(- N)' where N is an integer. */
3955 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3956 if (EQ (XCAR (it
->font_height
), Qplus
))
3958 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3960 else if (FUNCTIONP (it
->font_height
))
3962 /* Call function with current height as argument.
3963 Value is the new height. */
3965 height
= safe_call1 (it
->font_height
,
3966 face
->lface
[LFACE_HEIGHT_INDEX
]);
3967 if (NUMBERP (height
))
3968 new_height
= XFLOATINT (height
);
3970 else if (NUMBERP (it
->font_height
))
3972 /* Value is a multiple of the canonical char height. */
3975 f
= FACE_FROM_ID (it
->f
,
3976 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3977 new_height
= (XFLOATINT (it
->font_height
)
3978 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
3982 /* Evaluate IT->font_height with `height' bound to the
3983 current specified height to get the new height. */
3984 int count
= SPECPDL_INDEX ();
3986 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3987 value
= safe_eval (it
->font_height
);
3988 unbind_to (count
, Qnil
);
3990 if (NUMBERP (value
))
3991 new_height
= XFLOATINT (value
);
3995 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4001 /* Handle `(space-width WIDTH)'. */
4003 && EQ (XCAR (spec
), Qspace_width
)
4004 && CONSP (XCDR (spec
)))
4006 if (!FRAME_WINDOW_P (it
->f
))
4009 value
= XCAR (XCDR (spec
));
4010 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4011 it
->space_width
= value
;
4016 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4018 && EQ (XCAR (spec
), Qslice
))
4022 if (!FRAME_WINDOW_P (it
->f
))
4025 if (tem
= XCDR (spec
), CONSP (tem
))
4027 it
->slice
.x
= XCAR (tem
);
4028 if (tem
= XCDR (tem
), CONSP (tem
))
4030 it
->slice
.y
= XCAR (tem
);
4031 if (tem
= XCDR (tem
), CONSP (tem
))
4033 it
->slice
.width
= XCAR (tem
);
4034 if (tem
= XCDR (tem
), CONSP (tem
))
4035 it
->slice
.height
= XCAR (tem
);
4043 /* Handle `(raise FACTOR)'. */
4045 && EQ (XCAR (spec
), Qraise
)
4046 && CONSP (XCDR (spec
)))
4048 if (!FRAME_WINDOW_P (it
->f
))
4051 #ifdef HAVE_WINDOW_SYSTEM
4052 value
= XCAR (XCDR (spec
));
4053 if (NUMBERP (value
))
4055 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4056 it
->voffset
= - (XFLOATINT (value
)
4057 * (FONT_HEIGHT (face
->font
)));
4059 #endif /* HAVE_WINDOW_SYSTEM */
4064 /* Don't handle the other kinds of display specifications
4065 inside a string that we got from a `display' property. */
4066 if (it
->string_from_display_prop_p
)
4069 /* Characters having this form of property are not displayed, so
4070 we have to find the end of the property. */
4071 start_pos
= *position
;
4072 *position
= display_prop_end (it
, object
, start_pos
);
4075 /* Stop the scan at that end position--we assume that all
4076 text properties change there. */
4077 it
->stop_charpos
= position
->charpos
;
4079 /* Handle `(left-fringe BITMAP [FACE])'
4080 and `(right-fringe BITMAP [FACE])'. */
4082 && (EQ (XCAR (spec
), Qleft_fringe
)
4083 || EQ (XCAR (spec
), Qright_fringe
))
4084 && CONSP (XCDR (spec
)))
4086 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4089 if (!FRAME_WINDOW_P (it
->f
))
4090 /* If we return here, POSITION has been advanced
4091 across the text with this property. */
4094 #ifdef HAVE_WINDOW_SYSTEM
4095 value
= XCAR (XCDR (spec
));
4096 if (!SYMBOLP (value
)
4097 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4098 /* If we return here, POSITION has been advanced
4099 across the text with this property. */
4102 if (CONSP (XCDR (XCDR (spec
))))
4104 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4105 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4111 /* Save current settings of IT so that we can restore them
4112 when we are finished with the glyph property value. */
4114 save_pos
= it
->position
;
4115 it
->position
= *position
;
4117 it
->position
= save_pos
;
4119 it
->area
= TEXT_AREA
;
4120 it
->what
= IT_IMAGE
;
4121 it
->image_id
= -1; /* no image */
4122 it
->position
= start_pos
;
4123 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4124 it
->method
= GET_FROM_IMAGE
;
4125 it
->from_overlay
= Qnil
;
4126 it
->face_id
= face_id
;
4128 /* Say that we haven't consumed the characters with
4129 `display' property yet. The call to pop_it in
4130 set_iterator_to_next will clean this up. */
4131 *position
= start_pos
;
4133 if (EQ (XCAR (spec
), Qleft_fringe
))
4135 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4136 it
->left_user_fringe_face_id
= face_id
;
4140 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4141 it
->right_user_fringe_face_id
= face_id
;
4143 #endif /* HAVE_WINDOW_SYSTEM */
4147 /* Prepare to handle `((margin left-margin) ...)',
4148 `((margin right-margin) ...)' and `((margin nil) ...)'
4149 prefixes for display specifications. */
4150 location
= Qunbound
;
4151 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4155 value
= XCDR (spec
);
4157 value
= XCAR (value
);
4160 if (EQ (XCAR (tem
), Qmargin
)
4161 && (tem
= XCDR (tem
),
4162 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4164 || EQ (tem
, Qleft_margin
)
4165 || EQ (tem
, Qright_margin
))))
4169 if (EQ (location
, Qunbound
))
4175 /* After this point, VALUE is the property after any
4176 margin prefix has been stripped. It must be a string,
4177 an image specification, or `(space ...)'.
4179 LOCATION specifies where to display: `left-margin',
4180 `right-margin' or nil. */
4182 valid_p
= (STRINGP (value
)
4183 #ifdef HAVE_WINDOW_SYSTEM
4184 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4185 #endif /* not HAVE_WINDOW_SYSTEM */
4186 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4188 if (valid_p
&& !display_replaced_p
)
4190 /* Save current settings of IT so that we can restore them
4191 when we are finished with the glyph property value. */
4192 save_pos
= it
->position
;
4193 it
->position
= *position
;
4195 it
->position
= save_pos
;
4196 it
->from_overlay
= overlay
;
4198 if (NILP (location
))
4199 it
->area
= TEXT_AREA
;
4200 else if (EQ (location
, Qleft_margin
))
4201 it
->area
= LEFT_MARGIN_AREA
;
4203 it
->area
= RIGHT_MARGIN_AREA
;
4205 if (STRINGP (value
))
4208 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4209 it
->current
.overlay_string_index
= -1;
4210 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4211 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4212 it
->method
= GET_FROM_STRING
;
4213 it
->stop_charpos
= 0;
4214 it
->string_from_display_prop_p
= 1;
4215 /* Say that we haven't consumed the characters with
4216 `display' property yet. The call to pop_it in
4217 set_iterator_to_next will clean this up. */
4218 if (BUFFERP (object
))
4219 *position
= start_pos
;
4221 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4223 it
->method
= GET_FROM_STRETCH
;
4225 *position
= it
->position
= start_pos
;
4227 #ifdef HAVE_WINDOW_SYSTEM
4230 it
->what
= IT_IMAGE
;
4231 it
->image_id
= lookup_image (it
->f
, value
);
4232 it
->position
= start_pos
;
4233 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4234 it
->method
= GET_FROM_IMAGE
;
4236 /* Say that we haven't consumed the characters with
4237 `display' property yet. The call to pop_it in
4238 set_iterator_to_next will clean this up. */
4239 *position
= start_pos
;
4241 #endif /* HAVE_WINDOW_SYSTEM */
4246 /* Invalid property or property not supported. Restore
4247 POSITION to what it was before. */
4248 *position
= start_pos
;
4253 /* Check if SPEC is a display sub-property value whose text should be
4254 treated as intangible. */
4257 single_display_spec_intangible_p (Lisp_Object prop
)
4259 /* Skip over `when FORM'. */
4260 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4274 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4275 we don't need to treat text as intangible. */
4276 if (EQ (XCAR (prop
), Qmargin
))
4284 || EQ (XCAR (prop
), Qleft_margin
)
4285 || EQ (XCAR (prop
), Qright_margin
))
4289 return (CONSP (prop
)
4290 && (EQ (XCAR (prop
), Qimage
)
4291 || EQ (XCAR (prop
), Qspace
)));
4295 /* Check if PROP is a display property value whose text should be
4296 treated as intangible. */
4299 display_prop_intangible_p (Lisp_Object prop
)
4302 && CONSP (XCAR (prop
))
4303 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4305 /* A list of sub-properties. */
4306 while (CONSP (prop
))
4308 if (single_display_spec_intangible_p (XCAR (prop
)))
4313 else if (VECTORP (prop
))
4315 /* A vector of sub-properties. */
4317 for (i
= 0; i
< ASIZE (prop
); ++i
)
4318 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4322 return single_display_spec_intangible_p (prop
);
4328 /* Return 1 if PROP is a display sub-property value containing STRING. */
4331 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4333 if (EQ (string
, prop
))
4336 /* Skip over `when FORM'. */
4337 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4346 /* Skip over `margin LOCATION'. */
4347 if (EQ (XCAR (prop
), Qmargin
))
4358 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4362 /* Return 1 if STRING appears in the `display' property PROP. */
4365 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4368 && CONSP (XCAR (prop
))
4369 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4371 /* A list of sub-properties. */
4372 while (CONSP (prop
))
4374 if (single_display_spec_string_p (XCAR (prop
), string
))
4379 else if (VECTORP (prop
))
4381 /* A vector of sub-properties. */
4383 for (i
= 0; i
< ASIZE (prop
); ++i
)
4384 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4388 return single_display_spec_string_p (prop
, string
);
4393 /* Look for STRING in overlays and text properties in the current
4394 buffer, between character positions FROM and TO (excluding TO).
4395 BACK_P non-zero means look back (in this case, TO is supposed to be
4397 Value is the first character position where STRING was found, or
4398 zero if it wasn't found before hitting TO.
4400 This function may only use code that doesn't eval because it is
4401 called asynchronously from note_mouse_highlight. */
4404 string_buffer_position_lim (Lisp_Object string
,
4405 EMACS_INT from
, EMACS_INT to
, int back_p
)
4407 Lisp_Object limit
, prop
, pos
;
4410 pos
= make_number (from
);
4412 if (!back_p
) /* looking forward */
4414 limit
= make_number (min (to
, ZV
));
4415 while (!found
&& !EQ (pos
, limit
))
4417 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4418 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4421 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4425 else /* looking back */
4427 limit
= make_number (max (to
, BEGV
));
4428 while (!found
&& !EQ (pos
, limit
))
4430 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4431 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4434 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4439 return found
? XINT (pos
) : 0;
4442 /* Determine which buffer position in current buffer STRING comes from.
4443 AROUND_CHARPOS is an approximate position where it could come from.
4444 Value is the buffer position or 0 if it couldn't be determined.
4446 This function is necessary because we don't record buffer positions
4447 in glyphs generated from strings (to keep struct glyph small).
4448 This function may only use code that doesn't eval because it is
4449 called asynchronously from note_mouse_highlight. */
4452 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4454 const int MAX_DISTANCE
= 1000;
4455 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4456 around_charpos
+ MAX_DISTANCE
,
4460 found
= string_buffer_position_lim (string
, around_charpos
,
4461 around_charpos
- MAX_DISTANCE
, 1);
4467 /***********************************************************************
4468 `composition' property
4469 ***********************************************************************/
4471 /* Set up iterator IT from `composition' property at its current
4472 position. Called from handle_stop. */
4474 static enum prop_handled
4475 handle_composition_prop (struct it
*it
)
4477 Lisp_Object prop
, string
;
4478 EMACS_INT pos
, pos_byte
, start
, end
;
4480 if (STRINGP (it
->string
))
4484 pos
= IT_STRING_CHARPOS (*it
);
4485 pos_byte
= IT_STRING_BYTEPOS (*it
);
4486 string
= it
->string
;
4487 s
= SDATA (string
) + pos_byte
;
4488 it
->c
= STRING_CHAR (s
);
4492 pos
= IT_CHARPOS (*it
);
4493 pos_byte
= IT_BYTEPOS (*it
);
4495 it
->c
= FETCH_CHAR (pos_byte
);
4498 /* If there's a valid composition and point is not inside of the
4499 composition (in the case that the composition is from the current
4500 buffer), draw a glyph composed from the composition components. */
4501 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4502 && COMPOSITION_VALID_P (start
, end
, prop
)
4503 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4507 if (STRINGP (it
->string
))
4508 pos_byte
= string_char_to_byte (it
->string
, start
);
4510 pos_byte
= CHAR_TO_BYTE (start
);
4512 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4515 if (it
->cmp_it
.id
>= 0)
4518 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4519 it
->cmp_it
.nglyphs
= -1;
4523 return HANDLED_NORMALLY
;
4528 /***********************************************************************
4530 ***********************************************************************/
4532 /* The following structure is used to record overlay strings for
4533 later sorting in load_overlay_strings. */
4535 struct overlay_entry
4537 Lisp_Object overlay
;
4544 /* Set up iterator IT from overlay strings at its current position.
4545 Called from handle_stop. */
4547 static enum prop_handled
4548 handle_overlay_change (struct it
*it
)
4550 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4551 return HANDLED_RECOMPUTE_PROPS
;
4553 return HANDLED_NORMALLY
;
4557 /* Set up the next overlay string for delivery by IT, if there is an
4558 overlay string to deliver. Called by set_iterator_to_next when the
4559 end of the current overlay string is reached. If there are more
4560 overlay strings to display, IT->string and
4561 IT->current.overlay_string_index are set appropriately here.
4562 Otherwise IT->string is set to nil. */
4565 next_overlay_string (struct it
*it
)
4567 ++it
->current
.overlay_string_index
;
4568 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4570 /* No more overlay strings. Restore IT's settings to what
4571 they were before overlay strings were processed, and
4572 continue to deliver from current_buffer. */
4574 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4577 || (NILP (it
->string
)
4578 && it
->method
== GET_FROM_BUFFER
4579 && it
->stop_charpos
>= BEGV
4580 && it
->stop_charpos
<= it
->end_charpos
));
4581 it
->current
.overlay_string_index
= -1;
4582 it
->n_overlay_strings
= 0;
4583 it
->overlay_strings_charpos
= -1;
4585 /* If we're at the end of the buffer, record that we have
4586 processed the overlay strings there already, so that
4587 next_element_from_buffer doesn't try it again. */
4588 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4589 it
->overlay_strings_at_end_processed_p
= 1;
4593 /* There are more overlay strings to process. If
4594 IT->current.overlay_string_index has advanced to a position
4595 where we must load IT->overlay_strings with more strings, do
4596 it. We must load at the IT->overlay_strings_charpos where
4597 IT->n_overlay_strings was originally computed; when invisible
4598 text is present, this might not be IT_CHARPOS (Bug#7016). */
4599 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4601 if (it
->current
.overlay_string_index
&& i
== 0)
4602 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4604 /* Initialize IT to deliver display elements from the overlay
4606 it
->string
= it
->overlay_strings
[i
];
4607 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4608 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4609 it
->method
= GET_FROM_STRING
;
4610 it
->stop_charpos
= 0;
4611 if (it
->cmp_it
.stop_pos
>= 0)
4612 it
->cmp_it
.stop_pos
= 0;
4619 /* Compare two overlay_entry structures E1 and E2. Used as a
4620 comparison function for qsort in load_overlay_strings. Overlay
4621 strings for the same position are sorted so that
4623 1. All after-strings come in front of before-strings, except
4624 when they come from the same overlay.
4626 2. Within after-strings, strings are sorted so that overlay strings
4627 from overlays with higher priorities come first.
4629 2. Within before-strings, strings are sorted so that overlay
4630 strings from overlays with higher priorities come last.
4632 Value is analogous to strcmp. */
4636 compare_overlay_entries (const void *e1
, const void *e2
)
4638 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4639 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4642 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4644 /* Let after-strings appear in front of before-strings if
4645 they come from different overlays. */
4646 if (EQ (entry1
->overlay
, entry2
->overlay
))
4647 result
= entry1
->after_string_p
? 1 : -1;
4649 result
= entry1
->after_string_p
? -1 : 1;
4651 else if (entry1
->after_string_p
)
4652 /* After-strings sorted in order of decreasing priority. */
4653 result
= entry2
->priority
- entry1
->priority
;
4655 /* Before-strings sorted in order of increasing priority. */
4656 result
= entry1
->priority
- entry2
->priority
;
4662 /* Load the vector IT->overlay_strings with overlay strings from IT's
4663 current buffer position, or from CHARPOS if that is > 0. Set
4664 IT->n_overlays to the total number of overlay strings found.
4666 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4667 a time. On entry into load_overlay_strings,
4668 IT->current.overlay_string_index gives the number of overlay
4669 strings that have already been loaded by previous calls to this
4672 IT->add_overlay_start contains an additional overlay start
4673 position to consider for taking overlay strings from, if non-zero.
4674 This position comes into play when the overlay has an `invisible'
4675 property, and both before and after-strings. When we've skipped to
4676 the end of the overlay, because of its `invisible' property, we
4677 nevertheless want its before-string to appear.
4678 IT->add_overlay_start will contain the overlay start position
4681 Overlay strings are sorted so that after-string strings come in
4682 front of before-string strings. Within before and after-strings,
4683 strings are sorted by overlay priority. See also function
4684 compare_overlay_entries. */
4687 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4689 Lisp_Object overlay
, window
, str
, invisible
;
4690 struct Lisp_Overlay
*ov
;
4691 EMACS_INT start
, end
;
4693 int n
= 0, i
, j
, invis_p
;
4694 struct overlay_entry
*entries
4695 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4698 charpos
= IT_CHARPOS (*it
);
4700 /* Append the overlay string STRING of overlay OVERLAY to vector
4701 `entries' which has size `size' and currently contains `n'
4702 elements. AFTER_P non-zero means STRING is an after-string of
4704 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4707 Lisp_Object priority; \
4711 int new_size = 2 * size; \
4712 struct overlay_entry *old = entries; \
4714 (struct overlay_entry *) alloca (new_size \
4715 * sizeof *entries); \
4716 memcpy (entries, old, size * sizeof *entries); \
4720 entries[n].string = (STRING); \
4721 entries[n].overlay = (OVERLAY); \
4722 priority = Foverlay_get ((OVERLAY), Qpriority); \
4723 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4724 entries[n].after_string_p = (AFTER_P); \
4729 /* Process overlay before the overlay center. */
4730 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4732 XSETMISC (overlay
, ov
);
4733 xassert (OVERLAYP (overlay
));
4734 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4735 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4740 /* Skip this overlay if it doesn't start or end at IT's current
4742 if (end
!= charpos
&& start
!= charpos
)
4745 /* Skip this overlay if it doesn't apply to IT->w. */
4746 window
= Foverlay_get (overlay
, Qwindow
);
4747 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4750 /* If the text ``under'' the overlay is invisible, both before-
4751 and after-strings from this overlay are visible; start and
4752 end position are indistinguishable. */
4753 invisible
= Foverlay_get (overlay
, Qinvisible
);
4754 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4756 /* If overlay has a non-empty before-string, record it. */
4757 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4758 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4760 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4762 /* If overlay has a non-empty after-string, record it. */
4763 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4764 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4766 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4769 /* Process overlays after the overlay center. */
4770 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4772 XSETMISC (overlay
, ov
);
4773 xassert (OVERLAYP (overlay
));
4774 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4775 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4777 if (start
> charpos
)
4780 /* Skip this overlay if it doesn't start or end at IT's current
4782 if (end
!= charpos
&& start
!= charpos
)
4785 /* Skip this overlay if it doesn't apply to IT->w. */
4786 window
= Foverlay_get (overlay
, Qwindow
);
4787 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4790 /* If the text ``under'' the overlay is invisible, it has a zero
4791 dimension, and both before- and after-strings apply. */
4792 invisible
= Foverlay_get (overlay
, Qinvisible
);
4793 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4795 /* If overlay has a non-empty before-string, record it. */
4796 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4797 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4799 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4801 /* If overlay has a non-empty after-string, record it. */
4802 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4803 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4805 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4808 #undef RECORD_OVERLAY_STRING
4812 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4814 /* Record number of overlay strings, and where we computed it. */
4815 it
->n_overlay_strings
= n
;
4816 it
->overlay_strings_charpos
= charpos
;
4818 /* IT->current.overlay_string_index is the number of overlay strings
4819 that have already been consumed by IT. Copy some of the
4820 remaining overlay strings to IT->overlay_strings. */
4822 j
= it
->current
.overlay_string_index
;
4823 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4825 it
->overlay_strings
[i
] = entries
[j
].string
;
4826 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4833 /* Get the first chunk of overlay strings at IT's current buffer
4834 position, or at CHARPOS if that is > 0. Value is non-zero if at
4835 least one overlay string was found. */
4838 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4840 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4841 process. This fills IT->overlay_strings with strings, and sets
4842 IT->n_overlay_strings to the total number of strings to process.
4843 IT->pos.overlay_string_index has to be set temporarily to zero
4844 because load_overlay_strings needs this; it must be set to -1
4845 when no overlay strings are found because a zero value would
4846 indicate a position in the first overlay string. */
4847 it
->current
.overlay_string_index
= 0;
4848 load_overlay_strings (it
, charpos
);
4850 /* If we found overlay strings, set up IT to deliver display
4851 elements from the first one. Otherwise set up IT to deliver
4852 from current_buffer. */
4853 if (it
->n_overlay_strings
)
4855 /* Make sure we know settings in current_buffer, so that we can
4856 restore meaningful values when we're done with the overlay
4859 compute_stop_pos (it
);
4860 xassert (it
->face_id
>= 0);
4862 /* Save IT's settings. They are restored after all overlay
4863 strings have been processed. */
4864 xassert (!compute_stop_p
|| it
->sp
== 0);
4866 /* When called from handle_stop, there might be an empty display
4867 string loaded. In that case, don't bother saving it. */
4868 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4871 /* Set up IT to deliver display elements from the first overlay
4873 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4874 it
->string
= it
->overlay_strings
[0];
4875 it
->from_overlay
= Qnil
;
4876 it
->stop_charpos
= 0;
4877 xassert (STRINGP (it
->string
));
4878 it
->end_charpos
= SCHARS (it
->string
);
4879 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4880 it
->method
= GET_FROM_STRING
;
4884 it
->current
.overlay_string_index
= -1;
4889 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4892 it
->method
= GET_FROM_BUFFER
;
4894 (void) get_overlay_strings_1 (it
, charpos
, 1);
4898 /* Value is non-zero if we found at least one overlay string. */
4899 return STRINGP (it
->string
);
4904 /***********************************************************************
4905 Saving and restoring state
4906 ***********************************************************************/
4908 /* Save current settings of IT on IT->stack. Called, for example,
4909 before setting up IT for an overlay string, to be able to restore
4910 IT's settings to what they were after the overlay string has been
4914 push_it (struct it
*it
)
4916 struct iterator_stack_entry
*p
;
4918 xassert (it
->sp
< IT_STACK_SIZE
);
4919 p
= it
->stack
+ it
->sp
;
4921 p
->stop_charpos
= it
->stop_charpos
;
4922 p
->prev_stop
= it
->prev_stop
;
4923 p
->base_level_stop
= it
->base_level_stop
;
4924 p
->cmp_it
= it
->cmp_it
;
4925 xassert (it
->face_id
>= 0);
4926 p
->face_id
= it
->face_id
;
4927 p
->string
= it
->string
;
4928 p
->method
= it
->method
;
4929 p
->from_overlay
= it
->from_overlay
;
4932 case GET_FROM_IMAGE
:
4933 p
->u
.image
.object
= it
->object
;
4934 p
->u
.image
.image_id
= it
->image_id
;
4935 p
->u
.image
.slice
= it
->slice
;
4937 case GET_FROM_STRETCH
:
4938 p
->u
.stretch
.object
= it
->object
;
4941 p
->position
= it
->position
;
4942 p
->current
= it
->current
;
4943 p
->end_charpos
= it
->end_charpos
;
4944 p
->string_nchars
= it
->string_nchars
;
4946 p
->multibyte_p
= it
->multibyte_p
;
4947 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4948 p
->space_width
= it
->space_width
;
4949 p
->font_height
= it
->font_height
;
4950 p
->voffset
= it
->voffset
;
4951 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4952 p
->display_ellipsis_p
= 0;
4953 p
->line_wrap
= it
->line_wrap
;
4958 iterate_out_of_display_property (struct it
*it
)
4960 /* Maybe initialize paragraph direction. If we are at the beginning
4961 of a new paragraph, next_element_from_buffer may not have a
4962 chance to do that. */
4963 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4964 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4965 /* prev_stop can be zero, so check against BEGV as well. */
4966 while (it
->bidi_it
.charpos
>= BEGV
4967 && it
->prev_stop
<= it
->bidi_it
.charpos
4968 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4969 bidi_move_to_visually_next (&it
->bidi_it
);
4970 /* Record the stop_pos we just crossed, for when we cross it
4972 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4973 it
->prev_stop
= CHARPOS (it
->position
);
4974 /* If we ended up not where pop_it put us, resync IT's
4975 positional members with the bidi iterator. */
4976 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
4978 SET_TEXT_POS (it
->position
,
4979 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
4980 it
->current
.pos
= it
->position
;
4984 /* Restore IT's settings from IT->stack. Called, for example, when no
4985 more overlay strings must be processed, and we return to delivering
4986 display elements from a buffer, or when the end of a string from a
4987 `display' property is reached and we return to delivering display
4988 elements from an overlay string, or from a buffer. */
4991 pop_it (struct it
*it
)
4993 struct iterator_stack_entry
*p
;
4995 xassert (it
->sp
> 0);
4997 p
= it
->stack
+ it
->sp
;
4998 it
->stop_charpos
= p
->stop_charpos
;
4999 it
->prev_stop
= p
->prev_stop
;
5000 it
->base_level_stop
= p
->base_level_stop
;
5001 it
->cmp_it
= p
->cmp_it
;
5002 it
->face_id
= p
->face_id
;
5003 it
->current
= p
->current
;
5004 it
->position
= p
->position
;
5005 it
->string
= p
->string
;
5006 it
->from_overlay
= p
->from_overlay
;
5007 if (NILP (it
->string
))
5008 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5009 it
->method
= p
->method
;
5012 case GET_FROM_IMAGE
:
5013 it
->image_id
= p
->u
.image
.image_id
;
5014 it
->object
= p
->u
.image
.object
;
5015 it
->slice
= p
->u
.image
.slice
;
5017 case GET_FROM_STRETCH
:
5018 it
->object
= p
->u
.comp
.object
;
5020 case GET_FROM_BUFFER
:
5021 it
->object
= it
->w
->buffer
;
5024 /* Bidi-iterate until we get out of the portion of text, if
5025 any, covered by a `display' text property or an overlay
5026 with `display' property. (We cannot just jump there,
5027 because the internal coherency of the bidi iterator state
5028 can not be preserved across such jumps.) We also must
5029 determine the paragraph base direction if the overlay we
5030 just processed is at the beginning of a new
5032 iterate_out_of_display_property (it
);
5035 case GET_FROM_STRING
:
5036 it
->object
= it
->string
;
5038 case GET_FROM_DISPLAY_VECTOR
:
5040 it
->method
= GET_FROM_C_STRING
;
5041 else if (STRINGP (it
->string
))
5042 it
->method
= GET_FROM_STRING
;
5045 it
->method
= GET_FROM_BUFFER
;
5046 it
->object
= it
->w
->buffer
;
5049 it
->end_charpos
= p
->end_charpos
;
5050 it
->string_nchars
= p
->string_nchars
;
5052 it
->multibyte_p
= p
->multibyte_p
;
5053 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5054 it
->space_width
= p
->space_width
;
5055 it
->font_height
= p
->font_height
;
5056 it
->voffset
= p
->voffset
;
5057 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5058 it
->line_wrap
= p
->line_wrap
;
5063 /***********************************************************************
5065 ***********************************************************************/
5067 /* Set IT's current position to the previous line start. */
5070 back_to_previous_line_start (struct it
*it
)
5072 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5073 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5077 /* Move IT to the next line start.
5079 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5080 we skipped over part of the text (as opposed to moving the iterator
5081 continuously over the text). Otherwise, don't change the value
5084 Newlines may come from buffer text, overlay strings, or strings
5085 displayed via the `display' property. That's the reason we can't
5086 simply use find_next_newline_no_quit.
5088 Note that this function may not skip over invisible text that is so
5089 because of text properties and immediately follows a newline. If
5090 it would, function reseat_at_next_visible_line_start, when called
5091 from set_iterator_to_next, would effectively make invisible
5092 characters following a newline part of the wrong glyph row, which
5093 leads to wrong cursor motion. */
5096 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5098 int old_selective
, newline_found_p
, n
;
5099 const int MAX_NEWLINE_DISTANCE
= 500;
5101 /* If already on a newline, just consume it to avoid unintended
5102 skipping over invisible text below. */
5103 if (it
->what
== IT_CHARACTER
5105 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5107 set_iterator_to_next (it
, 0);
5112 /* Don't handle selective display in the following. It's (a)
5113 unnecessary because it's done by the caller, and (b) leads to an
5114 infinite recursion because next_element_from_ellipsis indirectly
5115 calls this function. */
5116 old_selective
= it
->selective
;
5119 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5120 from buffer text. */
5121 for (n
= newline_found_p
= 0;
5122 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5123 n
+= STRINGP (it
->string
) ? 0 : 1)
5125 if (!get_next_display_element (it
))
5127 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5128 set_iterator_to_next (it
, 0);
5131 /* If we didn't find a newline near enough, see if we can use a
5133 if (!newline_found_p
)
5135 EMACS_INT start
= IT_CHARPOS (*it
);
5136 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5139 xassert (!STRINGP (it
->string
));
5141 /* If there isn't any `display' property in sight, and no
5142 overlays, we can just use the position of the newline in
5144 if (it
->stop_charpos
>= limit
5145 || ((pos
= Fnext_single_property_change (make_number (start
),
5147 Qnil
, make_number (limit
)),
5149 && next_overlay_change (start
) == ZV
))
5151 IT_CHARPOS (*it
) = limit
;
5152 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5153 *skipped_p
= newline_found_p
= 1;
5157 while (get_next_display_element (it
)
5158 && !newline_found_p
)
5160 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5161 set_iterator_to_next (it
, 0);
5166 it
->selective
= old_selective
;
5167 return newline_found_p
;
5171 /* Set IT's current position to the previous visible line start. Skip
5172 invisible text that is so either due to text properties or due to
5173 selective display. Caution: this does not change IT->current_x and
5177 back_to_previous_visible_line_start (struct it
*it
)
5179 while (IT_CHARPOS (*it
) > BEGV
)
5181 back_to_previous_line_start (it
);
5183 if (IT_CHARPOS (*it
) <= BEGV
)
5186 /* If selective > 0, then lines indented more than its value are
5188 if (it
->selective
> 0
5189 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5190 (double) it
->selective
)) /* iftc */
5193 /* Check the newline before point for invisibility. */
5196 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5197 Qinvisible
, it
->window
);
5198 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5202 if (IT_CHARPOS (*it
) <= BEGV
)
5209 Lisp_Object val
, overlay
;
5211 /* If newline is part of a composition, continue from start of composition */
5212 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5213 && beg
< IT_CHARPOS (*it
))
5216 /* If newline is replaced by a display property, find start of overlay
5217 or interval and continue search from that point. */
5219 pos
= --IT_CHARPOS (it2
);
5222 it2
.string_from_display_prop_p
= 0;
5223 if (handle_display_prop (&it2
) == HANDLED_RETURN
5224 && !NILP (val
= get_char_property_and_overlay
5225 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5226 && (OVERLAYP (overlay
)
5227 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5228 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5231 /* Newline is not replaced by anything -- so we are done. */
5237 IT_CHARPOS (*it
) = beg
;
5238 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5242 it
->continuation_lines_width
= 0;
5244 xassert (IT_CHARPOS (*it
) >= BEGV
);
5245 xassert (IT_CHARPOS (*it
) == BEGV
5246 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5251 /* Reseat iterator IT at the previous visible line start. Skip
5252 invisible text that is so either due to text properties or due to
5253 selective display. At the end, update IT's overlay information,
5254 face information etc. */
5257 reseat_at_previous_visible_line_start (struct it
*it
)
5259 back_to_previous_visible_line_start (it
);
5260 reseat (it
, it
->current
.pos
, 1);
5265 /* Reseat iterator IT on the next visible line start in the current
5266 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5267 preceding the line start. Skip over invisible text that is so
5268 because of selective display. Compute faces, overlays etc at the
5269 new position. Note that this function does not skip over text that
5270 is invisible because of text properties. */
5273 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5275 int newline_found_p
, skipped_p
= 0;
5277 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5279 /* Skip over lines that are invisible because they are indented
5280 more than the value of IT->selective. */
5281 if (it
->selective
> 0)
5282 while (IT_CHARPOS (*it
) < ZV
5283 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5284 (double) it
->selective
)) /* iftc */
5286 xassert (IT_BYTEPOS (*it
) == BEGV
5287 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5288 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5291 /* Position on the newline if that's what's requested. */
5292 if (on_newline_p
&& newline_found_p
)
5294 if (STRINGP (it
->string
))
5296 if (IT_STRING_CHARPOS (*it
) > 0)
5298 --IT_STRING_CHARPOS (*it
);
5299 --IT_STRING_BYTEPOS (*it
);
5302 else if (IT_CHARPOS (*it
) > BEGV
)
5306 reseat (it
, it
->current
.pos
, 0);
5310 reseat (it
, it
->current
.pos
, 0);
5317 /***********************************************************************
5318 Changing an iterator's position
5319 ***********************************************************************/
5321 /* Change IT's current position to POS in current_buffer. If FORCE_P
5322 is non-zero, always check for text properties at the new position.
5323 Otherwise, text properties are only looked up if POS >=
5324 IT->check_charpos of a property. */
5327 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5329 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5331 reseat_1 (it
, pos
, 0);
5333 /* Determine where to check text properties. Avoid doing it
5334 where possible because text property lookup is very expensive. */
5336 || CHARPOS (pos
) > it
->stop_charpos
5337 || CHARPOS (pos
) < original_pos
)
5341 /* For bidi iteration, we need to prime prev_stop and
5342 base_level_stop with our best estimations. */
5343 if (CHARPOS (pos
) < it
->prev_stop
)
5345 handle_stop_backwards (it
, BEGV
);
5346 if (CHARPOS (pos
) < it
->base_level_stop
)
5347 it
->base_level_stop
= 0;
5349 else if (CHARPOS (pos
) > it
->stop_charpos
5350 && it
->stop_charpos
>= BEGV
)
5351 handle_stop_backwards (it
, it
->stop_charpos
);
5358 it
->prev_stop
= it
->base_level_stop
= 0;
5367 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5368 IT->stop_pos to POS, also. */
5371 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5373 /* Don't call this function when scanning a C string. */
5374 xassert (it
->s
== NULL
);
5376 /* POS must be a reasonable value. */
5377 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5379 it
->current
.pos
= it
->position
= pos
;
5380 it
->end_charpos
= ZV
;
5382 it
->current
.dpvec_index
= -1;
5383 it
->current
.overlay_string_index
= -1;
5384 IT_STRING_CHARPOS (*it
) = -1;
5385 IT_STRING_BYTEPOS (*it
) = -1;
5387 it
->string_from_display_prop_p
= 0;
5388 it
->method
= GET_FROM_BUFFER
;
5389 it
->object
= it
->w
->buffer
;
5390 it
->area
= TEXT_AREA
;
5391 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5393 it
->string_from_display_prop_p
= 0;
5394 it
->face_before_selective_p
= 0;
5397 it
->bidi_it
.first_elt
= 1;
5398 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5399 it
->bidi_it
.disp_pos
= -1;
5404 it
->stop_charpos
= CHARPOS (pos
);
5405 it
->base_level_stop
= CHARPOS (pos
);
5410 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5411 If S is non-null, it is a C string to iterate over. Otherwise,
5412 STRING gives a Lisp string to iterate over.
5414 If PRECISION > 0, don't return more then PRECISION number of
5415 characters from the string.
5417 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5418 characters have been returned. FIELD_WIDTH < 0 means an infinite
5421 MULTIBYTE = 0 means disable processing of multibyte characters,
5422 MULTIBYTE > 0 means enable it,
5423 MULTIBYTE < 0 means use IT->multibyte_p.
5425 IT must be initialized via a prior call to init_iterator before
5426 calling this function. */
5429 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5430 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5433 /* No region in strings. */
5434 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5436 /* No text property checks performed by default, but see below. */
5437 it
->stop_charpos
= -1;
5439 /* Set iterator position and end position. */
5440 memset (&it
->current
, 0, sizeof it
->current
);
5441 it
->current
.overlay_string_index
= -1;
5442 it
->current
.dpvec_index
= -1;
5443 xassert (charpos
>= 0);
5445 /* If STRING is specified, use its multibyteness, otherwise use the
5446 setting of MULTIBYTE, if specified. */
5448 it
->multibyte_p
= multibyte
> 0;
5452 xassert (STRINGP (string
));
5453 it
->string
= string
;
5455 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5456 it
->method
= GET_FROM_STRING
;
5457 it
->current
.string_pos
= string_pos (charpos
, string
);
5461 it
->s
= (const unsigned char *) s
;
5464 /* Note that we use IT->current.pos, not it->current.string_pos,
5465 for displaying C strings. */
5466 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5467 if (it
->multibyte_p
)
5469 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5470 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5474 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5475 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5478 it
->method
= GET_FROM_C_STRING
;
5481 /* PRECISION > 0 means don't return more than PRECISION characters
5483 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5484 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5486 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5487 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5488 FIELD_WIDTH < 0 means infinite field width. This is useful for
5489 padding with `-' at the end of a mode line. */
5490 if (field_width
< 0)
5491 field_width
= INFINITY
;
5492 if (field_width
> it
->end_charpos
- charpos
)
5493 it
->end_charpos
= charpos
+ field_width
;
5495 /* Use the standard display table for displaying strings. */
5496 if (DISP_TABLE_P (Vstandard_display_table
))
5497 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5499 it
->stop_charpos
= charpos
;
5500 if (s
== NULL
&& it
->multibyte_p
)
5502 EMACS_INT endpos
= SCHARS (it
->string
);
5503 if (endpos
> it
->end_charpos
)
5504 endpos
= it
->end_charpos
;
5505 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5513 /***********************************************************************
5515 ***********************************************************************/
5517 /* Map enum it_method value to corresponding next_element_from_* function. */
5519 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5521 next_element_from_buffer
,
5522 next_element_from_display_vector
,
5523 next_element_from_string
,
5524 next_element_from_c_string
,
5525 next_element_from_image
,
5526 next_element_from_stretch
5529 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5532 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5533 (possibly with the following characters). */
5535 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5536 ((IT)->cmp_it.id >= 0 \
5537 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5538 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5539 END_CHARPOS, (IT)->w, \
5540 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5544 /* Lookup the char-table Vglyphless_char_display for character C (-1
5545 if we want information for no-font case), and return the display
5546 method symbol. By side-effect, update it->what and
5547 it->glyphless_method. This function is called from
5548 get_next_display_element for each character element, and from
5549 x_produce_glyphs when no suitable font was found. */
5552 lookup_glyphless_char_display (int c
, struct it
*it
)
5554 Lisp_Object glyphless_method
= Qnil
;
5556 if (CHAR_TABLE_P (Vglyphless_char_display
)
5557 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5561 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5562 if (CONSP (glyphless_method
))
5563 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5564 ? XCAR (glyphless_method
)
5565 : XCDR (glyphless_method
);
5568 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5572 if (NILP (glyphless_method
))
5575 /* The default is to display the character by a proper font. */
5577 /* The default for the no-font case is to display an empty box. */
5578 glyphless_method
= Qempty_box
;
5580 if (EQ (glyphless_method
, Qzero_width
))
5583 return glyphless_method
;
5584 /* This method can't be used for the no-font case. */
5585 glyphless_method
= Qempty_box
;
5587 if (EQ (glyphless_method
, Qthin_space
))
5588 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5589 else if (EQ (glyphless_method
, Qempty_box
))
5590 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5591 else if (EQ (glyphless_method
, Qhex_code
))
5592 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5593 else if (STRINGP (glyphless_method
))
5594 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5597 /* Invalid value. We use the default method. */
5598 glyphless_method
= Qnil
;
5601 it
->what
= IT_GLYPHLESS
;
5602 return glyphless_method
;
5605 /* Load IT's display element fields with information about the next
5606 display element from the current position of IT. Value is zero if
5607 end of buffer (or C string) is reached. */
5609 static struct frame
*last_escape_glyph_frame
= NULL
;
5610 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5611 static int last_escape_glyph_merged_face_id
= 0;
5613 struct frame
*last_glyphless_glyph_frame
= NULL
;
5614 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5615 int last_glyphless_glyph_merged_face_id
= 0;
5618 get_next_display_element (struct it
*it
)
5620 /* Non-zero means that we found a display element. Zero means that
5621 we hit the end of what we iterate over. Performance note: the
5622 function pointer `method' used here turns out to be faster than
5623 using a sequence of if-statements. */
5627 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5629 if (it
->what
== IT_CHARACTER
)
5631 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5632 and only if (a) the resolved directionality of that character
5634 /* FIXME: Do we need an exception for characters from display
5636 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5637 it
->c
= bidi_mirror_char (it
->c
);
5638 /* Map via display table or translate control characters.
5639 IT->c, IT->len etc. have been set to the next character by
5640 the function call above. If we have a display table, and it
5641 contains an entry for IT->c, translate it. Don't do this if
5642 IT->c itself comes from a display table, otherwise we could
5643 end up in an infinite recursion. (An alternative could be to
5644 count the recursion depth of this function and signal an
5645 error when a certain maximum depth is reached.) Is it worth
5647 if (success_p
&& it
->dpvec
== NULL
)
5650 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5651 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5652 nbsp_or_shy
= char_is_other
;
5653 int c
= it
->c
; /* This is the character to display. */
5655 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5657 xassert (SINGLE_BYTE_CHAR_P (c
));
5658 if (unibyte_display_via_language_environment
)
5660 c
= DECODE_CHAR (unibyte
, c
);
5662 c
= BYTE8_TO_CHAR (it
->c
);
5665 c
= BYTE8_TO_CHAR (it
->c
);
5669 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5672 struct Lisp_Vector
*v
= XVECTOR (dv
);
5674 /* Return the first character from the display table
5675 entry, if not empty. If empty, don't display the
5676 current character. */
5679 it
->dpvec_char_len
= it
->len
;
5680 it
->dpvec
= v
->contents
;
5681 it
->dpend
= v
->contents
+ v
->header
.size
;
5682 it
->current
.dpvec_index
= 0;
5683 it
->dpvec_face_id
= -1;
5684 it
->saved_face_id
= it
->face_id
;
5685 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5690 set_iterator_to_next (it
, 0);
5695 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5697 if (it
->what
== IT_GLYPHLESS
)
5699 /* Don't display this character. */
5700 set_iterator_to_next (it
, 0);
5704 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5705 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5706 : c
== 0xAD ? char_is_soft_hyphen
5709 /* Translate control characters into `\003' or `^C' form.
5710 Control characters coming from a display table entry are
5711 currently not translated because we use IT->dpvec to hold
5712 the translation. This could easily be changed but I
5713 don't believe that it is worth doing.
5715 NBSP and SOFT-HYPEN are property translated too.
5717 Non-printable characters and raw-byte characters are also
5718 translated to octal form. */
5719 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5720 ? (it
->area
!= TEXT_AREA
5721 /* In mode line, treat \n, \t like other crl chars. */
5724 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5725 || (c
!= '\n' && c
!= '\t'))
5728 || ! CHAR_PRINTABLE_P (c
))))
5730 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5731 or a non-printable character which must be displayed
5732 either as '\003' or as `^C' where the '\\' and '^'
5733 can be defined in the display table. Fill
5734 IT->ctl_chars with glyphs for what we have to
5735 display. Then, set IT->dpvec to these glyphs. */
5738 int face_id
, lface_id
= 0 ;
5741 /* Handle control characters with ^. */
5743 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5747 g
= '^'; /* default glyph for Control */
5748 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5750 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5751 && GLYPH_CODE_CHAR_VALID_P (gc
))
5753 g
= GLYPH_CODE_CHAR (gc
);
5754 lface_id
= GLYPH_CODE_FACE (gc
);
5758 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5760 else if (it
->f
== last_escape_glyph_frame
5761 && it
->face_id
== last_escape_glyph_face_id
)
5763 face_id
= last_escape_glyph_merged_face_id
;
5767 /* Merge the escape-glyph face into the current face. */
5768 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5770 last_escape_glyph_frame
= it
->f
;
5771 last_escape_glyph_face_id
= it
->face_id
;
5772 last_escape_glyph_merged_face_id
= face_id
;
5775 XSETINT (it
->ctl_chars
[0], g
);
5776 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5778 goto display_control
;
5781 /* Handle non-break space in the mode where it only gets
5784 if (EQ (Vnobreak_char_display
, Qt
)
5785 && nbsp_or_shy
== char_is_nbsp
)
5787 /* Merge the no-break-space face into the current face. */
5788 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5792 XSETINT (it
->ctl_chars
[0], ' ');
5794 goto display_control
;
5797 /* Handle sequences that start with the "escape glyph". */
5799 /* the default escape glyph is \. */
5800 escape_glyph
= '\\';
5803 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5804 && GLYPH_CODE_CHAR_VALID_P (gc
))
5806 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5807 lface_id
= GLYPH_CODE_FACE (gc
);
5811 /* The display table specified a face.
5812 Merge it into face_id and also into escape_glyph. */
5813 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5816 else if (it
->f
== last_escape_glyph_frame
5817 && it
->face_id
== last_escape_glyph_face_id
)
5819 face_id
= last_escape_glyph_merged_face_id
;
5823 /* Merge the escape-glyph face into the current face. */
5824 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5826 last_escape_glyph_frame
= it
->f
;
5827 last_escape_glyph_face_id
= it
->face_id
;
5828 last_escape_glyph_merged_face_id
= face_id
;
5831 /* Handle soft hyphens in the mode where they only get
5834 if (EQ (Vnobreak_char_display
, Qt
)
5835 && nbsp_or_shy
== char_is_soft_hyphen
)
5837 XSETINT (it
->ctl_chars
[0], '-');
5839 goto display_control
;
5842 /* Handle non-break space and soft hyphen
5843 with the escape glyph. */
5847 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5848 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5849 XSETINT (it
->ctl_chars
[1], c
);
5851 goto display_control
;
5858 if (CHAR_BYTE8_P (c
))
5859 /* Display \200 instead of \17777600. */
5860 c
= CHAR_TO_BYTE8 (c
);
5861 len
= sprintf (str
, "%03o", c
);
5863 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5864 for (i
= 0; i
< len
; i
++)
5865 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5870 /* Set up IT->dpvec and return first character from it. */
5871 it
->dpvec_char_len
= it
->len
;
5872 it
->dpvec
= it
->ctl_chars
;
5873 it
->dpend
= it
->dpvec
+ ctl_len
;
5874 it
->current
.dpvec_index
= 0;
5875 it
->dpvec_face_id
= face_id
;
5876 it
->saved_face_id
= it
->face_id
;
5877 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5881 it
->char_to_display
= c
;
5885 it
->char_to_display
= it
->c
;
5889 /* Adjust face id for a multibyte character. There are no multibyte
5890 character in unibyte text. */
5891 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5894 && FRAME_WINDOW_P (it
->f
))
5896 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5898 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5900 /* Automatic composition with glyph-string. */
5901 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5903 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5907 EMACS_INT pos
= (it
->s
? -1
5908 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5909 : IT_CHARPOS (*it
));
5911 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5917 /* Is this character the last one of a run of characters with
5918 box? If yes, set IT->end_of_box_run_p to 1. */
5922 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5924 int face_id
= underlying_face_id (it
);
5925 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5929 if (face
->box
== FACE_NO_BOX
)
5931 /* If the box comes from face properties in a
5932 display string, check faces in that string. */
5933 int string_face_id
= face_after_it_pos (it
);
5934 it
->end_of_box_run_p
5935 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5938 /* Otherwise, the box comes from the underlying face.
5939 If this is the last string character displayed, check
5940 the next buffer location. */
5941 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5942 && (it
->current
.overlay_string_index
5943 == it
->n_overlay_strings
- 1))
5947 struct text_pos pos
= it
->current
.pos
;
5948 INC_TEXT_POS (pos
, it
->multibyte_p
);
5950 next_face_id
= face_at_buffer_position
5951 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5952 it
->region_end_charpos
, &ignore
,
5953 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5955 it
->end_of_box_run_p
5956 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5963 int face_id
= face_after_it_pos (it
);
5964 it
->end_of_box_run_p
5965 = (face_id
!= it
->face_id
5966 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5970 /* Value is 0 if end of buffer or string reached. */
5975 /* Move IT to the next display element.
5977 RESEAT_P non-zero means if called on a newline in buffer text,
5978 skip to the next visible line start.
5980 Functions get_next_display_element and set_iterator_to_next are
5981 separate because I find this arrangement easier to handle than a
5982 get_next_display_element function that also increments IT's
5983 position. The way it is we can first look at an iterator's current
5984 display element, decide whether it fits on a line, and if it does,
5985 increment the iterator position. The other way around we probably
5986 would either need a flag indicating whether the iterator has to be
5987 incremented the next time, or we would have to implement a
5988 decrement position function which would not be easy to write. */
5991 set_iterator_to_next (struct it
*it
, int reseat_p
)
5993 /* Reset flags indicating start and end of a sequence of characters
5994 with box. Reset them at the start of this function because
5995 moving the iterator to a new position might set them. */
5996 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6000 case GET_FROM_BUFFER
:
6001 /* The current display element of IT is a character from
6002 current_buffer. Advance in the buffer, and maybe skip over
6003 invisible lines that are so because of selective display. */
6004 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6005 reseat_at_next_visible_line_start (it
, 0);
6006 else if (it
->cmp_it
.id
>= 0)
6008 /* We are currently getting glyphs from a composition. */
6013 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6014 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6015 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6017 it
->cmp_it
.from
= it
->cmp_it
.to
;
6022 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6024 it
->end_charpos
, Qnil
);
6027 else if (! it
->cmp_it
.reversed_p
)
6029 /* Composition created while scanning forward. */
6030 /* Update IT's char/byte positions to point to the first
6031 character of the next grapheme cluster, or to the
6032 character visually after the current composition. */
6033 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6034 bidi_move_to_visually_next (&it
->bidi_it
);
6035 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6036 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6038 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6040 /* Proceed to the next grapheme cluster. */
6041 it
->cmp_it
.from
= it
->cmp_it
.to
;
6045 /* No more grapheme clusters in this composition.
6046 Find the next stop position. */
6047 EMACS_INT stop
= it
->end_charpos
;
6048 if (it
->bidi_it
.scan_dir
< 0)
6049 /* Now we are scanning backward and don't know
6052 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6053 IT_BYTEPOS (*it
), stop
, Qnil
);
6058 /* Composition created while scanning backward. */
6059 /* Update IT's char/byte positions to point to the last
6060 character of the previous grapheme cluster, or the
6061 character visually after the current composition. */
6062 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6063 bidi_move_to_visually_next (&it
->bidi_it
);
6064 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6065 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6066 if (it
->cmp_it
.from
> 0)
6068 /* Proceed to the previous grapheme cluster. */
6069 it
->cmp_it
.to
= it
->cmp_it
.from
;
6073 /* No more grapheme clusters in this composition.
6074 Find the next stop position. */
6075 EMACS_INT stop
= it
->end_charpos
;
6076 if (it
->bidi_it
.scan_dir
< 0)
6077 /* Now we are scanning backward and don't know
6080 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6081 IT_BYTEPOS (*it
), stop
, Qnil
);
6087 xassert (it
->len
!= 0);
6091 IT_BYTEPOS (*it
) += it
->len
;
6092 IT_CHARPOS (*it
) += 1;
6096 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6097 /* If this is a new paragraph, determine its base
6098 direction (a.k.a. its base embedding level). */
6099 if (it
->bidi_it
.new_paragraph
)
6100 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6101 bidi_move_to_visually_next (&it
->bidi_it
);
6102 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6103 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6104 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6106 /* As the scan direction was changed, we must
6107 re-compute the stop position for composition. */
6108 EMACS_INT stop
= it
->end_charpos
;
6109 if (it
->bidi_it
.scan_dir
< 0)
6111 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6112 IT_BYTEPOS (*it
), stop
, Qnil
);
6115 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6119 case GET_FROM_C_STRING
:
6120 /* Current display element of IT is from a C string. */
6121 IT_BYTEPOS (*it
) += it
->len
;
6122 IT_CHARPOS (*it
) += 1;
6125 case GET_FROM_DISPLAY_VECTOR
:
6126 /* Current display element of IT is from a display table entry.
6127 Advance in the display table definition. Reset it to null if
6128 end reached, and continue with characters from buffers/
6130 ++it
->current
.dpvec_index
;
6132 /* Restore face of the iterator to what they were before the
6133 display vector entry (these entries may contain faces). */
6134 it
->face_id
= it
->saved_face_id
;
6136 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6138 int recheck_faces
= it
->ellipsis_p
;
6141 it
->method
= GET_FROM_C_STRING
;
6142 else if (STRINGP (it
->string
))
6143 it
->method
= GET_FROM_STRING
;
6146 it
->method
= GET_FROM_BUFFER
;
6147 it
->object
= it
->w
->buffer
;
6151 it
->current
.dpvec_index
= -1;
6153 /* Skip over characters which were displayed via IT->dpvec. */
6154 if (it
->dpvec_char_len
< 0)
6155 reseat_at_next_visible_line_start (it
, 1);
6156 else if (it
->dpvec_char_len
> 0)
6158 if (it
->method
== GET_FROM_STRING
6159 && it
->n_overlay_strings
> 0)
6160 it
->ignore_overlay_strings_at_pos_p
= 1;
6161 it
->len
= it
->dpvec_char_len
;
6162 set_iterator_to_next (it
, reseat_p
);
6165 /* Maybe recheck faces after display vector */
6167 it
->stop_charpos
= IT_CHARPOS (*it
);
6171 case GET_FROM_STRING
:
6172 /* Current display element is a character from a Lisp string. */
6173 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6174 if (it
->cmp_it
.id
>= 0)
6176 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6177 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6178 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6179 it
->cmp_it
.from
= it
->cmp_it
.to
;
6183 composition_compute_stop_pos (&it
->cmp_it
,
6184 IT_STRING_CHARPOS (*it
),
6185 IT_STRING_BYTEPOS (*it
),
6186 it
->end_charpos
, it
->string
);
6191 IT_STRING_BYTEPOS (*it
) += it
->len
;
6192 IT_STRING_CHARPOS (*it
) += 1;
6195 consider_string_end
:
6197 if (it
->current
.overlay_string_index
>= 0)
6199 /* IT->string is an overlay string. Advance to the
6200 next, if there is one. */
6201 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6204 next_overlay_string (it
);
6206 setup_for_ellipsis (it
, 0);
6211 /* IT->string is not an overlay string. If we reached
6212 its end, and there is something on IT->stack, proceed
6213 with what is on the stack. This can be either another
6214 string, this time an overlay string, or a buffer. */
6215 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6219 if (it
->method
== GET_FROM_STRING
)
6220 goto consider_string_end
;
6225 case GET_FROM_IMAGE
:
6226 case GET_FROM_STRETCH
:
6227 /* The position etc with which we have to proceed are on
6228 the stack. The position may be at the end of a string,
6229 if the `display' property takes up the whole string. */
6230 xassert (it
->sp
> 0);
6232 if (it
->method
== GET_FROM_STRING
)
6233 goto consider_string_end
;
6237 /* There are no other methods defined, so this should be a bug. */
6241 xassert (it
->method
!= GET_FROM_STRING
6242 || (STRINGP (it
->string
)
6243 && IT_STRING_CHARPOS (*it
) >= 0));
6246 /* Load IT's display element fields with information about the next
6247 display element which comes from a display table entry or from the
6248 result of translating a control character to one of the forms `^C'
6251 IT->dpvec holds the glyphs to return as characters.
6252 IT->saved_face_id holds the face id before the display vector--it
6253 is restored into IT->face_id in set_iterator_to_next. */
6256 next_element_from_display_vector (struct it
*it
)
6261 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6263 it
->face_id
= it
->saved_face_id
;
6265 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6266 That seemed totally bogus - so I changed it... */
6267 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6269 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6271 it
->c
= GLYPH_CODE_CHAR (gc
);
6272 it
->len
= CHAR_BYTES (it
->c
);
6274 /* The entry may contain a face id to use. Such a face id is
6275 the id of a Lisp face, not a realized face. A face id of
6276 zero means no face is specified. */
6277 if (it
->dpvec_face_id
>= 0)
6278 it
->face_id
= it
->dpvec_face_id
;
6281 int lface_id
= GLYPH_CODE_FACE (gc
);
6283 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6288 /* Display table entry is invalid. Return a space. */
6289 it
->c
= ' ', it
->len
= 1;
6291 /* Don't change position and object of the iterator here. They are
6292 still the values of the character that had this display table
6293 entry or was translated, and that's what we want. */
6294 it
->what
= IT_CHARACTER
;
6299 /* Load IT with the next display element from Lisp string IT->string.
6300 IT->current.string_pos is the current position within the string.
6301 If IT->current.overlay_string_index >= 0, the Lisp string is an
6305 next_element_from_string (struct it
*it
)
6307 struct text_pos position
;
6309 xassert (STRINGP (it
->string
));
6310 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6311 position
= it
->current
.string_pos
;
6313 /* Time to check for invisible text? */
6314 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6315 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6319 /* Since a handler may have changed IT->method, we must
6321 return GET_NEXT_DISPLAY_ELEMENT (it
);
6324 if (it
->current
.overlay_string_index
>= 0)
6326 /* Get the next character from an overlay string. In overlay
6327 strings, There is no field width or padding with spaces to
6329 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6334 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6335 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6336 && next_element_from_composition (it
))
6340 else if (STRING_MULTIBYTE (it
->string
))
6342 const unsigned char *s
= (SDATA (it
->string
)
6343 + IT_STRING_BYTEPOS (*it
));
6344 it
->c
= string_char_and_length (s
, &it
->len
);
6348 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6354 /* Get the next character from a Lisp string that is not an
6355 overlay string. Such strings come from the mode line, for
6356 example. We may have to pad with spaces, or truncate the
6357 string. See also next_element_from_c_string. */
6358 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6363 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6365 /* Pad with spaces. */
6366 it
->c
= ' ', it
->len
= 1;
6367 CHARPOS (position
) = BYTEPOS (position
) = -1;
6369 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6370 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6371 && next_element_from_composition (it
))
6375 else if (STRING_MULTIBYTE (it
->string
))
6377 const unsigned char *s
= (SDATA (it
->string
)
6378 + IT_STRING_BYTEPOS (*it
));
6379 it
->c
= string_char_and_length (s
, &it
->len
);
6383 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6388 /* Record what we have and where it came from. */
6389 it
->what
= IT_CHARACTER
;
6390 it
->object
= it
->string
;
6391 it
->position
= position
;
6396 /* Load IT with next display element from C string IT->s.
6397 IT->string_nchars is the maximum number of characters to return
6398 from the string. IT->end_charpos may be greater than
6399 IT->string_nchars when this function is called, in which case we
6400 may have to return padding spaces. Value is zero if end of string
6401 reached, including padding spaces. */
6404 next_element_from_c_string (struct it
*it
)
6409 it
->what
= IT_CHARACTER
;
6410 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6413 /* IT's position can be greater IT->string_nchars in case a field
6414 width or precision has been specified when the iterator was
6416 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6418 /* End of the game. */
6422 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6424 /* Pad with spaces. */
6425 it
->c
= ' ', it
->len
= 1;
6426 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6428 else if (it
->multibyte_p
)
6429 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6431 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6437 /* Set up IT to return characters from an ellipsis, if appropriate.
6438 The definition of the ellipsis glyphs may come from a display table
6439 entry. This function fills IT with the first glyph from the
6440 ellipsis if an ellipsis is to be displayed. */
6443 next_element_from_ellipsis (struct it
*it
)
6445 if (it
->selective_display_ellipsis_p
)
6446 setup_for_ellipsis (it
, it
->len
);
6449 /* The face at the current position may be different from the
6450 face we find after the invisible text. Remember what it
6451 was in IT->saved_face_id, and signal that it's there by
6452 setting face_before_selective_p. */
6453 it
->saved_face_id
= it
->face_id
;
6454 it
->method
= GET_FROM_BUFFER
;
6455 it
->object
= it
->w
->buffer
;
6456 reseat_at_next_visible_line_start (it
, 1);
6457 it
->face_before_selective_p
= 1;
6460 return GET_NEXT_DISPLAY_ELEMENT (it
);
6464 /* Deliver an image display element. The iterator IT is already
6465 filled with image information (done in handle_display_prop). Value
6470 next_element_from_image (struct it
*it
)
6472 it
->what
= IT_IMAGE
;
6473 it
->ignore_overlay_strings_at_pos_p
= 0;
6478 /* Fill iterator IT with next display element from a stretch glyph
6479 property. IT->object is the value of the text property. Value is
6483 next_element_from_stretch (struct it
*it
)
6485 it
->what
= IT_STRETCH
;
6489 /* Scan forward from CHARPOS in the current buffer, until we find a
6490 stop position > current IT's position. Then handle the stop
6491 position before that. This is called when we bump into a stop
6492 position while reordering bidirectional text. CHARPOS should be
6493 the last previously processed stop_pos (or BEGV, if none were
6494 processed yet) whose position is less that IT's current
6498 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6500 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6501 struct display_pos save_current
= it
->current
;
6502 struct text_pos save_position
= it
->position
;
6503 struct text_pos pos1
;
6504 EMACS_INT next_stop
;
6506 /* Scan in strict logical order. */
6510 it
->prev_stop
= charpos
;
6511 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6512 reseat_1 (it
, pos1
, 0);
6513 compute_stop_pos (it
);
6514 /* We must advance forward, right? */
6515 if (it
->stop_charpos
<= it
->prev_stop
)
6517 charpos
= it
->stop_charpos
;
6519 while (charpos
<= where_we_are
);
6521 next_stop
= it
->stop_charpos
;
6522 it
->stop_charpos
= it
->prev_stop
;
6524 it
->current
= save_current
;
6525 it
->position
= save_position
;
6527 it
->stop_charpos
= next_stop
;
6530 /* Load IT with the next display element from current_buffer. Value
6531 is zero if end of buffer reached. IT->stop_charpos is the next
6532 position at which to stop and check for text properties or buffer
6536 next_element_from_buffer (struct it
*it
)
6540 xassert (IT_CHARPOS (*it
) >= BEGV
);
6542 /* With bidi reordering, the character to display might not be the
6543 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6544 we were reseat()ed to a new buffer position, which is potentially
6545 a different paragraph. */
6546 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6548 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6549 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6550 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6552 /* Nothing to do, but reset the FIRST_ELT flag, like
6553 bidi_paragraph_init does, because we are not going to
6555 it
->bidi_it
.first_elt
= 0;
6557 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6558 /* FIXME: Should support all Unicode line separators. */
6559 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6560 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6562 /* If we are at the beginning of a line, we can produce the
6563 next element right away. */
6564 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6565 bidi_move_to_visually_next (&it
->bidi_it
);
6569 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6571 /* We need to prime the bidi iterator starting at the line's
6572 beginning, before we will be able to produce the next
6574 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6575 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6576 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6577 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6578 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6581 /* Now return to buffer position where we were asked to
6582 get the next display element, and produce that. */
6583 bidi_move_to_visually_next (&it
->bidi_it
);
6585 while (it
->bidi_it
.bytepos
!= orig_bytepos
6586 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6589 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6590 /* Adjust IT's position information to where we ended up. */
6591 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6592 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6593 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6595 EMACS_INT stop
= it
->end_charpos
;
6596 if (it
->bidi_it
.scan_dir
< 0)
6598 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6599 IT_BYTEPOS (*it
), stop
, Qnil
);
6603 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6605 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6607 int overlay_strings_follow_p
;
6609 /* End of the game, except when overlay strings follow that
6610 haven't been returned yet. */
6611 if (it
->overlay_strings_at_end_processed_p
)
6612 overlay_strings_follow_p
= 0;
6615 it
->overlay_strings_at_end_processed_p
= 1;
6616 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6619 if (overlay_strings_follow_p
)
6620 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6624 it
->position
= it
->current
.pos
;
6628 else if (!(!it
->bidi_p
6629 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6630 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6632 /* With bidi non-linear iteration, we could find ourselves
6633 far beyond the last computed stop_charpos, with several
6634 other stop positions in between that we missed. Scan
6635 them all now, in buffer's logical order, until we find
6636 and handle the last stop_charpos that precedes our
6637 current position. */
6638 handle_stop_backwards (it
, it
->stop_charpos
);
6639 return GET_NEXT_DISPLAY_ELEMENT (it
);
6645 /* Take note of the stop position we just moved across,
6646 for when we will move back across it. */
6647 it
->prev_stop
= it
->stop_charpos
;
6648 /* If we are at base paragraph embedding level, take
6649 note of the last stop position seen at this
6651 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6652 it
->base_level_stop
= it
->stop_charpos
;
6655 return GET_NEXT_DISPLAY_ELEMENT (it
);
6659 /* We can sometimes back up for reasons that have nothing
6660 to do with bidi reordering. E.g., compositions. The
6661 code below is only needed when we are above the base
6662 embedding level, so test for that explicitly. */
6663 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6664 && IT_CHARPOS (*it
) < it
->prev_stop
)
6666 if (it
->base_level_stop
<= 0)
6667 it
->base_level_stop
= BEGV
;
6668 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6670 handle_stop_backwards (it
, it
->base_level_stop
);
6671 return GET_NEXT_DISPLAY_ELEMENT (it
);
6675 /* No face changes, overlays etc. in sight, so just return a
6676 character from current_buffer. */
6680 /* Maybe run the redisplay end trigger hook. Performance note:
6681 This doesn't seem to cost measurable time. */
6682 if (it
->redisplay_end_trigger_charpos
6684 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6685 run_redisplay_end_trigger_hook (it
);
6687 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6688 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6690 && next_element_from_composition (it
))
6695 /* Get the next character, maybe multibyte. */
6696 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6697 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6698 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6700 it
->c
= *p
, it
->len
= 1;
6702 /* Record what we have and where it came from. */
6703 it
->what
= IT_CHARACTER
;
6704 it
->object
= it
->w
->buffer
;
6705 it
->position
= it
->current
.pos
;
6707 /* Normally we return the character found above, except when we
6708 really want to return an ellipsis for selective display. */
6713 /* A value of selective > 0 means hide lines indented more
6714 than that number of columns. */
6715 if (it
->selective
> 0
6716 && IT_CHARPOS (*it
) + 1 < ZV
6717 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6718 IT_BYTEPOS (*it
) + 1,
6719 (double) it
->selective
)) /* iftc */
6721 success_p
= next_element_from_ellipsis (it
);
6722 it
->dpvec_char_len
= -1;
6725 else if (it
->c
== '\r' && it
->selective
== -1)
6727 /* A value of selective == -1 means that everything from the
6728 CR to the end of the line is invisible, with maybe an
6729 ellipsis displayed for it. */
6730 success_p
= next_element_from_ellipsis (it
);
6731 it
->dpvec_char_len
= -1;
6736 /* Value is zero if end of buffer reached. */
6737 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6742 /* Run the redisplay end trigger hook for IT. */
6745 run_redisplay_end_trigger_hook (struct it
*it
)
6747 Lisp_Object args
[3];
6749 /* IT->glyph_row should be non-null, i.e. we should be actually
6750 displaying something, or otherwise we should not run the hook. */
6751 xassert (it
->glyph_row
);
6753 /* Set up hook arguments. */
6754 args
[0] = Qredisplay_end_trigger_functions
;
6755 args
[1] = it
->window
;
6756 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6757 it
->redisplay_end_trigger_charpos
= 0;
6759 /* Since we are *trying* to run these functions, don't try to run
6760 them again, even if they get an error. */
6761 it
->w
->redisplay_end_trigger
= Qnil
;
6762 Frun_hook_with_args (3, args
);
6764 /* Notice if it changed the face of the character we are on. */
6765 handle_face_prop (it
);
6769 /* Deliver a composition display element. Unlike the other
6770 next_element_from_XXX, this function is not registered in the array
6771 get_next_element[]. It is called from next_element_from_buffer and
6772 next_element_from_string when necessary. */
6775 next_element_from_composition (struct it
*it
)
6777 it
->what
= IT_COMPOSITION
;
6778 it
->len
= it
->cmp_it
.nbytes
;
6779 if (STRINGP (it
->string
))
6783 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6784 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6787 it
->position
= it
->current
.string_pos
;
6788 it
->object
= it
->string
;
6789 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6790 IT_STRING_BYTEPOS (*it
), it
->string
);
6796 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6797 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6800 if (it
->bidi_it
.new_paragraph
)
6801 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6802 /* Resync the bidi iterator with IT's new position.
6803 FIXME: this doesn't support bidirectional text. */
6804 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6805 bidi_move_to_visually_next (&it
->bidi_it
);
6809 it
->position
= it
->current
.pos
;
6810 it
->object
= it
->w
->buffer
;
6811 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6812 IT_BYTEPOS (*it
), Qnil
);
6819 /***********************************************************************
6820 Moving an iterator without producing glyphs
6821 ***********************************************************************/
6823 /* Check if iterator is at a position corresponding to a valid buffer
6824 position after some move_it_ call. */
6826 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6827 ((it)->method == GET_FROM_STRING \
6828 ? IT_STRING_CHARPOS (*it) == 0 \
6832 /* Move iterator IT to a specified buffer or X position within one
6833 line on the display without producing glyphs.
6835 OP should be a bit mask including some or all of these bits:
6836 MOVE_TO_X: Stop upon reaching x-position TO_X.
6837 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6838 Regardless of OP's value, stop upon reaching the end of the display line.
6840 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6841 This means, in particular, that TO_X includes window's horizontal
6844 The return value has several possible values that
6845 say what condition caused the scan to stop:
6847 MOVE_POS_MATCH_OR_ZV
6848 - when TO_POS or ZV was reached.
6851 -when TO_X was reached before TO_POS or ZV were reached.
6854 - when we reached the end of the display area and the line must
6858 - when we reached the end of the display area and the line is
6862 - when we stopped at a line end, i.e. a newline or a CR and selective
6865 static enum move_it_result
6866 move_it_in_display_line_to (struct it
*it
,
6867 EMACS_INT to_charpos
, int to_x
,
6868 enum move_operation_enum op
)
6870 enum move_it_result result
= MOVE_UNDEFINED
;
6871 struct glyph_row
*saved_glyph_row
;
6872 struct it wrap_it
, atpos_it
, atx_it
;
6874 enum it_method prev_method
= it
->method
;
6875 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6877 /* Don't produce glyphs in produce_glyphs. */
6878 saved_glyph_row
= it
->glyph_row
;
6879 it
->glyph_row
= NULL
;
6881 /* Use wrap_it to save a copy of IT wherever a word wrap could
6882 occur. Use atpos_it to save a copy of IT at the desired buffer
6883 position, if found, so that we can scan ahead and check if the
6884 word later overshoots the window edge. Use atx_it similarly, for
6890 #define BUFFER_POS_REACHED_P() \
6891 ((op & MOVE_TO_POS) != 0 \
6892 && BUFFERP (it->object) \
6893 && (IT_CHARPOS (*it) == to_charpos \
6894 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6895 && (it->method == GET_FROM_BUFFER \
6896 || (it->method == GET_FROM_DISPLAY_VECTOR \
6897 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6899 /* If there's a line-/wrap-prefix, handle it. */
6900 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6901 && it
->current_y
< it
->last_visible_y
)
6902 handle_line_prefix (it
);
6904 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6905 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6909 int x
, i
, ascent
= 0, descent
= 0;
6911 /* Utility macro to reset an iterator with x, ascent, and descent. */
6912 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6913 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6914 (IT)->max_descent = descent)
6916 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6918 if ((op
& MOVE_TO_POS
) != 0
6919 && BUFFERP (it
->object
)
6920 && it
->method
== GET_FROM_BUFFER
6921 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6923 && (prev_method
== GET_FROM_IMAGE
6924 || prev_method
== GET_FROM_STRETCH
)
6925 /* Passed TO_CHARPOS from left to right. */
6926 && ((prev_pos
< to_charpos
6927 && IT_CHARPOS (*it
) > to_charpos
)
6928 /* Passed TO_CHARPOS from right to left. */
6929 || (prev_pos
> to_charpos
6930 && IT_CHARPOS (*it
) < to_charpos
)))))
6932 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6934 result
= MOVE_POS_MATCH_OR_ZV
;
6937 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6938 /* If wrap_it is valid, the current position might be in a
6939 word that is wrapped. So, save the iterator in
6940 atpos_it and continue to see if wrapping happens. */
6944 prev_method
= it
->method
;
6945 if (it
->method
== GET_FROM_BUFFER
)
6946 prev_pos
= IT_CHARPOS (*it
);
6947 /* Stop when ZV reached.
6948 We used to stop here when TO_CHARPOS reached as well, but that is
6949 too soon if this glyph does not fit on this line. So we handle it
6950 explicitly below. */
6951 if (!get_next_display_element (it
))
6953 result
= MOVE_POS_MATCH_OR_ZV
;
6957 if (it
->line_wrap
== TRUNCATE
)
6959 if (BUFFER_POS_REACHED_P ())
6961 result
= MOVE_POS_MATCH_OR_ZV
;
6967 if (it
->line_wrap
== WORD_WRAP
)
6969 if (IT_DISPLAYING_WHITESPACE (it
))
6973 /* We have reached a glyph that follows one or more
6974 whitespace characters. If the position is
6975 already found, we are done. */
6976 if (atpos_it
.sp
>= 0)
6979 result
= MOVE_POS_MATCH_OR_ZV
;
6985 result
= MOVE_X_REACHED
;
6988 /* Otherwise, we can wrap here. */
6995 /* Remember the line height for the current line, in case
6996 the next element doesn't fit on the line. */
6997 ascent
= it
->max_ascent
;
6998 descent
= it
->max_descent
;
7000 /* The call to produce_glyphs will get the metrics of the
7001 display element IT is loaded with. Record the x-position
7002 before this display element, in case it doesn't fit on the
7006 PRODUCE_GLYPHS (it
);
7008 if (it
->area
!= TEXT_AREA
)
7010 set_iterator_to_next (it
, 1);
7011 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7012 SET_TEXT_POS (this_line_min_pos
,
7013 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7017 /* The number of glyphs we get back in IT->nglyphs will normally
7018 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7019 character on a terminal frame, or (iii) a line end. For the
7020 second case, IT->nglyphs - 1 padding glyphs will be present.
7021 (On X frames, there is only one glyph produced for a
7022 composite character.)
7024 The behavior implemented below means, for continuation lines,
7025 that as many spaces of a TAB as fit on the current line are
7026 displayed there. For terminal frames, as many glyphs of a
7027 multi-glyph character are displayed in the current line, too.
7028 This is what the old redisplay code did, and we keep it that
7029 way. Under X, the whole shape of a complex character must
7030 fit on the line or it will be completely displayed in the
7033 Note that both for tabs and padding glyphs, all glyphs have
7037 /* More than one glyph or glyph doesn't fit on line. All
7038 glyphs have the same width. */
7039 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7041 int x_before_this_char
= x
;
7042 int hpos_before_this_char
= it
->hpos
;
7044 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7046 new_x
= x
+ single_glyph_width
;
7048 /* We want to leave anything reaching TO_X to the caller. */
7049 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7051 if (BUFFER_POS_REACHED_P ())
7053 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7054 goto buffer_pos_reached
;
7055 if (atpos_it
.sp
< 0)
7058 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7063 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7066 result
= MOVE_X_REACHED
;
7072 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7077 if (/* Lines are continued. */
7078 it
->line_wrap
!= TRUNCATE
7079 && (/* And glyph doesn't fit on the line. */
7080 new_x
> it
->last_visible_x
7081 /* Or it fits exactly and we're on a window
7083 || (new_x
== it
->last_visible_x
7084 && FRAME_WINDOW_P (it
->f
))))
7086 if (/* IT->hpos == 0 means the very first glyph
7087 doesn't fit on the line, e.g. a wide image. */
7089 || (new_x
== it
->last_visible_x
7090 && FRAME_WINDOW_P (it
->f
)))
7093 it
->current_x
= new_x
;
7095 /* The character's last glyph just barely fits
7097 if (i
== it
->nglyphs
- 1)
7099 /* If this is the destination position,
7100 return a position *before* it in this row,
7101 now that we know it fits in this row. */
7102 if (BUFFER_POS_REACHED_P ())
7104 if (it
->line_wrap
!= WORD_WRAP
7107 it
->hpos
= hpos_before_this_char
;
7108 it
->current_x
= x_before_this_char
;
7109 result
= MOVE_POS_MATCH_OR_ZV
;
7112 if (it
->line_wrap
== WORD_WRAP
7116 atpos_it
.current_x
= x_before_this_char
;
7117 atpos_it
.hpos
= hpos_before_this_char
;
7121 set_iterator_to_next (it
, 1);
7122 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7123 SET_TEXT_POS (this_line_min_pos
,
7124 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7125 /* On graphical terminals, newlines may
7126 "overflow" into the fringe if
7127 overflow-newline-into-fringe is non-nil.
7128 On text-only terminals, newlines may
7129 overflow into the last glyph on the
7131 if (!FRAME_WINDOW_P (it
->f
)
7132 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7134 if (!get_next_display_element (it
))
7136 result
= MOVE_POS_MATCH_OR_ZV
;
7139 if (BUFFER_POS_REACHED_P ())
7141 if (ITERATOR_AT_END_OF_LINE_P (it
))
7142 result
= MOVE_POS_MATCH_OR_ZV
;
7144 result
= MOVE_LINE_CONTINUED
;
7147 if (ITERATOR_AT_END_OF_LINE_P (it
))
7149 result
= MOVE_NEWLINE_OR_CR
;
7156 IT_RESET_X_ASCENT_DESCENT (it
);
7158 if (wrap_it
.sp
>= 0)
7165 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7167 result
= MOVE_LINE_CONTINUED
;
7171 if (BUFFER_POS_REACHED_P ())
7173 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7174 goto buffer_pos_reached
;
7175 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7178 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7182 if (new_x
> it
->first_visible_x
)
7184 /* Glyph is visible. Increment number of glyphs that
7185 would be displayed. */
7190 if (result
!= MOVE_UNDEFINED
)
7193 else if (BUFFER_POS_REACHED_P ())
7196 IT_RESET_X_ASCENT_DESCENT (it
);
7197 result
= MOVE_POS_MATCH_OR_ZV
;
7200 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7202 /* Stop when TO_X specified and reached. This check is
7203 necessary here because of lines consisting of a line end,
7204 only. The line end will not produce any glyphs and we
7205 would never get MOVE_X_REACHED. */
7206 xassert (it
->nglyphs
== 0);
7207 result
= MOVE_X_REACHED
;
7211 /* Is this a line end? If yes, we're done. */
7212 if (ITERATOR_AT_END_OF_LINE_P (it
))
7214 result
= MOVE_NEWLINE_OR_CR
;
7218 if (it
->method
== GET_FROM_BUFFER
)
7219 prev_pos
= IT_CHARPOS (*it
);
7220 /* The current display element has been consumed. Advance
7222 set_iterator_to_next (it
, 1);
7223 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7224 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7226 /* Stop if lines are truncated and IT's current x-position is
7227 past the right edge of the window now. */
7228 if (it
->line_wrap
== TRUNCATE
7229 && it
->current_x
>= it
->last_visible_x
)
7231 if (!FRAME_WINDOW_P (it
->f
)
7232 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7234 if (!get_next_display_element (it
)
7235 || BUFFER_POS_REACHED_P ())
7237 result
= MOVE_POS_MATCH_OR_ZV
;
7240 if (ITERATOR_AT_END_OF_LINE_P (it
))
7242 result
= MOVE_NEWLINE_OR_CR
;
7246 result
= MOVE_LINE_TRUNCATED
;
7249 #undef IT_RESET_X_ASCENT_DESCENT
7252 #undef BUFFER_POS_REACHED_P
7254 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7255 restore the saved iterator. */
7256 if (atpos_it
.sp
>= 0)
7258 else if (atx_it
.sp
>= 0)
7263 /* Restore the iterator settings altered at the beginning of this
7265 it
->glyph_row
= saved_glyph_row
;
7269 /* For external use. */
7271 move_it_in_display_line (struct it
*it
,
7272 EMACS_INT to_charpos
, int to_x
,
7273 enum move_operation_enum op
)
7275 if (it
->line_wrap
== WORD_WRAP
7276 && (op
& MOVE_TO_X
))
7278 struct it save_it
= *it
;
7279 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7280 /* When word-wrap is on, TO_X may lie past the end
7281 of a wrapped line. Then it->current is the
7282 character on the next line, so backtrack to the
7283 space before the wrap point. */
7284 if (skip
== MOVE_LINE_CONTINUED
)
7286 int prev_x
= max (it
->current_x
- 1, 0);
7288 move_it_in_display_line_to
7289 (it
, -1, prev_x
, MOVE_TO_X
);
7293 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7297 /* Move IT forward until it satisfies one or more of the criteria in
7298 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7300 OP is a bit-mask that specifies where to stop, and in particular,
7301 which of those four position arguments makes a difference. See the
7302 description of enum move_operation_enum.
7304 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7305 screen line, this function will set IT to the next position >
7309 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7311 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7312 int line_height
, line_start_x
= 0, reached
= 0;
7316 if (op
& MOVE_TO_VPOS
)
7318 /* If no TO_CHARPOS and no TO_X specified, stop at the
7319 start of the line TO_VPOS. */
7320 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7322 if (it
->vpos
== to_vpos
)
7328 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7332 /* TO_VPOS >= 0 means stop at TO_X in the line at
7333 TO_VPOS, or at TO_POS, whichever comes first. */
7334 if (it
->vpos
== to_vpos
)
7340 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7342 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7347 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7349 /* We have reached TO_X but not in the line we want. */
7350 skip
= move_it_in_display_line_to (it
, to_charpos
,
7352 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7360 else if (op
& MOVE_TO_Y
)
7362 struct it it_backup
;
7364 if (it
->line_wrap
== WORD_WRAP
)
7367 /* TO_Y specified means stop at TO_X in the line containing
7368 TO_Y---or at TO_CHARPOS if this is reached first. The
7369 problem is that we can't really tell whether the line
7370 contains TO_Y before we have completely scanned it, and
7371 this may skip past TO_X. What we do is to first scan to
7374 If TO_X is not specified, use a TO_X of zero. The reason
7375 is to make the outcome of this function more predictable.
7376 If we didn't use TO_X == 0, we would stop at the end of
7377 the line which is probably not what a caller would expect
7379 skip
= move_it_in_display_line_to
7380 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7381 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7383 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7384 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7386 else if (skip
== MOVE_X_REACHED
)
7388 /* If TO_X was reached, we want to know whether TO_Y is
7389 in the line. We know this is the case if the already
7390 scanned glyphs make the line tall enough. Otherwise,
7391 we must check by scanning the rest of the line. */
7392 line_height
= it
->max_ascent
+ it
->max_descent
;
7393 if (to_y
>= it
->current_y
7394 && to_y
< it
->current_y
+ line_height
)
7400 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7401 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7403 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7404 line_height
= it
->max_ascent
+ it
->max_descent
;
7405 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7407 if (to_y
>= it
->current_y
7408 && to_y
< it
->current_y
+ line_height
)
7410 /* If TO_Y is in this line and TO_X was reached
7411 above, we scanned too far. We have to restore
7412 IT's settings to the ones before skipping. */
7419 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7425 /* Check whether TO_Y is in this line. */
7426 line_height
= it
->max_ascent
+ it
->max_descent
;
7427 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7429 if (to_y
>= it
->current_y
7430 && to_y
< it
->current_y
+ line_height
)
7432 /* When word-wrap is on, TO_X may lie past the end
7433 of a wrapped line. Then it->current is the
7434 character on the next line, so backtrack to the
7435 space before the wrap point. */
7436 if (skip
== MOVE_LINE_CONTINUED
7437 && it
->line_wrap
== WORD_WRAP
)
7439 int prev_x
= max (it
->current_x
- 1, 0);
7441 skip
= move_it_in_display_line_to
7442 (it
, -1, prev_x
, MOVE_TO_X
);
7451 else if (BUFFERP (it
->object
)
7452 && (it
->method
== GET_FROM_BUFFER
7453 || it
->method
== GET_FROM_STRETCH
)
7454 && IT_CHARPOS (*it
) >= to_charpos
)
7455 skip
= MOVE_POS_MATCH_OR_ZV
;
7457 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7461 case MOVE_POS_MATCH_OR_ZV
:
7465 case MOVE_NEWLINE_OR_CR
:
7466 set_iterator_to_next (it
, 1);
7467 it
->continuation_lines_width
= 0;
7470 case MOVE_LINE_TRUNCATED
:
7471 it
->continuation_lines_width
= 0;
7472 reseat_at_next_visible_line_start (it
, 0);
7473 if ((op
& MOVE_TO_POS
) != 0
7474 && IT_CHARPOS (*it
) > to_charpos
)
7481 case MOVE_LINE_CONTINUED
:
7482 /* For continued lines ending in a tab, some of the glyphs
7483 associated with the tab are displayed on the current
7484 line. Since it->current_x does not include these glyphs,
7485 we use it->last_visible_x instead. */
7488 it
->continuation_lines_width
+= it
->last_visible_x
;
7489 /* When moving by vpos, ensure that the iterator really
7490 advances to the next line (bug#847, bug#969). Fixme:
7491 do we need to do this in other circumstances? */
7492 if (it
->current_x
!= it
->last_visible_x
7493 && (op
& MOVE_TO_VPOS
)
7494 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7496 line_start_x
= it
->current_x
+ it
->pixel_width
7497 - it
->last_visible_x
;
7498 set_iterator_to_next (it
, 0);
7502 it
->continuation_lines_width
+= it
->current_x
;
7509 /* Reset/increment for the next run. */
7510 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7511 it
->current_x
= line_start_x
;
7514 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7516 last_height
= it
->max_ascent
+ it
->max_descent
;
7517 last_max_ascent
= it
->max_ascent
;
7518 it
->max_ascent
= it
->max_descent
= 0;
7523 /* On text terminals, we may stop at the end of a line in the middle
7524 of a multi-character glyph. If the glyph itself is continued,
7525 i.e. it is actually displayed on the next line, don't treat this
7526 stopping point as valid; move to the next line instead (unless
7527 that brings us offscreen). */
7528 if (!FRAME_WINDOW_P (it
->f
)
7530 && IT_CHARPOS (*it
) == to_charpos
7531 && it
->what
== IT_CHARACTER
7533 && it
->line_wrap
== WINDOW_WRAP
7534 && it
->current_x
== it
->last_visible_x
- 1
7537 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7539 it
->continuation_lines_width
+= it
->current_x
;
7540 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7541 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7543 last_height
= it
->max_ascent
+ it
->max_descent
;
7544 last_max_ascent
= it
->max_ascent
;
7547 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7551 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7553 If DY > 0, move IT backward at least that many pixels. DY = 0
7554 means move IT backward to the preceding line start or BEGV. This
7555 function may move over more than DY pixels if IT->current_y - DY
7556 ends up in the middle of a line; in this case IT->current_y will be
7557 set to the top of the line moved to. */
7560 move_it_vertically_backward (struct it
*it
, int dy
)
7564 EMACS_INT start_pos
;
7569 start_pos
= IT_CHARPOS (*it
);
7571 /* Estimate how many newlines we must move back. */
7572 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7574 /* Set the iterator's position that many lines back. */
7575 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7576 back_to_previous_visible_line_start (it
);
7578 /* Reseat the iterator here. When moving backward, we don't want
7579 reseat to skip forward over invisible text, set up the iterator
7580 to deliver from overlay strings at the new position etc. So,
7581 use reseat_1 here. */
7582 reseat_1 (it
, it
->current
.pos
, 1);
7584 /* We are now surely at a line start. */
7585 it
->current_x
= it
->hpos
= 0;
7586 it
->continuation_lines_width
= 0;
7588 /* Move forward and see what y-distance we moved. First move to the
7589 start of the next line so that we get its height. We need this
7590 height to be able to tell whether we reached the specified
7593 it2
.max_ascent
= it2
.max_descent
= 0;
7596 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7597 MOVE_TO_POS
| MOVE_TO_VPOS
);
7599 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7600 xassert (IT_CHARPOS (*it
) >= BEGV
);
7603 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7604 xassert (IT_CHARPOS (*it
) >= BEGV
);
7605 /* H is the actual vertical distance from the position in *IT
7606 and the starting position. */
7607 h
= it2
.current_y
- it
->current_y
;
7608 /* NLINES is the distance in number of lines. */
7609 nlines
= it2
.vpos
- it
->vpos
;
7611 /* Correct IT's y and vpos position
7612 so that they are relative to the starting point. */
7618 /* DY == 0 means move to the start of the screen line. The
7619 value of nlines is > 0 if continuation lines were involved. */
7621 move_it_by_lines (it
, nlines
);
7625 /* The y-position we try to reach, relative to *IT.
7626 Note that H has been subtracted in front of the if-statement. */
7627 int target_y
= it
->current_y
+ h
- dy
;
7628 int y0
= it3
.current_y
;
7629 int y1
= line_bottom_y (&it3
);
7630 int line_height
= y1
- y0
;
7632 /* If we did not reach target_y, try to move further backward if
7633 we can. If we moved too far backward, try to move forward. */
7634 if (target_y
< it
->current_y
7635 /* This is heuristic. In a window that's 3 lines high, with
7636 a line height of 13 pixels each, recentering with point
7637 on the bottom line will try to move -39/2 = 19 pixels
7638 backward. Try to avoid moving into the first line. */
7639 && (it
->current_y
- target_y
7640 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7641 && IT_CHARPOS (*it
) > BEGV
)
7643 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7644 target_y
- it
->current_y
));
7645 dy
= it
->current_y
- target_y
;
7646 goto move_further_back
;
7648 else if (target_y
>= it
->current_y
+ line_height
7649 && IT_CHARPOS (*it
) < ZV
)
7651 /* Should move forward by at least one line, maybe more.
7653 Note: Calling move_it_by_lines can be expensive on
7654 terminal frames, where compute_motion is used (via
7655 vmotion) to do the job, when there are very long lines
7656 and truncate-lines is nil. That's the reason for
7657 treating terminal frames specially here. */
7659 if (!FRAME_WINDOW_P (it
->f
))
7660 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7665 move_it_by_lines (it
, 1);
7667 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7674 /* Move IT by a specified amount of pixel lines DY. DY negative means
7675 move backwards. DY = 0 means move to start of screen line. At the
7676 end, IT will be on the start of a screen line. */
7679 move_it_vertically (struct it
*it
, int dy
)
7682 move_it_vertically_backward (it
, -dy
);
7685 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7686 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7687 MOVE_TO_POS
| MOVE_TO_Y
);
7688 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7690 /* If buffer ends in ZV without a newline, move to the start of
7691 the line to satisfy the post-condition. */
7692 if (IT_CHARPOS (*it
) == ZV
7694 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7695 move_it_by_lines (it
, 0);
7700 /* Move iterator IT past the end of the text line it is in. */
7703 move_it_past_eol (struct it
*it
)
7705 enum move_it_result rc
;
7707 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7708 if (rc
== MOVE_NEWLINE_OR_CR
)
7709 set_iterator_to_next (it
, 0);
7713 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7714 negative means move up. DVPOS == 0 means move to the start of the
7717 Optimization idea: If we would know that IT->f doesn't use
7718 a face with proportional font, we could be faster for
7719 truncate-lines nil. */
7722 move_it_by_lines (struct it
*it
, int dvpos
)
7725 /* The commented-out optimization uses vmotion on terminals. This
7726 gives bad results, because elements like it->what, on which
7727 callers such as pos_visible_p rely, aren't updated. */
7728 /* struct position pos;
7729 if (!FRAME_WINDOW_P (it->f))
7731 struct text_pos textpos;
7733 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7734 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7735 reseat (it, textpos, 1);
7736 it->vpos += pos.vpos;
7737 it->current_y += pos.vpos;
7743 /* DVPOS == 0 means move to the start of the screen line. */
7744 move_it_vertically_backward (it
, 0);
7745 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7746 /* Let next call to line_bottom_y calculate real line height */
7751 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7752 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7753 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7758 EMACS_INT start_charpos
, i
;
7760 /* Start at the beginning of the screen line containing IT's
7761 position. This may actually move vertically backwards,
7762 in case of overlays, so adjust dvpos accordingly. */
7764 move_it_vertically_backward (it
, 0);
7767 /* Go back -DVPOS visible lines and reseat the iterator there. */
7768 start_charpos
= IT_CHARPOS (*it
);
7769 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7770 back_to_previous_visible_line_start (it
);
7771 reseat (it
, it
->current
.pos
, 1);
7773 /* Move further back if we end up in a string or an image. */
7774 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7776 /* First try to move to start of display line. */
7778 move_it_vertically_backward (it
, 0);
7780 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7782 /* If start of line is still in string or image,
7783 move further back. */
7784 back_to_previous_visible_line_start (it
);
7785 reseat (it
, it
->current
.pos
, 1);
7789 it
->current_x
= it
->hpos
= 0;
7791 /* Above call may have moved too far if continuation lines
7792 are involved. Scan forward and see if it did. */
7794 it2
.vpos
= it2
.current_y
= 0;
7795 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7796 it
->vpos
-= it2
.vpos
;
7797 it
->current_y
-= it2
.current_y
;
7798 it
->current_x
= it
->hpos
= 0;
7800 /* If we moved too far back, move IT some lines forward. */
7801 if (it2
.vpos
> -dvpos
)
7803 int delta
= it2
.vpos
+ dvpos
;
7805 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7806 /* Move back again if we got too far ahead. */
7807 if (IT_CHARPOS (*it
) >= start_charpos
)
7813 /* Return 1 if IT points into the middle of a display vector. */
7816 in_display_vector_p (struct it
*it
)
7818 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7819 && it
->current
.dpvec_index
> 0
7820 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7824 /***********************************************************************
7826 ***********************************************************************/
7829 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7833 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7835 Lisp_Object args
[3];
7836 Lisp_Object msg
, fmt
;
7839 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7842 /* Do nothing if called asynchronously. Inserting text into
7843 a buffer may call after-change-functions and alike and
7844 that would means running Lisp asynchronously. */
7845 if (handling_signal
)
7849 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7851 args
[0] = fmt
= build_string (format
);
7854 msg
= Fformat (3, args
);
7856 len
= SBYTES (msg
) + 1;
7857 SAFE_ALLOCA (buffer
, char *, len
);
7858 memcpy (buffer
, SDATA (msg
), len
);
7860 message_dolog (buffer
, len
- 1, 1, 0);
7867 /* Output a newline in the *Messages* buffer if "needs" one. */
7870 message_log_maybe_newline (void)
7872 if (message_log_need_newline
)
7873 message_dolog ("", 0, 1, 0);
7877 /* Add a string M of length NBYTES to the message log, optionally
7878 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7879 nonzero, means interpret the contents of M as multibyte. This
7880 function calls low-level routines in order to bypass text property
7881 hooks, etc. which might not be safe to run.
7883 This may GC (insert may run before/after change hooks),
7884 so the buffer M must NOT point to a Lisp string. */
7887 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7889 const unsigned char *msg
= (const unsigned char *) m
;
7891 if (!NILP (Vmemory_full
))
7894 if (!NILP (Vmessage_log_max
))
7896 struct buffer
*oldbuf
;
7897 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7898 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7899 EMACS_INT point_at_end
= 0;
7900 EMACS_INT zv_at_end
= 0;
7901 Lisp_Object old_deactivate_mark
, tem
;
7902 struct gcpro gcpro1
;
7904 old_deactivate_mark
= Vdeactivate_mark
;
7905 oldbuf
= current_buffer
;
7906 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7907 BVAR (current_buffer
, undo_list
) = Qt
;
7909 oldpoint
= message_dolog_marker1
;
7910 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7911 oldbegv
= message_dolog_marker2
;
7912 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7913 oldzv
= message_dolog_marker3
;
7914 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7915 GCPRO1 (old_deactivate_mark
);
7923 BEGV_BYTE
= BEG_BYTE
;
7926 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7928 /* Insert the string--maybe converting multibyte to single byte
7929 or vice versa, so that all the text fits the buffer. */
7931 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7937 /* Convert a multibyte string to single-byte
7938 for the *Message* buffer. */
7939 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7941 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7942 work
[0] = (ASCII_CHAR_P (c
)
7944 : multibyte_char_to_unibyte (c
));
7945 insert_1_both (work
, 1, 1, 1, 0, 0);
7948 else if (! multibyte
7949 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7953 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7954 /* Convert a single-byte string to multibyte
7955 for the *Message* buffer. */
7956 for (i
= 0; i
< nbytes
; i
++)
7959 MAKE_CHAR_MULTIBYTE (c
);
7960 char_bytes
= CHAR_STRING (c
, str
);
7961 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7965 insert_1 (m
, nbytes
, 1, 0, 0);
7969 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7970 unsigned long int dups
;
7971 insert_1 ("\n", 1, 1, 0, 0);
7973 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7975 this_bol_byte
= PT_BYTE
;
7977 /* See if this line duplicates the previous one.
7978 If so, combine duplicates. */
7981 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7983 prev_bol_byte
= PT_BYTE
;
7985 dups
= message_log_check_duplicate (prev_bol_byte
,
7989 del_range_both (prev_bol
, prev_bol_byte
,
7990 this_bol
, this_bol_byte
, 0);
7996 /* If you change this format, don't forget to also
7997 change message_log_check_duplicate. */
7998 sprintf (dupstr
, " [%lu times]", dups
);
7999 duplen
= strlen (dupstr
);
8000 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8001 insert_1 (dupstr
, duplen
, 1, 0, 1);
8006 /* If we have more than the desired maximum number of lines
8007 in the *Messages* buffer now, delete the oldest ones.
8008 This is safe because we don't have undo in this buffer. */
8010 if (NATNUMP (Vmessage_log_max
))
8012 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8013 -XFASTINT (Vmessage_log_max
) - 1, 0);
8014 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8017 BEGV
= XMARKER (oldbegv
)->charpos
;
8018 BEGV_BYTE
= marker_byte_position (oldbegv
);
8027 ZV
= XMARKER (oldzv
)->charpos
;
8028 ZV_BYTE
= marker_byte_position (oldzv
);
8032 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8034 /* We can't do Fgoto_char (oldpoint) because it will run some
8036 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8037 XMARKER (oldpoint
)->bytepos
);
8040 unchain_marker (XMARKER (oldpoint
));
8041 unchain_marker (XMARKER (oldbegv
));
8042 unchain_marker (XMARKER (oldzv
));
8044 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8045 set_buffer_internal (oldbuf
);
8047 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8048 message_log_need_newline
= !nlflag
;
8049 Vdeactivate_mark
= old_deactivate_mark
;
8054 /* We are at the end of the buffer after just having inserted a newline.
8055 (Note: We depend on the fact we won't be crossing the gap.)
8056 Check to see if the most recent message looks a lot like the previous one.
8057 Return 0 if different, 1 if the new one should just replace it, or a
8058 value N > 1 if we should also append " [N times]". */
8060 static unsigned long int
8061 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8064 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8066 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8067 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8069 for (i
= 0; i
< len
; i
++)
8071 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8079 if (*p1
++ == ' ' && *p1
++ == '[')
8082 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8083 if (strncmp (pend
, " times]\n", 8) == 0)
8090 /* Display an echo area message M with a specified length of NBYTES
8091 bytes. The string may include null characters. If M is 0, clear
8092 out any existing message, and let the mini-buffer text show
8095 This may GC, so the buffer M must NOT point to a Lisp string. */
8098 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8100 /* First flush out any partial line written with print. */
8101 message_log_maybe_newline ();
8103 message_dolog (m
, nbytes
, 1, multibyte
);
8104 message2_nolog (m
, nbytes
, multibyte
);
8108 /* The non-logging counterpart of message2. */
8111 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8113 struct frame
*sf
= SELECTED_FRAME ();
8114 message_enable_multibyte
= multibyte
;
8116 if (FRAME_INITIAL_P (sf
))
8118 if (noninteractive_need_newline
)
8119 putc ('\n', stderr
);
8120 noninteractive_need_newline
= 0;
8122 fwrite (m
, nbytes
, 1, stderr
);
8123 if (cursor_in_echo_area
== 0)
8124 fprintf (stderr
, "\n");
8127 /* A null message buffer means that the frame hasn't really been
8128 initialized yet. Error messages get reported properly by
8129 cmd_error, so this must be just an informative message; toss it. */
8130 else if (INTERACTIVE
8131 && sf
->glyphs_initialized_p
8132 && FRAME_MESSAGE_BUF (sf
))
8134 Lisp_Object mini_window
;
8137 /* Get the frame containing the mini-buffer
8138 that the selected frame is using. */
8139 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8140 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8142 FRAME_SAMPLE_VISIBILITY (f
);
8143 if (FRAME_VISIBLE_P (sf
)
8144 && ! FRAME_VISIBLE_P (f
))
8145 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8149 set_message (m
, Qnil
, nbytes
, multibyte
);
8150 if (minibuffer_auto_raise
)
8151 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8154 clear_message (1, 1);
8156 do_pending_window_change (0);
8157 echo_area_display (1);
8158 do_pending_window_change (0);
8159 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8160 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8165 /* Display an echo area message M with a specified length of NBYTES
8166 bytes. The string may include null characters. If M is not a
8167 string, clear out any existing message, and let the mini-buffer
8170 This function cancels echoing. */
8173 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8175 struct gcpro gcpro1
;
8178 clear_message (1,1);
8181 /* First flush out any partial line written with print. */
8182 message_log_maybe_newline ();
8188 SAFE_ALLOCA (buffer
, char *, nbytes
);
8189 memcpy (buffer
, SDATA (m
), nbytes
);
8190 message_dolog (buffer
, nbytes
, 1, multibyte
);
8193 message3_nolog (m
, nbytes
, multibyte
);
8199 /* The non-logging version of message3.
8200 This does not cancel echoing, because it is used for echoing.
8201 Perhaps we need to make a separate function for echoing
8202 and make this cancel echoing. */
8205 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8207 struct frame
*sf
= SELECTED_FRAME ();
8208 message_enable_multibyte
= multibyte
;
8210 if (FRAME_INITIAL_P (sf
))
8212 if (noninteractive_need_newline
)
8213 putc ('\n', stderr
);
8214 noninteractive_need_newline
= 0;
8216 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8217 if (cursor_in_echo_area
== 0)
8218 fprintf (stderr
, "\n");
8221 /* A null message buffer means that the frame hasn't really been
8222 initialized yet. Error messages get reported properly by
8223 cmd_error, so this must be just an informative message; toss it. */
8224 else if (INTERACTIVE
8225 && sf
->glyphs_initialized_p
8226 && FRAME_MESSAGE_BUF (sf
))
8228 Lisp_Object mini_window
;
8232 /* Get the frame containing the mini-buffer
8233 that the selected frame is using. */
8234 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8235 frame
= XWINDOW (mini_window
)->frame
;
8238 FRAME_SAMPLE_VISIBILITY (f
);
8239 if (FRAME_VISIBLE_P (sf
)
8240 && !FRAME_VISIBLE_P (f
))
8241 Fmake_frame_visible (frame
);
8243 if (STRINGP (m
) && SCHARS (m
) > 0)
8245 set_message (NULL
, m
, nbytes
, multibyte
);
8246 if (minibuffer_auto_raise
)
8247 Fraise_frame (frame
);
8248 /* Assume we are not echoing.
8249 (If we are, echo_now will override this.) */
8250 echo_message_buffer
= Qnil
;
8253 clear_message (1, 1);
8255 do_pending_window_change (0);
8256 echo_area_display (1);
8257 do_pending_window_change (0);
8258 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8259 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8264 /* Display a null-terminated echo area message M. If M is 0, clear
8265 out any existing message, and let the mini-buffer text show through.
8267 The buffer M must continue to exist until after the echo area gets
8268 cleared or some other message gets displayed there. Do not pass
8269 text that is stored in a Lisp string. Do not pass text in a buffer
8270 that was alloca'd. */
8273 message1 (const char *m
)
8275 message2 (m
, (m
? strlen (m
) : 0), 0);
8279 /* The non-logging counterpart of message1. */
8282 message1_nolog (const char *m
)
8284 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8287 /* Display a message M which contains a single %s
8288 which gets replaced with STRING. */
8291 message_with_string (const char *m
, Lisp_Object string
, int log
)
8293 CHECK_STRING (string
);
8299 if (noninteractive_need_newline
)
8300 putc ('\n', stderr
);
8301 noninteractive_need_newline
= 0;
8302 fprintf (stderr
, m
, SDATA (string
));
8303 if (!cursor_in_echo_area
)
8304 fprintf (stderr
, "\n");
8308 else if (INTERACTIVE
)
8310 /* The frame whose minibuffer we're going to display the message on.
8311 It may be larger than the selected frame, so we need
8312 to use its buffer, not the selected frame's buffer. */
8313 Lisp_Object mini_window
;
8314 struct frame
*f
, *sf
= SELECTED_FRAME ();
8316 /* Get the frame containing the minibuffer
8317 that the selected frame is using. */
8318 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8319 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8321 /* A null message buffer means that the frame hasn't really been
8322 initialized yet. Error messages get reported properly by
8323 cmd_error, so this must be just an informative message; toss it. */
8324 if (FRAME_MESSAGE_BUF (f
))
8326 Lisp_Object args
[2], msg
;
8327 struct gcpro gcpro1
, gcpro2
;
8329 args
[0] = build_string (m
);
8330 args
[1] = msg
= string
;
8331 GCPRO2 (args
[0], msg
);
8334 msg
= Fformat (2, args
);
8337 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8339 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8343 /* Print should start at the beginning of the message
8344 buffer next time. */
8345 message_buf_print
= 0;
8351 /* Dump an informative message to the minibuf. If M is 0, clear out
8352 any existing message, and let the mini-buffer text show through. */
8355 vmessage (const char *m
, va_list ap
)
8361 if (noninteractive_need_newline
)
8362 putc ('\n', stderr
);
8363 noninteractive_need_newline
= 0;
8364 vfprintf (stderr
, m
, ap
);
8365 if (cursor_in_echo_area
== 0)
8366 fprintf (stderr
, "\n");
8370 else if (INTERACTIVE
)
8372 /* The frame whose mini-buffer we're going to display the message
8373 on. It may be larger than the selected frame, so we need to
8374 use its buffer, not the selected frame's buffer. */
8375 Lisp_Object mini_window
;
8376 struct frame
*f
, *sf
= SELECTED_FRAME ();
8378 /* Get the frame containing the mini-buffer
8379 that the selected frame is using. */
8380 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8381 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8383 /* A null message buffer means that the frame hasn't really been
8384 initialized yet. Error messages get reported properly by
8385 cmd_error, so this must be just an informative message; toss
8387 if (FRAME_MESSAGE_BUF (f
))
8393 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8394 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8396 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8401 /* Print should start at the beginning of the message
8402 buffer next time. */
8403 message_buf_print
= 0;
8409 message (const char *m
, ...)
8419 /* The non-logging version of message. */
8422 message_nolog (const char *m
, ...)
8424 Lisp_Object old_log_max
;
8427 old_log_max
= Vmessage_log_max
;
8428 Vmessage_log_max
= Qnil
;
8430 Vmessage_log_max
= old_log_max
;
8436 /* Display the current message in the current mini-buffer. This is
8437 only called from error handlers in process.c, and is not time
8441 update_echo_area (void)
8443 if (!NILP (echo_area_buffer
[0]))
8446 string
= Fcurrent_message ();
8447 message3 (string
, SBYTES (string
),
8448 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8453 /* Make sure echo area buffers in `echo_buffers' are live.
8454 If they aren't, make new ones. */
8457 ensure_echo_area_buffers (void)
8461 for (i
= 0; i
< 2; ++i
)
8462 if (!BUFFERP (echo_buffer
[i
])
8463 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8466 Lisp_Object old_buffer
;
8469 old_buffer
= echo_buffer
[i
];
8470 sprintf (name
, " *Echo Area %d*", i
);
8471 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8472 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8473 /* to force word wrap in echo area -
8474 it was decided to postpone this*/
8475 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8477 for (j
= 0; j
< 2; ++j
)
8478 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8479 echo_area_buffer
[j
] = echo_buffer
[i
];
8484 /* Call FN with args A1..A4 with either the current or last displayed
8485 echo_area_buffer as current buffer.
8487 WHICH zero means use the current message buffer
8488 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8489 from echo_buffer[] and clear it.
8491 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8492 suitable buffer from echo_buffer[] and clear it.
8494 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8495 that the current message becomes the last displayed one, make
8496 choose a suitable buffer for echo_area_buffer[0], and clear it.
8498 Value is what FN returns. */
8501 with_echo_area_buffer (struct window
*w
, int which
,
8502 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8503 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8506 int this_one
, the_other
, clear_buffer_p
, rc
;
8507 int count
= SPECPDL_INDEX ();
8509 /* If buffers aren't live, make new ones. */
8510 ensure_echo_area_buffers ();
8515 this_one
= 0, the_other
= 1;
8517 this_one
= 1, the_other
= 0;
8520 this_one
= 0, the_other
= 1;
8523 /* We need a fresh one in case the current echo buffer equals
8524 the one containing the last displayed echo area message. */
8525 if (!NILP (echo_area_buffer
[this_one
])
8526 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8527 echo_area_buffer
[this_one
] = Qnil
;
8530 /* Choose a suitable buffer from echo_buffer[] is we don't
8532 if (NILP (echo_area_buffer
[this_one
]))
8534 echo_area_buffer
[this_one
]
8535 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8536 ? echo_buffer
[the_other
]
8537 : echo_buffer
[this_one
]);
8541 buffer
= echo_area_buffer
[this_one
];
8543 /* Don't get confused by reusing the buffer used for echoing
8544 for a different purpose. */
8545 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8548 record_unwind_protect (unwind_with_echo_area_buffer
,
8549 with_echo_area_buffer_unwind_data (w
));
8551 /* Make the echo area buffer current. Note that for display
8552 purposes, it is not necessary that the displayed window's buffer
8553 == current_buffer, except for text property lookup. So, let's
8554 only set that buffer temporarily here without doing a full
8555 Fset_window_buffer. We must also change w->pointm, though,
8556 because otherwise an assertions in unshow_buffer fails, and Emacs
8558 set_buffer_internal_1 (XBUFFER (buffer
));
8562 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8565 BVAR (current_buffer
, undo_list
) = Qt
;
8566 BVAR (current_buffer
, read_only
) = Qnil
;
8567 specbind (Qinhibit_read_only
, Qt
);
8568 specbind (Qinhibit_modification_hooks
, Qt
);
8570 if (clear_buffer_p
&& Z
> BEG
)
8573 xassert (BEGV
>= BEG
);
8574 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8576 rc
= fn (a1
, a2
, a3
, a4
);
8578 xassert (BEGV
>= BEG
);
8579 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8581 unbind_to (count
, Qnil
);
8586 /* Save state that should be preserved around the call to the function
8587 FN called in with_echo_area_buffer. */
8590 with_echo_area_buffer_unwind_data (struct window
*w
)
8593 Lisp_Object vector
, tmp
;
8595 /* Reduce consing by keeping one vector in
8596 Vwith_echo_area_save_vector. */
8597 vector
= Vwith_echo_area_save_vector
;
8598 Vwith_echo_area_save_vector
= Qnil
;
8601 vector
= Fmake_vector (make_number (7), Qnil
);
8603 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8604 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8605 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8609 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8610 ASET (vector
, i
, w
->buffer
); ++i
;
8611 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8612 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8617 for (; i
< end
; ++i
)
8618 ASET (vector
, i
, Qnil
);
8621 xassert (i
== ASIZE (vector
));
8626 /* Restore global state from VECTOR which was created by
8627 with_echo_area_buffer_unwind_data. */
8630 unwind_with_echo_area_buffer (Lisp_Object vector
)
8632 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8633 Vdeactivate_mark
= AREF (vector
, 1);
8634 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8636 if (WINDOWP (AREF (vector
, 3)))
8639 Lisp_Object buffer
, charpos
, bytepos
;
8641 w
= XWINDOW (AREF (vector
, 3));
8642 buffer
= AREF (vector
, 4);
8643 charpos
= AREF (vector
, 5);
8644 bytepos
= AREF (vector
, 6);
8647 set_marker_both (w
->pointm
, buffer
,
8648 XFASTINT (charpos
), XFASTINT (bytepos
));
8651 Vwith_echo_area_save_vector
= vector
;
8656 /* Set up the echo area for use by print functions. MULTIBYTE_P
8657 non-zero means we will print multibyte. */
8660 setup_echo_area_for_printing (int multibyte_p
)
8662 /* If we can't find an echo area any more, exit. */
8663 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8666 ensure_echo_area_buffers ();
8668 if (!message_buf_print
)
8670 /* A message has been output since the last time we printed.
8671 Choose a fresh echo area buffer. */
8672 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8673 echo_area_buffer
[0] = echo_buffer
[1];
8675 echo_area_buffer
[0] = echo_buffer
[0];
8677 /* Switch to that buffer and clear it. */
8678 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8679 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8683 int count
= SPECPDL_INDEX ();
8684 specbind (Qinhibit_read_only
, Qt
);
8685 /* Note that undo recording is always disabled. */
8687 unbind_to (count
, Qnil
);
8689 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8691 /* Set up the buffer for the multibyteness we need. */
8693 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8694 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8696 /* Raise the frame containing the echo area. */
8697 if (minibuffer_auto_raise
)
8699 struct frame
*sf
= SELECTED_FRAME ();
8700 Lisp_Object mini_window
;
8701 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8702 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8705 message_log_maybe_newline ();
8706 message_buf_print
= 1;
8710 if (NILP (echo_area_buffer
[0]))
8712 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8713 echo_area_buffer
[0] = echo_buffer
[1];
8715 echo_area_buffer
[0] = echo_buffer
[0];
8718 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8720 /* Someone switched buffers between print requests. */
8721 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8722 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8728 /* Display an echo area message in window W. Value is non-zero if W's
8729 height is changed. If display_last_displayed_message_p is
8730 non-zero, display the message that was last displayed, otherwise
8731 display the current message. */
8734 display_echo_area (struct window
*w
)
8736 int i
, no_message_p
, window_height_changed_p
, count
;
8738 /* Temporarily disable garbage collections while displaying the echo
8739 area. This is done because a GC can print a message itself.
8740 That message would modify the echo area buffer's contents while a
8741 redisplay of the buffer is going on, and seriously confuse
8743 count
= inhibit_garbage_collection ();
8745 /* If there is no message, we must call display_echo_area_1
8746 nevertheless because it resizes the window. But we will have to
8747 reset the echo_area_buffer in question to nil at the end because
8748 with_echo_area_buffer will sets it to an empty buffer. */
8749 i
= display_last_displayed_message_p
? 1 : 0;
8750 no_message_p
= NILP (echo_area_buffer
[i
]);
8752 window_height_changed_p
8753 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8754 display_echo_area_1
,
8755 (intptr_t) w
, Qnil
, 0, 0);
8758 echo_area_buffer
[i
] = Qnil
;
8760 unbind_to (count
, Qnil
);
8761 return window_height_changed_p
;
8765 /* Helper for display_echo_area. Display the current buffer which
8766 contains the current echo area message in window W, a mini-window,
8767 a pointer to which is passed in A1. A2..A4 are currently not used.
8768 Change the height of W so that all of the message is displayed.
8769 Value is non-zero if height of W was changed. */
8772 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8775 struct window
*w
= (struct window
*) i1
;
8777 struct text_pos start
;
8778 int window_height_changed_p
= 0;
8780 /* Do this before displaying, so that we have a large enough glyph
8781 matrix for the display. If we can't get enough space for the
8782 whole text, display the last N lines. That works by setting w->start. */
8783 window_height_changed_p
= resize_mini_window (w
, 0);
8785 /* Use the starting position chosen by resize_mini_window. */
8786 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8789 clear_glyph_matrix (w
->desired_matrix
);
8790 XSETWINDOW (window
, w
);
8791 try_window (window
, start
, 0);
8793 return window_height_changed_p
;
8797 /* Resize the echo area window to exactly the size needed for the
8798 currently displayed message, if there is one. If a mini-buffer
8799 is active, don't shrink it. */
8802 resize_echo_area_exactly (void)
8804 if (BUFFERP (echo_area_buffer
[0])
8805 && WINDOWP (echo_area_window
))
8807 struct window
*w
= XWINDOW (echo_area_window
);
8809 Lisp_Object resize_exactly
;
8811 if (minibuf_level
== 0)
8812 resize_exactly
= Qt
;
8814 resize_exactly
= Qnil
;
8816 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8817 (intptr_t) w
, resize_exactly
,
8821 ++windows_or_buffers_changed
;
8822 ++update_mode_lines
;
8823 redisplay_internal ();
8829 /* Callback function for with_echo_area_buffer, when used from
8830 resize_echo_area_exactly. A1 contains a pointer to the window to
8831 resize, EXACTLY non-nil means resize the mini-window exactly to the
8832 size of the text displayed. A3 and A4 are not used. Value is what
8833 resize_mini_window returns. */
8836 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8839 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
8843 /* Resize mini-window W to fit the size of its contents. EXACT_P
8844 means size the window exactly to the size needed. Otherwise, it's
8845 only enlarged until W's buffer is empty.
8847 Set W->start to the right place to begin display. If the whole
8848 contents fit, start at the beginning. Otherwise, start so as
8849 to make the end of the contents appear. This is particularly
8850 important for y-or-n-p, but seems desirable generally.
8852 Value is non-zero if the window height has been changed. */
8855 resize_mini_window (struct window
*w
, int exact_p
)
8857 struct frame
*f
= XFRAME (w
->frame
);
8858 int window_height_changed_p
= 0;
8860 xassert (MINI_WINDOW_P (w
));
8862 /* By default, start display at the beginning. */
8863 set_marker_both (w
->start
, w
->buffer
,
8864 BUF_BEGV (XBUFFER (w
->buffer
)),
8865 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8867 /* Don't resize windows while redisplaying a window; it would
8868 confuse redisplay functions when the size of the window they are
8869 displaying changes from under them. Such a resizing can happen,
8870 for instance, when which-func prints a long message while
8871 we are running fontification-functions. We're running these
8872 functions with safe_call which binds inhibit-redisplay to t. */
8873 if (!NILP (Vinhibit_redisplay
))
8876 /* Nil means don't try to resize. */
8877 if (NILP (Vresize_mini_windows
)
8878 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8881 if (!FRAME_MINIBUF_ONLY_P (f
))
8884 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8885 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8886 int height
, max_height
;
8887 int unit
= FRAME_LINE_HEIGHT (f
);
8888 struct text_pos start
;
8889 struct buffer
*old_current_buffer
= NULL
;
8891 if (current_buffer
!= XBUFFER (w
->buffer
))
8893 old_current_buffer
= current_buffer
;
8894 set_buffer_internal (XBUFFER (w
->buffer
));
8897 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8899 /* Compute the max. number of lines specified by the user. */
8900 if (FLOATP (Vmax_mini_window_height
))
8901 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8902 else if (INTEGERP (Vmax_mini_window_height
))
8903 max_height
= XINT (Vmax_mini_window_height
);
8905 max_height
= total_height
/ 4;
8907 /* Correct that max. height if it's bogus. */
8908 max_height
= max (1, max_height
);
8909 max_height
= min (total_height
, max_height
);
8911 /* Find out the height of the text in the window. */
8912 if (it
.line_wrap
== TRUNCATE
)
8917 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8918 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8919 height
= it
.current_y
+ last_height
;
8921 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8922 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8923 height
= (height
+ unit
- 1) / unit
;
8926 /* Compute a suitable window start. */
8927 if (height
> max_height
)
8929 height
= max_height
;
8930 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8931 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8932 start
= it
.current
.pos
;
8935 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8936 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8938 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8940 /* Let it grow only, until we display an empty message, in which
8941 case the window shrinks again. */
8942 if (height
> WINDOW_TOTAL_LINES (w
))
8944 int old_height
= WINDOW_TOTAL_LINES (w
);
8945 freeze_window_starts (f
, 1);
8946 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8947 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8949 else if (height
< WINDOW_TOTAL_LINES (w
)
8950 && (exact_p
|| BEGV
== ZV
))
8952 int old_height
= WINDOW_TOTAL_LINES (w
);
8953 freeze_window_starts (f
, 0);
8954 shrink_mini_window (w
);
8955 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8960 /* Always resize to exact size needed. */
8961 if (height
> WINDOW_TOTAL_LINES (w
))
8963 int old_height
= WINDOW_TOTAL_LINES (w
);
8964 freeze_window_starts (f
, 1);
8965 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8966 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8968 else if (height
< WINDOW_TOTAL_LINES (w
))
8970 int old_height
= WINDOW_TOTAL_LINES (w
);
8971 freeze_window_starts (f
, 0);
8972 shrink_mini_window (w
);
8976 freeze_window_starts (f
, 1);
8977 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8980 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8984 if (old_current_buffer
)
8985 set_buffer_internal (old_current_buffer
);
8988 return window_height_changed_p
;
8992 /* Value is the current message, a string, or nil if there is no
8996 current_message (void)
9000 if (!BUFFERP (echo_area_buffer
[0]))
9004 with_echo_area_buffer (0, 0, current_message_1
,
9005 (intptr_t) &msg
, Qnil
, 0, 0);
9007 echo_area_buffer
[0] = Qnil
;
9015 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9018 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9021 *msg
= make_buffer_string (BEG
, Z
, 1);
9028 /* Push the current message on Vmessage_stack for later restauration
9029 by restore_message. Value is non-zero if the current message isn't
9030 empty. This is a relatively infrequent operation, so it's not
9031 worth optimizing. */
9037 msg
= current_message ();
9038 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9039 return STRINGP (msg
);
9043 /* Restore message display from the top of Vmessage_stack. */
9046 restore_message (void)
9050 xassert (CONSP (Vmessage_stack
));
9051 msg
= XCAR (Vmessage_stack
);
9053 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9055 message3_nolog (msg
, 0, 0);
9059 /* Handler for record_unwind_protect calling pop_message. */
9062 pop_message_unwind (Lisp_Object dummy
)
9068 /* Pop the top-most entry off Vmessage_stack. */
9073 xassert (CONSP (Vmessage_stack
));
9074 Vmessage_stack
= XCDR (Vmessage_stack
);
9078 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9079 exits. If the stack is not empty, we have a missing pop_message
9083 check_message_stack (void)
9085 if (!NILP (Vmessage_stack
))
9090 /* Truncate to NCHARS what will be displayed in the echo area the next
9091 time we display it---but don't redisplay it now. */
9094 truncate_echo_area (EMACS_INT nchars
)
9097 echo_area_buffer
[0] = Qnil
;
9098 /* A null message buffer means that the frame hasn't really been
9099 initialized yet. Error messages get reported properly by
9100 cmd_error, so this must be just an informative message; toss it. */
9101 else if (!noninteractive
9103 && !NILP (echo_area_buffer
[0]))
9105 struct frame
*sf
= SELECTED_FRAME ();
9106 if (FRAME_MESSAGE_BUF (sf
))
9107 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9112 /* Helper function for truncate_echo_area. Truncate the current
9113 message to at most NCHARS characters. */
9116 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9118 if (BEG
+ nchars
< Z
)
9119 del_range (BEG
+ nchars
, Z
);
9121 echo_area_buffer
[0] = Qnil
;
9126 /* Set the current message to a substring of S or STRING.
9128 If STRING is a Lisp string, set the message to the first NBYTES
9129 bytes from STRING. NBYTES zero means use the whole string. If
9130 STRING is multibyte, the message will be displayed multibyte.
9132 If S is not null, set the message to the first LEN bytes of S. LEN
9133 zero means use the whole string. MULTIBYTE_P non-zero means S is
9134 multibyte. Display the message multibyte in that case.
9136 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9137 to t before calling set_message_1 (which calls insert).
9141 set_message (const char *s
, Lisp_Object string
,
9142 EMACS_INT nbytes
, int multibyte_p
)
9144 message_enable_multibyte
9145 = ((s
&& multibyte_p
)
9146 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9148 with_echo_area_buffer (0, -1, set_message_1
,
9149 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9150 message_buf_print
= 0;
9151 help_echo_showing_p
= 0;
9155 /* Helper function for set_message. Arguments have the same meaning
9156 as there, with A1 corresponding to S and A2 corresponding to STRING
9157 This function is called with the echo area buffer being
9161 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9164 const char *s
= (const char *) i1
;
9165 const unsigned char *msg
= (const unsigned char *) s
;
9166 Lisp_Object string
= a2
;
9168 /* Change multibyteness of the echo buffer appropriately. */
9169 if (message_enable_multibyte
9170 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9171 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9173 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9174 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9175 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9177 /* Insert new message at BEG. */
9178 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9180 if (STRINGP (string
))
9185 nbytes
= SBYTES (string
);
9186 nchars
= string_byte_to_char (string
, nbytes
);
9188 /* This function takes care of single/multibyte conversion. We
9189 just have to ensure that the echo area buffer has the right
9190 setting of enable_multibyte_characters. */
9191 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9196 nbytes
= strlen (s
);
9198 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9200 /* Convert from multi-byte to single-byte. */
9205 /* Convert a multibyte string to single-byte. */
9206 for (i
= 0; i
< nbytes
; i
+= n
)
9208 c
= string_char_and_length (msg
+ i
, &n
);
9209 work
[0] = (ASCII_CHAR_P (c
)
9211 : multibyte_char_to_unibyte (c
));
9212 insert_1_both (work
, 1, 1, 1, 0, 0);
9215 else if (!multibyte_p
9216 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9218 /* Convert from single-byte to multi-byte. */
9221 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9223 /* Convert a single-byte string to multibyte. */
9224 for (i
= 0; i
< nbytes
; i
++)
9227 MAKE_CHAR_MULTIBYTE (c
);
9228 n
= CHAR_STRING (c
, str
);
9229 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9233 insert_1 (s
, nbytes
, 1, 0, 0);
9240 /* Clear messages. CURRENT_P non-zero means clear the current
9241 message. LAST_DISPLAYED_P non-zero means clear the message
9245 clear_message (int current_p
, int last_displayed_p
)
9249 echo_area_buffer
[0] = Qnil
;
9250 message_cleared_p
= 1;
9253 if (last_displayed_p
)
9254 echo_area_buffer
[1] = Qnil
;
9256 message_buf_print
= 0;
9259 /* Clear garbaged frames.
9261 This function is used where the old redisplay called
9262 redraw_garbaged_frames which in turn called redraw_frame which in
9263 turn called clear_frame. The call to clear_frame was a source of
9264 flickering. I believe a clear_frame is not necessary. It should
9265 suffice in the new redisplay to invalidate all current matrices,
9266 and ensure a complete redisplay of all windows. */
9269 clear_garbaged_frames (void)
9273 Lisp_Object tail
, frame
;
9274 int changed_count
= 0;
9276 FOR_EACH_FRAME (tail
, frame
)
9278 struct frame
*f
= XFRAME (frame
);
9280 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9284 Fredraw_frame (frame
);
9285 f
->force_flush_display_p
= 1;
9287 clear_current_matrices (f
);
9296 ++windows_or_buffers_changed
;
9301 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9302 is non-zero update selected_frame. Value is non-zero if the
9303 mini-windows height has been changed. */
9306 echo_area_display (int update_frame_p
)
9308 Lisp_Object mini_window
;
9311 int window_height_changed_p
= 0;
9312 struct frame
*sf
= SELECTED_FRAME ();
9314 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9315 w
= XWINDOW (mini_window
);
9316 f
= XFRAME (WINDOW_FRAME (w
));
9318 /* Don't display if frame is invisible or not yet initialized. */
9319 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9322 #ifdef HAVE_WINDOW_SYSTEM
9323 /* When Emacs starts, selected_frame may be the initial terminal
9324 frame. If we let this through, a message would be displayed on
9326 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9328 #endif /* HAVE_WINDOW_SYSTEM */
9330 /* Redraw garbaged frames. */
9332 clear_garbaged_frames ();
9334 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9336 echo_area_window
= mini_window
;
9337 window_height_changed_p
= display_echo_area (w
);
9338 w
->must_be_updated_p
= 1;
9340 /* Update the display, unless called from redisplay_internal.
9341 Also don't update the screen during redisplay itself. The
9342 update will happen at the end of redisplay, and an update
9343 here could cause confusion. */
9344 if (update_frame_p
&& !redisplaying_p
)
9348 /* If the display update has been interrupted by pending
9349 input, update mode lines in the frame. Due to the
9350 pending input, it might have been that redisplay hasn't
9351 been called, so that mode lines above the echo area are
9352 garbaged. This looks odd, so we prevent it here. */
9353 if (!display_completed
)
9354 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9356 if (window_height_changed_p
9357 /* Don't do this if Emacs is shutting down. Redisplay
9358 needs to run hooks. */
9359 && !NILP (Vrun_hooks
))
9361 /* Must update other windows. Likewise as in other
9362 cases, don't let this update be interrupted by
9364 int count
= SPECPDL_INDEX ();
9365 specbind (Qredisplay_dont_pause
, Qt
);
9366 windows_or_buffers_changed
= 1;
9367 redisplay_internal ();
9368 unbind_to (count
, Qnil
);
9370 else if (FRAME_WINDOW_P (f
) && n
== 0)
9372 /* Window configuration is the same as before.
9373 Can do with a display update of the echo area,
9374 unless we displayed some mode lines. */
9375 update_single_window (w
, 1);
9376 FRAME_RIF (f
)->flush_display (f
);
9379 update_frame (f
, 1, 1);
9381 /* If cursor is in the echo area, make sure that the next
9382 redisplay displays the minibuffer, so that the cursor will
9383 be replaced with what the minibuffer wants. */
9384 if (cursor_in_echo_area
)
9385 ++windows_or_buffers_changed
;
9388 else if (!EQ (mini_window
, selected_window
))
9389 windows_or_buffers_changed
++;
9391 /* Last displayed message is now the current message. */
9392 echo_area_buffer
[1] = echo_area_buffer
[0];
9393 /* Inform read_char that we're not echoing. */
9394 echo_message_buffer
= Qnil
;
9396 /* Prevent redisplay optimization in redisplay_internal by resetting
9397 this_line_start_pos. This is done because the mini-buffer now
9398 displays the message instead of its buffer text. */
9399 if (EQ (mini_window
, selected_window
))
9400 CHARPOS (this_line_start_pos
) = 0;
9402 return window_height_changed_p
;
9407 /***********************************************************************
9408 Mode Lines and Frame Titles
9409 ***********************************************************************/
9411 /* A buffer for constructing non-propertized mode-line strings and
9412 frame titles in it; allocated from the heap in init_xdisp and
9413 resized as needed in store_mode_line_noprop_char. */
9415 static char *mode_line_noprop_buf
;
9417 /* The buffer's end, and a current output position in it. */
9419 static char *mode_line_noprop_buf_end
;
9420 static char *mode_line_noprop_ptr
;
9422 #define MODE_LINE_NOPROP_LEN(start) \
9423 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9426 MODE_LINE_DISPLAY
= 0,
9432 /* Alist that caches the results of :propertize.
9433 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9434 static Lisp_Object mode_line_proptrans_alist
;
9436 /* List of strings making up the mode-line. */
9437 static Lisp_Object mode_line_string_list
;
9439 /* Base face property when building propertized mode line string. */
9440 static Lisp_Object mode_line_string_face
;
9441 static Lisp_Object mode_line_string_face_prop
;
9444 /* Unwind data for mode line strings */
9446 static Lisp_Object Vmode_line_unwind_vector
;
9449 format_mode_line_unwind_data (struct buffer
*obuf
,
9453 Lisp_Object vector
, tmp
;
9455 /* Reduce consing by keeping one vector in
9456 Vwith_echo_area_save_vector. */
9457 vector
= Vmode_line_unwind_vector
;
9458 Vmode_line_unwind_vector
= Qnil
;
9461 vector
= Fmake_vector (make_number (8), Qnil
);
9463 ASET (vector
, 0, make_number (mode_line_target
));
9464 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9465 ASET (vector
, 2, mode_line_string_list
);
9466 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9467 ASET (vector
, 4, mode_line_string_face
);
9468 ASET (vector
, 5, mode_line_string_face_prop
);
9471 XSETBUFFER (tmp
, obuf
);
9474 ASET (vector
, 6, tmp
);
9475 ASET (vector
, 7, owin
);
9481 unwind_format_mode_line (Lisp_Object vector
)
9483 mode_line_target
= XINT (AREF (vector
, 0));
9484 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9485 mode_line_string_list
= AREF (vector
, 2);
9486 if (! EQ (AREF (vector
, 3), Qt
))
9487 mode_line_proptrans_alist
= AREF (vector
, 3);
9488 mode_line_string_face
= AREF (vector
, 4);
9489 mode_line_string_face_prop
= AREF (vector
, 5);
9491 if (!NILP (AREF (vector
, 7)))
9492 /* Select window before buffer, since it may change the buffer. */
9493 Fselect_window (AREF (vector
, 7), Qt
);
9495 if (!NILP (AREF (vector
, 6)))
9497 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9498 ASET (vector
, 6, Qnil
);
9501 Vmode_line_unwind_vector
= vector
;
9506 /* Store a single character C for the frame title in mode_line_noprop_buf.
9507 Re-allocate mode_line_noprop_buf if necessary. */
9510 store_mode_line_noprop_char (char c
)
9512 /* If output position has reached the end of the allocated buffer,
9513 double the buffer's size. */
9514 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9516 int len
= MODE_LINE_NOPROP_LEN (0);
9517 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9518 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9519 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9520 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9523 *mode_line_noprop_ptr
++ = c
;
9527 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9528 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9529 characters that yield more columns than PRECISION; PRECISION <= 0
9530 means copy the whole string. Pad with spaces until FIELD_WIDTH
9531 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9532 pad. Called from display_mode_element when it is used to build a
9536 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9538 const unsigned char *str
= (const unsigned char *) string
;
9540 EMACS_INT dummy
, nbytes
;
9542 /* Copy at most PRECISION chars from STR. */
9543 nbytes
= strlen (string
);
9544 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9546 store_mode_line_noprop_char (*str
++);
9548 /* Fill up with spaces until FIELD_WIDTH reached. */
9549 while (field_width
> 0
9552 store_mode_line_noprop_char (' ');
9559 /***********************************************************************
9561 ***********************************************************************/
9563 #ifdef HAVE_WINDOW_SYSTEM
9565 /* Set the title of FRAME, if it has changed. The title format is
9566 Vicon_title_format if FRAME is iconified, otherwise it is
9567 frame_title_format. */
9570 x_consider_frame_title (Lisp_Object frame
)
9572 struct frame
*f
= XFRAME (frame
);
9574 if (FRAME_WINDOW_P (f
)
9575 || FRAME_MINIBUF_ONLY_P (f
)
9576 || f
->explicit_name
)
9578 /* Do we have more than one visible frame on this X display? */
9585 int count
= SPECPDL_INDEX ();
9587 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9589 Lisp_Object other_frame
= XCAR (tail
);
9590 struct frame
*tf
= XFRAME (other_frame
);
9593 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9594 && !FRAME_MINIBUF_ONLY_P (tf
)
9595 && !EQ (other_frame
, tip_frame
)
9596 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9600 /* Set global variable indicating that multiple frames exist. */
9601 multiple_frames
= CONSP (tail
);
9603 /* Switch to the buffer of selected window of the frame. Set up
9604 mode_line_target so that display_mode_element will output into
9605 mode_line_noprop_buf; then display the title. */
9606 record_unwind_protect (unwind_format_mode_line
,
9607 format_mode_line_unwind_data
9608 (current_buffer
, selected_window
, 0));
9610 Fselect_window (f
->selected_window
, Qt
);
9611 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9612 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9614 mode_line_target
= MODE_LINE_TITLE
;
9615 title_start
= MODE_LINE_NOPROP_LEN (0);
9616 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9617 NULL
, DEFAULT_FACE_ID
);
9618 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9619 len
= MODE_LINE_NOPROP_LEN (title_start
);
9620 title
= mode_line_noprop_buf
+ title_start
;
9621 unbind_to (count
, Qnil
);
9623 /* Set the title only if it's changed. This avoids consing in
9624 the common case where it hasn't. (If it turns out that we've
9625 already wasted too much time by walking through the list with
9626 display_mode_element, then we might need to optimize at a
9627 higher level than this.) */
9628 if (! STRINGP (f
->name
)
9629 || SBYTES (f
->name
) != len
9630 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9631 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9635 #endif /* not HAVE_WINDOW_SYSTEM */
9640 /***********************************************************************
9642 ***********************************************************************/
9645 /* Prepare for redisplay by updating menu-bar item lists when
9646 appropriate. This can call eval. */
9649 prepare_menu_bars (void)
9652 struct gcpro gcpro1
, gcpro2
;
9654 Lisp_Object tooltip_frame
;
9656 #ifdef HAVE_WINDOW_SYSTEM
9657 tooltip_frame
= tip_frame
;
9659 tooltip_frame
= Qnil
;
9662 /* Update all frame titles based on their buffer names, etc. We do
9663 this before the menu bars so that the buffer-menu will show the
9664 up-to-date frame titles. */
9665 #ifdef HAVE_WINDOW_SYSTEM
9666 if (windows_or_buffers_changed
|| update_mode_lines
)
9668 Lisp_Object tail
, frame
;
9670 FOR_EACH_FRAME (tail
, frame
)
9673 if (!EQ (frame
, tooltip_frame
)
9674 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9675 x_consider_frame_title (frame
);
9678 #endif /* HAVE_WINDOW_SYSTEM */
9680 /* Update the menu bar item lists, if appropriate. This has to be
9681 done before any actual redisplay or generation of display lines. */
9682 all_windows
= (update_mode_lines
9683 || buffer_shared
> 1
9684 || windows_or_buffers_changed
);
9687 Lisp_Object tail
, frame
;
9688 int count
= SPECPDL_INDEX ();
9689 /* 1 means that update_menu_bar has run its hooks
9690 so any further calls to update_menu_bar shouldn't do so again. */
9691 int menu_bar_hooks_run
= 0;
9693 record_unwind_save_match_data ();
9695 FOR_EACH_FRAME (tail
, frame
)
9699 /* Ignore tooltip frame. */
9700 if (EQ (frame
, tooltip_frame
))
9703 /* If a window on this frame changed size, report that to
9704 the user and clear the size-change flag. */
9705 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9707 Lisp_Object functions
;
9709 /* Clear flag first in case we get an error below. */
9710 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9711 functions
= Vwindow_size_change_functions
;
9712 GCPRO2 (tail
, functions
);
9714 while (CONSP (functions
))
9716 if (!EQ (XCAR (functions
), Qt
))
9717 call1 (XCAR (functions
), frame
);
9718 functions
= XCDR (functions
);
9724 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9725 #ifdef HAVE_WINDOW_SYSTEM
9726 update_tool_bar (f
, 0);
9729 if (windows_or_buffers_changed
9731 ns_set_doc_edited (f
, Fbuffer_modified_p
9732 (XWINDOW (f
->selected_window
)->buffer
));
9737 unbind_to (count
, Qnil
);
9741 struct frame
*sf
= SELECTED_FRAME ();
9742 update_menu_bar (sf
, 1, 0);
9743 #ifdef HAVE_WINDOW_SYSTEM
9744 update_tool_bar (sf
, 1);
9750 /* Update the menu bar item list for frame F. This has to be done
9751 before we start to fill in any display lines, because it can call
9754 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9756 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9757 already ran the menu bar hooks for this redisplay, so there
9758 is no need to run them again. The return value is the
9759 updated value of this flag, to pass to the next call. */
9762 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9765 register struct window
*w
;
9767 /* If called recursively during a menu update, do nothing. This can
9768 happen when, for instance, an activate-menubar-hook causes a
9770 if (inhibit_menubar_update
)
9773 window
= FRAME_SELECTED_WINDOW (f
);
9774 w
= XWINDOW (window
);
9776 if (FRAME_WINDOW_P (f
)
9778 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9779 || defined (HAVE_NS) || defined (USE_GTK)
9780 FRAME_EXTERNAL_MENU_BAR (f
)
9782 FRAME_MENU_BAR_LINES (f
) > 0
9784 : FRAME_MENU_BAR_LINES (f
) > 0)
9786 /* If the user has switched buffers or windows, we need to
9787 recompute to reflect the new bindings. But we'll
9788 recompute when update_mode_lines is set too; that means
9789 that people can use force-mode-line-update to request
9790 that the menu bar be recomputed. The adverse effect on
9791 the rest of the redisplay algorithm is about the same as
9792 windows_or_buffers_changed anyway. */
9793 if (windows_or_buffers_changed
9794 /* This used to test w->update_mode_line, but we believe
9795 there is no need to recompute the menu in that case. */
9796 || update_mode_lines
9797 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9798 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9799 != !NILP (w
->last_had_star
))
9800 || ((!NILP (Vtransient_mark_mode
)
9801 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9802 != !NILP (w
->region_showing
)))
9804 struct buffer
*prev
= current_buffer
;
9805 int count
= SPECPDL_INDEX ();
9807 specbind (Qinhibit_menubar_update
, Qt
);
9809 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9810 if (save_match_data
)
9811 record_unwind_save_match_data ();
9812 if (NILP (Voverriding_local_map_menu_flag
))
9814 specbind (Qoverriding_terminal_local_map
, Qnil
);
9815 specbind (Qoverriding_local_map
, Qnil
);
9820 /* Run the Lucid hook. */
9821 safe_run_hooks (Qactivate_menubar_hook
);
9823 /* If it has changed current-menubar from previous value,
9824 really recompute the menu-bar from the value. */
9825 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9826 call0 (Qrecompute_lucid_menubar
);
9828 safe_run_hooks (Qmenu_bar_update_hook
);
9833 XSETFRAME (Vmenu_updating_frame
, f
);
9834 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9836 /* Redisplay the menu bar in case we changed it. */
9837 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9838 || defined (HAVE_NS) || defined (USE_GTK)
9839 if (FRAME_WINDOW_P (f
))
9841 #if defined (HAVE_NS)
9842 /* All frames on Mac OS share the same menubar. So only
9843 the selected frame should be allowed to set it. */
9844 if (f
== SELECTED_FRAME ())
9846 set_frame_menubar (f
, 0, 0);
9849 /* On a terminal screen, the menu bar is an ordinary screen
9850 line, and this makes it get updated. */
9851 w
->update_mode_line
= Qt
;
9852 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9853 /* In the non-toolkit version, the menu bar is an ordinary screen
9854 line, and this makes it get updated. */
9855 w
->update_mode_line
= Qt
;
9856 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9858 unbind_to (count
, Qnil
);
9859 set_buffer_internal_1 (prev
);
9868 /***********************************************************************
9870 ***********************************************************************/
9872 #ifdef HAVE_WINDOW_SYSTEM
9875 Nominal cursor position -- where to draw output.
9876 HPOS and VPOS are window relative glyph matrix coordinates.
9877 X and Y are window relative pixel coordinates. */
9879 struct cursor_pos output_cursor
;
9883 Set the global variable output_cursor to CURSOR. All cursor
9884 positions are relative to updated_window. */
9887 set_output_cursor (struct cursor_pos
*cursor
)
9889 output_cursor
.hpos
= cursor
->hpos
;
9890 output_cursor
.vpos
= cursor
->vpos
;
9891 output_cursor
.x
= cursor
->x
;
9892 output_cursor
.y
= cursor
->y
;
9897 Set a nominal cursor position.
9899 HPOS and VPOS are column/row positions in a window glyph matrix. X
9900 and Y are window text area relative pixel positions.
9902 If this is done during an update, updated_window will contain the
9903 window that is being updated and the position is the future output
9904 cursor position for that window. If updated_window is null, use
9905 selected_window and display the cursor at the given position. */
9908 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9912 /* If updated_window is not set, work on selected_window. */
9916 w
= XWINDOW (selected_window
);
9918 /* Set the output cursor. */
9919 output_cursor
.hpos
= hpos
;
9920 output_cursor
.vpos
= vpos
;
9921 output_cursor
.x
= x
;
9922 output_cursor
.y
= y
;
9924 /* If not called as part of an update, really display the cursor.
9925 This will also set the cursor position of W. */
9926 if (updated_window
== NULL
)
9929 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9930 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9931 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9936 #endif /* HAVE_WINDOW_SYSTEM */
9939 /***********************************************************************
9941 ***********************************************************************/
9943 #ifdef HAVE_WINDOW_SYSTEM
9945 /* Where the mouse was last time we reported a mouse event. */
9947 FRAME_PTR last_mouse_frame
;
9949 /* Tool-bar item index of the item on which a mouse button was pressed
9952 int last_tool_bar_item
;
9956 update_tool_bar_unwind (Lisp_Object frame
)
9958 selected_frame
= frame
;
9962 /* Update the tool-bar item list for frame F. This has to be done
9963 before we start to fill in any display lines. Called from
9964 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9965 and restore it here. */
9968 update_tool_bar (struct frame
*f
, int save_match_data
)
9970 #if defined (USE_GTK) || defined (HAVE_NS)
9971 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9973 int do_update
= WINDOWP (f
->tool_bar_window
)
9974 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9982 window
= FRAME_SELECTED_WINDOW (f
);
9983 w
= XWINDOW (window
);
9985 /* If the user has switched buffers or windows, we need to
9986 recompute to reflect the new bindings. But we'll
9987 recompute when update_mode_lines is set too; that means
9988 that people can use force-mode-line-update to request
9989 that the menu bar be recomputed. The adverse effect on
9990 the rest of the redisplay algorithm is about the same as
9991 windows_or_buffers_changed anyway. */
9992 if (windows_or_buffers_changed
9993 || !NILP (w
->update_mode_line
)
9994 || update_mode_lines
9995 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9996 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9997 != !NILP (w
->last_had_star
))
9998 || ((!NILP (Vtransient_mark_mode
)
9999 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10000 != !NILP (w
->region_showing
)))
10002 struct buffer
*prev
= current_buffer
;
10003 int count
= SPECPDL_INDEX ();
10004 Lisp_Object frame
, new_tool_bar
;
10005 int new_n_tool_bar
;
10006 struct gcpro gcpro1
;
10008 /* Set current_buffer to the buffer of the selected
10009 window of the frame, so that we get the right local
10011 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10013 /* Save match data, if we must. */
10014 if (save_match_data
)
10015 record_unwind_save_match_data ();
10017 /* Make sure that we don't accidentally use bogus keymaps. */
10018 if (NILP (Voverriding_local_map_menu_flag
))
10020 specbind (Qoverriding_terminal_local_map
, Qnil
);
10021 specbind (Qoverriding_local_map
, Qnil
);
10024 GCPRO1 (new_tool_bar
);
10026 /* We must temporarily set the selected frame to this frame
10027 before calling tool_bar_items, because the calculation of
10028 the tool-bar keymap uses the selected frame (see
10029 `tool-bar-make-keymap' in tool-bar.el). */
10030 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10031 XSETFRAME (frame
, f
);
10032 selected_frame
= frame
;
10034 /* Build desired tool-bar items from keymaps. */
10035 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10038 /* Redisplay the tool-bar if we changed it. */
10039 if (new_n_tool_bar
!= f
->n_tool_bar_items
10040 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10042 /* Redisplay that happens asynchronously due to an expose event
10043 may access f->tool_bar_items. Make sure we update both
10044 variables within BLOCK_INPUT so no such event interrupts. */
10046 f
->tool_bar_items
= new_tool_bar
;
10047 f
->n_tool_bar_items
= new_n_tool_bar
;
10048 w
->update_mode_line
= Qt
;
10054 unbind_to (count
, Qnil
);
10055 set_buffer_internal_1 (prev
);
10061 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10062 F's desired tool-bar contents. F->tool_bar_items must have
10063 been set up previously by calling prepare_menu_bars. */
10066 build_desired_tool_bar_string (struct frame
*f
)
10068 int i
, size
, size_needed
;
10069 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10070 Lisp_Object image
, plist
, props
;
10072 image
= plist
= props
= Qnil
;
10073 GCPRO3 (image
, plist
, props
);
10075 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10076 Otherwise, make a new string. */
10078 /* The size of the string we might be able to reuse. */
10079 size
= (STRINGP (f
->desired_tool_bar_string
)
10080 ? SCHARS (f
->desired_tool_bar_string
)
10083 /* We need one space in the string for each image. */
10084 size_needed
= f
->n_tool_bar_items
;
10086 /* Reuse f->desired_tool_bar_string, if possible. */
10087 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10088 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10089 make_number (' '));
10092 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10093 Fremove_text_properties (make_number (0), make_number (size
),
10094 props
, f
->desired_tool_bar_string
);
10097 /* Put a `display' property on the string for the images to display,
10098 put a `menu_item' property on tool-bar items with a value that
10099 is the index of the item in F's tool-bar item vector. */
10100 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10102 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10104 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10105 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10106 int hmargin
, vmargin
, relief
, idx
, end
;
10108 /* If image is a vector, choose the image according to the
10110 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10111 if (VECTORP (image
))
10115 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10116 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10119 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10120 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10122 xassert (ASIZE (image
) >= idx
);
10123 image
= AREF (image
, idx
);
10128 /* Ignore invalid image specifications. */
10129 if (!valid_image_p (image
))
10132 /* Display the tool-bar button pressed, or depressed. */
10133 plist
= Fcopy_sequence (XCDR (image
));
10135 /* Compute margin and relief to draw. */
10136 relief
= (tool_bar_button_relief
>= 0
10137 ? tool_bar_button_relief
10138 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10139 hmargin
= vmargin
= relief
;
10141 if (INTEGERP (Vtool_bar_button_margin
)
10142 && XINT (Vtool_bar_button_margin
) > 0)
10144 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10145 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10147 else if (CONSP (Vtool_bar_button_margin
))
10149 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10150 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10151 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10153 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10154 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10155 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10158 if (auto_raise_tool_bar_buttons_p
)
10160 /* Add a `:relief' property to the image spec if the item is
10164 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10171 /* If image is selected, display it pressed, i.e. with a
10172 negative relief. If it's not selected, display it with a
10174 plist
= Fplist_put (plist
, QCrelief
,
10176 ? make_number (-relief
)
10177 : make_number (relief
)));
10182 /* Put a margin around the image. */
10183 if (hmargin
|| vmargin
)
10185 if (hmargin
== vmargin
)
10186 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10188 plist
= Fplist_put (plist
, QCmargin
,
10189 Fcons (make_number (hmargin
),
10190 make_number (vmargin
)));
10193 /* If button is not enabled, and we don't have special images
10194 for the disabled state, make the image appear disabled by
10195 applying an appropriate algorithm to it. */
10196 if (!enabled_p
&& idx
< 0)
10197 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10199 /* Put a `display' text property on the string for the image to
10200 display. Put a `menu-item' property on the string that gives
10201 the start of this item's properties in the tool-bar items
10203 image
= Fcons (Qimage
, plist
);
10204 props
= list4 (Qdisplay
, image
,
10205 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10207 /* Let the last image hide all remaining spaces in the tool bar
10208 string. The string can be longer than needed when we reuse a
10209 previous string. */
10210 if (i
+ 1 == f
->n_tool_bar_items
)
10211 end
= SCHARS (f
->desired_tool_bar_string
);
10214 Fadd_text_properties (make_number (i
), make_number (end
),
10215 props
, f
->desired_tool_bar_string
);
10223 /* Display one line of the tool-bar of frame IT->f.
10225 HEIGHT specifies the desired height of the tool-bar line.
10226 If the actual height of the glyph row is less than HEIGHT, the
10227 row's height is increased to HEIGHT, and the icons are centered
10228 vertically in the new height.
10230 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10231 count a final empty row in case the tool-bar width exactly matches
10236 display_tool_bar_line (struct it
*it
, int height
)
10238 struct glyph_row
*row
= it
->glyph_row
;
10239 int max_x
= it
->last_visible_x
;
10240 struct glyph
*last
;
10242 prepare_desired_row (row
);
10243 row
->y
= it
->current_y
;
10245 /* Note that this isn't made use of if the face hasn't a box,
10246 so there's no need to check the face here. */
10247 it
->start_of_box_run_p
= 1;
10249 while (it
->current_x
< max_x
)
10251 int x
, n_glyphs_before
, i
, nglyphs
;
10252 struct it it_before
;
10254 /* Get the next display element. */
10255 if (!get_next_display_element (it
))
10257 /* Don't count empty row if we are counting needed tool-bar lines. */
10258 if (height
< 0 && !it
->hpos
)
10263 /* Produce glyphs. */
10264 n_glyphs_before
= row
->used
[TEXT_AREA
];
10267 PRODUCE_GLYPHS (it
);
10269 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10271 x
= it_before
.current_x
;
10272 while (i
< nglyphs
)
10274 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10276 if (x
+ glyph
->pixel_width
> max_x
)
10278 /* Glyph doesn't fit on line. Backtrack. */
10279 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10281 /* If this is the only glyph on this line, it will never fit on the
10282 tool-bar, so skip it. But ensure there is at least one glyph,
10283 so we don't accidentally disable the tool-bar. */
10284 if (n_glyphs_before
== 0
10285 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10291 x
+= glyph
->pixel_width
;
10295 /* Stop at line ends. */
10296 if (ITERATOR_AT_END_OF_LINE_P (it
))
10299 set_iterator_to_next (it
, 1);
10304 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10306 /* Use default face for the border below the tool bar.
10308 FIXME: When auto-resize-tool-bars is grow-only, there is
10309 no additional border below the possibly empty tool-bar lines.
10310 So to make the extra empty lines look "normal", we have to
10311 use the tool-bar face for the border too. */
10312 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10313 it
->face_id
= DEFAULT_FACE_ID
;
10315 extend_face_to_end_of_line (it
);
10316 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10317 last
->right_box_line_p
= 1;
10318 if (last
== row
->glyphs
[TEXT_AREA
])
10319 last
->left_box_line_p
= 1;
10321 /* Make line the desired height and center it vertically. */
10322 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10324 /* Don't add more than one line height. */
10325 height
%= FRAME_LINE_HEIGHT (it
->f
);
10326 it
->max_ascent
+= height
/ 2;
10327 it
->max_descent
+= (height
+ 1) / 2;
10330 compute_line_metrics (it
);
10332 /* If line is empty, make it occupy the rest of the tool-bar. */
10333 if (!row
->displays_text_p
)
10335 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10336 row
->visible_height
= row
->height
;
10337 row
->ascent
= row
->phys_ascent
= 0;
10338 row
->extra_line_spacing
= 0;
10341 row
->full_width_p
= 1;
10342 row
->continued_p
= 0;
10343 row
->truncated_on_left_p
= 0;
10344 row
->truncated_on_right_p
= 0;
10346 it
->current_x
= it
->hpos
= 0;
10347 it
->current_y
+= row
->height
;
10353 /* Max tool-bar height. */
10355 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10356 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10358 /* Value is the number of screen lines needed to make all tool-bar
10359 items of frame F visible. The number of actual rows needed is
10360 returned in *N_ROWS if non-NULL. */
10363 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10365 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10367 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10368 the desired matrix, so use (unused) mode-line row as temporary row to
10369 avoid destroying the first tool-bar row. */
10370 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10372 /* Initialize an iterator for iteration over
10373 F->desired_tool_bar_string in the tool-bar window of frame F. */
10374 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10375 it
.first_visible_x
= 0;
10376 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10377 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10379 while (!ITERATOR_AT_END_P (&it
))
10381 clear_glyph_row (temp_row
);
10382 it
.glyph_row
= temp_row
;
10383 display_tool_bar_line (&it
, -1);
10385 clear_glyph_row (temp_row
);
10387 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10389 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10391 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10395 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10397 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10398 (Lisp_Object frame
)
10405 frame
= selected_frame
;
10407 CHECK_FRAME (frame
);
10408 f
= XFRAME (frame
);
10410 if (WINDOWP (f
->tool_bar_window
)
10411 || (w
= XWINDOW (f
->tool_bar_window
),
10412 WINDOW_TOTAL_LINES (w
) > 0))
10414 update_tool_bar (f
, 1);
10415 if (f
->n_tool_bar_items
)
10417 build_desired_tool_bar_string (f
);
10418 nlines
= tool_bar_lines_needed (f
, NULL
);
10422 return make_number (nlines
);
10426 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10427 height should be changed. */
10430 redisplay_tool_bar (struct frame
*f
)
10434 struct glyph_row
*row
;
10436 #if defined (USE_GTK) || defined (HAVE_NS)
10437 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10438 update_frame_tool_bar (f
);
10442 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10443 do anything. This means you must start with tool-bar-lines
10444 non-zero to get the auto-sizing effect. Or in other words, you
10445 can turn off tool-bars by specifying tool-bar-lines zero. */
10446 if (!WINDOWP (f
->tool_bar_window
)
10447 || (w
= XWINDOW (f
->tool_bar_window
),
10448 WINDOW_TOTAL_LINES (w
) == 0))
10451 /* Set up an iterator for the tool-bar window. */
10452 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10453 it
.first_visible_x
= 0;
10454 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10455 row
= it
.glyph_row
;
10457 /* Build a string that represents the contents of the tool-bar. */
10458 build_desired_tool_bar_string (f
);
10459 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10461 if (f
->n_tool_bar_rows
== 0)
10465 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10466 nlines
!= WINDOW_TOTAL_LINES (w
)))
10469 int old_height
= WINDOW_TOTAL_LINES (w
);
10471 XSETFRAME (frame
, f
);
10472 Fmodify_frame_parameters (frame
,
10473 Fcons (Fcons (Qtool_bar_lines
,
10474 make_number (nlines
)),
10476 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10478 clear_glyph_matrix (w
->desired_matrix
);
10479 fonts_changed_p
= 1;
10485 /* Display as many lines as needed to display all tool-bar items. */
10487 if (f
->n_tool_bar_rows
> 0)
10489 int border
, rows
, height
, extra
;
10491 if (INTEGERP (Vtool_bar_border
))
10492 border
= XINT (Vtool_bar_border
);
10493 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10494 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10495 else if (EQ (Vtool_bar_border
, Qborder_width
))
10496 border
= f
->border_width
;
10502 rows
= f
->n_tool_bar_rows
;
10503 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10504 extra
= it
.last_visible_y
- border
- height
* rows
;
10506 while (it
.current_y
< it
.last_visible_y
)
10509 if (extra
> 0 && rows
-- > 0)
10511 h
= (extra
+ rows
- 1) / rows
;
10514 display_tool_bar_line (&it
, height
+ h
);
10519 while (it
.current_y
< it
.last_visible_y
)
10520 display_tool_bar_line (&it
, 0);
10523 /* It doesn't make much sense to try scrolling in the tool-bar
10524 window, so don't do it. */
10525 w
->desired_matrix
->no_scrolling_p
= 1;
10526 w
->must_be_updated_p
= 1;
10528 if (!NILP (Vauto_resize_tool_bars
))
10530 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10531 int change_height_p
= 0;
10533 /* If we couldn't display everything, change the tool-bar's
10534 height if there is room for more. */
10535 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10536 && it
.current_y
< max_tool_bar_height
)
10537 change_height_p
= 1;
10539 row
= it
.glyph_row
- 1;
10541 /* If there are blank lines at the end, except for a partially
10542 visible blank line at the end that is smaller than
10543 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10544 if (!row
->displays_text_p
10545 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10546 change_height_p
= 1;
10548 /* If row displays tool-bar items, but is partially visible,
10549 change the tool-bar's height. */
10550 if (row
->displays_text_p
10551 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10552 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10553 change_height_p
= 1;
10555 /* Resize windows as needed by changing the `tool-bar-lines'
10556 frame parameter. */
10557 if (change_height_p
)
10560 int old_height
= WINDOW_TOTAL_LINES (w
);
10562 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10564 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10565 && !f
->minimize_tool_bar_window_p
)
10566 ? (nlines
> old_height
)
10567 : (nlines
!= old_height
));
10568 f
->minimize_tool_bar_window_p
= 0;
10570 if (change_height_p
)
10572 XSETFRAME (frame
, f
);
10573 Fmodify_frame_parameters (frame
,
10574 Fcons (Fcons (Qtool_bar_lines
,
10575 make_number (nlines
)),
10577 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10579 clear_glyph_matrix (w
->desired_matrix
);
10580 f
->n_tool_bar_rows
= nrows
;
10581 fonts_changed_p
= 1;
10588 f
->minimize_tool_bar_window_p
= 0;
10593 /* Get information about the tool-bar item which is displayed in GLYPH
10594 on frame F. Return in *PROP_IDX the index where tool-bar item
10595 properties start in F->tool_bar_items. Value is zero if
10596 GLYPH doesn't display a tool-bar item. */
10599 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10605 /* This function can be called asynchronously, which means we must
10606 exclude any possibility that Fget_text_property signals an
10608 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10609 charpos
= max (0, charpos
);
10611 /* Get the text property `menu-item' at pos. The value of that
10612 property is the start index of this item's properties in
10613 F->tool_bar_items. */
10614 prop
= Fget_text_property (make_number (charpos
),
10615 Qmenu_item
, f
->current_tool_bar_string
);
10616 if (INTEGERP (prop
))
10618 *prop_idx
= XINT (prop
);
10628 /* Get information about the tool-bar item at position X/Y on frame F.
10629 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10630 the current matrix of the tool-bar window of F, or NULL if not
10631 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10632 item in F->tool_bar_items. Value is
10634 -1 if X/Y is not on a tool-bar item
10635 0 if X/Y is on the same item that was highlighted before.
10639 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10640 int *hpos
, int *vpos
, int *prop_idx
)
10642 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10643 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10646 /* Find the glyph under X/Y. */
10647 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10648 if (*glyph
== NULL
)
10651 /* Get the start of this tool-bar item's properties in
10652 f->tool_bar_items. */
10653 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10656 /* Is mouse on the highlighted item? */
10657 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10658 && *vpos
>= hlinfo
->mouse_face_beg_row
10659 && *vpos
<= hlinfo
->mouse_face_end_row
10660 && (*vpos
> hlinfo
->mouse_face_beg_row
10661 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10662 && (*vpos
< hlinfo
->mouse_face_end_row
10663 || *hpos
< hlinfo
->mouse_face_end_col
10664 || hlinfo
->mouse_face_past_end
))
10672 Handle mouse button event on the tool-bar of frame F, at
10673 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10674 0 for button release. MODIFIERS is event modifiers for button
10678 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10679 unsigned int modifiers
)
10681 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10682 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10683 int hpos
, vpos
, prop_idx
;
10684 struct glyph
*glyph
;
10685 Lisp_Object enabled_p
;
10687 /* If not on the highlighted tool-bar item, return. */
10688 frame_to_window_pixel_xy (w
, &x
, &y
);
10689 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10692 /* If item is disabled, do nothing. */
10693 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10694 if (NILP (enabled_p
))
10699 /* Show item in pressed state. */
10700 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10701 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10702 last_tool_bar_item
= prop_idx
;
10706 Lisp_Object key
, frame
;
10707 struct input_event event
;
10708 EVENT_INIT (event
);
10710 /* Show item in released state. */
10711 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10712 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10714 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10716 XSETFRAME (frame
, f
);
10717 event
.kind
= TOOL_BAR_EVENT
;
10718 event
.frame_or_window
= frame
;
10720 kbd_buffer_store_event (&event
);
10722 event
.kind
= TOOL_BAR_EVENT
;
10723 event
.frame_or_window
= frame
;
10725 event
.modifiers
= modifiers
;
10726 kbd_buffer_store_event (&event
);
10727 last_tool_bar_item
= -1;
10732 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10733 tool-bar window-relative coordinates X/Y. Called from
10734 note_mouse_highlight. */
10737 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10739 Lisp_Object window
= f
->tool_bar_window
;
10740 struct window
*w
= XWINDOW (window
);
10741 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10742 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10744 struct glyph
*glyph
;
10745 struct glyph_row
*row
;
10747 Lisp_Object enabled_p
;
10749 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10750 int mouse_down_p
, rc
;
10752 /* Function note_mouse_highlight is called with negative X/Y
10753 values when mouse moves outside of the frame. */
10754 if (x
<= 0 || y
<= 0)
10756 clear_mouse_face (hlinfo
);
10760 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10763 /* Not on tool-bar item. */
10764 clear_mouse_face (hlinfo
);
10768 /* On same tool-bar item as before. */
10769 goto set_help_echo
;
10771 clear_mouse_face (hlinfo
);
10773 /* Mouse is down, but on different tool-bar item? */
10774 mouse_down_p
= (dpyinfo
->grabbed
10775 && f
== last_mouse_frame
10776 && FRAME_LIVE_P (f
));
10778 && last_tool_bar_item
!= prop_idx
)
10781 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10782 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10784 /* If tool-bar item is not enabled, don't highlight it. */
10785 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10786 if (!NILP (enabled_p
))
10788 /* Compute the x-position of the glyph. In front and past the
10789 image is a space. We include this in the highlighted area. */
10790 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10791 for (i
= x
= 0; i
< hpos
; ++i
)
10792 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10794 /* Record this as the current active region. */
10795 hlinfo
->mouse_face_beg_col
= hpos
;
10796 hlinfo
->mouse_face_beg_row
= vpos
;
10797 hlinfo
->mouse_face_beg_x
= x
;
10798 hlinfo
->mouse_face_beg_y
= row
->y
;
10799 hlinfo
->mouse_face_past_end
= 0;
10801 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10802 hlinfo
->mouse_face_end_row
= vpos
;
10803 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10804 hlinfo
->mouse_face_end_y
= row
->y
;
10805 hlinfo
->mouse_face_window
= window
;
10806 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10808 /* Display it as active. */
10809 show_mouse_face (hlinfo
, draw
);
10810 hlinfo
->mouse_face_image_state
= draw
;
10815 /* Set help_echo_string to a help string to display for this tool-bar item.
10816 XTread_socket does the rest. */
10817 help_echo_object
= help_echo_window
= Qnil
;
10818 help_echo_pos
= -1;
10819 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10820 if (NILP (help_echo_string
))
10821 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10824 #endif /* HAVE_WINDOW_SYSTEM */
10828 /************************************************************************
10829 Horizontal scrolling
10830 ************************************************************************/
10832 static int hscroll_window_tree (Lisp_Object
);
10833 static int hscroll_windows (Lisp_Object
);
10835 /* For all leaf windows in the window tree rooted at WINDOW, set their
10836 hscroll value so that PT is (i) visible in the window, and (ii) so
10837 that it is not within a certain margin at the window's left and
10838 right border. Value is non-zero if any window's hscroll has been
10842 hscroll_window_tree (Lisp_Object window
)
10844 int hscrolled_p
= 0;
10845 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10846 int hscroll_step_abs
= 0;
10847 double hscroll_step_rel
= 0;
10849 if (hscroll_relative_p
)
10851 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10852 if (hscroll_step_rel
< 0)
10854 hscroll_relative_p
= 0;
10855 hscroll_step_abs
= 0;
10858 else if (INTEGERP (Vhscroll_step
))
10860 hscroll_step_abs
= XINT (Vhscroll_step
);
10861 if (hscroll_step_abs
< 0)
10862 hscroll_step_abs
= 0;
10865 hscroll_step_abs
= 0;
10867 while (WINDOWP (window
))
10869 struct window
*w
= XWINDOW (window
);
10871 if (WINDOWP (w
->hchild
))
10872 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10873 else if (WINDOWP (w
->vchild
))
10874 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10875 else if (w
->cursor
.vpos
>= 0)
10878 int text_area_width
;
10879 struct glyph_row
*current_cursor_row
10880 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10881 struct glyph_row
*desired_cursor_row
10882 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10883 struct glyph_row
*cursor_row
10884 = (desired_cursor_row
->enabled_p
10885 ? desired_cursor_row
10886 : current_cursor_row
);
10888 text_area_width
= window_box_width (w
, TEXT_AREA
);
10890 /* Scroll when cursor is inside this scroll margin. */
10891 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10893 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10894 && ((XFASTINT (w
->hscroll
)
10895 && w
->cursor
.x
<= h_margin
)
10896 || (cursor_row
->enabled_p
10897 && cursor_row
->truncated_on_right_p
10898 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10902 struct buffer
*saved_current_buffer
;
10906 /* Find point in a display of infinite width. */
10907 saved_current_buffer
= current_buffer
;
10908 current_buffer
= XBUFFER (w
->buffer
);
10910 if (w
== XWINDOW (selected_window
))
10914 pt
= marker_position (w
->pointm
);
10915 pt
= max (BEGV
, pt
);
10919 /* Move iterator to pt starting at cursor_row->start in
10920 a line with infinite width. */
10921 init_to_row_start (&it
, w
, cursor_row
);
10922 it
.last_visible_x
= INFINITY
;
10923 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10924 current_buffer
= saved_current_buffer
;
10926 /* Position cursor in window. */
10927 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10928 hscroll
= max (0, (it
.current_x
10929 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10930 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10931 : (text_area_width
/ 2))))
10932 / FRAME_COLUMN_WIDTH (it
.f
);
10933 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10935 if (hscroll_relative_p
)
10936 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10939 wanted_x
= text_area_width
10940 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10943 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10947 if (hscroll_relative_p
)
10948 wanted_x
= text_area_width
* hscroll_step_rel
10951 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10954 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10956 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10958 /* Don't call Fset_window_hscroll if value hasn't
10959 changed because it will prevent redisplay
10961 if (XFASTINT (w
->hscroll
) != hscroll
)
10963 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10964 w
->hscroll
= make_number (hscroll
);
10973 /* Value is non-zero if hscroll of any leaf window has been changed. */
10974 return hscrolled_p
;
10978 /* Set hscroll so that cursor is visible and not inside horizontal
10979 scroll margins for all windows in the tree rooted at WINDOW. See
10980 also hscroll_window_tree above. Value is non-zero if any window's
10981 hscroll has been changed. If it has, desired matrices on the frame
10982 of WINDOW are cleared. */
10985 hscroll_windows (Lisp_Object window
)
10987 int hscrolled_p
= hscroll_window_tree (window
);
10989 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10990 return hscrolled_p
;
10995 /************************************************************************
10997 ************************************************************************/
10999 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11000 to a non-zero value. This is sometimes handy to have in a debugger
11005 /* First and last unchanged row for try_window_id. */
11007 int debug_first_unchanged_at_end_vpos
;
11008 int debug_last_unchanged_at_beg_vpos
;
11010 /* Delta vpos and y. */
11012 int debug_dvpos
, debug_dy
;
11014 /* Delta in characters and bytes for try_window_id. */
11016 EMACS_INT debug_delta
, debug_delta_bytes
;
11018 /* Values of window_end_pos and window_end_vpos at the end of
11021 EMACS_INT debug_end_vpos
;
11023 /* Append a string to W->desired_matrix->method. FMT is a printf
11024 format string. A1...A9 are a supplement for a variable-length
11025 argument list. If trace_redisplay_p is non-zero also printf the
11026 resulting string to stderr. */
11029 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11032 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11035 char *method
= w
->desired_matrix
->method
;
11036 int len
= strlen (method
);
11037 int size
= sizeof w
->desired_matrix
->method
;
11038 int remaining
= size
- len
- 1;
11040 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11041 if (len
&& remaining
)
11044 --remaining
, ++len
;
11047 strncpy (method
+ len
, buffer
, remaining
);
11049 if (trace_redisplay_p
)
11050 fprintf (stderr
, "%p (%s): %s\n",
11052 ((BUFFERP (w
->buffer
)
11053 && STRINGP (XBUFFER (w
->buffer
)->name
))
11054 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11059 #endif /* GLYPH_DEBUG */
11062 /* Value is non-zero if all changes in window W, which displays
11063 current_buffer, are in the text between START and END. START is a
11064 buffer position, END is given as a distance from Z. Used in
11065 redisplay_internal for display optimization. */
11068 text_outside_line_unchanged_p (struct window
*w
,
11069 EMACS_INT start
, EMACS_INT end
)
11071 int unchanged_p
= 1;
11073 /* If text or overlays have changed, see where. */
11074 if (XFASTINT (w
->last_modified
) < MODIFF
11075 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11077 /* Gap in the line? */
11078 if (GPT
< start
|| Z
- GPT
< end
)
11081 /* Changes start in front of the line, or end after it? */
11083 && (BEG_UNCHANGED
< start
- 1
11084 || END_UNCHANGED
< end
))
11087 /* If selective display, can't optimize if changes start at the
11088 beginning of the line. */
11090 && INTEGERP (BVAR (current_buffer
, selective_display
))
11091 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11092 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11095 /* If there are overlays at the start or end of the line, these
11096 may have overlay strings with newlines in them. A change at
11097 START, for instance, may actually concern the display of such
11098 overlay strings as well, and they are displayed on different
11099 lines. So, quickly rule out this case. (For the future, it
11100 might be desirable to implement something more telling than
11101 just BEG/END_UNCHANGED.) */
11104 if (BEG
+ BEG_UNCHANGED
== start
11105 && overlay_touches_p (start
))
11107 if (END_UNCHANGED
== end
11108 && overlay_touches_p (Z
- end
))
11112 /* Under bidi reordering, adding or deleting a character in the
11113 beginning of a paragraph, before the first strong directional
11114 character, can change the base direction of the paragraph (unless
11115 the buffer specifies a fixed paragraph direction), which will
11116 require to redisplay the whole paragraph. It might be worthwhile
11117 to find the paragraph limits and widen the range of redisplayed
11118 lines to that, but for now just give up this optimization. */
11119 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11120 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11124 return unchanged_p
;
11128 /* Do a frame update, taking possible shortcuts into account. This is
11129 the main external entry point for redisplay.
11131 If the last redisplay displayed an echo area message and that message
11132 is no longer requested, we clear the echo area or bring back the
11133 mini-buffer if that is in use. */
11138 redisplay_internal ();
11143 overlay_arrow_string_or_property (Lisp_Object var
)
11147 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11150 return Voverlay_arrow_string
;
11153 /* Return 1 if there are any overlay-arrows in current_buffer. */
11155 overlay_arrow_in_current_buffer_p (void)
11159 for (vlist
= Voverlay_arrow_variable_list
;
11161 vlist
= XCDR (vlist
))
11163 Lisp_Object var
= XCAR (vlist
);
11166 if (!SYMBOLP (var
))
11168 val
= find_symbol_value (var
);
11170 && current_buffer
== XMARKER (val
)->buffer
)
11177 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11181 overlay_arrows_changed_p (void)
11185 for (vlist
= Voverlay_arrow_variable_list
;
11187 vlist
= XCDR (vlist
))
11189 Lisp_Object var
= XCAR (vlist
);
11190 Lisp_Object val
, pstr
;
11192 if (!SYMBOLP (var
))
11194 val
= find_symbol_value (var
);
11195 if (!MARKERP (val
))
11197 if (! EQ (COERCE_MARKER (val
),
11198 Fget (var
, Qlast_arrow_position
))
11199 || ! (pstr
= overlay_arrow_string_or_property (var
),
11200 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11206 /* Mark overlay arrows to be updated on next redisplay. */
11209 update_overlay_arrows (int up_to_date
)
11213 for (vlist
= Voverlay_arrow_variable_list
;
11215 vlist
= XCDR (vlist
))
11217 Lisp_Object var
= XCAR (vlist
);
11219 if (!SYMBOLP (var
))
11222 if (up_to_date
> 0)
11224 Lisp_Object val
= find_symbol_value (var
);
11225 Fput (var
, Qlast_arrow_position
,
11226 COERCE_MARKER (val
));
11227 Fput (var
, Qlast_arrow_string
,
11228 overlay_arrow_string_or_property (var
));
11230 else if (up_to_date
< 0
11231 || !NILP (Fget (var
, Qlast_arrow_position
)))
11233 Fput (var
, Qlast_arrow_position
, Qt
);
11234 Fput (var
, Qlast_arrow_string
, Qt
);
11240 /* Return overlay arrow string to display at row.
11241 Return integer (bitmap number) for arrow bitmap in left fringe.
11242 Return nil if no overlay arrow. */
11245 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11249 for (vlist
= Voverlay_arrow_variable_list
;
11251 vlist
= XCDR (vlist
))
11253 Lisp_Object var
= XCAR (vlist
);
11256 if (!SYMBOLP (var
))
11259 val
= find_symbol_value (var
);
11262 && current_buffer
== XMARKER (val
)->buffer
11263 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11265 if (FRAME_WINDOW_P (it
->f
)
11266 /* FIXME: if ROW->reversed_p is set, this should test
11267 the right fringe, not the left one. */
11268 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11270 #ifdef HAVE_WINDOW_SYSTEM
11271 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11274 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11275 return make_number (fringe_bitmap
);
11278 return make_number (-1); /* Use default arrow bitmap */
11280 return overlay_arrow_string_or_property (var
);
11287 /* Return 1 if point moved out of or into a composition. Otherwise
11288 return 0. PREV_BUF and PREV_PT are the last point buffer and
11289 position. BUF and PT are the current point buffer and position. */
11292 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11293 struct buffer
*buf
, EMACS_INT pt
)
11295 EMACS_INT start
, end
;
11297 Lisp_Object buffer
;
11299 XSETBUFFER (buffer
, buf
);
11300 /* Check a composition at the last point if point moved within the
11302 if (prev_buf
== buf
)
11305 /* Point didn't move. */
11308 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11309 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11310 && COMPOSITION_VALID_P (start
, end
, prop
)
11311 && start
< prev_pt
&& end
> prev_pt
)
11312 /* The last point was within the composition. Return 1 iff
11313 point moved out of the composition. */
11314 return (pt
<= start
|| pt
>= end
);
11317 /* Check a composition at the current point. */
11318 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11319 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11320 && COMPOSITION_VALID_P (start
, end
, prop
)
11321 && start
< pt
&& end
> pt
);
11325 /* Reconsider the setting of B->clip_changed which is displayed
11329 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11331 if (b
->clip_changed
11332 && !NILP (w
->window_end_valid
)
11333 && w
->current_matrix
->buffer
== b
11334 && w
->current_matrix
->zv
== BUF_ZV (b
)
11335 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11336 b
->clip_changed
= 0;
11338 /* If display wasn't paused, and W is not a tool bar window, see if
11339 point has been moved into or out of a composition. In that case,
11340 we set b->clip_changed to 1 to force updating the screen. If
11341 b->clip_changed has already been set to 1, we can skip this
11343 if (!b
->clip_changed
11344 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11348 if (w
== XWINDOW (selected_window
))
11351 pt
= marker_position (w
->pointm
);
11353 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11354 || pt
!= XINT (w
->last_point
))
11355 && check_point_in_composition (w
->current_matrix
->buffer
,
11356 XINT (w
->last_point
),
11357 XBUFFER (w
->buffer
), pt
))
11358 b
->clip_changed
= 1;
11363 /* Select FRAME to forward the values of frame-local variables into C
11364 variables so that the redisplay routines can access those values
11368 select_frame_for_redisplay (Lisp_Object frame
)
11370 Lisp_Object tail
, tem
;
11371 Lisp_Object old
= selected_frame
;
11372 struct Lisp_Symbol
*sym
;
11374 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11376 selected_frame
= frame
;
11379 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11380 if (CONSP (XCAR (tail
))
11381 && (tem
= XCAR (XCAR (tail
)),
11383 && (sym
= indirect_variable (XSYMBOL (tem
)),
11384 sym
->redirect
== SYMBOL_LOCALIZED
)
11385 && sym
->val
.blv
->frame_local
)
11386 /* Use find_symbol_value rather than Fsymbol_value
11387 to avoid an error if it is void. */
11388 find_symbol_value (tem
);
11389 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11393 #define STOP_POLLING \
11394 do { if (! polling_stopped_here) stop_polling (); \
11395 polling_stopped_here = 1; } while (0)
11397 #define RESUME_POLLING \
11398 do { if (polling_stopped_here) start_polling (); \
11399 polling_stopped_here = 0; } while (0)
11402 /* Perhaps in the future avoid recentering windows if it
11403 is not necessary; currently that causes some problems. */
11406 redisplay_internal (void)
11408 struct window
*w
= XWINDOW (selected_window
);
11412 int must_finish
= 0;
11413 struct text_pos tlbufpos
, tlendpos
;
11414 int number_of_visible_frames
;
11417 int polling_stopped_here
= 0;
11418 Lisp_Object old_frame
= selected_frame
;
11420 /* Non-zero means redisplay has to consider all windows on all
11421 frames. Zero means, only selected_window is considered. */
11422 int consider_all_windows_p
;
11424 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11426 /* No redisplay if running in batch mode or frame is not yet fully
11427 initialized, or redisplay is explicitly turned off by setting
11428 Vinhibit_redisplay. */
11429 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11430 || !NILP (Vinhibit_redisplay
))
11433 /* Don't examine these until after testing Vinhibit_redisplay.
11434 When Emacs is shutting down, perhaps because its connection to
11435 X has dropped, we should not look at them at all. */
11436 fr
= XFRAME (w
->frame
);
11437 sf
= SELECTED_FRAME ();
11439 if (!fr
->glyphs_initialized_p
)
11442 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11443 if (popup_activated ())
11447 /* I don't think this happens but let's be paranoid. */
11448 if (redisplaying_p
)
11451 /* Record a function that resets redisplaying_p to its old value
11452 when we leave this function. */
11453 count
= SPECPDL_INDEX ();
11454 record_unwind_protect (unwind_redisplay
,
11455 Fcons (make_number (redisplaying_p
), selected_frame
));
11457 specbind (Qinhibit_free_realized_faces
, Qnil
);
11460 Lisp_Object tail
, frame
;
11462 FOR_EACH_FRAME (tail
, frame
)
11464 struct frame
*f
= XFRAME (frame
);
11465 f
->already_hscrolled_p
= 0;
11470 /* Remember the currently selected window. */
11473 if (!EQ (old_frame
, selected_frame
)
11474 && FRAME_LIVE_P (XFRAME (old_frame
)))
11475 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11476 selected_frame and selected_window to be temporarily out-of-sync so
11477 when we come back here via `goto retry', we need to resync because we
11478 may need to run Elisp code (via prepare_menu_bars). */
11479 select_frame_for_redisplay (old_frame
);
11482 reconsider_clip_changes (w
, current_buffer
);
11483 last_escape_glyph_frame
= NULL
;
11484 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11485 last_glyphless_glyph_frame
= NULL
;
11486 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11488 /* If new fonts have been loaded that make a glyph matrix adjustment
11489 necessary, do it. */
11490 if (fonts_changed_p
)
11492 adjust_glyphs (NULL
);
11493 ++windows_or_buffers_changed
;
11494 fonts_changed_p
= 0;
11497 /* If face_change_count is non-zero, init_iterator will free all
11498 realized faces, which includes the faces referenced from current
11499 matrices. So, we can't reuse current matrices in this case. */
11500 if (face_change_count
)
11501 ++windows_or_buffers_changed
;
11503 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11504 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11506 /* Since frames on a single ASCII terminal share the same
11507 display area, displaying a different frame means redisplay
11508 the whole thing. */
11509 windows_or_buffers_changed
++;
11510 SET_FRAME_GARBAGED (sf
);
11512 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11514 FRAME_TTY (sf
)->previous_frame
= sf
;
11517 /* Set the visible flags for all frames. Do this before checking
11518 for resized or garbaged frames; they want to know if their frames
11519 are visible. See the comment in frame.h for
11520 FRAME_SAMPLE_VISIBILITY. */
11522 Lisp_Object tail
, frame
;
11524 number_of_visible_frames
= 0;
11526 FOR_EACH_FRAME (tail
, frame
)
11528 struct frame
*f
= XFRAME (frame
);
11530 FRAME_SAMPLE_VISIBILITY (f
);
11531 if (FRAME_VISIBLE_P (f
))
11532 ++number_of_visible_frames
;
11533 clear_desired_matrices (f
);
11537 /* Notice any pending interrupt request to change frame size. */
11538 do_pending_window_change (1);
11540 /* do_pending_window_change could change the selected_window due to
11541 frame resizing which makes the selected window too small. */
11542 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11545 reconsider_clip_changes (w
, current_buffer
);
11548 /* Clear frames marked as garbaged. */
11549 if (frame_garbaged
)
11550 clear_garbaged_frames ();
11552 /* Build menubar and tool-bar items. */
11553 if (NILP (Vmemory_full
))
11554 prepare_menu_bars ();
11556 if (windows_or_buffers_changed
)
11557 update_mode_lines
++;
11559 /* Detect case that we need to write or remove a star in the mode line. */
11560 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11562 w
->update_mode_line
= Qt
;
11563 if (buffer_shared
> 1)
11564 update_mode_lines
++;
11567 /* Avoid invocation of point motion hooks by `current_column' below. */
11568 count1
= SPECPDL_INDEX ();
11569 specbind (Qinhibit_point_motion_hooks
, Qt
);
11571 /* If %c is in the mode line, update it if needed. */
11572 if (!NILP (w
->column_number_displayed
)
11573 /* This alternative quickly identifies a common case
11574 where no change is needed. */
11575 && !(PT
== XFASTINT (w
->last_point
)
11576 && XFASTINT (w
->last_modified
) >= MODIFF
11577 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11578 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11579 w
->update_mode_line
= Qt
;
11581 unbind_to (count1
, Qnil
);
11583 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11585 /* The variable buffer_shared is set in redisplay_window and
11586 indicates that we redisplay a buffer in different windows. See
11588 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11589 || cursor_type_changed
);
11591 /* If specs for an arrow have changed, do thorough redisplay
11592 to ensure we remove any arrow that should no longer exist. */
11593 if (overlay_arrows_changed_p ())
11594 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11596 /* Normally the message* functions will have already displayed and
11597 updated the echo area, but the frame may have been trashed, or
11598 the update may have been preempted, so display the echo area
11599 again here. Checking message_cleared_p captures the case that
11600 the echo area should be cleared. */
11601 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11602 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11603 || (message_cleared_p
11604 && minibuf_level
== 0
11605 /* If the mini-window is currently selected, this means the
11606 echo-area doesn't show through. */
11607 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11609 int window_height_changed_p
= echo_area_display (0);
11612 /* If we don't display the current message, don't clear the
11613 message_cleared_p flag, because, if we did, we wouldn't clear
11614 the echo area in the next redisplay which doesn't preserve
11616 if (!display_last_displayed_message_p
)
11617 message_cleared_p
= 0;
11619 if (fonts_changed_p
)
11621 else if (window_height_changed_p
)
11623 consider_all_windows_p
= 1;
11624 ++update_mode_lines
;
11625 ++windows_or_buffers_changed
;
11627 /* If window configuration was changed, frames may have been
11628 marked garbaged. Clear them or we will experience
11629 surprises wrt scrolling. */
11630 if (frame_garbaged
)
11631 clear_garbaged_frames ();
11634 else if (EQ (selected_window
, minibuf_window
)
11635 && (current_buffer
->clip_changed
11636 || XFASTINT (w
->last_modified
) < MODIFF
11637 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11638 && resize_mini_window (w
, 0))
11640 /* Resized active mini-window to fit the size of what it is
11641 showing if its contents might have changed. */
11643 /* FIXME: this causes all frames to be updated, which seems unnecessary
11644 since only the current frame needs to be considered. This function needs
11645 to be rewritten with two variables, consider_all_windows and
11646 consider_all_frames. */
11647 consider_all_windows_p
= 1;
11648 ++windows_or_buffers_changed
;
11649 ++update_mode_lines
;
11651 /* If window configuration was changed, frames may have been
11652 marked garbaged. Clear them or we will experience
11653 surprises wrt scrolling. */
11654 if (frame_garbaged
)
11655 clear_garbaged_frames ();
11659 /* If showing the region, and mark has changed, we must redisplay
11660 the whole window. The assignment to this_line_start_pos prevents
11661 the optimization directly below this if-statement. */
11662 if (((!NILP (Vtransient_mark_mode
)
11663 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11664 != !NILP (w
->region_showing
))
11665 || (!NILP (w
->region_showing
)
11666 && !EQ (w
->region_showing
,
11667 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11668 CHARPOS (this_line_start_pos
) = 0;
11670 /* Optimize the case that only the line containing the cursor in the
11671 selected window has changed. Variables starting with this_ are
11672 set in display_line and record information about the line
11673 containing the cursor. */
11674 tlbufpos
= this_line_start_pos
;
11675 tlendpos
= this_line_end_pos
;
11676 if (!consider_all_windows_p
11677 && CHARPOS (tlbufpos
) > 0
11678 && NILP (w
->update_mode_line
)
11679 && !current_buffer
->clip_changed
11680 && !current_buffer
->prevent_redisplay_optimizations_p
11681 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11682 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11683 /* Make sure recorded data applies to current buffer, etc. */
11684 && this_line_buffer
== current_buffer
11685 && current_buffer
== XBUFFER (w
->buffer
)
11686 && NILP (w
->force_start
)
11687 && NILP (w
->optional_new_start
)
11688 /* Point must be on the line that we have info recorded about. */
11689 && PT
>= CHARPOS (tlbufpos
)
11690 && PT
<= Z
- CHARPOS (tlendpos
)
11691 /* All text outside that line, including its final newline,
11692 must be unchanged. */
11693 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11694 CHARPOS (tlendpos
)))
11696 if (CHARPOS (tlbufpos
) > BEGV
11697 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11698 && (CHARPOS (tlbufpos
) == ZV
11699 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11700 /* Former continuation line has disappeared by becoming empty. */
11702 else if (XFASTINT (w
->last_modified
) < MODIFF
11703 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11704 || MINI_WINDOW_P (w
))
11706 /* We have to handle the case of continuation around a
11707 wide-column character (see the comment in indent.c around
11710 For instance, in the following case:
11712 -------- Insert --------
11713 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11714 J_I_ ==> J_I_ `^^' are cursors.
11718 As we have to redraw the line above, we cannot use this
11722 int line_height_before
= this_line_pixel_height
;
11724 /* Note that start_display will handle the case that the
11725 line starting at tlbufpos is a continuation line. */
11726 start_display (&it
, w
, tlbufpos
);
11728 /* Implementation note: It this still necessary? */
11729 if (it
.current_x
!= this_line_start_x
)
11732 TRACE ((stderr
, "trying display optimization 1\n"));
11733 w
->cursor
.vpos
= -1;
11734 overlay_arrow_seen
= 0;
11735 it
.vpos
= this_line_vpos
;
11736 it
.current_y
= this_line_y
;
11737 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11738 display_line (&it
);
11740 /* If line contains point, is not continued,
11741 and ends at same distance from eob as before, we win. */
11742 if (w
->cursor
.vpos
>= 0
11743 /* Line is not continued, otherwise this_line_start_pos
11744 would have been set to 0 in display_line. */
11745 && CHARPOS (this_line_start_pos
)
11746 /* Line ends as before. */
11747 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11748 /* Line has same height as before. Otherwise other lines
11749 would have to be shifted up or down. */
11750 && this_line_pixel_height
== line_height_before
)
11752 /* If this is not the window's last line, we must adjust
11753 the charstarts of the lines below. */
11754 if (it
.current_y
< it
.last_visible_y
)
11756 struct glyph_row
*row
11757 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11758 EMACS_INT delta
, delta_bytes
;
11760 /* We used to distinguish between two cases here,
11761 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11762 when the line ends in a newline or the end of the
11763 buffer's accessible portion. But both cases did
11764 the same, so they were collapsed. */
11766 - CHARPOS (tlendpos
)
11767 - MATRIX_ROW_START_CHARPOS (row
));
11768 delta_bytes
= (Z_BYTE
11769 - BYTEPOS (tlendpos
)
11770 - MATRIX_ROW_START_BYTEPOS (row
));
11772 increment_matrix_positions (w
->current_matrix
,
11773 this_line_vpos
+ 1,
11774 w
->current_matrix
->nrows
,
11775 delta
, delta_bytes
);
11778 /* If this row displays text now but previously didn't,
11779 or vice versa, w->window_end_vpos may have to be
11781 if ((it
.glyph_row
- 1)->displays_text_p
)
11783 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11784 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11786 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11787 && this_line_vpos
> 0)
11788 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11789 w
->window_end_valid
= Qnil
;
11791 /* Update hint: No need to try to scroll in update_window. */
11792 w
->desired_matrix
->no_scrolling_p
= 1;
11795 *w
->desired_matrix
->method
= 0;
11796 debug_method_add (w
, "optimization 1");
11798 #ifdef HAVE_WINDOW_SYSTEM
11799 update_window_fringes (w
, 0);
11806 else if (/* Cursor position hasn't changed. */
11807 PT
== XFASTINT (w
->last_point
)
11808 /* Make sure the cursor was last displayed
11809 in this window. Otherwise we have to reposition it. */
11810 && 0 <= w
->cursor
.vpos
11811 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11815 do_pending_window_change (1);
11816 /* If selected_window changed, redisplay again. */
11817 if (WINDOWP (selected_window
)
11818 && (w
= XWINDOW (selected_window
)) != sw
)
11821 /* We used to always goto end_of_redisplay here, but this
11822 isn't enough if we have a blinking cursor. */
11823 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11824 goto end_of_redisplay
;
11828 /* If highlighting the region, or if the cursor is in the echo area,
11829 then we can't just move the cursor. */
11830 else if (! (!NILP (Vtransient_mark_mode
)
11831 && !NILP (BVAR (current_buffer
, mark_active
)))
11832 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11833 || highlight_nonselected_windows
)
11834 && NILP (w
->region_showing
)
11835 && NILP (Vshow_trailing_whitespace
)
11836 && !cursor_in_echo_area
)
11839 struct glyph_row
*row
;
11841 /* Skip from tlbufpos to PT and see where it is. Note that
11842 PT may be in invisible text. If so, we will end at the
11843 next visible position. */
11844 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11845 NULL
, DEFAULT_FACE_ID
);
11846 it
.current_x
= this_line_start_x
;
11847 it
.current_y
= this_line_y
;
11848 it
.vpos
= this_line_vpos
;
11850 /* The call to move_it_to stops in front of PT, but
11851 moves over before-strings. */
11852 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11854 if (it
.vpos
== this_line_vpos
11855 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11858 xassert (this_line_vpos
== it
.vpos
);
11859 xassert (this_line_y
== it
.current_y
);
11860 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11862 *w
->desired_matrix
->method
= 0;
11863 debug_method_add (w
, "optimization 3");
11872 /* Text changed drastically or point moved off of line. */
11873 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11876 CHARPOS (this_line_start_pos
) = 0;
11877 consider_all_windows_p
|= buffer_shared
> 1;
11878 ++clear_face_cache_count
;
11879 #ifdef HAVE_WINDOW_SYSTEM
11880 ++clear_image_cache_count
;
11883 /* Build desired matrices, and update the display. If
11884 consider_all_windows_p is non-zero, do it for all windows on all
11885 frames. Otherwise do it for selected_window, only. */
11887 if (consider_all_windows_p
)
11889 Lisp_Object tail
, frame
;
11891 FOR_EACH_FRAME (tail
, frame
)
11892 XFRAME (frame
)->updated_p
= 0;
11894 /* Recompute # windows showing selected buffer. This will be
11895 incremented each time such a window is displayed. */
11898 FOR_EACH_FRAME (tail
, frame
)
11900 struct frame
*f
= XFRAME (frame
);
11902 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11904 if (! EQ (frame
, selected_frame
))
11905 /* Select the frame, for the sake of frame-local
11907 select_frame_for_redisplay (frame
);
11909 /* Mark all the scroll bars to be removed; we'll redeem
11910 the ones we want when we redisplay their windows. */
11911 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11912 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11914 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11915 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11917 /* The X error handler may have deleted that frame. */
11918 if (!FRAME_LIVE_P (f
))
11921 /* Any scroll bars which redisplay_windows should have
11922 nuked should now go away. */
11923 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11924 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11926 /* If fonts changed, display again. */
11927 /* ??? rms: I suspect it is a mistake to jump all the way
11928 back to retry here. It should just retry this frame. */
11929 if (fonts_changed_p
)
11932 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11934 /* See if we have to hscroll. */
11935 if (!f
->already_hscrolled_p
)
11937 f
->already_hscrolled_p
= 1;
11938 if (hscroll_windows (f
->root_window
))
11942 /* Prevent various kinds of signals during display
11943 update. stdio is not robust about handling
11944 signals, which can cause an apparent I/O
11946 if (interrupt_input
)
11947 unrequest_sigio ();
11950 /* Update the display. */
11951 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11952 pending
|= update_frame (f
, 0, 0);
11958 if (!EQ (old_frame
, selected_frame
)
11959 && FRAME_LIVE_P (XFRAME (old_frame
)))
11960 /* We played a bit fast-and-loose above and allowed selected_frame
11961 and selected_window to be temporarily out-of-sync but let's make
11962 sure this stays contained. */
11963 select_frame_for_redisplay (old_frame
);
11964 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11968 /* Do the mark_window_display_accurate after all windows have
11969 been redisplayed because this call resets flags in buffers
11970 which are needed for proper redisplay. */
11971 FOR_EACH_FRAME (tail
, frame
)
11973 struct frame
*f
= XFRAME (frame
);
11976 mark_window_display_accurate (f
->root_window
, 1);
11977 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11978 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11983 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11985 Lisp_Object mini_window
;
11986 struct frame
*mini_frame
;
11988 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11989 /* Use list_of_error, not Qerror, so that
11990 we catch only errors and don't run the debugger. */
11991 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11993 redisplay_window_error
);
11995 /* Compare desired and current matrices, perform output. */
11998 /* If fonts changed, display again. */
11999 if (fonts_changed_p
)
12002 /* Prevent various kinds of signals during display update.
12003 stdio is not robust about handling signals,
12004 which can cause an apparent I/O error. */
12005 if (interrupt_input
)
12006 unrequest_sigio ();
12009 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12011 if (hscroll_windows (selected_window
))
12014 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12015 pending
= update_frame (sf
, 0, 0);
12018 /* We may have called echo_area_display at the top of this
12019 function. If the echo area is on another frame, that may
12020 have put text on a frame other than the selected one, so the
12021 above call to update_frame would not have caught it. Catch
12023 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12024 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12026 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12028 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12029 pending
|= update_frame (mini_frame
, 0, 0);
12030 if (!pending
&& hscroll_windows (mini_window
))
12035 /* If display was paused because of pending input, make sure we do a
12036 thorough update the next time. */
12039 /* Prevent the optimization at the beginning of
12040 redisplay_internal that tries a single-line update of the
12041 line containing the cursor in the selected window. */
12042 CHARPOS (this_line_start_pos
) = 0;
12044 /* Let the overlay arrow be updated the next time. */
12045 update_overlay_arrows (0);
12047 /* If we pause after scrolling, some rows in the current
12048 matrices of some windows are not valid. */
12049 if (!WINDOW_FULL_WIDTH_P (w
)
12050 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12051 update_mode_lines
= 1;
12055 if (!consider_all_windows_p
)
12057 /* This has already been done above if
12058 consider_all_windows_p is set. */
12059 mark_window_display_accurate_1 (w
, 1);
12061 /* Say overlay arrows are up to date. */
12062 update_overlay_arrows (1);
12064 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12065 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12068 update_mode_lines
= 0;
12069 windows_or_buffers_changed
= 0;
12070 cursor_type_changed
= 0;
12073 /* Start SIGIO interrupts coming again. Having them off during the
12074 code above makes it less likely one will discard output, but not
12075 impossible, since there might be stuff in the system buffer here.
12076 But it is much hairier to try to do anything about that. */
12077 if (interrupt_input
)
12081 /* If a frame has become visible which was not before, redisplay
12082 again, so that we display it. Expose events for such a frame
12083 (which it gets when becoming visible) don't call the parts of
12084 redisplay constructing glyphs, so simply exposing a frame won't
12085 display anything in this case. So, we have to display these
12086 frames here explicitly. */
12089 Lisp_Object tail
, frame
;
12092 FOR_EACH_FRAME (tail
, frame
)
12094 int this_is_visible
= 0;
12096 if (XFRAME (frame
)->visible
)
12097 this_is_visible
= 1;
12098 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12099 if (XFRAME (frame
)->visible
)
12100 this_is_visible
= 1;
12102 if (this_is_visible
)
12106 if (new_count
!= number_of_visible_frames
)
12107 windows_or_buffers_changed
++;
12110 /* Change frame size now if a change is pending. */
12111 do_pending_window_change (1);
12113 /* If we just did a pending size change, or have additional
12114 visible frames, or selected_window changed, redisplay again. */
12115 if ((windows_or_buffers_changed
&& !pending
)
12116 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12119 /* Clear the face and image caches.
12121 We used to do this only if consider_all_windows_p. But the cache
12122 needs to be cleared if a timer creates images in the current
12123 buffer (e.g. the test case in Bug#6230). */
12125 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12127 clear_face_cache (0);
12128 clear_face_cache_count
= 0;
12131 #ifdef HAVE_WINDOW_SYSTEM
12132 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12134 clear_image_caches (Qnil
);
12135 clear_image_cache_count
= 0;
12137 #endif /* HAVE_WINDOW_SYSTEM */
12140 unbind_to (count
, Qnil
);
12145 /* Redisplay, but leave alone any recent echo area message unless
12146 another message has been requested in its place.
12148 This is useful in situations where you need to redisplay but no
12149 user action has occurred, making it inappropriate for the message
12150 area to be cleared. See tracking_off and
12151 wait_reading_process_output for examples of these situations.
12153 FROM_WHERE is an integer saying from where this function was
12154 called. This is useful for debugging. */
12157 redisplay_preserve_echo_area (int from_where
)
12159 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12161 if (!NILP (echo_area_buffer
[1]))
12163 /* We have a previously displayed message, but no current
12164 message. Redisplay the previous message. */
12165 display_last_displayed_message_p
= 1;
12166 redisplay_internal ();
12167 display_last_displayed_message_p
= 0;
12170 redisplay_internal ();
12172 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12173 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12174 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12178 /* Function registered with record_unwind_protect in
12179 redisplay_internal. Reset redisplaying_p to the value it had
12180 before redisplay_internal was called, and clear
12181 prevent_freeing_realized_faces_p. It also selects the previously
12182 selected frame, unless it has been deleted (by an X connection
12183 failure during redisplay, for example). */
12186 unwind_redisplay (Lisp_Object val
)
12188 Lisp_Object old_redisplaying_p
, old_frame
;
12190 old_redisplaying_p
= XCAR (val
);
12191 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12192 old_frame
= XCDR (val
);
12193 if (! EQ (old_frame
, selected_frame
)
12194 && FRAME_LIVE_P (XFRAME (old_frame
)))
12195 select_frame_for_redisplay (old_frame
);
12200 /* Mark the display of window W as accurate or inaccurate. If
12201 ACCURATE_P is non-zero mark display of W as accurate. If
12202 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12203 redisplay_internal is called. */
12206 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12208 if (BUFFERP (w
->buffer
))
12210 struct buffer
*b
= XBUFFER (w
->buffer
);
12213 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12214 w
->last_overlay_modified
12215 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12217 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12221 b
->clip_changed
= 0;
12222 b
->prevent_redisplay_optimizations_p
= 0;
12224 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12225 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12226 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12227 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12229 w
->current_matrix
->buffer
= b
;
12230 w
->current_matrix
->begv
= BUF_BEGV (b
);
12231 w
->current_matrix
->zv
= BUF_ZV (b
);
12233 w
->last_cursor
= w
->cursor
;
12234 w
->last_cursor_off_p
= w
->cursor_off_p
;
12236 if (w
== XWINDOW (selected_window
))
12237 w
->last_point
= make_number (BUF_PT (b
));
12239 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12245 w
->window_end_valid
= w
->buffer
;
12246 w
->update_mode_line
= Qnil
;
12251 /* Mark the display of windows in the window tree rooted at WINDOW as
12252 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12253 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12254 be redisplayed the next time redisplay_internal is called. */
12257 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12261 for (; !NILP (window
); window
= w
->next
)
12263 w
= XWINDOW (window
);
12264 mark_window_display_accurate_1 (w
, accurate_p
);
12266 if (!NILP (w
->vchild
))
12267 mark_window_display_accurate (w
->vchild
, accurate_p
);
12268 if (!NILP (w
->hchild
))
12269 mark_window_display_accurate (w
->hchild
, accurate_p
);
12274 update_overlay_arrows (1);
12278 /* Force a thorough redisplay the next time by setting
12279 last_arrow_position and last_arrow_string to t, which is
12280 unequal to any useful value of Voverlay_arrow_... */
12281 update_overlay_arrows (-1);
12286 /* Return value in display table DP (Lisp_Char_Table *) for character
12287 C. Since a display table doesn't have any parent, we don't have to
12288 follow parent. Do not call this function directly but use the
12289 macro DISP_CHAR_VECTOR. */
12292 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12296 if (ASCII_CHAR_P (c
))
12299 if (SUB_CHAR_TABLE_P (val
))
12300 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12306 XSETCHAR_TABLE (table
, dp
);
12307 val
= char_table_ref (table
, c
);
12316 /***********************************************************************
12318 ***********************************************************************/
12320 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12323 redisplay_windows (Lisp_Object window
)
12325 while (!NILP (window
))
12327 struct window
*w
= XWINDOW (window
);
12329 if (!NILP (w
->hchild
))
12330 redisplay_windows (w
->hchild
);
12331 else if (!NILP (w
->vchild
))
12332 redisplay_windows (w
->vchild
);
12333 else if (!NILP (w
->buffer
))
12335 displayed_buffer
= XBUFFER (w
->buffer
);
12336 /* Use list_of_error, not Qerror, so that
12337 we catch only errors and don't run the debugger. */
12338 internal_condition_case_1 (redisplay_window_0
, window
,
12340 redisplay_window_error
);
12348 redisplay_window_error (Lisp_Object ignore
)
12350 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12355 redisplay_window_0 (Lisp_Object window
)
12357 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12358 redisplay_window (window
, 0);
12363 redisplay_window_1 (Lisp_Object window
)
12365 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12366 redisplay_window (window
, 1);
12371 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12372 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12373 which positions recorded in ROW differ from current buffer
12376 Return 0 if cursor is not on this row, 1 otherwise. */
12379 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12380 struct glyph_matrix
*matrix
,
12381 EMACS_INT delta
, EMACS_INT delta_bytes
,
12384 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12385 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12386 struct glyph
*cursor
= NULL
;
12387 /* The last known character position in row. */
12388 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12390 EMACS_INT pt_old
= PT
- delta
;
12391 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12392 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12393 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12394 /* A glyph beyond the edge of TEXT_AREA which we should never
12396 struct glyph
*glyphs_end
= end
;
12397 /* Non-zero means we've found a match for cursor position, but that
12398 glyph has the avoid_cursor_p flag set. */
12399 int match_with_avoid_cursor
= 0;
12400 /* Non-zero means we've seen at least one glyph that came from a
12402 int string_seen
= 0;
12403 /* Largest and smalles buffer positions seen so far during scan of
12405 EMACS_INT bpos_max
= pos_before
;
12406 EMACS_INT bpos_min
= pos_after
;
12407 /* Last buffer position covered by an overlay string with an integer
12408 `cursor' property. */
12409 EMACS_INT bpos_covered
= 0;
12411 /* Skip over glyphs not having an object at the start and the end of
12412 the row. These are special glyphs like truncation marks on
12413 terminal frames. */
12414 if (row
->displays_text_p
)
12416 if (!row
->reversed_p
)
12419 && INTEGERP (glyph
->object
)
12420 && glyph
->charpos
< 0)
12422 x
+= glyph
->pixel_width
;
12426 && INTEGERP ((end
- 1)->object
)
12427 /* CHARPOS is zero for blanks and stretch glyphs
12428 inserted by extend_face_to_end_of_line. */
12429 && (end
- 1)->charpos
<= 0)
12431 glyph_before
= glyph
- 1;
12438 /* If the glyph row is reversed, we need to process it from back
12439 to front, so swap the edge pointers. */
12440 glyphs_end
= end
= glyph
- 1;
12441 glyph
+= row
->used
[TEXT_AREA
] - 1;
12443 while (glyph
> end
+ 1
12444 && INTEGERP (glyph
->object
)
12445 && glyph
->charpos
< 0)
12448 x
-= glyph
->pixel_width
;
12450 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12452 /* By default, in reversed rows we put the cursor on the
12453 rightmost (first in the reading order) glyph. */
12454 for (g
= end
+ 1; g
< glyph
; g
++)
12455 x
+= g
->pixel_width
;
12457 && INTEGERP ((end
+ 1)->object
)
12458 && (end
+ 1)->charpos
<= 0)
12460 glyph_before
= glyph
+ 1;
12464 else if (row
->reversed_p
)
12466 /* In R2L rows that don't display text, put the cursor on the
12467 rightmost glyph. Case in point: an empty last line that is
12468 part of an R2L paragraph. */
12470 /* Avoid placing the cursor on the last glyph of the row, where
12471 on terminal frames we hold the vertical border between
12472 adjacent windows. */
12473 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12474 && !WINDOW_RIGHTMOST_P (w
)
12475 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12477 x
= -1; /* will be computed below, at label compute_x */
12480 /* Step 1: Try to find the glyph whose character position
12481 corresponds to point. If that's not possible, find 2 glyphs
12482 whose character positions are the closest to point, one before
12483 point, the other after it. */
12484 if (!row
->reversed_p
)
12485 while (/* not marched to end of glyph row */
12487 /* glyph was not inserted by redisplay for internal purposes */
12488 && !INTEGERP (glyph
->object
))
12490 if (BUFFERP (glyph
->object
))
12492 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12494 if (glyph
->charpos
> bpos_max
)
12495 bpos_max
= glyph
->charpos
;
12496 if (glyph
->charpos
< bpos_min
)
12497 bpos_min
= glyph
->charpos
;
12498 if (!glyph
->avoid_cursor_p
)
12500 /* If we hit point, we've found the glyph on which to
12501 display the cursor. */
12504 match_with_avoid_cursor
= 0;
12507 /* See if we've found a better approximation to
12508 POS_BEFORE or to POS_AFTER. Note that we want the
12509 first (leftmost) glyph of all those that are the
12510 closest from below, and the last (rightmost) of all
12511 those from above. */
12512 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12514 pos_before
= glyph
->charpos
;
12515 glyph_before
= glyph
;
12517 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12519 pos_after
= glyph
->charpos
;
12520 glyph_after
= glyph
;
12523 else if (dpos
== 0)
12524 match_with_avoid_cursor
= 1;
12526 else if (STRINGP (glyph
->object
))
12528 Lisp_Object chprop
;
12529 EMACS_INT glyph_pos
= glyph
->charpos
;
12531 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12533 if (INTEGERP (chprop
))
12535 bpos_covered
= bpos_max
+ XINT (chprop
);
12536 /* If the `cursor' property covers buffer positions up
12537 to and including point, we should display cursor on
12538 this glyph. Note that overlays and text properties
12539 with string values stop bidi reordering, so every
12540 buffer position to the left of the string is always
12541 smaller than any position to the right of the
12542 string. Therefore, if a `cursor' property on one
12543 of the string's characters has an integer value, we
12544 will break out of the loop below _before_ we get to
12545 the position match above. IOW, integer values of
12546 the `cursor' property override the "exact match for
12547 point" strategy of positioning the cursor. */
12548 /* Implementation note: bpos_max == pt_old when, e.g.,
12549 we are in an empty line, where bpos_max is set to
12550 MATRIX_ROW_START_CHARPOS, see above. */
12551 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12560 x
+= glyph
->pixel_width
;
12563 else if (glyph
> end
) /* row is reversed */
12564 while (!INTEGERP (glyph
->object
))
12566 if (BUFFERP (glyph
->object
))
12568 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12570 if (glyph
->charpos
> bpos_max
)
12571 bpos_max
= glyph
->charpos
;
12572 if (glyph
->charpos
< bpos_min
)
12573 bpos_min
= glyph
->charpos
;
12574 if (!glyph
->avoid_cursor_p
)
12578 match_with_avoid_cursor
= 0;
12581 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12583 pos_before
= glyph
->charpos
;
12584 glyph_before
= glyph
;
12586 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12588 pos_after
= glyph
->charpos
;
12589 glyph_after
= glyph
;
12592 else if (dpos
== 0)
12593 match_with_avoid_cursor
= 1;
12595 else if (STRINGP (glyph
->object
))
12597 Lisp_Object chprop
;
12598 EMACS_INT glyph_pos
= glyph
->charpos
;
12600 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12602 if (INTEGERP (chprop
))
12604 bpos_covered
= bpos_max
+ XINT (chprop
);
12605 /* If the `cursor' property covers buffer positions up
12606 to and including point, we should display cursor on
12608 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12617 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12619 x
--; /* can't use any pixel_width */
12622 x
-= glyph
->pixel_width
;
12625 /* Step 2: If we didn't find an exact match for point, we need to
12626 look for a proper place to put the cursor among glyphs between
12627 GLYPH_BEFORE and GLYPH_AFTER. */
12628 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12629 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12630 && bpos_covered
< pt_old
)
12632 /* An empty line has a single glyph whose OBJECT is zero and
12633 whose CHARPOS is the position of a newline on that line.
12634 Note that on a TTY, there are more glyphs after that, which
12635 were produced by extend_face_to_end_of_line, but their
12636 CHARPOS is zero or negative. */
12638 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12639 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12641 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12643 EMACS_INT ellipsis_pos
;
12645 /* Scan back over the ellipsis glyphs. */
12646 if (!row
->reversed_p
)
12648 ellipsis_pos
= (glyph
- 1)->charpos
;
12649 while (glyph
> row
->glyphs
[TEXT_AREA
]
12650 && (glyph
- 1)->charpos
== ellipsis_pos
)
12651 glyph
--, x
-= glyph
->pixel_width
;
12652 /* That loop always goes one position too far, including
12653 the glyph before the ellipsis. So scan forward over
12655 x
+= glyph
->pixel_width
;
12658 else /* row is reversed */
12660 ellipsis_pos
= (glyph
+ 1)->charpos
;
12661 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12662 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12663 glyph
++, x
+= glyph
->pixel_width
;
12664 x
-= glyph
->pixel_width
;
12668 else if (match_with_avoid_cursor
12669 /* A truncated row may not include PT among its
12670 character positions. Setting the cursor inside the
12671 scroll margin will trigger recalculation of hscroll
12672 in hscroll_window_tree. */
12673 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12674 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12675 /* Zero-width characters produce no glyphs. */
12678 && (row
->reversed_p
12679 ? glyph_after
> glyphs_end
12680 : glyph_after
< glyphs_end
)))
12682 cursor
= glyph_after
;
12685 else if (string_seen
)
12687 int incr
= row
->reversed_p
? -1 : +1;
12689 /* Need to find the glyph that came out of a string which is
12690 present at point. That glyph is somewhere between
12691 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12692 positioned between POS_BEFORE and POS_AFTER in the
12694 struct glyph
*stop
= glyph_after
;
12695 EMACS_INT pos
= pos_before
;
12698 for (glyph
= glyph_before
+ incr
;
12699 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12702 /* Any glyphs that come from the buffer are here because
12703 of bidi reordering. Skip them, and only pay
12704 attention to glyphs that came from some string. */
12705 if (STRINGP (glyph
->object
))
12710 str
= glyph
->object
;
12711 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12712 if (tem
== 0 /* from overlay */
12715 /* If the string from which this glyph came is
12716 found in the buffer at point, then we've
12717 found the glyph we've been looking for. If
12718 it comes from an overlay (tem == 0), and it
12719 has the `cursor' property on one of its
12720 glyphs, record that glyph as a candidate for
12721 displaying the cursor. (As in the
12722 unidirectional version, we will display the
12723 cursor on the last candidate we find.) */
12724 if (tem
== 0 || tem
== pt_old
)
12726 /* The glyphs from this string could have
12727 been reordered. Find the one with the
12728 smallest string position. Or there could
12729 be a character in the string with the
12730 `cursor' property, which means display
12731 cursor on that character's glyph. */
12732 EMACS_INT strpos
= glyph
->charpos
;
12737 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12738 && EQ (glyph
->object
, str
);
12742 EMACS_INT gpos
= glyph
->charpos
;
12744 cprop
= Fget_char_property (make_number (gpos
),
12752 if (tem
&& glyph
->charpos
< strpos
)
12754 strpos
= glyph
->charpos
;
12763 pos
= tem
+ 1; /* don't find previous instances */
12765 /* This string is not what we want; skip all of the
12766 glyphs that came from it. */
12767 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12768 && EQ (glyph
->object
, str
))
12775 /* If we reached the end of the line, and END was from a string,
12776 the cursor is not on this line. */
12778 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12779 && STRINGP (end
->object
)
12780 && row
->continued_p
)
12786 if (cursor
!= NULL
)
12792 /* Need to compute x that corresponds to GLYPH. */
12793 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12795 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12797 x
+= g
->pixel_width
;
12801 /* ROW could be part of a continued line, which, under bidi
12802 reordering, might have other rows whose start and end charpos
12803 occlude point. Only set w->cursor if we found a better
12804 approximation to the cursor position than we have from previously
12805 examined candidate rows belonging to the same continued line. */
12806 if (/* we already have a candidate row */
12807 w
->cursor
.vpos
>= 0
12808 /* that candidate is not the row we are processing */
12809 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12810 /* the row we are processing is part of a continued line */
12811 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12812 /* Make sure cursor.vpos specifies a row whose start and end
12813 charpos occlude point. This is because some callers of this
12814 function leave cursor.vpos at the row where the cursor was
12815 displayed during the last redisplay cycle. */
12816 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12817 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12820 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12822 /* Don't consider glyphs that are outside TEXT_AREA. */
12823 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12825 /* Keep the candidate whose buffer position is the closest to
12827 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12828 w
->cursor
.hpos
>= 0
12829 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12830 && BUFFERP (g1
->object
)
12831 && (g1
->charpos
== pt_old
/* an exact match always wins */
12832 || (BUFFERP (glyph
->object
)
12833 && eabs (g1
->charpos
- pt_old
)
12834 < eabs (glyph
->charpos
- pt_old
))))
12836 /* If this candidate gives an exact match, use that. */
12837 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12838 /* Otherwise, keep the candidate that comes from a row
12839 spanning less buffer positions. This may win when one or
12840 both candidate positions are on glyphs that came from
12841 display strings, for which we cannot compare buffer
12843 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12844 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12845 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12848 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12850 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12851 w
->cursor
.y
= row
->y
+ dy
;
12853 if (w
== XWINDOW (selected_window
))
12855 if (!row
->continued_p
12856 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12859 this_line_buffer
= XBUFFER (w
->buffer
);
12861 CHARPOS (this_line_start_pos
)
12862 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12863 BYTEPOS (this_line_start_pos
)
12864 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12866 CHARPOS (this_line_end_pos
)
12867 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12868 BYTEPOS (this_line_end_pos
)
12869 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12871 this_line_y
= w
->cursor
.y
;
12872 this_line_pixel_height
= row
->height
;
12873 this_line_vpos
= w
->cursor
.vpos
;
12874 this_line_start_x
= row
->x
;
12877 CHARPOS (this_line_start_pos
) = 0;
12884 /* Run window scroll functions, if any, for WINDOW with new window
12885 start STARTP. Sets the window start of WINDOW to that position.
12887 We assume that the window's buffer is really current. */
12889 static INLINE
struct text_pos
12890 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12892 struct window
*w
= XWINDOW (window
);
12893 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12895 if (current_buffer
!= XBUFFER (w
->buffer
))
12898 if (!NILP (Vwindow_scroll_functions
))
12900 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12901 make_number (CHARPOS (startp
)));
12902 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12903 /* In case the hook functions switch buffers. */
12904 if (current_buffer
!= XBUFFER (w
->buffer
))
12905 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12912 /* Make sure the line containing the cursor is fully visible.
12913 A value of 1 means there is nothing to be done.
12914 (Either the line is fully visible, or it cannot be made so,
12915 or we cannot tell.)
12917 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12918 is higher than window.
12920 A value of 0 means the caller should do scrolling
12921 as if point had gone off the screen. */
12924 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12926 struct glyph_matrix
*matrix
;
12927 struct glyph_row
*row
;
12930 if (!make_cursor_line_fully_visible_p
)
12933 /* It's not always possible to find the cursor, e.g, when a window
12934 is full of overlay strings. Don't do anything in that case. */
12935 if (w
->cursor
.vpos
< 0)
12938 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12939 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12941 /* If the cursor row is not partially visible, there's nothing to do. */
12942 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12945 /* If the row the cursor is in is taller than the window's height,
12946 it's not clear what to do, so do nothing. */
12947 window_height
= window_box_height (w
);
12948 if (row
->height
>= window_height
)
12950 if (!force_p
|| MINI_WINDOW_P (w
)
12951 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12958 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12959 non-zero means only WINDOW is redisplayed in redisplay_internal.
12960 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12961 in redisplay_window to bring a partially visible line into view in
12962 the case that only the cursor has moved.
12964 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12965 last screen line's vertical height extends past the end of the screen.
12969 1 if scrolling succeeded
12971 0 if scrolling didn't find point.
12973 -1 if new fonts have been loaded so that we must interrupt
12974 redisplay, adjust glyph matrices, and try again. */
12980 SCROLLING_NEED_LARGER_MATRICES
12983 /* If scroll-conservatively is more than this, never recenter.
12985 If you change this, don't forget to update the doc string of
12986 `scroll-conservatively' and the Emacs manual. */
12987 #define SCROLL_LIMIT 100
12990 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12991 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12992 int temp_scroll_step
, int last_line_misfit
)
12994 struct window
*w
= XWINDOW (window
);
12995 struct frame
*f
= XFRAME (w
->frame
);
12996 struct text_pos pos
, startp
;
12998 int this_scroll_margin
, scroll_max
, rc
, height
;
12999 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13000 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13001 Lisp_Object aggressive
;
13002 /* We will never try scrolling more than this number of lines. */
13003 int scroll_limit
= SCROLL_LIMIT
;
13006 debug_method_add (w
, "try_scrolling");
13009 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13011 /* Compute scroll margin height in pixels. We scroll when point is
13012 within this distance from the top or bottom of the window. */
13013 if (scroll_margin
> 0)
13014 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13015 * FRAME_LINE_HEIGHT (f
);
13017 this_scroll_margin
= 0;
13019 /* Force arg_scroll_conservatively to have a reasonable value, to
13020 avoid scrolling too far away with slow move_it_* functions. Note
13021 that the user can supply scroll-conservatively equal to
13022 `most-positive-fixnum', which can be larger than INT_MAX. */
13023 if (arg_scroll_conservatively
> scroll_limit
)
13025 arg_scroll_conservatively
= scroll_limit
+ 1;
13026 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13028 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13029 /* Compute how much we should try to scroll maximally to bring
13030 point into view. */
13031 scroll_max
= (max (scroll_step
,
13032 max (arg_scroll_conservatively
, temp_scroll_step
))
13033 * FRAME_LINE_HEIGHT (f
));
13034 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13035 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13036 /* We're trying to scroll because of aggressive scrolling but no
13037 scroll_step is set. Choose an arbitrary one. */
13038 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13044 /* Decide whether to scroll down. */
13045 if (PT
> CHARPOS (startp
))
13047 int scroll_margin_y
;
13049 /* Compute the pixel ypos of the scroll margin, then move it to
13050 either that ypos or PT, whichever comes first. */
13051 start_display (&it
, w
, startp
);
13052 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13053 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13054 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13055 (MOVE_TO_POS
| MOVE_TO_Y
));
13057 if (PT
> CHARPOS (it
.current
.pos
))
13059 int y0
= line_bottom_y (&it
);
13060 /* Compute how many pixels below window bottom to stop searching
13061 for PT. This avoids costly search for PT that is far away if
13062 the user limited scrolling by a small number of lines, but
13063 always finds PT if scroll_conservatively is set to a large
13064 number, such as most-positive-fixnum. */
13065 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13066 int y_to_move
= it
.last_visible_y
+ slack
;
13068 /* Compute the distance from the scroll margin to PT or to
13069 the scroll limit, whichever comes first. This should
13070 include the height of the cursor line, to make that line
13072 move_it_to (&it
, PT
, -1, y_to_move
,
13073 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13074 dy
= line_bottom_y (&it
) - y0
;
13076 if (dy
> scroll_max
)
13077 return SCROLLING_FAILED
;
13085 /* Point is in or below the bottom scroll margin, so move the
13086 window start down. If scrolling conservatively, move it just
13087 enough down to make point visible. If scroll_step is set,
13088 move it down by scroll_step. */
13089 if (arg_scroll_conservatively
)
13091 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13092 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13093 else if (scroll_step
|| temp_scroll_step
)
13094 amount_to_scroll
= scroll_max
;
13097 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13098 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13099 if (NUMBERP (aggressive
))
13101 double float_amount
= XFLOATINT (aggressive
) * height
;
13102 amount_to_scroll
= float_amount
;
13103 if (amount_to_scroll
== 0 && float_amount
> 0)
13104 amount_to_scroll
= 1;
13105 /* Don't let point enter the scroll margin near top of
13107 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13108 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13112 if (amount_to_scroll
<= 0)
13113 return SCROLLING_FAILED
;
13115 start_display (&it
, w
, startp
);
13116 if (arg_scroll_conservatively
<= scroll_limit
)
13117 move_it_vertically (&it
, amount_to_scroll
);
13120 /* Extra precision for users who set scroll-conservatively
13121 to a large number: make sure the amount we scroll
13122 the window start is never less than amount_to_scroll,
13123 which was computed as distance from window bottom to
13124 point. This matters when lines at window top and lines
13125 below window bottom have different height. */
13126 struct it it1
= it
;
13127 /* We use a temporary it1 because line_bottom_y can modify
13128 its argument, if it moves one line down; see there. */
13129 int start_y
= line_bottom_y (&it1
);
13132 move_it_by_lines (&it
, 1);
13134 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13137 /* If STARTP is unchanged, move it down another screen line. */
13138 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13139 move_it_by_lines (&it
, 1);
13140 startp
= it
.current
.pos
;
13144 struct text_pos scroll_margin_pos
= startp
;
13146 /* See if point is inside the scroll margin at the top of the
13148 if (this_scroll_margin
)
13150 start_display (&it
, w
, startp
);
13151 move_it_vertically (&it
, this_scroll_margin
);
13152 scroll_margin_pos
= it
.current
.pos
;
13155 if (PT
< CHARPOS (scroll_margin_pos
))
13157 /* Point is in the scroll margin at the top of the window or
13158 above what is displayed in the window. */
13161 /* Compute the vertical distance from PT to the scroll
13162 margin position. Move as far as scroll_max allows, or
13163 one screenful, or 10 screen lines, whichever is largest.
13164 Give up if distance is greater than scroll_max. */
13165 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13166 start_display (&it
, w
, pos
);
13168 y_to_move
= max (it
.last_visible_y
,
13169 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13170 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13172 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13173 dy
= it
.current_y
- y0
;
13174 if (dy
> scroll_max
)
13175 return SCROLLING_FAILED
;
13177 /* Compute new window start. */
13178 start_display (&it
, w
, startp
);
13180 if (arg_scroll_conservatively
)
13181 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13182 max (scroll_step
, temp_scroll_step
));
13183 else if (scroll_step
|| temp_scroll_step
)
13184 amount_to_scroll
= scroll_max
;
13187 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13188 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13189 if (NUMBERP (aggressive
))
13191 double float_amount
= XFLOATINT (aggressive
) * height
;
13192 amount_to_scroll
= float_amount
;
13193 if (amount_to_scroll
== 0 && float_amount
> 0)
13194 amount_to_scroll
= 1;
13195 amount_to_scroll
-=
13196 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13197 /* Don't let point enter the scroll margin near
13198 bottom of the window. */
13199 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13200 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13204 if (amount_to_scroll
<= 0)
13205 return SCROLLING_FAILED
;
13207 move_it_vertically_backward (&it
, amount_to_scroll
);
13208 startp
= it
.current
.pos
;
13212 /* Run window scroll functions. */
13213 startp
= run_window_scroll_functions (window
, startp
);
13215 /* Display the window. Give up if new fonts are loaded, or if point
13217 if (!try_window (window
, startp
, 0))
13218 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13219 else if (w
->cursor
.vpos
< 0)
13221 clear_glyph_matrix (w
->desired_matrix
);
13222 rc
= SCROLLING_FAILED
;
13226 /* Maybe forget recorded base line for line number display. */
13227 if (!just_this_one_p
13228 || current_buffer
->clip_changed
13229 || BEG_UNCHANGED
< CHARPOS (startp
))
13230 w
->base_line_number
= Qnil
;
13232 /* If cursor ends up on a partially visible line,
13233 treat that as being off the bottom of the screen. */
13234 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13235 /* It's possible that the cursor is on the first line of the
13236 buffer, which is partially obscured due to a vscroll
13237 (Bug#7537). In that case, avoid looping forever . */
13238 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13240 clear_glyph_matrix (w
->desired_matrix
);
13241 ++extra_scroll_margin_lines
;
13244 rc
= SCROLLING_SUCCESS
;
13251 /* Compute a suitable window start for window W if display of W starts
13252 on a continuation line. Value is non-zero if a new window start
13255 The new window start will be computed, based on W's width, starting
13256 from the start of the continued line. It is the start of the
13257 screen line with the minimum distance from the old start W->start. */
13260 compute_window_start_on_continuation_line (struct window
*w
)
13262 struct text_pos pos
, start_pos
;
13263 int window_start_changed_p
= 0;
13265 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13267 /* If window start is on a continuation line... Window start may be
13268 < BEGV in case there's invisible text at the start of the
13269 buffer (M-x rmail, for example). */
13270 if (CHARPOS (start_pos
) > BEGV
13271 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13274 struct glyph_row
*row
;
13276 /* Handle the case that the window start is out of range. */
13277 if (CHARPOS (start_pos
) < BEGV
)
13278 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13279 else if (CHARPOS (start_pos
) > ZV
)
13280 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13282 /* Find the start of the continued line. This should be fast
13283 because scan_buffer is fast (newline cache). */
13284 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13285 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13286 row
, DEFAULT_FACE_ID
);
13287 reseat_at_previous_visible_line_start (&it
);
13289 /* If the line start is "too far" away from the window start,
13290 say it takes too much time to compute a new window start. */
13291 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13292 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13294 int min_distance
, distance
;
13296 /* Move forward by display lines to find the new window
13297 start. If window width was enlarged, the new start can
13298 be expected to be > the old start. If window width was
13299 decreased, the new window start will be < the old start.
13300 So, we're looking for the display line start with the
13301 minimum distance from the old window start. */
13302 pos
= it
.current
.pos
;
13303 min_distance
= INFINITY
;
13304 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13305 distance
< min_distance
)
13307 min_distance
= distance
;
13308 pos
= it
.current
.pos
;
13309 move_it_by_lines (&it
, 1);
13312 /* Set the window start there. */
13313 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13314 window_start_changed_p
= 1;
13318 return window_start_changed_p
;
13322 /* Try cursor movement in case text has not changed in window WINDOW,
13323 with window start STARTP. Value is
13325 CURSOR_MOVEMENT_SUCCESS if successful
13327 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13329 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13330 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13331 we want to scroll as if scroll-step were set to 1. See the code.
13333 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13334 which case we have to abort this redisplay, and adjust matrices
13339 CURSOR_MOVEMENT_SUCCESS
,
13340 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13341 CURSOR_MOVEMENT_MUST_SCROLL
,
13342 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13346 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13348 struct window
*w
= XWINDOW (window
);
13349 struct frame
*f
= XFRAME (w
->frame
);
13350 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13353 if (inhibit_try_cursor_movement
)
13357 /* Handle case where text has not changed, only point, and it has
13358 not moved off the frame. */
13359 if (/* Point may be in this window. */
13360 PT
>= CHARPOS (startp
)
13361 /* Selective display hasn't changed. */
13362 && !current_buffer
->clip_changed
13363 /* Function force-mode-line-update is used to force a thorough
13364 redisplay. It sets either windows_or_buffers_changed or
13365 update_mode_lines. So don't take a shortcut here for these
13367 && !update_mode_lines
13368 && !windows_or_buffers_changed
13369 && !cursor_type_changed
13370 /* Can't use this case if highlighting a region. When a
13371 region exists, cursor movement has to do more than just
13373 && !(!NILP (Vtransient_mark_mode
)
13374 && !NILP (BVAR (current_buffer
, mark_active
)))
13375 && NILP (w
->region_showing
)
13376 && NILP (Vshow_trailing_whitespace
)
13377 /* Right after splitting windows, last_point may be nil. */
13378 && INTEGERP (w
->last_point
)
13379 /* This code is not used for mini-buffer for the sake of the case
13380 of redisplaying to replace an echo area message; since in
13381 that case the mini-buffer contents per se are usually
13382 unchanged. This code is of no real use in the mini-buffer
13383 since the handling of this_line_start_pos, etc., in redisplay
13384 handles the same cases. */
13385 && !EQ (window
, minibuf_window
)
13386 /* When splitting windows or for new windows, it happens that
13387 redisplay is called with a nil window_end_vpos or one being
13388 larger than the window. This should really be fixed in
13389 window.c. I don't have this on my list, now, so we do
13390 approximately the same as the old redisplay code. --gerd. */
13391 && INTEGERP (w
->window_end_vpos
)
13392 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13393 && (FRAME_WINDOW_P (f
)
13394 || !overlay_arrow_in_current_buffer_p ()))
13396 int this_scroll_margin
, top_scroll_margin
;
13397 struct glyph_row
*row
= NULL
;
13400 debug_method_add (w
, "cursor movement");
13403 /* Scroll if point within this distance from the top or bottom
13404 of the window. This is a pixel value. */
13405 if (scroll_margin
> 0)
13407 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13408 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13411 this_scroll_margin
= 0;
13413 top_scroll_margin
= this_scroll_margin
;
13414 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13415 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13417 /* Start with the row the cursor was displayed during the last
13418 not paused redisplay. Give up if that row is not valid. */
13419 if (w
->last_cursor
.vpos
< 0
13420 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13421 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13424 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13425 if (row
->mode_line_p
)
13427 if (!row
->enabled_p
)
13428 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13431 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13433 int scroll_p
= 0, must_scroll
= 0;
13434 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13436 if (PT
> XFASTINT (w
->last_point
))
13438 /* Point has moved forward. */
13439 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13440 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13442 xassert (row
->enabled_p
);
13446 /* If the end position of a row equals the start
13447 position of the next row, and PT is at that position,
13448 we would rather display cursor in the next line. */
13449 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13450 && MATRIX_ROW_END_CHARPOS (row
) == PT
13451 && row
< w
->current_matrix
->rows
13452 + w
->current_matrix
->nrows
- 1
13453 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13454 && !cursor_row_p (row
))
13457 /* If within the scroll margin, scroll. Note that
13458 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13459 the next line would be drawn, and that
13460 this_scroll_margin can be zero. */
13461 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13462 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13463 /* Line is completely visible last line in window
13464 and PT is to be set in the next line. */
13465 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13466 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13467 && !row
->ends_at_zv_p
13468 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13471 else if (PT
< XFASTINT (w
->last_point
))
13473 /* Cursor has to be moved backward. Note that PT >=
13474 CHARPOS (startp) because of the outer if-statement. */
13475 while (!row
->mode_line_p
13476 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13477 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13478 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13479 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13480 row
> w
->current_matrix
->rows
13481 && (row
-1)->ends_in_newline_from_string_p
))))
13482 && (row
->y
> top_scroll_margin
13483 || CHARPOS (startp
) == BEGV
))
13485 xassert (row
->enabled_p
);
13489 /* Consider the following case: Window starts at BEGV,
13490 there is invisible, intangible text at BEGV, so that
13491 display starts at some point START > BEGV. It can
13492 happen that we are called with PT somewhere between
13493 BEGV and START. Try to handle that case. */
13494 if (row
< w
->current_matrix
->rows
13495 || row
->mode_line_p
)
13497 row
= w
->current_matrix
->rows
;
13498 if (row
->mode_line_p
)
13502 /* Due to newlines in overlay strings, we may have to
13503 skip forward over overlay strings. */
13504 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13505 && MATRIX_ROW_END_CHARPOS (row
) == PT
13506 && !cursor_row_p (row
))
13509 /* If within the scroll margin, scroll. */
13510 if (row
->y
< top_scroll_margin
13511 && CHARPOS (startp
) != BEGV
)
13516 /* Cursor did not move. So don't scroll even if cursor line
13517 is partially visible, as it was so before. */
13518 rc
= CURSOR_MOVEMENT_SUCCESS
;
13521 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13522 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13524 /* if PT is not in the glyph row, give up. */
13525 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13528 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13529 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13531 /* If rows are bidi-reordered and point moved, back up
13532 until we find a row that does not belong to a
13533 continuation line. This is because we must consider
13534 all rows of a continued line as candidates for the
13535 new cursor positioning, since row start and end
13536 positions change non-linearly with vertical position
13538 /* FIXME: Revisit this when glyph ``spilling'' in
13539 continuation lines' rows is implemented for
13540 bidi-reordered rows. */
13541 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13543 xassert (row
->enabled_p
);
13545 /* If we hit the beginning of the displayed portion
13546 without finding the first row of a continued
13548 if (row
<= w
->current_matrix
->rows
)
13550 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13558 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13559 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13560 && make_cursor_line_fully_visible_p
)
13562 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13563 && !row
->ends_at_zv_p
13564 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13565 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13566 else if (row
->height
> window_box_height (w
))
13568 /* If we end up in a partially visible line, let's
13569 make it fully visible, except when it's taller
13570 than the window, in which case we can't do much
13573 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13577 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13578 if (!cursor_row_fully_visible_p (w
, 0, 1))
13579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13581 rc
= CURSOR_MOVEMENT_SUCCESS
;
13585 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13586 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13587 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13589 /* With bidi-reordered rows, there could be more than
13590 one candidate row whose start and end positions
13591 occlude point. We need to let set_cursor_from_row
13592 find the best candidate. */
13593 /* FIXME: Revisit this when glyph ``spilling'' in
13594 continuation lines' rows is implemented for
13595 bidi-reordered rows. */
13600 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13601 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13602 && cursor_row_p (row
))
13603 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13605 /* As soon as we've found the first suitable row
13606 whose ends_at_zv_p flag is set, we are done. */
13608 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13610 rc
= CURSOR_MOVEMENT_SUCCESS
;
13615 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13616 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13617 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13618 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13619 /* If we didn't find any candidate rows, or exited the
13620 loop before all the candidates were examined, signal
13621 to the caller that this method failed. */
13622 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13623 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13624 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13626 rc
= CURSOR_MOVEMENT_SUCCESS
;
13632 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13634 rc
= CURSOR_MOVEMENT_SUCCESS
;
13639 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13640 && MATRIX_ROW_START_CHARPOS (row
) == PT
13641 && cursor_row_p (row
));
13649 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13653 set_vertical_scroll_bar (struct window
*w
)
13655 EMACS_INT start
, end
, whole
;
13657 /* Calculate the start and end positions for the current window.
13658 At some point, it would be nice to choose between scrollbars
13659 which reflect the whole buffer size, with special markers
13660 indicating narrowing, and scrollbars which reflect only the
13663 Note that mini-buffers sometimes aren't displaying any text. */
13664 if (!MINI_WINDOW_P (w
)
13665 || (w
== XWINDOW (minibuf_window
)
13666 && NILP (echo_area_buffer
[0])))
13668 struct buffer
*buf
= XBUFFER (w
->buffer
);
13669 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13670 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13671 /* I don't think this is guaranteed to be right. For the
13672 moment, we'll pretend it is. */
13673 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13677 if (whole
< (end
- start
))
13678 whole
= end
- start
;
13681 start
= end
= whole
= 0;
13683 /* Indicate what this scroll bar ought to be displaying now. */
13684 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13685 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13686 (w
, end
- start
, whole
, start
);
13690 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13691 selected_window is redisplayed.
13693 We can return without actually redisplaying the window if
13694 fonts_changed_p is nonzero. In that case, redisplay_internal will
13698 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13700 struct window
*w
= XWINDOW (window
);
13701 struct frame
*f
= XFRAME (w
->frame
);
13702 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13703 struct buffer
*old
= current_buffer
;
13704 struct text_pos lpoint
, opoint
, startp
;
13705 int update_mode_line
;
13708 /* Record it now because it's overwritten. */
13709 int current_matrix_up_to_date_p
= 0;
13710 int used_current_matrix_p
= 0;
13711 /* This is less strict than current_matrix_up_to_date_p.
13712 It indictes that the buffer contents and narrowing are unchanged. */
13713 int buffer_unchanged_p
= 0;
13714 int temp_scroll_step
= 0;
13715 int count
= SPECPDL_INDEX ();
13717 int centering_position
= -1;
13718 int last_line_misfit
= 0;
13719 EMACS_INT beg_unchanged
, end_unchanged
;
13721 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13724 /* W must be a leaf window here. */
13725 xassert (!NILP (w
->buffer
));
13727 *w
->desired_matrix
->method
= 0;
13731 reconsider_clip_changes (w
, buffer
);
13733 /* Has the mode line to be updated? */
13734 update_mode_line
= (!NILP (w
->update_mode_line
)
13735 || update_mode_lines
13736 || buffer
->clip_changed
13737 || buffer
->prevent_redisplay_optimizations_p
);
13739 if (MINI_WINDOW_P (w
))
13741 if (w
== XWINDOW (echo_area_window
)
13742 && !NILP (echo_area_buffer
[0]))
13744 if (update_mode_line
)
13745 /* We may have to update a tty frame's menu bar or a
13746 tool-bar. Example `M-x C-h C-h C-g'. */
13747 goto finish_menu_bars
;
13749 /* We've already displayed the echo area glyphs in this window. */
13750 goto finish_scroll_bars
;
13752 else if ((w
!= XWINDOW (minibuf_window
)
13753 || minibuf_level
== 0)
13754 /* When buffer is nonempty, redisplay window normally. */
13755 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13756 /* Quail displays non-mini buffers in minibuffer window.
13757 In that case, redisplay the window normally. */
13758 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13760 /* W is a mini-buffer window, but it's not active, so clear
13762 int yb
= window_text_bottom_y (w
);
13763 struct glyph_row
*row
;
13766 for (y
= 0, row
= w
->desired_matrix
->rows
;
13768 y
+= row
->height
, ++row
)
13769 blank_row (w
, row
, y
);
13770 goto finish_scroll_bars
;
13773 clear_glyph_matrix (w
->desired_matrix
);
13776 /* Otherwise set up data on this window; select its buffer and point
13778 /* Really select the buffer, for the sake of buffer-local
13780 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13782 current_matrix_up_to_date_p
13783 = (!NILP (w
->window_end_valid
)
13784 && !current_buffer
->clip_changed
13785 && !current_buffer
->prevent_redisplay_optimizations_p
13786 && XFASTINT (w
->last_modified
) >= MODIFF
13787 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13789 /* Run the window-bottom-change-functions
13790 if it is possible that the text on the screen has changed
13791 (either due to modification of the text, or any other reason). */
13792 if (!current_matrix_up_to_date_p
13793 && !NILP (Vwindow_text_change_functions
))
13795 safe_run_hooks (Qwindow_text_change_functions
);
13799 beg_unchanged
= BEG_UNCHANGED
;
13800 end_unchanged
= END_UNCHANGED
;
13802 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13804 specbind (Qinhibit_point_motion_hooks
, Qt
);
13807 = (!NILP (w
->window_end_valid
)
13808 && !current_buffer
->clip_changed
13809 && XFASTINT (w
->last_modified
) >= MODIFF
13810 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13812 /* When windows_or_buffers_changed is non-zero, we can't rely on
13813 the window end being valid, so set it to nil there. */
13814 if (windows_or_buffers_changed
)
13816 /* If window starts on a continuation line, maybe adjust the
13817 window start in case the window's width changed. */
13818 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13819 compute_window_start_on_continuation_line (w
);
13821 w
->window_end_valid
= Qnil
;
13824 /* Some sanity checks. */
13825 CHECK_WINDOW_END (w
);
13826 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13828 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13831 /* If %c is in mode line, update it if needed. */
13832 if (!NILP (w
->column_number_displayed
)
13833 /* This alternative quickly identifies a common case
13834 where no change is needed. */
13835 && !(PT
== XFASTINT (w
->last_point
)
13836 && XFASTINT (w
->last_modified
) >= MODIFF
13837 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13838 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13839 update_mode_line
= 1;
13841 /* Count number of windows showing the selected buffer. An indirect
13842 buffer counts as its base buffer. */
13843 if (!just_this_one_p
)
13845 struct buffer
*current_base
, *window_base
;
13846 current_base
= current_buffer
;
13847 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13848 if (current_base
->base_buffer
)
13849 current_base
= current_base
->base_buffer
;
13850 if (window_base
->base_buffer
)
13851 window_base
= window_base
->base_buffer
;
13852 if (current_base
== window_base
)
13856 /* Point refers normally to the selected window. For any other
13857 window, set up appropriate value. */
13858 if (!EQ (window
, selected_window
))
13860 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13861 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13865 new_pt_byte
= BEGV_BYTE
;
13866 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13868 else if (new_pt
> (ZV
- 1))
13871 new_pt_byte
= ZV_BYTE
;
13872 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13875 /* We don't use SET_PT so that the point-motion hooks don't run. */
13876 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13879 /* If any of the character widths specified in the display table
13880 have changed, invalidate the width run cache. It's true that
13881 this may be a bit late to catch such changes, but the rest of
13882 redisplay goes (non-fatally) haywire when the display table is
13883 changed, so why should we worry about doing any better? */
13884 if (current_buffer
->width_run_cache
)
13886 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13888 if (! disptab_matches_widthtab (disptab
,
13889 XVECTOR (BVAR (current_buffer
, width_table
))))
13891 invalidate_region_cache (current_buffer
,
13892 current_buffer
->width_run_cache
,
13894 recompute_width_table (current_buffer
, disptab
);
13898 /* If window-start is screwed up, choose a new one. */
13899 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13902 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13904 /* If someone specified a new starting point but did not insist,
13905 check whether it can be used. */
13906 if (!NILP (w
->optional_new_start
)
13907 && CHARPOS (startp
) >= BEGV
13908 && CHARPOS (startp
) <= ZV
)
13910 w
->optional_new_start
= Qnil
;
13911 start_display (&it
, w
, startp
);
13912 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13913 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13914 if (IT_CHARPOS (it
) == PT
)
13915 w
->force_start
= Qt
;
13916 /* IT may overshoot PT if text at PT is invisible. */
13917 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13918 w
->force_start
= Qt
;
13923 /* Handle case where place to start displaying has been specified,
13924 unless the specified location is outside the accessible range. */
13925 if (!NILP (w
->force_start
)
13926 || w
->frozen_window_start_p
)
13928 /* We set this later on if we have to adjust point. */
13931 w
->force_start
= Qnil
;
13933 w
->window_end_valid
= Qnil
;
13935 /* Forget any recorded base line for line number display. */
13936 if (!buffer_unchanged_p
)
13937 w
->base_line_number
= Qnil
;
13939 /* Redisplay the mode line. Select the buffer properly for that.
13940 Also, run the hook window-scroll-functions
13941 because we have scrolled. */
13942 /* Note, we do this after clearing force_start because
13943 if there's an error, it is better to forget about force_start
13944 than to get into an infinite loop calling the hook functions
13945 and having them get more errors. */
13946 if (!update_mode_line
13947 || ! NILP (Vwindow_scroll_functions
))
13949 update_mode_line
= 1;
13950 w
->update_mode_line
= Qt
;
13951 startp
= run_window_scroll_functions (window
, startp
);
13954 w
->last_modified
= make_number (0);
13955 w
->last_overlay_modified
= make_number (0);
13956 if (CHARPOS (startp
) < BEGV
)
13957 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13958 else if (CHARPOS (startp
) > ZV
)
13959 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13961 /* Redisplay, then check if cursor has been set during the
13962 redisplay. Give up if new fonts were loaded. */
13963 /* We used to issue a CHECK_MARGINS argument to try_window here,
13964 but this causes scrolling to fail when point begins inside
13965 the scroll margin (bug#148) -- cyd */
13966 if (!try_window (window
, startp
, 0))
13968 w
->force_start
= Qt
;
13969 clear_glyph_matrix (w
->desired_matrix
);
13970 goto need_larger_matrices
;
13973 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13975 /* If point does not appear, try to move point so it does
13976 appear. The desired matrix has been built above, so we
13977 can use it here. */
13978 new_vpos
= window_box_height (w
) / 2;
13981 if (!cursor_row_fully_visible_p (w
, 0, 0))
13983 /* Point does appear, but on a line partly visible at end of window.
13984 Move it back to a fully-visible line. */
13985 new_vpos
= window_box_height (w
);
13988 /* If we need to move point for either of the above reasons,
13989 now actually do it. */
13992 struct glyph_row
*row
;
13994 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13995 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13998 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13999 MATRIX_ROW_START_BYTEPOS (row
));
14001 if (w
!= XWINDOW (selected_window
))
14002 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14003 else if (current_buffer
== old
)
14004 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14006 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14008 /* If we are highlighting the region, then we just changed
14009 the region, so redisplay to show it. */
14010 if (!NILP (Vtransient_mark_mode
)
14011 && !NILP (BVAR (current_buffer
, mark_active
)))
14013 clear_glyph_matrix (w
->desired_matrix
);
14014 if (!try_window (window
, startp
, 0))
14015 goto need_larger_matrices
;
14020 debug_method_add (w
, "forced window start");
14025 /* Handle case where text has not changed, only point, and it has
14026 not moved off the frame, and we are not retrying after hscroll.
14027 (current_matrix_up_to_date_p is nonzero when retrying.) */
14028 if (current_matrix_up_to_date_p
14029 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14030 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14034 case CURSOR_MOVEMENT_SUCCESS
:
14035 used_current_matrix_p
= 1;
14038 case CURSOR_MOVEMENT_MUST_SCROLL
:
14039 goto try_to_scroll
;
14045 /* If current starting point was originally the beginning of a line
14046 but no longer is, find a new starting point. */
14047 else if (!NILP (w
->start_at_line_beg
)
14048 && !(CHARPOS (startp
) <= BEGV
14049 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14052 debug_method_add (w
, "recenter 1");
14057 /* Try scrolling with try_window_id. Value is > 0 if update has
14058 been done, it is -1 if we know that the same window start will
14059 not work. It is 0 if unsuccessful for some other reason. */
14060 else if ((tem
= try_window_id (w
)) != 0)
14063 debug_method_add (w
, "try_window_id %d", tem
);
14066 if (fonts_changed_p
)
14067 goto need_larger_matrices
;
14071 /* Otherwise try_window_id has returned -1 which means that we
14072 don't want the alternative below this comment to execute. */
14074 else if (CHARPOS (startp
) >= BEGV
14075 && CHARPOS (startp
) <= ZV
14076 && PT
>= CHARPOS (startp
)
14077 && (CHARPOS (startp
) < ZV
14078 /* Avoid starting at end of buffer. */
14079 || CHARPOS (startp
) == BEGV
14080 || (XFASTINT (w
->last_modified
) >= MODIFF
14081 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14084 /* If first window line is a continuation line, and window start
14085 is inside the modified region, but the first change is before
14086 current window start, we must select a new window start.
14088 However, if this is the result of a down-mouse event (e.g. by
14089 extending the mouse-drag-overlay), we don't want to select a
14090 new window start, since that would change the position under
14091 the mouse, resulting in an unwanted mouse-movement rather
14092 than a simple mouse-click. */
14093 if (NILP (w
->start_at_line_beg
)
14094 && NILP (do_mouse_tracking
)
14095 && CHARPOS (startp
) > BEGV
14096 && CHARPOS (startp
) > BEG
+ beg_unchanged
14097 && CHARPOS (startp
) <= Z
- end_unchanged
14098 /* Even if w->start_at_line_beg is nil, a new window may
14099 start at a line_beg, since that's how set_buffer_window
14100 sets it. So, we need to check the return value of
14101 compute_window_start_on_continuation_line. (See also
14103 && XMARKER (w
->start
)->buffer
== current_buffer
14104 && compute_window_start_on_continuation_line (w
))
14106 w
->force_start
= Qt
;
14107 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14112 debug_method_add (w
, "same window start");
14115 /* Try to redisplay starting at same place as before.
14116 If point has not moved off frame, accept the results. */
14117 if (!current_matrix_up_to_date_p
14118 /* Don't use try_window_reusing_current_matrix in this case
14119 because a window scroll function can have changed the
14121 || !NILP (Vwindow_scroll_functions
)
14122 || MINI_WINDOW_P (w
)
14123 || !(used_current_matrix_p
14124 = try_window_reusing_current_matrix (w
)))
14126 IF_DEBUG (debug_method_add (w
, "1"));
14127 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14128 /* -1 means we need to scroll.
14129 0 means we need new matrices, but fonts_changed_p
14130 is set in that case, so we will detect it below. */
14131 goto try_to_scroll
;
14134 if (fonts_changed_p
)
14135 goto need_larger_matrices
;
14137 if (w
->cursor
.vpos
>= 0)
14139 if (!just_this_one_p
14140 || current_buffer
->clip_changed
14141 || BEG_UNCHANGED
< CHARPOS (startp
))
14142 /* Forget any recorded base line for line number display. */
14143 w
->base_line_number
= Qnil
;
14145 if (!cursor_row_fully_visible_p (w
, 1, 0))
14147 clear_glyph_matrix (w
->desired_matrix
);
14148 last_line_misfit
= 1;
14150 /* Drop through and scroll. */
14155 clear_glyph_matrix (w
->desired_matrix
);
14160 w
->last_modified
= make_number (0);
14161 w
->last_overlay_modified
= make_number (0);
14163 /* Redisplay the mode line. Select the buffer properly for that. */
14164 if (!update_mode_line
)
14166 update_mode_line
= 1;
14167 w
->update_mode_line
= Qt
;
14170 /* Try to scroll by specified few lines. */
14171 if ((scroll_conservatively
14172 || emacs_scroll_step
14173 || temp_scroll_step
14174 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14175 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14176 && CHARPOS (startp
) >= BEGV
14177 && CHARPOS (startp
) <= ZV
)
14179 /* The function returns -1 if new fonts were loaded, 1 if
14180 successful, 0 if not successful. */
14181 int ss
= try_scrolling (window
, just_this_one_p
,
14182 scroll_conservatively
,
14184 temp_scroll_step
, last_line_misfit
);
14187 case SCROLLING_SUCCESS
:
14190 case SCROLLING_NEED_LARGER_MATRICES
:
14191 goto need_larger_matrices
;
14193 case SCROLLING_FAILED
:
14201 /* Finally, just choose a place to start which positions point
14202 according to user preferences. */
14207 debug_method_add (w
, "recenter");
14210 /* w->vscroll = 0; */
14212 /* Forget any previously recorded base line for line number display. */
14213 if (!buffer_unchanged_p
)
14214 w
->base_line_number
= Qnil
;
14216 /* Determine the window start relative to point. */
14217 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14218 it
.current_y
= it
.last_visible_y
;
14219 if (centering_position
< 0)
14223 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14225 EMACS_INT margin_pos
= CHARPOS (startp
);
14227 Lisp_Object aggressive
;
14229 /* If there is a scroll margin at the top of the window, find
14230 its character position. */
14232 /* Cannot call start_display if startp is not in the
14233 accessible region of the buffer. This can happen when we
14234 have just switched to a different buffer and/or changed
14235 its restriction. In that case, startp is initialized to
14236 the character position 1 (BEG) because we did not yet
14237 have chance to display the buffer even once. */
14238 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14242 start_display (&it1
, w
, startp
);
14243 move_it_vertically (&it1
, margin
);
14244 margin_pos
= IT_CHARPOS (it1
);
14246 scrolling_up
= PT
> margin_pos
;
14249 ? BVAR (current_buffer
, scroll_up_aggressively
)
14250 : BVAR (current_buffer
, scroll_down_aggressively
);
14252 if (!MINI_WINDOW_P (w
)
14253 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14257 /* Setting scroll-conservatively overrides
14258 scroll-*-aggressively. */
14259 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14261 double float_amount
= XFLOATINT (aggressive
);
14263 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14264 if (pt_offset
== 0 && float_amount
> 0)
14269 /* Compute how much to move the window start backward from
14270 point so that point will be displayed where the user
14274 centering_position
= it
.last_visible_y
;
14276 centering_position
-= pt_offset
;
14277 centering_position
-=
14278 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14279 /* Don't let point enter the scroll margin near top of
14281 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14282 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14285 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14288 /* Set the window start half the height of the window backward
14290 centering_position
= window_box_height (w
) / 2;
14292 move_it_vertically_backward (&it
, centering_position
);
14294 xassert (IT_CHARPOS (it
) >= BEGV
);
14296 /* The function move_it_vertically_backward may move over more
14297 than the specified y-distance. If it->w is small, e.g. a
14298 mini-buffer window, we may end up in front of the window's
14299 display area. Start displaying at the start of the line
14300 containing PT in this case. */
14301 if (it
.current_y
<= 0)
14303 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14304 move_it_vertically_backward (&it
, 0);
14308 it
.current_x
= it
.hpos
= 0;
14310 /* Set the window start position here explicitly, to avoid an
14311 infinite loop in case the functions in window-scroll-functions
14313 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14315 /* Run scroll hooks. */
14316 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14318 /* Redisplay the window. */
14319 if (!current_matrix_up_to_date_p
14320 || windows_or_buffers_changed
14321 || cursor_type_changed
14322 /* Don't use try_window_reusing_current_matrix in this case
14323 because it can have changed the buffer. */
14324 || !NILP (Vwindow_scroll_functions
)
14325 || !just_this_one_p
14326 || MINI_WINDOW_P (w
)
14327 || !(used_current_matrix_p
14328 = try_window_reusing_current_matrix (w
)))
14329 try_window (window
, startp
, 0);
14331 /* If new fonts have been loaded (due to fontsets), give up. We
14332 have to start a new redisplay since we need to re-adjust glyph
14334 if (fonts_changed_p
)
14335 goto need_larger_matrices
;
14337 /* If cursor did not appear assume that the middle of the window is
14338 in the first line of the window. Do it again with the next line.
14339 (Imagine a window of height 100, displaying two lines of height
14340 60. Moving back 50 from it->last_visible_y will end in the first
14342 if (w
->cursor
.vpos
< 0)
14344 if (!NILP (w
->window_end_valid
)
14345 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14347 clear_glyph_matrix (w
->desired_matrix
);
14348 move_it_by_lines (&it
, 1);
14349 try_window (window
, it
.current
.pos
, 0);
14351 else if (PT
< IT_CHARPOS (it
))
14353 clear_glyph_matrix (w
->desired_matrix
);
14354 move_it_by_lines (&it
, -1);
14355 try_window (window
, it
.current
.pos
, 0);
14359 /* Not much we can do about it. */
14363 /* Consider the following case: Window starts at BEGV, there is
14364 invisible, intangible text at BEGV, so that display starts at
14365 some point START > BEGV. It can happen that we are called with
14366 PT somewhere between BEGV and START. Try to handle that case. */
14367 if (w
->cursor
.vpos
< 0)
14369 struct glyph_row
*row
= w
->current_matrix
->rows
;
14370 if (row
->mode_line_p
)
14372 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14375 if (!cursor_row_fully_visible_p (w
, 0, 0))
14377 /* If vscroll is enabled, disable it and try again. */
14381 clear_glyph_matrix (w
->desired_matrix
);
14385 /* If centering point failed to make the whole line visible,
14386 put point at the top instead. That has to make the whole line
14387 visible, if it can be done. */
14388 if (centering_position
== 0)
14391 clear_glyph_matrix (w
->desired_matrix
);
14392 centering_position
= 0;
14398 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14399 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14400 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14403 /* Display the mode line, if we must. */
14404 if ((update_mode_line
14405 /* If window not full width, must redo its mode line
14406 if (a) the window to its side is being redone and
14407 (b) we do a frame-based redisplay. This is a consequence
14408 of how inverted lines are drawn in frame-based redisplay. */
14409 || (!just_this_one_p
14410 && !FRAME_WINDOW_P (f
)
14411 && !WINDOW_FULL_WIDTH_P (w
))
14412 /* Line number to display. */
14413 || INTEGERP (w
->base_line_pos
)
14414 /* Column number is displayed and different from the one displayed. */
14415 || (!NILP (w
->column_number_displayed
)
14416 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14417 /* This means that the window has a mode line. */
14418 && (WINDOW_WANTS_MODELINE_P (w
)
14419 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14421 display_mode_lines (w
);
14423 /* If mode line height has changed, arrange for a thorough
14424 immediate redisplay using the correct mode line height. */
14425 if (WINDOW_WANTS_MODELINE_P (w
)
14426 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14428 fonts_changed_p
= 1;
14429 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14430 = DESIRED_MODE_LINE_HEIGHT (w
);
14433 /* If header line height has changed, arrange for a thorough
14434 immediate redisplay using the correct header line height. */
14435 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14436 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14438 fonts_changed_p
= 1;
14439 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14440 = DESIRED_HEADER_LINE_HEIGHT (w
);
14443 if (fonts_changed_p
)
14444 goto need_larger_matrices
;
14447 if (!line_number_displayed
14448 && !BUFFERP (w
->base_line_pos
))
14450 w
->base_line_pos
= Qnil
;
14451 w
->base_line_number
= Qnil
;
14456 /* When we reach a frame's selected window, redo the frame's menu bar. */
14457 if (update_mode_line
14458 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14460 int redisplay_menu_p
= 0;
14462 if (FRAME_WINDOW_P (f
))
14464 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14465 || defined (HAVE_NS) || defined (USE_GTK)
14466 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14468 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14472 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14474 if (redisplay_menu_p
)
14475 display_menu_bar (w
);
14477 #ifdef HAVE_WINDOW_SYSTEM
14478 if (FRAME_WINDOW_P (f
))
14480 #if defined (USE_GTK) || defined (HAVE_NS)
14481 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14482 redisplay_tool_bar (f
);
14484 if (WINDOWP (f
->tool_bar_window
)
14485 && (FRAME_TOOL_BAR_LINES (f
) > 0
14486 || !NILP (Vauto_resize_tool_bars
))
14487 && redisplay_tool_bar (f
))
14488 ignore_mouse_drag_p
= 1;
14494 #ifdef HAVE_WINDOW_SYSTEM
14495 if (FRAME_WINDOW_P (f
)
14496 && update_window_fringes (w
, (just_this_one_p
14497 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14498 || w
->pseudo_window_p
)))
14502 if (draw_window_fringes (w
, 1))
14503 x_draw_vertical_border (w
);
14507 #endif /* HAVE_WINDOW_SYSTEM */
14509 /* We go to this label, with fonts_changed_p nonzero,
14510 if it is necessary to try again using larger glyph matrices.
14511 We have to redeem the scroll bar even in this case,
14512 because the loop in redisplay_internal expects that. */
14513 need_larger_matrices
:
14515 finish_scroll_bars
:
14517 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14519 /* Set the thumb's position and size. */
14520 set_vertical_scroll_bar (w
);
14522 /* Note that we actually used the scroll bar attached to this
14523 window, so it shouldn't be deleted at the end of redisplay. */
14524 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14525 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14528 /* Restore current_buffer and value of point in it. The window
14529 update may have changed the buffer, so first make sure `opoint'
14530 is still valid (Bug#6177). */
14531 if (CHARPOS (opoint
) < BEGV
)
14532 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14533 else if (CHARPOS (opoint
) > ZV
)
14534 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14536 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14538 set_buffer_internal_1 (old
);
14539 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14540 shorter. This can be caused by log truncation in *Messages*. */
14541 if (CHARPOS (lpoint
) <= ZV
)
14542 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14544 unbind_to (count
, Qnil
);
14548 /* Build the complete desired matrix of WINDOW with a window start
14549 buffer position POS.
14551 Value is 1 if successful. It is zero if fonts were loaded during
14552 redisplay which makes re-adjusting glyph matrices necessary, and -1
14553 if point would appear in the scroll margins.
14554 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14555 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14559 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14561 struct window
*w
= XWINDOW (window
);
14563 struct glyph_row
*last_text_row
= NULL
;
14564 struct frame
*f
= XFRAME (w
->frame
);
14566 /* Make POS the new window start. */
14567 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14569 /* Mark cursor position as unknown. No overlay arrow seen. */
14570 w
->cursor
.vpos
= -1;
14571 overlay_arrow_seen
= 0;
14573 /* Initialize iterator and info to start at POS. */
14574 start_display (&it
, w
, pos
);
14576 /* Display all lines of W. */
14577 while (it
.current_y
< it
.last_visible_y
)
14579 if (display_line (&it
))
14580 last_text_row
= it
.glyph_row
- 1;
14581 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14585 /* Don't let the cursor end in the scroll margins. */
14586 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14587 && !MINI_WINDOW_P (w
))
14589 int this_scroll_margin
;
14591 if (scroll_margin
> 0)
14593 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14594 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14597 this_scroll_margin
= 0;
14599 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14600 && w
->cursor
.y
< this_scroll_margin
14601 && CHARPOS (pos
) > BEGV
14602 && IT_CHARPOS (it
) < ZV
)
14603 /* rms: considering make_cursor_line_fully_visible_p here
14604 seems to give wrong results. We don't want to recenter
14605 when the last line is partly visible, we want to allow
14606 that case to be handled in the usual way. */
14607 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14609 w
->cursor
.vpos
= -1;
14610 clear_glyph_matrix (w
->desired_matrix
);
14615 /* If bottom moved off end of frame, change mode line percentage. */
14616 if (XFASTINT (w
->window_end_pos
) <= 0
14617 && Z
!= IT_CHARPOS (it
))
14618 w
->update_mode_line
= Qt
;
14620 /* Set window_end_pos to the offset of the last character displayed
14621 on the window from the end of current_buffer. Set
14622 window_end_vpos to its row number. */
14625 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14626 w
->window_end_bytepos
14627 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14629 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14631 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14632 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14633 ->displays_text_p
);
14637 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14638 w
->window_end_pos
= make_number (Z
- ZV
);
14639 w
->window_end_vpos
= make_number (0);
14642 /* But that is not valid info until redisplay finishes. */
14643 w
->window_end_valid
= Qnil
;
14649 /************************************************************************
14650 Window redisplay reusing current matrix when buffer has not changed
14651 ************************************************************************/
14653 /* Try redisplay of window W showing an unchanged buffer with a
14654 different window start than the last time it was displayed by
14655 reusing its current matrix. Value is non-zero if successful.
14656 W->start is the new window start. */
14659 try_window_reusing_current_matrix (struct window
*w
)
14661 struct frame
*f
= XFRAME (w
->frame
);
14662 struct glyph_row
*bottom_row
;
14665 struct text_pos start
, new_start
;
14666 int nrows_scrolled
, i
;
14667 struct glyph_row
*last_text_row
;
14668 struct glyph_row
*last_reused_text_row
;
14669 struct glyph_row
*start_row
;
14670 int start_vpos
, min_y
, max_y
;
14673 if (inhibit_try_window_reusing
)
14677 if (/* This function doesn't handle terminal frames. */
14678 !FRAME_WINDOW_P (f
)
14679 /* Don't try to reuse the display if windows have been split
14681 || windows_or_buffers_changed
14682 || cursor_type_changed
)
14685 /* Can't do this if region may have changed. */
14686 if ((!NILP (Vtransient_mark_mode
)
14687 && !NILP (BVAR (current_buffer
, mark_active
)))
14688 || !NILP (w
->region_showing
)
14689 || !NILP (Vshow_trailing_whitespace
))
14692 /* If top-line visibility has changed, give up. */
14693 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14694 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14697 /* Give up if old or new display is scrolled vertically. We could
14698 make this function handle this, but right now it doesn't. */
14699 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14700 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14703 /* The variable new_start now holds the new window start. The old
14704 start `start' can be determined from the current matrix. */
14705 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14706 start
= start_row
->minpos
;
14707 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14709 /* Clear the desired matrix for the display below. */
14710 clear_glyph_matrix (w
->desired_matrix
);
14712 if (CHARPOS (new_start
) <= CHARPOS (start
))
14714 /* Don't use this method if the display starts with an ellipsis
14715 displayed for invisible text. It's not easy to handle that case
14716 below, and it's certainly not worth the effort since this is
14717 not a frequent case. */
14718 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14721 IF_DEBUG (debug_method_add (w
, "twu1"));
14723 /* Display up to a row that can be reused. The variable
14724 last_text_row is set to the last row displayed that displays
14725 text. Note that it.vpos == 0 if or if not there is a
14726 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14727 start_display (&it
, w
, new_start
);
14728 w
->cursor
.vpos
= -1;
14729 last_text_row
= last_reused_text_row
= NULL
;
14731 while (it
.current_y
< it
.last_visible_y
14732 && !fonts_changed_p
)
14734 /* If we have reached into the characters in the START row,
14735 that means the line boundaries have changed. So we
14736 can't start copying with the row START. Maybe it will
14737 work to start copying with the following row. */
14738 while (IT_CHARPOS (it
) > CHARPOS (start
))
14740 /* Advance to the next row as the "start". */
14742 start
= start_row
->minpos
;
14743 /* If there are no more rows to try, or just one, give up. */
14744 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14745 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14746 || CHARPOS (start
) == ZV
)
14748 clear_glyph_matrix (w
->desired_matrix
);
14752 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14754 /* If we have reached alignment,
14755 we can copy the rest of the rows. */
14756 if (IT_CHARPOS (it
) == CHARPOS (start
))
14759 if (display_line (&it
))
14760 last_text_row
= it
.glyph_row
- 1;
14763 /* A value of current_y < last_visible_y means that we stopped
14764 at the previous window start, which in turn means that we
14765 have at least one reusable row. */
14766 if (it
.current_y
< it
.last_visible_y
)
14768 struct glyph_row
*row
;
14770 /* IT.vpos always starts from 0; it counts text lines. */
14771 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14773 /* Find PT if not already found in the lines displayed. */
14774 if (w
->cursor
.vpos
< 0)
14776 int dy
= it
.current_y
- start_row
->y
;
14778 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14779 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14781 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14782 dy
, nrows_scrolled
);
14785 clear_glyph_matrix (w
->desired_matrix
);
14790 /* Scroll the display. Do it before the current matrix is
14791 changed. The problem here is that update has not yet
14792 run, i.e. part of the current matrix is not up to date.
14793 scroll_run_hook will clear the cursor, and use the
14794 current matrix to get the height of the row the cursor is
14796 run
.current_y
= start_row
->y
;
14797 run
.desired_y
= it
.current_y
;
14798 run
.height
= it
.last_visible_y
- it
.current_y
;
14800 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14803 FRAME_RIF (f
)->update_window_begin_hook (w
);
14804 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14805 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14806 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14810 /* Shift current matrix down by nrows_scrolled lines. */
14811 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14812 rotate_matrix (w
->current_matrix
,
14814 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14817 /* Disable lines that must be updated. */
14818 for (i
= 0; i
< nrows_scrolled
; ++i
)
14819 (start_row
+ i
)->enabled_p
= 0;
14821 /* Re-compute Y positions. */
14822 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14823 max_y
= it
.last_visible_y
;
14824 for (row
= start_row
+ nrows_scrolled
;
14828 row
->y
= it
.current_y
;
14829 row
->visible_height
= row
->height
;
14831 if (row
->y
< min_y
)
14832 row
->visible_height
-= min_y
- row
->y
;
14833 if (row
->y
+ row
->height
> max_y
)
14834 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14835 row
->redraw_fringe_bitmaps_p
= 1;
14837 it
.current_y
+= row
->height
;
14839 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14840 last_reused_text_row
= row
;
14841 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14845 /* Disable lines in the current matrix which are now
14846 below the window. */
14847 for (++row
; row
< bottom_row
; ++row
)
14848 row
->enabled_p
= row
->mode_line_p
= 0;
14851 /* Update window_end_pos etc.; last_reused_text_row is the last
14852 reused row from the current matrix containing text, if any.
14853 The value of last_text_row is the last displayed line
14854 containing text. */
14855 if (last_reused_text_row
)
14857 w
->window_end_bytepos
14858 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14860 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14862 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14863 w
->current_matrix
));
14865 else if (last_text_row
)
14867 w
->window_end_bytepos
14868 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14870 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14872 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14876 /* This window must be completely empty. */
14877 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14878 w
->window_end_pos
= make_number (Z
- ZV
);
14879 w
->window_end_vpos
= make_number (0);
14881 w
->window_end_valid
= Qnil
;
14883 /* Update hint: don't try scrolling again in update_window. */
14884 w
->desired_matrix
->no_scrolling_p
= 1;
14887 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14891 else if (CHARPOS (new_start
) > CHARPOS (start
))
14893 struct glyph_row
*pt_row
, *row
;
14894 struct glyph_row
*first_reusable_row
;
14895 struct glyph_row
*first_row_to_display
;
14897 int yb
= window_text_bottom_y (w
);
14899 /* Find the row starting at new_start, if there is one. Don't
14900 reuse a partially visible line at the end. */
14901 first_reusable_row
= start_row
;
14902 while (first_reusable_row
->enabled_p
14903 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14904 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14905 < CHARPOS (new_start
)))
14906 ++first_reusable_row
;
14908 /* Give up if there is no row to reuse. */
14909 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14910 || !first_reusable_row
->enabled_p
14911 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14912 != CHARPOS (new_start
)))
14915 /* We can reuse fully visible rows beginning with
14916 first_reusable_row to the end of the window. Set
14917 first_row_to_display to the first row that cannot be reused.
14918 Set pt_row to the row containing point, if there is any. */
14920 for (first_row_to_display
= first_reusable_row
;
14921 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14922 ++first_row_to_display
)
14924 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14925 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14926 pt_row
= first_row_to_display
;
14929 /* Start displaying at the start of first_row_to_display. */
14930 xassert (first_row_to_display
->y
< yb
);
14931 init_to_row_start (&it
, w
, first_row_to_display
);
14933 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14935 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14937 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14938 + WINDOW_HEADER_LINE_HEIGHT (w
));
14940 /* Display lines beginning with first_row_to_display in the
14941 desired matrix. Set last_text_row to the last row displayed
14942 that displays text. */
14943 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14944 if (pt_row
== NULL
)
14945 w
->cursor
.vpos
= -1;
14946 last_text_row
= NULL
;
14947 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14948 if (display_line (&it
))
14949 last_text_row
= it
.glyph_row
- 1;
14951 /* If point is in a reused row, adjust y and vpos of the cursor
14955 w
->cursor
.vpos
-= nrows_scrolled
;
14956 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14959 /* Give up if point isn't in a row displayed or reused. (This
14960 also handles the case where w->cursor.vpos < nrows_scrolled
14961 after the calls to display_line, which can happen with scroll
14962 margins. See bug#1295.) */
14963 if (w
->cursor
.vpos
< 0)
14965 clear_glyph_matrix (w
->desired_matrix
);
14969 /* Scroll the display. */
14970 run
.current_y
= first_reusable_row
->y
;
14971 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14972 run
.height
= it
.last_visible_y
- run
.current_y
;
14973 dy
= run
.current_y
- run
.desired_y
;
14978 FRAME_RIF (f
)->update_window_begin_hook (w
);
14979 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14980 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14981 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14985 /* Adjust Y positions of reused rows. */
14986 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14987 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14988 max_y
= it
.last_visible_y
;
14989 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14992 row
->visible_height
= row
->height
;
14993 if (row
->y
< min_y
)
14994 row
->visible_height
-= min_y
- row
->y
;
14995 if (row
->y
+ row
->height
> max_y
)
14996 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14997 row
->redraw_fringe_bitmaps_p
= 1;
15000 /* Scroll the current matrix. */
15001 xassert (nrows_scrolled
> 0);
15002 rotate_matrix (w
->current_matrix
,
15004 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15007 /* Disable rows not reused. */
15008 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15009 row
->enabled_p
= 0;
15011 /* Point may have moved to a different line, so we cannot assume that
15012 the previous cursor position is valid; locate the correct row. */
15015 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15016 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15020 w
->cursor
.y
= row
->y
;
15022 if (row
< bottom_row
)
15024 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15025 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15027 /* Can't use this optimization with bidi-reordered glyph
15028 rows, unless cursor is already at point. */
15029 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15031 if (!(w
->cursor
.hpos
>= 0
15032 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15033 && BUFFERP (glyph
->object
)
15034 && glyph
->charpos
== PT
))
15039 && (!BUFFERP (glyph
->object
)
15040 || glyph
->charpos
< PT
);
15044 w
->cursor
.x
+= glyph
->pixel_width
;
15049 /* Adjust window end. A null value of last_text_row means that
15050 the window end is in reused rows which in turn means that
15051 only its vpos can have changed. */
15054 w
->window_end_bytepos
15055 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15057 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15059 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15064 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15067 w
->window_end_valid
= Qnil
;
15068 w
->desired_matrix
->no_scrolling_p
= 1;
15071 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15081 /************************************************************************
15082 Window redisplay reusing current matrix when buffer has changed
15083 ************************************************************************/
15085 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15086 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15087 EMACS_INT
*, EMACS_INT
*);
15088 static struct glyph_row
*
15089 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15090 struct glyph_row
*);
15093 /* Return the last row in MATRIX displaying text. If row START is
15094 non-null, start searching with that row. IT gives the dimensions
15095 of the display. Value is null if matrix is empty; otherwise it is
15096 a pointer to the row found. */
15098 static struct glyph_row
*
15099 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15100 struct glyph_row
*start
)
15102 struct glyph_row
*row
, *row_found
;
15104 /* Set row_found to the last row in IT->w's current matrix
15105 displaying text. The loop looks funny but think of partially
15108 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15109 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15111 xassert (row
->enabled_p
);
15113 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15122 /* Return the last row in the current matrix of W that is not affected
15123 by changes at the start of current_buffer that occurred since W's
15124 current matrix was built. Value is null if no such row exists.
15126 BEG_UNCHANGED us the number of characters unchanged at the start of
15127 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15128 first changed character in current_buffer. Characters at positions <
15129 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15130 when the current matrix was built. */
15132 static struct glyph_row
*
15133 find_last_unchanged_at_beg_row (struct window
*w
)
15135 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15136 struct glyph_row
*row
;
15137 struct glyph_row
*row_found
= NULL
;
15138 int yb
= window_text_bottom_y (w
);
15140 /* Find the last row displaying unchanged text. */
15141 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15142 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15143 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15146 if (/* If row ends before first_changed_pos, it is unchanged,
15147 except in some case. */
15148 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15149 /* When row ends in ZV and we write at ZV it is not
15151 && !row
->ends_at_zv_p
15152 /* When first_changed_pos is the end of a continued line,
15153 row is not unchanged because it may be no longer
15155 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15156 && (row
->continued_p
15157 || row
->exact_window_width_line_p
)))
15160 /* Stop if last visible row. */
15161 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15169 /* Find the first glyph row in the current matrix of W that is not
15170 affected by changes at the end of current_buffer since the
15171 time W's current matrix was built.
15173 Return in *DELTA the number of chars by which buffer positions in
15174 unchanged text at the end of current_buffer must be adjusted.
15176 Return in *DELTA_BYTES the corresponding number of bytes.
15178 Value is null if no such row exists, i.e. all rows are affected by
15181 static struct glyph_row
*
15182 find_first_unchanged_at_end_row (struct window
*w
,
15183 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15185 struct glyph_row
*row
;
15186 struct glyph_row
*row_found
= NULL
;
15188 *delta
= *delta_bytes
= 0;
15190 /* Display must not have been paused, otherwise the current matrix
15191 is not up to date. */
15192 eassert (!NILP (w
->window_end_valid
));
15194 /* A value of window_end_pos >= END_UNCHANGED means that the window
15195 end is in the range of changed text. If so, there is no
15196 unchanged row at the end of W's current matrix. */
15197 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15200 /* Set row to the last row in W's current matrix displaying text. */
15201 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15203 /* If matrix is entirely empty, no unchanged row exists. */
15204 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15206 /* The value of row is the last glyph row in the matrix having a
15207 meaningful buffer position in it. The end position of row
15208 corresponds to window_end_pos. This allows us to translate
15209 buffer positions in the current matrix to current buffer
15210 positions for characters not in changed text. */
15212 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15213 EMACS_INT Z_BYTE_old
=
15214 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15215 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15216 struct glyph_row
*first_text_row
15217 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15219 *delta
= Z
- Z_old
;
15220 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15222 /* Set last_unchanged_pos to the buffer position of the last
15223 character in the buffer that has not been changed. Z is the
15224 index + 1 of the last character in current_buffer, i.e. by
15225 subtracting END_UNCHANGED we get the index of the last
15226 unchanged character, and we have to add BEG to get its buffer
15228 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15229 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15231 /* Search backward from ROW for a row displaying a line that
15232 starts at a minimum position >= last_unchanged_pos_old. */
15233 for (; row
> first_text_row
; --row
)
15235 /* This used to abort, but it can happen.
15236 It is ok to just stop the search instead here. KFS. */
15237 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15240 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15245 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15251 /* Make sure that glyph rows in the current matrix of window W
15252 reference the same glyph memory as corresponding rows in the
15253 frame's frame matrix. This function is called after scrolling W's
15254 current matrix on a terminal frame in try_window_id and
15255 try_window_reusing_current_matrix. */
15258 sync_frame_with_window_matrix_rows (struct window
*w
)
15260 struct frame
*f
= XFRAME (w
->frame
);
15261 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15263 /* Preconditions: W must be a leaf window and full-width. Its frame
15264 must have a frame matrix. */
15265 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15266 xassert (WINDOW_FULL_WIDTH_P (w
));
15267 xassert (!FRAME_WINDOW_P (f
));
15269 /* If W is a full-width window, glyph pointers in W's current matrix
15270 have, by definition, to be the same as glyph pointers in the
15271 corresponding frame matrix. Note that frame matrices have no
15272 marginal areas (see build_frame_matrix). */
15273 window_row
= w
->current_matrix
->rows
;
15274 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15275 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15276 while (window_row
< window_row_end
)
15278 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15279 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15281 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15282 frame_row
->glyphs
[TEXT_AREA
] = start
;
15283 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15284 frame_row
->glyphs
[LAST_AREA
] = end
;
15286 /* Disable frame rows whose corresponding window rows have
15287 been disabled in try_window_id. */
15288 if (!window_row
->enabled_p
)
15289 frame_row
->enabled_p
= 0;
15291 ++window_row
, ++frame_row
;
15296 /* Find the glyph row in window W containing CHARPOS. Consider all
15297 rows between START and END (not inclusive). END null means search
15298 all rows to the end of the display area of W. Value is the row
15299 containing CHARPOS or null. */
15302 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15303 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15305 struct glyph_row
*row
= start
;
15306 struct glyph_row
*best_row
= NULL
;
15307 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15310 /* If we happen to start on a header-line, skip that. */
15311 if (row
->mode_line_p
)
15314 if ((end
&& row
>= end
) || !row
->enabled_p
)
15317 last_y
= window_text_bottom_y (w
) - dy
;
15321 /* Give up if we have gone too far. */
15322 if (end
&& row
>= end
)
15324 /* This formerly returned if they were equal.
15325 I think that both quantities are of a "last plus one" type;
15326 if so, when they are equal, the row is within the screen. -- rms. */
15327 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15330 /* If it is in this row, return this row. */
15331 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15332 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15333 /* The end position of a row equals the start
15334 position of the next row. If CHARPOS is there, we
15335 would rather display it in the next line, except
15336 when this line ends in ZV. */
15337 && !row
->ends_at_zv_p
15338 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15339 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15343 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15344 || (!best_row
&& !row
->continued_p
))
15346 /* In bidi-reordered rows, there could be several rows
15347 occluding point, all of them belonging to the same
15348 continued line. We need to find the row which fits
15349 CHARPOS the best. */
15350 for (g
= row
->glyphs
[TEXT_AREA
];
15351 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15354 if (!STRINGP (g
->object
))
15356 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15358 mindif
= eabs (g
->charpos
- charpos
);
15360 /* Exact match always wins. */
15367 else if (best_row
&& !row
->continued_p
)
15374 /* Try to redisplay window W by reusing its existing display. W's
15375 current matrix must be up to date when this function is called,
15376 i.e. window_end_valid must not be nil.
15380 1 if display has been updated
15381 0 if otherwise unsuccessful
15382 -1 if redisplay with same window start is known not to succeed
15384 The following steps are performed:
15386 1. Find the last row in the current matrix of W that is not
15387 affected by changes at the start of current_buffer. If no such row
15390 2. Find the first row in W's current matrix that is not affected by
15391 changes at the end of current_buffer. Maybe there is no such row.
15393 3. Display lines beginning with the row + 1 found in step 1 to the
15394 row found in step 2 or, if step 2 didn't find a row, to the end of
15397 4. If cursor is not known to appear on the window, give up.
15399 5. If display stopped at the row found in step 2, scroll the
15400 display and current matrix as needed.
15402 6. Maybe display some lines at the end of W, if we must. This can
15403 happen under various circumstances, like a partially visible line
15404 becoming fully visible, or because newly displayed lines are displayed
15405 in smaller font sizes.
15407 7. Update W's window end information. */
15410 try_window_id (struct window
*w
)
15412 struct frame
*f
= XFRAME (w
->frame
);
15413 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15414 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15415 struct glyph_row
*last_unchanged_at_beg_row
;
15416 struct glyph_row
*first_unchanged_at_end_row
;
15417 struct glyph_row
*row
;
15418 struct glyph_row
*bottom_row
;
15421 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15423 struct text_pos start_pos
;
15425 int first_unchanged_at_end_vpos
= 0;
15426 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15427 struct text_pos start
;
15428 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15431 if (inhibit_try_window_id
)
15435 /* This is handy for debugging. */
15437 #define GIVE_UP(X) \
15439 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15443 #define GIVE_UP(X) return 0
15446 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15448 /* Don't use this for mini-windows because these can show
15449 messages and mini-buffers, and we don't handle that here. */
15450 if (MINI_WINDOW_P (w
))
15453 /* This flag is used to prevent redisplay optimizations. */
15454 if (windows_or_buffers_changed
|| cursor_type_changed
)
15457 /* Verify that narrowing has not changed.
15458 Also verify that we were not told to prevent redisplay optimizations.
15459 It would be nice to further
15460 reduce the number of cases where this prevents try_window_id. */
15461 if (current_buffer
->clip_changed
15462 || current_buffer
->prevent_redisplay_optimizations_p
)
15465 /* Window must either use window-based redisplay or be full width. */
15466 if (!FRAME_WINDOW_P (f
)
15467 && (!FRAME_LINE_INS_DEL_OK (f
)
15468 || !WINDOW_FULL_WIDTH_P (w
)))
15471 /* Give up if point is known NOT to appear in W. */
15472 if (PT
< CHARPOS (start
))
15475 /* Another way to prevent redisplay optimizations. */
15476 if (XFASTINT (w
->last_modified
) == 0)
15479 /* Verify that window is not hscrolled. */
15480 if (XFASTINT (w
->hscroll
) != 0)
15483 /* Verify that display wasn't paused. */
15484 if (NILP (w
->window_end_valid
))
15487 /* Can't use this if highlighting a region because a cursor movement
15488 will do more than just set the cursor. */
15489 if (!NILP (Vtransient_mark_mode
)
15490 && !NILP (BVAR (current_buffer
, mark_active
)))
15493 /* Likewise if highlighting trailing whitespace. */
15494 if (!NILP (Vshow_trailing_whitespace
))
15497 /* Likewise if showing a region. */
15498 if (!NILP (w
->region_showing
))
15501 /* Can't use this if overlay arrow position and/or string have
15503 if (overlay_arrows_changed_p ())
15506 /* When word-wrap is on, adding a space to the first word of a
15507 wrapped line can change the wrap position, altering the line
15508 above it. It might be worthwhile to handle this more
15509 intelligently, but for now just redisplay from scratch. */
15510 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15513 /* Under bidi reordering, adding or deleting a character in the
15514 beginning of a paragraph, before the first strong directional
15515 character, can change the base direction of the paragraph (unless
15516 the buffer specifies a fixed paragraph direction), which will
15517 require to redisplay the whole paragraph. It might be worthwhile
15518 to find the paragraph limits and widen the range of redisplayed
15519 lines to that, but for now just give up this optimization and
15520 redisplay from scratch. */
15521 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15522 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15525 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15526 only if buffer has really changed. The reason is that the gap is
15527 initially at Z for freshly visited files. The code below would
15528 set end_unchanged to 0 in that case. */
15529 if (MODIFF
> SAVE_MODIFF
15530 /* This seems to happen sometimes after saving a buffer. */
15531 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15533 if (GPT
- BEG
< BEG_UNCHANGED
)
15534 BEG_UNCHANGED
= GPT
- BEG
;
15535 if (Z
- GPT
< END_UNCHANGED
)
15536 END_UNCHANGED
= Z
- GPT
;
15539 /* The position of the first and last character that has been changed. */
15540 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15541 last_changed_charpos
= Z
- END_UNCHANGED
;
15543 /* If window starts after a line end, and the last change is in
15544 front of that newline, then changes don't affect the display.
15545 This case happens with stealth-fontification. Note that although
15546 the display is unchanged, glyph positions in the matrix have to
15547 be adjusted, of course. */
15548 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15549 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15550 && ((last_changed_charpos
< CHARPOS (start
)
15551 && CHARPOS (start
) == BEGV
)
15552 || (last_changed_charpos
< CHARPOS (start
) - 1
15553 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15555 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15556 struct glyph_row
*r0
;
15558 /* Compute how many chars/bytes have been added to or removed
15559 from the buffer. */
15560 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15561 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15562 Z_delta
= Z
- Z_old
;
15563 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15565 /* Give up if PT is not in the window. Note that it already has
15566 been checked at the start of try_window_id that PT is not in
15567 front of the window start. */
15568 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15571 /* If window start is unchanged, we can reuse the whole matrix
15572 as is, after adjusting glyph positions. No need to compute
15573 the window end again, since its offset from Z hasn't changed. */
15574 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15575 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15576 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15577 /* PT must not be in a partially visible line. */
15578 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15579 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15581 /* Adjust positions in the glyph matrix. */
15582 if (Z_delta
|| Z_delta_bytes
)
15584 struct glyph_row
*r1
15585 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15586 increment_matrix_positions (w
->current_matrix
,
15587 MATRIX_ROW_VPOS (r0
, current_matrix
),
15588 MATRIX_ROW_VPOS (r1
, current_matrix
),
15589 Z_delta
, Z_delta_bytes
);
15592 /* Set the cursor. */
15593 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15595 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15602 /* Handle the case that changes are all below what is displayed in
15603 the window, and that PT is in the window. This shortcut cannot
15604 be taken if ZV is visible in the window, and text has been added
15605 there that is visible in the window. */
15606 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15607 /* ZV is not visible in the window, or there are no
15608 changes at ZV, actually. */
15609 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15610 || first_changed_charpos
== last_changed_charpos
))
15612 struct glyph_row
*r0
;
15614 /* Give up if PT is not in the window. Note that it already has
15615 been checked at the start of try_window_id that PT is not in
15616 front of the window start. */
15617 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15620 /* If window start is unchanged, we can reuse the whole matrix
15621 as is, without changing glyph positions since no text has
15622 been added/removed in front of the window end. */
15623 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15624 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15625 /* PT must not be in a partially visible line. */
15626 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15627 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15629 /* We have to compute the window end anew since text
15630 could have been added/removed after it. */
15632 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15633 w
->window_end_bytepos
15634 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15636 /* Set the cursor. */
15637 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15639 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15646 /* Give up if window start is in the changed area.
15648 The condition used to read
15650 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15652 but why that was tested escapes me at the moment. */
15653 if (CHARPOS (start
) >= first_changed_charpos
15654 && CHARPOS (start
) <= last_changed_charpos
)
15657 /* Check that window start agrees with the start of the first glyph
15658 row in its current matrix. Check this after we know the window
15659 start is not in changed text, otherwise positions would not be
15661 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15662 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15665 /* Give up if the window ends in strings. Overlay strings
15666 at the end are difficult to handle, so don't try. */
15667 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15668 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15671 /* Compute the position at which we have to start displaying new
15672 lines. Some of the lines at the top of the window might be
15673 reusable because they are not displaying changed text. Find the
15674 last row in W's current matrix not affected by changes at the
15675 start of current_buffer. Value is null if changes start in the
15676 first line of window. */
15677 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15678 if (last_unchanged_at_beg_row
)
15680 /* Avoid starting to display in the moddle of a character, a TAB
15681 for instance. This is easier than to set up the iterator
15682 exactly, and it's not a frequent case, so the additional
15683 effort wouldn't really pay off. */
15684 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15685 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15686 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15687 --last_unchanged_at_beg_row
;
15689 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15692 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15694 start_pos
= it
.current
.pos
;
15696 /* Start displaying new lines in the desired matrix at the same
15697 vpos we would use in the current matrix, i.e. below
15698 last_unchanged_at_beg_row. */
15699 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15701 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15702 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15704 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15708 /* There are no reusable lines at the start of the window.
15709 Start displaying in the first text line. */
15710 start_display (&it
, w
, start
);
15711 it
.vpos
= it
.first_vpos
;
15712 start_pos
= it
.current
.pos
;
15715 /* Find the first row that is not affected by changes at the end of
15716 the buffer. Value will be null if there is no unchanged row, in
15717 which case we must redisplay to the end of the window. delta
15718 will be set to the value by which buffer positions beginning with
15719 first_unchanged_at_end_row have to be adjusted due to text
15721 first_unchanged_at_end_row
15722 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15723 IF_DEBUG (debug_delta
= delta
);
15724 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15726 /* Set stop_pos to the buffer position up to which we will have to
15727 display new lines. If first_unchanged_at_end_row != NULL, this
15728 is the buffer position of the start of the line displayed in that
15729 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15730 that we don't stop at a buffer position. */
15732 if (first_unchanged_at_end_row
)
15734 xassert (last_unchanged_at_beg_row
== NULL
15735 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15737 /* If this is a continuation line, move forward to the next one
15738 that isn't. Changes in lines above affect this line.
15739 Caution: this may move first_unchanged_at_end_row to a row
15740 not displaying text. */
15741 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15742 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15743 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15744 < it
.last_visible_y
))
15745 ++first_unchanged_at_end_row
;
15747 if (!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
= NULL
;
15753 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15755 first_unchanged_at_end_vpos
15756 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15757 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15760 else if (last_unchanged_at_beg_row
== NULL
)
15766 /* Either there is no unchanged row at the end, or the one we have
15767 now displays text. This is a necessary condition for the window
15768 end pos calculation at the end of this function. */
15769 xassert (first_unchanged_at_end_row
== NULL
15770 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15772 debug_last_unchanged_at_beg_vpos
15773 = (last_unchanged_at_beg_row
15774 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15776 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15778 #endif /* GLYPH_DEBUG != 0 */
15781 /* Display new lines. Set last_text_row to the last new line
15782 displayed which has text on it, i.e. might end up as being the
15783 line where the window_end_vpos is. */
15784 w
->cursor
.vpos
= -1;
15785 last_text_row
= NULL
;
15786 overlay_arrow_seen
= 0;
15787 while (it
.current_y
< it
.last_visible_y
15788 && !fonts_changed_p
15789 && (first_unchanged_at_end_row
== NULL
15790 || IT_CHARPOS (it
) < stop_pos
))
15792 if (display_line (&it
))
15793 last_text_row
= it
.glyph_row
- 1;
15796 if (fonts_changed_p
)
15800 /* Compute differences in buffer positions, y-positions etc. for
15801 lines reused at the bottom of the window. Compute what we can
15803 if (first_unchanged_at_end_row
15804 /* No lines reused because we displayed everything up to the
15805 bottom of the window. */
15806 && it
.current_y
< it
.last_visible_y
)
15809 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15811 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15812 run
.current_y
= first_unchanged_at_end_row
->y
;
15813 run
.desired_y
= run
.current_y
+ dy
;
15814 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15818 delta
= delta_bytes
= dvpos
= dy
15819 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15820 first_unchanged_at_end_row
= NULL
;
15822 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15825 /* Find the cursor if not already found. We have to decide whether
15826 PT will appear on this window (it sometimes doesn't, but this is
15827 not a very frequent case.) This decision has to be made before
15828 the current matrix is altered. A value of cursor.vpos < 0 means
15829 that PT is either in one of the lines beginning at
15830 first_unchanged_at_end_row or below the window. Don't care for
15831 lines that might be displayed later at the window end; as
15832 mentioned, this is not a frequent case. */
15833 if (w
->cursor
.vpos
< 0)
15835 /* Cursor in unchanged rows at the top? */
15836 if (PT
< CHARPOS (start_pos
)
15837 && last_unchanged_at_beg_row
)
15839 row
= row_containing_pos (w
, PT
,
15840 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15841 last_unchanged_at_beg_row
+ 1, 0);
15843 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15846 /* Start from first_unchanged_at_end_row looking for PT. */
15847 else if (first_unchanged_at_end_row
)
15849 row
= row_containing_pos (w
, PT
- delta
,
15850 first_unchanged_at_end_row
, NULL
, 0);
15852 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15853 delta_bytes
, dy
, dvpos
);
15856 /* Give up if cursor was not found. */
15857 if (w
->cursor
.vpos
< 0)
15859 clear_glyph_matrix (w
->desired_matrix
);
15864 /* Don't let the cursor end in the scroll margins. */
15866 int this_scroll_margin
, cursor_height
;
15868 this_scroll_margin
= max (0, scroll_margin
);
15869 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15870 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15871 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15873 if ((w
->cursor
.y
< this_scroll_margin
15874 && CHARPOS (start
) > BEGV
)
15875 /* Old redisplay didn't take scroll margin into account at the bottom,
15876 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15877 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15878 ? cursor_height
+ this_scroll_margin
15879 : 1)) > it
.last_visible_y
)
15881 w
->cursor
.vpos
= -1;
15882 clear_glyph_matrix (w
->desired_matrix
);
15887 /* Scroll the display. Do it before changing the current matrix so
15888 that xterm.c doesn't get confused about where the cursor glyph is
15890 if (dy
&& run
.height
)
15894 if (FRAME_WINDOW_P (f
))
15896 FRAME_RIF (f
)->update_window_begin_hook (w
);
15897 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15898 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15899 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15903 /* Terminal frame. In this case, dvpos gives the number of
15904 lines to scroll by; dvpos < 0 means scroll up. */
15906 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15907 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15908 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15909 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15910 + window_internal_height (w
));
15912 #if defined (HAVE_GPM) || defined (MSDOS)
15913 x_clear_window_mouse_face (w
);
15915 /* Perform the operation on the screen. */
15918 /* Scroll last_unchanged_at_beg_row to the end of the
15919 window down dvpos lines. */
15920 set_terminal_window (f
, end
);
15922 /* On dumb terminals delete dvpos lines at the end
15923 before inserting dvpos empty lines. */
15924 if (!FRAME_SCROLL_REGION_OK (f
))
15925 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15927 /* Insert dvpos empty lines in front of
15928 last_unchanged_at_beg_row. */
15929 ins_del_lines (f
, from
, dvpos
);
15931 else if (dvpos
< 0)
15933 /* Scroll up last_unchanged_at_beg_vpos to the end of
15934 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15935 set_terminal_window (f
, end
);
15937 /* Delete dvpos lines in front of
15938 last_unchanged_at_beg_vpos. ins_del_lines will set
15939 the cursor to the given vpos and emit |dvpos| delete
15941 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15943 /* On a dumb terminal insert dvpos empty lines at the
15945 if (!FRAME_SCROLL_REGION_OK (f
))
15946 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15949 set_terminal_window (f
, 0);
15955 /* Shift reused rows of the current matrix to the right position.
15956 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15958 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15959 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15962 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15963 bottom_vpos
, dvpos
);
15964 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15967 else if (dvpos
> 0)
15969 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15970 bottom_vpos
, dvpos
);
15971 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15972 first_unchanged_at_end_vpos
+ dvpos
, 0);
15975 /* For frame-based redisplay, make sure that current frame and window
15976 matrix are in sync with respect to glyph memory. */
15977 if (!FRAME_WINDOW_P (f
))
15978 sync_frame_with_window_matrix_rows (w
);
15980 /* Adjust buffer positions in reused rows. */
15981 if (delta
|| delta_bytes
)
15982 increment_matrix_positions (current_matrix
,
15983 first_unchanged_at_end_vpos
+ dvpos
,
15984 bottom_vpos
, delta
, delta_bytes
);
15986 /* Adjust Y positions. */
15988 shift_glyph_matrix (w
, current_matrix
,
15989 first_unchanged_at_end_vpos
+ dvpos
,
15992 if (first_unchanged_at_end_row
)
15994 first_unchanged_at_end_row
+= dvpos
;
15995 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15996 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15997 first_unchanged_at_end_row
= NULL
;
16000 /* If scrolling up, there may be some lines to display at the end of
16002 last_text_row_at_end
= NULL
;
16005 /* Scrolling up can leave for example a partially visible line
16006 at the end of the window to be redisplayed. */
16007 /* Set last_row to the glyph row in the current matrix where the
16008 window end line is found. It has been moved up or down in
16009 the matrix by dvpos. */
16010 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16011 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16013 /* If last_row is the window end line, it should display text. */
16014 xassert (last_row
->displays_text_p
);
16016 /* If window end line was partially visible before, begin
16017 displaying at that line. Otherwise begin displaying with the
16018 line following it. */
16019 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16021 init_to_row_start (&it
, w
, last_row
);
16022 it
.vpos
= last_vpos
;
16023 it
.current_y
= last_row
->y
;
16027 init_to_row_end (&it
, w
, last_row
);
16028 it
.vpos
= 1 + last_vpos
;
16029 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16033 /* We may start in a continuation line. If so, we have to
16034 get the right continuation_lines_width and current_x. */
16035 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16036 it
.hpos
= it
.current_x
= 0;
16038 /* Display the rest of the lines at the window end. */
16039 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16040 while (it
.current_y
< it
.last_visible_y
16041 && !fonts_changed_p
)
16043 /* Is it always sure that the display agrees with lines in
16044 the current matrix? I don't think so, so we mark rows
16045 displayed invalid in the current matrix by setting their
16046 enabled_p flag to zero. */
16047 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16048 if (display_line (&it
))
16049 last_text_row_at_end
= it
.glyph_row
- 1;
16053 /* Update window_end_pos and window_end_vpos. */
16054 if (first_unchanged_at_end_row
16055 && !last_text_row_at_end
)
16057 /* Window end line if one of the preserved rows from the current
16058 matrix. Set row to the last row displaying text in current
16059 matrix starting at first_unchanged_at_end_row, after
16061 xassert (first_unchanged_at_end_row
->displays_text_p
);
16062 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16063 first_unchanged_at_end_row
);
16064 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16066 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16067 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16069 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16070 xassert (w
->window_end_bytepos
>= 0);
16071 IF_DEBUG (debug_method_add (w
, "A"));
16073 else if (last_text_row_at_end
)
16076 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16077 w
->window_end_bytepos
16078 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16080 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16081 xassert (w
->window_end_bytepos
>= 0);
16082 IF_DEBUG (debug_method_add (w
, "B"));
16084 else if (last_text_row
)
16086 /* We have displayed either to the end of the window or at the
16087 end of the window, i.e. the last row with text is to be found
16088 in the desired matrix. */
16090 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16091 w
->window_end_bytepos
16092 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16094 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16095 xassert (w
->window_end_bytepos
>= 0);
16097 else if (first_unchanged_at_end_row
== NULL
16098 && last_text_row
== NULL
16099 && last_text_row_at_end
== NULL
)
16101 /* Displayed to end of window, but no line containing text was
16102 displayed. Lines were deleted at the end of the window. */
16103 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16104 int vpos
= XFASTINT (w
->window_end_vpos
);
16105 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16106 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16109 row
== NULL
&& vpos
>= first_vpos
;
16110 --vpos
, --current_row
, --desired_row
)
16112 if (desired_row
->enabled_p
)
16114 if (desired_row
->displays_text_p
)
16117 else if (current_row
->displays_text_p
)
16121 xassert (row
!= NULL
);
16122 w
->window_end_vpos
= make_number (vpos
+ 1);
16123 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16124 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16125 xassert (w
->window_end_bytepos
>= 0);
16126 IF_DEBUG (debug_method_add (w
, "C"));
16131 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16132 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16134 /* Record that display has not been completed. */
16135 w
->window_end_valid
= Qnil
;
16136 w
->desired_matrix
->no_scrolling_p
= 1;
16144 /***********************************************************************
16145 More debugging support
16146 ***********************************************************************/
16150 void dump_glyph_row (struct glyph_row
*, int, int);
16151 void dump_glyph_matrix (struct glyph_matrix
*, int);
16152 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16155 /* Dump the contents of glyph matrix MATRIX on stderr.
16157 GLYPHS 0 means don't show glyph contents.
16158 GLYPHS 1 means show glyphs in short form
16159 GLYPHS > 1 means show glyphs in long form. */
16162 dump_glyph_matrix (matrix
, glyphs
)
16163 struct glyph_matrix
*matrix
;
16167 for (i
= 0; i
< matrix
->nrows
; ++i
)
16168 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16172 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16173 the glyph row and area where the glyph comes from. */
16176 dump_glyph (row
, glyph
, area
)
16177 struct glyph_row
*row
;
16178 struct glyph
*glyph
;
16181 if (glyph
->type
== CHAR_GLYPH
)
16184 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16185 glyph
- row
->glyphs
[TEXT_AREA
],
16188 (BUFFERP (glyph
->object
)
16190 : (STRINGP (glyph
->object
)
16193 glyph
->pixel_width
,
16195 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16199 glyph
->left_box_line_p
,
16200 glyph
->right_box_line_p
);
16202 else if (glyph
->type
== STRETCH_GLYPH
)
16205 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16206 glyph
- row
->glyphs
[TEXT_AREA
],
16209 (BUFFERP (glyph
->object
)
16211 : (STRINGP (glyph
->object
)
16214 glyph
->pixel_width
,
16218 glyph
->left_box_line_p
,
16219 glyph
->right_box_line_p
);
16221 else if (glyph
->type
== IMAGE_GLYPH
)
16224 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16225 glyph
- row
->glyphs
[TEXT_AREA
],
16228 (BUFFERP (glyph
->object
)
16230 : (STRINGP (glyph
->object
)
16233 glyph
->pixel_width
,
16237 glyph
->left_box_line_p
,
16238 glyph
->right_box_line_p
);
16240 else if (glyph
->type
== COMPOSITE_GLYPH
)
16243 " %5d %4c %6d %c %3d 0x%05x",
16244 glyph
- row
->glyphs
[TEXT_AREA
],
16247 (BUFFERP (glyph
->object
)
16249 : (STRINGP (glyph
->object
)
16252 glyph
->pixel_width
,
16254 if (glyph
->u
.cmp
.automatic
)
16257 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16258 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16260 glyph
->left_box_line_p
,
16261 glyph
->right_box_line_p
);
16266 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16267 GLYPHS 0 means don't show glyph contents.
16268 GLYPHS 1 means show glyphs in short form
16269 GLYPHS > 1 means show glyphs in long form. */
16272 dump_glyph_row (row
, vpos
, glyphs
)
16273 struct glyph_row
*row
;
16278 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16279 fprintf (stderr
, "======================================================================\n");
16281 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16282 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16284 MATRIX_ROW_START_CHARPOS (row
),
16285 MATRIX_ROW_END_CHARPOS (row
),
16286 row
->used
[TEXT_AREA
],
16287 row
->contains_overlapping_glyphs_p
,
16289 row
->truncated_on_left_p
,
16290 row
->truncated_on_right_p
,
16292 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16293 row
->displays_text_p
,
16296 row
->ends_in_middle_of_char_p
,
16297 row
->starts_in_middle_of_char_p
,
16303 row
->visible_height
,
16306 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16307 row
->end
.overlay_string_index
,
16308 row
->continuation_lines_width
);
16309 fprintf (stderr
, "%9d %5d\n",
16310 CHARPOS (row
->start
.string_pos
),
16311 CHARPOS (row
->end
.string_pos
));
16312 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16313 row
->end
.dpvec_index
);
16320 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16322 struct glyph
*glyph
= row
->glyphs
[area
];
16323 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16325 /* Glyph for a line end in text. */
16326 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16329 if (glyph
< glyph_end
)
16330 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16332 for (; glyph
< glyph_end
; ++glyph
)
16333 dump_glyph (row
, glyph
, area
);
16336 else if (glyphs
== 1)
16340 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16342 char *s
= (char *) alloca (row
->used
[area
] + 1);
16345 for (i
= 0; i
< row
->used
[area
]; ++i
)
16347 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16348 if (glyph
->type
== CHAR_GLYPH
16349 && glyph
->u
.ch
< 0x80
16350 && glyph
->u
.ch
>= ' ')
16351 s
[i
] = glyph
->u
.ch
;
16357 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16363 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16364 Sdump_glyph_matrix
, 0, 1, "p",
16365 doc
: /* Dump the current matrix of the selected window to stderr.
16366 Shows contents of glyph row structures. With non-nil
16367 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16368 glyphs in short form, otherwise show glyphs in long form. */)
16369 (Lisp_Object glyphs
)
16371 struct window
*w
= XWINDOW (selected_window
);
16372 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16374 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16375 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16376 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16377 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16378 fprintf (stderr
, "=============================================\n");
16379 dump_glyph_matrix (w
->current_matrix
,
16380 NILP (glyphs
) ? 0 : XINT (glyphs
));
16385 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16386 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16389 struct frame
*f
= XFRAME (selected_frame
);
16390 dump_glyph_matrix (f
->current_matrix
, 1);
16395 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16396 doc
: /* Dump glyph row ROW to stderr.
16397 GLYPH 0 means don't dump glyphs.
16398 GLYPH 1 means dump glyphs in short form.
16399 GLYPH > 1 or omitted means dump glyphs in long form. */)
16400 (Lisp_Object row
, Lisp_Object glyphs
)
16402 struct glyph_matrix
*matrix
;
16405 CHECK_NUMBER (row
);
16406 matrix
= XWINDOW (selected_window
)->current_matrix
;
16408 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16409 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16411 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16416 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16417 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16418 GLYPH 0 means don't dump glyphs.
16419 GLYPH 1 means dump glyphs in short form.
16420 GLYPH > 1 or omitted means dump glyphs in long form. */)
16421 (Lisp_Object row
, Lisp_Object glyphs
)
16423 struct frame
*sf
= SELECTED_FRAME ();
16424 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16427 CHECK_NUMBER (row
);
16429 if (vpos
>= 0 && vpos
< m
->nrows
)
16430 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16431 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16436 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16437 doc
: /* Toggle tracing of redisplay.
16438 With ARG, turn tracing on if and only if ARG is positive. */)
16442 trace_redisplay_p
= !trace_redisplay_p
;
16445 arg
= Fprefix_numeric_value (arg
);
16446 trace_redisplay_p
= XINT (arg
) > 0;
16453 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16454 doc
: /* Like `format', but print result to stderr.
16455 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16456 (size_t nargs
, Lisp_Object
*args
)
16458 Lisp_Object s
= Fformat (nargs
, args
);
16459 fprintf (stderr
, "%s", SDATA (s
));
16463 #endif /* GLYPH_DEBUG */
16467 /***********************************************************************
16468 Building Desired Matrix Rows
16469 ***********************************************************************/
16471 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16472 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16474 static struct glyph_row
*
16475 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16477 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16478 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16479 struct buffer
*old
= current_buffer
;
16480 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16481 int arrow_len
= SCHARS (overlay_arrow_string
);
16482 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16483 const unsigned char *p
;
16486 int n_glyphs_before
;
16488 set_buffer_temp (buffer
);
16489 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16490 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16491 SET_TEXT_POS (it
.position
, 0, 0);
16493 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16495 while (p
< arrow_end
)
16497 Lisp_Object face
, ilisp
;
16499 /* Get the next character. */
16501 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16504 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16505 if (! ASCII_CHAR_P (it
.c
))
16506 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16510 /* Get its face. */
16511 ilisp
= make_number (p
- arrow_string
);
16512 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16513 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16515 /* Compute its width, get its glyphs. */
16516 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16517 SET_TEXT_POS (it
.position
, -1, -1);
16518 PRODUCE_GLYPHS (&it
);
16520 /* If this character doesn't fit any more in the line, we have
16521 to remove some glyphs. */
16522 if (it
.current_x
> it
.last_visible_x
)
16524 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16529 set_buffer_temp (old
);
16530 return it
.glyph_row
;
16534 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16535 glyphs are only inserted for terminal frames since we can't really
16536 win with truncation glyphs when partially visible glyphs are
16537 involved. Which glyphs to insert is determined by
16538 produce_special_glyphs. */
16541 insert_left_trunc_glyphs (struct it
*it
)
16543 struct it truncate_it
;
16544 struct glyph
*from
, *end
, *to
, *toend
;
16546 xassert (!FRAME_WINDOW_P (it
->f
));
16548 /* Get the truncation glyphs. */
16550 truncate_it
.current_x
= 0;
16551 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16552 truncate_it
.glyph_row
= &scratch_glyph_row
;
16553 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16554 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16555 truncate_it
.object
= make_number (0);
16556 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16558 /* Overwrite glyphs from IT with truncation glyphs. */
16559 if (!it
->glyph_row
->reversed_p
)
16561 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16562 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16563 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16564 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16569 /* There may be padding glyphs left over. Overwrite them too. */
16570 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16572 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16578 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16582 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16583 that back to front. */
16584 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16585 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16586 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16587 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16589 while (from
>= end
&& to
>= toend
)
16591 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16594 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16595 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16596 while (from
>= end
&& to
>= toend
)
16601 /* Need to free some room before prepending additional
16603 int move_by
= from
- end
+ 1;
16604 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16605 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16607 for ( ; g
>= g0
; g
--)
16609 while (from
>= end
)
16611 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16617 /* Compute the pixel height and width of IT->glyph_row.
16619 Most of the time, ascent and height of a display line will be equal
16620 to the max_ascent and max_height values of the display iterator
16621 structure. This is not the case if
16623 1. We hit ZV without displaying anything. In this case, max_ascent
16624 and max_height will be zero.
16626 2. We have some glyphs that don't contribute to the line height.
16627 (The glyph row flag contributes_to_line_height_p is for future
16628 pixmap extensions).
16630 The first case is easily covered by using default values because in
16631 these cases, the line height does not really matter, except that it
16632 must not be zero. */
16635 compute_line_metrics (struct it
*it
)
16637 struct glyph_row
*row
= it
->glyph_row
;
16639 if (FRAME_WINDOW_P (it
->f
))
16641 int i
, min_y
, max_y
;
16643 /* The line may consist of one space only, that was added to
16644 place the cursor on it. If so, the row's height hasn't been
16646 if (row
->height
== 0)
16648 if (it
->max_ascent
+ it
->max_descent
== 0)
16649 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16650 row
->ascent
= it
->max_ascent
;
16651 row
->height
= it
->max_ascent
+ it
->max_descent
;
16652 row
->phys_ascent
= it
->max_phys_ascent
;
16653 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16654 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16657 /* Compute the width of this line. */
16658 row
->pixel_width
= row
->x
;
16659 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16660 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16662 xassert (row
->pixel_width
>= 0);
16663 xassert (row
->ascent
>= 0 && row
->height
> 0);
16665 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16666 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16668 /* If first line's physical ascent is larger than its logical
16669 ascent, use the physical ascent, and make the row taller.
16670 This makes accented characters fully visible. */
16671 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16672 && row
->phys_ascent
> row
->ascent
)
16674 row
->height
+= row
->phys_ascent
- row
->ascent
;
16675 row
->ascent
= row
->phys_ascent
;
16678 /* Compute how much of the line is visible. */
16679 row
->visible_height
= row
->height
;
16681 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16682 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16684 if (row
->y
< min_y
)
16685 row
->visible_height
-= min_y
- row
->y
;
16686 if (row
->y
+ row
->height
> max_y
)
16687 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16691 row
->pixel_width
= row
->used
[TEXT_AREA
];
16692 if (row
->continued_p
)
16693 row
->pixel_width
-= it
->continuation_pixel_width
;
16694 else if (row
->truncated_on_right_p
)
16695 row
->pixel_width
-= it
->truncation_pixel_width
;
16696 row
->ascent
= row
->phys_ascent
= 0;
16697 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16698 row
->extra_line_spacing
= 0;
16701 /* Compute a hash code for this row. */
16705 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16706 for (i
= 0; i
< row
->used
[area
]; ++i
)
16707 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16708 + row
->glyphs
[area
][i
].u
.val
16709 + row
->glyphs
[area
][i
].face_id
16710 + row
->glyphs
[area
][i
].padding_p
16711 + (row
->glyphs
[area
][i
].type
<< 2));
16714 it
->max_ascent
= it
->max_descent
= 0;
16715 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16719 /* Append one space to the glyph row of iterator IT if doing a
16720 window-based redisplay. The space has the same face as
16721 IT->face_id. Value is non-zero if a space was added.
16723 This function is called to make sure that there is always one glyph
16724 at the end of a glyph row that the cursor can be set on under
16725 window-systems. (If there weren't such a glyph we would not know
16726 how wide and tall a box cursor should be displayed).
16728 At the same time this space let's a nicely handle clearing to the
16729 end of the line if the row ends in italic text. */
16732 append_space_for_newline (struct it
*it
, int default_face_p
)
16734 if (FRAME_WINDOW_P (it
->f
))
16736 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16738 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16739 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16741 /* Save some values that must not be changed.
16742 Must save IT->c and IT->len because otherwise
16743 ITERATOR_AT_END_P wouldn't work anymore after
16744 append_space_for_newline has been called. */
16745 enum display_element_type saved_what
= it
->what
;
16746 int saved_c
= it
->c
, saved_len
= it
->len
;
16747 int saved_char_to_display
= it
->char_to_display
;
16748 int saved_x
= it
->current_x
;
16749 int saved_face_id
= it
->face_id
;
16750 struct text_pos saved_pos
;
16751 Lisp_Object saved_object
;
16754 saved_object
= it
->object
;
16755 saved_pos
= it
->position
;
16757 it
->what
= IT_CHARACTER
;
16758 memset (&it
->position
, 0, sizeof it
->position
);
16759 it
->object
= make_number (0);
16760 it
->c
= it
->char_to_display
= ' ';
16763 if (default_face_p
)
16764 it
->face_id
= DEFAULT_FACE_ID
;
16765 else if (it
->face_before_selective_p
)
16766 it
->face_id
= it
->saved_face_id
;
16767 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16768 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16770 PRODUCE_GLYPHS (it
);
16772 it
->override_ascent
= -1;
16773 it
->constrain_row_ascent_descent_p
= 0;
16774 it
->current_x
= saved_x
;
16775 it
->object
= saved_object
;
16776 it
->position
= saved_pos
;
16777 it
->what
= saved_what
;
16778 it
->face_id
= saved_face_id
;
16779 it
->len
= saved_len
;
16781 it
->char_to_display
= saved_char_to_display
;
16790 /* Extend the face of the last glyph in the text area of IT->glyph_row
16791 to the end of the display line. Called from display_line. If the
16792 glyph row is empty, add a space glyph to it so that we know the
16793 face to draw. Set the glyph row flag fill_line_p. If the glyph
16794 row is R2L, prepend a stretch glyph to cover the empty space to the
16795 left of the leftmost glyph. */
16798 extend_face_to_end_of_line (struct it
*it
)
16801 struct frame
*f
= it
->f
;
16803 /* If line is already filled, do nothing. Non window-system frames
16804 get a grace of one more ``pixel'' because their characters are
16805 1-``pixel'' wide, so they hit the equality too early. This grace
16806 is needed only for R2L rows that are not continued, to produce
16807 one extra blank where we could display the cursor. */
16808 if (it
->current_x
>= it
->last_visible_x
16809 + (!FRAME_WINDOW_P (f
)
16810 && it
->glyph_row
->reversed_p
16811 && !it
->glyph_row
->continued_p
))
16814 /* Face extension extends the background and box of IT->face_id
16815 to the end of the line. If the background equals the background
16816 of the frame, we don't have to do anything. */
16817 if (it
->face_before_selective_p
)
16818 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16820 face
= FACE_FROM_ID (f
, it
->face_id
);
16822 if (FRAME_WINDOW_P (f
)
16823 && it
->glyph_row
->displays_text_p
16824 && face
->box
== FACE_NO_BOX
16825 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16827 && !it
->glyph_row
->reversed_p
)
16830 /* Set the glyph row flag indicating that the face of the last glyph
16831 in the text area has to be drawn to the end of the text area. */
16832 it
->glyph_row
->fill_line_p
= 1;
16834 /* If current character of IT is not ASCII, make sure we have the
16835 ASCII face. This will be automatically undone the next time
16836 get_next_display_element returns a multibyte character. Note
16837 that the character will always be single byte in unibyte
16839 if (!ASCII_CHAR_P (it
->c
))
16841 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16844 if (FRAME_WINDOW_P (f
))
16846 /* If the row is empty, add a space with the current face of IT,
16847 so that we know which face to draw. */
16848 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16850 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16851 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16852 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16854 #ifdef HAVE_WINDOW_SYSTEM
16855 if (it
->glyph_row
->reversed_p
)
16857 /* Prepend a stretch glyph to the row, such that the
16858 rightmost glyph will be drawn flushed all the way to the
16859 right margin of the window. The stretch glyph that will
16860 occupy the empty space, if any, to the left of the
16862 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16863 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16864 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16866 int row_width
, stretch_ascent
, stretch_width
;
16867 struct text_pos saved_pos
;
16868 int saved_face_id
, saved_avoid_cursor
;
16870 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16871 row_width
+= g
->pixel_width
;
16872 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16873 if (stretch_width
> 0)
16876 (((it
->ascent
+ it
->descent
)
16877 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16878 saved_pos
= it
->position
;
16879 memset (&it
->position
, 0, sizeof it
->position
);
16880 saved_avoid_cursor
= it
->avoid_cursor_p
;
16881 it
->avoid_cursor_p
= 1;
16882 saved_face_id
= it
->face_id
;
16883 /* The last row's stretch glyph should get the default
16884 face, to avoid painting the rest of the window with
16885 the region face, if the region ends at ZV. */
16886 if (it
->glyph_row
->ends_at_zv_p
)
16887 it
->face_id
= DEFAULT_FACE_ID
;
16889 it
->face_id
= face
->id
;
16890 append_stretch_glyph (it
, make_number (0), stretch_width
,
16891 it
->ascent
+ it
->descent
, stretch_ascent
);
16892 it
->position
= saved_pos
;
16893 it
->avoid_cursor_p
= saved_avoid_cursor
;
16894 it
->face_id
= saved_face_id
;
16897 #endif /* HAVE_WINDOW_SYSTEM */
16901 /* Save some values that must not be changed. */
16902 int saved_x
= it
->current_x
;
16903 struct text_pos saved_pos
;
16904 Lisp_Object saved_object
;
16905 enum display_element_type saved_what
= it
->what
;
16906 int saved_face_id
= it
->face_id
;
16908 saved_object
= it
->object
;
16909 saved_pos
= it
->position
;
16911 it
->what
= IT_CHARACTER
;
16912 memset (&it
->position
, 0, sizeof it
->position
);
16913 it
->object
= make_number (0);
16914 it
->c
= it
->char_to_display
= ' ';
16916 /* The last row's blank glyphs should get the default face, to
16917 avoid painting the rest of the window with the region face,
16918 if the region ends at ZV. */
16919 if (it
->glyph_row
->ends_at_zv_p
)
16920 it
->face_id
= DEFAULT_FACE_ID
;
16922 it
->face_id
= face
->id
;
16924 PRODUCE_GLYPHS (it
);
16926 while (it
->current_x
<= it
->last_visible_x
)
16927 PRODUCE_GLYPHS (it
);
16929 /* Don't count these blanks really. It would let us insert a left
16930 truncation glyph below and make us set the cursor on them, maybe. */
16931 it
->current_x
= saved_x
;
16932 it
->object
= saved_object
;
16933 it
->position
= saved_pos
;
16934 it
->what
= saved_what
;
16935 it
->face_id
= saved_face_id
;
16940 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16941 trailing whitespace. */
16944 trailing_whitespace_p (EMACS_INT charpos
)
16946 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16949 while (bytepos
< ZV_BYTE
16950 && (c
= FETCH_CHAR (bytepos
),
16951 c
== ' ' || c
== '\t'))
16954 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16956 if (bytepos
!= PT_BYTE
)
16963 /* Highlight trailing whitespace, if any, in ROW. */
16966 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16968 int used
= row
->used
[TEXT_AREA
];
16972 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16973 struct glyph
*glyph
= start
+ used
- 1;
16975 if (row
->reversed_p
)
16977 /* Right-to-left rows need to be processed in the opposite
16978 direction, so swap the edge pointers. */
16980 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16983 /* Skip over glyphs inserted to display the cursor at the
16984 end of a line, for extending the face of the last glyph
16985 to the end of the line on terminals, and for truncation
16986 and continuation glyphs. */
16987 if (!row
->reversed_p
)
16989 while (glyph
>= start
16990 && glyph
->type
== CHAR_GLYPH
16991 && INTEGERP (glyph
->object
))
16996 while (glyph
<= start
16997 && glyph
->type
== CHAR_GLYPH
16998 && INTEGERP (glyph
->object
))
17002 /* If last glyph is a space or stretch, and it's trailing
17003 whitespace, set the face of all trailing whitespace glyphs in
17004 IT->glyph_row to `trailing-whitespace'. */
17005 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17006 && BUFFERP (glyph
->object
)
17007 && (glyph
->type
== STRETCH_GLYPH
17008 || (glyph
->type
== CHAR_GLYPH
17009 && glyph
->u
.ch
== ' '))
17010 && trailing_whitespace_p (glyph
->charpos
))
17012 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17016 if (!row
->reversed_p
)
17018 while (glyph
>= start
17019 && BUFFERP (glyph
->object
)
17020 && (glyph
->type
== STRETCH_GLYPH
17021 || (glyph
->type
== CHAR_GLYPH
17022 && glyph
->u
.ch
== ' ')))
17023 (glyph
--)->face_id
= face_id
;
17027 while (glyph
<= start
17028 && BUFFERP (glyph
->object
)
17029 && (glyph
->type
== STRETCH_GLYPH
17030 || (glyph
->type
== CHAR_GLYPH
17031 && glyph
->u
.ch
== ' ')))
17032 (glyph
++)->face_id
= face_id
;
17039 /* Value is non-zero if glyph row ROW should be
17040 used to hold the cursor. */
17043 cursor_row_p (struct glyph_row
*row
)
17047 if (PT
== CHARPOS (row
->end
.pos
))
17049 /* Suppose the row ends on a string.
17050 Unless the row is continued, that means it ends on a newline
17051 in the string. If it's anything other than a display string
17052 (e.g. a before-string from an overlay), we don't want the
17053 cursor there. (This heuristic seems to give the optimal
17054 behavior for the various types of multi-line strings.) */
17055 if (CHARPOS (row
->end
.string_pos
) >= 0)
17057 if (row
->continued_p
)
17061 /* Check for `display' property. */
17062 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17063 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17064 struct glyph
*glyph
;
17067 for (glyph
= end
; glyph
>= beg
; --glyph
)
17068 if (STRINGP (glyph
->object
))
17071 = Fget_char_property (make_number (PT
),
17075 && display_prop_string_p (prop
, glyph
->object
));
17080 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17082 /* If the row ends in middle of a real character,
17083 and the line is continued, we want the cursor here.
17084 That's because CHARPOS (ROW->end.pos) would equal
17085 PT if PT is before the character. */
17086 if (!row
->ends_in_ellipsis_p
)
17087 result
= row
->continued_p
;
17089 /* If the row ends in an ellipsis, then
17090 CHARPOS (ROW->end.pos) will equal point after the
17091 invisible text. We want that position to be displayed
17092 after the ellipsis. */
17095 /* If the row ends at ZV, display the cursor at the end of that
17096 row instead of at the start of the row below. */
17097 else if (row
->ends_at_zv_p
)
17108 /* Push the display property PROP so that it will be rendered at the
17109 current position in IT. Return 1 if PROP was successfully pushed,
17113 push_display_prop (struct it
*it
, Lisp_Object prop
)
17117 if (STRINGP (prop
))
17119 if (SCHARS (prop
) == 0)
17126 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17127 it
->current
.overlay_string_index
= -1;
17128 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17129 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17130 it
->method
= GET_FROM_STRING
;
17131 it
->stop_charpos
= 0;
17133 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17135 it
->method
= GET_FROM_STRETCH
;
17138 #ifdef HAVE_WINDOW_SYSTEM
17139 else if (IMAGEP (prop
))
17141 it
->what
= IT_IMAGE
;
17142 it
->image_id
= lookup_image (it
->f
, prop
);
17143 it
->method
= GET_FROM_IMAGE
;
17145 #endif /* HAVE_WINDOW_SYSTEM */
17148 pop_it (it
); /* bogus display property, give up */
17155 /* Return the character-property PROP at the current position in IT. */
17158 get_it_property (struct it
*it
, Lisp_Object prop
)
17160 Lisp_Object position
;
17162 if (STRINGP (it
->object
))
17163 position
= make_number (IT_STRING_CHARPOS (*it
));
17164 else if (BUFFERP (it
->object
))
17165 position
= make_number (IT_CHARPOS (*it
));
17169 return Fget_char_property (position
, prop
, it
->object
);
17172 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17175 handle_line_prefix (struct it
*it
)
17177 Lisp_Object prefix
;
17178 if (it
->continuation_lines_width
> 0)
17180 prefix
= get_it_property (it
, Qwrap_prefix
);
17182 prefix
= Vwrap_prefix
;
17186 prefix
= get_it_property (it
, Qline_prefix
);
17188 prefix
= Vline_prefix
;
17190 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17192 /* If the prefix is wider than the window, and we try to wrap
17193 it, it would acquire its own wrap prefix, and so on till the
17194 iterator stack overflows. So, don't wrap the prefix. */
17195 it
->line_wrap
= TRUNCATE
;
17196 it
->avoid_cursor_p
= 1;
17202 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17203 only for R2L lines from display_line, when it decides that too many
17204 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17207 unproduce_glyphs (struct it
*it
, int n
)
17209 struct glyph
*glyph
, *end
;
17211 xassert (it
->glyph_row
);
17212 xassert (it
->glyph_row
->reversed_p
);
17213 xassert (it
->area
== TEXT_AREA
);
17214 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17216 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17217 n
= it
->glyph_row
->used
[TEXT_AREA
];
17218 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17219 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17220 for ( ; glyph
< end
; glyph
++)
17221 glyph
[-n
] = *glyph
;
17224 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17225 and ROW->maxpos. */
17227 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17228 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17229 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17231 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17232 lines' rows is implemented for bidi-reordered rows. */
17234 /* ROW->minpos is the value of min_pos, the minimal buffer position
17237 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17239 /* We didn't find _any_ valid buffer positions in any of the
17240 glyphs, so we must trust the iterator's computed positions. */
17241 row
->minpos
= row
->start
.pos
;
17244 max_pos
= CHARPOS (it
->current
.pos
);
17245 max_bpos
= BYTEPOS (it
->current
.pos
);
17248 /* Here are the various use-cases for ending the row, and the
17249 corresponding values for ROW->maxpos:
17251 Line ends in a newline from buffer eol_pos + 1
17252 Line is continued from buffer max_pos + 1
17253 Line is truncated on right it->current.pos
17254 Line ends in a newline from string max_pos
17255 Line is continued from string max_pos
17256 Line is continued from display vector max_pos
17257 Line is entirely from a string min_pos == max_pos
17258 Line is entirely from a display vector min_pos == max_pos
17259 Line that ends at ZV ZV
17261 If you discover other use-cases, please add them here as
17263 if (row
->ends_at_zv_p
)
17264 row
->maxpos
= it
->current
.pos
;
17265 else if (row
->used
[TEXT_AREA
])
17267 if (row
->ends_in_newline_from_string_p
)
17268 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17269 else if (CHARPOS (it
->eol_pos
) > 0)
17270 SET_TEXT_POS (row
->maxpos
,
17271 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17272 else if (row
->continued_p
)
17274 /* If max_pos is different from IT's current position, it
17275 means IT->method does not belong to the display element
17276 at max_pos. However, it also means that the display
17277 element at max_pos was displayed in its entirety on this
17278 line, which is equivalent to saying that the next line
17279 starts at the next buffer position. */
17280 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17281 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17284 INC_BOTH (max_pos
, max_bpos
);
17285 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17288 else if (row
->truncated_on_right_p
)
17289 /* display_line already called reseat_at_next_visible_line_start,
17290 which puts the iterator at the beginning of the next line, in
17291 the logical order. */
17292 row
->maxpos
= it
->current
.pos
;
17293 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17294 /* A line that is entirely from a string/image/stretch... */
17295 row
->maxpos
= row
->minpos
;
17300 row
->maxpos
= it
->current
.pos
;
17303 /* Construct the glyph row IT->glyph_row in the desired matrix of
17304 IT->w from text at the current position of IT. See dispextern.h
17305 for an overview of struct it. Value is non-zero if
17306 IT->glyph_row displays text, as opposed to a line displaying ZV
17310 display_line (struct it
*it
)
17312 struct glyph_row
*row
= it
->glyph_row
;
17313 Lisp_Object overlay_arrow_string
;
17315 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17316 int wrap_row_used
= -1;
17317 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17318 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17319 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17320 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17321 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17323 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17324 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17326 /* We always start displaying at hpos zero even if hscrolled. */
17327 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17329 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17330 >= it
->w
->desired_matrix
->nrows
)
17332 it
->w
->nrows_scale_factor
++;
17333 fonts_changed_p
= 1;
17337 /* Is IT->w showing the region? */
17338 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17340 /* Clear the result glyph row and enable it. */
17341 prepare_desired_row (row
);
17343 row
->y
= it
->current_y
;
17344 row
->start
= it
->start
;
17345 row
->continuation_lines_width
= it
->continuation_lines_width
;
17346 row
->displays_text_p
= 1;
17347 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17348 it
->starts_in_middle_of_char_p
= 0;
17350 /* Arrange the overlays nicely for our purposes. Usually, we call
17351 display_line on only one line at a time, in which case this
17352 can't really hurt too much, or we call it on lines which appear
17353 one after another in the buffer, in which case all calls to
17354 recenter_overlay_lists but the first will be pretty cheap. */
17355 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17357 /* Move over display elements that are not visible because we are
17358 hscrolled. This may stop at an x-position < IT->first_visible_x
17359 if the first glyph is partially visible or if we hit a line end. */
17360 if (it
->current_x
< it
->first_visible_x
)
17362 this_line_min_pos
= row
->start
.pos
;
17363 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17364 MOVE_TO_POS
| MOVE_TO_X
);
17365 /* Record the smallest positions seen while we moved over
17366 display elements that are not visible. This is needed by
17367 redisplay_internal for optimizing the case where the cursor
17368 stays inside the same line. The rest of this function only
17369 considers positions that are actually displayed, so
17370 RECORD_MAX_MIN_POS will not otherwise record positions that
17371 are hscrolled to the left of the left edge of the window. */
17372 min_pos
= CHARPOS (this_line_min_pos
);
17373 min_bpos
= BYTEPOS (this_line_min_pos
);
17377 /* We only do this when not calling `move_it_in_display_line_to'
17378 above, because move_it_in_display_line_to calls
17379 handle_line_prefix itself. */
17380 handle_line_prefix (it
);
17383 /* Get the initial row height. This is either the height of the
17384 text hscrolled, if there is any, or zero. */
17385 row
->ascent
= it
->max_ascent
;
17386 row
->height
= it
->max_ascent
+ it
->max_descent
;
17387 row
->phys_ascent
= it
->max_phys_ascent
;
17388 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17389 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17391 /* Utility macro to record max and min buffer positions seen until now. */
17392 #define RECORD_MAX_MIN_POS(IT) \
17395 if (IT_CHARPOS (*(IT)) < min_pos) \
17397 min_pos = IT_CHARPOS (*(IT)); \
17398 min_bpos = IT_BYTEPOS (*(IT)); \
17400 if (IT_CHARPOS (*(IT)) > max_pos) \
17402 max_pos = IT_CHARPOS (*(IT)); \
17403 max_bpos = IT_BYTEPOS (*(IT)); \
17408 /* Loop generating characters. The loop is left with IT on the next
17409 character to display. */
17412 int n_glyphs_before
, hpos_before
, x_before
;
17414 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17416 /* Retrieve the next thing to display. Value is zero if end of
17418 if (!get_next_display_element (it
))
17420 /* Maybe add a space at the end of this line that is used to
17421 display the cursor there under X. Set the charpos of the
17422 first glyph of blank lines not corresponding to any text
17424 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17425 row
->exact_window_width_line_p
= 1;
17426 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17427 || row
->used
[TEXT_AREA
] == 0)
17429 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17430 row
->displays_text_p
= 0;
17432 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17433 && (!MINI_WINDOW_P (it
->w
)
17434 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17435 row
->indicate_empty_line_p
= 1;
17438 it
->continuation_lines_width
= 0;
17439 row
->ends_at_zv_p
= 1;
17440 /* A row that displays right-to-left text must always have
17441 its last face extended all the way to the end of line,
17442 even if this row ends in ZV, because we still write to
17443 the screen left to right. */
17444 if (row
->reversed_p
)
17445 extend_face_to_end_of_line (it
);
17449 /* Now, get the metrics of what we want to display. This also
17450 generates glyphs in `row' (which is IT->glyph_row). */
17451 n_glyphs_before
= row
->used
[TEXT_AREA
];
17454 /* Remember the line height so far in case the next element doesn't
17455 fit on the line. */
17456 if (it
->line_wrap
!= TRUNCATE
)
17458 ascent
= it
->max_ascent
;
17459 descent
= it
->max_descent
;
17460 phys_ascent
= it
->max_phys_ascent
;
17461 phys_descent
= it
->max_phys_descent
;
17463 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17465 if (IT_DISPLAYING_WHITESPACE (it
))
17471 wrap_row_used
= row
->used
[TEXT_AREA
];
17472 wrap_row_ascent
= row
->ascent
;
17473 wrap_row_height
= row
->height
;
17474 wrap_row_phys_ascent
= row
->phys_ascent
;
17475 wrap_row_phys_height
= row
->phys_height
;
17476 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17477 wrap_row_min_pos
= min_pos
;
17478 wrap_row_min_bpos
= min_bpos
;
17479 wrap_row_max_pos
= max_pos
;
17480 wrap_row_max_bpos
= max_bpos
;
17486 PRODUCE_GLYPHS (it
);
17488 /* If this display element was in marginal areas, continue with
17490 if (it
->area
!= TEXT_AREA
)
17492 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17493 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17494 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17495 row
->phys_height
= max (row
->phys_height
,
17496 it
->max_phys_ascent
+ it
->max_phys_descent
);
17497 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17498 it
->max_extra_line_spacing
);
17499 set_iterator_to_next (it
, 1);
17503 /* Does the display element fit on the line? If we truncate
17504 lines, we should draw past the right edge of the window. If
17505 we don't truncate, we want to stop so that we can display the
17506 continuation glyph before the right margin. If lines are
17507 continued, there are two possible strategies for characters
17508 resulting in more than 1 glyph (e.g. tabs): Display as many
17509 glyphs as possible in this line and leave the rest for the
17510 continuation line, or display the whole element in the next
17511 line. Original redisplay did the former, so we do it also. */
17512 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17513 hpos_before
= it
->hpos
;
17516 if (/* Not a newline. */
17518 /* Glyphs produced fit entirely in the line. */
17519 && it
->current_x
< it
->last_visible_x
)
17521 it
->hpos
+= nglyphs
;
17522 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17523 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17524 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17525 row
->phys_height
= max (row
->phys_height
,
17526 it
->max_phys_ascent
+ it
->max_phys_descent
);
17527 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17528 it
->max_extra_line_spacing
);
17529 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17530 row
->x
= x
- it
->first_visible_x
;
17531 /* Record the maximum and minimum buffer positions seen so
17532 far in glyphs that will be displayed by this row. */
17534 RECORD_MAX_MIN_POS (it
);
17539 struct glyph
*glyph
;
17541 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17543 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17544 new_x
= x
+ glyph
->pixel_width
;
17546 if (/* Lines are continued. */
17547 it
->line_wrap
!= TRUNCATE
17548 && (/* Glyph doesn't fit on the line. */
17549 new_x
> it
->last_visible_x
17550 /* Or it fits exactly on a window system frame. */
17551 || (new_x
== it
->last_visible_x
17552 && FRAME_WINDOW_P (it
->f
))))
17554 /* End of a continued line. */
17557 || (new_x
== it
->last_visible_x
17558 && FRAME_WINDOW_P (it
->f
)))
17560 /* Current glyph is the only one on the line or
17561 fits exactly on the line. We must continue
17562 the line because we can't draw the cursor
17563 after the glyph. */
17564 row
->continued_p
= 1;
17565 it
->current_x
= new_x
;
17566 it
->continuation_lines_width
+= new_x
;
17568 /* Record the maximum and minimum buffer
17569 positions seen so far in glyphs that will be
17570 displayed by this row. */
17572 RECORD_MAX_MIN_POS (it
);
17573 if (i
== nglyphs
- 1)
17575 /* If line-wrap is on, check if a previous
17576 wrap point was found. */
17577 if (wrap_row_used
> 0
17578 /* Even if there is a previous wrap
17579 point, continue the line here as
17580 usual, if (i) the previous character
17581 was a space or tab AND (ii) the
17582 current character is not. */
17584 || IT_DISPLAYING_WHITESPACE (it
)))
17587 set_iterator_to_next (it
, 1);
17588 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17590 if (!get_next_display_element (it
))
17592 row
->exact_window_width_line_p
= 1;
17593 it
->continuation_lines_width
= 0;
17594 row
->continued_p
= 0;
17595 row
->ends_at_zv_p
= 1;
17597 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17599 row
->continued_p
= 0;
17600 row
->exact_window_width_line_p
= 1;
17605 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17606 && !FRAME_WINDOW_P (it
->f
))
17608 /* A padding glyph that doesn't fit on this line.
17609 This means the whole character doesn't fit
17611 if (row
->reversed_p
)
17612 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17613 - n_glyphs_before
);
17614 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17616 /* Fill the rest of the row with continuation
17617 glyphs like in 20.x. */
17618 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17619 < row
->glyphs
[1 + TEXT_AREA
])
17620 produce_special_glyphs (it
, IT_CONTINUATION
);
17622 row
->continued_p
= 1;
17623 it
->current_x
= x_before
;
17624 it
->continuation_lines_width
+= x_before
;
17626 /* Restore the height to what it was before the
17627 element not fitting on the line. */
17628 it
->max_ascent
= ascent
;
17629 it
->max_descent
= descent
;
17630 it
->max_phys_ascent
= phys_ascent
;
17631 it
->max_phys_descent
= phys_descent
;
17633 else if (wrap_row_used
> 0)
17636 if (row
->reversed_p
)
17637 unproduce_glyphs (it
,
17638 row
->used
[TEXT_AREA
] - wrap_row_used
);
17640 it
->continuation_lines_width
+= wrap_x
;
17641 row
->used
[TEXT_AREA
] = wrap_row_used
;
17642 row
->ascent
= wrap_row_ascent
;
17643 row
->height
= wrap_row_height
;
17644 row
->phys_ascent
= wrap_row_phys_ascent
;
17645 row
->phys_height
= wrap_row_phys_height
;
17646 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17647 min_pos
= wrap_row_min_pos
;
17648 min_bpos
= wrap_row_min_bpos
;
17649 max_pos
= wrap_row_max_pos
;
17650 max_bpos
= wrap_row_max_bpos
;
17651 row
->continued_p
= 1;
17652 row
->ends_at_zv_p
= 0;
17653 row
->exact_window_width_line_p
= 0;
17654 it
->continuation_lines_width
+= x
;
17656 /* Make sure that a non-default face is extended
17657 up to the right margin of the window. */
17658 extend_face_to_end_of_line (it
);
17660 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17662 /* A TAB that extends past the right edge of the
17663 window. This produces a single glyph on
17664 window system frames. We leave the glyph in
17665 this row and let it fill the row, but don't
17666 consume the TAB. */
17667 it
->continuation_lines_width
+= it
->last_visible_x
;
17668 row
->ends_in_middle_of_char_p
= 1;
17669 row
->continued_p
= 1;
17670 glyph
->pixel_width
= it
->last_visible_x
- x
;
17671 it
->starts_in_middle_of_char_p
= 1;
17675 /* Something other than a TAB that draws past
17676 the right edge of the window. Restore
17677 positions to values before the element. */
17678 if (row
->reversed_p
)
17679 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17680 - (n_glyphs_before
+ i
));
17681 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17683 /* Display continuation glyphs. */
17684 if (!FRAME_WINDOW_P (it
->f
))
17685 produce_special_glyphs (it
, IT_CONTINUATION
);
17686 row
->continued_p
= 1;
17688 it
->current_x
= x_before
;
17689 it
->continuation_lines_width
+= x
;
17690 extend_face_to_end_of_line (it
);
17692 if (nglyphs
> 1 && i
> 0)
17694 row
->ends_in_middle_of_char_p
= 1;
17695 it
->starts_in_middle_of_char_p
= 1;
17698 /* Restore the height to what it was before the
17699 element not fitting on the line. */
17700 it
->max_ascent
= ascent
;
17701 it
->max_descent
= descent
;
17702 it
->max_phys_ascent
= phys_ascent
;
17703 it
->max_phys_descent
= phys_descent
;
17708 else if (new_x
> it
->first_visible_x
)
17710 /* Increment number of glyphs actually displayed. */
17713 /* Record the maximum and minimum buffer positions
17714 seen so far in glyphs that will be displayed by
17717 RECORD_MAX_MIN_POS (it
);
17719 if (x
< it
->first_visible_x
)
17720 /* Glyph is partially visible, i.e. row starts at
17721 negative X position. */
17722 row
->x
= x
- it
->first_visible_x
;
17726 /* Glyph is completely off the left margin of the
17727 window. This should not happen because of the
17728 move_it_in_display_line at the start of this
17729 function, unless the text display area of the
17730 window is empty. */
17731 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17735 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17736 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17737 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17738 row
->phys_height
= max (row
->phys_height
,
17739 it
->max_phys_ascent
+ it
->max_phys_descent
);
17740 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17741 it
->max_extra_line_spacing
);
17743 /* End of this display line if row is continued. */
17744 if (row
->continued_p
|| row
->ends_at_zv_p
)
17749 /* Is this a line end? If yes, we're also done, after making
17750 sure that a non-default face is extended up to the right
17751 margin of the window. */
17752 if (ITERATOR_AT_END_OF_LINE_P (it
))
17754 int used_before
= row
->used
[TEXT_AREA
];
17756 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17758 /* Add a space at the end of the line that is used to
17759 display the cursor there. */
17760 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17761 append_space_for_newline (it
, 0);
17763 /* Extend the face to the end of the line. */
17764 extend_face_to_end_of_line (it
);
17766 /* Make sure we have the position. */
17767 if (used_before
== 0)
17768 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17770 /* Record the position of the newline, for use in
17772 it
->eol_pos
= it
->current
.pos
;
17774 /* Consume the line end. This skips over invisible lines. */
17775 set_iterator_to_next (it
, 1);
17776 it
->continuation_lines_width
= 0;
17780 /* Proceed with next display element. Note that this skips
17781 over lines invisible because of selective display. */
17782 set_iterator_to_next (it
, 1);
17784 /* If we truncate lines, we are done when the last displayed
17785 glyphs reach past the right margin of the window. */
17786 if (it
->line_wrap
== TRUNCATE
17787 && (FRAME_WINDOW_P (it
->f
)
17788 ? (it
->current_x
>= it
->last_visible_x
)
17789 : (it
->current_x
> it
->last_visible_x
)))
17791 /* Maybe add truncation glyphs. */
17792 if (!FRAME_WINDOW_P (it
->f
))
17796 if (!row
->reversed_p
)
17798 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17799 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17804 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17805 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17807 /* Remove any padding glyphs at the front of ROW, to
17808 make room for the truncation glyphs we will be
17809 adding below. The loop below always inserts at
17810 least one truncation glyph, so also remove the
17811 last glyph added to ROW. */
17812 unproduce_glyphs (it
, i
+ 1);
17813 /* Adjust i for the loop below. */
17814 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17817 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17819 row
->used
[TEXT_AREA
] = i
;
17820 produce_special_glyphs (it
, IT_TRUNCATION
);
17823 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17825 /* Don't truncate if we can overflow newline into fringe. */
17826 if (!get_next_display_element (it
))
17828 it
->continuation_lines_width
= 0;
17829 row
->ends_at_zv_p
= 1;
17830 row
->exact_window_width_line_p
= 1;
17833 if (ITERATOR_AT_END_OF_LINE_P (it
))
17835 row
->exact_window_width_line_p
= 1;
17836 goto at_end_of_line
;
17840 row
->truncated_on_right_p
= 1;
17841 it
->continuation_lines_width
= 0;
17842 reseat_at_next_visible_line_start (it
, 0);
17843 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17844 it
->hpos
= hpos_before
;
17845 it
->current_x
= x_before
;
17850 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17851 at the left window margin. */
17852 if (it
->first_visible_x
17853 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17855 if (!FRAME_WINDOW_P (it
->f
))
17856 insert_left_trunc_glyphs (it
);
17857 row
->truncated_on_left_p
= 1;
17860 /* Remember the position at which this line ends.
17862 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17863 cannot be before the call to find_row_edges below, since that is
17864 where these positions are determined. */
17865 row
->end
= it
->current
;
17868 row
->minpos
= row
->start
.pos
;
17869 row
->maxpos
= row
->end
.pos
;
17873 /* ROW->minpos and ROW->maxpos must be the smallest and
17874 `1 + the largest' buffer positions in ROW. But if ROW was
17875 bidi-reordered, these two positions can be anywhere in the
17876 row, so we must determine them now. */
17877 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17880 /* If the start of this line is the overlay arrow-position, then
17881 mark this glyph row as the one containing the overlay arrow.
17882 This is clearly a mess with variable size fonts. It would be
17883 better to let it be displayed like cursors under X. */
17884 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17885 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17886 !NILP (overlay_arrow_string
)))
17888 /* Overlay arrow in window redisplay is a fringe bitmap. */
17889 if (STRINGP (overlay_arrow_string
))
17891 struct glyph_row
*arrow_row
17892 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17893 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17894 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17895 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17896 struct glyph
*p2
, *end
;
17898 /* Copy the arrow glyphs. */
17899 while (glyph
< arrow_end
)
17902 /* Throw away padding glyphs. */
17904 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17905 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17911 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17916 xassert (INTEGERP (overlay_arrow_string
));
17917 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17919 overlay_arrow_seen
= 1;
17922 /* Compute pixel dimensions of this line. */
17923 compute_line_metrics (it
);
17925 /* Record whether this row ends inside an ellipsis. */
17926 row
->ends_in_ellipsis_p
17927 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17928 && it
->ellipsis_p
);
17930 /* Save fringe bitmaps in this row. */
17931 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17932 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17933 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17934 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17936 it
->left_user_fringe_bitmap
= 0;
17937 it
->left_user_fringe_face_id
= 0;
17938 it
->right_user_fringe_bitmap
= 0;
17939 it
->right_user_fringe_face_id
= 0;
17941 /* Maybe set the cursor. */
17942 cvpos
= it
->w
->cursor
.vpos
;
17944 /* In bidi-reordered rows, keep checking for proper cursor
17945 position even if one has been found already, because buffer
17946 positions in such rows change non-linearly with ROW->VPOS,
17947 when a line is continued. One exception: when we are at ZV,
17948 display cursor on the first suitable glyph row, since all
17949 the empty rows after that also have their position set to ZV. */
17950 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17951 lines' rows is implemented for bidi-reordered rows. */
17953 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17954 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17955 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17956 && cursor_row_p (row
))
17957 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17959 /* Highlight trailing whitespace. */
17960 if (!NILP (Vshow_trailing_whitespace
))
17961 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17963 /* Prepare for the next line. This line starts horizontally at (X
17964 HPOS) = (0 0). Vertical positions are incremented. As a
17965 convenience for the caller, IT->glyph_row is set to the next
17967 it
->current_x
= it
->hpos
= 0;
17968 it
->current_y
+= row
->height
;
17969 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17972 /* The next row should by default use the same value of the
17973 reversed_p flag as this one. set_iterator_to_next decides when
17974 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17975 the flag accordingly. */
17976 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17977 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17978 it
->start
= row
->end
;
17979 return row
->displays_text_p
;
17981 #undef RECORD_MAX_MIN_POS
17984 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17985 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17986 doc
: /* Return paragraph direction at point in BUFFER.
17987 Value is either `left-to-right' or `right-to-left'.
17988 If BUFFER is omitted or nil, it defaults to the current buffer.
17990 Paragraph direction determines how the text in the paragraph is displayed.
17991 In left-to-right paragraphs, text begins at the left margin of the window
17992 and the reading direction is generally left to right. In right-to-left
17993 paragraphs, text begins at the right margin and is read from right to left.
17995 See also `bidi-paragraph-direction'. */)
17996 (Lisp_Object buffer
)
17998 struct buffer
*buf
= current_buffer
;
17999 struct buffer
*old
= buf
;
18001 if (! NILP (buffer
))
18003 CHECK_BUFFER (buffer
);
18004 buf
= XBUFFER (buffer
);
18007 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18008 return Qleft_to_right
;
18009 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18010 return BVAR (buf
, bidi_paragraph_direction
);
18013 /* Determine the direction from buffer text. We could try to
18014 use current_matrix if it is up to date, but this seems fast
18015 enough as it is. */
18016 struct bidi_it itb
;
18017 EMACS_INT pos
= BUF_PT (buf
);
18018 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18021 set_buffer_temp (buf
);
18022 /* bidi_paragraph_init finds the base direction of the paragraph
18023 by searching forward from paragraph start. We need the base
18024 direction of the current or _previous_ paragraph, so we need
18025 to make sure we are within that paragraph. To that end, find
18026 the previous non-empty line. */
18027 if (pos
>= ZV
&& pos
> BEGV
)
18030 bytepos
= CHAR_TO_BYTE (pos
);
18032 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18033 || c
== ' ' || c
== '\t' || c
== '\f')
18035 if (bytepos
<= BEGV_BYTE
)
18040 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18043 itb
.bytepos
= bytepos
;
18045 itb
.separator_limit
= -1;
18046 itb
.paragraph_dir
= NEUTRAL_DIR
;
18048 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18049 set_buffer_temp (old
);
18050 switch (itb
.paragraph_dir
)
18053 return Qleft_to_right
;
18056 return Qright_to_left
;
18066 /***********************************************************************
18068 ***********************************************************************/
18070 /* Redisplay the menu bar in the frame for window W.
18072 The menu bar of X frames that don't have X toolkit support is
18073 displayed in a special window W->frame->menu_bar_window.
18075 The menu bar of terminal frames is treated specially as far as
18076 glyph matrices are concerned. Menu bar lines are not part of
18077 windows, so the update is done directly on the frame matrix rows
18078 for the menu bar. */
18081 display_menu_bar (struct window
*w
)
18083 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18088 /* Don't do all this for graphical frames. */
18090 if (FRAME_W32_P (f
))
18093 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18099 if (FRAME_NS_P (f
))
18101 #endif /* HAVE_NS */
18103 #ifdef USE_X_TOOLKIT
18104 xassert (!FRAME_WINDOW_P (f
));
18105 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18106 it
.first_visible_x
= 0;
18107 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18108 #else /* not USE_X_TOOLKIT */
18109 if (FRAME_WINDOW_P (f
))
18111 /* Menu bar lines are displayed in the desired matrix of the
18112 dummy window menu_bar_window. */
18113 struct window
*menu_w
;
18114 xassert (WINDOWP (f
->menu_bar_window
));
18115 menu_w
= XWINDOW (f
->menu_bar_window
);
18116 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18118 it
.first_visible_x
= 0;
18119 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18123 /* This is a TTY frame, i.e. character hpos/vpos are used as
18125 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18127 it
.first_visible_x
= 0;
18128 it
.last_visible_x
= FRAME_COLS (f
);
18130 #endif /* not USE_X_TOOLKIT */
18132 if (! mode_line_inverse_video
)
18133 /* Force the menu-bar to be displayed in the default face. */
18134 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18136 /* Clear all rows of the menu bar. */
18137 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18139 struct glyph_row
*row
= it
.glyph_row
+ i
;
18140 clear_glyph_row (row
);
18141 row
->enabled_p
= 1;
18142 row
->full_width_p
= 1;
18145 /* Display all items of the menu bar. */
18146 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18147 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18149 Lisp_Object string
;
18151 /* Stop at nil string. */
18152 string
= AREF (items
, i
+ 1);
18156 /* Remember where item was displayed. */
18157 ASET (items
, i
+ 3, make_number (it
.hpos
));
18159 /* Display the item, pad with one space. */
18160 if (it
.current_x
< it
.last_visible_x
)
18161 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18162 SCHARS (string
) + 1, 0, 0, -1);
18165 /* Fill out the line with spaces. */
18166 if (it
.current_x
< it
.last_visible_x
)
18167 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18169 /* Compute the total height of the lines. */
18170 compute_line_metrics (&it
);
18175 /***********************************************************************
18177 ***********************************************************************/
18179 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18180 FORCE is non-zero, redisplay mode lines unconditionally.
18181 Otherwise, redisplay only mode lines that are garbaged. Value is
18182 the number of windows whose mode lines were redisplayed. */
18185 redisplay_mode_lines (Lisp_Object window
, int force
)
18189 while (!NILP (window
))
18191 struct window
*w
= XWINDOW (window
);
18193 if (WINDOWP (w
->hchild
))
18194 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18195 else if (WINDOWP (w
->vchild
))
18196 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18198 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18199 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18201 struct text_pos lpoint
;
18202 struct buffer
*old
= current_buffer
;
18204 /* Set the window's buffer for the mode line display. */
18205 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18206 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18208 /* Point refers normally to the selected window. For any
18209 other window, set up appropriate value. */
18210 if (!EQ (window
, selected_window
))
18212 struct text_pos pt
;
18214 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18215 if (CHARPOS (pt
) < BEGV
)
18216 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18217 else if (CHARPOS (pt
) > (ZV
- 1))
18218 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18220 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18223 /* Display mode lines. */
18224 clear_glyph_matrix (w
->desired_matrix
);
18225 if (display_mode_lines (w
))
18228 w
->must_be_updated_p
= 1;
18231 /* Restore old settings. */
18232 set_buffer_internal_1 (old
);
18233 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18243 /* Display the mode and/or header line of window W. Value is the
18244 sum number of mode lines and header lines displayed. */
18247 display_mode_lines (struct window
*w
)
18249 Lisp_Object old_selected_window
, old_selected_frame
;
18252 old_selected_frame
= selected_frame
;
18253 selected_frame
= w
->frame
;
18254 old_selected_window
= selected_window
;
18255 XSETWINDOW (selected_window
, w
);
18257 /* These will be set while the mode line specs are processed. */
18258 line_number_displayed
= 0;
18259 w
->column_number_displayed
= Qnil
;
18261 if (WINDOW_WANTS_MODELINE_P (w
))
18263 struct window
*sel_w
= XWINDOW (old_selected_window
);
18265 /* Select mode line face based on the real selected window. */
18266 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18267 BVAR (current_buffer
, mode_line_format
));
18271 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18273 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18274 BVAR (current_buffer
, header_line_format
));
18278 selected_frame
= old_selected_frame
;
18279 selected_window
= old_selected_window
;
18284 /* Display mode or header line of window W. FACE_ID specifies which
18285 line to display; it is either MODE_LINE_FACE_ID or
18286 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18287 display. Value is the pixel height of the mode/header line
18291 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18295 int count
= SPECPDL_INDEX ();
18297 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18298 /* Don't extend on a previously drawn mode-line.
18299 This may happen if called from pos_visible_p. */
18300 it
.glyph_row
->enabled_p
= 0;
18301 prepare_desired_row (it
.glyph_row
);
18303 it
.glyph_row
->mode_line_p
= 1;
18305 if (! mode_line_inverse_video
)
18306 /* Force the mode-line to be displayed in the default face. */
18307 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18309 record_unwind_protect (unwind_format_mode_line
,
18310 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18312 mode_line_target
= MODE_LINE_DISPLAY
;
18314 /* Temporarily make frame's keyboard the current kboard so that
18315 kboard-local variables in the mode_line_format will get the right
18317 push_kboard (FRAME_KBOARD (it
.f
));
18318 record_unwind_save_match_data ();
18319 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18322 unbind_to (count
, Qnil
);
18324 /* Fill up with spaces. */
18325 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18327 compute_line_metrics (&it
);
18328 it
.glyph_row
->full_width_p
= 1;
18329 it
.glyph_row
->continued_p
= 0;
18330 it
.glyph_row
->truncated_on_left_p
= 0;
18331 it
.glyph_row
->truncated_on_right_p
= 0;
18333 /* Make a 3D mode-line have a shadow at its right end. */
18334 face
= FACE_FROM_ID (it
.f
, face_id
);
18335 extend_face_to_end_of_line (&it
);
18336 if (face
->box
!= FACE_NO_BOX
)
18338 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18339 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18340 last
->right_box_line_p
= 1;
18343 return it
.glyph_row
->height
;
18346 /* Move element ELT in LIST to the front of LIST.
18347 Return the updated list. */
18350 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18352 register Lisp_Object tail
, prev
;
18353 register Lisp_Object tem
;
18357 while (CONSP (tail
))
18363 /* Splice out the link TAIL. */
18365 list
= XCDR (tail
);
18367 Fsetcdr (prev
, XCDR (tail
));
18369 /* Now make it the first. */
18370 Fsetcdr (tail
, list
);
18375 tail
= XCDR (tail
);
18379 /* Not found--return unchanged LIST. */
18383 /* Contribute ELT to the mode line for window IT->w. How it
18384 translates into text depends on its data type.
18386 IT describes the display environment in which we display, as usual.
18388 DEPTH is the depth in recursion. It is used to prevent
18389 infinite recursion here.
18391 FIELD_WIDTH is the number of characters the display of ELT should
18392 occupy in the mode line, and PRECISION is the maximum number of
18393 characters to display from ELT's representation. See
18394 display_string for details.
18396 Returns the hpos of the end of the text generated by ELT.
18398 PROPS is a property list to add to any string we encounter.
18400 If RISKY is nonzero, remove (disregard) any properties in any string
18401 we encounter, and ignore :eval and :propertize.
18403 The global variable `mode_line_target' determines whether the
18404 output is passed to `store_mode_line_noprop',
18405 `store_mode_line_string', or `display_string'. */
18408 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18409 Lisp_Object elt
, Lisp_Object props
, int risky
)
18411 int n
= 0, field
, prec
;
18416 elt
= build_string ("*too-deep*");
18420 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18424 /* A string: output it and check for %-constructs within it. */
18426 EMACS_INT offset
= 0;
18428 if (SCHARS (elt
) > 0
18429 && (!NILP (props
) || risky
))
18431 Lisp_Object oprops
, aelt
;
18432 oprops
= Ftext_properties_at (make_number (0), elt
);
18434 /* If the starting string's properties are not what
18435 we want, translate the string. Also, if the string
18436 is risky, do that anyway. */
18438 if (NILP (Fequal (props
, oprops
)) || risky
)
18440 /* If the starting string has properties,
18441 merge the specified ones onto the existing ones. */
18442 if (! NILP (oprops
) && !risky
)
18446 oprops
= Fcopy_sequence (oprops
);
18448 while (CONSP (tem
))
18450 oprops
= Fplist_put (oprops
, XCAR (tem
),
18451 XCAR (XCDR (tem
)));
18452 tem
= XCDR (XCDR (tem
));
18457 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18458 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18460 /* AELT is what we want. Move it to the front
18461 without consing. */
18463 mode_line_proptrans_alist
18464 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18470 /* If AELT has the wrong props, it is useless.
18471 so get rid of it. */
18473 mode_line_proptrans_alist
18474 = Fdelq (aelt
, mode_line_proptrans_alist
);
18476 elt
= Fcopy_sequence (elt
);
18477 Fset_text_properties (make_number (0), Flength (elt
),
18479 /* Add this item to mode_line_proptrans_alist. */
18480 mode_line_proptrans_alist
18481 = Fcons (Fcons (elt
, props
),
18482 mode_line_proptrans_alist
);
18483 /* Truncate mode_line_proptrans_alist
18484 to at most 50 elements. */
18485 tem
= Fnthcdr (make_number (50),
18486 mode_line_proptrans_alist
);
18488 XSETCDR (tem
, Qnil
);
18497 prec
= precision
- n
;
18498 switch (mode_line_target
)
18500 case MODE_LINE_NOPROP
:
18501 case MODE_LINE_TITLE
:
18502 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18504 case MODE_LINE_STRING
:
18505 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18507 case MODE_LINE_DISPLAY
:
18508 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18509 0, prec
, 0, STRING_MULTIBYTE (elt
));
18516 /* Handle the non-literal case. */
18518 while ((precision
<= 0 || n
< precision
)
18519 && SREF (elt
, offset
) != 0
18520 && (mode_line_target
!= MODE_LINE_DISPLAY
18521 || it
->current_x
< it
->last_visible_x
))
18523 EMACS_INT last_offset
= offset
;
18525 /* Advance to end of string or next format specifier. */
18526 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18529 if (offset
- 1 != last_offset
)
18531 EMACS_INT nchars
, nbytes
;
18533 /* Output to end of string or up to '%'. Field width
18534 is length of string. Don't output more than
18535 PRECISION allows us. */
18538 prec
= c_string_width (SDATA (elt
) + last_offset
,
18539 offset
- last_offset
, precision
- n
,
18542 switch (mode_line_target
)
18544 case MODE_LINE_NOPROP
:
18545 case MODE_LINE_TITLE
:
18546 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18548 case MODE_LINE_STRING
:
18550 EMACS_INT bytepos
= last_offset
;
18551 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18552 EMACS_INT endpos
= (precision
<= 0
18553 ? string_byte_to_char (elt
, offset
)
18554 : charpos
+ nchars
);
18556 n
+= store_mode_line_string (NULL
,
18557 Fsubstring (elt
, make_number (charpos
),
18558 make_number (endpos
)),
18562 case MODE_LINE_DISPLAY
:
18564 EMACS_INT bytepos
= last_offset
;
18565 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18567 if (precision
<= 0)
18568 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18569 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18571 STRING_MULTIBYTE (elt
));
18576 else /* c == '%' */
18578 EMACS_INT percent_position
= offset
;
18580 /* Get the specified minimum width. Zero means
18583 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18584 field
= field
* 10 + c
- '0';
18586 /* Don't pad beyond the total padding allowed. */
18587 if (field_width
- n
> 0 && field
> field_width
- n
)
18588 field
= field_width
- n
;
18590 /* Note that either PRECISION <= 0 or N < PRECISION. */
18591 prec
= precision
- n
;
18594 n
+= display_mode_element (it
, depth
, field
, prec
,
18595 Vglobal_mode_string
, props
,
18600 EMACS_INT bytepos
, charpos
;
18602 Lisp_Object string
;
18604 bytepos
= percent_position
;
18605 charpos
= (STRING_MULTIBYTE (elt
)
18606 ? string_byte_to_char (elt
, bytepos
)
18608 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18609 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18611 switch (mode_line_target
)
18613 case MODE_LINE_NOPROP
:
18614 case MODE_LINE_TITLE
:
18615 n
+= store_mode_line_noprop (spec
, field
, prec
);
18617 case MODE_LINE_STRING
:
18619 int len
= strlen (spec
);
18620 Lisp_Object tem
= make_string (spec
, len
);
18621 props
= Ftext_properties_at (make_number (charpos
), elt
);
18622 /* Should only keep face property in props */
18623 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18626 case MODE_LINE_DISPLAY
:
18628 int nglyphs_before
, nwritten
;
18630 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18631 nwritten
= display_string (spec
, string
, elt
,
18636 /* Assign to the glyphs written above the
18637 string where the `%x' came from, position
18641 struct glyph
*glyph
18642 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18646 for (i
= 0; i
< nwritten
; ++i
)
18648 glyph
[i
].object
= elt
;
18649 glyph
[i
].charpos
= charpos
;
18666 /* A symbol: process the value of the symbol recursively
18667 as if it appeared here directly. Avoid error if symbol void.
18668 Special case: if value of symbol is a string, output the string
18671 register Lisp_Object tem
;
18673 /* If the variable is not marked as risky to set
18674 then its contents are risky to use. */
18675 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18678 tem
= Fboundp (elt
);
18681 tem
= Fsymbol_value (elt
);
18682 /* If value is a string, output that string literally:
18683 don't check for % within it. */
18687 if (!EQ (tem
, elt
))
18689 /* Give up right away for nil or t. */
18699 register Lisp_Object car
, tem
;
18701 /* A cons cell: five distinct cases.
18702 If first element is :eval or :propertize, do something special.
18703 If first element is a string or a cons, process all the elements
18704 and effectively concatenate them.
18705 If first element is a negative number, truncate displaying cdr to
18706 at most that many characters. If positive, pad (with spaces)
18707 to at least that many characters.
18708 If first element is a symbol, process the cadr or caddr recursively
18709 according to whether the symbol's value is non-nil or nil. */
18711 if (EQ (car
, QCeval
))
18713 /* An element of the form (:eval FORM) means evaluate FORM
18714 and use the result as mode line elements. */
18719 if (CONSP (XCDR (elt
)))
18722 spec
= safe_eval (XCAR (XCDR (elt
)));
18723 n
+= display_mode_element (it
, depth
, field_width
- n
,
18724 precision
- n
, spec
, props
,
18728 else if (EQ (car
, QCpropertize
))
18730 /* An element of the form (:propertize ELT PROPS...)
18731 means display ELT but applying properties PROPS. */
18736 if (CONSP (XCDR (elt
)))
18737 n
+= display_mode_element (it
, depth
, field_width
- n
,
18738 precision
- n
, XCAR (XCDR (elt
)),
18739 XCDR (XCDR (elt
)), risky
);
18741 else if (SYMBOLP (car
))
18743 tem
= Fboundp (car
);
18747 /* elt is now the cdr, and we know it is a cons cell.
18748 Use its car if CAR has a non-nil value. */
18751 tem
= Fsymbol_value (car
);
18758 /* Symbol's value is nil (or symbol is unbound)
18759 Get the cddr of the original list
18760 and if possible find the caddr and use that. */
18764 else if (!CONSP (elt
))
18769 else if (INTEGERP (car
))
18771 register int lim
= XINT (car
);
18775 /* Negative int means reduce maximum width. */
18776 if (precision
<= 0)
18779 precision
= min (precision
, -lim
);
18783 /* Padding specified. Don't let it be more than
18784 current maximum. */
18786 lim
= min (precision
, lim
);
18788 /* If that's more padding than already wanted, queue it.
18789 But don't reduce padding already specified even if
18790 that is beyond the current truncation point. */
18791 field_width
= max (lim
, field_width
);
18795 else if (STRINGP (car
) || CONSP (car
))
18797 Lisp_Object halftail
= elt
;
18801 && (precision
<= 0 || n
< precision
))
18803 n
+= display_mode_element (it
, depth
,
18804 /* Do padding only after the last
18805 element in the list. */
18806 (! CONSP (XCDR (elt
))
18809 precision
- n
, XCAR (elt
),
18813 if ((len
& 1) == 0)
18814 halftail
= XCDR (halftail
);
18815 /* Check for cycle. */
18816 if (EQ (halftail
, elt
))
18825 elt
= build_string ("*invalid*");
18829 /* Pad to FIELD_WIDTH. */
18830 if (field_width
> 0 && n
< field_width
)
18832 switch (mode_line_target
)
18834 case MODE_LINE_NOPROP
:
18835 case MODE_LINE_TITLE
:
18836 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18838 case MODE_LINE_STRING
:
18839 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18841 case MODE_LINE_DISPLAY
:
18842 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18851 /* Store a mode-line string element in mode_line_string_list.
18853 If STRING is non-null, display that C string. Otherwise, the Lisp
18854 string LISP_STRING is displayed.
18856 FIELD_WIDTH is the minimum number of output glyphs to produce.
18857 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18858 with spaces. FIELD_WIDTH <= 0 means don't pad.
18860 PRECISION is the maximum number of characters to output from
18861 STRING. PRECISION <= 0 means don't truncate the string.
18863 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18864 properties to the string.
18866 PROPS are the properties to add to the string.
18867 The mode_line_string_face face property is always added to the string.
18871 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18872 int field_width
, int precision
, Lisp_Object props
)
18877 if (string
!= NULL
)
18879 len
= strlen (string
);
18880 if (precision
> 0 && len
> precision
)
18882 lisp_string
= make_string (string
, len
);
18884 props
= mode_line_string_face_prop
;
18885 else if (!NILP (mode_line_string_face
))
18887 Lisp_Object face
= Fplist_get (props
, Qface
);
18888 props
= Fcopy_sequence (props
);
18890 face
= mode_line_string_face
;
18892 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18893 props
= Fplist_put (props
, Qface
, face
);
18895 Fadd_text_properties (make_number (0), make_number (len
),
18896 props
, lisp_string
);
18900 len
= XFASTINT (Flength (lisp_string
));
18901 if (precision
> 0 && len
> precision
)
18904 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18907 if (!NILP (mode_line_string_face
))
18911 props
= Ftext_properties_at (make_number (0), lisp_string
);
18912 face
= Fplist_get (props
, Qface
);
18914 face
= mode_line_string_face
;
18916 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18917 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18919 lisp_string
= Fcopy_sequence (lisp_string
);
18922 Fadd_text_properties (make_number (0), make_number (len
),
18923 props
, lisp_string
);
18928 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18932 if (field_width
> len
)
18934 field_width
-= len
;
18935 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18937 Fadd_text_properties (make_number (0), make_number (field_width
),
18938 props
, lisp_string
);
18939 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18947 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18949 doc
: /* Format a string out of a mode line format specification.
18950 First arg FORMAT specifies the mode line format (see `mode-line-format'
18951 for details) to use.
18953 By default, the format is evaluated for the currently selected window.
18955 Optional second arg FACE specifies the face property to put on all
18956 characters for which no face is specified. The value nil means the
18957 default face. The value t means whatever face the window's mode line
18958 currently uses (either `mode-line' or `mode-line-inactive',
18959 depending on whether the window is the selected window or not).
18960 An integer value means the value string has no text
18963 Optional third and fourth args WINDOW and BUFFER specify the window
18964 and buffer to use as the context for the formatting (defaults
18965 are the selected window and the WINDOW's buffer). */)
18966 (Lisp_Object format
, Lisp_Object face
,
18967 Lisp_Object window
, Lisp_Object buffer
)
18972 struct buffer
*old_buffer
= NULL
;
18974 int no_props
= INTEGERP (face
);
18975 int count
= SPECPDL_INDEX ();
18977 int string_start
= 0;
18980 window
= selected_window
;
18981 CHECK_WINDOW (window
);
18982 w
= XWINDOW (window
);
18985 buffer
= w
->buffer
;
18986 CHECK_BUFFER (buffer
);
18988 /* Make formatting the modeline a non-op when noninteractive, otherwise
18989 there will be problems later caused by a partially initialized frame. */
18990 if (NILP (format
) || noninteractive
)
18991 return empty_unibyte_string
;
18996 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18997 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18998 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18999 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19000 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19001 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19002 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19005 if (XBUFFER (buffer
) != current_buffer
)
19006 old_buffer
= current_buffer
;
19008 /* Save things including mode_line_proptrans_alist,
19009 and set that to nil so that we don't alter the outer value. */
19010 record_unwind_protect (unwind_format_mode_line
,
19011 format_mode_line_unwind_data
19012 (old_buffer
, selected_window
, 1));
19013 mode_line_proptrans_alist
= Qnil
;
19015 Fselect_window (window
, Qt
);
19017 set_buffer_internal_1 (XBUFFER (buffer
));
19019 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19023 mode_line_target
= MODE_LINE_NOPROP
;
19024 mode_line_string_face_prop
= Qnil
;
19025 mode_line_string_list
= Qnil
;
19026 string_start
= MODE_LINE_NOPROP_LEN (0);
19030 mode_line_target
= MODE_LINE_STRING
;
19031 mode_line_string_list
= Qnil
;
19032 mode_line_string_face
= face
;
19033 mode_line_string_face_prop
19034 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19037 push_kboard (FRAME_KBOARD (it
.f
));
19038 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19043 len
= MODE_LINE_NOPROP_LEN (string_start
);
19044 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19048 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19049 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19050 empty_unibyte_string
);
19053 unbind_to (count
, Qnil
);
19057 /* Write a null-terminated, right justified decimal representation of
19058 the positive integer D to BUF using a minimal field width WIDTH. */
19061 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19063 register char *p
= buf
;
19071 *p
++ = d
% 10 + '0';
19076 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19087 /* Write a null-terminated, right justified decimal and "human
19088 readable" representation of the nonnegative integer D to BUF using
19089 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19091 static const char power_letter
[] =
19105 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19107 /* We aim to represent the nonnegative integer D as
19108 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19109 EMACS_INT quotient
= d
;
19111 /* -1 means: do not use TENTHS. */
19115 /* Length of QUOTIENT.TENTHS as a string. */
19121 if (1000 <= quotient
)
19123 /* Scale to the appropriate EXPONENT. */
19126 remainder
= quotient
% 1000;
19130 while (1000 <= quotient
);
19132 /* Round to nearest and decide whether to use TENTHS or not. */
19135 tenths
= remainder
/ 100;
19136 if (50 <= remainder
% 100)
19143 if (quotient
== 10)
19151 if (500 <= remainder
)
19153 if (quotient
< 999)
19164 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19165 if (tenths
== -1 && quotient
<= 99)
19172 p
= psuffix
= buf
+ max (width
, length
);
19174 /* Print EXPONENT. */
19175 *psuffix
++ = power_letter
[exponent
];
19178 /* Print TENTHS. */
19181 *--p
= '0' + tenths
;
19185 /* Print QUOTIENT. */
19188 int digit
= quotient
% 10;
19189 *--p
= '0' + digit
;
19191 while ((quotient
/= 10) != 0);
19193 /* Print leading spaces. */
19198 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19199 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19200 type of CODING_SYSTEM. Return updated pointer into BUF. */
19202 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19205 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19208 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19209 const unsigned char *eol_str
;
19211 /* The EOL conversion we are using. */
19212 Lisp_Object eoltype
;
19214 val
= CODING_SYSTEM_SPEC (coding_system
);
19217 if (!VECTORP (val
)) /* Not yet decided. */
19222 eoltype
= eol_mnemonic_undecided
;
19223 /* Don't mention EOL conversion if it isn't decided. */
19228 Lisp_Object eolvalue
;
19230 attrs
= AREF (val
, 0);
19231 eolvalue
= AREF (val
, 2);
19234 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19238 /* The EOL conversion that is normal on this system. */
19240 if (NILP (eolvalue
)) /* Not yet decided. */
19241 eoltype
= eol_mnemonic_undecided
;
19242 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19243 eoltype
= eol_mnemonic_undecided
;
19244 else /* eolvalue is Qunix, Qdos, or Qmac. */
19245 eoltype
= (EQ (eolvalue
, Qunix
)
19246 ? eol_mnemonic_unix
19247 : (EQ (eolvalue
, Qdos
) == 1
19248 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19254 /* Mention the EOL conversion if it is not the usual one. */
19255 if (STRINGP (eoltype
))
19257 eol_str
= SDATA (eoltype
);
19258 eol_str_len
= SBYTES (eoltype
);
19260 else if (CHARACTERP (eoltype
))
19262 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19263 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19268 eol_str
= invalid_eol_type
;
19269 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19271 memcpy (buf
, eol_str
, eol_str_len
);
19272 buf
+= eol_str_len
;
19278 /* Return a string for the output of a mode line %-spec for window W,
19279 generated by character C. FIELD_WIDTH > 0 means pad the string
19280 returned with spaces to that value. Return a Lisp string in
19281 *STRING if the resulting string is taken from that Lisp string.
19283 Note we operate on the current buffer for most purposes,
19284 the exception being w->base_line_pos. */
19286 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19288 static const char *
19289 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19290 Lisp_Object
*string
)
19293 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19294 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19295 struct buffer
*b
= current_buffer
;
19303 if (!NILP (BVAR (b
, read_only
)))
19305 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19310 /* This differs from %* only for a modified read-only buffer. */
19311 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19313 if (!NILP (BVAR (b
, read_only
)))
19318 /* This differs from %* in ignoring read-only-ness. */
19319 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19331 if (command_loop_level
> 5)
19333 p
= decode_mode_spec_buf
;
19334 for (i
= 0; i
< command_loop_level
; i
++)
19337 return decode_mode_spec_buf
;
19345 if (command_loop_level
> 5)
19347 p
= decode_mode_spec_buf
;
19348 for (i
= 0; i
< command_loop_level
; i
++)
19351 return decode_mode_spec_buf
;
19358 /* Let lots_of_dashes be a string of infinite length. */
19359 if (mode_line_target
== MODE_LINE_NOPROP
||
19360 mode_line_target
== MODE_LINE_STRING
)
19362 if (field_width
<= 0
19363 || field_width
> sizeof (lots_of_dashes
))
19365 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19366 decode_mode_spec_buf
[i
] = '-';
19367 decode_mode_spec_buf
[i
] = '\0';
19368 return decode_mode_spec_buf
;
19371 return lots_of_dashes
;
19375 obj
= BVAR (b
, name
);
19379 /* %c and %l are ignored in `frame-title-format'.
19380 (In redisplay_internal, the frame title is drawn _before_ the
19381 windows are updated, so the stuff which depends on actual
19382 window contents (such as %l) may fail to render properly, or
19383 even crash emacs.) */
19384 if (mode_line_target
== MODE_LINE_TITLE
)
19388 EMACS_INT col
= current_column ();
19389 w
->column_number_displayed
= make_number (col
);
19390 pint2str (decode_mode_spec_buf
, field_width
, col
);
19391 return decode_mode_spec_buf
;
19395 #ifndef SYSTEM_MALLOC
19397 if (NILP (Vmemory_full
))
19400 return "!MEM FULL! ";
19407 /* %F displays the frame name. */
19408 if (!NILP (f
->title
))
19409 return SSDATA (f
->title
);
19410 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19411 return SSDATA (f
->name
);
19415 obj
= BVAR (b
, filename
);
19420 EMACS_INT size
= ZV
- BEGV
;
19421 pint2str (decode_mode_spec_buf
, field_width
, size
);
19422 return decode_mode_spec_buf
;
19427 EMACS_INT size
= ZV
- BEGV
;
19428 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19429 return decode_mode_spec_buf
;
19434 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19435 EMACS_INT topline
, nlines
, height
;
19438 /* %c and %l are ignored in `frame-title-format'. */
19439 if (mode_line_target
== MODE_LINE_TITLE
)
19442 startpos
= XMARKER (w
->start
)->charpos
;
19443 startpos_byte
= marker_byte_position (w
->start
);
19444 height
= WINDOW_TOTAL_LINES (w
);
19446 /* If we decided that this buffer isn't suitable for line numbers,
19447 don't forget that too fast. */
19448 if (EQ (w
->base_line_pos
, w
->buffer
))
19450 /* But do forget it, if the window shows a different buffer now. */
19451 else if (BUFFERP (w
->base_line_pos
))
19452 w
->base_line_pos
= Qnil
;
19454 /* If the buffer is very big, don't waste time. */
19455 if (INTEGERP (Vline_number_display_limit
)
19456 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19458 w
->base_line_pos
= Qnil
;
19459 w
->base_line_number
= Qnil
;
19463 if (INTEGERP (w
->base_line_number
)
19464 && INTEGERP (w
->base_line_pos
)
19465 && XFASTINT (w
->base_line_pos
) <= startpos
)
19467 line
= XFASTINT (w
->base_line_number
);
19468 linepos
= XFASTINT (w
->base_line_pos
);
19469 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19474 linepos
= BUF_BEGV (b
);
19475 linepos_byte
= BUF_BEGV_BYTE (b
);
19478 /* Count lines from base line to window start position. */
19479 nlines
= display_count_lines (linepos_byte
,
19483 topline
= nlines
+ line
;
19485 /* Determine a new base line, if the old one is too close
19486 or too far away, or if we did not have one.
19487 "Too close" means it's plausible a scroll-down would
19488 go back past it. */
19489 if (startpos
== BUF_BEGV (b
))
19491 w
->base_line_number
= make_number (topline
);
19492 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19494 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19495 || linepos
== BUF_BEGV (b
))
19497 EMACS_INT limit
= BUF_BEGV (b
);
19498 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19499 EMACS_INT position
;
19500 EMACS_INT distance
=
19501 (height
* 2 + 30) * line_number_display_limit_width
;
19503 if (startpos
- distance
> limit
)
19505 limit
= startpos
- distance
;
19506 limit_byte
= CHAR_TO_BYTE (limit
);
19509 nlines
= display_count_lines (startpos_byte
,
19511 - (height
* 2 + 30),
19513 /* If we couldn't find the lines we wanted within
19514 line_number_display_limit_width chars per line,
19515 give up on line numbers for this window. */
19516 if (position
== limit_byte
&& limit
== startpos
- distance
)
19518 w
->base_line_pos
= w
->buffer
;
19519 w
->base_line_number
= Qnil
;
19523 w
->base_line_number
= make_number (topline
- nlines
);
19524 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19527 /* Now count lines from the start pos to point. */
19528 nlines
= display_count_lines (startpos_byte
,
19529 PT_BYTE
, PT
, &junk
);
19531 /* Record that we did display the line number. */
19532 line_number_displayed
= 1;
19534 /* Make the string to show. */
19535 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19536 return decode_mode_spec_buf
;
19539 char* p
= decode_mode_spec_buf
;
19540 int pad
= field_width
- 2;
19546 return decode_mode_spec_buf
;
19552 obj
= BVAR (b
, mode_name
);
19556 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19562 EMACS_INT pos
= marker_position (w
->start
);
19563 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19565 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19567 if (pos
<= BUF_BEGV (b
))
19572 else if (pos
<= BUF_BEGV (b
))
19576 if (total
> 1000000)
19577 /* Do it differently for a large value, to avoid overflow. */
19578 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19580 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19581 /* We can't normally display a 3-digit number,
19582 so get us a 2-digit number that is close. */
19585 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19586 return decode_mode_spec_buf
;
19590 /* Display percentage of size above the bottom of the screen. */
19593 EMACS_INT toppos
= marker_position (w
->start
);
19594 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19595 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19597 if (botpos
>= BUF_ZV (b
))
19599 if (toppos
<= BUF_BEGV (b
))
19606 if (total
> 1000000)
19607 /* Do it differently for a large value, to avoid overflow. */
19608 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19610 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19611 /* We can't normally display a 3-digit number,
19612 so get us a 2-digit number that is close. */
19615 if (toppos
<= BUF_BEGV (b
))
19616 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19618 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19619 return decode_mode_spec_buf
;
19624 /* status of process */
19625 obj
= Fget_buffer_process (Fcurrent_buffer ());
19627 return "no process";
19629 obj
= Fsymbol_name (Fprocess_status (obj
));
19635 int count
= inhibit_garbage_collection ();
19636 Lisp_Object val
= call1 (intern ("file-remote-p"),
19637 BVAR (current_buffer
, directory
));
19638 unbind_to (count
, Qnil
);
19646 case 't': /* indicate TEXT or BINARY */
19650 /* coding-system (not including end-of-line format) */
19652 /* coding-system (including end-of-line type) */
19654 int eol_flag
= (c
== 'Z');
19655 char *p
= decode_mode_spec_buf
;
19657 if (! FRAME_WINDOW_P (f
))
19659 /* No need to mention EOL here--the terminal never needs
19660 to do EOL conversion. */
19661 p
= decode_mode_spec_coding (CODING_ID_NAME
19662 (FRAME_KEYBOARD_CODING (f
)->id
),
19664 p
= decode_mode_spec_coding (CODING_ID_NAME
19665 (FRAME_TERMINAL_CODING (f
)->id
),
19668 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19671 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19672 #ifdef subprocesses
19673 obj
= Fget_buffer_process (Fcurrent_buffer ());
19674 if (PROCESSP (obj
))
19676 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19678 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19681 #endif /* subprocesses */
19684 return decode_mode_spec_buf
;
19691 return SSDATA (obj
);
19698 /* Count up to COUNT lines starting from START_BYTE.
19699 But don't go beyond LIMIT_BYTE.
19700 Return the number of lines thus found (always nonnegative).
19702 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19705 display_count_lines (EMACS_INT start_byte
,
19706 EMACS_INT limit_byte
, EMACS_INT count
,
19707 EMACS_INT
*byte_pos_ptr
)
19709 register unsigned char *cursor
;
19710 unsigned char *base
;
19712 register EMACS_INT ceiling
;
19713 register unsigned char *ceiling_addr
;
19714 EMACS_INT orig_count
= count
;
19716 /* If we are not in selective display mode,
19717 check only for newlines. */
19718 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19719 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19723 while (start_byte
< limit_byte
)
19725 ceiling
= BUFFER_CEILING_OF (start_byte
);
19726 ceiling
= min (limit_byte
- 1, ceiling
);
19727 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19728 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19731 if (selective_display
)
19732 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19735 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19738 if (cursor
!= ceiling_addr
)
19742 start_byte
+= cursor
- base
+ 1;
19743 *byte_pos_ptr
= start_byte
;
19747 if (++cursor
== ceiling_addr
)
19753 start_byte
+= cursor
- base
;
19758 while (start_byte
> limit_byte
)
19760 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19761 ceiling
= max (limit_byte
, ceiling
);
19762 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19763 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19766 if (selective_display
)
19767 while (--cursor
!= ceiling_addr
19768 && *cursor
!= '\n' && *cursor
!= 015)
19771 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19774 if (cursor
!= ceiling_addr
)
19778 start_byte
+= cursor
- base
+ 1;
19779 *byte_pos_ptr
= start_byte
;
19780 /* When scanning backwards, we should
19781 not count the newline posterior to which we stop. */
19782 return - orig_count
- 1;
19788 /* Here we add 1 to compensate for the last decrement
19789 of CURSOR, which took it past the valid range. */
19790 start_byte
+= cursor
- base
+ 1;
19794 *byte_pos_ptr
= limit_byte
;
19797 return - orig_count
+ count
;
19798 return orig_count
- count
;
19804 /***********************************************************************
19806 ***********************************************************************/
19808 /* Display a NUL-terminated string, starting with index START.
19810 If STRING is non-null, display that C string. Otherwise, the Lisp
19811 string LISP_STRING is displayed. There's a case that STRING is
19812 non-null and LISP_STRING is not nil. It means STRING is a string
19813 data of LISP_STRING. In that case, we display LISP_STRING while
19814 ignoring its text properties.
19816 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19817 FACE_STRING. Display STRING or LISP_STRING with the face at
19818 FACE_STRING_POS in FACE_STRING:
19820 Display the string in the environment given by IT, but use the
19821 standard display table, temporarily.
19823 FIELD_WIDTH is the minimum number of output glyphs to produce.
19824 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19825 with spaces. If STRING has more characters, more than FIELD_WIDTH
19826 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19828 PRECISION is the maximum number of characters to output from
19829 STRING. PRECISION < 0 means don't truncate the string.
19831 This is roughly equivalent to printf format specifiers:
19833 FIELD_WIDTH PRECISION PRINTF
19834 ----------------------------------------
19840 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19841 display them, and < 0 means obey the current buffer's value of
19842 enable_multibyte_characters.
19844 Value is the number of columns displayed. */
19847 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19848 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19849 int field_width
, int precision
, int max_x
, int multibyte
)
19851 int hpos_at_start
= it
->hpos
;
19852 int saved_face_id
= it
->face_id
;
19853 struct glyph_row
*row
= it
->glyph_row
;
19855 /* Initialize the iterator IT for iteration over STRING beginning
19856 with index START. */
19857 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19858 precision
, field_width
, multibyte
);
19859 if (string
&& STRINGP (lisp_string
))
19860 /* LISP_STRING is the one returned by decode_mode_spec. We should
19861 ignore its text properties. */
19862 it
->stop_charpos
= -1;
19864 /* If displaying STRING, set up the face of the iterator
19865 from LISP_STRING, if that's given. */
19866 if (STRINGP (face_string
))
19872 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19873 0, it
->region_beg_charpos
,
19874 it
->region_end_charpos
,
19875 &endptr
, it
->base_face_id
, 0);
19876 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19877 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19880 /* Set max_x to the maximum allowed X position. Don't let it go
19881 beyond the right edge of the window. */
19883 max_x
= it
->last_visible_x
;
19885 max_x
= min (max_x
, it
->last_visible_x
);
19887 /* Skip over display elements that are not visible. because IT->w is
19889 if (it
->current_x
< it
->first_visible_x
)
19890 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19891 MOVE_TO_POS
| MOVE_TO_X
);
19893 row
->ascent
= it
->max_ascent
;
19894 row
->height
= it
->max_ascent
+ it
->max_descent
;
19895 row
->phys_ascent
= it
->max_phys_ascent
;
19896 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19897 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19899 /* This condition is for the case that we are called with current_x
19900 past last_visible_x. */
19901 while (it
->current_x
< max_x
)
19903 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19905 /* Get the next display element. */
19906 if (!get_next_display_element (it
))
19909 /* Produce glyphs. */
19910 x_before
= it
->current_x
;
19911 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19912 PRODUCE_GLYPHS (it
);
19914 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19917 while (i
< nglyphs
)
19919 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19921 if (it
->line_wrap
!= TRUNCATE
19922 && x
+ glyph
->pixel_width
> max_x
)
19924 /* End of continued line or max_x reached. */
19925 if (CHAR_GLYPH_PADDING_P (*glyph
))
19927 /* A wide character is unbreakable. */
19928 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19929 it
->current_x
= x_before
;
19933 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19938 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19940 /* Glyph is at least partially visible. */
19942 if (x
< it
->first_visible_x
)
19943 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19947 /* Glyph is off the left margin of the display area.
19948 Should not happen. */
19952 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19953 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19954 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19955 row
->phys_height
= max (row
->phys_height
,
19956 it
->max_phys_ascent
+ it
->max_phys_descent
);
19957 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19958 it
->max_extra_line_spacing
);
19959 x
+= glyph
->pixel_width
;
19963 /* Stop if max_x reached. */
19967 /* Stop at line ends. */
19968 if (ITERATOR_AT_END_OF_LINE_P (it
))
19970 it
->continuation_lines_width
= 0;
19974 set_iterator_to_next (it
, 1);
19976 /* Stop if truncating at the right edge. */
19977 if (it
->line_wrap
== TRUNCATE
19978 && it
->current_x
>= it
->last_visible_x
)
19980 /* Add truncation mark, but don't do it if the line is
19981 truncated at a padding space. */
19982 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19984 if (!FRAME_WINDOW_P (it
->f
))
19988 if (it
->current_x
> it
->last_visible_x
)
19990 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19991 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19993 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19995 row
->used
[TEXT_AREA
] = ii
;
19996 produce_special_glyphs (it
, IT_TRUNCATION
);
19999 produce_special_glyphs (it
, IT_TRUNCATION
);
20001 it
->glyph_row
->truncated_on_right_p
= 1;
20007 /* Maybe insert a truncation at the left. */
20008 if (it
->first_visible_x
20009 && IT_CHARPOS (*it
) > 0)
20011 if (!FRAME_WINDOW_P (it
->f
))
20012 insert_left_trunc_glyphs (it
);
20013 it
->glyph_row
->truncated_on_left_p
= 1;
20016 it
->face_id
= saved_face_id
;
20018 /* Value is number of columns displayed. */
20019 return it
->hpos
- hpos_at_start
;
20024 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20025 appears as an element of LIST or as the car of an element of LIST.
20026 If PROPVAL is a list, compare each element against LIST in that
20027 way, and return 1/2 if any element of PROPVAL is found in LIST.
20028 Otherwise return 0. This function cannot quit.
20029 The return value is 2 if the text is invisible but with an ellipsis
20030 and 1 if it's invisible and without an ellipsis. */
20033 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20035 register Lisp_Object tail
, proptail
;
20037 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20039 register Lisp_Object tem
;
20041 if (EQ (propval
, tem
))
20043 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20044 return NILP (XCDR (tem
)) ? 1 : 2;
20047 if (CONSP (propval
))
20049 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20051 Lisp_Object propelt
;
20052 propelt
= XCAR (proptail
);
20053 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20055 register Lisp_Object tem
;
20057 if (EQ (propelt
, tem
))
20059 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20060 return NILP (XCDR (tem
)) ? 1 : 2;
20068 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20069 doc
: /* Non-nil if the property makes the text invisible.
20070 POS-OR-PROP can be a marker or number, in which case it is taken to be
20071 a position in the current buffer and the value of the `invisible' property
20072 is checked; or it can be some other value, which is then presumed to be the
20073 value of the `invisible' property of the text of interest.
20074 The non-nil value returned can be t for truly invisible text or something
20075 else if the text is replaced by an ellipsis. */)
20076 (Lisp_Object pos_or_prop
)
20079 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20080 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20082 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20083 return (invis
== 0 ? Qnil
20085 : make_number (invis
));
20088 /* Calculate a width or height in pixels from a specification using
20089 the following elements:
20092 NUM - a (fractional) multiple of the default font width/height
20093 (NUM) - specifies exactly NUM pixels
20094 UNIT - a fixed number of pixels, see below.
20095 ELEMENT - size of a display element in pixels, see below.
20096 (NUM . SPEC) - equals NUM * SPEC
20097 (+ SPEC SPEC ...) - add pixel values
20098 (- SPEC SPEC ...) - subtract pixel values
20099 (- SPEC) - negate pixel value
20102 INT or FLOAT - a number constant
20103 SYMBOL - use symbol's (buffer local) variable binding.
20106 in - pixels per inch *)
20107 mm - pixels per 1/1000 meter *)
20108 cm - pixels per 1/100 meter *)
20109 width - width of current font in pixels.
20110 height - height of current font in pixels.
20112 *) using the ratio(s) defined in display-pixels-per-inch.
20116 left-fringe - left fringe width in pixels
20117 right-fringe - right fringe width in pixels
20119 left-margin - left margin width in pixels
20120 right-margin - right margin width in pixels
20122 scroll-bar - scroll-bar area width in pixels
20126 Pixels corresponding to 5 inches:
20129 Total width of non-text areas on left side of window (if scroll-bar is on left):
20130 '(space :width (+ left-fringe left-margin scroll-bar))
20132 Align to first text column (in header line):
20133 '(space :align-to 0)
20135 Align to middle of text area minus half the width of variable `my-image'
20136 containing a loaded image:
20137 '(space :align-to (0.5 . (- text my-image)))
20139 Width of left margin minus width of 1 character in the default font:
20140 '(space :width (- left-margin 1))
20142 Width of left margin minus width of 2 characters in the current font:
20143 '(space :width (- left-margin (2 . width)))
20145 Center 1 character over left-margin (in header line):
20146 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20148 Different ways to express width of left fringe plus left margin minus one pixel:
20149 '(space :width (- (+ left-fringe left-margin) (1)))
20150 '(space :width (+ left-fringe left-margin (- (1))))
20151 '(space :width (+ left-fringe left-margin (-1)))
20155 #define NUMVAL(X) \
20156 ((INTEGERP (X) || FLOATP (X)) \
20161 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20162 struct font
*font
, int width_p
, int *align_to
)
20166 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20167 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20170 return OK_PIXELS (0);
20172 xassert (FRAME_LIVE_P (it
->f
));
20174 if (SYMBOLP (prop
))
20176 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20178 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20180 if (unit
[0] == 'i' && unit
[1] == 'n')
20182 else if (unit
[0] == 'm' && unit
[1] == 'm')
20184 else if (unit
[0] == 'c' && unit
[1] == 'm')
20191 #ifdef HAVE_WINDOW_SYSTEM
20192 if (FRAME_WINDOW_P (it
->f
)
20194 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20195 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20197 return OK_PIXELS (ppi
/ pixels
);
20200 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20201 || (CONSP (Vdisplay_pixels_per_inch
)
20203 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20204 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20206 return OK_PIXELS (ppi
/ pixels
);
20212 #ifdef HAVE_WINDOW_SYSTEM
20213 if (EQ (prop
, Qheight
))
20214 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20215 if (EQ (prop
, Qwidth
))
20216 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20218 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20219 return OK_PIXELS (1);
20222 if (EQ (prop
, Qtext
))
20223 return OK_PIXELS (width_p
20224 ? window_box_width (it
->w
, TEXT_AREA
)
20225 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20227 if (align_to
&& *align_to
< 0)
20230 if (EQ (prop
, Qleft
))
20231 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20232 if (EQ (prop
, Qright
))
20233 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20234 if (EQ (prop
, Qcenter
))
20235 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20236 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20237 if (EQ (prop
, Qleft_fringe
))
20238 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20240 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20241 if (EQ (prop
, Qright_fringe
))
20242 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20243 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20244 : window_box_right_offset (it
->w
, TEXT_AREA
));
20245 if (EQ (prop
, Qleft_margin
))
20246 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20247 if (EQ (prop
, Qright_margin
))
20248 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20249 if (EQ (prop
, Qscroll_bar
))
20250 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20252 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20253 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20254 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20259 if (EQ (prop
, Qleft_fringe
))
20260 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20261 if (EQ (prop
, Qright_fringe
))
20262 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20263 if (EQ (prop
, Qleft_margin
))
20264 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20265 if (EQ (prop
, Qright_margin
))
20266 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20267 if (EQ (prop
, Qscroll_bar
))
20268 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20271 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20274 if (INTEGERP (prop
) || FLOATP (prop
))
20276 int base_unit
= (width_p
20277 ? FRAME_COLUMN_WIDTH (it
->f
)
20278 : FRAME_LINE_HEIGHT (it
->f
));
20279 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20284 Lisp_Object car
= XCAR (prop
);
20285 Lisp_Object cdr
= XCDR (prop
);
20289 #ifdef HAVE_WINDOW_SYSTEM
20290 if (FRAME_WINDOW_P (it
->f
)
20291 && valid_image_p (prop
))
20293 int id
= lookup_image (it
->f
, prop
);
20294 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20296 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20299 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20305 while (CONSP (cdr
))
20307 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20308 font
, width_p
, align_to
))
20311 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20316 if (EQ (car
, Qminus
))
20318 return OK_PIXELS (pixels
);
20321 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20324 if (INTEGERP (car
) || FLOATP (car
))
20327 pixels
= XFLOATINT (car
);
20329 return OK_PIXELS (pixels
);
20330 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20331 font
, width_p
, align_to
))
20332 return OK_PIXELS (pixels
* fact
);
20343 /***********************************************************************
20345 ***********************************************************************/
20347 #ifdef HAVE_WINDOW_SYSTEM
20352 dump_glyph_string (s
)
20353 struct glyph_string
*s
;
20355 fprintf (stderr
, "glyph string\n");
20356 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20357 s
->x
, s
->y
, s
->width
, s
->height
);
20358 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20359 fprintf (stderr
, " hl = %d\n", s
->hl
);
20360 fprintf (stderr
, " left overhang = %d, right = %d\n",
20361 s
->left_overhang
, s
->right_overhang
);
20362 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20363 fprintf (stderr
, " extends to end of line = %d\n",
20364 s
->extends_to_end_of_line_p
);
20365 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20366 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20369 #endif /* GLYPH_DEBUG */
20371 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20372 of XChar2b structures for S; it can't be allocated in
20373 init_glyph_string because it must be allocated via `alloca'. W
20374 is the window on which S is drawn. ROW and AREA are the glyph row
20375 and area within the row from which S is constructed. START is the
20376 index of the first glyph structure covered by S. HL is a
20377 face-override for drawing S. */
20380 #define OPTIONAL_HDC(hdc) HDC hdc,
20381 #define DECLARE_HDC(hdc) HDC hdc;
20382 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20383 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20386 #ifndef OPTIONAL_HDC
20387 #define OPTIONAL_HDC(hdc)
20388 #define DECLARE_HDC(hdc)
20389 #define ALLOCATE_HDC(hdc, f)
20390 #define RELEASE_HDC(hdc, f)
20394 init_glyph_string (struct glyph_string
*s
,
20396 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20397 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20399 memset (s
, 0, sizeof *s
);
20401 s
->f
= XFRAME (w
->frame
);
20405 s
->display
= FRAME_X_DISPLAY (s
->f
);
20406 s
->window
= FRAME_X_WINDOW (s
->f
);
20407 s
->char2b
= char2b
;
20411 s
->first_glyph
= row
->glyphs
[area
] + start
;
20412 s
->height
= row
->height
;
20413 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20414 s
->ybase
= s
->y
+ row
->ascent
;
20418 /* Append the list of glyph strings with head H and tail T to the list
20419 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20422 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20423 struct glyph_string
*h
, struct glyph_string
*t
)
20437 /* Prepend the list of glyph strings with head H and tail T to the
20438 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20442 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20443 struct glyph_string
*h
, struct glyph_string
*t
)
20457 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20458 Set *HEAD and *TAIL to the resulting list. */
20461 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20462 struct glyph_string
*s
)
20464 s
->next
= s
->prev
= NULL
;
20465 append_glyph_string_lists (head
, tail
, s
, s
);
20469 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20470 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20471 make sure that X resources for the face returned are allocated.
20472 Value is a pointer to a realized face that is ready for display if
20473 DISPLAY_P is non-zero. */
20475 static INLINE
struct face
*
20476 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20477 XChar2b
*char2b
, int display_p
)
20479 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20483 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20485 if (code
!= FONT_INVALID_CODE
)
20486 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20488 STORE_XCHAR2B (char2b
, 0, 0);
20491 /* Make sure X resources of the face are allocated. */
20492 #ifdef HAVE_X_WINDOWS
20496 xassert (face
!= NULL
);
20497 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20504 /* Get face and two-byte form of character glyph GLYPH on frame F.
20505 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20506 a pointer to a realized face that is ready for display. */
20508 static INLINE
struct face
*
20509 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20510 XChar2b
*char2b
, int *two_byte_p
)
20514 xassert (glyph
->type
== CHAR_GLYPH
);
20515 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20524 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20525 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20527 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20529 if (code
!= FONT_INVALID_CODE
)
20530 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20532 STORE_XCHAR2B (char2b
, 0, 0);
20535 /* Make sure X resources of the face are allocated. */
20536 xassert (face
!= NULL
);
20537 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20542 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20543 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20546 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20550 if (CHAR_BYTE8_P (c
))
20551 code
= CHAR_TO_BYTE8 (c
);
20553 code
= font
->driver
->encode_char (font
, c
);
20555 if (code
== FONT_INVALID_CODE
)
20557 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20562 /* Fill glyph string S with composition components specified by S->cmp.
20564 BASE_FACE is the base face of the composition.
20565 S->cmp_from is the index of the first component for S.
20567 OVERLAPS non-zero means S should draw the foreground only, and use
20568 its physical height for clipping. See also draw_glyphs.
20570 Value is the index of a component not in S. */
20573 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20577 /* For all glyphs of this composition, starting at the offset
20578 S->cmp_from, until we reach the end of the definition or encounter a
20579 glyph that requires the different face, add it to S. */
20584 s
->for_overlaps
= overlaps
;
20587 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20589 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20593 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20596 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20603 s
->font
= s
->face
->font
;
20605 else if (s
->face
!= face
)
20613 /* All glyph strings for the same composition has the same width,
20614 i.e. the width set for the first component of the composition. */
20615 s
->width
= s
->first_glyph
->pixel_width
;
20617 /* If the specified font could not be loaded, use the frame's
20618 default font, but record the fact that we couldn't load it in
20619 the glyph string so that we can draw rectangles for the
20620 characters of the glyph string. */
20621 if (s
->font
== NULL
)
20623 s
->font_not_found_p
= 1;
20624 s
->font
= FRAME_FONT (s
->f
);
20627 /* Adjust base line for subscript/superscript text. */
20628 s
->ybase
+= s
->first_glyph
->voffset
;
20630 /* This glyph string must always be drawn with 16-bit functions. */
20637 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20638 int start
, int end
, int overlaps
)
20640 struct glyph
*glyph
, *last
;
20641 Lisp_Object lgstring
;
20644 s
->for_overlaps
= overlaps
;
20645 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20646 last
= s
->row
->glyphs
[s
->area
] + end
;
20647 s
->cmp_id
= glyph
->u
.cmp
.id
;
20648 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20649 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20650 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20651 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20652 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20654 while (glyph
< last
20655 && glyph
->u
.cmp
.automatic
20656 && glyph
->u
.cmp
.id
== s
->cmp_id
20657 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20658 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20660 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20662 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20663 unsigned code
= LGLYPH_CODE (lglyph
);
20665 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20667 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20668 return glyph
- s
->row
->glyphs
[s
->area
];
20672 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20673 See the comment of fill_glyph_string for arguments.
20674 Value is the index of the first glyph not in S. */
20678 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20679 int start
, int end
, int overlaps
)
20681 struct glyph
*glyph
, *last
;
20684 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20685 s
->for_overlaps
= overlaps
;
20686 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20687 last
= s
->row
->glyphs
[s
->area
] + end
;
20688 voffset
= glyph
->voffset
;
20689 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20690 s
->font
= s
->face
->font
;
20692 s
->width
= glyph
->pixel_width
;
20694 while (glyph
< last
20695 && glyph
->type
== GLYPHLESS_GLYPH
20696 && glyph
->voffset
== voffset
20697 && glyph
->face_id
== face_id
)
20700 s
->width
+= glyph
->pixel_width
;
20703 s
->ybase
+= voffset
;
20704 return glyph
- s
->row
->glyphs
[s
->area
];
20708 /* Fill glyph string S from a sequence of character glyphs.
20710 FACE_ID is the face id of the string. START is the index of the
20711 first glyph to consider, END is the index of the last + 1.
20712 OVERLAPS non-zero means S should draw the foreground only, and use
20713 its physical height for clipping. See also draw_glyphs.
20715 Value is the index of the first glyph not in S. */
20718 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20719 int start
, int end
, int overlaps
)
20721 struct glyph
*glyph
, *last
;
20723 int glyph_not_available_p
;
20725 xassert (s
->f
== XFRAME (s
->w
->frame
));
20726 xassert (s
->nchars
== 0);
20727 xassert (start
>= 0 && end
> start
);
20729 s
->for_overlaps
= overlaps
;
20730 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20731 last
= s
->row
->glyphs
[s
->area
] + end
;
20732 voffset
= glyph
->voffset
;
20733 s
->padding_p
= glyph
->padding_p
;
20734 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20736 while (glyph
< last
20737 && glyph
->type
== CHAR_GLYPH
20738 && glyph
->voffset
== voffset
20739 /* Same face id implies same font, nowadays. */
20740 && glyph
->face_id
== face_id
20741 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20745 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20746 s
->char2b
+ s
->nchars
,
20748 s
->two_byte_p
= two_byte_p
;
20750 xassert (s
->nchars
<= end
- start
);
20751 s
->width
+= glyph
->pixel_width
;
20752 if (glyph
++->padding_p
!= s
->padding_p
)
20756 s
->font
= s
->face
->font
;
20758 /* If the specified font could not be loaded, use the frame's font,
20759 but record the fact that we couldn't load it in
20760 S->font_not_found_p so that we can draw rectangles for the
20761 characters of the glyph string. */
20762 if (s
->font
== NULL
|| glyph_not_available_p
)
20764 s
->font_not_found_p
= 1;
20765 s
->font
= FRAME_FONT (s
->f
);
20768 /* Adjust base line for subscript/superscript text. */
20769 s
->ybase
+= voffset
;
20771 xassert (s
->face
&& s
->face
->gc
);
20772 return glyph
- s
->row
->glyphs
[s
->area
];
20776 /* Fill glyph string S from image glyph S->first_glyph. */
20779 fill_image_glyph_string (struct glyph_string
*s
)
20781 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20782 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20784 s
->slice
= s
->first_glyph
->slice
.img
;
20785 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20786 s
->font
= s
->face
->font
;
20787 s
->width
= s
->first_glyph
->pixel_width
;
20789 /* Adjust base line for subscript/superscript text. */
20790 s
->ybase
+= s
->first_glyph
->voffset
;
20794 /* Fill glyph string S from a sequence of stretch glyphs.
20796 START is the index of the first glyph to consider,
20797 END is the index of the last + 1.
20799 Value is the index of the first glyph not in S. */
20802 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20804 struct glyph
*glyph
, *last
;
20805 int voffset
, face_id
;
20807 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20809 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20810 last
= s
->row
->glyphs
[s
->area
] + end
;
20811 face_id
= glyph
->face_id
;
20812 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20813 s
->font
= s
->face
->font
;
20814 s
->width
= glyph
->pixel_width
;
20816 voffset
= glyph
->voffset
;
20820 && glyph
->type
== STRETCH_GLYPH
20821 && glyph
->voffset
== voffset
20822 && glyph
->face_id
== face_id
);
20824 s
->width
+= glyph
->pixel_width
;
20826 /* Adjust base line for subscript/superscript text. */
20827 s
->ybase
+= voffset
;
20829 /* The case that face->gc == 0 is handled when drawing the glyph
20830 string by calling PREPARE_FACE_FOR_DISPLAY. */
20832 return glyph
- s
->row
->glyphs
[s
->area
];
20835 static struct font_metrics
*
20836 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20838 static struct font_metrics metrics
;
20839 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20841 if (! font
|| code
== FONT_INVALID_CODE
)
20843 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20848 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20849 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20850 assumed to be zero. */
20853 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20855 *left
= *right
= 0;
20857 if (glyph
->type
== CHAR_GLYPH
)
20861 struct font_metrics
*pcm
;
20863 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20864 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20866 if (pcm
->rbearing
> pcm
->width
)
20867 *right
= pcm
->rbearing
- pcm
->width
;
20868 if (pcm
->lbearing
< 0)
20869 *left
= -pcm
->lbearing
;
20872 else if (glyph
->type
== COMPOSITE_GLYPH
)
20874 if (! glyph
->u
.cmp
.automatic
)
20876 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20878 if (cmp
->rbearing
> cmp
->pixel_width
)
20879 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20880 if (cmp
->lbearing
< 0)
20881 *left
= - cmp
->lbearing
;
20885 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20886 struct font_metrics metrics
;
20888 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20889 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20890 if (metrics
.rbearing
> metrics
.width
)
20891 *right
= metrics
.rbearing
- metrics
.width
;
20892 if (metrics
.lbearing
< 0)
20893 *left
= - metrics
.lbearing
;
20899 /* Return the index of the first glyph preceding glyph string S that
20900 is overwritten by S because of S's left overhang. Value is -1
20901 if no glyphs are overwritten. */
20904 left_overwritten (struct glyph_string
*s
)
20908 if (s
->left_overhang
)
20911 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20912 int first
= s
->first_glyph
- glyphs
;
20914 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20915 x
-= glyphs
[i
].pixel_width
;
20926 /* Return the index of the first glyph preceding glyph string S that
20927 is overwriting S because of its right overhang. Value is -1 if no
20928 glyph in front of S overwrites S. */
20931 left_overwriting (struct glyph_string
*s
)
20934 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20935 int first
= s
->first_glyph
- glyphs
;
20939 for (i
= first
- 1; i
>= 0; --i
)
20942 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20945 x
-= glyphs
[i
].pixel_width
;
20952 /* Return the index of the last glyph following glyph string S that is
20953 overwritten by S because of S's right overhang. Value is -1 if
20954 no such glyph is found. */
20957 right_overwritten (struct glyph_string
*s
)
20961 if (s
->right_overhang
)
20964 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20965 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20966 int end
= s
->row
->used
[s
->area
];
20968 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20969 x
+= glyphs
[i
].pixel_width
;
20978 /* Return the index of the last glyph following glyph string S that
20979 overwrites S because of its left overhang. Value is negative
20980 if no such glyph is found. */
20983 right_overwriting (struct glyph_string
*s
)
20986 int end
= s
->row
->used
[s
->area
];
20987 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20988 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20992 for (i
= first
; i
< end
; ++i
)
20995 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20998 x
+= glyphs
[i
].pixel_width
;
21005 /* Set background width of glyph string S. START is the index of the
21006 first glyph following S. LAST_X is the right-most x-position + 1
21007 in the drawing area. */
21010 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21012 /* If the face of this glyph string has to be drawn to the end of
21013 the drawing area, set S->extends_to_end_of_line_p. */
21015 if (start
== s
->row
->used
[s
->area
]
21016 && s
->area
== TEXT_AREA
21017 && ((s
->row
->fill_line_p
21018 && (s
->hl
== DRAW_NORMAL_TEXT
21019 || s
->hl
== DRAW_IMAGE_RAISED
21020 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21021 || s
->hl
== DRAW_MOUSE_FACE
))
21022 s
->extends_to_end_of_line_p
= 1;
21024 /* If S extends its face to the end of the line, set its
21025 background_width to the distance to the right edge of the drawing
21027 if (s
->extends_to_end_of_line_p
)
21028 s
->background_width
= last_x
- s
->x
+ 1;
21030 s
->background_width
= s
->width
;
21034 /* Compute overhangs and x-positions for glyph string S and its
21035 predecessors, or successors. X is the starting x-position for S.
21036 BACKWARD_P non-zero means process predecessors. */
21039 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21045 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21046 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21056 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21057 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21067 /* The following macros are only called from draw_glyphs below.
21068 They reference the following parameters of that function directly:
21069 `w', `row', `area', and `overlap_p'
21070 as well as the following local variables:
21071 `s', `f', and `hdc' (in W32) */
21074 /* On W32, silently add local `hdc' variable to argument list of
21075 init_glyph_string. */
21076 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21077 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21079 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21080 init_glyph_string (s, char2b, w, row, area, start, hl)
21083 /* Add a glyph string for a stretch glyph to the list of strings
21084 between HEAD and TAIL. START is the index of the stretch glyph in
21085 row area AREA of glyph row ROW. END is the index of the last glyph
21086 in that glyph row area. X is the current output position assigned
21087 to the new glyph string constructed. HL overrides that face of the
21088 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21089 is the right-most x-position of the drawing area. */
21091 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21092 and below -- keep them on one line. */
21093 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21096 s = (struct glyph_string *) alloca (sizeof *s); \
21097 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21098 START = fill_stretch_glyph_string (s, START, END); \
21099 append_glyph_string (&HEAD, &TAIL, s); \
21105 /* Add a glyph string for an image glyph to the list of strings
21106 between HEAD and TAIL. START is the index of the image glyph in
21107 row area AREA of glyph row ROW. END is the index of the last glyph
21108 in that glyph row area. X is the current output position assigned
21109 to the new glyph string constructed. HL overrides that face of the
21110 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21111 is the right-most x-position of the drawing area. */
21113 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21116 s = (struct glyph_string *) alloca (sizeof *s); \
21117 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21118 fill_image_glyph_string (s); \
21119 append_glyph_string (&HEAD, &TAIL, s); \
21126 /* Add a glyph string for a sequence of character glyphs to the list
21127 of strings between HEAD and TAIL. START is the index of the first
21128 glyph in row area AREA of glyph row ROW that is part of the new
21129 glyph string. END is the index of the last glyph in that glyph row
21130 area. X is the current output position assigned to the new glyph
21131 string constructed. HL overrides that face of the glyph; e.g. it
21132 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21133 right-most x-position of the drawing area. */
21135 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21141 face_id = (row)->glyphs[area][START].face_id; \
21143 s = (struct glyph_string *) alloca (sizeof *s); \
21144 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21145 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21146 append_glyph_string (&HEAD, &TAIL, s); \
21148 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21153 /* Add a glyph string for a composite sequence to the list of strings
21154 between HEAD and TAIL. START is the index of the first glyph in
21155 row area AREA of glyph row ROW that is part of the new glyph
21156 string. END is the index of the last glyph in that glyph row area.
21157 X is the current output position assigned to the new glyph string
21158 constructed. HL overrides that face of the glyph; e.g. it is
21159 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21160 x-position of the drawing area. */
21162 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21164 int face_id = (row)->glyphs[area][START].face_id; \
21165 struct face *base_face = FACE_FROM_ID (f, face_id); \
21166 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21167 struct composition *cmp = composition_table[cmp_id]; \
21169 struct glyph_string *first_s IF_LINT (= NULL); \
21172 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21174 /* Make glyph_strings for each glyph sequence that is drawable by \
21175 the same face, and append them to HEAD/TAIL. */ \
21176 for (n = 0; n < cmp->glyph_len;) \
21178 s = (struct glyph_string *) alloca (sizeof *s); \
21179 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21180 append_glyph_string (&(HEAD), &(TAIL), s); \
21186 n = fill_composite_glyph_string (s, base_face, overlaps); \
21194 /* Add a glyph string for a glyph-string sequence to the list of strings
21195 between HEAD and TAIL. */
21197 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21201 Lisp_Object gstring; \
21203 face_id = (row)->glyphs[area][START].face_id; \
21204 gstring = (composition_gstring_from_id \
21205 ((row)->glyphs[area][START].u.cmp.id)); \
21206 s = (struct glyph_string *) alloca (sizeof *s); \
21207 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21208 * LGSTRING_GLYPH_LEN (gstring)); \
21209 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21210 append_glyph_string (&(HEAD), &(TAIL), s); \
21212 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21216 /* Add a glyph string for a sequence of glyphless character's glyphs
21217 to the list of strings between HEAD and TAIL. The meanings of
21218 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21220 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21225 face_id = (row)->glyphs[area][START].face_id; \
21227 s = (struct glyph_string *) alloca (sizeof *s); \
21228 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21229 append_glyph_string (&HEAD, &TAIL, s); \
21231 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21237 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21238 of AREA of glyph row ROW on window W between indices START and END.
21239 HL overrides the face for drawing glyph strings, e.g. it is
21240 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21241 x-positions of the drawing area.
21243 This is an ugly monster macro construct because we must use alloca
21244 to allocate glyph strings (because draw_glyphs can be called
21245 asynchronously). */
21247 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21250 HEAD = TAIL = NULL; \
21251 while (START < END) \
21253 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21254 switch (first_glyph->type) \
21257 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21261 case COMPOSITE_GLYPH: \
21262 if (first_glyph->u.cmp.automatic) \
21263 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21266 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21270 case STRETCH_GLYPH: \
21271 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21275 case IMAGE_GLYPH: \
21276 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21280 case GLYPHLESS_GLYPH: \
21281 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21291 set_glyph_string_background_width (s, START, LAST_X); \
21298 /* Draw glyphs between START and END in AREA of ROW on window W,
21299 starting at x-position X. X is relative to AREA in W. HL is a
21300 face-override with the following meaning:
21302 DRAW_NORMAL_TEXT draw normally
21303 DRAW_CURSOR draw in cursor face
21304 DRAW_MOUSE_FACE draw in mouse face.
21305 DRAW_INVERSE_VIDEO draw in mode line face
21306 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21307 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21309 If OVERLAPS is non-zero, draw only the foreground of characters and
21310 clip to the physical height of ROW. Non-zero value also defines
21311 the overlapping part to be drawn:
21313 OVERLAPS_PRED overlap with preceding rows
21314 OVERLAPS_SUCC overlap with succeeding rows
21315 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21316 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21318 Value is the x-position reached, relative to AREA of W. */
21321 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21322 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21323 enum draw_glyphs_face hl
, int overlaps
)
21325 struct glyph_string
*head
, *tail
;
21326 struct glyph_string
*s
;
21327 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21328 int i
, j
, x_reached
, last_x
, area_left
= 0;
21329 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21332 ALLOCATE_HDC (hdc
, f
);
21334 /* Let's rather be paranoid than getting a SEGV. */
21335 end
= min (end
, row
->used
[area
]);
21336 start
= max (0, start
);
21337 start
= min (end
, start
);
21339 /* Translate X to frame coordinates. Set last_x to the right
21340 end of the drawing area. */
21341 if (row
->full_width_p
)
21343 /* X is relative to the left edge of W, without scroll bars
21345 area_left
= WINDOW_LEFT_EDGE_X (w
);
21346 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21350 area_left
= window_box_left (w
, area
);
21351 last_x
= area_left
+ window_box_width (w
, area
);
21355 /* Build a doubly-linked list of glyph_string structures between
21356 head and tail from what we have to draw. Note that the macro
21357 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21358 the reason we use a separate variable `i'. */
21360 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21362 x_reached
= tail
->x
+ tail
->background_width
;
21366 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21367 the row, redraw some glyphs in front or following the glyph
21368 strings built above. */
21369 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21371 struct glyph_string
*h
, *t
;
21372 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21373 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21374 int check_mouse_face
= 0;
21377 /* If mouse highlighting is on, we may need to draw adjacent
21378 glyphs using mouse-face highlighting. */
21379 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21381 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21383 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21384 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21386 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21388 check_mouse_face
= 1;
21389 mouse_beg_col
= (row
== mouse_beg_row
)
21390 ? hlinfo
->mouse_face_beg_col
: 0;
21391 mouse_end_col
= (row
== mouse_end_row
)
21392 ? hlinfo
->mouse_face_end_col
21393 : row
->used
[TEXT_AREA
];
21397 /* Compute overhangs for all glyph strings. */
21398 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21399 for (s
= head
; s
; s
= s
->next
)
21400 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21402 /* Prepend glyph strings for glyphs in front of the first glyph
21403 string that are overwritten because of the first glyph
21404 string's left overhang. The background of all strings
21405 prepended must be drawn because the first glyph string
21407 i
= left_overwritten (head
);
21410 enum draw_glyphs_face overlap_hl
;
21412 /* If this row contains mouse highlighting, attempt to draw
21413 the overlapped glyphs with the correct highlight. This
21414 code fails if the overlap encompasses more than one glyph
21415 and mouse-highlight spans only some of these glyphs.
21416 However, making it work perfectly involves a lot more
21417 code, and I don't know if the pathological case occurs in
21418 practice, so we'll stick to this for now. --- cyd */
21419 if (check_mouse_face
21420 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21421 overlap_hl
= DRAW_MOUSE_FACE
;
21423 overlap_hl
= DRAW_NORMAL_TEXT
;
21426 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21427 overlap_hl
, dummy_x
, last_x
);
21429 compute_overhangs_and_x (t
, head
->x
, 1);
21430 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21434 /* Prepend glyph strings for glyphs in front of the first glyph
21435 string that overwrite that glyph string because of their
21436 right overhang. For these strings, only the foreground must
21437 be drawn, because it draws over the glyph string at `head'.
21438 The background must not be drawn because this would overwrite
21439 right overhangs of preceding glyphs for which no glyph
21441 i
= left_overwriting (head
);
21444 enum draw_glyphs_face overlap_hl
;
21446 if (check_mouse_face
21447 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21448 overlap_hl
= DRAW_MOUSE_FACE
;
21450 overlap_hl
= DRAW_NORMAL_TEXT
;
21453 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21454 overlap_hl
, dummy_x
, last_x
);
21455 for (s
= h
; s
; s
= s
->next
)
21456 s
->background_filled_p
= 1;
21457 compute_overhangs_and_x (t
, head
->x
, 1);
21458 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21461 /* Append glyphs strings for glyphs following the last glyph
21462 string tail that are overwritten by tail. The background of
21463 these strings has to be drawn because tail's foreground draws
21465 i
= right_overwritten (tail
);
21468 enum draw_glyphs_face overlap_hl
;
21470 if (check_mouse_face
21471 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21472 overlap_hl
= DRAW_MOUSE_FACE
;
21474 overlap_hl
= DRAW_NORMAL_TEXT
;
21476 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21477 overlap_hl
, x
, last_x
);
21478 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21479 we don't have `end = i;' here. */
21480 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21481 append_glyph_string_lists (&head
, &tail
, h
, t
);
21485 /* Append glyph strings for glyphs following the last glyph
21486 string tail that overwrite tail. The foreground of such
21487 glyphs has to be drawn because it writes into the background
21488 of tail. The background must not be drawn because it could
21489 paint over the foreground of following glyphs. */
21490 i
= right_overwriting (tail
);
21493 enum draw_glyphs_face overlap_hl
;
21494 if (check_mouse_face
21495 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21496 overlap_hl
= DRAW_MOUSE_FACE
;
21498 overlap_hl
= DRAW_NORMAL_TEXT
;
21501 i
++; /* We must include the Ith glyph. */
21502 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21503 overlap_hl
, x
, last_x
);
21504 for (s
= h
; s
; s
= s
->next
)
21505 s
->background_filled_p
= 1;
21506 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21507 append_glyph_string_lists (&head
, &tail
, h
, t
);
21509 if (clip_head
|| clip_tail
)
21510 for (s
= head
; s
; s
= s
->next
)
21512 s
->clip_head
= clip_head
;
21513 s
->clip_tail
= clip_tail
;
21517 /* Draw all strings. */
21518 for (s
= head
; s
; s
= s
->next
)
21519 FRAME_RIF (f
)->draw_glyph_string (s
);
21522 /* When focus a sole frame and move horizontally, this sets on_p to 0
21523 causing a failure to erase prev cursor position. */
21524 if (area
== TEXT_AREA
21525 && !row
->full_width_p
21526 /* When drawing overlapping rows, only the glyph strings'
21527 foreground is drawn, which doesn't erase a cursor
21531 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21532 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21533 : (tail
? tail
->x
+ tail
->background_width
: x
));
21537 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21538 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21542 /* Value is the x-position up to which drawn, relative to AREA of W.
21543 This doesn't include parts drawn because of overhangs. */
21544 if (row
->full_width_p
)
21545 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21547 x_reached
-= area_left
;
21549 RELEASE_HDC (hdc
, f
);
21554 /* Expand row matrix if too narrow. Don't expand if area
21557 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21559 if (!fonts_changed_p \
21560 && (it->glyph_row->glyphs[area] \
21561 < it->glyph_row->glyphs[area + 1])) \
21563 it->w->ncols_scale_factor++; \
21564 fonts_changed_p = 1; \
21568 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21569 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21572 append_glyph (struct it
*it
)
21574 struct glyph
*glyph
;
21575 enum glyph_row_area area
= it
->area
;
21577 xassert (it
->glyph_row
);
21578 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21580 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21581 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21583 /* If the glyph row is reversed, we need to prepend the glyph
21584 rather than append it. */
21585 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21589 /* Make room for the additional glyph. */
21590 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21592 glyph
= it
->glyph_row
->glyphs
[area
];
21594 glyph
->charpos
= CHARPOS (it
->position
);
21595 glyph
->object
= it
->object
;
21596 if (it
->pixel_width
> 0)
21598 glyph
->pixel_width
= it
->pixel_width
;
21599 glyph
->padding_p
= 0;
21603 /* Assure at least 1-pixel width. Otherwise, cursor can't
21604 be displayed correctly. */
21605 glyph
->pixel_width
= 1;
21606 glyph
->padding_p
= 1;
21608 glyph
->ascent
= it
->ascent
;
21609 glyph
->descent
= it
->descent
;
21610 glyph
->voffset
= it
->voffset
;
21611 glyph
->type
= CHAR_GLYPH
;
21612 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21613 glyph
->multibyte_p
= it
->multibyte_p
;
21614 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21615 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21616 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21617 || it
->phys_descent
> it
->descent
);
21618 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21619 glyph
->face_id
= it
->face_id
;
21620 glyph
->u
.ch
= it
->char_to_display
;
21621 glyph
->slice
.img
= null_glyph_slice
;
21622 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21625 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21626 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21628 glyph
->bidi_type
= it
->bidi_it
.type
;
21632 glyph
->resolved_level
= 0;
21633 glyph
->bidi_type
= UNKNOWN_BT
;
21635 ++it
->glyph_row
->used
[area
];
21638 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21641 /* Store one glyph for the composition IT->cmp_it.id in
21642 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21646 append_composite_glyph (struct it
*it
)
21648 struct glyph
*glyph
;
21649 enum glyph_row_area area
= it
->area
;
21651 xassert (it
->glyph_row
);
21653 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21654 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21656 /* If the glyph row is reversed, we need to prepend the glyph
21657 rather than append it. */
21658 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21662 /* Make room for the new glyph. */
21663 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21665 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21667 glyph
->charpos
= it
->cmp_it
.charpos
;
21668 glyph
->object
= it
->object
;
21669 glyph
->pixel_width
= it
->pixel_width
;
21670 glyph
->ascent
= it
->ascent
;
21671 glyph
->descent
= it
->descent
;
21672 glyph
->voffset
= it
->voffset
;
21673 glyph
->type
= COMPOSITE_GLYPH
;
21674 if (it
->cmp_it
.ch
< 0)
21676 glyph
->u
.cmp
.automatic
= 0;
21677 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21678 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21682 glyph
->u
.cmp
.automatic
= 1;
21683 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21684 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21685 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21687 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21688 glyph
->multibyte_p
= it
->multibyte_p
;
21689 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21690 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21691 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21692 || it
->phys_descent
> it
->descent
);
21693 glyph
->padding_p
= 0;
21694 glyph
->glyph_not_available_p
= 0;
21695 glyph
->face_id
= it
->face_id
;
21696 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21699 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21700 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21702 glyph
->bidi_type
= it
->bidi_it
.type
;
21704 ++it
->glyph_row
->used
[area
];
21707 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21711 /* Change IT->ascent and IT->height according to the setting of
21715 take_vertical_position_into_account (struct it
*it
)
21719 if (it
->voffset
< 0)
21720 /* Increase the ascent so that we can display the text higher
21722 it
->ascent
-= it
->voffset
;
21724 /* Increase the descent so that we can display the text lower
21726 it
->descent
+= it
->voffset
;
21731 /* Produce glyphs/get display metrics for the image IT is loaded with.
21732 See the description of struct display_iterator in dispextern.h for
21733 an overview of struct display_iterator. */
21736 produce_image_glyph (struct it
*it
)
21740 int glyph_ascent
, crop
;
21741 struct glyph_slice slice
;
21743 xassert (it
->what
== IT_IMAGE
);
21745 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21747 /* Make sure X resources of the face is loaded. */
21748 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21750 if (it
->image_id
< 0)
21752 /* Fringe bitmap. */
21753 it
->ascent
= it
->phys_ascent
= 0;
21754 it
->descent
= it
->phys_descent
= 0;
21755 it
->pixel_width
= 0;
21760 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21762 /* Make sure X resources of the image is loaded. */
21763 prepare_image_for_display (it
->f
, img
);
21765 slice
.x
= slice
.y
= 0;
21766 slice
.width
= img
->width
;
21767 slice
.height
= img
->height
;
21769 if (INTEGERP (it
->slice
.x
))
21770 slice
.x
= XINT (it
->slice
.x
);
21771 else if (FLOATP (it
->slice
.x
))
21772 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21774 if (INTEGERP (it
->slice
.y
))
21775 slice
.y
= XINT (it
->slice
.y
);
21776 else if (FLOATP (it
->slice
.y
))
21777 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21779 if (INTEGERP (it
->slice
.width
))
21780 slice
.width
= XINT (it
->slice
.width
);
21781 else if (FLOATP (it
->slice
.width
))
21782 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21784 if (INTEGERP (it
->slice
.height
))
21785 slice
.height
= XINT (it
->slice
.height
);
21786 else if (FLOATP (it
->slice
.height
))
21787 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21789 if (slice
.x
>= img
->width
)
21790 slice
.x
= img
->width
;
21791 if (slice
.y
>= img
->height
)
21792 slice
.y
= img
->height
;
21793 if (slice
.x
+ slice
.width
>= img
->width
)
21794 slice
.width
= img
->width
- slice
.x
;
21795 if (slice
.y
+ slice
.height
> img
->height
)
21796 slice
.height
= img
->height
- slice
.y
;
21798 if (slice
.width
== 0 || slice
.height
== 0)
21801 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21803 it
->descent
= slice
.height
- glyph_ascent
;
21805 it
->descent
+= img
->vmargin
;
21806 if (slice
.y
+ slice
.height
== img
->height
)
21807 it
->descent
+= img
->vmargin
;
21808 it
->phys_descent
= it
->descent
;
21810 it
->pixel_width
= slice
.width
;
21812 it
->pixel_width
+= img
->hmargin
;
21813 if (slice
.x
+ slice
.width
== img
->width
)
21814 it
->pixel_width
+= img
->hmargin
;
21816 /* It's quite possible for images to have an ascent greater than
21817 their height, so don't get confused in that case. */
21818 if (it
->descent
< 0)
21823 if (face
->box
!= FACE_NO_BOX
)
21825 if (face
->box_line_width
> 0)
21828 it
->ascent
+= face
->box_line_width
;
21829 if (slice
.y
+ slice
.height
== img
->height
)
21830 it
->descent
+= face
->box_line_width
;
21833 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21834 it
->pixel_width
+= eabs (face
->box_line_width
);
21835 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21836 it
->pixel_width
+= eabs (face
->box_line_width
);
21839 take_vertical_position_into_account (it
);
21841 /* Automatically crop wide image glyphs at right edge so we can
21842 draw the cursor on same display row. */
21843 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21844 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21846 it
->pixel_width
-= crop
;
21847 slice
.width
-= crop
;
21852 struct glyph
*glyph
;
21853 enum glyph_row_area area
= it
->area
;
21855 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21856 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21858 glyph
->charpos
= CHARPOS (it
->position
);
21859 glyph
->object
= it
->object
;
21860 glyph
->pixel_width
= it
->pixel_width
;
21861 glyph
->ascent
= glyph_ascent
;
21862 glyph
->descent
= it
->descent
;
21863 glyph
->voffset
= it
->voffset
;
21864 glyph
->type
= IMAGE_GLYPH
;
21865 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21866 glyph
->multibyte_p
= it
->multibyte_p
;
21867 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21868 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21869 glyph
->overlaps_vertically_p
= 0;
21870 glyph
->padding_p
= 0;
21871 glyph
->glyph_not_available_p
= 0;
21872 glyph
->face_id
= it
->face_id
;
21873 glyph
->u
.img_id
= img
->id
;
21874 glyph
->slice
.img
= slice
;
21875 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21878 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21879 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21881 glyph
->bidi_type
= it
->bidi_it
.type
;
21883 ++it
->glyph_row
->used
[area
];
21886 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21891 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21892 of the glyph, WIDTH and HEIGHT are the width and height of the
21893 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21896 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21897 int width
, int height
, int ascent
)
21899 struct glyph
*glyph
;
21900 enum glyph_row_area area
= it
->area
;
21902 xassert (ascent
>= 0 && ascent
<= height
);
21904 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21905 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21907 /* If the glyph row is reversed, we need to prepend the glyph
21908 rather than append it. */
21909 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21913 /* Make room for the additional glyph. */
21914 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21916 glyph
= it
->glyph_row
->glyphs
[area
];
21918 glyph
->charpos
= CHARPOS (it
->position
);
21919 glyph
->object
= object
;
21920 glyph
->pixel_width
= width
;
21921 glyph
->ascent
= ascent
;
21922 glyph
->descent
= height
- ascent
;
21923 glyph
->voffset
= it
->voffset
;
21924 glyph
->type
= STRETCH_GLYPH
;
21925 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21926 glyph
->multibyte_p
= it
->multibyte_p
;
21927 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21928 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21929 glyph
->overlaps_vertically_p
= 0;
21930 glyph
->padding_p
= 0;
21931 glyph
->glyph_not_available_p
= 0;
21932 glyph
->face_id
= it
->face_id
;
21933 glyph
->u
.stretch
.ascent
= ascent
;
21934 glyph
->u
.stretch
.height
= height
;
21935 glyph
->slice
.img
= null_glyph_slice
;
21936 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21939 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21940 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21942 glyph
->bidi_type
= it
->bidi_it
.type
;
21946 glyph
->resolved_level
= 0;
21947 glyph
->bidi_type
= UNKNOWN_BT
;
21949 ++it
->glyph_row
->used
[area
];
21952 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21956 /* Produce a stretch glyph for iterator IT. IT->object is the value
21957 of the glyph property displayed. The value must be a list
21958 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21961 1. `:width WIDTH' specifies that the space should be WIDTH *
21962 canonical char width wide. WIDTH may be an integer or floating
21965 2. `:relative-width FACTOR' specifies that the width of the stretch
21966 should be computed from the width of the first character having the
21967 `glyph' property, and should be FACTOR times that width.
21969 3. `:align-to HPOS' specifies that the space should be wide enough
21970 to reach HPOS, a value in canonical character units.
21972 Exactly one of the above pairs must be present.
21974 4. `:height HEIGHT' specifies that the height of the stretch produced
21975 should be HEIGHT, measured in canonical character units.
21977 5. `:relative-height FACTOR' specifies that the height of the
21978 stretch should be FACTOR times the height of the characters having
21979 the glyph property.
21981 Either none or exactly one of 4 or 5 must be present.
21983 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21984 of the stretch should be used for the ascent of the stretch.
21985 ASCENT must be in the range 0 <= ASCENT <= 100. */
21988 produce_stretch_glyph (struct it
*it
)
21990 /* (space :width WIDTH :height HEIGHT ...) */
21991 Lisp_Object prop
, plist
;
21992 int width
= 0, height
= 0, align_to
= -1;
21993 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21996 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21997 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21999 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22001 /* List should start with `space'. */
22002 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22003 plist
= XCDR (it
->object
);
22005 /* Compute the width of the stretch. */
22006 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22007 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22009 /* Absolute width `:width WIDTH' specified and valid. */
22010 zero_width_ok_p
= 1;
22013 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22016 /* Relative width `:relative-width FACTOR' specified and valid.
22017 Compute the width of the characters having the `glyph'
22020 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22023 if (it
->multibyte_p
)
22024 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22027 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22028 if (! ASCII_CHAR_P (it2
.c
))
22029 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22032 it2
.glyph_row
= NULL
;
22033 it2
.what
= IT_CHARACTER
;
22034 x_produce_glyphs (&it2
);
22035 width
= NUMVAL (prop
) * it2
.pixel_width
;
22037 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22038 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22040 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22041 align_to
= (align_to
< 0
22043 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22044 else if (align_to
< 0)
22045 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22046 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22047 zero_width_ok_p
= 1;
22050 /* Nothing specified -> width defaults to canonical char width. */
22051 width
= FRAME_COLUMN_WIDTH (it
->f
);
22053 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22056 /* Compute height. */
22057 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22058 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22061 zero_height_ok_p
= 1;
22063 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22065 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22067 height
= FONT_HEIGHT (font
);
22069 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22072 /* Compute percentage of height used for ascent. If
22073 `:ascent ASCENT' is present and valid, use that. Otherwise,
22074 derive the ascent from the font in use. */
22075 if (prop
= Fplist_get (plist
, QCascent
),
22076 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22077 ascent
= height
* NUMVAL (prop
) / 100.0;
22078 else if (!NILP (prop
)
22079 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22080 ascent
= min (max (0, (int)tem
), height
);
22082 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22084 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22085 && it
->current_x
+ width
> it
->last_visible_x
)
22086 width
= it
->last_visible_x
- it
->current_x
- 1;
22088 if (width
> 0 && height
> 0 && it
->glyph_row
)
22090 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22091 if (!STRINGP (object
))
22092 object
= it
->w
->buffer
;
22093 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22096 it
->pixel_width
= width
;
22097 it
->ascent
= it
->phys_ascent
= ascent
;
22098 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22099 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22101 take_vertical_position_into_account (it
);
22104 /* Calculate line-height and line-spacing properties.
22105 An integer value specifies explicit pixel value.
22106 A float value specifies relative value to current face height.
22107 A cons (float . face-name) specifies relative value to
22108 height of specified face font.
22110 Returns height in pixels, or nil. */
22114 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22115 int boff
, int override
)
22117 Lisp_Object face_name
= Qnil
;
22118 int ascent
, descent
, height
;
22120 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22125 face_name
= XCAR (val
);
22127 if (!NUMBERP (val
))
22128 val
= make_number (1);
22129 if (NILP (face_name
))
22131 height
= it
->ascent
+ it
->descent
;
22136 if (NILP (face_name
))
22138 font
= FRAME_FONT (it
->f
);
22139 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22141 else if (EQ (face_name
, Qt
))
22150 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22152 return make_number (-1);
22154 face
= FACE_FROM_ID (it
->f
, face_id
);
22157 return make_number (-1);
22158 boff
= font
->baseline_offset
;
22159 if (font
->vertical_centering
)
22160 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22163 ascent
= FONT_BASE (font
) + boff
;
22164 descent
= FONT_DESCENT (font
) - boff
;
22168 it
->override_ascent
= ascent
;
22169 it
->override_descent
= descent
;
22170 it
->override_boff
= boff
;
22173 height
= ascent
+ descent
;
22177 height
= (int)(XFLOAT_DATA (val
) * height
);
22178 else if (INTEGERP (val
))
22179 height
*= XINT (val
);
22181 return make_number (height
);
22185 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22186 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22187 and only if this is for a character for which no font was found.
22189 If the display method (it->glyphless_method) is
22190 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22191 length of the acronym or the hexadecimal string, UPPER_XOFF and
22192 UPPER_YOFF are pixel offsets for the upper part of the string,
22193 LOWER_XOFF and LOWER_YOFF are for the lower part.
22195 For the other display methods, LEN through LOWER_YOFF are zero. */
22198 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22199 short upper_xoff
, short upper_yoff
,
22200 short lower_xoff
, short lower_yoff
)
22202 struct glyph
*glyph
;
22203 enum glyph_row_area area
= it
->area
;
22205 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22206 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22208 /* If the glyph row is reversed, we need to prepend the glyph
22209 rather than append it. */
22210 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22214 /* Make room for the additional glyph. */
22215 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22217 glyph
= it
->glyph_row
->glyphs
[area
];
22219 glyph
->charpos
= CHARPOS (it
->position
);
22220 glyph
->object
= it
->object
;
22221 glyph
->pixel_width
= it
->pixel_width
;
22222 glyph
->ascent
= it
->ascent
;
22223 glyph
->descent
= it
->descent
;
22224 glyph
->voffset
= it
->voffset
;
22225 glyph
->type
= GLYPHLESS_GLYPH
;
22226 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22227 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22228 glyph
->u
.glyphless
.len
= len
;
22229 glyph
->u
.glyphless
.ch
= it
->c
;
22230 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22231 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22232 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22233 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22234 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22235 glyph
->multibyte_p
= it
->multibyte_p
;
22236 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22237 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22238 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22239 || it
->phys_descent
> it
->descent
);
22240 glyph
->padding_p
= 0;
22241 glyph
->glyph_not_available_p
= 0;
22242 glyph
->face_id
= face_id
;
22243 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22246 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22247 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22249 glyph
->bidi_type
= it
->bidi_it
.type
;
22251 ++it
->glyph_row
->used
[area
];
22254 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22258 /* Produce a glyph for a glyphless character for iterator IT.
22259 IT->glyphless_method specifies which method to use for displaying
22260 the character. See the description of enum
22261 glyphless_display_method in dispextern.h for the detail.
22263 FOR_NO_FONT is nonzero if and only if this is for a character for
22264 which no font was found. ACRONYM, if non-nil, is an acronym string
22265 for the character. */
22268 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22273 int base_width
, base_height
, width
, height
;
22274 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22277 /* Get the metrics of the base font. We always refer to the current
22279 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22280 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22281 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22282 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22283 base_height
= it
->ascent
+ it
->descent
;
22284 base_width
= font
->average_width
;
22286 /* Get a face ID for the glyph by utilizing a cache (the same way as
22287 doen for `escape-glyph' in get_next_display_element). */
22288 if (it
->f
== last_glyphless_glyph_frame
22289 && it
->face_id
== last_glyphless_glyph_face_id
)
22291 face_id
= last_glyphless_glyph_merged_face_id
;
22295 /* Merge the `glyphless-char' face into the current face. */
22296 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22297 last_glyphless_glyph_frame
= it
->f
;
22298 last_glyphless_glyph_face_id
= it
->face_id
;
22299 last_glyphless_glyph_merged_face_id
= face_id
;
22302 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22304 it
->pixel_width
= THIN_SPACE_WIDTH
;
22306 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22308 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22310 width
= CHAR_WIDTH (it
->c
);
22313 else if (width
> 4)
22315 it
->pixel_width
= base_width
* width
;
22317 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22323 unsigned int code
[6];
22325 int ascent
, descent
;
22326 struct font_metrics metrics_upper
, metrics_lower
;
22328 face
= FACE_FROM_ID (it
->f
, face_id
);
22329 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22330 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22332 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22334 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22335 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22336 if (CONSP (acronym
))
22337 acronym
= XCAR (acronym
);
22338 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22342 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22343 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22346 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22347 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22348 upper_len
= (len
+ 1) / 2;
22349 font
->driver
->text_extents (font
, code
, upper_len
,
22351 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22356 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22357 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22358 upper_xoff
= upper_yoff
= 2; /* the typical case */
22359 if (base_width
>= width
)
22361 /* Align the upper to the left, the lower to the right. */
22362 it
->pixel_width
= base_width
;
22363 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22367 /* Center the shorter one. */
22368 it
->pixel_width
= width
;
22369 if (metrics_upper
.width
>= metrics_lower
.width
)
22370 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22373 /* FIXME: This code doesn't look right. It formerly was
22374 missing the "lower_xoff = 0;", which couldn't have
22375 been right since it left lower_xoff uninitialized. */
22377 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22381 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22382 top, bottom, and between upper and lower strings. */
22383 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22384 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22385 /* Center vertically.
22386 H:base_height, D:base_descent
22387 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22389 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22390 descent = D - H/2 + h/2;
22391 lower_yoff = descent - 2 - ld;
22392 upper_yoff = lower_yoff - la - 1 - ud; */
22393 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22394 descent
= it
->descent
- (base_height
- height
) / 2;
22395 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22396 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22397 - metrics_upper
.descent
);
22398 /* Don't make the height shorter than the base height. */
22399 if (height
> base_height
)
22401 it
->ascent
= ascent
;
22402 it
->descent
= descent
;
22406 it
->phys_ascent
= it
->ascent
;
22407 it
->phys_descent
= it
->descent
;
22409 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22410 upper_xoff
, upper_yoff
,
22411 lower_xoff
, lower_yoff
);
22413 take_vertical_position_into_account (it
);
22418 Produce glyphs/get display metrics for the display element IT is
22419 loaded with. See the description of struct it in dispextern.h
22420 for an overview of struct it. */
22423 x_produce_glyphs (struct it
*it
)
22425 int extra_line_spacing
= it
->extra_line_spacing
;
22427 it
->glyph_not_available_p
= 0;
22429 if (it
->what
== IT_CHARACTER
)
22432 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22433 struct font
*font
= face
->font
;
22434 struct font_metrics
*pcm
= NULL
;
22435 int boff
; /* baseline offset */
22439 /* When no suitable font is found, display this character by
22440 the method specified in the first extra slot of
22441 Vglyphless_char_display. */
22442 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22444 xassert (it
->what
== IT_GLYPHLESS
);
22445 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22449 boff
= font
->baseline_offset
;
22450 if (font
->vertical_centering
)
22451 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22453 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22459 if (it
->override_ascent
>= 0)
22461 it
->ascent
= it
->override_ascent
;
22462 it
->descent
= it
->override_descent
;
22463 boff
= it
->override_boff
;
22467 it
->ascent
= FONT_BASE (font
) + boff
;
22468 it
->descent
= FONT_DESCENT (font
) - boff
;
22471 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22473 pcm
= get_per_char_metric (font
, &char2b
);
22474 if (pcm
->width
== 0
22475 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22481 it
->phys_ascent
= pcm
->ascent
+ boff
;
22482 it
->phys_descent
= pcm
->descent
- boff
;
22483 it
->pixel_width
= pcm
->width
;
22487 it
->glyph_not_available_p
= 1;
22488 it
->phys_ascent
= it
->ascent
;
22489 it
->phys_descent
= it
->descent
;
22490 it
->pixel_width
= font
->space_width
;
22493 if (it
->constrain_row_ascent_descent_p
)
22495 if (it
->descent
> it
->max_descent
)
22497 it
->ascent
+= it
->descent
- it
->max_descent
;
22498 it
->descent
= it
->max_descent
;
22500 if (it
->ascent
> it
->max_ascent
)
22502 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22503 it
->ascent
= it
->max_ascent
;
22505 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22506 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22507 extra_line_spacing
= 0;
22510 /* If this is a space inside a region of text with
22511 `space-width' property, change its width. */
22512 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22514 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22516 /* If face has a box, add the box thickness to the character
22517 height. If character has a box line to the left and/or
22518 right, add the box line width to the character's width. */
22519 if (face
->box
!= FACE_NO_BOX
)
22521 int thick
= face
->box_line_width
;
22525 it
->ascent
+= thick
;
22526 it
->descent
+= thick
;
22531 if (it
->start_of_box_run_p
)
22532 it
->pixel_width
+= thick
;
22533 if (it
->end_of_box_run_p
)
22534 it
->pixel_width
+= thick
;
22537 /* If face has an overline, add the height of the overline
22538 (1 pixel) and a 1 pixel margin to the character height. */
22539 if (face
->overline_p
)
22540 it
->ascent
+= overline_margin
;
22542 if (it
->constrain_row_ascent_descent_p
)
22544 if (it
->ascent
> it
->max_ascent
)
22545 it
->ascent
= it
->max_ascent
;
22546 if (it
->descent
> it
->max_descent
)
22547 it
->descent
= it
->max_descent
;
22550 take_vertical_position_into_account (it
);
22552 /* If we have to actually produce glyphs, do it. */
22557 /* Translate a space with a `space-width' property
22558 into a stretch glyph. */
22559 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22560 / FONT_HEIGHT (font
));
22561 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22562 it
->ascent
+ it
->descent
, ascent
);
22567 /* If characters with lbearing or rbearing are displayed
22568 in this line, record that fact in a flag of the
22569 glyph row. This is used to optimize X output code. */
22570 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22571 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22573 if (! stretched_p
&& it
->pixel_width
== 0)
22574 /* We assure that all visible glyphs have at least 1-pixel
22576 it
->pixel_width
= 1;
22578 else if (it
->char_to_display
== '\n')
22580 /* A newline has no width, but we need the height of the
22581 line. But if previous part of the line sets a height,
22582 don't increase that height */
22584 Lisp_Object height
;
22585 Lisp_Object total_height
= Qnil
;
22587 it
->override_ascent
= -1;
22588 it
->pixel_width
= 0;
22591 height
= get_it_property (it
, Qline_height
);
22592 /* Split (line-height total-height) list */
22594 && CONSP (XCDR (height
))
22595 && NILP (XCDR (XCDR (height
))))
22597 total_height
= XCAR (XCDR (height
));
22598 height
= XCAR (height
);
22600 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22602 if (it
->override_ascent
>= 0)
22604 it
->ascent
= it
->override_ascent
;
22605 it
->descent
= it
->override_descent
;
22606 boff
= it
->override_boff
;
22610 it
->ascent
= FONT_BASE (font
) + boff
;
22611 it
->descent
= FONT_DESCENT (font
) - boff
;
22614 if (EQ (height
, Qt
))
22616 if (it
->descent
> it
->max_descent
)
22618 it
->ascent
+= it
->descent
- it
->max_descent
;
22619 it
->descent
= it
->max_descent
;
22621 if (it
->ascent
> it
->max_ascent
)
22623 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22624 it
->ascent
= it
->max_ascent
;
22626 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22627 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22628 it
->constrain_row_ascent_descent_p
= 1;
22629 extra_line_spacing
= 0;
22633 Lisp_Object spacing
;
22635 it
->phys_ascent
= it
->ascent
;
22636 it
->phys_descent
= it
->descent
;
22638 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22639 && face
->box
!= FACE_NO_BOX
22640 && face
->box_line_width
> 0)
22642 it
->ascent
+= face
->box_line_width
;
22643 it
->descent
+= face
->box_line_width
;
22646 && XINT (height
) > it
->ascent
+ it
->descent
)
22647 it
->ascent
= XINT (height
) - it
->descent
;
22649 if (!NILP (total_height
))
22650 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22653 spacing
= get_it_property (it
, Qline_spacing
);
22654 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22656 if (INTEGERP (spacing
))
22658 extra_line_spacing
= XINT (spacing
);
22659 if (!NILP (total_height
))
22660 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22664 else /* i.e. (it->char_to_display == '\t') */
22666 if (font
->space_width
> 0)
22668 int tab_width
= it
->tab_width
* font
->space_width
;
22669 int x
= it
->current_x
+ it
->continuation_lines_width
;
22670 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22672 /* If the distance from the current position to the next tab
22673 stop is less than a space character width, use the
22674 tab stop after that. */
22675 if (next_tab_x
- x
< font
->space_width
)
22676 next_tab_x
+= tab_width
;
22678 it
->pixel_width
= next_tab_x
- x
;
22680 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22681 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22685 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22686 it
->ascent
+ it
->descent
, it
->ascent
);
22691 it
->pixel_width
= 0;
22696 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22698 /* A static composition.
22700 Note: A composition is represented as one glyph in the
22701 glyph matrix. There are no padding glyphs.
22703 Important note: pixel_width, ascent, and descent are the
22704 values of what is drawn by draw_glyphs (i.e. the values of
22705 the overall glyphs composed). */
22706 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22707 int boff
; /* baseline offset */
22708 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22709 int glyph_len
= cmp
->glyph_len
;
22710 struct font
*font
= face
->font
;
22714 /* If we have not yet calculated pixel size data of glyphs of
22715 the composition for the current face font, calculate them
22716 now. Theoretically, we have to check all fonts for the
22717 glyphs, but that requires much time and memory space. So,
22718 here we check only the font of the first glyph. This may
22719 lead to incorrect display, but it's very rare, and C-l
22720 (recenter-top-bottom) can correct the display anyway. */
22721 if (! cmp
->font
|| cmp
->font
!= font
)
22723 /* Ascent and descent of the font of the first character
22724 of this composition (adjusted by baseline offset).
22725 Ascent and descent of overall glyphs should not be less
22726 than these, respectively. */
22727 int font_ascent
, font_descent
, font_height
;
22728 /* Bounding box of the overall glyphs. */
22729 int leftmost
, rightmost
, lowest
, highest
;
22730 int lbearing
, rbearing
;
22731 int i
, width
, ascent
, descent
;
22732 int left_padded
= 0, right_padded
= 0;
22733 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22735 struct font_metrics
*pcm
;
22736 int font_not_found_p
;
22739 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22740 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22742 if (glyph_len
< cmp
->glyph_len
)
22744 for (i
= 0; i
< glyph_len
; i
++)
22746 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22748 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22753 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22754 : IT_CHARPOS (*it
));
22755 /* If no suitable font is found, use the default font. */
22756 font_not_found_p
= font
== NULL
;
22757 if (font_not_found_p
)
22759 face
= face
->ascii_face
;
22762 boff
= font
->baseline_offset
;
22763 if (font
->vertical_centering
)
22764 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22765 font_ascent
= FONT_BASE (font
) + boff
;
22766 font_descent
= FONT_DESCENT (font
) - boff
;
22767 font_height
= FONT_HEIGHT (font
);
22769 cmp
->font
= (void *) font
;
22772 if (! font_not_found_p
)
22774 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22776 pcm
= get_per_char_metric (font
, &char2b
);
22779 /* Initialize the bounding box. */
22782 width
= pcm
->width
;
22783 ascent
= pcm
->ascent
;
22784 descent
= pcm
->descent
;
22785 lbearing
= pcm
->lbearing
;
22786 rbearing
= pcm
->rbearing
;
22790 width
= font
->space_width
;
22791 ascent
= FONT_BASE (font
);
22792 descent
= FONT_DESCENT (font
);
22799 lowest
= - descent
+ boff
;
22800 highest
= ascent
+ boff
;
22802 if (! font_not_found_p
22803 && font
->default_ascent
22804 && CHAR_TABLE_P (Vuse_default_ascent
)
22805 && !NILP (Faref (Vuse_default_ascent
,
22806 make_number (it
->char_to_display
))))
22807 highest
= font
->default_ascent
+ boff
;
22809 /* Draw the first glyph at the normal position. It may be
22810 shifted to right later if some other glyphs are drawn
22812 cmp
->offsets
[i
* 2] = 0;
22813 cmp
->offsets
[i
* 2 + 1] = boff
;
22814 cmp
->lbearing
= lbearing
;
22815 cmp
->rbearing
= rbearing
;
22817 /* Set cmp->offsets for the remaining glyphs. */
22818 for (i
++; i
< glyph_len
; i
++)
22820 int left
, right
, btm
, top
;
22821 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22823 struct face
*this_face
;
22827 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22828 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22829 font
= this_face
->font
;
22835 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22837 pcm
= get_per_char_metric (font
, &char2b
);
22840 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22843 width
= pcm
->width
;
22844 ascent
= pcm
->ascent
;
22845 descent
= pcm
->descent
;
22846 lbearing
= pcm
->lbearing
;
22847 rbearing
= pcm
->rbearing
;
22848 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22850 /* Relative composition with or without
22851 alternate chars. */
22852 left
= (leftmost
+ rightmost
- width
) / 2;
22853 btm
= - descent
+ boff
;
22854 if (font
->relative_compose
22855 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22856 || NILP (Faref (Vignore_relative_composition
,
22857 make_number (ch
)))))
22860 if (- descent
>= font
->relative_compose
)
22861 /* One extra pixel between two glyphs. */
22863 else if (ascent
<= 0)
22864 /* One extra pixel between two glyphs. */
22865 btm
= lowest
- 1 - ascent
- descent
;
22870 /* A composition rule is specified by an integer
22871 value that encodes global and new reference
22872 points (GREF and NREF). GREF and NREF are
22873 specified by numbers as below:
22875 0---1---2 -- ascent
22879 9--10--11 -- center
22881 ---3---4---5--- baseline
22883 6---7---8 -- descent
22885 int rule
= COMPOSITION_RULE (cmp
, i
);
22886 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22888 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22889 grefx
= gref
% 3, nrefx
= nref
% 3;
22890 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22892 xoff
= font_height
* (xoff
- 128) / 256;
22894 yoff
= font_height
* (yoff
- 128) / 256;
22897 + grefx
* (rightmost
- leftmost
) / 2
22898 - nrefx
* width
/ 2
22901 btm
= ((grefy
== 0 ? highest
22903 : grefy
== 2 ? lowest
22904 : (highest
+ lowest
) / 2)
22905 - (nrefy
== 0 ? ascent
+ descent
22906 : nrefy
== 1 ? descent
- boff
22908 : (ascent
+ descent
) / 2)
22912 cmp
->offsets
[i
* 2] = left
;
22913 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22915 /* Update the bounding box of the overall glyphs. */
22918 right
= left
+ width
;
22919 if (left
< leftmost
)
22921 if (right
> rightmost
)
22924 top
= btm
+ descent
+ ascent
;
22930 if (cmp
->lbearing
> left
+ lbearing
)
22931 cmp
->lbearing
= left
+ lbearing
;
22932 if (cmp
->rbearing
< left
+ rbearing
)
22933 cmp
->rbearing
= left
+ rbearing
;
22937 /* If there are glyphs whose x-offsets are negative,
22938 shift all glyphs to the right and make all x-offsets
22942 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22943 cmp
->offsets
[i
* 2] -= leftmost
;
22944 rightmost
-= leftmost
;
22945 cmp
->lbearing
-= leftmost
;
22946 cmp
->rbearing
-= leftmost
;
22949 if (left_padded
&& cmp
->lbearing
< 0)
22951 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22952 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22953 rightmost
-= cmp
->lbearing
;
22954 cmp
->rbearing
-= cmp
->lbearing
;
22957 if (right_padded
&& rightmost
< cmp
->rbearing
)
22959 rightmost
= cmp
->rbearing
;
22962 cmp
->pixel_width
= rightmost
;
22963 cmp
->ascent
= highest
;
22964 cmp
->descent
= - lowest
;
22965 if (cmp
->ascent
< font_ascent
)
22966 cmp
->ascent
= font_ascent
;
22967 if (cmp
->descent
< font_descent
)
22968 cmp
->descent
= font_descent
;
22972 && (cmp
->lbearing
< 0
22973 || cmp
->rbearing
> cmp
->pixel_width
))
22974 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22976 it
->pixel_width
= cmp
->pixel_width
;
22977 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22978 it
->descent
= it
->phys_descent
= cmp
->descent
;
22979 if (face
->box
!= FACE_NO_BOX
)
22981 int thick
= face
->box_line_width
;
22985 it
->ascent
+= thick
;
22986 it
->descent
+= thick
;
22991 if (it
->start_of_box_run_p
)
22992 it
->pixel_width
+= thick
;
22993 if (it
->end_of_box_run_p
)
22994 it
->pixel_width
+= thick
;
22997 /* If face has an overline, add the height of the overline
22998 (1 pixel) and a 1 pixel margin to the character height. */
22999 if (face
->overline_p
)
23000 it
->ascent
+= overline_margin
;
23002 take_vertical_position_into_account (it
);
23003 if (it
->ascent
< 0)
23005 if (it
->descent
< 0)
23009 append_composite_glyph (it
);
23011 else if (it
->what
== IT_COMPOSITION
)
23013 /* A dynamic (automatic) composition. */
23014 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23015 Lisp_Object gstring
;
23016 struct font_metrics metrics
;
23018 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23020 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23023 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23024 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23025 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23026 it
->descent
= it
->phys_descent
= metrics
.descent
;
23027 if (face
->box
!= FACE_NO_BOX
)
23029 int thick
= face
->box_line_width
;
23033 it
->ascent
+= thick
;
23034 it
->descent
+= thick
;
23039 if (it
->start_of_box_run_p
)
23040 it
->pixel_width
+= thick
;
23041 if (it
->end_of_box_run_p
)
23042 it
->pixel_width
+= thick
;
23044 /* If face has an overline, add the height of the overline
23045 (1 pixel) and a 1 pixel margin to the character height. */
23046 if (face
->overline_p
)
23047 it
->ascent
+= overline_margin
;
23048 take_vertical_position_into_account (it
);
23049 if (it
->ascent
< 0)
23051 if (it
->descent
< 0)
23055 append_composite_glyph (it
);
23057 else if (it
->what
== IT_GLYPHLESS
)
23058 produce_glyphless_glyph (it
, 0, Qnil
);
23059 else if (it
->what
== IT_IMAGE
)
23060 produce_image_glyph (it
);
23061 else if (it
->what
== IT_STRETCH
)
23062 produce_stretch_glyph (it
);
23065 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23066 because this isn't true for images with `:ascent 100'. */
23067 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23068 if (it
->area
== TEXT_AREA
)
23069 it
->current_x
+= it
->pixel_width
;
23071 if (extra_line_spacing
> 0)
23073 it
->descent
+= extra_line_spacing
;
23074 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23075 it
->max_extra_line_spacing
= extra_line_spacing
;
23078 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23079 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23080 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23081 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23085 Output LEN glyphs starting at START at the nominal cursor position.
23086 Advance the nominal cursor over the text. The global variable
23087 updated_window contains the window being updated, updated_row is
23088 the glyph row being updated, and updated_area is the area of that
23089 row being updated. */
23092 x_write_glyphs (struct glyph
*start
, int len
)
23096 xassert (updated_window
&& updated_row
);
23099 /* Write glyphs. */
23101 hpos
= start
- updated_row
->glyphs
[updated_area
];
23102 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23103 updated_row
, updated_area
,
23105 DRAW_NORMAL_TEXT
, 0);
23107 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23108 if (updated_area
== TEXT_AREA
23109 && updated_window
->phys_cursor_on_p
23110 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23111 && updated_window
->phys_cursor
.hpos
>= hpos
23112 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23113 updated_window
->phys_cursor_on_p
= 0;
23117 /* Advance the output cursor. */
23118 output_cursor
.hpos
+= len
;
23119 output_cursor
.x
= x
;
23124 Insert LEN glyphs from START at the nominal cursor position. */
23127 x_insert_glyphs (struct glyph
*start
, int len
)
23131 int line_height
, shift_by_width
, shifted_region_width
;
23132 struct glyph_row
*row
;
23133 struct glyph
*glyph
;
23134 int frame_x
, frame_y
;
23137 xassert (updated_window
&& updated_row
);
23139 w
= updated_window
;
23140 f
= XFRAME (WINDOW_FRAME (w
));
23142 /* Get the height of the line we are in. */
23144 line_height
= row
->height
;
23146 /* Get the width of the glyphs to insert. */
23147 shift_by_width
= 0;
23148 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23149 shift_by_width
+= glyph
->pixel_width
;
23151 /* Get the width of the region to shift right. */
23152 shifted_region_width
= (window_box_width (w
, updated_area
)
23157 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23158 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23160 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23161 line_height
, shift_by_width
);
23163 /* Write the glyphs. */
23164 hpos
= start
- row
->glyphs
[updated_area
];
23165 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23167 DRAW_NORMAL_TEXT
, 0);
23169 /* Advance the output cursor. */
23170 output_cursor
.hpos
+= len
;
23171 output_cursor
.x
+= shift_by_width
;
23177 Erase the current text line from the nominal cursor position
23178 (inclusive) to pixel column TO_X (exclusive). The idea is that
23179 everything from TO_X onward is already erased.
23181 TO_X is a pixel position relative to updated_area of
23182 updated_window. TO_X == -1 means clear to the end of this area. */
23185 x_clear_end_of_line (int to_x
)
23188 struct window
*w
= updated_window
;
23189 int max_x
, min_y
, max_y
;
23190 int from_x
, from_y
, to_y
;
23192 xassert (updated_window
&& updated_row
);
23193 f
= XFRAME (w
->frame
);
23195 if (updated_row
->full_width_p
)
23196 max_x
= WINDOW_TOTAL_WIDTH (w
);
23198 max_x
= window_box_width (w
, updated_area
);
23199 max_y
= window_text_bottom_y (w
);
23201 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23202 of window. For TO_X > 0, truncate to end of drawing area. */
23208 to_x
= min (to_x
, max_x
);
23210 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23212 /* Notice if the cursor will be cleared by this operation. */
23213 if (!updated_row
->full_width_p
)
23214 notice_overwritten_cursor (w
, updated_area
,
23215 output_cursor
.x
, -1,
23217 MATRIX_ROW_BOTTOM_Y (updated_row
));
23219 from_x
= output_cursor
.x
;
23221 /* Translate to frame coordinates. */
23222 if (updated_row
->full_width_p
)
23224 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23225 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23229 int area_left
= window_box_left (w
, updated_area
);
23230 from_x
+= area_left
;
23234 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23235 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23236 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23238 /* Prevent inadvertently clearing to end of the X window. */
23239 if (to_x
> from_x
&& to_y
> from_y
)
23242 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23243 to_x
- from_x
, to_y
- from_y
);
23248 #endif /* HAVE_WINDOW_SYSTEM */
23252 /***********************************************************************
23254 ***********************************************************************/
23256 /* Value is the internal representation of the specified cursor type
23257 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23258 of the bar cursor. */
23260 static enum text_cursor_kinds
23261 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23263 enum text_cursor_kinds type
;
23268 if (EQ (arg
, Qbox
))
23269 return FILLED_BOX_CURSOR
;
23271 if (EQ (arg
, Qhollow
))
23272 return HOLLOW_BOX_CURSOR
;
23274 if (EQ (arg
, Qbar
))
23281 && EQ (XCAR (arg
), Qbar
)
23282 && INTEGERP (XCDR (arg
))
23283 && XINT (XCDR (arg
)) >= 0)
23285 *width
= XINT (XCDR (arg
));
23289 if (EQ (arg
, Qhbar
))
23292 return HBAR_CURSOR
;
23296 && EQ (XCAR (arg
), Qhbar
)
23297 && INTEGERP (XCDR (arg
))
23298 && XINT (XCDR (arg
)) >= 0)
23300 *width
= XINT (XCDR (arg
));
23301 return HBAR_CURSOR
;
23304 /* Treat anything unknown as "hollow box cursor".
23305 It was bad to signal an error; people have trouble fixing
23306 .Xdefaults with Emacs, when it has something bad in it. */
23307 type
= HOLLOW_BOX_CURSOR
;
23312 /* Set the default cursor types for specified frame. */
23314 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23319 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23320 FRAME_CURSOR_WIDTH (f
) = width
;
23322 /* By default, set up the blink-off state depending on the on-state. */
23324 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23327 FRAME_BLINK_OFF_CURSOR (f
)
23328 = get_specified_cursor_type (XCDR (tem
), &width
);
23329 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23332 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23336 #ifdef HAVE_WINDOW_SYSTEM
23338 /* Return the cursor we want to be displayed in window W. Return
23339 width of bar/hbar cursor through WIDTH arg. Return with
23340 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23341 (i.e. if the `system caret' should track this cursor).
23343 In a mini-buffer window, we want the cursor only to appear if we
23344 are reading input from this window. For the selected window, we
23345 want the cursor type given by the frame parameter or buffer local
23346 setting of cursor-type. If explicitly marked off, draw no cursor.
23347 In all other cases, we want a hollow box cursor. */
23349 static enum text_cursor_kinds
23350 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23351 int *active_cursor
)
23353 struct frame
*f
= XFRAME (w
->frame
);
23354 struct buffer
*b
= XBUFFER (w
->buffer
);
23355 int cursor_type
= DEFAULT_CURSOR
;
23356 Lisp_Object alt_cursor
;
23357 int non_selected
= 0;
23359 *active_cursor
= 1;
23362 if (cursor_in_echo_area
23363 && FRAME_HAS_MINIBUF_P (f
)
23364 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23366 if (w
== XWINDOW (echo_area_window
))
23368 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23370 *width
= FRAME_CURSOR_WIDTH (f
);
23371 return FRAME_DESIRED_CURSOR (f
);
23374 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23377 *active_cursor
= 0;
23381 /* Detect a nonselected window or nonselected frame. */
23382 else if (w
!= XWINDOW (f
->selected_window
)
23383 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23385 *active_cursor
= 0;
23387 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23393 /* Never display a cursor in a window in which cursor-type is nil. */
23394 if (NILP (BVAR (b
, cursor_type
)))
23397 /* Get the normal cursor type for this window. */
23398 if (EQ (BVAR (b
, cursor_type
), Qt
))
23400 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23401 *width
= FRAME_CURSOR_WIDTH (f
);
23404 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23406 /* Use cursor-in-non-selected-windows instead
23407 for non-selected window or frame. */
23410 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23411 if (!EQ (Qt
, alt_cursor
))
23412 return get_specified_cursor_type (alt_cursor
, width
);
23413 /* t means modify the normal cursor type. */
23414 if (cursor_type
== FILLED_BOX_CURSOR
)
23415 cursor_type
= HOLLOW_BOX_CURSOR
;
23416 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23418 return cursor_type
;
23421 /* Use normal cursor if not blinked off. */
23422 if (!w
->cursor_off_p
)
23424 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23426 if (cursor_type
== FILLED_BOX_CURSOR
)
23428 /* Using a block cursor on large images can be very annoying.
23429 So use a hollow cursor for "large" images.
23430 If image is not transparent (no mask), also use hollow cursor. */
23431 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23432 if (img
!= NULL
&& IMAGEP (img
->spec
))
23434 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23435 where N = size of default frame font size.
23436 This should cover most of the "tiny" icons people may use. */
23438 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23439 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23440 cursor_type
= HOLLOW_BOX_CURSOR
;
23443 else if (cursor_type
!= NO_CURSOR
)
23445 /* Display current only supports BOX and HOLLOW cursors for images.
23446 So for now, unconditionally use a HOLLOW cursor when cursor is
23447 not a solid box cursor. */
23448 cursor_type
= HOLLOW_BOX_CURSOR
;
23451 return cursor_type
;
23454 /* Cursor is blinked off, so determine how to "toggle" it. */
23456 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23457 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23458 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23460 /* Then see if frame has specified a specific blink off cursor type. */
23461 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23463 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23464 return FRAME_BLINK_OFF_CURSOR (f
);
23468 /* Some people liked having a permanently visible blinking cursor,
23469 while others had very strong opinions against it. So it was
23470 decided to remove it. KFS 2003-09-03 */
23472 /* Finally perform built-in cursor blinking:
23473 filled box <-> hollow box
23474 wide [h]bar <-> narrow [h]bar
23475 narrow [h]bar <-> no cursor
23476 other type <-> no cursor */
23478 if (cursor_type
== FILLED_BOX_CURSOR
)
23479 return HOLLOW_BOX_CURSOR
;
23481 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23484 return cursor_type
;
23492 /* Notice when the text cursor of window W has been completely
23493 overwritten by a drawing operation that outputs glyphs in AREA
23494 starting at X0 and ending at X1 in the line starting at Y0 and
23495 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23496 the rest of the line after X0 has been written. Y coordinates
23497 are window-relative. */
23500 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23501 int x0
, int x1
, int y0
, int y1
)
23503 int cx0
, cx1
, cy0
, cy1
;
23504 struct glyph_row
*row
;
23506 if (!w
->phys_cursor_on_p
)
23508 if (area
!= TEXT_AREA
)
23511 if (w
->phys_cursor
.vpos
< 0
23512 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23513 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23514 !(row
->enabled_p
&& row
->displays_text_p
)))
23517 if (row
->cursor_in_fringe_p
)
23519 row
->cursor_in_fringe_p
= 0;
23520 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23521 w
->phys_cursor_on_p
= 0;
23525 cx0
= w
->phys_cursor
.x
;
23526 cx1
= cx0
+ w
->phys_cursor_width
;
23527 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23530 /* The cursor image will be completely removed from the
23531 screen if the output area intersects the cursor area in
23532 y-direction. When we draw in [y0 y1[, and some part of
23533 the cursor is at y < y0, that part must have been drawn
23534 before. When scrolling, the cursor is erased before
23535 actually scrolling, so we don't come here. When not
23536 scrolling, the rows above the old cursor row must have
23537 changed, and in this case these rows must have written
23538 over the cursor image.
23540 Likewise if part of the cursor is below y1, with the
23541 exception of the cursor being in the first blank row at
23542 the buffer and window end because update_text_area
23543 doesn't draw that row. (Except when it does, but
23544 that's handled in update_text_area.) */
23546 cy0
= w
->phys_cursor
.y
;
23547 cy1
= cy0
+ w
->phys_cursor_height
;
23548 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23551 w
->phys_cursor_on_p
= 0;
23554 #endif /* HAVE_WINDOW_SYSTEM */
23557 /************************************************************************
23559 ************************************************************************/
23561 #ifdef HAVE_WINDOW_SYSTEM
23564 Fix the display of area AREA of overlapping row ROW in window W
23565 with respect to the overlapping part OVERLAPS. */
23568 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23569 enum glyph_row_area area
, int overlaps
)
23576 for (i
= 0; i
< row
->used
[area
];)
23578 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23580 int start
= i
, start_x
= x
;
23584 x
+= row
->glyphs
[area
][i
].pixel_width
;
23587 while (i
< row
->used
[area
]
23588 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23590 draw_glyphs (w
, start_x
, row
, area
,
23592 DRAW_NORMAL_TEXT
, overlaps
);
23596 x
+= row
->glyphs
[area
][i
].pixel_width
;
23606 Draw the cursor glyph of window W in glyph row ROW. See the
23607 comment of draw_glyphs for the meaning of HL. */
23610 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23611 enum draw_glyphs_face hl
)
23613 /* If cursor hpos is out of bounds, don't draw garbage. This can
23614 happen in mini-buffer windows when switching between echo area
23615 glyphs and mini-buffer. */
23616 if ((row
->reversed_p
23617 ? (w
->phys_cursor
.hpos
>= 0)
23618 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23620 int on_p
= w
->phys_cursor_on_p
;
23622 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23623 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23625 w
->phys_cursor_on_p
= on_p
;
23627 if (hl
== DRAW_CURSOR
)
23628 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23629 /* When we erase the cursor, and ROW is overlapped by other
23630 rows, make sure that these overlapping parts of other rows
23632 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23634 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23636 if (row
> w
->current_matrix
->rows
23637 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23638 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23639 OVERLAPS_ERASED_CURSOR
);
23641 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23642 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23643 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23644 OVERLAPS_ERASED_CURSOR
);
23651 Erase the image of a cursor of window W from the screen. */
23654 erase_phys_cursor (struct window
*w
)
23656 struct frame
*f
= XFRAME (w
->frame
);
23657 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23658 int hpos
= w
->phys_cursor
.hpos
;
23659 int vpos
= w
->phys_cursor
.vpos
;
23660 int mouse_face_here_p
= 0;
23661 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23662 struct glyph_row
*cursor_row
;
23663 struct glyph
*cursor_glyph
;
23664 enum draw_glyphs_face hl
;
23666 /* No cursor displayed or row invalidated => nothing to do on the
23668 if (w
->phys_cursor_type
== NO_CURSOR
)
23669 goto mark_cursor_off
;
23671 /* VPOS >= active_glyphs->nrows means that window has been resized.
23672 Don't bother to erase the cursor. */
23673 if (vpos
>= active_glyphs
->nrows
)
23674 goto mark_cursor_off
;
23676 /* If row containing cursor is marked invalid, there is nothing we
23678 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23679 if (!cursor_row
->enabled_p
)
23680 goto mark_cursor_off
;
23682 /* If line spacing is > 0, old cursor may only be partially visible in
23683 window after split-window. So adjust visible height. */
23684 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23685 window_text_bottom_y (w
) - cursor_row
->y
);
23687 /* If row is completely invisible, don't attempt to delete a cursor which
23688 isn't there. This can happen if cursor is at top of a window, and
23689 we switch to a buffer with a header line in that window. */
23690 if (cursor_row
->visible_height
<= 0)
23691 goto mark_cursor_off
;
23693 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23694 if (cursor_row
->cursor_in_fringe_p
)
23696 cursor_row
->cursor_in_fringe_p
= 0;
23697 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23698 goto mark_cursor_off
;
23701 /* This can happen when the new row is shorter than the old one.
23702 In this case, either draw_glyphs or clear_end_of_line
23703 should have cleared the cursor. Note that we wouldn't be
23704 able to erase the cursor in this case because we don't have a
23705 cursor glyph at hand. */
23706 if ((cursor_row
->reversed_p
23707 ? (w
->phys_cursor
.hpos
< 0)
23708 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23709 goto mark_cursor_off
;
23711 /* If the cursor is in the mouse face area, redisplay that when
23712 we clear the cursor. */
23713 if (! NILP (hlinfo
->mouse_face_window
)
23714 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23715 /* Don't redraw the cursor's spot in mouse face if it is at the
23716 end of a line (on a newline). The cursor appears there, but
23717 mouse highlighting does not. */
23718 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23719 mouse_face_here_p
= 1;
23721 /* Maybe clear the display under the cursor. */
23722 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23725 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23728 cursor_glyph
= get_phys_cursor_glyph (w
);
23729 if (cursor_glyph
== NULL
)
23730 goto mark_cursor_off
;
23732 width
= cursor_glyph
->pixel_width
;
23733 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23734 x
= w
->phys_cursor
.x
;
23736 width
-= left_x
- x
;
23737 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23738 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23739 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23742 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23745 /* Erase the cursor by redrawing the character underneath it. */
23746 if (mouse_face_here_p
)
23747 hl
= DRAW_MOUSE_FACE
;
23749 hl
= DRAW_NORMAL_TEXT
;
23750 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23753 w
->phys_cursor_on_p
= 0;
23754 w
->phys_cursor_type
= NO_CURSOR
;
23759 Display or clear cursor of window W. If ON is zero, clear the
23760 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23761 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23764 display_and_set_cursor (struct window
*w
, int on
,
23765 int hpos
, int vpos
, int x
, int y
)
23767 struct frame
*f
= XFRAME (w
->frame
);
23768 int new_cursor_type
;
23769 int new_cursor_width
;
23771 struct glyph_row
*glyph_row
;
23772 struct glyph
*glyph
;
23774 /* This is pointless on invisible frames, and dangerous on garbaged
23775 windows and frames; in the latter case, the frame or window may
23776 be in the midst of changing its size, and x and y may be off the
23778 if (! FRAME_VISIBLE_P (f
)
23779 || FRAME_GARBAGED_P (f
)
23780 || vpos
>= w
->current_matrix
->nrows
23781 || hpos
>= w
->current_matrix
->matrix_w
)
23784 /* If cursor is off and we want it off, return quickly. */
23785 if (!on
&& !w
->phys_cursor_on_p
)
23788 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23789 /* If cursor row is not enabled, we don't really know where to
23790 display the cursor. */
23791 if (!glyph_row
->enabled_p
)
23793 w
->phys_cursor_on_p
= 0;
23798 if (!glyph_row
->exact_window_width_line_p
23799 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23800 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23802 xassert (interrupt_input_blocked
);
23804 /* Set new_cursor_type to the cursor we want to be displayed. */
23805 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23806 &new_cursor_width
, &active_cursor
);
23808 /* If cursor is currently being shown and we don't want it to be or
23809 it is in the wrong place, or the cursor type is not what we want,
23811 if (w
->phys_cursor_on_p
23813 || w
->phys_cursor
.x
!= x
23814 || w
->phys_cursor
.y
!= y
23815 || new_cursor_type
!= w
->phys_cursor_type
23816 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23817 && new_cursor_width
!= w
->phys_cursor_width
)))
23818 erase_phys_cursor (w
);
23820 /* Don't check phys_cursor_on_p here because that flag is only set
23821 to zero in some cases where we know that the cursor has been
23822 completely erased, to avoid the extra work of erasing the cursor
23823 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23824 still not be visible, or it has only been partly erased. */
23827 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23828 w
->phys_cursor_height
= glyph_row
->height
;
23830 /* Set phys_cursor_.* before x_draw_.* is called because some
23831 of them may need the information. */
23832 w
->phys_cursor
.x
= x
;
23833 w
->phys_cursor
.y
= glyph_row
->y
;
23834 w
->phys_cursor
.hpos
= hpos
;
23835 w
->phys_cursor
.vpos
= vpos
;
23838 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23839 new_cursor_type
, new_cursor_width
,
23840 on
, active_cursor
);
23844 /* Switch the display of W's cursor on or off, according to the value
23848 update_window_cursor (struct window
*w
, int on
)
23850 /* Don't update cursor in windows whose frame is in the process
23851 of being deleted. */
23852 if (w
->current_matrix
)
23855 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23856 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23862 /* Call update_window_cursor with parameter ON_P on all leaf windows
23863 in the window tree rooted at W. */
23866 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23870 if (!NILP (w
->hchild
))
23871 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23872 else if (!NILP (w
->vchild
))
23873 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23875 update_window_cursor (w
, on_p
);
23877 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23883 Display the cursor on window W, or clear it, according to ON_P.
23884 Don't change the cursor's position. */
23887 x_update_cursor (struct frame
*f
, int on_p
)
23889 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23894 Clear the cursor of window W to background color, and mark the
23895 cursor as not shown. This is used when the text where the cursor
23896 is about to be rewritten. */
23899 x_clear_cursor (struct window
*w
)
23901 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23902 update_window_cursor (w
, 0);
23905 #endif /* HAVE_WINDOW_SYSTEM */
23907 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23910 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23911 int start_hpos
, int end_hpos
,
23912 enum draw_glyphs_face draw
)
23914 #ifdef HAVE_WINDOW_SYSTEM
23915 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23917 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23921 #if defined (HAVE_GPM) || defined (MSDOS)
23922 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23926 /* Display the active region described by mouse_face_* according to DRAW. */
23929 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23931 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23932 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23934 if (/* If window is in the process of being destroyed, don't bother
23936 w
->current_matrix
!= NULL
23937 /* Don't update mouse highlight if hidden */
23938 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23939 /* Recognize when we are called to operate on rows that don't exist
23940 anymore. This can happen when a window is split. */
23941 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23943 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23944 struct glyph_row
*row
, *first
, *last
;
23946 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23947 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23949 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23951 int start_hpos
, end_hpos
, start_x
;
23953 /* For all but the first row, the highlight starts at column 0. */
23956 /* R2L rows have BEG and END in reversed order, but the
23957 screen drawing geometry is always left to right. So
23958 we need to mirror the beginning and end of the
23959 highlighted area in R2L rows. */
23960 if (!row
->reversed_p
)
23962 start_hpos
= hlinfo
->mouse_face_beg_col
;
23963 start_x
= hlinfo
->mouse_face_beg_x
;
23965 else if (row
== last
)
23967 start_hpos
= hlinfo
->mouse_face_end_col
;
23968 start_x
= hlinfo
->mouse_face_end_x
;
23976 else if (row
->reversed_p
&& row
== last
)
23978 start_hpos
= hlinfo
->mouse_face_end_col
;
23979 start_x
= hlinfo
->mouse_face_end_x
;
23989 if (!row
->reversed_p
)
23990 end_hpos
= hlinfo
->mouse_face_end_col
;
23991 else if (row
== first
)
23992 end_hpos
= hlinfo
->mouse_face_beg_col
;
23995 end_hpos
= row
->used
[TEXT_AREA
];
23996 if (draw
== DRAW_NORMAL_TEXT
)
23997 row
->fill_line_p
= 1; /* Clear to end of line */
24000 else if (row
->reversed_p
&& row
== first
)
24001 end_hpos
= hlinfo
->mouse_face_beg_col
;
24004 end_hpos
= row
->used
[TEXT_AREA
];
24005 if (draw
== DRAW_NORMAL_TEXT
)
24006 row
->fill_line_p
= 1; /* Clear to end of line */
24009 if (end_hpos
> start_hpos
)
24011 draw_row_with_mouse_face (w
, start_x
, row
,
24012 start_hpos
, end_hpos
, draw
);
24015 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24019 #ifdef HAVE_WINDOW_SYSTEM
24020 /* When we've written over the cursor, arrange for it to
24021 be displayed again. */
24022 if (FRAME_WINDOW_P (f
)
24023 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24026 display_and_set_cursor (w
, 1,
24027 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24028 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24031 #endif /* HAVE_WINDOW_SYSTEM */
24034 #ifdef HAVE_WINDOW_SYSTEM
24035 /* Change the mouse cursor. */
24036 if (FRAME_WINDOW_P (f
))
24038 if (draw
== DRAW_NORMAL_TEXT
24039 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24040 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24041 else if (draw
== DRAW_MOUSE_FACE
)
24042 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24044 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24046 #endif /* HAVE_WINDOW_SYSTEM */
24050 Clear out the mouse-highlighted active region.
24051 Redraw it un-highlighted first. Value is non-zero if mouse
24052 face was actually drawn unhighlighted. */
24055 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24059 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24061 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24065 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24066 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24067 hlinfo
->mouse_face_window
= Qnil
;
24068 hlinfo
->mouse_face_overlay
= Qnil
;
24072 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24073 within the mouse face on that window. */
24075 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24077 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24079 /* Quickly resolve the easy cases. */
24080 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24081 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24083 if (vpos
< hlinfo
->mouse_face_beg_row
24084 || vpos
> hlinfo
->mouse_face_end_row
)
24086 if (vpos
> hlinfo
->mouse_face_beg_row
24087 && vpos
< hlinfo
->mouse_face_end_row
)
24090 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24092 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24094 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24097 else if ((vpos
== hlinfo
->mouse_face_beg_row
24098 && hpos
>= hlinfo
->mouse_face_beg_col
)
24099 || (vpos
== hlinfo
->mouse_face_end_row
24100 && hpos
< hlinfo
->mouse_face_end_col
))
24105 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24107 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24110 else if ((vpos
== hlinfo
->mouse_face_beg_row
24111 && hpos
<= hlinfo
->mouse_face_beg_col
)
24112 || (vpos
== hlinfo
->mouse_face_end_row
24113 && hpos
> hlinfo
->mouse_face_end_col
))
24121 Non-zero if physical cursor of window W is within mouse face. */
24124 cursor_in_mouse_face_p (struct window
*w
)
24126 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24131 /* Find the glyph rows START_ROW and END_ROW of window W that display
24132 characters between buffer positions START_CHARPOS and END_CHARPOS
24133 (excluding END_CHARPOS). This is similar to row_containing_pos,
24134 but is more accurate when bidi reordering makes buffer positions
24135 change non-linearly with glyph rows. */
24137 rows_from_pos_range (struct window
*w
,
24138 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24139 struct glyph_row
**start
, struct glyph_row
**end
)
24141 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24142 int last_y
= window_text_bottom_y (w
);
24143 struct glyph_row
*row
;
24148 while (!first
->enabled_p
24149 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24152 /* Find the START row. */
24154 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24157 /* A row can potentially be the START row if the range of the
24158 characters it displays intersects the range
24159 [START_CHARPOS..END_CHARPOS). */
24160 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24161 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24162 /* See the commentary in row_containing_pos, for the
24163 explanation of the complicated way to check whether
24164 some position is beyond the end of the characters
24165 displayed by a row. */
24166 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24167 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24168 && !row
->ends_at_zv_p
24169 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24170 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24171 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24172 && !row
->ends_at_zv_p
24173 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24175 /* Found a candidate row. Now make sure at least one of the
24176 glyphs it displays has a charpos from the range
24177 [START_CHARPOS..END_CHARPOS).
24179 This is not obvious because bidi reordering could make
24180 buffer positions of a row be 1,2,3,102,101,100, and if we
24181 want to highlight characters in [50..60), we don't want
24182 this row, even though [50..60) does intersect [1..103),
24183 the range of character positions given by the row's start
24184 and end positions. */
24185 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24186 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24190 if (BUFFERP (g
->object
)
24191 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24200 /* Find the END row. */
24202 /* If the last row is partially visible, start looking for END
24203 from that row, instead of starting from FIRST. */
24204 && !(row
->enabled_p
24205 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24207 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24209 struct glyph_row
*next
= row
+ 1;
24211 if (!next
->enabled_p
24212 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24213 /* The first row >= START whose range of displayed characters
24214 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24215 is the row END + 1. */
24216 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24217 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24218 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24219 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24220 && !next
->ends_at_zv_p
24221 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24222 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24223 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24224 && !next
->ends_at_zv_p
24225 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24232 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24233 but none of the characters it displays are in the range, it is
24235 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24236 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24240 if (BUFFERP (g
->object
)
24241 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24254 /* This function sets the mouse_face_* elements of HLINFO, assuming
24255 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24256 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24257 for the overlay or run of text properties specifying the mouse
24258 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24259 before-string and after-string that must also be highlighted.
24260 COVER_STRING, if non-nil, is a display string that may cover some
24261 or all of the highlighted text. */
24264 mouse_face_from_buffer_pos (Lisp_Object window
,
24265 Mouse_HLInfo
*hlinfo
,
24266 EMACS_INT mouse_charpos
,
24267 EMACS_INT start_charpos
,
24268 EMACS_INT end_charpos
,
24269 Lisp_Object before_string
,
24270 Lisp_Object after_string
,
24271 Lisp_Object cover_string
)
24273 struct window
*w
= XWINDOW (window
);
24274 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24275 struct glyph_row
*r1
, *r2
;
24276 struct glyph
*glyph
, *end
;
24277 EMACS_INT ignore
, pos
;
24280 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24281 xassert (NILP (before_string
) || STRINGP (before_string
));
24282 xassert (NILP (after_string
) || STRINGP (after_string
));
24284 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24285 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24287 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24288 /* If the before-string or display-string contains newlines,
24289 rows_from_pos_range skips to its last row. Move back. */
24290 if (!NILP (before_string
) || !NILP (cover_string
))
24292 struct glyph_row
*prev
;
24293 while ((prev
= r1
- 1, prev
>= first
)
24294 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24295 && prev
->used
[TEXT_AREA
] > 0)
24297 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24298 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24299 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24301 || !(EQ (glyph
->object
, before_string
)
24302 || EQ (glyph
->object
, cover_string
)))
24309 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24310 hlinfo
->mouse_face_past_end
= 1;
24312 else if (!NILP (after_string
))
24314 /* If the after-string has newlines, advance to its last row. */
24315 struct glyph_row
*next
;
24316 struct glyph_row
*last
24317 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24319 for (next
= r2
+ 1;
24321 && next
->used
[TEXT_AREA
] > 0
24322 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24326 /* The rest of the display engine assumes that mouse_face_beg_row is
24327 either above below mouse_face_end_row or identical to it. But
24328 with bidi-reordered continued lines, the row for START_CHARPOS
24329 could be below the row for END_CHARPOS. If so, swap the rows and
24330 store them in correct order. */
24333 struct glyph_row
*tem
= r2
;
24339 hlinfo
->mouse_face_beg_y
= r1
->y
;
24340 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24341 hlinfo
->mouse_face_end_y
= r2
->y
;
24342 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24344 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24345 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24346 could be anywhere in the row and in any order. The strategy
24347 below is to find the leftmost and the rightmost glyph that
24348 belongs to either of these 3 strings, or whose position is
24349 between START_CHARPOS and END_CHARPOS, and highlight all the
24350 glyphs between those two. This may cover more than just the text
24351 between START_CHARPOS and END_CHARPOS if the range of characters
24352 strides the bidi level boundary, e.g. if the beginning is in R2L
24353 text while the end is in L2R text or vice versa. */
24354 if (!r1
->reversed_p
)
24356 /* This row is in a left to right paragraph. Scan it left to
24358 glyph
= r1
->glyphs
[TEXT_AREA
];
24359 end
= glyph
+ r1
->used
[TEXT_AREA
];
24362 /* Skip truncation glyphs at the start of the glyph row. */
24363 if (r1
->displays_text_p
)
24365 && INTEGERP (glyph
->object
)
24366 && glyph
->charpos
< 0;
24368 x
+= glyph
->pixel_width
;
24370 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24371 or COVER_STRING, and the first glyph from buffer whose
24372 position is between START_CHARPOS and END_CHARPOS. */
24374 && !INTEGERP (glyph
->object
)
24375 && !EQ (glyph
->object
, cover_string
)
24376 && !(BUFFERP (glyph
->object
)
24377 && (glyph
->charpos
>= start_charpos
24378 && glyph
->charpos
< end_charpos
));
24381 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24382 are present at buffer positions between START_CHARPOS and
24383 END_CHARPOS, or if they come from an overlay. */
24384 if (EQ (glyph
->object
, before_string
))
24386 pos
= string_buffer_position (before_string
,
24388 /* If pos == 0, it means before_string came from an
24389 overlay, not from a buffer position. */
24390 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24393 else if (EQ (glyph
->object
, after_string
))
24395 pos
= string_buffer_position (after_string
, end_charpos
);
24396 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24399 x
+= glyph
->pixel_width
;
24401 hlinfo
->mouse_face_beg_x
= x
;
24402 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24406 /* This row is in a right to left paragraph. Scan it right to
24410 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24411 glyph
= end
+ r1
->used
[TEXT_AREA
];
24413 /* Skip truncation glyphs at the start of the glyph row. */
24414 if (r1
->displays_text_p
)
24416 && INTEGERP (glyph
->object
)
24417 && glyph
->charpos
< 0;
24421 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24422 or COVER_STRING, and the first glyph from buffer whose
24423 position is between START_CHARPOS and END_CHARPOS. */
24425 && !INTEGERP (glyph
->object
)
24426 && !EQ (glyph
->object
, cover_string
)
24427 && !(BUFFERP (glyph
->object
)
24428 && (glyph
->charpos
>= start_charpos
24429 && glyph
->charpos
< end_charpos
));
24432 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24433 are present at buffer positions between START_CHARPOS and
24434 END_CHARPOS, or if they come from an overlay. */
24435 if (EQ (glyph
->object
, before_string
))
24437 pos
= string_buffer_position (before_string
, start_charpos
);
24438 /* If pos == 0, it means before_string came from an
24439 overlay, not from a buffer position. */
24440 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24443 else if (EQ (glyph
->object
, after_string
))
24445 pos
= string_buffer_position (after_string
, end_charpos
);
24446 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24451 glyph
++; /* first glyph to the right of the highlighted area */
24452 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24453 x
+= g
->pixel_width
;
24454 hlinfo
->mouse_face_beg_x
= x
;
24455 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24458 /* If the highlight ends in a different row, compute GLYPH and END
24459 for the end row. Otherwise, reuse the values computed above for
24460 the row where the highlight begins. */
24463 if (!r2
->reversed_p
)
24465 glyph
= r2
->glyphs
[TEXT_AREA
];
24466 end
= glyph
+ r2
->used
[TEXT_AREA
];
24471 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24472 glyph
= end
+ r2
->used
[TEXT_AREA
];
24476 if (!r2
->reversed_p
)
24478 /* Skip truncation and continuation glyphs near the end of the
24479 row, and also blanks and stretch glyphs inserted by
24480 extend_face_to_end_of_line. */
24482 && INTEGERP ((end
- 1)->object
)
24483 && (end
- 1)->charpos
<= 0)
24485 /* Scan the rest of the glyph row from the end, looking for the
24486 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24487 COVER_STRING, or whose position is between START_CHARPOS
24491 && !INTEGERP (end
->object
)
24492 && !EQ (end
->object
, cover_string
)
24493 && !(BUFFERP (end
->object
)
24494 && (end
->charpos
>= start_charpos
24495 && end
->charpos
< end_charpos
));
24498 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24499 are present at buffer positions between START_CHARPOS and
24500 END_CHARPOS, or if they come from an overlay. */
24501 if (EQ (end
->object
, before_string
))
24503 pos
= string_buffer_position (before_string
, start_charpos
);
24504 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24507 else if (EQ (end
->object
, after_string
))
24509 pos
= string_buffer_position (after_string
, end_charpos
);
24510 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24514 /* Find the X coordinate of the last glyph to be highlighted. */
24515 for (; glyph
<= end
; ++glyph
)
24516 x
+= glyph
->pixel_width
;
24518 hlinfo
->mouse_face_end_x
= x
;
24519 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24523 /* Skip truncation and continuation glyphs near the end of the
24524 row, and also blanks and stretch glyphs inserted by
24525 extend_face_to_end_of_line. */
24529 && INTEGERP (end
->object
)
24530 && end
->charpos
<= 0)
24532 x
+= end
->pixel_width
;
24535 /* Scan the rest of the glyph row from the end, looking for the
24536 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24537 COVER_STRING, or whose position is between START_CHARPOS
24541 && !INTEGERP (end
->object
)
24542 && !EQ (end
->object
, cover_string
)
24543 && !(BUFFERP (end
->object
)
24544 && (end
->charpos
>= start_charpos
24545 && end
->charpos
< end_charpos
));
24548 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24549 are present at buffer positions between START_CHARPOS and
24550 END_CHARPOS, or if they come from an overlay. */
24551 if (EQ (end
->object
, before_string
))
24553 pos
= string_buffer_position (before_string
, start_charpos
);
24554 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24557 else if (EQ (end
->object
, after_string
))
24559 pos
= string_buffer_position (after_string
, end_charpos
);
24560 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24563 x
+= end
->pixel_width
;
24565 hlinfo
->mouse_face_end_x
= x
;
24566 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24569 hlinfo
->mouse_face_window
= window
;
24570 hlinfo
->mouse_face_face_id
24571 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24573 !hlinfo
->mouse_face_hidden
, -1);
24574 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24577 /* The following function is not used anymore (replaced with
24578 mouse_face_from_string_pos), but I leave it here for the time
24579 being, in case someone would. */
24581 #if 0 /* not used */
24583 /* Find the position of the glyph for position POS in OBJECT in
24584 window W's current matrix, and return in *X, *Y the pixel
24585 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24587 RIGHT_P non-zero means return the position of the right edge of the
24588 glyph, RIGHT_P zero means return the left edge position.
24590 If no glyph for POS exists in the matrix, return the position of
24591 the glyph with the next smaller position that is in the matrix, if
24592 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24593 exists in the matrix, return the position of the glyph with the
24594 next larger position in OBJECT.
24596 Value is non-zero if a glyph was found. */
24599 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24600 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24602 int yb
= window_text_bottom_y (w
);
24603 struct glyph_row
*r
;
24604 struct glyph
*best_glyph
= NULL
;
24605 struct glyph_row
*best_row
= NULL
;
24608 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24609 r
->enabled_p
&& r
->y
< yb
;
24612 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24613 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24616 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24617 if (EQ (g
->object
, object
))
24619 if (g
->charpos
== pos
)
24626 else if (best_glyph
== NULL
24627 || ((eabs (g
->charpos
- pos
)
24628 < eabs (best_glyph
->charpos
- pos
))
24631 : g
->charpos
> pos
)))
24645 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24649 *x
+= best_glyph
->pixel_width
;
24654 *vpos
= best_row
- w
->current_matrix
->rows
;
24657 return best_glyph
!= NULL
;
24659 #endif /* not used */
24661 /* Find the positions of the first and the last glyphs in window W's
24662 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24663 (assumed to be a string), and return in HLINFO's mouse_face_*
24664 members the pixel and column/row coordinates of those glyphs. */
24667 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24668 Lisp_Object object
,
24669 EMACS_INT startpos
, EMACS_INT endpos
)
24671 int yb
= window_text_bottom_y (w
);
24672 struct glyph_row
*r
;
24673 struct glyph
*g
, *e
;
24677 /* Find the glyph row with at least one position in the range
24678 [STARTPOS..ENDPOS], and the first glyph in that row whose
24679 position belongs to that range. */
24680 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24681 r
->enabled_p
&& r
->y
< yb
;
24684 if (!r
->reversed_p
)
24686 g
= r
->glyphs
[TEXT_AREA
];
24687 e
= g
+ r
->used
[TEXT_AREA
];
24688 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24689 if (EQ (g
->object
, object
)
24690 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24692 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24693 hlinfo
->mouse_face_beg_y
= r
->y
;
24694 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24695 hlinfo
->mouse_face_beg_x
= gx
;
24704 e
= r
->glyphs
[TEXT_AREA
];
24705 g
= e
+ r
->used
[TEXT_AREA
];
24706 for ( ; g
> e
; --g
)
24707 if (EQ ((g
-1)->object
, object
)
24708 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24710 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24711 hlinfo
->mouse_face_beg_y
= r
->y
;
24712 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24713 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24714 gx
+= g1
->pixel_width
;
24715 hlinfo
->mouse_face_beg_x
= gx
;
24727 /* Starting with the next row, look for the first row which does NOT
24728 include any glyphs whose positions are in the range. */
24729 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24731 g
= r
->glyphs
[TEXT_AREA
];
24732 e
= g
+ r
->used
[TEXT_AREA
];
24734 for ( ; g
< e
; ++g
)
24735 if (EQ (g
->object
, object
)
24736 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24745 /* The highlighted region ends on the previous row. */
24748 /* Set the end row and its vertical pixel coordinate. */
24749 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24750 hlinfo
->mouse_face_end_y
= r
->y
;
24752 /* Compute and set the end column and the end column's horizontal
24753 pixel coordinate. */
24754 if (!r
->reversed_p
)
24756 g
= r
->glyphs
[TEXT_AREA
];
24757 e
= g
+ r
->used
[TEXT_AREA
];
24758 for ( ; e
> g
; --e
)
24759 if (EQ ((e
-1)->object
, object
)
24760 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24762 hlinfo
->mouse_face_end_col
= e
- g
;
24764 for (gx
= r
->x
; g
< e
; ++g
)
24765 gx
+= g
->pixel_width
;
24766 hlinfo
->mouse_face_end_x
= gx
;
24770 e
= r
->glyphs
[TEXT_AREA
];
24771 g
= e
+ r
->used
[TEXT_AREA
];
24772 for (gx
= r
->x
; e
< g
; ++e
)
24774 if (EQ (e
->object
, object
)
24775 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24777 gx
+= e
->pixel_width
;
24779 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24780 hlinfo
->mouse_face_end_x
= gx
;
24784 #ifdef HAVE_WINDOW_SYSTEM
24786 /* See if position X, Y is within a hot-spot of an image. */
24789 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24791 if (!CONSP (hot_spot
))
24794 if (EQ (XCAR (hot_spot
), Qrect
))
24796 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24797 Lisp_Object rect
= XCDR (hot_spot
);
24801 if (!CONSP (XCAR (rect
)))
24803 if (!CONSP (XCDR (rect
)))
24805 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24807 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24809 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24811 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24815 else if (EQ (XCAR (hot_spot
), Qcircle
))
24817 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24818 Lisp_Object circ
= XCDR (hot_spot
);
24819 Lisp_Object lr
, lx0
, ly0
;
24821 && CONSP (XCAR (circ
))
24822 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24823 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24824 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24826 double r
= XFLOATINT (lr
);
24827 double dx
= XINT (lx0
) - x
;
24828 double dy
= XINT (ly0
) - y
;
24829 return (dx
* dx
+ dy
* dy
<= r
* r
);
24832 else if (EQ (XCAR (hot_spot
), Qpoly
))
24834 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24835 if (VECTORP (XCDR (hot_spot
)))
24837 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24838 Lisp_Object
*poly
= v
->contents
;
24839 int n
= v
->header
.size
;
24842 Lisp_Object lx
, ly
;
24845 /* Need an even number of coordinates, and at least 3 edges. */
24846 if (n
< 6 || n
& 1)
24849 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24850 If count is odd, we are inside polygon. Pixels on edges
24851 may or may not be included depending on actual geometry of the
24853 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24854 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24856 x0
= XINT (lx
), y0
= XINT (ly
);
24857 for (i
= 0; i
< n
; i
+= 2)
24859 int x1
= x0
, y1
= y0
;
24860 if ((lx
= poly
[i
], !INTEGERP (lx
))
24861 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24863 x0
= XINT (lx
), y0
= XINT (ly
);
24865 /* Does this segment cross the X line? */
24873 if (y
> y0
&& y
> y1
)
24875 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24885 find_hot_spot (Lisp_Object map
, int x
, int y
)
24887 while (CONSP (map
))
24889 if (CONSP (XCAR (map
))
24890 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24898 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24900 doc
: /* Lookup in image map MAP coordinates X and Y.
24901 An image map is an alist where each element has the format (AREA ID PLIST).
24902 An AREA is specified as either a rectangle, a circle, or a polygon:
24903 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24904 pixel coordinates of the upper left and bottom right corners.
24905 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24906 and the radius of the circle; r may be a float or integer.
24907 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24908 vector describes one corner in the polygon.
24909 Returns the alist element for the first matching AREA in MAP. */)
24910 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24918 return find_hot_spot (map
, XINT (x
), XINT (y
));
24922 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24924 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24926 /* Do not change cursor shape while dragging mouse. */
24927 if (!NILP (do_mouse_tracking
))
24930 if (!NILP (pointer
))
24932 if (EQ (pointer
, Qarrow
))
24933 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24934 else if (EQ (pointer
, Qhand
))
24935 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24936 else if (EQ (pointer
, Qtext
))
24937 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24938 else if (EQ (pointer
, intern ("hdrag")))
24939 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24940 #ifdef HAVE_X_WINDOWS
24941 else if (EQ (pointer
, intern ("vdrag")))
24942 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24944 else if (EQ (pointer
, intern ("hourglass")))
24945 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24946 else if (EQ (pointer
, Qmodeline
))
24947 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24949 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24952 if (cursor
!= No_Cursor
)
24953 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24956 #endif /* HAVE_WINDOW_SYSTEM */
24958 /* Take proper action when mouse has moved to the mode or header line
24959 or marginal area AREA of window W, x-position X and y-position Y.
24960 X is relative to the start of the text display area of W, so the
24961 width of bitmap areas and scroll bars must be subtracted to get a
24962 position relative to the start of the mode line. */
24965 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24966 enum window_part area
)
24968 struct window
*w
= XWINDOW (window
);
24969 struct frame
*f
= XFRAME (w
->frame
);
24970 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24971 #ifdef HAVE_WINDOW_SYSTEM
24972 Display_Info
*dpyinfo
;
24974 Cursor cursor
= No_Cursor
;
24975 Lisp_Object pointer
= Qnil
;
24976 int dx
, dy
, width
, height
;
24978 Lisp_Object string
, object
= Qnil
;
24979 Lisp_Object pos
, help
;
24981 Lisp_Object mouse_face
;
24982 int original_x_pixel
= x
;
24983 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24984 struct glyph_row
*row
;
24986 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24991 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24992 returns them in row/column units! */
24993 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24994 &object
, &dx
, &dy
, &width
, &height
);
24996 row
= (area
== ON_MODE_LINE
24997 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24998 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25000 /* Find the glyph under the mouse pointer. */
25001 if (row
->mode_line_p
&& row
->enabled_p
)
25003 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25004 end
= glyph
+ row
->used
[TEXT_AREA
];
25006 for (x0
= original_x_pixel
;
25007 glyph
< end
&& x0
>= glyph
->pixel_width
;
25009 x0
-= glyph
->pixel_width
;
25017 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25018 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25019 returns them in row/column units! */
25020 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25021 &object
, &dx
, &dy
, &width
, &height
);
25026 #ifdef HAVE_WINDOW_SYSTEM
25027 if (IMAGEP (object
))
25029 Lisp_Object image_map
, hotspot
;
25030 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25032 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25034 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25038 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25039 If so, we could look for mouse-enter, mouse-leave
25040 properties in PLIST (and do something...). */
25041 hotspot
= XCDR (hotspot
);
25042 if (CONSP (hotspot
)
25043 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25045 pointer
= Fplist_get (plist
, Qpointer
);
25046 if (NILP (pointer
))
25048 help
= Fplist_get (plist
, Qhelp_echo
);
25051 help_echo_string
= help
;
25052 /* Is this correct? ++kfs */
25053 XSETWINDOW (help_echo_window
, w
);
25054 help_echo_object
= w
->buffer
;
25055 help_echo_pos
= charpos
;
25059 if (NILP (pointer
))
25060 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25062 #endif /* HAVE_WINDOW_SYSTEM */
25064 if (STRINGP (string
))
25066 pos
= make_number (charpos
);
25067 /* If we're on a string with `help-echo' text property, arrange
25068 for the help to be displayed. This is done by setting the
25069 global variable help_echo_string to the help string. */
25072 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25075 help_echo_string
= help
;
25076 XSETWINDOW (help_echo_window
, w
);
25077 help_echo_object
= string
;
25078 help_echo_pos
= charpos
;
25082 #ifdef HAVE_WINDOW_SYSTEM
25083 if (FRAME_WINDOW_P (f
))
25085 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25086 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25087 if (NILP (pointer
))
25088 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25090 /* Change the mouse pointer according to what is under X/Y. */
25092 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25095 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25096 if (!KEYMAPP (map
))
25097 map
= Fget_text_property (pos
, Qkeymap
, string
);
25098 if (!KEYMAPP (map
))
25099 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25104 /* Change the mouse face according to what is under X/Y. */
25105 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25106 if (!NILP (mouse_face
)
25107 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25112 struct glyph
* tmp_glyph
;
25116 int total_pixel_width
;
25117 EMACS_INT begpos
, endpos
, ignore
;
25121 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25122 Qmouse_face
, string
, Qnil
);
25128 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25130 endpos
= SCHARS (string
);
25134 /* Calculate the glyph position GPOS of GLYPH in the
25135 displayed string, relative to the beginning of the
25136 highlighted part of the string.
25138 Note: GPOS is different from CHARPOS. CHARPOS is the
25139 position of GLYPH in the internal string object. A mode
25140 line string format has structures which are converted to
25141 a flattened string by the Emacs Lisp interpreter. The
25142 internal string is an element of those structures. The
25143 displayed string is the flattened string. */
25144 tmp_glyph
= row_start_glyph
;
25145 while (tmp_glyph
< glyph
25146 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25147 && begpos
<= tmp_glyph
->charpos
25148 && tmp_glyph
->charpos
< endpos
)))
25150 gpos
= glyph
- tmp_glyph
;
25152 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25153 the highlighted part of the displayed string to which
25154 GLYPH belongs. Note: GSEQ_LENGTH is different from
25155 SCHARS (STRING), because the latter returns the length of
25156 the internal string. */
25157 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25159 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25160 && begpos
<= tmp_glyph
->charpos
25161 && tmp_glyph
->charpos
< endpos
));
25164 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25166 /* Calculate the total pixel width of all the glyphs between
25167 the beginning of the highlighted area and GLYPH. */
25168 total_pixel_width
= 0;
25169 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25170 total_pixel_width
+= tmp_glyph
->pixel_width
;
25172 /* Pre calculation of re-rendering position. Note: X is in
25173 column units here, after the call to mode_line_string or
25174 marginal_area_string. */
25176 vpos
= (area
== ON_MODE_LINE
25177 ? (w
->current_matrix
)->nrows
- 1
25180 /* If GLYPH's position is included in the region that is
25181 already drawn in mouse face, we have nothing to do. */
25182 if ( EQ (window
, hlinfo
->mouse_face_window
)
25183 && (!row
->reversed_p
25184 ? (hlinfo
->mouse_face_beg_col
<= hpos
25185 && hpos
< hlinfo
->mouse_face_end_col
)
25186 /* In R2L rows we swap BEG and END, see below. */
25187 : (hlinfo
->mouse_face_end_col
<= hpos
25188 && hpos
< hlinfo
->mouse_face_beg_col
))
25189 && hlinfo
->mouse_face_beg_row
== vpos
)
25192 if (clear_mouse_face (hlinfo
))
25193 cursor
= No_Cursor
;
25195 if (!row
->reversed_p
)
25197 hlinfo
->mouse_face_beg_col
= hpos
;
25198 hlinfo
->mouse_face_beg_x
= original_x_pixel
25199 - (total_pixel_width
+ dx
);
25200 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25201 hlinfo
->mouse_face_end_x
= 0;
25205 /* In R2L rows, show_mouse_face expects BEG and END
25206 coordinates to be swapped. */
25207 hlinfo
->mouse_face_end_col
= hpos
;
25208 hlinfo
->mouse_face_end_x
= original_x_pixel
25209 - (total_pixel_width
+ dx
);
25210 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25211 hlinfo
->mouse_face_beg_x
= 0;
25214 hlinfo
->mouse_face_beg_row
= vpos
;
25215 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25216 hlinfo
->mouse_face_beg_y
= 0;
25217 hlinfo
->mouse_face_end_y
= 0;
25218 hlinfo
->mouse_face_past_end
= 0;
25219 hlinfo
->mouse_face_window
= window
;
25221 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25227 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25229 if (NILP (pointer
))
25232 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25233 clear_mouse_face (hlinfo
);
25235 #ifdef HAVE_WINDOW_SYSTEM
25236 if (FRAME_WINDOW_P (f
))
25237 define_frame_cursor1 (f
, cursor
, pointer
);
25243 Take proper action when the mouse has moved to position X, Y on
25244 frame F as regards highlighting characters that have mouse-face
25245 properties. Also de-highlighting chars where the mouse was before.
25246 X and Y can be negative or out of range. */
25249 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25251 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25252 enum window_part part
;
25253 Lisp_Object window
;
25255 Cursor cursor
= No_Cursor
;
25256 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25259 /* When a menu is active, don't highlight because this looks odd. */
25260 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25261 if (popup_activated ())
25265 if (NILP (Vmouse_highlight
)
25266 || !f
->glyphs_initialized_p
25267 || f
->pointer_invisible
)
25270 hlinfo
->mouse_face_mouse_x
= x
;
25271 hlinfo
->mouse_face_mouse_y
= y
;
25272 hlinfo
->mouse_face_mouse_frame
= f
;
25274 if (hlinfo
->mouse_face_defer
)
25277 if (gc_in_progress
)
25279 hlinfo
->mouse_face_deferred_gc
= 1;
25283 /* Which window is that in? */
25284 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25286 /* If we were displaying active text in another window, clear that.
25287 Also clear if we move out of text area in same window. */
25288 if (! EQ (window
, hlinfo
->mouse_face_window
)
25289 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25290 && !NILP (hlinfo
->mouse_face_window
)))
25291 clear_mouse_face (hlinfo
);
25293 /* Not on a window -> return. */
25294 if (!WINDOWP (window
))
25297 /* Reset help_echo_string. It will get recomputed below. */
25298 help_echo_string
= Qnil
;
25300 /* Convert to window-relative pixel coordinates. */
25301 w
= XWINDOW (window
);
25302 frame_to_window_pixel_xy (w
, &x
, &y
);
25304 #ifdef HAVE_WINDOW_SYSTEM
25305 /* Handle tool-bar window differently since it doesn't display a
25307 if (EQ (window
, f
->tool_bar_window
))
25309 note_tool_bar_highlight (f
, x
, y
);
25314 /* Mouse is on the mode, header line or margin? */
25315 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25316 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25318 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25322 #ifdef HAVE_WINDOW_SYSTEM
25323 if (part
== ON_VERTICAL_BORDER
)
25325 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25326 help_echo_string
= build_string ("drag-mouse-1: resize");
25328 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25329 || part
== ON_SCROLL_BAR
)
25330 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25332 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25335 /* Are we in a window whose display is up to date?
25336 And verify the buffer's text has not changed. */
25337 b
= XBUFFER (w
->buffer
);
25338 if (part
== ON_TEXT
25339 && EQ (w
->window_end_valid
, w
->buffer
)
25340 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25341 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25343 int hpos
, vpos
, i
, dx
, dy
, area
;
25345 struct glyph
*glyph
;
25346 Lisp_Object object
;
25347 Lisp_Object mouse_face
= Qnil
, position
;
25348 Lisp_Object
*overlay_vec
= NULL
;
25350 struct buffer
*obuf
;
25351 EMACS_INT obegv
, ozv
;
25354 /* Find the glyph under X/Y. */
25355 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25357 #ifdef HAVE_WINDOW_SYSTEM
25358 /* Look for :pointer property on image. */
25359 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25361 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25362 if (img
!= NULL
&& IMAGEP (img
->spec
))
25364 Lisp_Object image_map
, hotspot
;
25365 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25367 && (hotspot
= find_hot_spot (image_map
,
25368 glyph
->slice
.img
.x
+ dx
,
25369 glyph
->slice
.img
.y
+ dy
),
25371 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25375 /* Could check XCAR (hotspot) to see if we enter/leave
25377 If so, we could look for mouse-enter, mouse-leave
25378 properties in PLIST (and do something...). */
25379 hotspot
= XCDR (hotspot
);
25380 if (CONSP (hotspot
)
25381 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25383 pointer
= Fplist_get (plist
, Qpointer
);
25384 if (NILP (pointer
))
25386 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25387 if (!NILP (help_echo_string
))
25389 help_echo_window
= window
;
25390 help_echo_object
= glyph
->object
;
25391 help_echo_pos
= glyph
->charpos
;
25395 if (NILP (pointer
))
25396 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25399 #endif /* HAVE_WINDOW_SYSTEM */
25401 /* Clear mouse face if X/Y not over text. */
25403 || area
!= TEXT_AREA
25404 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25405 /* Glyph's OBJECT is an integer for glyphs inserted by the
25406 display engine for its internal purposes, like truncation
25407 and continuation glyphs and blanks beyond the end of
25408 line's text on text terminals. If we are over such a
25409 glyph, we are not over any text. */
25410 || INTEGERP (glyph
->object
)
25411 /* R2L rows have a stretch glyph at their front, which
25412 stands for no text, whereas L2R rows have no glyphs at
25413 all beyond the end of text. Treat such stretch glyphs
25414 like we do with NULL glyphs in L2R rows. */
25415 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25416 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25417 && glyph
->type
== STRETCH_GLYPH
25418 && glyph
->avoid_cursor_p
))
25420 if (clear_mouse_face (hlinfo
))
25421 cursor
= No_Cursor
;
25422 #ifdef HAVE_WINDOW_SYSTEM
25423 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25425 if (area
!= TEXT_AREA
)
25426 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25428 pointer
= Vvoid_text_area_pointer
;
25434 pos
= glyph
->charpos
;
25435 object
= glyph
->object
;
25436 if (!STRINGP (object
) && !BUFFERP (object
))
25439 /* If we get an out-of-range value, return now; avoid an error. */
25440 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25443 /* Make the window's buffer temporarily current for
25444 overlays_at and compute_char_face. */
25445 obuf
= current_buffer
;
25446 current_buffer
= b
;
25452 /* Is this char mouse-active or does it have help-echo? */
25453 position
= make_number (pos
);
25455 if (BUFFERP (object
))
25457 /* Put all the overlays we want in a vector in overlay_vec. */
25458 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25459 /* Sort overlays into increasing priority order. */
25460 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25465 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25468 cursor
= No_Cursor
;
25470 /* Check mouse-face highlighting. */
25472 /* If there exists an overlay with mouse-face overlapping
25473 the one we are currently highlighting, we have to
25474 check if we enter the overlapping overlay, and then
25475 highlight only that. */
25476 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25477 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25479 /* Find the highest priority overlay with a mouse-face. */
25480 Lisp_Object overlay
= Qnil
;
25481 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25483 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25484 if (!NILP (mouse_face
))
25485 overlay
= overlay_vec
[i
];
25488 /* If we're highlighting the same overlay as before, there's
25489 no need to do that again. */
25490 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25491 goto check_help_echo
;
25492 hlinfo
->mouse_face_overlay
= overlay
;
25494 /* Clear the display of the old active region, if any. */
25495 if (clear_mouse_face (hlinfo
))
25496 cursor
= No_Cursor
;
25498 /* If no overlay applies, get a text property. */
25499 if (NILP (overlay
))
25500 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25502 /* Next, compute the bounds of the mouse highlighting and
25504 if (!NILP (mouse_face
) && STRINGP (object
))
25506 /* The mouse-highlighting comes from a display string
25507 with a mouse-face. */
25511 s
= Fprevious_single_property_change
25512 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25513 e
= Fnext_single_property_change
25514 (position
, Qmouse_face
, object
, Qnil
);
25516 s
= make_number (0);
25518 e
= make_number (SCHARS (object
) - 1);
25519 mouse_face_from_string_pos (w
, hlinfo
, object
,
25520 XINT (s
), XINT (e
));
25521 hlinfo
->mouse_face_past_end
= 0;
25522 hlinfo
->mouse_face_window
= window
;
25523 hlinfo
->mouse_face_face_id
25524 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25525 glyph
->face_id
, 1);
25526 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25527 cursor
= No_Cursor
;
25531 /* The mouse-highlighting, if any, comes from an overlay
25532 or text property in the buffer. */
25533 Lisp_Object buffer
IF_LINT (= Qnil
);
25534 Lisp_Object cover_string
IF_LINT (= Qnil
);
25536 if (STRINGP (object
))
25538 /* If we are on a display string with no mouse-face,
25539 check if the text under it has one. */
25540 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25541 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25542 pos
= string_buffer_position (object
, start
);
25545 mouse_face
= get_char_property_and_overlay
25546 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25547 buffer
= w
->buffer
;
25548 cover_string
= object
;
25554 cover_string
= Qnil
;
25557 if (!NILP (mouse_face
))
25559 Lisp_Object before
, after
;
25560 Lisp_Object before_string
, after_string
;
25561 /* To correctly find the limits of mouse highlight
25562 in a bidi-reordered buffer, we must not use the
25563 optimization of limiting the search in
25564 previous-single-property-change and
25565 next-single-property-change, because
25566 rows_from_pos_range needs the real start and end
25567 positions to DTRT in this case. That's because
25568 the first row visible in a window does not
25569 necessarily display the character whose position
25570 is the smallest. */
25572 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25573 ? Fmarker_position (w
->start
)
25576 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25577 ? make_number (BUF_Z (XBUFFER (buffer
))
25578 - XFASTINT (w
->window_end_pos
))
25581 if (NILP (overlay
))
25583 /* Handle the text property case. */
25584 before
= Fprevious_single_property_change
25585 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25586 after
= Fnext_single_property_change
25587 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25588 before_string
= after_string
= Qnil
;
25592 /* Handle the overlay case. */
25593 before
= Foverlay_start (overlay
);
25594 after
= Foverlay_end (overlay
);
25595 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25596 after_string
= Foverlay_get (overlay
, Qafter_string
);
25598 if (!STRINGP (before_string
)) before_string
= Qnil
;
25599 if (!STRINGP (after_string
)) after_string
= Qnil
;
25602 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25605 before_string
, after_string
,
25607 cursor
= No_Cursor
;
25614 /* Look for a `help-echo' property. */
25615 if (NILP (help_echo_string
)) {
25616 Lisp_Object help
, overlay
;
25618 /* Check overlays first. */
25619 help
= overlay
= Qnil
;
25620 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25622 overlay
= overlay_vec
[i
];
25623 help
= Foverlay_get (overlay
, Qhelp_echo
);
25628 help_echo_string
= help
;
25629 help_echo_window
= window
;
25630 help_echo_object
= overlay
;
25631 help_echo_pos
= pos
;
25635 Lisp_Object obj
= glyph
->object
;
25636 EMACS_INT charpos
= glyph
->charpos
;
25638 /* Try text properties. */
25641 && charpos
< SCHARS (obj
))
25643 help
= Fget_text_property (make_number (charpos
),
25647 /* If the string itself doesn't specify a help-echo,
25648 see if the buffer text ``under'' it does. */
25649 struct glyph_row
*r
25650 = MATRIX_ROW (w
->current_matrix
, vpos
);
25651 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25652 EMACS_INT p
= string_buffer_position (obj
, start
);
25655 help
= Fget_char_property (make_number (p
),
25656 Qhelp_echo
, w
->buffer
);
25665 else if (BUFFERP (obj
)
25668 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25673 help_echo_string
= help
;
25674 help_echo_window
= window
;
25675 help_echo_object
= obj
;
25676 help_echo_pos
= charpos
;
25681 #ifdef HAVE_WINDOW_SYSTEM
25682 /* Look for a `pointer' property. */
25683 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25685 /* Check overlays first. */
25686 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25687 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25689 if (NILP (pointer
))
25691 Lisp_Object obj
= glyph
->object
;
25692 EMACS_INT charpos
= glyph
->charpos
;
25694 /* Try text properties. */
25697 && charpos
< SCHARS (obj
))
25699 pointer
= Fget_text_property (make_number (charpos
),
25701 if (NILP (pointer
))
25703 /* If the string itself doesn't specify a pointer,
25704 see if the buffer text ``under'' it does. */
25705 struct glyph_row
*r
25706 = MATRIX_ROW (w
->current_matrix
, vpos
);
25707 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25708 EMACS_INT p
= string_buffer_position (obj
, start
);
25710 pointer
= Fget_char_property (make_number (p
),
25711 Qpointer
, w
->buffer
);
25714 else if (BUFFERP (obj
)
25717 pointer
= Fget_text_property (make_number (charpos
),
25721 #endif /* HAVE_WINDOW_SYSTEM */
25725 current_buffer
= obuf
;
25730 #ifdef HAVE_WINDOW_SYSTEM
25731 if (FRAME_WINDOW_P (f
))
25732 define_frame_cursor1 (f
, cursor
, pointer
);
25734 /* This is here to prevent a compiler error, about "label at end of
25735 compound statement". */
25742 Clear any mouse-face on window W. This function is part of the
25743 redisplay interface, and is called from try_window_id and similar
25744 functions to ensure the mouse-highlight is off. */
25747 x_clear_window_mouse_face (struct window
*w
)
25749 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25750 Lisp_Object window
;
25753 XSETWINDOW (window
, w
);
25754 if (EQ (window
, hlinfo
->mouse_face_window
))
25755 clear_mouse_face (hlinfo
);
25761 Just discard the mouse face information for frame F, if any.
25762 This is used when the size of F is changed. */
25765 cancel_mouse_face (struct frame
*f
)
25767 Lisp_Object window
;
25768 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25770 window
= hlinfo
->mouse_face_window
;
25771 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25773 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25774 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25775 hlinfo
->mouse_face_window
= Qnil
;
25781 /***********************************************************************
25783 ***********************************************************************/
25785 #ifdef HAVE_WINDOW_SYSTEM
25787 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25788 which intersects rectangle R. R is in window-relative coordinates. */
25791 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25792 enum glyph_row_area area
)
25794 struct glyph
*first
= row
->glyphs
[area
];
25795 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25796 struct glyph
*last
;
25797 int first_x
, start_x
, x
;
25799 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25800 /* If row extends face to end of line write the whole line. */
25801 draw_glyphs (w
, 0, row
, area
,
25802 0, row
->used
[area
],
25803 DRAW_NORMAL_TEXT
, 0);
25806 /* Set START_X to the window-relative start position for drawing glyphs of
25807 AREA. The first glyph of the text area can be partially visible.
25808 The first glyphs of other areas cannot. */
25809 start_x
= window_box_left_offset (w
, area
);
25811 if (area
== TEXT_AREA
)
25814 /* Find the first glyph that must be redrawn. */
25816 && x
+ first
->pixel_width
< r
->x
)
25818 x
+= first
->pixel_width
;
25822 /* Find the last one. */
25826 && x
< r
->x
+ r
->width
)
25828 x
+= last
->pixel_width
;
25834 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25835 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25836 DRAW_NORMAL_TEXT
, 0);
25841 /* Redraw the parts of the glyph row ROW on window W intersecting
25842 rectangle R. R is in window-relative coordinates. Value is
25843 non-zero if mouse-face was overwritten. */
25846 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25848 xassert (row
->enabled_p
);
25850 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25851 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25852 0, row
->used
[TEXT_AREA
],
25853 DRAW_NORMAL_TEXT
, 0);
25856 if (row
->used
[LEFT_MARGIN_AREA
])
25857 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25858 if (row
->used
[TEXT_AREA
])
25859 expose_area (w
, row
, r
, TEXT_AREA
);
25860 if (row
->used
[RIGHT_MARGIN_AREA
])
25861 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25862 draw_row_fringe_bitmaps (w
, row
);
25865 return row
->mouse_face_p
;
25869 /* Redraw those parts of glyphs rows during expose event handling that
25870 overlap other rows. Redrawing of an exposed line writes over parts
25871 of lines overlapping that exposed line; this function fixes that.
25873 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25874 row in W's current matrix that is exposed and overlaps other rows.
25875 LAST_OVERLAPPING_ROW is the last such row. */
25878 expose_overlaps (struct window
*w
,
25879 struct glyph_row
*first_overlapping_row
,
25880 struct glyph_row
*last_overlapping_row
,
25883 struct glyph_row
*row
;
25885 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25886 if (row
->overlapping_p
)
25888 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25891 if (row
->used
[LEFT_MARGIN_AREA
])
25892 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25894 if (row
->used
[TEXT_AREA
])
25895 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25897 if (row
->used
[RIGHT_MARGIN_AREA
])
25898 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25904 /* Return non-zero if W's cursor intersects rectangle R. */
25907 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25909 XRectangle cr
, result
;
25910 struct glyph
*cursor_glyph
;
25911 struct glyph_row
*row
;
25913 if (w
->phys_cursor
.vpos
>= 0
25914 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25915 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25917 && row
->cursor_in_fringe_p
)
25919 /* Cursor is in the fringe. */
25920 cr
.x
= window_box_right_offset (w
,
25921 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25922 ? RIGHT_MARGIN_AREA
25925 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25926 cr
.height
= row
->height
;
25927 return x_intersect_rectangles (&cr
, r
, &result
);
25930 cursor_glyph
= get_phys_cursor_glyph (w
);
25933 /* r is relative to W's box, but w->phys_cursor.x is relative
25934 to left edge of W's TEXT area. Adjust it. */
25935 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25936 cr
.y
= w
->phys_cursor
.y
;
25937 cr
.width
= cursor_glyph
->pixel_width
;
25938 cr
.height
= w
->phys_cursor_height
;
25939 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25940 I assume the effect is the same -- and this is portable. */
25941 return x_intersect_rectangles (&cr
, r
, &result
);
25943 /* If we don't understand the format, pretend we're not in the hot-spot. */
25949 Draw a vertical window border to the right of window W if W doesn't
25950 have vertical scroll bars. */
25953 x_draw_vertical_border (struct window
*w
)
25955 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25957 /* We could do better, if we knew what type of scroll-bar the adjacent
25958 windows (on either side) have... But we don't :-(
25959 However, I think this works ok. ++KFS 2003-04-25 */
25961 /* Redraw borders between horizontally adjacent windows. Don't
25962 do it for frames with vertical scroll bars because either the
25963 right scroll bar of a window, or the left scroll bar of its
25964 neighbor will suffice as a border. */
25965 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25968 if (!WINDOW_RIGHTMOST_P (w
)
25969 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25971 int x0
, x1
, y0
, y1
;
25973 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25976 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25979 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25981 else if (!WINDOW_LEFTMOST_P (w
)
25982 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25984 int x0
, x1
, y0
, y1
;
25986 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25989 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25992 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25997 /* Redraw the part of window W intersection rectangle FR. Pixel
25998 coordinates in FR are frame-relative. Call this function with
25999 input blocked. Value is non-zero if the exposure overwrites
26003 expose_window (struct window
*w
, XRectangle
*fr
)
26005 struct frame
*f
= XFRAME (w
->frame
);
26007 int mouse_face_overwritten_p
= 0;
26009 /* If window is not yet fully initialized, do nothing. This can
26010 happen when toolkit scroll bars are used and a window is split.
26011 Reconfiguring the scroll bar will generate an expose for a newly
26013 if (w
->current_matrix
== NULL
)
26016 /* When we're currently updating the window, display and current
26017 matrix usually don't agree. Arrange for a thorough display
26019 if (w
== updated_window
)
26021 SET_FRAME_GARBAGED (f
);
26025 /* Frame-relative pixel rectangle of W. */
26026 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26027 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26028 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26029 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26031 if (x_intersect_rectangles (fr
, &wr
, &r
))
26033 int yb
= window_text_bottom_y (w
);
26034 struct glyph_row
*row
;
26035 int cursor_cleared_p
;
26036 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26038 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26039 r
.x
, r
.y
, r
.width
, r
.height
));
26041 /* Convert to window coordinates. */
26042 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26043 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26045 /* Turn off the cursor. */
26046 if (!w
->pseudo_window_p
26047 && phys_cursor_in_rect_p (w
, &r
))
26049 x_clear_cursor (w
);
26050 cursor_cleared_p
= 1;
26053 cursor_cleared_p
= 0;
26055 /* Update lines intersecting rectangle R. */
26056 first_overlapping_row
= last_overlapping_row
= NULL
;
26057 for (row
= w
->current_matrix
->rows
;
26062 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26064 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26065 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26066 || (r
.y
>= y0
&& r
.y
< y1
)
26067 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26069 /* A header line may be overlapping, but there is no need
26070 to fix overlapping areas for them. KFS 2005-02-12 */
26071 if (row
->overlapping_p
&& !row
->mode_line_p
)
26073 if (first_overlapping_row
== NULL
)
26074 first_overlapping_row
= row
;
26075 last_overlapping_row
= row
;
26079 if (expose_line (w
, row
, &r
))
26080 mouse_face_overwritten_p
= 1;
26083 else if (row
->overlapping_p
)
26085 /* We must redraw a row overlapping the exposed area. */
26087 ? y0
+ row
->phys_height
> r
.y
26088 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26090 if (first_overlapping_row
== NULL
)
26091 first_overlapping_row
= row
;
26092 last_overlapping_row
= row
;
26100 /* Display the mode line if there is one. */
26101 if (WINDOW_WANTS_MODELINE_P (w
)
26102 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26104 && row
->y
< r
.y
+ r
.height
)
26106 if (expose_line (w
, row
, &r
))
26107 mouse_face_overwritten_p
= 1;
26110 if (!w
->pseudo_window_p
)
26112 /* Fix the display of overlapping rows. */
26113 if (first_overlapping_row
)
26114 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26117 /* Draw border between windows. */
26118 x_draw_vertical_border (w
);
26120 /* Turn the cursor on again. */
26121 if (cursor_cleared_p
)
26122 update_window_cursor (w
, 1);
26126 return mouse_face_overwritten_p
;
26131 /* Redraw (parts) of all windows in the window tree rooted at W that
26132 intersect R. R contains frame pixel coordinates. Value is
26133 non-zero if the exposure overwrites mouse-face. */
26136 expose_window_tree (struct window
*w
, XRectangle
*r
)
26138 struct frame
*f
= XFRAME (w
->frame
);
26139 int mouse_face_overwritten_p
= 0;
26141 while (w
&& !FRAME_GARBAGED_P (f
))
26143 if (!NILP (w
->hchild
))
26144 mouse_face_overwritten_p
26145 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26146 else if (!NILP (w
->vchild
))
26147 mouse_face_overwritten_p
26148 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26150 mouse_face_overwritten_p
|= expose_window (w
, r
);
26152 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26155 return mouse_face_overwritten_p
;
26160 Redisplay an exposed area of frame F. X and Y are the upper-left
26161 corner of the exposed rectangle. W and H are width and height of
26162 the exposed area. All are pixel values. W or H zero means redraw
26163 the entire frame. */
26166 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26169 int mouse_face_overwritten_p
= 0;
26171 TRACE ((stderr
, "expose_frame "));
26173 /* No need to redraw if frame will be redrawn soon. */
26174 if (FRAME_GARBAGED_P (f
))
26176 TRACE ((stderr
, " garbaged\n"));
26180 /* If basic faces haven't been realized yet, there is no point in
26181 trying to redraw anything. This can happen when we get an expose
26182 event while Emacs is starting, e.g. by moving another window. */
26183 if (FRAME_FACE_CACHE (f
) == NULL
26184 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26186 TRACE ((stderr
, " no faces\n"));
26190 if (w
== 0 || h
== 0)
26193 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26194 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26204 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26205 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26207 if (WINDOWP (f
->tool_bar_window
))
26208 mouse_face_overwritten_p
26209 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26211 #ifdef HAVE_X_WINDOWS
26213 #ifndef USE_X_TOOLKIT
26214 if (WINDOWP (f
->menu_bar_window
))
26215 mouse_face_overwritten_p
26216 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26217 #endif /* not USE_X_TOOLKIT */
26221 /* Some window managers support a focus-follows-mouse style with
26222 delayed raising of frames. Imagine a partially obscured frame,
26223 and moving the mouse into partially obscured mouse-face on that
26224 frame. The visible part of the mouse-face will be highlighted,
26225 then the WM raises the obscured frame. With at least one WM, KDE
26226 2.1, Emacs is not getting any event for the raising of the frame
26227 (even tried with SubstructureRedirectMask), only Expose events.
26228 These expose events will draw text normally, i.e. not
26229 highlighted. Which means we must redo the highlight here.
26230 Subsume it under ``we love X''. --gerd 2001-08-15 */
26231 /* Included in Windows version because Windows most likely does not
26232 do the right thing if any third party tool offers
26233 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26234 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26236 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26237 if (f
== hlinfo
->mouse_face_mouse_frame
)
26239 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26240 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26241 clear_mouse_face (hlinfo
);
26242 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26249 Determine the intersection of two rectangles R1 and R2. Return
26250 the intersection in *RESULT. Value is non-zero if RESULT is not
26254 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26256 XRectangle
*left
, *right
;
26257 XRectangle
*upper
, *lower
;
26258 int intersection_p
= 0;
26260 /* Rearrange so that R1 is the left-most rectangle. */
26262 left
= r1
, right
= r2
;
26264 left
= r2
, right
= r1
;
26266 /* X0 of the intersection is right.x0, if this is inside R1,
26267 otherwise there is no intersection. */
26268 if (right
->x
<= left
->x
+ left
->width
)
26270 result
->x
= right
->x
;
26272 /* The right end of the intersection is the minimum of the
26273 the right ends of left and right. */
26274 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26277 /* Same game for Y. */
26279 upper
= r1
, lower
= r2
;
26281 upper
= r2
, lower
= r1
;
26283 /* The upper end of the intersection is lower.y0, if this is inside
26284 of upper. Otherwise, there is no intersection. */
26285 if (lower
->y
<= upper
->y
+ upper
->height
)
26287 result
->y
= lower
->y
;
26289 /* The lower end of the intersection is the minimum of the lower
26290 ends of upper and lower. */
26291 result
->height
= (min (lower
->y
+ lower
->height
,
26292 upper
->y
+ upper
->height
)
26294 intersection_p
= 1;
26298 return intersection_p
;
26301 #endif /* HAVE_WINDOW_SYSTEM */
26304 /***********************************************************************
26306 ***********************************************************************/
26309 syms_of_xdisp (void)
26311 Vwith_echo_area_save_vector
= Qnil
;
26312 staticpro (&Vwith_echo_area_save_vector
);
26314 Vmessage_stack
= Qnil
;
26315 staticpro (&Vmessage_stack
);
26317 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26318 staticpro (&Qinhibit_redisplay
);
26320 message_dolog_marker1
= Fmake_marker ();
26321 staticpro (&message_dolog_marker1
);
26322 message_dolog_marker2
= Fmake_marker ();
26323 staticpro (&message_dolog_marker2
);
26324 message_dolog_marker3
= Fmake_marker ();
26325 staticpro (&message_dolog_marker3
);
26328 defsubr (&Sdump_frame_glyph_matrix
);
26329 defsubr (&Sdump_glyph_matrix
);
26330 defsubr (&Sdump_glyph_row
);
26331 defsubr (&Sdump_tool_bar_row
);
26332 defsubr (&Strace_redisplay
);
26333 defsubr (&Strace_to_stderr
);
26335 #ifdef HAVE_WINDOW_SYSTEM
26336 defsubr (&Stool_bar_lines_needed
);
26337 defsubr (&Slookup_image_map
);
26339 defsubr (&Sformat_mode_line
);
26340 defsubr (&Sinvisible_p
);
26341 defsubr (&Scurrent_bidi_paragraph_direction
);
26343 staticpro (&Qmenu_bar_update_hook
);
26344 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26346 staticpro (&Qoverriding_terminal_local_map
);
26347 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26349 staticpro (&Qoverriding_local_map
);
26350 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26352 staticpro (&Qwindow_scroll_functions
);
26353 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26355 staticpro (&Qwindow_text_change_functions
);
26356 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26358 staticpro (&Qredisplay_end_trigger_functions
);
26359 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26361 staticpro (&Qinhibit_point_motion_hooks
);
26362 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26364 Qeval
= intern_c_string ("eval");
26365 staticpro (&Qeval
);
26367 QCdata
= intern_c_string (":data");
26368 staticpro (&QCdata
);
26369 Qdisplay
= intern_c_string ("display");
26370 staticpro (&Qdisplay
);
26371 Qspace_width
= intern_c_string ("space-width");
26372 staticpro (&Qspace_width
);
26373 Qraise
= intern_c_string ("raise");
26374 staticpro (&Qraise
);
26375 Qslice
= intern_c_string ("slice");
26376 staticpro (&Qslice
);
26377 Qspace
= intern_c_string ("space");
26378 staticpro (&Qspace
);
26379 Qmargin
= intern_c_string ("margin");
26380 staticpro (&Qmargin
);
26381 Qpointer
= intern_c_string ("pointer");
26382 staticpro (&Qpointer
);
26383 Qleft_margin
= intern_c_string ("left-margin");
26384 staticpro (&Qleft_margin
);
26385 Qright_margin
= intern_c_string ("right-margin");
26386 staticpro (&Qright_margin
);
26387 Qcenter
= intern_c_string ("center");
26388 staticpro (&Qcenter
);
26389 Qline_height
= intern_c_string ("line-height");
26390 staticpro (&Qline_height
);
26391 QCalign_to
= intern_c_string (":align-to");
26392 staticpro (&QCalign_to
);
26393 QCrelative_width
= intern_c_string (":relative-width");
26394 staticpro (&QCrelative_width
);
26395 QCrelative_height
= intern_c_string (":relative-height");
26396 staticpro (&QCrelative_height
);
26397 QCeval
= intern_c_string (":eval");
26398 staticpro (&QCeval
);
26399 QCpropertize
= intern_c_string (":propertize");
26400 staticpro (&QCpropertize
);
26401 QCfile
= intern_c_string (":file");
26402 staticpro (&QCfile
);
26403 Qfontified
= intern_c_string ("fontified");
26404 staticpro (&Qfontified
);
26405 Qfontification_functions
= intern_c_string ("fontification-functions");
26406 staticpro (&Qfontification_functions
);
26407 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26408 staticpro (&Qtrailing_whitespace
);
26409 Qescape_glyph
= intern_c_string ("escape-glyph");
26410 staticpro (&Qescape_glyph
);
26411 Qnobreak_space
= intern_c_string ("nobreak-space");
26412 staticpro (&Qnobreak_space
);
26413 Qimage
= intern_c_string ("image");
26414 staticpro (&Qimage
);
26415 Qtext
= intern_c_string ("text");
26416 staticpro (&Qtext
);
26417 Qboth
= intern_c_string ("both");
26418 staticpro (&Qboth
);
26419 Qboth_horiz
= intern_c_string ("both-horiz");
26420 staticpro (&Qboth_horiz
);
26421 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26422 staticpro (&Qtext_image_horiz
);
26423 QCmap
= intern_c_string (":map");
26424 staticpro (&QCmap
);
26425 QCpointer
= intern_c_string (":pointer");
26426 staticpro (&QCpointer
);
26427 Qrect
= intern_c_string ("rect");
26428 staticpro (&Qrect
);
26429 Qcircle
= intern_c_string ("circle");
26430 staticpro (&Qcircle
);
26431 Qpoly
= intern_c_string ("poly");
26432 staticpro (&Qpoly
);
26433 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26434 staticpro (&Qmessage_truncate_lines
);
26435 Qgrow_only
= intern_c_string ("grow-only");
26436 staticpro (&Qgrow_only
);
26437 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26438 staticpro (&Qinhibit_menubar_update
);
26439 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26440 staticpro (&Qinhibit_eval_during_redisplay
);
26441 Qposition
= intern_c_string ("position");
26442 staticpro (&Qposition
);
26443 Qbuffer_position
= intern_c_string ("buffer-position");
26444 staticpro (&Qbuffer_position
);
26445 Qobject
= intern_c_string ("object");
26446 staticpro (&Qobject
);
26447 Qbar
= intern_c_string ("bar");
26449 Qhbar
= intern_c_string ("hbar");
26450 staticpro (&Qhbar
);
26451 Qbox
= intern_c_string ("box");
26453 Qhollow
= intern_c_string ("hollow");
26454 staticpro (&Qhollow
);
26455 Qhand
= intern_c_string ("hand");
26456 staticpro (&Qhand
);
26457 Qarrow
= intern_c_string ("arrow");
26458 staticpro (&Qarrow
);
26459 Qtext
= intern_c_string ("text");
26460 staticpro (&Qtext
);
26461 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26462 staticpro (&Qinhibit_free_realized_faces
);
26464 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26465 Fcons (intern_c_string ("void-variable"), Qnil
)),
26467 staticpro (&list_of_error
);
26469 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26470 staticpro (&Qlast_arrow_position
);
26471 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26472 staticpro (&Qlast_arrow_string
);
26474 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26475 staticpro (&Qoverlay_arrow_string
);
26476 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26477 staticpro (&Qoverlay_arrow_bitmap
);
26479 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26480 staticpro (&echo_buffer
[0]);
26481 staticpro (&echo_buffer
[1]);
26483 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26484 staticpro (&echo_area_buffer
[0]);
26485 staticpro (&echo_area_buffer
[1]);
26487 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26488 staticpro (&Vmessages_buffer_name
);
26490 mode_line_proptrans_alist
= Qnil
;
26491 staticpro (&mode_line_proptrans_alist
);
26492 mode_line_string_list
= Qnil
;
26493 staticpro (&mode_line_string_list
);
26494 mode_line_string_face
= Qnil
;
26495 staticpro (&mode_line_string_face
);
26496 mode_line_string_face_prop
= Qnil
;
26497 staticpro (&mode_line_string_face_prop
);
26498 Vmode_line_unwind_vector
= Qnil
;
26499 staticpro (&Vmode_line_unwind_vector
);
26501 help_echo_string
= Qnil
;
26502 staticpro (&help_echo_string
);
26503 help_echo_object
= Qnil
;
26504 staticpro (&help_echo_object
);
26505 help_echo_window
= Qnil
;
26506 staticpro (&help_echo_window
);
26507 previous_help_echo_string
= Qnil
;
26508 staticpro (&previous_help_echo_string
);
26509 help_echo_pos
= -1;
26511 Qright_to_left
= intern_c_string ("right-to-left");
26512 staticpro (&Qright_to_left
);
26513 Qleft_to_right
= intern_c_string ("left-to-right");
26514 staticpro (&Qleft_to_right
);
26516 #ifdef HAVE_WINDOW_SYSTEM
26517 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26518 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26519 For example, if a block cursor is over a tab, it will be drawn as
26520 wide as that tab on the display. */);
26521 x_stretch_cursor_p
= 0;
26524 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26525 doc
: /* *Non-nil means highlight trailing whitespace.
26526 The face used for trailing whitespace is `trailing-whitespace'. */);
26527 Vshow_trailing_whitespace
= Qnil
;
26529 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26530 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26531 A value of t means highlight the character itself (for nobreak space,
26532 use face `nobreak-space').
26533 A value of nil means no highlighting.
26534 Other values mean display the escape glyph followed by an ordinary
26535 space or ordinary hyphen. */);
26536 Vnobreak_char_display
= Qt
;
26538 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26539 doc
: /* *The pointer shape to show in void text areas.
26540 A value of nil means to show the text pointer. Other options are `arrow',
26541 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26542 Vvoid_text_area_pointer
= Qarrow
;
26544 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26545 doc
: /* Non-nil means don't actually do any redisplay.
26546 This is used for internal purposes. */);
26547 Vinhibit_redisplay
= Qnil
;
26549 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26550 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26551 Vglobal_mode_string
= Qnil
;
26553 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26554 doc
: /* Marker for where to display an arrow on top of the buffer text.
26555 This must be the beginning of a line in order to work.
26556 See also `overlay-arrow-string'. */);
26557 Voverlay_arrow_position
= Qnil
;
26559 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26560 doc
: /* String to display as an arrow in non-window frames.
26561 See also `overlay-arrow-position'. */);
26562 Voverlay_arrow_string
= make_pure_c_string ("=>");
26564 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26565 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26566 The symbols on this list are examined during redisplay to determine
26567 where to display overlay arrows. */);
26568 Voverlay_arrow_variable_list
26569 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26571 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26572 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26573 If that fails to bring point back on frame, point is centered instead.
26574 If this is zero, point is always centered after it moves off frame.
26575 If you want scrolling to always be a line at a time, you should set
26576 `scroll-conservatively' to a large value rather than set this to 1. */);
26578 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26579 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26580 If point moves off-screen, redisplay will scroll by up to
26581 `scroll-conservatively' lines in order to bring point just barely
26582 onto the screen again. If that cannot be done, then redisplay
26583 recenters point as usual.
26585 If the value is greater than 100, redisplay will never recenter point,
26586 but will always scroll just enough text to bring point into view, even
26587 if you move far away.
26589 A value of zero means always recenter point if it moves off screen. */);
26590 scroll_conservatively
= 0;
26592 DEFVAR_INT ("scroll-margin", scroll_margin
,
26593 doc
: /* *Number of lines of margin at the top and bottom of a window.
26594 Recenter the window whenever point gets within this many lines
26595 of the top or bottom of the window. */);
26598 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26599 doc
: /* Pixels per inch value for non-window system displays.
26600 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26601 Vdisplay_pixels_per_inch
= make_float (72.0);
26604 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26607 DEFVAR_LISP ("truncate-partial-width-windows",
26608 Vtruncate_partial_width_windows
,
26609 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26610 For an integer value, truncate lines in each window narrower than the
26611 full frame width, provided the window width is less than that integer;
26612 otherwise, respect the value of `truncate-lines'.
26614 For any other non-nil value, truncate lines in all windows that do
26615 not span the full frame width.
26617 A value of nil means to respect the value of `truncate-lines'.
26619 If `word-wrap' is enabled, you might want to reduce this. */);
26620 Vtruncate_partial_width_windows
= make_number (50);
26622 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26623 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26624 Any other value means to use the appropriate face, `mode-line',
26625 `header-line', or `menu' respectively. */);
26626 mode_line_inverse_video
= 1;
26628 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26629 doc
: /* *Maximum buffer size for which line number should be displayed.
26630 If the buffer is bigger than this, the line number does not appear
26631 in the mode line. A value of nil means no limit. */);
26632 Vline_number_display_limit
= Qnil
;
26634 DEFVAR_INT ("line-number-display-limit-width",
26635 line_number_display_limit_width
,
26636 doc
: /* *Maximum line width (in characters) for line number display.
26637 If the average length of the lines near point is bigger than this, then the
26638 line number may be omitted from the mode line. */);
26639 line_number_display_limit_width
= 200;
26641 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26642 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26643 highlight_nonselected_windows
= 0;
26645 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26646 doc
: /* Non-nil if more than one frame is visible on this display.
26647 Minibuffer-only frames don't count, but iconified frames do.
26648 This variable is not guaranteed to be accurate except while processing
26649 `frame-title-format' and `icon-title-format'. */);
26651 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26652 doc
: /* Template for displaying the title bar of visible frames.
26653 \(Assuming the window manager supports this feature.)
26655 This variable has the same structure as `mode-line-format', except that
26656 the %c and %l constructs are ignored. It is used only on frames for
26657 which no explicit name has been set \(see `modify-frame-parameters'). */);
26659 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26660 doc
: /* Template for displaying the title bar of an iconified frame.
26661 \(Assuming the window manager supports this feature.)
26662 This variable has the same structure as `mode-line-format' (which see),
26663 and is used only on frames for which no explicit name has been set
26664 \(see `modify-frame-parameters'). */);
26666 = Vframe_title_format
26667 = pure_cons (intern_c_string ("multiple-frames"),
26668 pure_cons (make_pure_c_string ("%b"),
26669 pure_cons (pure_cons (empty_unibyte_string
,
26670 pure_cons (intern_c_string ("invocation-name"),
26671 pure_cons (make_pure_c_string ("@"),
26672 pure_cons (intern_c_string ("system-name"),
26676 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26677 doc
: /* Maximum number of lines to keep in the message log buffer.
26678 If nil, disable message logging. If t, log messages but don't truncate
26679 the buffer when it becomes large. */);
26680 Vmessage_log_max
= make_number (100);
26682 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26683 doc
: /* Functions called before redisplay, if window sizes have changed.
26684 The value should be a list of functions that take one argument.
26685 Just before redisplay, for each frame, if any of its windows have changed
26686 size since the last redisplay, or have been split or deleted,
26687 all the functions in the list are called, with the frame as argument. */);
26688 Vwindow_size_change_functions
= Qnil
;
26690 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26691 doc
: /* List of functions to call before redisplaying a window with scrolling.
26692 Each function is called with two arguments, the window and its new
26693 display-start position. Note that these functions are also called by
26694 `set-window-buffer'. Also note that the value of `window-end' is not
26695 valid when these functions are called. */);
26696 Vwindow_scroll_functions
= Qnil
;
26698 DEFVAR_LISP ("window-text-change-functions",
26699 Vwindow_text_change_functions
,
26700 doc
: /* Functions to call in redisplay when text in the window might change. */);
26701 Vwindow_text_change_functions
= Qnil
;
26703 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26704 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26705 Each function is called with two arguments, the window and the end trigger value.
26706 See `set-window-redisplay-end-trigger'. */);
26707 Vredisplay_end_trigger_functions
= Qnil
;
26709 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26710 doc
: /* *Non-nil means autoselect window with mouse pointer.
26711 If nil, do not autoselect windows.
26712 A positive number means delay autoselection by that many seconds: a
26713 window is autoselected only after the mouse has remained in that
26714 window for the duration of the delay.
26715 A negative number has a similar effect, but causes windows to be
26716 autoselected only after the mouse has stopped moving. \(Because of
26717 the way Emacs compares mouse events, you will occasionally wait twice
26718 that time before the window gets selected.\)
26719 Any other value means to autoselect window instantaneously when the
26720 mouse pointer enters it.
26722 Autoselection selects the minibuffer only if it is active, and never
26723 unselects the minibuffer if it is active.
26725 When customizing this variable make sure that the actual value of
26726 `focus-follows-mouse' matches the behavior of your window manager. */);
26727 Vmouse_autoselect_window
= Qnil
;
26729 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26730 doc
: /* *Non-nil means automatically resize tool-bars.
26731 This dynamically changes the tool-bar's height to the minimum height
26732 that is needed to make all tool-bar items visible.
26733 If value is `grow-only', the tool-bar's height is only increased
26734 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26735 Vauto_resize_tool_bars
= Qt
;
26737 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26738 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26739 auto_raise_tool_bar_buttons_p
= 1;
26741 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26742 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26743 make_cursor_line_fully_visible_p
= 1;
26745 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26746 doc
: /* *Border below tool-bar in pixels.
26747 If an integer, use it as the height of the border.
26748 If it is one of `internal-border-width' or `border-width', use the
26749 value of the corresponding frame parameter.
26750 Otherwise, no border is added below the tool-bar. */);
26751 Vtool_bar_border
= Qinternal_border_width
;
26753 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26754 doc
: /* *Margin around tool-bar buttons in pixels.
26755 If an integer, use that for both horizontal and vertical margins.
26756 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26757 HORZ specifying the horizontal margin, and VERT specifying the
26758 vertical margin. */);
26759 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26761 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26762 doc
: /* *Relief thickness of tool-bar buttons. */);
26763 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26765 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26766 doc
: /* Tool bar style to use.
26768 image - show images only
26769 text - show text only
26770 both - show both, text below image
26771 both-horiz - show text to the right of the image
26772 text-image-horiz - show text to the left of the image
26773 any other - use system default or image if no system default. */);
26774 Vtool_bar_style
= Qnil
;
26776 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26777 doc
: /* *Maximum number of characters a label can have to be shown.
26778 The tool bar style must also show labels for this to have any effect, see
26779 `tool-bar-style'. */);
26780 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26782 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26783 doc
: /* List of functions to call to fontify regions of text.
26784 Each function is called with one argument POS. Functions must
26785 fontify a region starting at POS in the current buffer, and give
26786 fontified regions the property `fontified'. */);
26787 Vfontification_functions
= Qnil
;
26788 Fmake_variable_buffer_local (Qfontification_functions
);
26790 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26791 unibyte_display_via_language_environment
,
26792 doc
: /* *Non-nil means display unibyte text according to language environment.
26793 Specifically, this means that raw bytes in the range 160-255 decimal
26794 are displayed by converting them to the equivalent multibyte characters
26795 according to the current language environment. As a result, they are
26796 displayed according to the current fontset.
26798 Note that this variable affects only how these bytes are displayed,
26799 but does not change the fact they are interpreted as raw bytes. */);
26800 unibyte_display_via_language_environment
= 0;
26802 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26803 doc
: /* *Maximum height for resizing mini-windows.
26804 If a float, it specifies a fraction of the mini-window frame's height.
26805 If an integer, it specifies a number of lines. */);
26806 Vmax_mini_window_height
= make_float (0.25);
26808 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26809 doc
: /* *How to resize mini-windows.
26810 A value of nil means don't automatically resize mini-windows.
26811 A value of t means resize them to fit the text displayed in them.
26812 A value of `grow-only', the default, means let mini-windows grow
26813 only, until their display becomes empty, at which point the windows
26814 go back to their normal size. */);
26815 Vresize_mini_windows
= Qgrow_only
;
26817 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26818 doc
: /* Alist specifying how to blink the cursor off.
26819 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26820 `cursor-type' frame-parameter or variable equals ON-STATE,
26821 comparing using `equal', Emacs uses OFF-STATE to specify
26822 how to blink it off. ON-STATE and OFF-STATE are values for
26823 the `cursor-type' frame parameter.
26825 If a frame's ON-STATE has no entry in this list,
26826 the frame's other specifications determine how to blink the cursor off. */);
26827 Vblink_cursor_alist
= Qnil
;
26829 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26830 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26831 If non-nil, windows are automatically scrolled horizontally to make
26832 point visible. */);
26833 automatic_hscrolling_p
= 1;
26834 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26835 staticpro (&Qauto_hscroll_mode
);
26837 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26838 doc
: /* *How many columns away from the window edge point is allowed to get
26839 before automatic hscrolling will horizontally scroll the window. */);
26840 hscroll_margin
= 5;
26842 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26843 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26844 When point is less than `hscroll-margin' columns from the window
26845 edge, automatic hscrolling will scroll the window by the amount of columns
26846 determined by this variable. If its value is a positive integer, scroll that
26847 many columns. If it's a positive floating-point number, it specifies the
26848 fraction of the window's width to scroll. If it's nil or zero, point will be
26849 centered horizontally after the scroll. Any other value, including negative
26850 numbers, are treated as if the value were zero.
26852 Automatic hscrolling always moves point outside the scroll margin, so if
26853 point was more than scroll step columns inside the margin, the window will
26854 scroll more than the value given by the scroll step.
26856 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26857 and `scroll-right' overrides this variable's effect. */);
26858 Vhscroll_step
= make_number (0);
26860 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26861 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26862 Bind this around calls to `message' to let it take effect. */);
26863 message_truncate_lines
= 0;
26865 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26866 doc
: /* Normal hook run to update the menu bar definitions.
26867 Redisplay runs this hook before it redisplays the menu bar.
26868 This is used to update submenus such as Buffers,
26869 whose contents depend on various data. */);
26870 Vmenu_bar_update_hook
= Qnil
;
26872 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26873 doc
: /* Frame for which we are updating a menu.
26874 The enable predicate for a menu binding should check this variable. */);
26875 Vmenu_updating_frame
= Qnil
;
26877 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26878 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26879 inhibit_menubar_update
= 0;
26881 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26882 doc
: /* Prefix prepended to all continuation lines at display time.
26883 The value may be a string, an image, or a stretch-glyph; it is
26884 interpreted in the same way as the value of a `display' text property.
26886 This variable is overridden by any `wrap-prefix' text or overlay
26889 To add a prefix to non-continuation lines, use `line-prefix'. */);
26890 Vwrap_prefix
= Qnil
;
26891 staticpro (&Qwrap_prefix
);
26892 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26893 Fmake_variable_buffer_local (Qwrap_prefix
);
26895 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26896 doc
: /* Prefix prepended to all non-continuation lines at display time.
26897 The value may be a string, an image, or a stretch-glyph; it is
26898 interpreted in the same way as the value of a `display' text property.
26900 This variable is overridden by any `line-prefix' text or overlay
26903 To add a prefix to continuation lines, use `wrap-prefix'. */);
26904 Vline_prefix
= Qnil
;
26905 staticpro (&Qline_prefix
);
26906 Qline_prefix
= intern_c_string ("line-prefix");
26907 Fmake_variable_buffer_local (Qline_prefix
);
26909 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26910 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26911 inhibit_eval_during_redisplay
= 0;
26913 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26914 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26915 inhibit_free_realized_faces
= 0;
26918 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26919 doc
: /* Inhibit try_window_id display optimization. */);
26920 inhibit_try_window_id
= 0;
26922 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26923 doc
: /* Inhibit try_window_reusing display optimization. */);
26924 inhibit_try_window_reusing
= 0;
26926 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26927 doc
: /* Inhibit try_cursor_movement display optimization. */);
26928 inhibit_try_cursor_movement
= 0;
26929 #endif /* GLYPH_DEBUG */
26931 DEFVAR_INT ("overline-margin", overline_margin
,
26932 doc
: /* *Space between overline and text, in pixels.
26933 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26934 margin to the caracter height. */);
26935 overline_margin
= 2;
26937 DEFVAR_INT ("underline-minimum-offset",
26938 underline_minimum_offset
,
26939 doc
: /* Minimum distance between baseline and underline.
26940 This can improve legibility of underlined text at small font sizes,
26941 particularly when using variable `x-use-underline-position-properties'
26942 with fonts that specify an UNDERLINE_POSITION relatively close to the
26943 baseline. The default value is 1. */);
26944 underline_minimum_offset
= 1;
26946 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26947 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26948 This feature only works when on a window system that can change
26949 cursor shapes. */);
26950 display_hourglass_p
= 1;
26952 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26953 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26954 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26956 hourglass_atimer
= NULL
;
26957 hourglass_shown_p
= 0;
26959 DEFSYM (Qglyphless_char
, "glyphless-char");
26960 DEFSYM (Qhex_code
, "hex-code");
26961 DEFSYM (Qempty_box
, "empty-box");
26962 DEFSYM (Qthin_space
, "thin-space");
26963 DEFSYM (Qzero_width
, "zero-width");
26965 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26966 /* Intern this now in case it isn't already done.
26967 Setting this variable twice is harmless.
26968 But don't staticpro it here--that is done in alloc.c. */
26969 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26970 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26972 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26973 doc
: /* Char-table defining glyphless characters.
26974 Each element, if non-nil, should be one of the following:
26975 an ASCII acronym string: display this string in a box
26976 `hex-code': display the hexadecimal code of a character in a box
26977 `empty-box': display as an empty box
26978 `thin-space': display as 1-pixel width space
26979 `zero-width': don't display
26980 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
26981 display method for graphical terminals and text terminals respectively.
26982 GRAPHICAL and TEXT should each have one of the values listed above.
26984 The char-table has one extra slot to control the display of a character for
26985 which no font is found. This slot only takes effect on graphical terminals.
26986 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
26987 `thin-space'. The default is `empty-box'. */);
26988 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26989 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26994 /* Initialize this module when Emacs starts. */
26999 Lisp_Object root_window
;
27000 struct window
*mini_w
;
27002 current_header_line_height
= current_mode_line_height
= -1;
27004 CHARPOS (this_line_start_pos
) = 0;
27006 mini_w
= XWINDOW (minibuf_window
);
27007 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27008 echo_area_window
= minibuf_window
;
27010 if (!noninteractive
)
27012 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27015 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27016 set_window_height (root_window
,
27017 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27019 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27020 set_window_height (minibuf_window
, 1, 0);
27022 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27023 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27025 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27026 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27027 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27029 /* The default ellipsis glyphs `...'. */
27030 for (i
= 0; i
< 3; ++i
)
27031 default_invis_vector
[i
] = make_number ('.');
27035 /* Allocate the buffer for frame titles.
27036 Also used for `format-mode-line'. */
27038 mode_line_noprop_buf
= (char *) xmalloc (size
);
27039 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27040 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27041 mode_line_target
= MODE_LINE_DISPLAY
;
27044 help_echo_showing_p
= 0;
27047 /* Since w32 does not support atimers, it defines its own implementation of
27048 the following three functions in w32fns.c. */
27051 /* Platform-independent portion of hourglass implementation. */
27053 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27055 hourglass_started (void)
27057 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27060 /* Cancel a currently active hourglass timer, and start a new one. */
27062 start_hourglass (void)
27064 #if defined (HAVE_WINDOW_SYSTEM)
27066 int secs
, usecs
= 0;
27068 cancel_hourglass ();
27070 if (INTEGERP (Vhourglass_delay
)
27071 && XINT (Vhourglass_delay
) > 0)
27072 secs
= XFASTINT (Vhourglass_delay
);
27073 else if (FLOATP (Vhourglass_delay
)
27074 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27077 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27078 secs
= XFASTINT (tem
);
27079 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27082 secs
= DEFAULT_HOURGLASS_DELAY
;
27084 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27085 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27086 show_hourglass
, NULL
);
27091 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27094 cancel_hourglass (void)
27096 #if defined (HAVE_WINDOW_SYSTEM)
27097 if (hourglass_atimer
)
27099 cancel_atimer (hourglass_atimer
);
27100 hourglass_atimer
= NULL
;
27103 if (hourglass_shown_p
)
27107 #endif /* ! WINDOWSNT */