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
);
3090 /***********************************************************************
3092 ***********************************************************************/
3094 /* Handle changes in the `fontified' property of the current buffer by
3095 calling hook functions from Qfontification_functions to fontify
3098 static enum prop_handled
3099 handle_fontified_prop (struct it
*it
)
3101 Lisp_Object prop
, pos
;
3102 enum prop_handled handled
= HANDLED_NORMALLY
;
3104 if (!NILP (Vmemory_full
))
3107 /* Get the value of the `fontified' property at IT's current buffer
3108 position. (The `fontified' property doesn't have a special
3109 meaning in strings.) If the value is nil, call functions from
3110 Qfontification_functions. */
3111 if (!STRINGP (it
->string
)
3113 && !NILP (Vfontification_functions
)
3114 && !NILP (Vrun_hooks
)
3115 && (pos
= make_number (IT_CHARPOS (*it
)),
3116 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3117 /* Ignore the special cased nil value always present at EOB since
3118 no amount of fontifying will be able to change it. */
3119 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3121 int count
= SPECPDL_INDEX ();
3123 struct buffer
*obuf
= current_buffer
;
3124 int begv
= BEGV
, zv
= ZV
;
3125 int old_clip_changed
= current_buffer
->clip_changed
;
3127 val
= Vfontification_functions
;
3128 specbind (Qfontification_functions
, Qnil
);
3130 xassert (it
->end_charpos
== ZV
);
3132 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3133 safe_call1 (val
, pos
);
3136 Lisp_Object fns
, fn
;
3137 struct gcpro gcpro1
, gcpro2
;
3142 for (; CONSP (val
); val
= XCDR (val
))
3148 /* A value of t indicates this hook has a local
3149 binding; it means to run the global binding too.
3150 In a global value, t should not occur. If it
3151 does, we must ignore it to avoid an endless
3153 for (fns
= Fdefault_value (Qfontification_functions
);
3159 safe_call1 (fn
, pos
);
3163 safe_call1 (fn
, pos
);
3169 unbind_to (count
, Qnil
);
3171 /* Fontification functions routinely call `save-restriction'.
3172 Normally, this tags clip_changed, which can confuse redisplay
3173 (see discussion in Bug#6671). Since we don't perform any
3174 special handling of fontification changes in the case where
3175 `save-restriction' isn't called, there's no point doing so in
3176 this case either. So, if the buffer's restrictions are
3177 actually left unchanged, reset clip_changed. */
3178 if (obuf
== current_buffer
)
3180 if (begv
== BEGV
&& zv
== ZV
)
3181 current_buffer
->clip_changed
= old_clip_changed
;
3183 /* There isn't much we can reasonably do to protect against
3184 misbehaving fontification, but here's a fig leaf. */
3185 else if (!NILP (BVAR (obuf
, name
)))
3186 set_buffer_internal_1 (obuf
);
3188 /* The fontification code may have added/removed text.
3189 It could do even a lot worse, but let's at least protect against
3190 the most obvious case where only the text past `pos' gets changed',
3191 as is/was done in grep.el where some escapes sequences are turned
3192 into face properties (bug#7876). */
3193 it
->end_charpos
= ZV
;
3195 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3196 something. This avoids an endless loop if they failed to
3197 fontify the text for which reason ever. */
3198 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3199 handled
= HANDLED_RECOMPUTE_PROPS
;
3207 /***********************************************************************
3209 ***********************************************************************/
3211 /* Set up iterator IT from face properties at its current position.
3212 Called from handle_stop. */
3214 static enum prop_handled
3215 handle_face_prop (struct it
*it
)
3218 EMACS_INT next_stop
;
3220 if (!STRINGP (it
->string
))
3223 = face_at_buffer_position (it
->w
,
3225 it
->region_beg_charpos
,
3226 it
->region_end_charpos
,
3229 + TEXT_PROP_DISTANCE_LIMIT
),
3230 0, it
->base_face_id
);
3232 /* Is this a start of a run of characters with box face?
3233 Caveat: this can be called for a freshly initialized
3234 iterator; face_id is -1 in this case. We know that the new
3235 face will not change until limit, i.e. if the new face has a
3236 box, all characters up to limit will have one. But, as
3237 usual, we don't know whether limit is really the end. */
3238 if (new_face_id
!= it
->face_id
)
3240 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3242 /* If new face has a box but old face has not, this is
3243 the start of a run of characters with box, i.e. it has
3244 a shadow on the left side. The value of face_id of the
3245 iterator will be -1 if this is the initial call that gets
3246 the face. In this case, we have to look in front of IT's
3247 position and see whether there is a face != new_face_id. */
3248 it
->start_of_box_run_p
3249 = (new_face
->box
!= FACE_NO_BOX
3250 && (it
->face_id
>= 0
3251 || IT_CHARPOS (*it
) == BEG
3252 || new_face_id
!= face_before_it_pos (it
)));
3253 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3261 Lisp_Object from_overlay
3262 = (it
->current
.overlay_string_index
>= 0
3263 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3266 /* See if we got to this string directly or indirectly from
3267 an overlay property. That includes the before-string or
3268 after-string of an overlay, strings in display properties
3269 provided by an overlay, their text properties, etc.
3271 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3272 if (! NILP (from_overlay
))
3273 for (i
= it
->sp
- 1; i
>= 0; i
--)
3275 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3277 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3278 else if (! NILP (it
->stack
[i
].from_overlay
))
3279 from_overlay
= it
->stack
[i
].from_overlay
;
3281 if (!NILP (from_overlay
))
3285 if (! NILP (from_overlay
))
3287 bufpos
= IT_CHARPOS (*it
);
3288 /* For a string from an overlay, the base face depends
3289 only on text properties and ignores overlays. */
3291 = face_for_overlay_string (it
->w
,
3293 it
->region_beg_charpos
,
3294 it
->region_end_charpos
,
3297 + TEXT_PROP_DISTANCE_LIMIT
),
3305 /* For strings from a `display' property, use the face at
3306 IT's current buffer position as the base face to merge
3307 with, so that overlay strings appear in the same face as
3308 surrounding text, unless they specify their own
3310 base_face_id
= underlying_face_id (it
);
3313 new_face_id
= face_at_string_position (it
->w
,
3315 IT_STRING_CHARPOS (*it
),
3317 it
->region_beg_charpos
,
3318 it
->region_end_charpos
,
3322 /* Is this a start of a run of characters with box? Caveat:
3323 this can be called for a freshly allocated iterator; face_id
3324 is -1 is this case. We know that the new face will not
3325 change until the next check pos, i.e. if the new face has a
3326 box, all characters up to that position will have a
3327 box. But, as usual, we don't know whether that position
3328 is really the end. */
3329 if (new_face_id
!= it
->face_id
)
3331 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3332 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3334 /* If new face has a box but old face hasn't, this is the
3335 start of a run of characters with box, i.e. it has a
3336 shadow on the left side. */
3337 it
->start_of_box_run_p
3338 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3339 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3343 it
->face_id
= new_face_id
;
3344 return HANDLED_NORMALLY
;
3348 /* Return the ID of the face ``underlying'' IT's current position,
3349 which is in a string. If the iterator is associated with a
3350 buffer, return the face at IT's current buffer position.
3351 Otherwise, use the iterator's base_face_id. */
3354 underlying_face_id (struct it
*it
)
3356 int face_id
= it
->base_face_id
, i
;
3358 xassert (STRINGP (it
->string
));
3360 for (i
= it
->sp
- 1; i
>= 0; --i
)
3361 if (NILP (it
->stack
[i
].string
))
3362 face_id
= it
->stack
[i
].face_id
;
3368 /* Compute the face one character before or after the current position
3369 of IT. BEFORE_P non-zero means get the face in front of IT's
3370 position. Value is the id of the face. */
3373 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3376 EMACS_INT next_check_charpos
;
3377 struct text_pos pos
;
3379 xassert (it
->s
== NULL
);
3381 if (STRINGP (it
->string
))
3386 /* No face change past the end of the string (for the case
3387 we are padding with spaces). No face change before the
3389 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3390 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3393 /* Set pos to the position before or after IT's current position. */
3395 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3397 /* For composition, we must check the character after the
3399 pos
= (it
->what
== IT_COMPOSITION
3400 ? string_pos (IT_STRING_CHARPOS (*it
)
3401 + it
->cmp_it
.nchars
, it
->string
)
3402 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3404 if (it
->current
.overlay_string_index
>= 0)
3405 bufpos
= IT_CHARPOS (*it
);
3409 base_face_id
= underlying_face_id (it
);
3411 /* Get the face for ASCII, or unibyte. */
3412 face_id
= face_at_string_position (it
->w
,
3416 it
->region_beg_charpos
,
3417 it
->region_end_charpos
,
3418 &next_check_charpos
,
3421 /* Correct the face for charsets different from ASCII. Do it
3422 for the multibyte case only. The face returned above is
3423 suitable for unibyte text if IT->string is unibyte. */
3424 if (STRING_MULTIBYTE (it
->string
))
3426 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3428 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3430 c
= string_char_and_length (p
, &len
);
3431 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3436 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3437 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3440 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3441 pos
= it
->current
.pos
;
3444 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3447 if (it
->what
== IT_COMPOSITION
)
3448 /* For composition, we must check the position after the
3450 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3452 INC_TEXT_POS (pos
, it
->multibyte_p
);
3455 /* Determine face for CHARSET_ASCII, or unibyte. */
3456 face_id
= face_at_buffer_position (it
->w
,
3458 it
->region_beg_charpos
,
3459 it
->region_end_charpos
,
3460 &next_check_charpos
,
3463 /* Correct the face for charsets different from ASCII. Do it
3464 for the multibyte case only. The face returned above is
3465 suitable for unibyte text if current_buffer is unibyte. */
3466 if (it
->multibyte_p
)
3468 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3469 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3470 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3479 /***********************************************************************
3481 ***********************************************************************/
3483 /* Set up iterator IT from invisible properties at its current
3484 position. Called from handle_stop. */
3486 static enum prop_handled
3487 handle_invisible_prop (struct it
*it
)
3489 enum prop_handled handled
= HANDLED_NORMALLY
;
3491 if (STRINGP (it
->string
))
3493 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3495 /* Get the value of the invisible text property at the
3496 current position. Value will be nil if there is no such
3498 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3499 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3502 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3504 handled
= HANDLED_RECOMPUTE_PROPS
;
3506 /* Get the position at which the next change of the
3507 invisible text property can be found in IT->string.
3508 Value will be nil if the property value is the same for
3509 all the rest of IT->string. */
3510 XSETINT (limit
, SCHARS (it
->string
));
3511 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3514 /* Text at current position is invisible. The next
3515 change in the property is at position end_charpos.
3516 Move IT's current position to that position. */
3517 if (INTEGERP (end_charpos
)
3518 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3520 struct text_pos old
;
3521 old
= it
->current
.string_pos
;
3522 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3523 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3527 /* The rest of the string is invisible. If this is an
3528 overlay string, proceed with the next overlay string
3529 or whatever comes and return a character from there. */
3530 if (it
->current
.overlay_string_index
>= 0)
3532 next_overlay_string (it
);
3533 /* Don't check for overlay strings when we just
3534 finished processing them. */
3535 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3539 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3540 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3548 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3549 Lisp_Object pos
, prop
, overlay
;
3551 /* First of all, is there invisible text at this position? */
3552 tem
= start_charpos
= IT_CHARPOS (*it
);
3553 pos
= make_number (tem
);
3554 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3556 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3558 /* If we are on invisible text, skip over it. */
3559 if (invis_p
&& start_charpos
< it
->end_charpos
)
3561 /* Record whether we have to display an ellipsis for the
3563 int display_ellipsis_p
= invis_p
== 2;
3565 handled
= HANDLED_RECOMPUTE_PROPS
;
3567 /* Loop skipping over invisible text. The loop is left at
3568 ZV or with IT on the first char being visible again. */
3571 /* Try to skip some invisible text. Return value is the
3572 position reached which can be equal to where we start
3573 if there is nothing invisible there. This skips both
3574 over invisible text properties and overlays with
3575 invisible property. */
3576 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3578 /* If we skipped nothing at all we weren't at invisible
3579 text in the first place. If everything to the end of
3580 the buffer was skipped, end the loop. */
3581 if (newpos
== tem
|| newpos
>= ZV
)
3585 /* We skipped some characters but not necessarily
3586 all there are. Check if we ended up on visible
3587 text. Fget_char_property returns the property of
3588 the char before the given position, i.e. if we
3589 get invis_p = 0, this means that the char at
3590 newpos is visible. */
3591 pos
= make_number (newpos
);
3592 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3593 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3596 /* If we ended up on invisible text, proceed to
3597 skip starting with next_stop. */
3601 /* If there are adjacent invisible texts, don't lose the
3602 second one's ellipsis. */
3604 display_ellipsis_p
= 1;
3608 /* The position newpos is now either ZV or on visible text. */
3609 if (it
->bidi_p
&& newpos
< ZV
)
3611 /* With bidi iteration, the region of invisible text
3612 could start and/or end in the middle of a non-base
3613 embedding level. Therefore, we need to skip
3614 invisible text using the bidi iterator, starting at
3615 IT's current position, until we find ourselves
3616 outside the invisible text. Skipping invisible text
3617 _after_ bidi iteration avoids affecting the visual
3618 order of the displayed text when invisible properties
3619 are added or removed. */
3620 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3622 /* If we were `reseat'ed to a new paragraph,
3623 determine the paragraph base direction. We need
3624 to do it now because next_element_from_buffer may
3625 not have a chance to do it, if we are going to
3626 skip any text at the beginning, which resets the
3628 bidi_paragraph_init (it
->paragraph_embedding
,
3633 bidi_move_to_visually_next (&it
->bidi_it
);
3635 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3636 && it
->bidi_it
.charpos
< newpos
);
3637 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3638 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3639 /* If we overstepped NEWPOS, record its position in the
3640 iterator, so that we skip invisible text if later the
3641 bidi iteration lands us in the invisible region
3643 if (IT_CHARPOS (*it
) >= newpos
)
3644 it
->prev_stop
= newpos
;
3648 IT_CHARPOS (*it
) = newpos
;
3649 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3652 /* If there are before-strings at the start of invisible
3653 text, and the text is invisible because of a text
3654 property, arrange to show before-strings because 20.x did
3655 it that way. (If the text is invisible because of an
3656 overlay property instead of a text property, this is
3657 already handled in the overlay code.) */
3659 && get_overlay_strings (it
, it
->stop_charpos
))
3661 handled
= HANDLED_RECOMPUTE_PROPS
;
3662 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3664 else if (display_ellipsis_p
)
3666 /* Make sure that the glyphs of the ellipsis will get
3667 correct `charpos' values. If we would not update
3668 it->position here, the glyphs would belong to the
3669 last visible character _before_ the invisible
3670 text, which confuses `set_cursor_from_row'.
3672 We use the last invisible position instead of the
3673 first because this way the cursor is always drawn on
3674 the first "." of the ellipsis, whenever PT is inside
3675 the invisible text. Otherwise the cursor would be
3676 placed _after_ the ellipsis when the point is after the
3677 first invisible character. */
3678 if (!STRINGP (it
->object
))
3680 it
->position
.charpos
= newpos
- 1;
3681 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3684 /* Let the ellipsis display before
3685 considering any properties of the following char.
3686 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3687 handled
= HANDLED_RETURN
;
3696 /* Make iterator IT return `...' next.
3697 Replaces LEN characters from buffer. */
3700 setup_for_ellipsis (struct it
*it
, int len
)
3702 /* Use the display table definition for `...'. Invalid glyphs
3703 will be handled by the method returning elements from dpvec. */
3704 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3706 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3707 it
->dpvec
= v
->contents
;
3708 it
->dpend
= v
->contents
+ v
->size
;
3712 /* Default `...'. */
3713 it
->dpvec
= default_invis_vector
;
3714 it
->dpend
= default_invis_vector
+ 3;
3717 it
->dpvec_char_len
= len
;
3718 it
->current
.dpvec_index
= 0;
3719 it
->dpvec_face_id
= -1;
3721 /* Remember the current face id in case glyphs specify faces.
3722 IT's face is restored in set_iterator_to_next.
3723 saved_face_id was set to preceding char's face in handle_stop. */
3724 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3725 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3727 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3733 /***********************************************************************
3735 ***********************************************************************/
3737 /* Set up iterator IT from `display' property at its current position.
3738 Called from handle_stop.
3739 We return HANDLED_RETURN if some part of the display property
3740 overrides the display of the buffer text itself.
3741 Otherwise we return HANDLED_NORMALLY. */
3743 static enum prop_handled
3744 handle_display_prop (struct it
*it
)
3746 Lisp_Object prop
, object
, overlay
;
3747 struct text_pos
*position
;
3748 /* Nonzero if some property replaces the display of the text itself. */
3749 int display_replaced_p
= 0;
3751 if (STRINGP (it
->string
))
3753 object
= it
->string
;
3754 position
= &it
->current
.string_pos
;
3758 XSETWINDOW (object
, it
->w
);
3759 position
= &it
->current
.pos
;
3762 /* Reset those iterator values set from display property values. */
3763 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3764 it
->space_width
= Qnil
;
3765 it
->font_height
= Qnil
;
3768 /* We don't support recursive `display' properties, i.e. string
3769 values that have a string `display' property, that have a string
3770 `display' property etc. */
3771 if (!it
->string_from_display_prop_p
)
3772 it
->area
= TEXT_AREA
;
3774 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3775 Qdisplay
, object
, &overlay
);
3777 return HANDLED_NORMALLY
;
3778 /* Now OVERLAY is the overlay that gave us this property, or nil
3779 if it was a text property. */
3781 if (!STRINGP (it
->string
))
3782 object
= it
->w
->buffer
;
3785 /* Simple properties. */
3786 && !EQ (XCAR (prop
), Qimage
)
3787 && !EQ (XCAR (prop
), Qspace
)
3788 && !EQ (XCAR (prop
), Qwhen
)
3789 && !EQ (XCAR (prop
), Qslice
)
3790 && !EQ (XCAR (prop
), Qspace_width
)
3791 && !EQ (XCAR (prop
), Qheight
)
3792 && !EQ (XCAR (prop
), Qraise
)
3793 /* Marginal area specifications. */
3794 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3795 && !EQ (XCAR (prop
), Qleft_fringe
)
3796 && !EQ (XCAR (prop
), Qright_fringe
)
3797 && !NILP (XCAR (prop
)))
3799 for (; CONSP (prop
); prop
= XCDR (prop
))
3801 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3802 position
, display_replaced_p
))
3804 display_replaced_p
= 1;
3805 /* If some text in a string is replaced, `position' no
3806 longer points to the position of `object'. */
3807 if (STRINGP (object
))
3812 else if (VECTORP (prop
))
3815 for (i
= 0; i
< ASIZE (prop
); ++i
)
3816 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3817 position
, display_replaced_p
))
3819 display_replaced_p
= 1;
3820 /* If some text in a string is replaced, `position' no
3821 longer points to the position of `object'. */
3822 if (STRINGP (object
))
3828 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3830 display_replaced_p
= 1;
3833 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3837 /* Value is the position of the end of the `display' property starting
3838 at START_POS in OBJECT. */
3840 static struct text_pos
3841 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3844 struct text_pos end_pos
;
3846 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3847 Qdisplay
, object
, Qnil
);
3848 CHARPOS (end_pos
) = XFASTINT (end
);
3849 if (STRINGP (object
))
3850 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3852 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3858 /* Set up IT from a single `display' specification PROP. OBJECT
3859 is the object in which the `display' property was found. *POSITION
3860 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3861 means that we previously saw a display specification which already
3862 replaced text display with something else, for example an image;
3863 we ignore such properties after the first one has been processed.
3865 OVERLAY is the overlay this `display' property came from,
3866 or nil if it was a text property.
3868 If PROP is a `space' or `image' specification, and in some other
3869 cases too, set *POSITION to the position where the `display'
3872 Value is non-zero if something was found which replaces the display
3873 of buffer or string text. */
3876 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3877 Lisp_Object overlay
, struct text_pos
*position
,
3878 int display_replaced_before_p
)
3881 Lisp_Object location
, value
;
3882 struct text_pos start_pos
, save_pos
;
3885 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3886 If the result is non-nil, use VALUE instead of SPEC. */
3888 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3897 if (!NILP (form
) && !EQ (form
, Qt
))
3899 int count
= SPECPDL_INDEX ();
3900 struct gcpro gcpro1
;
3902 /* Bind `object' to the object having the `display' property, a
3903 buffer or string. Bind `position' to the position in the
3904 object where the property was found, and `buffer-position'
3905 to the current position in the buffer. */
3906 specbind (Qobject
, object
);
3907 specbind (Qposition
, make_number (CHARPOS (*position
)));
3908 specbind (Qbuffer_position
,
3909 make_number (STRINGP (object
)
3910 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3912 form
= safe_eval (form
);
3914 unbind_to (count
, Qnil
);
3920 /* Handle `(height HEIGHT)' specifications. */
3922 && EQ (XCAR (spec
), Qheight
)
3923 && CONSP (XCDR (spec
)))
3925 if (!FRAME_WINDOW_P (it
->f
))
3928 it
->font_height
= XCAR (XCDR (spec
));
3929 if (!NILP (it
->font_height
))
3931 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3932 int new_height
= -1;
3934 if (CONSP (it
->font_height
)
3935 && (EQ (XCAR (it
->font_height
), Qplus
)
3936 || EQ (XCAR (it
->font_height
), Qminus
))
3937 && CONSP (XCDR (it
->font_height
))
3938 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3940 /* `(+ N)' or `(- N)' where N is an integer. */
3941 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3942 if (EQ (XCAR (it
->font_height
), Qplus
))
3944 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3946 else if (FUNCTIONP (it
->font_height
))
3948 /* Call function with current height as argument.
3949 Value is the new height. */
3951 height
= safe_call1 (it
->font_height
,
3952 face
->lface
[LFACE_HEIGHT_INDEX
]);
3953 if (NUMBERP (height
))
3954 new_height
= XFLOATINT (height
);
3956 else if (NUMBERP (it
->font_height
))
3958 /* Value is a multiple of the canonical char height. */
3961 f
= FACE_FROM_ID (it
->f
,
3962 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3963 new_height
= (XFLOATINT (it
->font_height
)
3964 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
3968 /* Evaluate IT->font_height with `height' bound to the
3969 current specified height to get the new height. */
3970 int count
= SPECPDL_INDEX ();
3972 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3973 value
= safe_eval (it
->font_height
);
3974 unbind_to (count
, Qnil
);
3976 if (NUMBERP (value
))
3977 new_height
= XFLOATINT (value
);
3981 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
3987 /* Handle `(space-width WIDTH)'. */
3989 && EQ (XCAR (spec
), Qspace_width
)
3990 && CONSP (XCDR (spec
)))
3992 if (!FRAME_WINDOW_P (it
->f
))
3995 value
= XCAR (XCDR (spec
));
3996 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
3997 it
->space_width
= value
;
4002 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4004 && EQ (XCAR (spec
), Qslice
))
4008 if (!FRAME_WINDOW_P (it
->f
))
4011 if (tem
= XCDR (spec
), CONSP (tem
))
4013 it
->slice
.x
= XCAR (tem
);
4014 if (tem
= XCDR (tem
), CONSP (tem
))
4016 it
->slice
.y
= XCAR (tem
);
4017 if (tem
= XCDR (tem
), CONSP (tem
))
4019 it
->slice
.width
= XCAR (tem
);
4020 if (tem
= XCDR (tem
), CONSP (tem
))
4021 it
->slice
.height
= XCAR (tem
);
4029 /* Handle `(raise FACTOR)'. */
4031 && EQ (XCAR (spec
), Qraise
)
4032 && CONSP (XCDR (spec
)))
4034 if (!FRAME_WINDOW_P (it
->f
))
4037 #ifdef HAVE_WINDOW_SYSTEM
4038 value
= XCAR (XCDR (spec
));
4039 if (NUMBERP (value
))
4041 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4042 it
->voffset
= - (XFLOATINT (value
)
4043 * (FONT_HEIGHT (face
->font
)));
4045 #endif /* HAVE_WINDOW_SYSTEM */
4050 /* Don't handle the other kinds of display specifications
4051 inside a string that we got from a `display' property. */
4052 if (it
->string_from_display_prop_p
)
4055 /* Characters having this form of property are not displayed, so
4056 we have to find the end of the property. */
4057 start_pos
= *position
;
4058 *position
= display_prop_end (it
, object
, start_pos
);
4061 /* Stop the scan at that end position--we assume that all
4062 text properties change there. */
4063 it
->stop_charpos
= position
->charpos
;
4065 /* Handle `(left-fringe BITMAP [FACE])'
4066 and `(right-fringe BITMAP [FACE])'. */
4068 && (EQ (XCAR (spec
), Qleft_fringe
)
4069 || EQ (XCAR (spec
), Qright_fringe
))
4070 && CONSP (XCDR (spec
)))
4072 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4075 if (!FRAME_WINDOW_P (it
->f
))
4076 /* If we return here, POSITION has been advanced
4077 across the text with this property. */
4080 #ifdef HAVE_WINDOW_SYSTEM
4081 value
= XCAR (XCDR (spec
));
4082 if (!SYMBOLP (value
)
4083 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4084 /* If we return here, POSITION has been advanced
4085 across the text with this property. */
4088 if (CONSP (XCDR (XCDR (spec
))))
4090 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4091 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4097 /* Save current settings of IT so that we can restore them
4098 when we are finished with the glyph property value. */
4100 save_pos
= it
->position
;
4101 it
->position
= *position
;
4103 it
->position
= save_pos
;
4105 it
->area
= TEXT_AREA
;
4106 it
->what
= IT_IMAGE
;
4107 it
->image_id
= -1; /* no image */
4108 it
->position
= start_pos
;
4109 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4110 it
->method
= GET_FROM_IMAGE
;
4111 it
->from_overlay
= Qnil
;
4112 it
->face_id
= face_id
;
4114 /* Say that we haven't consumed the characters with
4115 `display' property yet. The call to pop_it in
4116 set_iterator_to_next will clean this up. */
4117 *position
= start_pos
;
4119 if (EQ (XCAR (spec
), Qleft_fringe
))
4121 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4122 it
->left_user_fringe_face_id
= face_id
;
4126 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4127 it
->right_user_fringe_face_id
= face_id
;
4129 #endif /* HAVE_WINDOW_SYSTEM */
4133 /* Prepare to handle `((margin left-margin) ...)',
4134 `((margin right-margin) ...)' and `((margin nil) ...)'
4135 prefixes for display specifications. */
4136 location
= Qunbound
;
4137 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4141 value
= XCDR (spec
);
4143 value
= XCAR (value
);
4146 if (EQ (XCAR (tem
), Qmargin
)
4147 && (tem
= XCDR (tem
),
4148 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4150 || EQ (tem
, Qleft_margin
)
4151 || EQ (tem
, Qright_margin
))))
4155 if (EQ (location
, Qunbound
))
4161 /* After this point, VALUE is the property after any
4162 margin prefix has been stripped. It must be a string,
4163 an image specification, or `(space ...)'.
4165 LOCATION specifies where to display: `left-margin',
4166 `right-margin' or nil. */
4168 valid_p
= (STRINGP (value
)
4169 #ifdef HAVE_WINDOW_SYSTEM
4170 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4171 #endif /* not HAVE_WINDOW_SYSTEM */
4172 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4174 if (valid_p
&& !display_replaced_before_p
)
4176 /* Save current settings of IT so that we can restore them
4177 when we are finished with the glyph property value. */
4178 save_pos
= it
->position
;
4179 it
->position
= *position
;
4181 it
->position
= save_pos
;
4182 it
->from_overlay
= overlay
;
4184 if (NILP (location
))
4185 it
->area
= TEXT_AREA
;
4186 else if (EQ (location
, Qleft_margin
))
4187 it
->area
= LEFT_MARGIN_AREA
;
4189 it
->area
= RIGHT_MARGIN_AREA
;
4191 if (STRINGP (value
))
4194 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4195 it
->current
.overlay_string_index
= -1;
4196 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4197 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4198 it
->method
= GET_FROM_STRING
;
4199 it
->stop_charpos
= 0;
4200 it
->string_from_display_prop_p
= 1;
4201 /* Say that we haven't consumed the characters with
4202 `display' property yet. The call to pop_it in
4203 set_iterator_to_next will clean this up. */
4204 if (BUFFERP (object
))
4205 *position
= start_pos
;
4207 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4209 it
->method
= GET_FROM_STRETCH
;
4211 *position
= it
->position
= start_pos
;
4213 #ifdef HAVE_WINDOW_SYSTEM
4216 it
->what
= IT_IMAGE
;
4217 it
->image_id
= lookup_image (it
->f
, value
);
4218 it
->position
= start_pos
;
4219 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4220 it
->method
= GET_FROM_IMAGE
;
4222 /* Say that we haven't consumed the characters with
4223 `display' property yet. The call to pop_it in
4224 set_iterator_to_next will clean this up. */
4225 *position
= start_pos
;
4227 #endif /* HAVE_WINDOW_SYSTEM */
4232 /* Invalid property or property not supported. Restore
4233 POSITION to what it was before. */
4234 *position
= start_pos
;
4239 /* Check if SPEC is a display sub-property value whose text should be
4240 treated as intangible. */
4243 single_display_spec_intangible_p (Lisp_Object prop
)
4245 /* Skip over `when FORM'. */
4246 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4260 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4261 we don't need to treat text as intangible. */
4262 if (EQ (XCAR (prop
), Qmargin
))
4270 || EQ (XCAR (prop
), Qleft_margin
)
4271 || EQ (XCAR (prop
), Qright_margin
))
4275 return (CONSP (prop
)
4276 && (EQ (XCAR (prop
), Qimage
)
4277 || EQ (XCAR (prop
), Qspace
)));
4281 /* Check if PROP is a display property value whose text should be
4282 treated as intangible. */
4285 display_prop_intangible_p (Lisp_Object prop
)
4288 && CONSP (XCAR (prop
))
4289 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4291 /* A list of sub-properties. */
4292 while (CONSP (prop
))
4294 if (single_display_spec_intangible_p (XCAR (prop
)))
4299 else if (VECTORP (prop
))
4301 /* A vector of sub-properties. */
4303 for (i
= 0; i
< ASIZE (prop
); ++i
)
4304 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4308 return single_display_spec_intangible_p (prop
);
4314 /* Return 1 if PROP is a display sub-property value containing STRING. */
4317 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4319 if (EQ (string
, prop
))
4322 /* Skip over `when FORM'. */
4323 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4332 /* Skip over `margin LOCATION'. */
4333 if (EQ (XCAR (prop
), Qmargin
))
4344 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4348 /* Return 1 if STRING appears in the `display' property PROP. */
4351 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4354 && CONSP (XCAR (prop
))
4355 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4357 /* A list of sub-properties. */
4358 while (CONSP (prop
))
4360 if (single_display_spec_string_p (XCAR (prop
), string
))
4365 else if (VECTORP (prop
))
4367 /* A vector of sub-properties. */
4369 for (i
= 0; i
< ASIZE (prop
); ++i
)
4370 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4374 return single_display_spec_string_p (prop
, string
);
4379 /* Look for STRING in overlays and text properties in the current
4380 buffer, between character positions FROM and TO (excluding TO).
4381 BACK_P non-zero means look back (in this case, TO is supposed to be
4383 Value is the first character position where STRING was found, or
4384 zero if it wasn't found before hitting TO.
4386 This function may only use code that doesn't eval because it is
4387 called asynchronously from note_mouse_highlight. */
4390 string_buffer_position_lim (Lisp_Object string
,
4391 EMACS_INT from
, EMACS_INT to
, int back_p
)
4393 Lisp_Object limit
, prop
, pos
;
4396 pos
= make_number (from
);
4398 if (!back_p
) /* looking forward */
4400 limit
= make_number (min (to
, ZV
));
4401 while (!found
&& !EQ (pos
, limit
))
4403 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4404 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4407 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4411 else /* looking back */
4413 limit
= make_number (max (to
, BEGV
));
4414 while (!found
&& !EQ (pos
, limit
))
4416 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4417 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4420 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4425 return found
? XINT (pos
) : 0;
4428 /* Determine which buffer position in current buffer STRING comes from.
4429 AROUND_CHARPOS is an approximate position where it could come from.
4430 Value is the buffer position or 0 if it couldn't be determined.
4432 This function is necessary because we don't record buffer positions
4433 in glyphs generated from strings (to keep struct glyph small).
4434 This function may only use code that doesn't eval because it is
4435 called asynchronously from note_mouse_highlight. */
4438 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4440 const int MAX_DISTANCE
= 1000;
4441 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4442 around_charpos
+ MAX_DISTANCE
,
4446 found
= string_buffer_position_lim (string
, around_charpos
,
4447 around_charpos
- MAX_DISTANCE
, 1);
4453 /***********************************************************************
4454 `composition' property
4455 ***********************************************************************/
4457 /* Set up iterator IT from `composition' property at its current
4458 position. Called from handle_stop. */
4460 static enum prop_handled
4461 handle_composition_prop (struct it
*it
)
4463 Lisp_Object prop
, string
;
4464 EMACS_INT pos
, pos_byte
, start
, end
;
4466 if (STRINGP (it
->string
))
4470 pos
= IT_STRING_CHARPOS (*it
);
4471 pos_byte
= IT_STRING_BYTEPOS (*it
);
4472 string
= it
->string
;
4473 s
= SDATA (string
) + pos_byte
;
4474 it
->c
= STRING_CHAR (s
);
4478 pos
= IT_CHARPOS (*it
);
4479 pos_byte
= IT_BYTEPOS (*it
);
4481 it
->c
= FETCH_CHAR (pos_byte
);
4484 /* If there's a valid composition and point is not inside of the
4485 composition (in the case that the composition is from the current
4486 buffer), draw a glyph composed from the composition components. */
4487 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4488 && COMPOSITION_VALID_P (start
, end
, prop
)
4489 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4493 if (STRINGP (it
->string
))
4494 pos_byte
= string_char_to_byte (it
->string
, start
);
4496 pos_byte
= CHAR_TO_BYTE (start
);
4498 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4501 if (it
->cmp_it
.id
>= 0)
4504 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4505 it
->cmp_it
.nglyphs
= -1;
4509 return HANDLED_NORMALLY
;
4514 /***********************************************************************
4516 ***********************************************************************/
4518 /* The following structure is used to record overlay strings for
4519 later sorting in load_overlay_strings. */
4521 struct overlay_entry
4523 Lisp_Object overlay
;
4530 /* Set up iterator IT from overlay strings at its current position.
4531 Called from handle_stop. */
4533 static enum prop_handled
4534 handle_overlay_change (struct it
*it
)
4536 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4537 return HANDLED_RECOMPUTE_PROPS
;
4539 return HANDLED_NORMALLY
;
4543 /* Set up the next overlay string for delivery by IT, if there is an
4544 overlay string to deliver. Called by set_iterator_to_next when the
4545 end of the current overlay string is reached. If there are more
4546 overlay strings to display, IT->string and
4547 IT->current.overlay_string_index are set appropriately here.
4548 Otherwise IT->string is set to nil. */
4551 next_overlay_string (struct it
*it
)
4553 ++it
->current
.overlay_string_index
;
4554 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4556 /* No more overlay strings. Restore IT's settings to what
4557 they were before overlay strings were processed, and
4558 continue to deliver from current_buffer. */
4560 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4563 || (NILP (it
->string
)
4564 && it
->method
== GET_FROM_BUFFER
4565 && it
->stop_charpos
>= BEGV
4566 && it
->stop_charpos
<= it
->end_charpos
));
4567 it
->current
.overlay_string_index
= -1;
4568 it
->n_overlay_strings
= 0;
4569 it
->overlay_strings_charpos
= -1;
4571 /* If we're at the end of the buffer, record that we have
4572 processed the overlay strings there already, so that
4573 next_element_from_buffer doesn't try it again. */
4574 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4575 it
->overlay_strings_at_end_processed_p
= 1;
4579 /* There are more overlay strings to process. If
4580 IT->current.overlay_string_index has advanced to a position
4581 where we must load IT->overlay_strings with more strings, do
4582 it. We must load at the IT->overlay_strings_charpos where
4583 IT->n_overlay_strings was originally computed; when invisible
4584 text is present, this might not be IT_CHARPOS (Bug#7016). */
4585 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4587 if (it
->current
.overlay_string_index
&& i
== 0)
4588 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4590 /* Initialize IT to deliver display elements from the overlay
4592 it
->string
= it
->overlay_strings
[i
];
4593 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4594 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4595 it
->method
= GET_FROM_STRING
;
4596 it
->stop_charpos
= 0;
4597 if (it
->cmp_it
.stop_pos
>= 0)
4598 it
->cmp_it
.stop_pos
= 0;
4605 /* Compare two overlay_entry structures E1 and E2. Used as a
4606 comparison function for qsort in load_overlay_strings. Overlay
4607 strings for the same position are sorted so that
4609 1. All after-strings come in front of before-strings, except
4610 when they come from the same overlay.
4612 2. Within after-strings, strings are sorted so that overlay strings
4613 from overlays with higher priorities come first.
4615 2. Within before-strings, strings are sorted so that overlay
4616 strings from overlays with higher priorities come last.
4618 Value is analogous to strcmp. */
4622 compare_overlay_entries (const void *e1
, const void *e2
)
4624 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4625 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4628 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4630 /* Let after-strings appear in front of before-strings if
4631 they come from different overlays. */
4632 if (EQ (entry1
->overlay
, entry2
->overlay
))
4633 result
= entry1
->after_string_p
? 1 : -1;
4635 result
= entry1
->after_string_p
? -1 : 1;
4637 else if (entry1
->after_string_p
)
4638 /* After-strings sorted in order of decreasing priority. */
4639 result
= entry2
->priority
- entry1
->priority
;
4641 /* Before-strings sorted in order of increasing priority. */
4642 result
= entry1
->priority
- entry2
->priority
;
4648 /* Load the vector IT->overlay_strings with overlay strings from IT's
4649 current buffer position, or from CHARPOS if that is > 0. Set
4650 IT->n_overlays to the total number of overlay strings found.
4652 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4653 a time. On entry into load_overlay_strings,
4654 IT->current.overlay_string_index gives the number of overlay
4655 strings that have already been loaded by previous calls to this
4658 IT->add_overlay_start contains an additional overlay start
4659 position to consider for taking overlay strings from, if non-zero.
4660 This position comes into play when the overlay has an `invisible'
4661 property, and both before and after-strings. When we've skipped to
4662 the end of the overlay, because of its `invisible' property, we
4663 nevertheless want its before-string to appear.
4664 IT->add_overlay_start will contain the overlay start position
4667 Overlay strings are sorted so that after-string strings come in
4668 front of before-string strings. Within before and after-strings,
4669 strings are sorted by overlay priority. See also function
4670 compare_overlay_entries. */
4673 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4675 Lisp_Object overlay
, window
, str
, invisible
;
4676 struct Lisp_Overlay
*ov
;
4677 EMACS_INT start
, end
;
4679 int n
= 0, i
, j
, invis_p
;
4680 struct overlay_entry
*entries
4681 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4684 charpos
= IT_CHARPOS (*it
);
4686 /* Append the overlay string STRING of overlay OVERLAY to vector
4687 `entries' which has size `size' and currently contains `n'
4688 elements. AFTER_P non-zero means STRING is an after-string of
4690 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4693 Lisp_Object priority; \
4697 int new_size = 2 * size; \
4698 struct overlay_entry *old = entries; \
4700 (struct overlay_entry *) alloca (new_size \
4701 * sizeof *entries); \
4702 memcpy (entries, old, size * sizeof *entries); \
4706 entries[n].string = (STRING); \
4707 entries[n].overlay = (OVERLAY); \
4708 priority = Foverlay_get ((OVERLAY), Qpriority); \
4709 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4710 entries[n].after_string_p = (AFTER_P); \
4715 /* Process overlay before the overlay center. */
4716 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4718 XSETMISC (overlay
, ov
);
4719 xassert (OVERLAYP (overlay
));
4720 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4721 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4726 /* Skip this overlay if it doesn't start or end at IT's current
4728 if (end
!= charpos
&& start
!= charpos
)
4731 /* Skip this overlay if it doesn't apply to IT->w. */
4732 window
= Foverlay_get (overlay
, Qwindow
);
4733 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4736 /* If the text ``under'' the overlay is invisible, both before-
4737 and after-strings from this overlay are visible; start and
4738 end position are indistinguishable. */
4739 invisible
= Foverlay_get (overlay
, Qinvisible
);
4740 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4742 /* If overlay has a non-empty before-string, record it. */
4743 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4744 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4746 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4748 /* If overlay has a non-empty after-string, record it. */
4749 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4750 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4752 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4755 /* Process overlays after the overlay center. */
4756 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4758 XSETMISC (overlay
, ov
);
4759 xassert (OVERLAYP (overlay
));
4760 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4761 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4763 if (start
> charpos
)
4766 /* Skip this overlay if it doesn't start or end at IT's current
4768 if (end
!= charpos
&& start
!= charpos
)
4771 /* Skip this overlay if it doesn't apply to IT->w. */
4772 window
= Foverlay_get (overlay
, Qwindow
);
4773 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4776 /* If the text ``under'' the overlay is invisible, it has a zero
4777 dimension, and both before- and after-strings apply. */
4778 invisible
= Foverlay_get (overlay
, Qinvisible
);
4779 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4781 /* If overlay has a non-empty before-string, record it. */
4782 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4783 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4785 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4787 /* If overlay has a non-empty after-string, record it. */
4788 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4789 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4791 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4794 #undef RECORD_OVERLAY_STRING
4798 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4800 /* Record number of overlay strings, and where we computed it. */
4801 it
->n_overlay_strings
= n
;
4802 it
->overlay_strings_charpos
= charpos
;
4804 /* IT->current.overlay_string_index is the number of overlay strings
4805 that have already been consumed by IT. Copy some of the
4806 remaining overlay strings to IT->overlay_strings. */
4808 j
= it
->current
.overlay_string_index
;
4809 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4811 it
->overlay_strings
[i
] = entries
[j
].string
;
4812 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4819 /* Get the first chunk of overlay strings at IT's current buffer
4820 position, or at CHARPOS if that is > 0. Value is non-zero if at
4821 least one overlay string was found. */
4824 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4826 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4827 process. This fills IT->overlay_strings with strings, and sets
4828 IT->n_overlay_strings to the total number of strings to process.
4829 IT->pos.overlay_string_index has to be set temporarily to zero
4830 because load_overlay_strings needs this; it must be set to -1
4831 when no overlay strings are found because a zero value would
4832 indicate a position in the first overlay string. */
4833 it
->current
.overlay_string_index
= 0;
4834 load_overlay_strings (it
, charpos
);
4836 /* If we found overlay strings, set up IT to deliver display
4837 elements from the first one. Otherwise set up IT to deliver
4838 from current_buffer. */
4839 if (it
->n_overlay_strings
)
4841 /* Make sure we know settings in current_buffer, so that we can
4842 restore meaningful values when we're done with the overlay
4845 compute_stop_pos (it
);
4846 xassert (it
->face_id
>= 0);
4848 /* Save IT's settings. They are restored after all overlay
4849 strings have been processed. */
4850 xassert (!compute_stop_p
|| it
->sp
== 0);
4852 /* When called from handle_stop, there might be an empty display
4853 string loaded. In that case, don't bother saving it. */
4854 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4857 /* Set up IT to deliver display elements from the first overlay
4859 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4860 it
->string
= it
->overlay_strings
[0];
4861 it
->from_overlay
= Qnil
;
4862 it
->stop_charpos
= 0;
4863 xassert (STRINGP (it
->string
));
4864 it
->end_charpos
= SCHARS (it
->string
);
4865 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4866 it
->method
= GET_FROM_STRING
;
4870 it
->current
.overlay_string_index
= -1;
4875 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4878 it
->method
= GET_FROM_BUFFER
;
4880 (void) get_overlay_strings_1 (it
, charpos
, 1);
4884 /* Value is non-zero if we found at least one overlay string. */
4885 return STRINGP (it
->string
);
4890 /***********************************************************************
4891 Saving and restoring state
4892 ***********************************************************************/
4894 /* Save current settings of IT on IT->stack. Called, for example,
4895 before setting up IT for an overlay string, to be able to restore
4896 IT's settings to what they were after the overlay string has been
4900 push_it (struct it
*it
)
4902 struct iterator_stack_entry
*p
;
4904 xassert (it
->sp
< IT_STACK_SIZE
);
4905 p
= it
->stack
+ it
->sp
;
4907 p
->stop_charpos
= it
->stop_charpos
;
4908 p
->prev_stop
= it
->prev_stop
;
4909 p
->base_level_stop
= it
->base_level_stop
;
4910 p
->cmp_it
= it
->cmp_it
;
4911 xassert (it
->face_id
>= 0);
4912 p
->face_id
= it
->face_id
;
4913 p
->string
= it
->string
;
4914 p
->method
= it
->method
;
4915 p
->from_overlay
= it
->from_overlay
;
4918 case GET_FROM_IMAGE
:
4919 p
->u
.image
.object
= it
->object
;
4920 p
->u
.image
.image_id
= it
->image_id
;
4921 p
->u
.image
.slice
= it
->slice
;
4923 case GET_FROM_STRETCH
:
4924 p
->u
.stretch
.object
= it
->object
;
4927 p
->position
= it
->position
;
4928 p
->current
= it
->current
;
4929 p
->end_charpos
= it
->end_charpos
;
4930 p
->string_nchars
= it
->string_nchars
;
4932 p
->multibyte_p
= it
->multibyte_p
;
4933 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4934 p
->space_width
= it
->space_width
;
4935 p
->font_height
= it
->font_height
;
4936 p
->voffset
= it
->voffset
;
4937 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4938 p
->display_ellipsis_p
= 0;
4939 p
->line_wrap
= it
->line_wrap
;
4944 iterate_out_of_display_property (struct it
*it
)
4946 /* Maybe initialize paragraph direction. If we are at the beginning
4947 of a new paragraph, next_element_from_buffer may not have a
4948 chance to do that. */
4949 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4950 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4951 /* prev_stop can be zero, so check against BEGV as well. */
4952 while (it
->bidi_it
.charpos
>= BEGV
4953 && it
->prev_stop
<= it
->bidi_it
.charpos
4954 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4955 bidi_move_to_visually_next (&it
->bidi_it
);
4956 /* Record the stop_pos we just crossed, for when we cross it
4958 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4959 it
->prev_stop
= CHARPOS (it
->position
);
4960 /* If we ended up not where pop_it put us, resync IT's
4961 positional members with the bidi iterator. */
4962 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
4964 SET_TEXT_POS (it
->position
,
4965 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
4966 it
->current
.pos
= it
->position
;
4970 /* Restore IT's settings from IT->stack. Called, for example, when no
4971 more overlay strings must be processed, and we return to delivering
4972 display elements from a buffer, or when the end of a string from a
4973 `display' property is reached and we return to delivering display
4974 elements from an overlay string, or from a buffer. */
4977 pop_it (struct it
*it
)
4979 struct iterator_stack_entry
*p
;
4981 xassert (it
->sp
> 0);
4983 p
= it
->stack
+ it
->sp
;
4984 it
->stop_charpos
= p
->stop_charpos
;
4985 it
->prev_stop
= p
->prev_stop
;
4986 it
->base_level_stop
= p
->base_level_stop
;
4987 it
->cmp_it
= p
->cmp_it
;
4988 it
->face_id
= p
->face_id
;
4989 it
->current
= p
->current
;
4990 it
->position
= p
->position
;
4991 it
->string
= p
->string
;
4992 it
->from_overlay
= p
->from_overlay
;
4993 if (NILP (it
->string
))
4994 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
4995 it
->method
= p
->method
;
4998 case GET_FROM_IMAGE
:
4999 it
->image_id
= p
->u
.image
.image_id
;
5000 it
->object
= p
->u
.image
.object
;
5001 it
->slice
= p
->u
.image
.slice
;
5003 case GET_FROM_STRETCH
:
5004 it
->object
= p
->u
.comp
.object
;
5006 case GET_FROM_BUFFER
:
5007 it
->object
= it
->w
->buffer
;
5010 /* Bidi-iterate until we get out of the portion of text, if
5011 any, covered by a `display' text property or an overlay
5012 with `display' property. (We cannot just jump there,
5013 because the internal coherency of the bidi iterator state
5014 can not be preserved across such jumps.) We also must
5015 determine the paragraph base direction if the overlay we
5016 just processed is at the beginning of a new
5018 iterate_out_of_display_property (it
);
5021 case GET_FROM_STRING
:
5022 it
->object
= it
->string
;
5024 case GET_FROM_DISPLAY_VECTOR
:
5026 it
->method
= GET_FROM_C_STRING
;
5027 else if (STRINGP (it
->string
))
5028 it
->method
= GET_FROM_STRING
;
5031 it
->method
= GET_FROM_BUFFER
;
5032 it
->object
= it
->w
->buffer
;
5035 it
->end_charpos
= p
->end_charpos
;
5036 it
->string_nchars
= p
->string_nchars
;
5038 it
->multibyte_p
= p
->multibyte_p
;
5039 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5040 it
->space_width
= p
->space_width
;
5041 it
->font_height
= p
->font_height
;
5042 it
->voffset
= p
->voffset
;
5043 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5044 it
->line_wrap
= p
->line_wrap
;
5049 /***********************************************************************
5051 ***********************************************************************/
5053 /* Set IT's current position to the previous line start. */
5056 back_to_previous_line_start (struct it
*it
)
5058 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5059 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5063 /* Move IT to the next line start.
5065 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5066 we skipped over part of the text (as opposed to moving the iterator
5067 continuously over the text). Otherwise, don't change the value
5070 Newlines may come from buffer text, overlay strings, or strings
5071 displayed via the `display' property. That's the reason we can't
5072 simply use find_next_newline_no_quit.
5074 Note that this function may not skip over invisible text that is so
5075 because of text properties and immediately follows a newline. If
5076 it would, function reseat_at_next_visible_line_start, when called
5077 from set_iterator_to_next, would effectively make invisible
5078 characters following a newline part of the wrong glyph row, which
5079 leads to wrong cursor motion. */
5082 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5084 int old_selective
, newline_found_p
, n
;
5085 const int MAX_NEWLINE_DISTANCE
= 500;
5087 /* If already on a newline, just consume it to avoid unintended
5088 skipping over invisible text below. */
5089 if (it
->what
== IT_CHARACTER
5091 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5093 set_iterator_to_next (it
, 0);
5098 /* Don't handle selective display in the following. It's (a)
5099 unnecessary because it's done by the caller, and (b) leads to an
5100 infinite recursion because next_element_from_ellipsis indirectly
5101 calls this function. */
5102 old_selective
= it
->selective
;
5105 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5106 from buffer text. */
5107 for (n
= newline_found_p
= 0;
5108 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5109 n
+= STRINGP (it
->string
) ? 0 : 1)
5111 if (!get_next_display_element (it
))
5113 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5114 set_iterator_to_next (it
, 0);
5117 /* If we didn't find a newline near enough, see if we can use a
5119 if (!newline_found_p
)
5121 EMACS_INT start
= IT_CHARPOS (*it
);
5122 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5125 xassert (!STRINGP (it
->string
));
5127 /* If there isn't any `display' property in sight, and no
5128 overlays, we can just use the position of the newline in
5130 if (it
->stop_charpos
>= limit
5131 || ((pos
= Fnext_single_property_change (make_number (start
),
5133 Qnil
, make_number (limit
)),
5135 && next_overlay_change (start
) == ZV
))
5137 IT_CHARPOS (*it
) = limit
;
5138 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5139 *skipped_p
= newline_found_p
= 1;
5143 while (get_next_display_element (it
)
5144 && !newline_found_p
)
5146 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5147 set_iterator_to_next (it
, 0);
5152 it
->selective
= old_selective
;
5153 return newline_found_p
;
5157 /* Set IT's current position to the previous visible line start. Skip
5158 invisible text that is so either due to text properties or due to
5159 selective display. Caution: this does not change IT->current_x and
5163 back_to_previous_visible_line_start (struct it
*it
)
5165 while (IT_CHARPOS (*it
) > BEGV
)
5167 back_to_previous_line_start (it
);
5169 if (IT_CHARPOS (*it
) <= BEGV
)
5172 /* If selective > 0, then lines indented more than its value are
5174 if (it
->selective
> 0
5175 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5176 (double) it
->selective
)) /* iftc */
5179 /* Check the newline before point for invisibility. */
5182 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5183 Qinvisible
, it
->window
);
5184 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5188 if (IT_CHARPOS (*it
) <= BEGV
)
5195 Lisp_Object val
, overlay
;
5197 /* If newline is part of a composition, continue from start of composition */
5198 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5199 && beg
< IT_CHARPOS (*it
))
5202 /* If newline is replaced by a display property, find start of overlay
5203 or interval and continue search from that point. */
5205 pos
= --IT_CHARPOS (it2
);
5208 it2
.string_from_display_prop_p
= 0;
5209 if (handle_display_prop (&it2
) == HANDLED_RETURN
5210 && !NILP (val
= get_char_property_and_overlay
5211 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5212 && (OVERLAYP (overlay
)
5213 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5214 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5217 /* Newline is not replaced by anything -- so we are done. */
5223 IT_CHARPOS (*it
) = beg
;
5224 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5228 it
->continuation_lines_width
= 0;
5230 xassert (IT_CHARPOS (*it
) >= BEGV
);
5231 xassert (IT_CHARPOS (*it
) == BEGV
5232 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5237 /* Reseat iterator IT at the previous visible line start. Skip
5238 invisible text that is so either due to text properties or due to
5239 selective display. At the end, update IT's overlay information,
5240 face information etc. */
5243 reseat_at_previous_visible_line_start (struct it
*it
)
5245 back_to_previous_visible_line_start (it
);
5246 reseat (it
, it
->current
.pos
, 1);
5251 /* Reseat iterator IT on the next visible line start in the current
5252 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5253 preceding the line start. Skip over invisible text that is so
5254 because of selective display. Compute faces, overlays etc at the
5255 new position. Note that this function does not skip over text that
5256 is invisible because of text properties. */
5259 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5261 int newline_found_p
, skipped_p
= 0;
5263 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5265 /* Skip over lines that are invisible because they are indented
5266 more than the value of IT->selective. */
5267 if (it
->selective
> 0)
5268 while (IT_CHARPOS (*it
) < ZV
5269 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5270 (double) it
->selective
)) /* iftc */
5272 xassert (IT_BYTEPOS (*it
) == BEGV
5273 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5274 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5277 /* Position on the newline if that's what's requested. */
5278 if (on_newline_p
&& newline_found_p
)
5280 if (STRINGP (it
->string
))
5282 if (IT_STRING_CHARPOS (*it
) > 0)
5284 --IT_STRING_CHARPOS (*it
);
5285 --IT_STRING_BYTEPOS (*it
);
5288 else if (IT_CHARPOS (*it
) > BEGV
)
5292 reseat (it
, it
->current
.pos
, 0);
5296 reseat (it
, it
->current
.pos
, 0);
5303 /***********************************************************************
5304 Changing an iterator's position
5305 ***********************************************************************/
5307 /* Change IT's current position to POS in current_buffer. If FORCE_P
5308 is non-zero, always check for text properties at the new position.
5309 Otherwise, text properties are only looked up if POS >=
5310 IT->check_charpos of a property. */
5313 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5315 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5317 reseat_1 (it
, pos
, 0);
5319 /* Determine where to check text properties. Avoid doing it
5320 where possible because text property lookup is very expensive. */
5322 || CHARPOS (pos
) > it
->stop_charpos
5323 || CHARPOS (pos
) < original_pos
)
5327 /* For bidi iteration, we need to prime prev_stop and
5328 base_level_stop with our best estimations. */
5329 if (CHARPOS (pos
) < it
->prev_stop
)
5331 handle_stop_backwards (it
, BEGV
);
5332 if (CHARPOS (pos
) < it
->base_level_stop
)
5333 it
->base_level_stop
= 0;
5335 else if (CHARPOS (pos
) > it
->stop_charpos
5336 && it
->stop_charpos
>= BEGV
)
5337 handle_stop_backwards (it
, it
->stop_charpos
);
5344 it
->prev_stop
= it
->base_level_stop
= 0;
5353 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5354 IT->stop_pos to POS, also. */
5357 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5359 /* Don't call this function when scanning a C string. */
5360 xassert (it
->s
== NULL
);
5362 /* POS must be a reasonable value. */
5363 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5365 it
->current
.pos
= it
->position
= pos
;
5366 it
->end_charpos
= ZV
;
5368 it
->current
.dpvec_index
= -1;
5369 it
->current
.overlay_string_index
= -1;
5370 IT_STRING_CHARPOS (*it
) = -1;
5371 IT_STRING_BYTEPOS (*it
) = -1;
5373 it
->string_from_display_prop_p
= 0;
5374 it
->method
= GET_FROM_BUFFER
;
5375 it
->object
= it
->w
->buffer
;
5376 it
->area
= TEXT_AREA
;
5377 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5379 it
->string_from_display_prop_p
= 0;
5380 it
->face_before_selective_p
= 0;
5383 it
->bidi_it
.first_elt
= 1;
5384 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5389 it
->stop_charpos
= CHARPOS (pos
);
5390 it
->base_level_stop
= CHARPOS (pos
);
5395 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5396 If S is non-null, it is a C string to iterate over. Otherwise,
5397 STRING gives a Lisp string to iterate over.
5399 If PRECISION > 0, don't return more then PRECISION number of
5400 characters from the string.
5402 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5403 characters have been returned. FIELD_WIDTH < 0 means an infinite
5406 MULTIBYTE = 0 means disable processing of multibyte characters,
5407 MULTIBYTE > 0 means enable it,
5408 MULTIBYTE < 0 means use IT->multibyte_p.
5410 IT must be initialized via a prior call to init_iterator before
5411 calling this function. */
5414 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5415 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5418 /* No region in strings. */
5419 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5421 /* No text property checks performed by default, but see below. */
5422 it
->stop_charpos
= -1;
5424 /* Set iterator position and end position. */
5425 memset (&it
->current
, 0, sizeof it
->current
);
5426 it
->current
.overlay_string_index
= -1;
5427 it
->current
.dpvec_index
= -1;
5428 xassert (charpos
>= 0);
5430 /* If STRING is specified, use its multibyteness, otherwise use the
5431 setting of MULTIBYTE, if specified. */
5433 it
->multibyte_p
= multibyte
> 0;
5437 xassert (STRINGP (string
));
5438 it
->string
= string
;
5440 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5441 it
->method
= GET_FROM_STRING
;
5442 it
->current
.string_pos
= string_pos (charpos
, string
);
5446 it
->s
= (const unsigned char *) s
;
5449 /* Note that we use IT->current.pos, not it->current.string_pos,
5450 for displaying C strings. */
5451 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5452 if (it
->multibyte_p
)
5454 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5455 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5459 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5460 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5463 it
->method
= GET_FROM_C_STRING
;
5466 /* PRECISION > 0 means don't return more than PRECISION characters
5468 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5469 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5471 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5472 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5473 FIELD_WIDTH < 0 means infinite field width. This is useful for
5474 padding with `-' at the end of a mode line. */
5475 if (field_width
< 0)
5476 field_width
= INFINITY
;
5477 if (field_width
> it
->end_charpos
- charpos
)
5478 it
->end_charpos
= charpos
+ field_width
;
5480 /* Use the standard display table for displaying strings. */
5481 if (DISP_TABLE_P (Vstandard_display_table
))
5482 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5484 it
->stop_charpos
= charpos
;
5485 if (s
== NULL
&& it
->multibyte_p
)
5487 EMACS_INT endpos
= SCHARS (it
->string
);
5488 if (endpos
> it
->end_charpos
)
5489 endpos
= it
->end_charpos
;
5490 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5498 /***********************************************************************
5500 ***********************************************************************/
5502 /* Map enum it_method value to corresponding next_element_from_* function. */
5504 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5506 next_element_from_buffer
,
5507 next_element_from_display_vector
,
5508 next_element_from_string
,
5509 next_element_from_c_string
,
5510 next_element_from_image
,
5511 next_element_from_stretch
5514 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5517 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5518 (possibly with the following characters). */
5520 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5521 ((IT)->cmp_it.id >= 0 \
5522 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5523 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5524 END_CHARPOS, (IT)->w, \
5525 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5529 /* Lookup the char-table Vglyphless_char_display for character C (-1
5530 if we want information for no-font case), and return the display
5531 method symbol. By side-effect, update it->what and
5532 it->glyphless_method. This function is called from
5533 get_next_display_element for each character element, and from
5534 x_produce_glyphs when no suitable font was found. */
5537 lookup_glyphless_char_display (int c
, struct it
*it
)
5539 Lisp_Object glyphless_method
= Qnil
;
5541 if (CHAR_TABLE_P (Vglyphless_char_display
)
5542 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5546 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5547 if (CONSP (glyphless_method
))
5548 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5549 ? XCAR (glyphless_method
)
5550 : XCDR (glyphless_method
);
5553 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5557 if (NILP (glyphless_method
))
5560 /* The default is to display the character by a proper font. */
5562 /* The default for the no-font case is to display an empty box. */
5563 glyphless_method
= Qempty_box
;
5565 if (EQ (glyphless_method
, Qzero_width
))
5568 return glyphless_method
;
5569 /* This method can't be used for the no-font case. */
5570 glyphless_method
= Qempty_box
;
5572 if (EQ (glyphless_method
, Qthin_space
))
5573 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5574 else if (EQ (glyphless_method
, Qempty_box
))
5575 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5576 else if (EQ (glyphless_method
, Qhex_code
))
5577 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5578 else if (STRINGP (glyphless_method
))
5579 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5582 /* Invalid value. We use the default method. */
5583 glyphless_method
= Qnil
;
5586 it
->what
= IT_GLYPHLESS
;
5587 return glyphless_method
;
5590 /* Load IT's display element fields with information about the next
5591 display element from the current position of IT. Value is zero if
5592 end of buffer (or C string) is reached. */
5594 static struct frame
*last_escape_glyph_frame
= NULL
;
5595 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5596 static int last_escape_glyph_merged_face_id
= 0;
5598 struct frame
*last_glyphless_glyph_frame
= NULL
;
5599 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5600 int last_glyphless_glyph_merged_face_id
= 0;
5603 get_next_display_element (struct it
*it
)
5605 /* Non-zero means that we found a display element. Zero means that
5606 we hit the end of what we iterate over. Performance note: the
5607 function pointer `method' used here turns out to be faster than
5608 using a sequence of if-statements. */
5612 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5614 if (it
->what
== IT_CHARACTER
)
5616 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5617 and only if (a) the resolved directionality of that character
5619 /* FIXME: Do we need an exception for characters from display
5621 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5622 it
->c
= bidi_mirror_char (it
->c
);
5623 /* Map via display table or translate control characters.
5624 IT->c, IT->len etc. have been set to the next character by
5625 the function call above. If we have a display table, and it
5626 contains an entry for IT->c, translate it. Don't do this if
5627 IT->c itself comes from a display table, otherwise we could
5628 end up in an infinite recursion. (An alternative could be to
5629 count the recursion depth of this function and signal an
5630 error when a certain maximum depth is reached.) Is it worth
5632 if (success_p
&& it
->dpvec
== NULL
)
5635 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5636 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5637 nbsp_or_shy
= char_is_other
;
5638 int c
= it
->c
; /* This is the character to display. */
5640 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5642 xassert (SINGLE_BYTE_CHAR_P (c
));
5643 if (unibyte_display_via_language_environment
)
5645 c
= DECODE_CHAR (unibyte
, c
);
5647 c
= BYTE8_TO_CHAR (it
->c
);
5650 c
= BYTE8_TO_CHAR (it
->c
);
5654 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5657 struct Lisp_Vector
*v
= XVECTOR (dv
);
5659 /* Return the first character from the display table
5660 entry, if not empty. If empty, don't display the
5661 current character. */
5664 it
->dpvec_char_len
= it
->len
;
5665 it
->dpvec
= v
->contents
;
5666 it
->dpend
= v
->contents
+ v
->size
;
5667 it
->current
.dpvec_index
= 0;
5668 it
->dpvec_face_id
= -1;
5669 it
->saved_face_id
= it
->face_id
;
5670 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5675 set_iterator_to_next (it
, 0);
5680 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5682 if (it
->what
== IT_GLYPHLESS
)
5684 /* Don't display this character. */
5685 set_iterator_to_next (it
, 0);
5689 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5690 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5691 : c
== 0xAD ? char_is_soft_hyphen
5694 /* Translate control characters into `\003' or `^C' form.
5695 Control characters coming from a display table entry are
5696 currently not translated because we use IT->dpvec to hold
5697 the translation. This could easily be changed but I
5698 don't believe that it is worth doing.
5700 NBSP and SOFT-HYPEN are property translated too.
5702 Non-printable characters and raw-byte characters are also
5703 translated to octal form. */
5704 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5705 ? (it
->area
!= TEXT_AREA
5706 /* In mode line, treat \n, \t like other crl chars. */
5709 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5710 || (c
!= '\n' && c
!= '\t'))
5713 || ! CHAR_PRINTABLE_P (c
))))
5715 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5716 or a non-printable character which must be displayed
5717 either as '\003' or as `^C' where the '\\' and '^'
5718 can be defined in the display table. Fill
5719 IT->ctl_chars with glyphs for what we have to
5720 display. Then, set IT->dpvec to these glyphs. */
5723 int face_id
, lface_id
= 0 ;
5726 /* Handle control characters with ^. */
5728 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5732 g
= '^'; /* default glyph for Control */
5733 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5735 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5736 && GLYPH_CODE_CHAR_VALID_P (gc
))
5738 g
= GLYPH_CODE_CHAR (gc
);
5739 lface_id
= GLYPH_CODE_FACE (gc
);
5743 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5745 else if (it
->f
== last_escape_glyph_frame
5746 && it
->face_id
== last_escape_glyph_face_id
)
5748 face_id
= last_escape_glyph_merged_face_id
;
5752 /* Merge the escape-glyph face into the current face. */
5753 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5755 last_escape_glyph_frame
= it
->f
;
5756 last_escape_glyph_face_id
= it
->face_id
;
5757 last_escape_glyph_merged_face_id
= face_id
;
5760 XSETINT (it
->ctl_chars
[0], g
);
5761 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5763 goto display_control
;
5766 /* Handle non-break space in the mode where it only gets
5769 if (EQ (Vnobreak_char_display
, Qt
)
5770 && nbsp_or_shy
== char_is_nbsp
)
5772 /* Merge the no-break-space face into the current face. */
5773 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5777 XSETINT (it
->ctl_chars
[0], ' ');
5779 goto display_control
;
5782 /* Handle sequences that start with the "escape glyph". */
5784 /* the default escape glyph is \. */
5785 escape_glyph
= '\\';
5788 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5789 && GLYPH_CODE_CHAR_VALID_P (gc
))
5791 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5792 lface_id
= GLYPH_CODE_FACE (gc
);
5796 /* The display table specified a face.
5797 Merge it into face_id and also into escape_glyph. */
5798 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5801 else if (it
->f
== last_escape_glyph_frame
5802 && it
->face_id
== last_escape_glyph_face_id
)
5804 face_id
= last_escape_glyph_merged_face_id
;
5808 /* Merge the escape-glyph face into the current face. */
5809 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5811 last_escape_glyph_frame
= it
->f
;
5812 last_escape_glyph_face_id
= it
->face_id
;
5813 last_escape_glyph_merged_face_id
= face_id
;
5816 /* Handle soft hyphens in the mode where they only get
5819 if (EQ (Vnobreak_char_display
, Qt
)
5820 && nbsp_or_shy
== char_is_soft_hyphen
)
5822 XSETINT (it
->ctl_chars
[0], '-');
5824 goto display_control
;
5827 /* Handle non-break space and soft hyphen
5828 with the escape glyph. */
5832 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5833 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5834 XSETINT (it
->ctl_chars
[1], c
);
5836 goto display_control
;
5843 if (CHAR_BYTE8_P (c
))
5844 /* Display \200 instead of \17777600. */
5845 c
= CHAR_TO_BYTE8 (c
);
5846 len
= sprintf (str
, "%03o", c
);
5848 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5849 for (i
= 0; i
< len
; i
++)
5850 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5855 /* Set up IT->dpvec and return first character from it. */
5856 it
->dpvec_char_len
= it
->len
;
5857 it
->dpvec
= it
->ctl_chars
;
5858 it
->dpend
= it
->dpvec
+ ctl_len
;
5859 it
->current
.dpvec_index
= 0;
5860 it
->dpvec_face_id
= face_id
;
5861 it
->saved_face_id
= it
->face_id
;
5862 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5866 it
->char_to_display
= c
;
5870 it
->char_to_display
= it
->c
;
5874 /* Adjust face id for a multibyte character. There are no multibyte
5875 character in unibyte text. */
5876 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5879 && FRAME_WINDOW_P (it
->f
))
5881 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5883 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5885 /* Automatic composition with glyph-string. */
5886 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5888 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5892 EMACS_INT pos
= (it
->s
? -1
5893 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5894 : IT_CHARPOS (*it
));
5896 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5902 /* Is this character the last one of a run of characters with
5903 box? If yes, set IT->end_of_box_run_p to 1. */
5907 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5909 int face_id
= underlying_face_id (it
);
5910 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5914 if (face
->box
== FACE_NO_BOX
)
5916 /* If the box comes from face properties in a
5917 display string, check faces in that string. */
5918 int string_face_id
= face_after_it_pos (it
);
5919 it
->end_of_box_run_p
5920 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5923 /* Otherwise, the box comes from the underlying face.
5924 If this is the last string character displayed, check
5925 the next buffer location. */
5926 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5927 && (it
->current
.overlay_string_index
5928 == it
->n_overlay_strings
- 1))
5932 struct text_pos pos
= it
->current
.pos
;
5933 INC_TEXT_POS (pos
, it
->multibyte_p
);
5935 next_face_id
= face_at_buffer_position
5936 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5937 it
->region_end_charpos
, &ignore
,
5938 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5940 it
->end_of_box_run_p
5941 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5948 int face_id
= face_after_it_pos (it
);
5949 it
->end_of_box_run_p
5950 = (face_id
!= it
->face_id
5951 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5955 /* Value is 0 if end of buffer or string reached. */
5960 /* Move IT to the next display element.
5962 RESEAT_P non-zero means if called on a newline in buffer text,
5963 skip to the next visible line start.
5965 Functions get_next_display_element and set_iterator_to_next are
5966 separate because I find this arrangement easier to handle than a
5967 get_next_display_element function that also increments IT's
5968 position. The way it is we can first look at an iterator's current
5969 display element, decide whether it fits on a line, and if it does,
5970 increment the iterator position. The other way around we probably
5971 would either need a flag indicating whether the iterator has to be
5972 incremented the next time, or we would have to implement a
5973 decrement position function which would not be easy to write. */
5976 set_iterator_to_next (struct it
*it
, int reseat_p
)
5978 /* Reset flags indicating start and end of a sequence of characters
5979 with box. Reset them at the start of this function because
5980 moving the iterator to a new position might set them. */
5981 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5985 case GET_FROM_BUFFER
:
5986 /* The current display element of IT is a character from
5987 current_buffer. Advance in the buffer, and maybe skip over
5988 invisible lines that are so because of selective display. */
5989 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5990 reseat_at_next_visible_line_start (it
, 0);
5991 else if (it
->cmp_it
.id
>= 0)
5993 /* We are currently getting glyphs from a composition. */
5998 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
5999 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6000 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6002 it
->cmp_it
.from
= it
->cmp_it
.to
;
6007 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6009 it
->end_charpos
, Qnil
);
6012 else if (! it
->cmp_it
.reversed_p
)
6014 /* Composition created while scanning forward. */
6015 /* Update IT's char/byte positions to point to the first
6016 character of the next grapheme cluster, or to the
6017 character visually after the current composition. */
6018 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6019 bidi_move_to_visually_next (&it
->bidi_it
);
6020 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6021 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6023 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6025 /* Proceed to the next grapheme cluster. */
6026 it
->cmp_it
.from
= it
->cmp_it
.to
;
6030 /* No more grapheme clusters in this composition.
6031 Find the next stop position. */
6032 EMACS_INT stop
= it
->end_charpos
;
6033 if (it
->bidi_it
.scan_dir
< 0)
6034 /* Now we are scanning backward and don't know
6037 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6038 IT_BYTEPOS (*it
), stop
, Qnil
);
6043 /* Composition created while scanning backward. */
6044 /* Update IT's char/byte positions to point to the last
6045 character of the previous grapheme cluster, or the
6046 character visually after the current composition. */
6047 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6048 bidi_move_to_visually_next (&it
->bidi_it
);
6049 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6050 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6051 if (it
->cmp_it
.from
> 0)
6053 /* Proceed to the previous grapheme cluster. */
6054 it
->cmp_it
.to
= it
->cmp_it
.from
;
6058 /* No more grapheme clusters in this composition.
6059 Find the next stop position. */
6060 EMACS_INT stop
= it
->end_charpos
;
6061 if (it
->bidi_it
.scan_dir
< 0)
6062 /* Now we are scanning backward and don't know
6065 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6066 IT_BYTEPOS (*it
), stop
, Qnil
);
6072 xassert (it
->len
!= 0);
6076 IT_BYTEPOS (*it
) += it
->len
;
6077 IT_CHARPOS (*it
) += 1;
6081 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6082 /* If this is a new paragraph, determine its base
6083 direction (a.k.a. its base embedding level). */
6084 if (it
->bidi_it
.new_paragraph
)
6085 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6086 bidi_move_to_visually_next (&it
->bidi_it
);
6087 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6088 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6089 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6091 /* As the scan direction was changed, we must
6092 re-compute the stop position for composition. */
6093 EMACS_INT stop
= it
->end_charpos
;
6094 if (it
->bidi_it
.scan_dir
< 0)
6096 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6097 IT_BYTEPOS (*it
), stop
, Qnil
);
6100 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6104 case GET_FROM_C_STRING
:
6105 /* Current display element of IT is from a C string. */
6106 IT_BYTEPOS (*it
) += it
->len
;
6107 IT_CHARPOS (*it
) += 1;
6110 case GET_FROM_DISPLAY_VECTOR
:
6111 /* Current display element of IT is from a display table entry.
6112 Advance in the display table definition. Reset it to null if
6113 end reached, and continue with characters from buffers/
6115 ++it
->current
.dpvec_index
;
6117 /* Restore face of the iterator to what they were before the
6118 display vector entry (these entries may contain faces). */
6119 it
->face_id
= it
->saved_face_id
;
6121 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6123 int recheck_faces
= it
->ellipsis_p
;
6126 it
->method
= GET_FROM_C_STRING
;
6127 else if (STRINGP (it
->string
))
6128 it
->method
= GET_FROM_STRING
;
6131 it
->method
= GET_FROM_BUFFER
;
6132 it
->object
= it
->w
->buffer
;
6136 it
->current
.dpvec_index
= -1;
6138 /* Skip over characters which were displayed via IT->dpvec. */
6139 if (it
->dpvec_char_len
< 0)
6140 reseat_at_next_visible_line_start (it
, 1);
6141 else if (it
->dpvec_char_len
> 0)
6143 if (it
->method
== GET_FROM_STRING
6144 && it
->n_overlay_strings
> 0)
6145 it
->ignore_overlay_strings_at_pos_p
= 1;
6146 it
->len
= it
->dpvec_char_len
;
6147 set_iterator_to_next (it
, reseat_p
);
6150 /* Maybe recheck faces after display vector */
6152 it
->stop_charpos
= IT_CHARPOS (*it
);
6156 case GET_FROM_STRING
:
6157 /* Current display element is a character from a Lisp string. */
6158 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6159 if (it
->cmp_it
.id
>= 0)
6161 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6162 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6163 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6164 it
->cmp_it
.from
= it
->cmp_it
.to
;
6168 composition_compute_stop_pos (&it
->cmp_it
,
6169 IT_STRING_CHARPOS (*it
),
6170 IT_STRING_BYTEPOS (*it
),
6171 it
->end_charpos
, it
->string
);
6176 IT_STRING_BYTEPOS (*it
) += it
->len
;
6177 IT_STRING_CHARPOS (*it
) += 1;
6180 consider_string_end
:
6182 if (it
->current
.overlay_string_index
>= 0)
6184 /* IT->string is an overlay string. Advance to the
6185 next, if there is one. */
6186 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6189 next_overlay_string (it
);
6191 setup_for_ellipsis (it
, 0);
6196 /* IT->string is not an overlay string. If we reached
6197 its end, and there is something on IT->stack, proceed
6198 with what is on the stack. This can be either another
6199 string, this time an overlay string, or a buffer. */
6200 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6204 if (it
->method
== GET_FROM_STRING
)
6205 goto consider_string_end
;
6210 case GET_FROM_IMAGE
:
6211 case GET_FROM_STRETCH
:
6212 /* The position etc with which we have to proceed are on
6213 the stack. The position may be at the end of a string,
6214 if the `display' property takes up the whole string. */
6215 xassert (it
->sp
> 0);
6217 if (it
->method
== GET_FROM_STRING
)
6218 goto consider_string_end
;
6222 /* There are no other methods defined, so this should be a bug. */
6226 xassert (it
->method
!= GET_FROM_STRING
6227 || (STRINGP (it
->string
)
6228 && IT_STRING_CHARPOS (*it
) >= 0));
6231 /* Load IT's display element fields with information about the next
6232 display element which comes from a display table entry or from the
6233 result of translating a control character to one of the forms `^C'
6236 IT->dpvec holds the glyphs to return as characters.
6237 IT->saved_face_id holds the face id before the display vector--it
6238 is restored into IT->face_id in set_iterator_to_next. */
6241 next_element_from_display_vector (struct it
*it
)
6246 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6248 it
->face_id
= it
->saved_face_id
;
6250 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6251 That seemed totally bogus - so I changed it... */
6252 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6254 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6256 it
->c
= GLYPH_CODE_CHAR (gc
);
6257 it
->len
= CHAR_BYTES (it
->c
);
6259 /* The entry may contain a face id to use. Such a face id is
6260 the id of a Lisp face, not a realized face. A face id of
6261 zero means no face is specified. */
6262 if (it
->dpvec_face_id
>= 0)
6263 it
->face_id
= it
->dpvec_face_id
;
6266 int lface_id
= GLYPH_CODE_FACE (gc
);
6268 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6273 /* Display table entry is invalid. Return a space. */
6274 it
->c
= ' ', it
->len
= 1;
6276 /* Don't change position and object of the iterator here. They are
6277 still the values of the character that had this display table
6278 entry or was translated, and that's what we want. */
6279 it
->what
= IT_CHARACTER
;
6284 /* Load IT with the next display element from Lisp string IT->string.
6285 IT->current.string_pos is the current position within the string.
6286 If IT->current.overlay_string_index >= 0, the Lisp string is an
6290 next_element_from_string (struct it
*it
)
6292 struct text_pos position
;
6294 xassert (STRINGP (it
->string
));
6295 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6296 position
= it
->current
.string_pos
;
6298 /* Time to check for invisible text? */
6299 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6300 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6304 /* Since a handler may have changed IT->method, we must
6306 return GET_NEXT_DISPLAY_ELEMENT (it
);
6309 if (it
->current
.overlay_string_index
>= 0)
6311 /* Get the next character from an overlay string. In overlay
6312 strings, There is no field width or padding with spaces to
6314 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6319 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6320 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6321 && next_element_from_composition (it
))
6325 else if (STRING_MULTIBYTE (it
->string
))
6327 const unsigned char *s
= (SDATA (it
->string
)
6328 + IT_STRING_BYTEPOS (*it
));
6329 it
->c
= string_char_and_length (s
, &it
->len
);
6333 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6339 /* Get the next character from a Lisp string that is not an
6340 overlay string. Such strings come from the mode line, for
6341 example. We may have to pad with spaces, or truncate the
6342 string. See also next_element_from_c_string. */
6343 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6348 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6350 /* Pad with spaces. */
6351 it
->c
= ' ', it
->len
= 1;
6352 CHARPOS (position
) = BYTEPOS (position
) = -1;
6354 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6355 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6356 && next_element_from_composition (it
))
6360 else if (STRING_MULTIBYTE (it
->string
))
6362 const unsigned char *s
= (SDATA (it
->string
)
6363 + IT_STRING_BYTEPOS (*it
));
6364 it
->c
= string_char_and_length (s
, &it
->len
);
6368 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6373 /* Record what we have and where it came from. */
6374 it
->what
= IT_CHARACTER
;
6375 it
->object
= it
->string
;
6376 it
->position
= position
;
6381 /* Load IT with next display element from C string IT->s.
6382 IT->string_nchars is the maximum number of characters to return
6383 from the string. IT->end_charpos may be greater than
6384 IT->string_nchars when this function is called, in which case we
6385 may have to return padding spaces. Value is zero if end of string
6386 reached, including padding spaces. */
6389 next_element_from_c_string (struct it
*it
)
6394 it
->what
= IT_CHARACTER
;
6395 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6398 /* IT's position can be greater IT->string_nchars in case a field
6399 width or precision has been specified when the iterator was
6401 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6403 /* End of the game. */
6407 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6409 /* Pad with spaces. */
6410 it
->c
= ' ', it
->len
= 1;
6411 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6413 else if (it
->multibyte_p
)
6414 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6416 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6422 /* Set up IT to return characters from an ellipsis, if appropriate.
6423 The definition of the ellipsis glyphs may come from a display table
6424 entry. This function fills IT with the first glyph from the
6425 ellipsis if an ellipsis is to be displayed. */
6428 next_element_from_ellipsis (struct it
*it
)
6430 if (it
->selective_display_ellipsis_p
)
6431 setup_for_ellipsis (it
, it
->len
);
6434 /* The face at the current position may be different from the
6435 face we find after the invisible text. Remember what it
6436 was in IT->saved_face_id, and signal that it's there by
6437 setting face_before_selective_p. */
6438 it
->saved_face_id
= it
->face_id
;
6439 it
->method
= GET_FROM_BUFFER
;
6440 it
->object
= it
->w
->buffer
;
6441 reseat_at_next_visible_line_start (it
, 1);
6442 it
->face_before_selective_p
= 1;
6445 return GET_NEXT_DISPLAY_ELEMENT (it
);
6449 /* Deliver an image display element. The iterator IT is already
6450 filled with image information (done in handle_display_prop). Value
6455 next_element_from_image (struct it
*it
)
6457 it
->what
= IT_IMAGE
;
6458 it
->ignore_overlay_strings_at_pos_p
= 0;
6463 /* Fill iterator IT with next display element from a stretch glyph
6464 property. IT->object is the value of the text property. Value is
6468 next_element_from_stretch (struct it
*it
)
6470 it
->what
= IT_STRETCH
;
6474 /* Scan forward from CHARPOS in the current buffer, until we find a
6475 stop position > current IT's position. Then handle the stop
6476 position before that. This is called when we bump into a stop
6477 position while reordering bidirectional text. CHARPOS should be
6478 the last previously processed stop_pos (or BEGV, if none were
6479 processed yet) whose position is less that IT's current
6483 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6485 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6486 struct display_pos save_current
= it
->current
;
6487 struct text_pos save_position
= it
->position
;
6488 struct text_pos pos1
;
6489 EMACS_INT next_stop
;
6491 /* Scan in strict logical order. */
6495 it
->prev_stop
= charpos
;
6496 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6497 reseat_1 (it
, pos1
, 0);
6498 compute_stop_pos (it
);
6499 /* We must advance forward, right? */
6500 if (it
->stop_charpos
<= it
->prev_stop
)
6502 charpos
= it
->stop_charpos
;
6504 while (charpos
<= where_we_are
);
6506 next_stop
= it
->stop_charpos
;
6507 it
->stop_charpos
= it
->prev_stop
;
6509 it
->current
= save_current
;
6510 it
->position
= save_position
;
6512 it
->stop_charpos
= next_stop
;
6515 /* Load IT with the next display element from current_buffer. Value
6516 is zero if end of buffer reached. IT->stop_charpos is the next
6517 position at which to stop and check for text properties or buffer
6521 next_element_from_buffer (struct it
*it
)
6525 xassert (IT_CHARPOS (*it
) >= BEGV
);
6527 /* With bidi reordering, the character to display might not be the
6528 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6529 we were reseat()ed to a new buffer position, which is potentially
6530 a different paragraph. */
6531 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6533 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6534 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6535 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6537 /* Nothing to do, but reset the FIRST_ELT flag, like
6538 bidi_paragraph_init does, because we are not going to
6540 it
->bidi_it
.first_elt
= 0;
6542 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6543 /* FIXME: Should support all Unicode line separators. */
6544 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6545 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6547 /* If we are at the beginning of a line, we can produce the
6548 next element right away. */
6549 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6550 bidi_move_to_visually_next (&it
->bidi_it
);
6554 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6556 /* We need to prime the bidi iterator starting at the line's
6557 beginning, before we will be able to produce the next
6559 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6560 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6561 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6562 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6563 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6566 /* Now return to buffer position where we were asked to
6567 get the next display element, and produce that. */
6568 bidi_move_to_visually_next (&it
->bidi_it
);
6570 while (it
->bidi_it
.bytepos
!= orig_bytepos
6571 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6574 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6575 /* Adjust IT's position information to where we ended up. */
6576 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6577 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6578 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6580 EMACS_INT stop
= it
->end_charpos
;
6581 if (it
->bidi_it
.scan_dir
< 0)
6583 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6584 IT_BYTEPOS (*it
), stop
, Qnil
);
6588 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6590 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6592 int overlay_strings_follow_p
;
6594 /* End of the game, except when overlay strings follow that
6595 haven't been returned yet. */
6596 if (it
->overlay_strings_at_end_processed_p
)
6597 overlay_strings_follow_p
= 0;
6600 it
->overlay_strings_at_end_processed_p
= 1;
6601 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6604 if (overlay_strings_follow_p
)
6605 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6609 it
->position
= it
->current
.pos
;
6613 else if (!(!it
->bidi_p
6614 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6615 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6617 /* With bidi non-linear iteration, we could find ourselves
6618 far beyond the last computed stop_charpos, with several
6619 other stop positions in between that we missed. Scan
6620 them all now, in buffer's logical order, until we find
6621 and handle the last stop_charpos that precedes our
6622 current position. */
6623 handle_stop_backwards (it
, it
->stop_charpos
);
6624 return GET_NEXT_DISPLAY_ELEMENT (it
);
6630 /* Take note of the stop position we just moved across,
6631 for when we will move back across it. */
6632 it
->prev_stop
= it
->stop_charpos
;
6633 /* If we are at base paragraph embedding level, take
6634 note of the last stop position seen at this
6636 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6637 it
->base_level_stop
= it
->stop_charpos
;
6640 return GET_NEXT_DISPLAY_ELEMENT (it
);
6644 /* We can sometimes back up for reasons that have nothing
6645 to do with bidi reordering. E.g., compositions. The
6646 code below is only needed when we are above the base
6647 embedding level, so test for that explicitly. */
6648 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6649 && IT_CHARPOS (*it
) < it
->prev_stop
)
6651 if (it
->base_level_stop
<= 0)
6652 it
->base_level_stop
= BEGV
;
6653 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6655 handle_stop_backwards (it
, it
->base_level_stop
);
6656 return GET_NEXT_DISPLAY_ELEMENT (it
);
6660 /* No face changes, overlays etc. in sight, so just return a
6661 character from current_buffer. */
6665 /* Maybe run the redisplay end trigger hook. Performance note:
6666 This doesn't seem to cost measurable time. */
6667 if (it
->redisplay_end_trigger_charpos
6669 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6670 run_redisplay_end_trigger_hook (it
);
6672 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6673 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6675 && next_element_from_composition (it
))
6680 /* Get the next character, maybe multibyte. */
6681 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6682 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6683 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6685 it
->c
= *p
, it
->len
= 1;
6687 /* Record what we have and where it came from. */
6688 it
->what
= IT_CHARACTER
;
6689 it
->object
= it
->w
->buffer
;
6690 it
->position
= it
->current
.pos
;
6692 /* Normally we return the character found above, except when we
6693 really want to return an ellipsis for selective display. */
6698 /* A value of selective > 0 means hide lines indented more
6699 than that number of columns. */
6700 if (it
->selective
> 0
6701 && IT_CHARPOS (*it
) + 1 < ZV
6702 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6703 IT_BYTEPOS (*it
) + 1,
6704 (double) it
->selective
)) /* iftc */
6706 success_p
= next_element_from_ellipsis (it
);
6707 it
->dpvec_char_len
= -1;
6710 else if (it
->c
== '\r' && it
->selective
== -1)
6712 /* A value of selective == -1 means that everything from the
6713 CR to the end of the line is invisible, with maybe an
6714 ellipsis displayed for it. */
6715 success_p
= next_element_from_ellipsis (it
);
6716 it
->dpvec_char_len
= -1;
6721 /* Value is zero if end of buffer reached. */
6722 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6727 /* Run the redisplay end trigger hook for IT. */
6730 run_redisplay_end_trigger_hook (struct it
*it
)
6732 Lisp_Object args
[3];
6734 /* IT->glyph_row should be non-null, i.e. we should be actually
6735 displaying something, or otherwise we should not run the hook. */
6736 xassert (it
->glyph_row
);
6738 /* Set up hook arguments. */
6739 args
[0] = Qredisplay_end_trigger_functions
;
6740 args
[1] = it
->window
;
6741 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6742 it
->redisplay_end_trigger_charpos
= 0;
6744 /* Since we are *trying* to run these functions, don't try to run
6745 them again, even if they get an error. */
6746 it
->w
->redisplay_end_trigger
= Qnil
;
6747 Frun_hook_with_args (3, args
);
6749 /* Notice if it changed the face of the character we are on. */
6750 handle_face_prop (it
);
6754 /* Deliver a composition display element. Unlike the other
6755 next_element_from_XXX, this function is not registered in the array
6756 get_next_element[]. It is called from next_element_from_buffer and
6757 next_element_from_string when necessary. */
6760 next_element_from_composition (struct it
*it
)
6762 it
->what
= IT_COMPOSITION
;
6763 it
->len
= it
->cmp_it
.nbytes
;
6764 if (STRINGP (it
->string
))
6768 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6769 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6772 it
->position
= it
->current
.string_pos
;
6773 it
->object
= it
->string
;
6774 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6775 IT_STRING_BYTEPOS (*it
), it
->string
);
6781 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6782 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6785 if (it
->bidi_it
.new_paragraph
)
6786 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6787 /* Resync the bidi iterator with IT's new position.
6788 FIXME: this doesn't support bidirectional text. */
6789 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6790 bidi_move_to_visually_next (&it
->bidi_it
);
6794 it
->position
= it
->current
.pos
;
6795 it
->object
= it
->w
->buffer
;
6796 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6797 IT_BYTEPOS (*it
), Qnil
);
6804 /***********************************************************************
6805 Moving an iterator without producing glyphs
6806 ***********************************************************************/
6808 /* Check if iterator is at a position corresponding to a valid buffer
6809 position after some move_it_ call. */
6811 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6812 ((it)->method == GET_FROM_STRING \
6813 ? IT_STRING_CHARPOS (*it) == 0 \
6817 /* Move iterator IT to a specified buffer or X position within one
6818 line on the display without producing glyphs.
6820 OP should be a bit mask including some or all of these bits:
6821 MOVE_TO_X: Stop upon reaching x-position TO_X.
6822 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6823 Regardless of OP's value, stop upon reaching the end of the display line.
6825 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6826 This means, in particular, that TO_X includes window's horizontal
6829 The return value has several possible values that
6830 say what condition caused the scan to stop:
6832 MOVE_POS_MATCH_OR_ZV
6833 - when TO_POS or ZV was reached.
6836 -when TO_X was reached before TO_POS or ZV were reached.
6839 - when we reached the end of the display area and the line must
6843 - when we reached the end of the display area and the line is
6847 - when we stopped at a line end, i.e. a newline or a CR and selective
6850 static enum move_it_result
6851 move_it_in_display_line_to (struct it
*it
,
6852 EMACS_INT to_charpos
, int to_x
,
6853 enum move_operation_enum op
)
6855 enum move_it_result result
= MOVE_UNDEFINED
;
6856 struct glyph_row
*saved_glyph_row
;
6857 struct it wrap_it
, atpos_it
, atx_it
;
6859 enum it_method prev_method
= it
->method
;
6860 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6862 /* Don't produce glyphs in produce_glyphs. */
6863 saved_glyph_row
= it
->glyph_row
;
6864 it
->glyph_row
= NULL
;
6866 /* Use wrap_it to save a copy of IT wherever a word wrap could
6867 occur. Use atpos_it to save a copy of IT at the desired buffer
6868 position, if found, so that we can scan ahead and check if the
6869 word later overshoots the window edge. Use atx_it similarly, for
6875 #define BUFFER_POS_REACHED_P() \
6876 ((op & MOVE_TO_POS) != 0 \
6877 && BUFFERP (it->object) \
6878 && (IT_CHARPOS (*it) == to_charpos \
6879 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6880 && (it->method == GET_FROM_BUFFER \
6881 || (it->method == GET_FROM_DISPLAY_VECTOR \
6882 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6884 /* If there's a line-/wrap-prefix, handle it. */
6885 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6886 && it
->current_y
< it
->last_visible_y
)
6887 handle_line_prefix (it
);
6889 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6890 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6894 int x
, i
, ascent
= 0, descent
= 0;
6896 /* Utility macro to reset an iterator with x, ascent, and descent. */
6897 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6898 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6899 (IT)->max_descent = descent)
6901 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6903 if ((op
& MOVE_TO_POS
) != 0
6904 && BUFFERP (it
->object
)
6905 && it
->method
== GET_FROM_BUFFER
6906 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6908 && (prev_method
== GET_FROM_IMAGE
6909 || prev_method
== GET_FROM_STRETCH
)
6910 /* Passed TO_CHARPOS from left to right. */
6911 && ((prev_pos
< to_charpos
6912 && IT_CHARPOS (*it
) > to_charpos
)
6913 /* Passed TO_CHARPOS from right to left. */
6914 || (prev_pos
> to_charpos
6915 && IT_CHARPOS (*it
) < to_charpos
)))))
6917 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6919 result
= MOVE_POS_MATCH_OR_ZV
;
6922 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6923 /* If wrap_it is valid, the current position might be in a
6924 word that is wrapped. So, save the iterator in
6925 atpos_it and continue to see if wrapping happens. */
6929 prev_method
= it
->method
;
6930 if (it
->method
== GET_FROM_BUFFER
)
6931 prev_pos
= IT_CHARPOS (*it
);
6932 /* Stop when ZV reached.
6933 We used to stop here when TO_CHARPOS reached as well, but that is
6934 too soon if this glyph does not fit on this line. So we handle it
6935 explicitly below. */
6936 if (!get_next_display_element (it
))
6938 result
= MOVE_POS_MATCH_OR_ZV
;
6942 if (it
->line_wrap
== TRUNCATE
)
6944 if (BUFFER_POS_REACHED_P ())
6946 result
= MOVE_POS_MATCH_OR_ZV
;
6952 if (it
->line_wrap
== WORD_WRAP
)
6954 if (IT_DISPLAYING_WHITESPACE (it
))
6958 /* We have reached a glyph that follows one or more
6959 whitespace characters. If the position is
6960 already found, we are done. */
6961 if (atpos_it
.sp
>= 0)
6964 result
= MOVE_POS_MATCH_OR_ZV
;
6970 result
= MOVE_X_REACHED
;
6973 /* Otherwise, we can wrap here. */
6980 /* Remember the line height for the current line, in case
6981 the next element doesn't fit on the line. */
6982 ascent
= it
->max_ascent
;
6983 descent
= it
->max_descent
;
6985 /* The call to produce_glyphs will get the metrics of the
6986 display element IT is loaded with. Record the x-position
6987 before this display element, in case it doesn't fit on the
6991 PRODUCE_GLYPHS (it
);
6993 if (it
->area
!= TEXT_AREA
)
6995 set_iterator_to_next (it
, 1);
6996 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6997 SET_TEXT_POS (this_line_min_pos
,
6998 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7002 /* The number of glyphs we get back in IT->nglyphs will normally
7003 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7004 character on a terminal frame, or (iii) a line end. For the
7005 second case, IT->nglyphs - 1 padding glyphs will be present.
7006 (On X frames, there is only one glyph produced for a
7007 composite character.)
7009 The behavior implemented below means, for continuation lines,
7010 that as many spaces of a TAB as fit on the current line are
7011 displayed there. For terminal frames, as many glyphs of a
7012 multi-glyph character are displayed in the current line, too.
7013 This is what the old redisplay code did, and we keep it that
7014 way. Under X, the whole shape of a complex character must
7015 fit on the line or it will be completely displayed in the
7018 Note that both for tabs and padding glyphs, all glyphs have
7022 /* More than one glyph or glyph doesn't fit on line. All
7023 glyphs have the same width. */
7024 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7026 int x_before_this_char
= x
;
7027 int hpos_before_this_char
= it
->hpos
;
7029 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7031 new_x
= x
+ single_glyph_width
;
7033 /* We want to leave anything reaching TO_X to the caller. */
7034 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7036 if (BUFFER_POS_REACHED_P ())
7038 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7039 goto buffer_pos_reached
;
7040 if (atpos_it
.sp
< 0)
7043 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7048 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7051 result
= MOVE_X_REACHED
;
7057 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7062 if (/* Lines are continued. */
7063 it
->line_wrap
!= TRUNCATE
7064 && (/* And glyph doesn't fit on the line. */
7065 new_x
> it
->last_visible_x
7066 /* Or it fits exactly and we're on a window
7068 || (new_x
== it
->last_visible_x
7069 && FRAME_WINDOW_P (it
->f
))))
7071 if (/* IT->hpos == 0 means the very first glyph
7072 doesn't fit on the line, e.g. a wide image. */
7074 || (new_x
== it
->last_visible_x
7075 && FRAME_WINDOW_P (it
->f
)))
7078 it
->current_x
= new_x
;
7080 /* The character's last glyph just barely fits
7082 if (i
== it
->nglyphs
- 1)
7084 /* If this is the destination position,
7085 return a position *before* it in this row,
7086 now that we know it fits in this row. */
7087 if (BUFFER_POS_REACHED_P ())
7089 if (it
->line_wrap
!= WORD_WRAP
7092 it
->hpos
= hpos_before_this_char
;
7093 it
->current_x
= x_before_this_char
;
7094 result
= MOVE_POS_MATCH_OR_ZV
;
7097 if (it
->line_wrap
== WORD_WRAP
7101 atpos_it
.current_x
= x_before_this_char
;
7102 atpos_it
.hpos
= hpos_before_this_char
;
7106 set_iterator_to_next (it
, 1);
7107 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7108 SET_TEXT_POS (this_line_min_pos
,
7109 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7110 /* On graphical terminals, newlines may
7111 "overflow" into the fringe if
7112 overflow-newline-into-fringe is non-nil.
7113 On text-only terminals, newlines may
7114 overflow into the last glyph on the
7116 if (!FRAME_WINDOW_P (it
->f
)
7117 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7119 if (!get_next_display_element (it
))
7121 result
= MOVE_POS_MATCH_OR_ZV
;
7124 if (BUFFER_POS_REACHED_P ())
7126 if (ITERATOR_AT_END_OF_LINE_P (it
))
7127 result
= MOVE_POS_MATCH_OR_ZV
;
7129 result
= MOVE_LINE_CONTINUED
;
7132 if (ITERATOR_AT_END_OF_LINE_P (it
))
7134 result
= MOVE_NEWLINE_OR_CR
;
7141 IT_RESET_X_ASCENT_DESCENT (it
);
7143 if (wrap_it
.sp
>= 0)
7150 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7152 result
= MOVE_LINE_CONTINUED
;
7156 if (BUFFER_POS_REACHED_P ())
7158 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7159 goto buffer_pos_reached
;
7160 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7163 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7167 if (new_x
> it
->first_visible_x
)
7169 /* Glyph is visible. Increment number of glyphs that
7170 would be displayed. */
7175 if (result
!= MOVE_UNDEFINED
)
7178 else if (BUFFER_POS_REACHED_P ())
7181 IT_RESET_X_ASCENT_DESCENT (it
);
7182 result
= MOVE_POS_MATCH_OR_ZV
;
7185 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7187 /* Stop when TO_X specified and reached. This check is
7188 necessary here because of lines consisting of a line end,
7189 only. The line end will not produce any glyphs and we
7190 would never get MOVE_X_REACHED. */
7191 xassert (it
->nglyphs
== 0);
7192 result
= MOVE_X_REACHED
;
7196 /* Is this a line end? If yes, we're done. */
7197 if (ITERATOR_AT_END_OF_LINE_P (it
))
7199 result
= MOVE_NEWLINE_OR_CR
;
7203 if (it
->method
== GET_FROM_BUFFER
)
7204 prev_pos
= IT_CHARPOS (*it
);
7205 /* The current display element has been consumed. Advance
7207 set_iterator_to_next (it
, 1);
7208 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7209 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7211 /* Stop if lines are truncated and IT's current x-position is
7212 past the right edge of the window now. */
7213 if (it
->line_wrap
== TRUNCATE
7214 && it
->current_x
>= it
->last_visible_x
)
7216 if (!FRAME_WINDOW_P (it
->f
)
7217 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7219 if (!get_next_display_element (it
)
7220 || BUFFER_POS_REACHED_P ())
7222 result
= MOVE_POS_MATCH_OR_ZV
;
7225 if (ITERATOR_AT_END_OF_LINE_P (it
))
7227 result
= MOVE_NEWLINE_OR_CR
;
7231 result
= MOVE_LINE_TRUNCATED
;
7234 #undef IT_RESET_X_ASCENT_DESCENT
7237 #undef BUFFER_POS_REACHED_P
7239 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7240 restore the saved iterator. */
7241 if (atpos_it
.sp
>= 0)
7243 else if (atx_it
.sp
>= 0)
7248 /* Restore the iterator settings altered at the beginning of this
7250 it
->glyph_row
= saved_glyph_row
;
7254 /* For external use. */
7256 move_it_in_display_line (struct it
*it
,
7257 EMACS_INT to_charpos
, int to_x
,
7258 enum move_operation_enum op
)
7260 if (it
->line_wrap
== WORD_WRAP
7261 && (op
& MOVE_TO_X
))
7263 struct it save_it
= *it
;
7264 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7265 /* When word-wrap is on, TO_X may lie past the end
7266 of a wrapped line. Then it->current is the
7267 character on the next line, so backtrack to the
7268 space before the wrap point. */
7269 if (skip
== MOVE_LINE_CONTINUED
)
7271 int prev_x
= max (it
->current_x
- 1, 0);
7273 move_it_in_display_line_to
7274 (it
, -1, prev_x
, MOVE_TO_X
);
7278 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7282 /* Move IT forward until it satisfies one or more of the criteria in
7283 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7285 OP is a bit-mask that specifies where to stop, and in particular,
7286 which of those four position arguments makes a difference. See the
7287 description of enum move_operation_enum.
7289 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7290 screen line, this function will set IT to the next position >
7294 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7296 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7297 int line_height
, line_start_x
= 0, reached
= 0;
7301 if (op
& MOVE_TO_VPOS
)
7303 /* If no TO_CHARPOS and no TO_X specified, stop at the
7304 start of the line TO_VPOS. */
7305 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7307 if (it
->vpos
== to_vpos
)
7313 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7317 /* TO_VPOS >= 0 means stop at TO_X in the line at
7318 TO_VPOS, or at TO_POS, whichever comes first. */
7319 if (it
->vpos
== to_vpos
)
7325 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7327 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7332 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7334 /* We have reached TO_X but not in the line we want. */
7335 skip
= move_it_in_display_line_to (it
, to_charpos
,
7337 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7345 else if (op
& MOVE_TO_Y
)
7347 struct it it_backup
;
7349 if (it
->line_wrap
== WORD_WRAP
)
7352 /* TO_Y specified means stop at TO_X in the line containing
7353 TO_Y---or at TO_CHARPOS if this is reached first. The
7354 problem is that we can't really tell whether the line
7355 contains TO_Y before we have completely scanned it, and
7356 this may skip past TO_X. What we do is to first scan to
7359 If TO_X is not specified, use a TO_X of zero. The reason
7360 is to make the outcome of this function more predictable.
7361 If we didn't use TO_X == 0, we would stop at the end of
7362 the line which is probably not what a caller would expect
7364 skip
= move_it_in_display_line_to
7365 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7366 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7368 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7369 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7371 else if (skip
== MOVE_X_REACHED
)
7373 /* If TO_X was reached, we want to know whether TO_Y is
7374 in the line. We know this is the case if the already
7375 scanned glyphs make the line tall enough. Otherwise,
7376 we must check by scanning the rest of the line. */
7377 line_height
= it
->max_ascent
+ it
->max_descent
;
7378 if (to_y
>= it
->current_y
7379 && to_y
< it
->current_y
+ line_height
)
7385 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7386 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7388 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7389 line_height
= it
->max_ascent
+ it
->max_descent
;
7390 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7392 if (to_y
>= it
->current_y
7393 && to_y
< it
->current_y
+ line_height
)
7395 /* If TO_Y is in this line and TO_X was reached
7396 above, we scanned too far. We have to restore
7397 IT's settings to the ones before skipping. */
7404 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7410 /* Check whether TO_Y is in this line. */
7411 line_height
= it
->max_ascent
+ it
->max_descent
;
7412 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7414 if (to_y
>= it
->current_y
7415 && to_y
< it
->current_y
+ line_height
)
7417 /* When word-wrap is on, TO_X may lie past the end
7418 of a wrapped line. Then it->current is the
7419 character on the next line, so backtrack to the
7420 space before the wrap point. */
7421 if (skip
== MOVE_LINE_CONTINUED
7422 && it
->line_wrap
== WORD_WRAP
)
7424 int prev_x
= max (it
->current_x
- 1, 0);
7426 skip
= move_it_in_display_line_to
7427 (it
, -1, prev_x
, MOVE_TO_X
);
7436 else if (BUFFERP (it
->object
)
7437 && (it
->method
== GET_FROM_BUFFER
7438 || it
->method
== GET_FROM_STRETCH
)
7439 && IT_CHARPOS (*it
) >= to_charpos
)
7440 skip
= MOVE_POS_MATCH_OR_ZV
;
7442 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7446 case MOVE_POS_MATCH_OR_ZV
:
7450 case MOVE_NEWLINE_OR_CR
:
7451 set_iterator_to_next (it
, 1);
7452 it
->continuation_lines_width
= 0;
7455 case MOVE_LINE_TRUNCATED
:
7456 it
->continuation_lines_width
= 0;
7457 reseat_at_next_visible_line_start (it
, 0);
7458 if ((op
& MOVE_TO_POS
) != 0
7459 && IT_CHARPOS (*it
) > to_charpos
)
7466 case MOVE_LINE_CONTINUED
:
7467 /* For continued lines ending in a tab, some of the glyphs
7468 associated with the tab are displayed on the current
7469 line. Since it->current_x does not include these glyphs,
7470 we use it->last_visible_x instead. */
7473 it
->continuation_lines_width
+= it
->last_visible_x
;
7474 /* When moving by vpos, ensure that the iterator really
7475 advances to the next line (bug#847, bug#969). Fixme:
7476 do we need to do this in other circumstances? */
7477 if (it
->current_x
!= it
->last_visible_x
7478 && (op
& MOVE_TO_VPOS
)
7479 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7481 line_start_x
= it
->current_x
+ it
->pixel_width
7482 - it
->last_visible_x
;
7483 set_iterator_to_next (it
, 0);
7487 it
->continuation_lines_width
+= it
->current_x
;
7494 /* Reset/increment for the next run. */
7495 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7496 it
->current_x
= line_start_x
;
7499 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7501 last_height
= it
->max_ascent
+ it
->max_descent
;
7502 last_max_ascent
= it
->max_ascent
;
7503 it
->max_ascent
= it
->max_descent
= 0;
7508 /* On text terminals, we may stop at the end of a line in the middle
7509 of a multi-character glyph. If the glyph itself is continued,
7510 i.e. it is actually displayed on the next line, don't treat this
7511 stopping point as valid; move to the next line instead (unless
7512 that brings us offscreen). */
7513 if (!FRAME_WINDOW_P (it
->f
)
7515 && IT_CHARPOS (*it
) == to_charpos
7516 && it
->what
== IT_CHARACTER
7518 && it
->line_wrap
== WINDOW_WRAP
7519 && it
->current_x
== it
->last_visible_x
- 1
7522 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7524 it
->continuation_lines_width
+= it
->current_x
;
7525 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7526 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7528 last_height
= it
->max_ascent
+ it
->max_descent
;
7529 last_max_ascent
= it
->max_ascent
;
7532 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7536 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7538 If DY > 0, move IT backward at least that many pixels. DY = 0
7539 means move IT backward to the preceding line start or BEGV. This
7540 function may move over more than DY pixels if IT->current_y - DY
7541 ends up in the middle of a line; in this case IT->current_y will be
7542 set to the top of the line moved to. */
7545 move_it_vertically_backward (struct it
*it
, int dy
)
7549 EMACS_INT start_pos
;
7554 start_pos
= IT_CHARPOS (*it
);
7556 /* Estimate how many newlines we must move back. */
7557 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7559 /* Set the iterator's position that many lines back. */
7560 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7561 back_to_previous_visible_line_start (it
);
7563 /* Reseat the iterator here. When moving backward, we don't want
7564 reseat to skip forward over invisible text, set up the iterator
7565 to deliver from overlay strings at the new position etc. So,
7566 use reseat_1 here. */
7567 reseat_1 (it
, it
->current
.pos
, 1);
7569 /* We are now surely at a line start. */
7570 it
->current_x
= it
->hpos
= 0;
7571 it
->continuation_lines_width
= 0;
7573 /* Move forward and see what y-distance we moved. First move to the
7574 start of the next line so that we get its height. We need this
7575 height to be able to tell whether we reached the specified
7578 it2
.max_ascent
= it2
.max_descent
= 0;
7581 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7582 MOVE_TO_POS
| MOVE_TO_VPOS
);
7584 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7585 xassert (IT_CHARPOS (*it
) >= BEGV
);
7588 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7589 xassert (IT_CHARPOS (*it
) >= BEGV
);
7590 /* H is the actual vertical distance from the position in *IT
7591 and the starting position. */
7592 h
= it2
.current_y
- it
->current_y
;
7593 /* NLINES is the distance in number of lines. */
7594 nlines
= it2
.vpos
- it
->vpos
;
7596 /* Correct IT's y and vpos position
7597 so that they are relative to the starting point. */
7603 /* DY == 0 means move to the start of the screen line. The
7604 value of nlines is > 0 if continuation lines were involved. */
7606 move_it_by_lines (it
, nlines
);
7610 /* The y-position we try to reach, relative to *IT.
7611 Note that H has been subtracted in front of the if-statement. */
7612 int target_y
= it
->current_y
+ h
- dy
;
7613 int y0
= it3
.current_y
;
7614 int y1
= line_bottom_y (&it3
);
7615 int line_height
= y1
- y0
;
7617 /* If we did not reach target_y, try to move further backward if
7618 we can. If we moved too far backward, try to move forward. */
7619 if (target_y
< it
->current_y
7620 /* This is heuristic. In a window that's 3 lines high, with
7621 a line height of 13 pixels each, recentering with point
7622 on the bottom line will try to move -39/2 = 19 pixels
7623 backward. Try to avoid moving into the first line. */
7624 && (it
->current_y
- target_y
7625 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7626 && IT_CHARPOS (*it
) > BEGV
)
7628 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7629 target_y
- it
->current_y
));
7630 dy
= it
->current_y
- target_y
;
7631 goto move_further_back
;
7633 else if (target_y
>= it
->current_y
+ line_height
7634 && IT_CHARPOS (*it
) < ZV
)
7636 /* Should move forward by at least one line, maybe more.
7638 Note: Calling move_it_by_lines can be expensive on
7639 terminal frames, where compute_motion is used (via
7640 vmotion) to do the job, when there are very long lines
7641 and truncate-lines is nil. That's the reason for
7642 treating terminal frames specially here. */
7644 if (!FRAME_WINDOW_P (it
->f
))
7645 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7650 move_it_by_lines (it
, 1);
7652 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7659 /* Move IT by a specified amount of pixel lines DY. DY negative means
7660 move backwards. DY = 0 means move to start of screen line. At the
7661 end, IT will be on the start of a screen line. */
7664 move_it_vertically (struct it
*it
, int dy
)
7667 move_it_vertically_backward (it
, -dy
);
7670 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7671 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7672 MOVE_TO_POS
| MOVE_TO_Y
);
7673 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7675 /* If buffer ends in ZV without a newline, move to the start of
7676 the line to satisfy the post-condition. */
7677 if (IT_CHARPOS (*it
) == ZV
7679 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7680 move_it_by_lines (it
, 0);
7685 /* Move iterator IT past the end of the text line it is in. */
7688 move_it_past_eol (struct it
*it
)
7690 enum move_it_result rc
;
7692 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7693 if (rc
== MOVE_NEWLINE_OR_CR
)
7694 set_iterator_to_next (it
, 0);
7698 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7699 negative means move up. DVPOS == 0 means move to the start of the
7702 Optimization idea: If we would know that IT->f doesn't use
7703 a face with proportional font, we could be faster for
7704 truncate-lines nil. */
7707 move_it_by_lines (struct it
*it
, int dvpos
)
7710 /* The commented-out optimization uses vmotion on terminals. This
7711 gives bad results, because elements like it->what, on which
7712 callers such as pos_visible_p rely, aren't updated. */
7713 /* struct position pos;
7714 if (!FRAME_WINDOW_P (it->f))
7716 struct text_pos textpos;
7718 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7719 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7720 reseat (it, textpos, 1);
7721 it->vpos += pos.vpos;
7722 it->current_y += pos.vpos;
7728 /* DVPOS == 0 means move to the start of the screen line. */
7729 move_it_vertically_backward (it
, 0);
7730 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7731 /* Let next call to line_bottom_y calculate real line height */
7736 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7737 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7738 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7743 EMACS_INT start_charpos
, i
;
7745 /* Start at the beginning of the screen line containing IT's
7746 position. This may actually move vertically backwards,
7747 in case of overlays, so adjust dvpos accordingly. */
7749 move_it_vertically_backward (it
, 0);
7752 /* Go back -DVPOS visible lines and reseat the iterator there. */
7753 start_charpos
= IT_CHARPOS (*it
);
7754 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7755 back_to_previous_visible_line_start (it
);
7756 reseat (it
, it
->current
.pos
, 1);
7758 /* Move further back if we end up in a string or an image. */
7759 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7761 /* First try to move to start of display line. */
7763 move_it_vertically_backward (it
, 0);
7765 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7767 /* If start of line is still in string or image,
7768 move further back. */
7769 back_to_previous_visible_line_start (it
);
7770 reseat (it
, it
->current
.pos
, 1);
7774 it
->current_x
= it
->hpos
= 0;
7776 /* Above call may have moved too far if continuation lines
7777 are involved. Scan forward and see if it did. */
7779 it2
.vpos
= it2
.current_y
= 0;
7780 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7781 it
->vpos
-= it2
.vpos
;
7782 it
->current_y
-= it2
.current_y
;
7783 it
->current_x
= it
->hpos
= 0;
7785 /* If we moved too far back, move IT some lines forward. */
7786 if (it2
.vpos
> -dvpos
)
7788 int delta
= it2
.vpos
+ dvpos
;
7790 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7791 /* Move back again if we got too far ahead. */
7792 if (IT_CHARPOS (*it
) >= start_charpos
)
7798 /* Return 1 if IT points into the middle of a display vector. */
7801 in_display_vector_p (struct it
*it
)
7803 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7804 && it
->current
.dpvec_index
> 0
7805 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7809 /***********************************************************************
7811 ***********************************************************************/
7814 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7818 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7820 Lisp_Object args
[3];
7821 Lisp_Object msg
, fmt
;
7824 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7827 /* Do nothing if called asynchronously. Inserting text into
7828 a buffer may call after-change-functions and alike and
7829 that would means running Lisp asynchronously. */
7830 if (handling_signal
)
7834 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7836 args
[0] = fmt
= build_string (format
);
7839 msg
= Fformat (3, args
);
7841 len
= SBYTES (msg
) + 1;
7842 SAFE_ALLOCA (buffer
, char *, len
);
7843 memcpy (buffer
, SDATA (msg
), len
);
7845 message_dolog (buffer
, len
- 1, 1, 0);
7852 /* Output a newline in the *Messages* buffer if "needs" one. */
7855 message_log_maybe_newline (void)
7857 if (message_log_need_newline
)
7858 message_dolog ("", 0, 1, 0);
7862 /* Add a string M of length NBYTES to the message log, optionally
7863 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7864 nonzero, means interpret the contents of M as multibyte. This
7865 function calls low-level routines in order to bypass text property
7866 hooks, etc. which might not be safe to run.
7868 This may GC (insert may run before/after change hooks),
7869 so the buffer M must NOT point to a Lisp string. */
7872 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7874 const unsigned char *msg
= (const unsigned char *) m
;
7876 if (!NILP (Vmemory_full
))
7879 if (!NILP (Vmessage_log_max
))
7881 struct buffer
*oldbuf
;
7882 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7883 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7884 EMACS_INT point_at_end
= 0;
7885 EMACS_INT zv_at_end
= 0;
7886 Lisp_Object old_deactivate_mark
, tem
;
7887 struct gcpro gcpro1
;
7889 old_deactivate_mark
= Vdeactivate_mark
;
7890 oldbuf
= current_buffer
;
7891 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7892 BVAR (current_buffer
, undo_list
) = Qt
;
7894 oldpoint
= message_dolog_marker1
;
7895 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7896 oldbegv
= message_dolog_marker2
;
7897 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7898 oldzv
= message_dolog_marker3
;
7899 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7900 GCPRO1 (old_deactivate_mark
);
7908 BEGV_BYTE
= BEG_BYTE
;
7911 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7913 /* Insert the string--maybe converting multibyte to single byte
7914 or vice versa, so that all the text fits the buffer. */
7916 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7922 /* Convert a multibyte string to single-byte
7923 for the *Message* buffer. */
7924 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7926 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7927 work
[0] = (ASCII_CHAR_P (c
)
7929 : multibyte_char_to_unibyte (c
));
7930 insert_1_both (work
, 1, 1, 1, 0, 0);
7933 else if (! multibyte
7934 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7938 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7939 /* Convert a single-byte string to multibyte
7940 for the *Message* buffer. */
7941 for (i
= 0; i
< nbytes
; i
++)
7944 MAKE_CHAR_MULTIBYTE (c
);
7945 char_bytes
= CHAR_STRING (c
, str
);
7946 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7950 insert_1 (m
, nbytes
, 1, 0, 0);
7954 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7955 unsigned long int dups
;
7956 insert_1 ("\n", 1, 1, 0, 0);
7958 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7960 this_bol_byte
= PT_BYTE
;
7962 /* See if this line duplicates the previous one.
7963 If so, combine duplicates. */
7966 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7968 prev_bol_byte
= PT_BYTE
;
7970 dups
= message_log_check_duplicate (prev_bol_byte
,
7974 del_range_both (prev_bol
, prev_bol_byte
,
7975 this_bol
, this_bol_byte
, 0);
7981 /* If you change this format, don't forget to also
7982 change message_log_check_duplicate. */
7983 sprintf (dupstr
, " [%lu times]", dups
);
7984 duplen
= strlen (dupstr
);
7985 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7986 insert_1 (dupstr
, duplen
, 1, 0, 1);
7991 /* If we have more than the desired maximum number of lines
7992 in the *Messages* buffer now, delete the oldest ones.
7993 This is safe because we don't have undo in this buffer. */
7995 if (NATNUMP (Vmessage_log_max
))
7997 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7998 -XFASTINT (Vmessage_log_max
) - 1, 0);
7999 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8002 BEGV
= XMARKER (oldbegv
)->charpos
;
8003 BEGV_BYTE
= marker_byte_position (oldbegv
);
8012 ZV
= XMARKER (oldzv
)->charpos
;
8013 ZV_BYTE
= marker_byte_position (oldzv
);
8017 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8019 /* We can't do Fgoto_char (oldpoint) because it will run some
8021 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8022 XMARKER (oldpoint
)->bytepos
);
8025 unchain_marker (XMARKER (oldpoint
));
8026 unchain_marker (XMARKER (oldbegv
));
8027 unchain_marker (XMARKER (oldzv
));
8029 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8030 set_buffer_internal (oldbuf
);
8032 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8033 message_log_need_newline
= !nlflag
;
8034 Vdeactivate_mark
= old_deactivate_mark
;
8039 /* We are at the end of the buffer after just having inserted a newline.
8040 (Note: We depend on the fact we won't be crossing the gap.)
8041 Check to see if the most recent message looks a lot like the previous one.
8042 Return 0 if different, 1 if the new one should just replace it, or a
8043 value N > 1 if we should also append " [N times]". */
8045 static unsigned long int
8046 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8049 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8051 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8052 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8054 for (i
= 0; i
< len
; i
++)
8056 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8064 if (*p1
++ == ' ' && *p1
++ == '[')
8067 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8068 if (strncmp (pend
, " times]\n", 8) == 0)
8075 /* Display an echo area message M with a specified length of NBYTES
8076 bytes. The string may include null characters. If M is 0, clear
8077 out any existing message, and let the mini-buffer text show
8080 This may GC, so the buffer M must NOT point to a Lisp string. */
8083 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8085 /* First flush out any partial line written with print. */
8086 message_log_maybe_newline ();
8088 message_dolog (m
, nbytes
, 1, multibyte
);
8089 message2_nolog (m
, nbytes
, multibyte
);
8093 /* The non-logging counterpart of message2. */
8096 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8098 struct frame
*sf
= SELECTED_FRAME ();
8099 message_enable_multibyte
= multibyte
;
8101 if (FRAME_INITIAL_P (sf
))
8103 if (noninteractive_need_newline
)
8104 putc ('\n', stderr
);
8105 noninteractive_need_newline
= 0;
8107 fwrite (m
, nbytes
, 1, stderr
);
8108 if (cursor_in_echo_area
== 0)
8109 fprintf (stderr
, "\n");
8112 /* A null message buffer means that the frame hasn't really been
8113 initialized yet. Error messages get reported properly by
8114 cmd_error, so this must be just an informative message; toss it. */
8115 else if (INTERACTIVE
8116 && sf
->glyphs_initialized_p
8117 && FRAME_MESSAGE_BUF (sf
))
8119 Lisp_Object mini_window
;
8122 /* Get the frame containing the mini-buffer
8123 that the selected frame is using. */
8124 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8125 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8127 FRAME_SAMPLE_VISIBILITY (f
);
8128 if (FRAME_VISIBLE_P (sf
)
8129 && ! FRAME_VISIBLE_P (f
))
8130 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8134 set_message (m
, Qnil
, nbytes
, multibyte
);
8135 if (minibuffer_auto_raise
)
8136 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8139 clear_message (1, 1);
8141 do_pending_window_change (0);
8142 echo_area_display (1);
8143 do_pending_window_change (0);
8144 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8145 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8150 /* Display an echo area message M with a specified length of NBYTES
8151 bytes. The string may include null characters. If M is not a
8152 string, clear out any existing message, and let the mini-buffer
8155 This function cancels echoing. */
8158 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8160 struct gcpro gcpro1
;
8163 clear_message (1,1);
8166 /* First flush out any partial line written with print. */
8167 message_log_maybe_newline ();
8173 SAFE_ALLOCA (buffer
, char *, nbytes
);
8174 memcpy (buffer
, SDATA (m
), nbytes
);
8175 message_dolog (buffer
, nbytes
, 1, multibyte
);
8178 message3_nolog (m
, nbytes
, multibyte
);
8184 /* The non-logging version of message3.
8185 This does not cancel echoing, because it is used for echoing.
8186 Perhaps we need to make a separate function for echoing
8187 and make this cancel echoing. */
8190 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8192 struct frame
*sf
= SELECTED_FRAME ();
8193 message_enable_multibyte
= multibyte
;
8195 if (FRAME_INITIAL_P (sf
))
8197 if (noninteractive_need_newline
)
8198 putc ('\n', stderr
);
8199 noninteractive_need_newline
= 0;
8201 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8202 if (cursor_in_echo_area
== 0)
8203 fprintf (stderr
, "\n");
8206 /* A null message buffer means that the frame hasn't really been
8207 initialized yet. Error messages get reported properly by
8208 cmd_error, so this must be just an informative message; toss it. */
8209 else if (INTERACTIVE
8210 && sf
->glyphs_initialized_p
8211 && FRAME_MESSAGE_BUF (sf
))
8213 Lisp_Object mini_window
;
8217 /* Get the frame containing the mini-buffer
8218 that the selected frame is using. */
8219 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8220 frame
= XWINDOW (mini_window
)->frame
;
8223 FRAME_SAMPLE_VISIBILITY (f
);
8224 if (FRAME_VISIBLE_P (sf
)
8225 && !FRAME_VISIBLE_P (f
))
8226 Fmake_frame_visible (frame
);
8228 if (STRINGP (m
) && SCHARS (m
) > 0)
8230 set_message (NULL
, m
, nbytes
, multibyte
);
8231 if (minibuffer_auto_raise
)
8232 Fraise_frame (frame
);
8233 /* Assume we are not echoing.
8234 (If we are, echo_now will override this.) */
8235 echo_message_buffer
= Qnil
;
8238 clear_message (1, 1);
8240 do_pending_window_change (0);
8241 echo_area_display (1);
8242 do_pending_window_change (0);
8243 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8244 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8249 /* Display a null-terminated echo area message M. If M is 0, clear
8250 out any existing message, and let the mini-buffer text show through.
8252 The buffer M must continue to exist until after the echo area gets
8253 cleared or some other message gets displayed there. Do not pass
8254 text that is stored in a Lisp string. Do not pass text in a buffer
8255 that was alloca'd. */
8258 message1 (const char *m
)
8260 message2 (m
, (m
? strlen (m
) : 0), 0);
8264 /* The non-logging counterpart of message1. */
8267 message1_nolog (const char *m
)
8269 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8272 /* Display a message M which contains a single %s
8273 which gets replaced with STRING. */
8276 message_with_string (const char *m
, Lisp_Object string
, int log
)
8278 CHECK_STRING (string
);
8284 if (noninteractive_need_newline
)
8285 putc ('\n', stderr
);
8286 noninteractive_need_newline
= 0;
8287 fprintf (stderr
, m
, SDATA (string
));
8288 if (!cursor_in_echo_area
)
8289 fprintf (stderr
, "\n");
8293 else if (INTERACTIVE
)
8295 /* The frame whose minibuffer we're going to display the message on.
8296 It may be larger than the selected frame, so we need
8297 to use its buffer, not the selected frame's buffer. */
8298 Lisp_Object mini_window
;
8299 struct frame
*f
, *sf
= SELECTED_FRAME ();
8301 /* Get the frame containing the minibuffer
8302 that the selected frame is using. */
8303 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8304 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8306 /* A null message buffer means that the frame hasn't really been
8307 initialized yet. Error messages get reported properly by
8308 cmd_error, so this must be just an informative message; toss it. */
8309 if (FRAME_MESSAGE_BUF (f
))
8311 Lisp_Object args
[2], msg
;
8312 struct gcpro gcpro1
, gcpro2
;
8314 args
[0] = build_string (m
);
8315 args
[1] = msg
= string
;
8316 GCPRO2 (args
[0], msg
);
8319 msg
= Fformat (2, args
);
8322 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8324 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8328 /* Print should start at the beginning of the message
8329 buffer next time. */
8330 message_buf_print
= 0;
8336 /* Dump an informative message to the minibuf. If M is 0, clear out
8337 any existing message, and let the mini-buffer text show through. */
8340 vmessage (const char *m
, va_list ap
)
8346 if (noninteractive_need_newline
)
8347 putc ('\n', stderr
);
8348 noninteractive_need_newline
= 0;
8349 vfprintf (stderr
, m
, ap
);
8350 if (cursor_in_echo_area
== 0)
8351 fprintf (stderr
, "\n");
8355 else if (INTERACTIVE
)
8357 /* The frame whose mini-buffer we're going to display the message
8358 on. It may be larger than the selected frame, so we need to
8359 use its buffer, not the selected frame's buffer. */
8360 Lisp_Object mini_window
;
8361 struct frame
*f
, *sf
= SELECTED_FRAME ();
8363 /* Get the frame containing the mini-buffer
8364 that the selected frame is using. */
8365 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8366 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8368 /* A null message buffer means that the frame hasn't really been
8369 initialized yet. Error messages get reported properly by
8370 cmd_error, so this must be just an informative message; toss
8372 if (FRAME_MESSAGE_BUF (f
))
8376 char *buf
= FRAME_MESSAGE_BUF (f
);
8377 size_t bufsize
= FRAME_MESSAGE_BUF_SIZE (f
);
8380 memset (buf
, 0, bufsize
);
8381 len
= vsnprintf (buf
, bufsize
, m
, ap
);
8383 /* Do any truncation at a character boundary. */
8384 if (! (0 <= len
&& len
< bufsize
))
8386 char *end
= memchr (buf
, 0, bufsize
);
8387 for (len
= end
? end
- buf
: bufsize
;
8388 len
&& ! CHAR_HEAD_P (buf
[len
- 1]);
8393 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8398 /* Print should start at the beginning of the message
8399 buffer next time. */
8400 message_buf_print
= 0;
8406 message (const char *m
, ...)
8416 /* The non-logging version of message. */
8419 message_nolog (const char *m
, ...)
8421 Lisp_Object old_log_max
;
8424 old_log_max
= Vmessage_log_max
;
8425 Vmessage_log_max
= Qnil
;
8427 Vmessage_log_max
= old_log_max
;
8433 /* Display the current message in the current mini-buffer. This is
8434 only called from error handlers in process.c, and is not time
8438 update_echo_area (void)
8440 if (!NILP (echo_area_buffer
[0]))
8443 string
= Fcurrent_message ();
8444 message3 (string
, SBYTES (string
),
8445 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8450 /* Make sure echo area buffers in `echo_buffers' are live.
8451 If they aren't, make new ones. */
8454 ensure_echo_area_buffers (void)
8458 for (i
= 0; i
< 2; ++i
)
8459 if (!BUFFERP (echo_buffer
[i
])
8460 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8463 Lisp_Object old_buffer
;
8466 old_buffer
= echo_buffer
[i
];
8467 sprintf (name
, " *Echo Area %d*", i
);
8468 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8469 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8470 /* to force word wrap in echo area -
8471 it was decided to postpone this*/
8472 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8474 for (j
= 0; j
< 2; ++j
)
8475 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8476 echo_area_buffer
[j
] = echo_buffer
[i
];
8481 /* Call FN with args A1..A4 with either the current or last displayed
8482 echo_area_buffer as current buffer.
8484 WHICH zero means use the current message buffer
8485 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8486 from echo_buffer[] and clear it.
8488 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8489 suitable buffer from echo_buffer[] and clear it.
8491 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8492 that the current message becomes the last displayed one, make
8493 choose a suitable buffer for echo_area_buffer[0], and clear it.
8495 Value is what FN returns. */
8498 with_echo_area_buffer (struct window
*w
, int which
,
8499 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8500 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8503 int this_one
, the_other
, clear_buffer_p
, rc
;
8504 int count
= SPECPDL_INDEX ();
8506 /* If buffers aren't live, make new ones. */
8507 ensure_echo_area_buffers ();
8512 this_one
= 0, the_other
= 1;
8514 this_one
= 1, the_other
= 0;
8517 this_one
= 0, the_other
= 1;
8520 /* We need a fresh one in case the current echo buffer equals
8521 the one containing the last displayed echo area message. */
8522 if (!NILP (echo_area_buffer
[this_one
])
8523 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8524 echo_area_buffer
[this_one
] = Qnil
;
8527 /* Choose a suitable buffer from echo_buffer[] is we don't
8529 if (NILP (echo_area_buffer
[this_one
]))
8531 echo_area_buffer
[this_one
]
8532 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8533 ? echo_buffer
[the_other
]
8534 : echo_buffer
[this_one
]);
8538 buffer
= echo_area_buffer
[this_one
];
8540 /* Don't get confused by reusing the buffer used for echoing
8541 for a different purpose. */
8542 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8545 record_unwind_protect (unwind_with_echo_area_buffer
,
8546 with_echo_area_buffer_unwind_data (w
));
8548 /* Make the echo area buffer current. Note that for display
8549 purposes, it is not necessary that the displayed window's buffer
8550 == current_buffer, except for text property lookup. So, let's
8551 only set that buffer temporarily here without doing a full
8552 Fset_window_buffer. We must also change w->pointm, though,
8553 because otherwise an assertions in unshow_buffer fails, and Emacs
8555 set_buffer_internal_1 (XBUFFER (buffer
));
8559 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8562 BVAR (current_buffer
, undo_list
) = Qt
;
8563 BVAR (current_buffer
, read_only
) = Qnil
;
8564 specbind (Qinhibit_read_only
, Qt
);
8565 specbind (Qinhibit_modification_hooks
, Qt
);
8567 if (clear_buffer_p
&& Z
> BEG
)
8570 xassert (BEGV
>= BEG
);
8571 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8573 rc
= fn (a1
, a2
, a3
, a4
);
8575 xassert (BEGV
>= BEG
);
8576 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8578 unbind_to (count
, Qnil
);
8583 /* Save state that should be preserved around the call to the function
8584 FN called in with_echo_area_buffer. */
8587 with_echo_area_buffer_unwind_data (struct window
*w
)
8590 Lisp_Object vector
, tmp
;
8592 /* Reduce consing by keeping one vector in
8593 Vwith_echo_area_save_vector. */
8594 vector
= Vwith_echo_area_save_vector
;
8595 Vwith_echo_area_save_vector
= Qnil
;
8598 vector
= Fmake_vector (make_number (7), Qnil
);
8600 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8601 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8602 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8606 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8607 ASET (vector
, i
, w
->buffer
); ++i
;
8608 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8609 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8614 for (; i
< end
; ++i
)
8615 ASET (vector
, i
, Qnil
);
8618 xassert (i
== ASIZE (vector
));
8623 /* Restore global state from VECTOR which was created by
8624 with_echo_area_buffer_unwind_data. */
8627 unwind_with_echo_area_buffer (Lisp_Object vector
)
8629 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8630 Vdeactivate_mark
= AREF (vector
, 1);
8631 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8633 if (WINDOWP (AREF (vector
, 3)))
8636 Lisp_Object buffer
, charpos
, bytepos
;
8638 w
= XWINDOW (AREF (vector
, 3));
8639 buffer
= AREF (vector
, 4);
8640 charpos
= AREF (vector
, 5);
8641 bytepos
= AREF (vector
, 6);
8644 set_marker_both (w
->pointm
, buffer
,
8645 XFASTINT (charpos
), XFASTINT (bytepos
));
8648 Vwith_echo_area_save_vector
= vector
;
8653 /* Set up the echo area for use by print functions. MULTIBYTE_P
8654 non-zero means we will print multibyte. */
8657 setup_echo_area_for_printing (int multibyte_p
)
8659 /* If we can't find an echo area any more, exit. */
8660 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8663 ensure_echo_area_buffers ();
8665 if (!message_buf_print
)
8667 /* A message has been output since the last time we printed.
8668 Choose a fresh echo area buffer. */
8669 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8670 echo_area_buffer
[0] = echo_buffer
[1];
8672 echo_area_buffer
[0] = echo_buffer
[0];
8674 /* Switch to that buffer and clear it. */
8675 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8676 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8680 int count
= SPECPDL_INDEX ();
8681 specbind (Qinhibit_read_only
, Qt
);
8682 /* Note that undo recording is always disabled. */
8684 unbind_to (count
, Qnil
);
8686 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8688 /* Set up the buffer for the multibyteness we need. */
8690 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8691 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8693 /* Raise the frame containing the echo area. */
8694 if (minibuffer_auto_raise
)
8696 struct frame
*sf
= SELECTED_FRAME ();
8697 Lisp_Object mini_window
;
8698 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8699 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8702 message_log_maybe_newline ();
8703 message_buf_print
= 1;
8707 if (NILP (echo_area_buffer
[0]))
8709 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8710 echo_area_buffer
[0] = echo_buffer
[1];
8712 echo_area_buffer
[0] = echo_buffer
[0];
8715 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8717 /* Someone switched buffers between print requests. */
8718 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8719 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8725 /* Display an echo area message in window W. Value is non-zero if W's
8726 height is changed. If display_last_displayed_message_p is
8727 non-zero, display the message that was last displayed, otherwise
8728 display the current message. */
8731 display_echo_area (struct window
*w
)
8733 int i
, no_message_p
, window_height_changed_p
, count
;
8735 /* Temporarily disable garbage collections while displaying the echo
8736 area. This is done because a GC can print a message itself.
8737 That message would modify the echo area buffer's contents while a
8738 redisplay of the buffer is going on, and seriously confuse
8740 count
= inhibit_garbage_collection ();
8742 /* If there is no message, we must call display_echo_area_1
8743 nevertheless because it resizes the window. But we will have to
8744 reset the echo_area_buffer in question to nil at the end because
8745 with_echo_area_buffer will sets it to an empty buffer. */
8746 i
= display_last_displayed_message_p
? 1 : 0;
8747 no_message_p
= NILP (echo_area_buffer
[i
]);
8749 window_height_changed_p
8750 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8751 display_echo_area_1
,
8752 (EMACS_INT
) w
, Qnil
, 0, 0);
8755 echo_area_buffer
[i
] = Qnil
;
8757 unbind_to (count
, Qnil
);
8758 return window_height_changed_p
;
8762 /* Helper for display_echo_area. Display the current buffer which
8763 contains the current echo area message in window W, a mini-window,
8764 a pointer to which is passed in A1. A2..A4 are currently not used.
8765 Change the height of W so that all of the message is displayed.
8766 Value is non-zero if height of W was changed. */
8769 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8771 struct window
*w
= (struct window
*) a1
;
8773 struct text_pos start
;
8774 int window_height_changed_p
= 0;
8776 /* Do this before displaying, so that we have a large enough glyph
8777 matrix for the display. If we can't get enough space for the
8778 whole text, display the last N lines. That works by setting w->start. */
8779 window_height_changed_p
= resize_mini_window (w
, 0);
8781 /* Use the starting position chosen by resize_mini_window. */
8782 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8785 clear_glyph_matrix (w
->desired_matrix
);
8786 XSETWINDOW (window
, w
);
8787 try_window (window
, start
, 0);
8789 return window_height_changed_p
;
8793 /* Resize the echo area window to exactly the size needed for the
8794 currently displayed message, if there is one. If a mini-buffer
8795 is active, don't shrink it. */
8798 resize_echo_area_exactly (void)
8800 if (BUFFERP (echo_area_buffer
[0])
8801 && WINDOWP (echo_area_window
))
8803 struct window
*w
= XWINDOW (echo_area_window
);
8805 Lisp_Object resize_exactly
;
8807 if (minibuf_level
== 0)
8808 resize_exactly
= Qt
;
8810 resize_exactly
= Qnil
;
8812 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8813 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8816 ++windows_or_buffers_changed
;
8817 ++update_mode_lines
;
8818 redisplay_internal ();
8824 /* Callback function for with_echo_area_buffer, when used from
8825 resize_echo_area_exactly. A1 contains a pointer to the window to
8826 resize, EXACTLY non-nil means resize the mini-window exactly to the
8827 size of the text displayed. A3 and A4 are not used. Value is what
8828 resize_mini_window returns. */
8831 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8833 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8837 /* Resize mini-window W to fit the size of its contents. EXACT_P
8838 means size the window exactly to the size needed. Otherwise, it's
8839 only enlarged until W's buffer is empty.
8841 Set W->start to the right place to begin display. If the whole
8842 contents fit, start at the beginning. Otherwise, start so as
8843 to make the end of the contents appear. This is particularly
8844 important for y-or-n-p, but seems desirable generally.
8846 Value is non-zero if the window height has been changed. */
8849 resize_mini_window (struct window
*w
, int exact_p
)
8851 struct frame
*f
= XFRAME (w
->frame
);
8852 int window_height_changed_p
= 0;
8854 xassert (MINI_WINDOW_P (w
));
8856 /* By default, start display at the beginning. */
8857 set_marker_both (w
->start
, w
->buffer
,
8858 BUF_BEGV (XBUFFER (w
->buffer
)),
8859 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8861 /* Don't resize windows while redisplaying a window; it would
8862 confuse redisplay functions when the size of the window they are
8863 displaying changes from under them. Such a resizing can happen,
8864 for instance, when which-func prints a long message while
8865 we are running fontification-functions. We're running these
8866 functions with safe_call which binds inhibit-redisplay to t. */
8867 if (!NILP (Vinhibit_redisplay
))
8870 /* Nil means don't try to resize. */
8871 if (NILP (Vresize_mini_windows
)
8872 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8875 if (!FRAME_MINIBUF_ONLY_P (f
))
8878 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8879 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8880 int height
, max_height
;
8881 int unit
= FRAME_LINE_HEIGHT (f
);
8882 struct text_pos start
;
8883 struct buffer
*old_current_buffer
= NULL
;
8885 if (current_buffer
!= XBUFFER (w
->buffer
))
8887 old_current_buffer
= current_buffer
;
8888 set_buffer_internal (XBUFFER (w
->buffer
));
8891 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8893 /* Compute the max. number of lines specified by the user. */
8894 if (FLOATP (Vmax_mini_window_height
))
8895 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8896 else if (INTEGERP (Vmax_mini_window_height
))
8897 max_height
= XINT (Vmax_mini_window_height
);
8899 max_height
= total_height
/ 4;
8901 /* Correct that max. height if it's bogus. */
8902 max_height
= max (1, max_height
);
8903 max_height
= min (total_height
, max_height
);
8905 /* Find out the height of the text in the window. */
8906 if (it
.line_wrap
== TRUNCATE
)
8911 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8912 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8913 height
= it
.current_y
+ last_height
;
8915 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8916 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8917 height
= (height
+ unit
- 1) / unit
;
8920 /* Compute a suitable window start. */
8921 if (height
> max_height
)
8923 height
= max_height
;
8924 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8925 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8926 start
= it
.current
.pos
;
8929 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8930 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8932 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8934 /* Let it grow only, until we display an empty message, in which
8935 case the window shrinks again. */
8936 if (height
> WINDOW_TOTAL_LINES (w
))
8938 int old_height
= WINDOW_TOTAL_LINES (w
);
8939 freeze_window_starts (f
, 1);
8940 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8941 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8943 else if (height
< WINDOW_TOTAL_LINES (w
)
8944 && (exact_p
|| BEGV
== ZV
))
8946 int old_height
= WINDOW_TOTAL_LINES (w
);
8947 freeze_window_starts (f
, 0);
8948 shrink_mini_window (w
);
8949 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8954 /* Always resize to exact size needed. */
8955 if (height
> WINDOW_TOTAL_LINES (w
))
8957 int old_height
= WINDOW_TOTAL_LINES (w
);
8958 freeze_window_starts (f
, 1);
8959 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8960 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8962 else if (height
< WINDOW_TOTAL_LINES (w
))
8964 int old_height
= WINDOW_TOTAL_LINES (w
);
8965 freeze_window_starts (f
, 0);
8966 shrink_mini_window (w
);
8970 freeze_window_starts (f
, 1);
8971 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8974 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8978 if (old_current_buffer
)
8979 set_buffer_internal (old_current_buffer
);
8982 return window_height_changed_p
;
8986 /* Value is the current message, a string, or nil if there is no
8990 current_message (void)
8994 if (!BUFFERP (echo_area_buffer
[0]))
8998 with_echo_area_buffer (0, 0, current_message_1
,
8999 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9001 echo_area_buffer
[0] = Qnil
;
9009 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9011 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9014 *msg
= make_buffer_string (BEG
, Z
, 1);
9021 /* Push the current message on Vmessage_stack for later restauration
9022 by restore_message. Value is non-zero if the current message isn't
9023 empty. This is a relatively infrequent operation, so it's not
9024 worth optimizing. */
9030 msg
= current_message ();
9031 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9032 return STRINGP (msg
);
9036 /* Restore message display from the top of Vmessage_stack. */
9039 restore_message (void)
9043 xassert (CONSP (Vmessage_stack
));
9044 msg
= XCAR (Vmessage_stack
);
9046 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9048 message3_nolog (msg
, 0, 0);
9052 /* Handler for record_unwind_protect calling pop_message. */
9055 pop_message_unwind (Lisp_Object dummy
)
9061 /* Pop the top-most entry off Vmessage_stack. */
9066 xassert (CONSP (Vmessage_stack
));
9067 Vmessage_stack
= XCDR (Vmessage_stack
);
9071 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9072 exits. If the stack is not empty, we have a missing pop_message
9076 check_message_stack (void)
9078 if (!NILP (Vmessage_stack
))
9083 /* Truncate to NCHARS what will be displayed in the echo area the next
9084 time we display it---but don't redisplay it now. */
9087 truncate_echo_area (EMACS_INT nchars
)
9090 echo_area_buffer
[0] = Qnil
;
9091 /* A null message buffer means that the frame hasn't really been
9092 initialized yet. Error messages get reported properly by
9093 cmd_error, so this must be just an informative message; toss it. */
9094 else if (!noninteractive
9096 && !NILP (echo_area_buffer
[0]))
9098 struct frame
*sf
= SELECTED_FRAME ();
9099 if (FRAME_MESSAGE_BUF (sf
))
9100 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9105 /* Helper function for truncate_echo_area. Truncate the current
9106 message to at most NCHARS characters. */
9109 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9111 if (BEG
+ nchars
< Z
)
9112 del_range (BEG
+ nchars
, Z
);
9114 echo_area_buffer
[0] = Qnil
;
9119 /* Set the current message to a substring of S or STRING.
9121 If STRING is a Lisp string, set the message to the first NBYTES
9122 bytes from STRING. NBYTES zero means use the whole string. If
9123 STRING is multibyte, the message will be displayed multibyte.
9125 If S is not null, set the message to the first LEN bytes of S. LEN
9126 zero means use the whole string. MULTIBYTE_P non-zero means S is
9127 multibyte. Display the message multibyte in that case.
9129 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9130 to t before calling set_message_1 (which calls insert).
9134 set_message (const char *s
, Lisp_Object string
,
9135 EMACS_INT nbytes
, int multibyte_p
)
9137 message_enable_multibyte
9138 = ((s
&& multibyte_p
)
9139 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9141 with_echo_area_buffer (0, -1, set_message_1
,
9142 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9143 message_buf_print
= 0;
9144 help_echo_showing_p
= 0;
9148 /* Helper function for set_message. Arguments have the same meaning
9149 as there, with A1 corresponding to S and A2 corresponding to STRING
9150 This function is called with the echo area buffer being
9154 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9156 const char *s
= (const char *) a1
;
9157 const unsigned char *msg
= (const unsigned char *) s
;
9158 Lisp_Object string
= a2
;
9160 /* Change multibyteness of the echo buffer appropriately. */
9161 if (message_enable_multibyte
9162 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9163 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9165 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9166 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9167 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9169 /* Insert new message at BEG. */
9170 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9172 if (STRINGP (string
))
9177 nbytes
= SBYTES (string
);
9178 nchars
= string_byte_to_char (string
, nbytes
);
9180 /* This function takes care of single/multibyte conversion. We
9181 just have to ensure that the echo area buffer has the right
9182 setting of enable_multibyte_characters. */
9183 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9188 nbytes
= strlen (s
);
9190 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9192 /* Convert from multi-byte to single-byte. */
9197 /* Convert a multibyte string to single-byte. */
9198 for (i
= 0; i
< nbytes
; i
+= n
)
9200 c
= string_char_and_length (msg
+ i
, &n
);
9201 work
[0] = (ASCII_CHAR_P (c
)
9203 : multibyte_char_to_unibyte (c
));
9204 insert_1_both (work
, 1, 1, 1, 0, 0);
9207 else if (!multibyte_p
9208 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9210 /* Convert from single-byte to multi-byte. */
9213 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9215 /* Convert a single-byte string to multibyte. */
9216 for (i
= 0; i
< nbytes
; i
++)
9219 MAKE_CHAR_MULTIBYTE (c
);
9220 n
= CHAR_STRING (c
, str
);
9221 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9225 insert_1 (s
, nbytes
, 1, 0, 0);
9232 /* Clear messages. CURRENT_P non-zero means clear the current
9233 message. LAST_DISPLAYED_P non-zero means clear the message
9237 clear_message (int current_p
, int last_displayed_p
)
9241 echo_area_buffer
[0] = Qnil
;
9242 message_cleared_p
= 1;
9245 if (last_displayed_p
)
9246 echo_area_buffer
[1] = Qnil
;
9248 message_buf_print
= 0;
9251 /* Clear garbaged frames.
9253 This function is used where the old redisplay called
9254 redraw_garbaged_frames which in turn called redraw_frame which in
9255 turn called clear_frame. The call to clear_frame was a source of
9256 flickering. I believe a clear_frame is not necessary. It should
9257 suffice in the new redisplay to invalidate all current matrices,
9258 and ensure a complete redisplay of all windows. */
9261 clear_garbaged_frames (void)
9265 Lisp_Object tail
, frame
;
9266 int changed_count
= 0;
9268 FOR_EACH_FRAME (tail
, frame
)
9270 struct frame
*f
= XFRAME (frame
);
9272 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9276 Fredraw_frame (frame
);
9277 f
->force_flush_display_p
= 1;
9279 clear_current_matrices (f
);
9288 ++windows_or_buffers_changed
;
9293 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9294 is non-zero update selected_frame. Value is non-zero if the
9295 mini-windows height has been changed. */
9298 echo_area_display (int update_frame_p
)
9300 Lisp_Object mini_window
;
9303 int window_height_changed_p
= 0;
9304 struct frame
*sf
= SELECTED_FRAME ();
9306 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9307 w
= XWINDOW (mini_window
);
9308 f
= XFRAME (WINDOW_FRAME (w
));
9310 /* Don't display if frame is invisible or not yet initialized. */
9311 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9314 #ifdef HAVE_WINDOW_SYSTEM
9315 /* When Emacs starts, selected_frame may be the initial terminal
9316 frame. If we let this through, a message would be displayed on
9318 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9320 #endif /* HAVE_WINDOW_SYSTEM */
9322 /* Redraw garbaged frames. */
9324 clear_garbaged_frames ();
9326 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9328 echo_area_window
= mini_window
;
9329 window_height_changed_p
= display_echo_area (w
);
9330 w
->must_be_updated_p
= 1;
9332 /* Update the display, unless called from redisplay_internal.
9333 Also don't update the screen during redisplay itself. The
9334 update will happen at the end of redisplay, and an update
9335 here could cause confusion. */
9336 if (update_frame_p
&& !redisplaying_p
)
9340 /* If the display update has been interrupted by pending
9341 input, update mode lines in the frame. Due to the
9342 pending input, it might have been that redisplay hasn't
9343 been called, so that mode lines above the echo area are
9344 garbaged. This looks odd, so we prevent it here. */
9345 if (!display_completed
)
9346 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9348 if (window_height_changed_p
9349 /* Don't do this if Emacs is shutting down. Redisplay
9350 needs to run hooks. */
9351 && !NILP (Vrun_hooks
))
9353 /* Must update other windows. Likewise as in other
9354 cases, don't let this update be interrupted by
9356 int count
= SPECPDL_INDEX ();
9357 specbind (Qredisplay_dont_pause
, Qt
);
9358 windows_or_buffers_changed
= 1;
9359 redisplay_internal ();
9360 unbind_to (count
, Qnil
);
9362 else if (FRAME_WINDOW_P (f
) && n
== 0)
9364 /* Window configuration is the same as before.
9365 Can do with a display update of the echo area,
9366 unless we displayed some mode lines. */
9367 update_single_window (w
, 1);
9368 FRAME_RIF (f
)->flush_display (f
);
9371 update_frame (f
, 1, 1);
9373 /* If cursor is in the echo area, make sure that the next
9374 redisplay displays the minibuffer, so that the cursor will
9375 be replaced with what the minibuffer wants. */
9376 if (cursor_in_echo_area
)
9377 ++windows_or_buffers_changed
;
9380 else if (!EQ (mini_window
, selected_window
))
9381 windows_or_buffers_changed
++;
9383 /* Last displayed message is now the current message. */
9384 echo_area_buffer
[1] = echo_area_buffer
[0];
9385 /* Inform read_char that we're not echoing. */
9386 echo_message_buffer
= Qnil
;
9388 /* Prevent redisplay optimization in redisplay_internal by resetting
9389 this_line_start_pos. This is done because the mini-buffer now
9390 displays the message instead of its buffer text. */
9391 if (EQ (mini_window
, selected_window
))
9392 CHARPOS (this_line_start_pos
) = 0;
9394 return window_height_changed_p
;
9399 /***********************************************************************
9400 Mode Lines and Frame Titles
9401 ***********************************************************************/
9403 /* A buffer for constructing non-propertized mode-line strings and
9404 frame titles in it; allocated from the heap in init_xdisp and
9405 resized as needed in store_mode_line_noprop_char. */
9407 static char *mode_line_noprop_buf
;
9409 /* The buffer's end, and a current output position in it. */
9411 static char *mode_line_noprop_buf_end
;
9412 static char *mode_line_noprop_ptr
;
9414 #define MODE_LINE_NOPROP_LEN(start) \
9415 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9418 MODE_LINE_DISPLAY
= 0,
9424 /* Alist that caches the results of :propertize.
9425 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9426 static Lisp_Object mode_line_proptrans_alist
;
9428 /* List of strings making up the mode-line. */
9429 static Lisp_Object mode_line_string_list
;
9431 /* Base face property when building propertized mode line string. */
9432 static Lisp_Object mode_line_string_face
;
9433 static Lisp_Object mode_line_string_face_prop
;
9436 /* Unwind data for mode line strings */
9438 static Lisp_Object Vmode_line_unwind_vector
;
9441 format_mode_line_unwind_data (struct buffer
*obuf
,
9445 Lisp_Object vector
, tmp
;
9447 /* Reduce consing by keeping one vector in
9448 Vwith_echo_area_save_vector. */
9449 vector
= Vmode_line_unwind_vector
;
9450 Vmode_line_unwind_vector
= Qnil
;
9453 vector
= Fmake_vector (make_number (8), Qnil
);
9455 ASET (vector
, 0, make_number (mode_line_target
));
9456 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9457 ASET (vector
, 2, mode_line_string_list
);
9458 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9459 ASET (vector
, 4, mode_line_string_face
);
9460 ASET (vector
, 5, mode_line_string_face_prop
);
9463 XSETBUFFER (tmp
, obuf
);
9466 ASET (vector
, 6, tmp
);
9467 ASET (vector
, 7, owin
);
9473 unwind_format_mode_line (Lisp_Object vector
)
9475 mode_line_target
= XINT (AREF (vector
, 0));
9476 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9477 mode_line_string_list
= AREF (vector
, 2);
9478 if (! EQ (AREF (vector
, 3), Qt
))
9479 mode_line_proptrans_alist
= AREF (vector
, 3);
9480 mode_line_string_face
= AREF (vector
, 4);
9481 mode_line_string_face_prop
= AREF (vector
, 5);
9483 if (!NILP (AREF (vector
, 7)))
9484 /* Select window before buffer, since it may change the buffer. */
9485 Fselect_window (AREF (vector
, 7), Qt
);
9487 if (!NILP (AREF (vector
, 6)))
9489 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9490 ASET (vector
, 6, Qnil
);
9493 Vmode_line_unwind_vector
= vector
;
9498 /* Store a single character C for the frame title in mode_line_noprop_buf.
9499 Re-allocate mode_line_noprop_buf if necessary. */
9502 store_mode_line_noprop_char (char c
)
9504 /* If output position has reached the end of the allocated buffer,
9505 double the buffer's size. */
9506 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9508 int len
= MODE_LINE_NOPROP_LEN (0);
9509 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9510 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9511 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9512 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9515 *mode_line_noprop_ptr
++ = c
;
9519 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9520 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9521 characters that yield more columns than PRECISION; PRECISION <= 0
9522 means copy the whole string. Pad with spaces until FIELD_WIDTH
9523 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9524 pad. Called from display_mode_element when it is used to build a
9528 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9530 const unsigned char *str
= (const unsigned char *) string
;
9532 EMACS_INT dummy
, nbytes
;
9534 /* Copy at most PRECISION chars from STR. */
9535 nbytes
= strlen (string
);
9536 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9538 store_mode_line_noprop_char (*str
++);
9540 /* Fill up with spaces until FIELD_WIDTH reached. */
9541 while (field_width
> 0
9544 store_mode_line_noprop_char (' ');
9551 /***********************************************************************
9553 ***********************************************************************/
9555 #ifdef HAVE_WINDOW_SYSTEM
9557 /* Set the title of FRAME, if it has changed. The title format is
9558 Vicon_title_format if FRAME is iconified, otherwise it is
9559 frame_title_format. */
9562 x_consider_frame_title (Lisp_Object frame
)
9564 struct frame
*f
= XFRAME (frame
);
9566 if (FRAME_WINDOW_P (f
)
9567 || FRAME_MINIBUF_ONLY_P (f
)
9568 || f
->explicit_name
)
9570 /* Do we have more than one visible frame on this X display? */
9577 int count
= SPECPDL_INDEX ();
9579 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9581 Lisp_Object other_frame
= XCAR (tail
);
9582 struct frame
*tf
= XFRAME (other_frame
);
9585 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9586 && !FRAME_MINIBUF_ONLY_P (tf
)
9587 && !EQ (other_frame
, tip_frame
)
9588 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9592 /* Set global variable indicating that multiple frames exist. */
9593 multiple_frames
= CONSP (tail
);
9595 /* Switch to the buffer of selected window of the frame. Set up
9596 mode_line_target so that display_mode_element will output into
9597 mode_line_noprop_buf; then display the title. */
9598 record_unwind_protect (unwind_format_mode_line
,
9599 format_mode_line_unwind_data
9600 (current_buffer
, selected_window
, 0));
9602 Fselect_window (f
->selected_window
, Qt
);
9603 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9604 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9606 mode_line_target
= MODE_LINE_TITLE
;
9607 title_start
= MODE_LINE_NOPROP_LEN (0);
9608 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9609 NULL
, DEFAULT_FACE_ID
);
9610 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9611 len
= MODE_LINE_NOPROP_LEN (title_start
);
9612 title
= mode_line_noprop_buf
+ title_start
;
9613 unbind_to (count
, Qnil
);
9615 /* Set the title only if it's changed. This avoids consing in
9616 the common case where it hasn't. (If it turns out that we've
9617 already wasted too much time by walking through the list with
9618 display_mode_element, then we might need to optimize at a
9619 higher level than this.) */
9620 if (! STRINGP (f
->name
)
9621 || SBYTES (f
->name
) != len
9622 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9623 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9627 #endif /* not HAVE_WINDOW_SYSTEM */
9632 /***********************************************************************
9634 ***********************************************************************/
9637 /* Prepare for redisplay by updating menu-bar item lists when
9638 appropriate. This can call eval. */
9641 prepare_menu_bars (void)
9644 struct gcpro gcpro1
, gcpro2
;
9646 Lisp_Object tooltip_frame
;
9648 #ifdef HAVE_WINDOW_SYSTEM
9649 tooltip_frame
= tip_frame
;
9651 tooltip_frame
= Qnil
;
9654 /* Update all frame titles based on their buffer names, etc. We do
9655 this before the menu bars so that the buffer-menu will show the
9656 up-to-date frame titles. */
9657 #ifdef HAVE_WINDOW_SYSTEM
9658 if (windows_or_buffers_changed
|| update_mode_lines
)
9660 Lisp_Object tail
, frame
;
9662 FOR_EACH_FRAME (tail
, frame
)
9665 if (!EQ (frame
, tooltip_frame
)
9666 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9667 x_consider_frame_title (frame
);
9670 #endif /* HAVE_WINDOW_SYSTEM */
9672 /* Update the menu bar item lists, if appropriate. This has to be
9673 done before any actual redisplay or generation of display lines. */
9674 all_windows
= (update_mode_lines
9675 || buffer_shared
> 1
9676 || windows_or_buffers_changed
);
9679 Lisp_Object tail
, frame
;
9680 int count
= SPECPDL_INDEX ();
9681 /* 1 means that update_menu_bar has run its hooks
9682 so any further calls to update_menu_bar shouldn't do so again. */
9683 int menu_bar_hooks_run
= 0;
9685 record_unwind_save_match_data ();
9687 FOR_EACH_FRAME (tail
, frame
)
9691 /* Ignore tooltip frame. */
9692 if (EQ (frame
, tooltip_frame
))
9695 /* If a window on this frame changed size, report that to
9696 the user and clear the size-change flag. */
9697 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9699 Lisp_Object functions
;
9701 /* Clear flag first in case we get an error below. */
9702 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9703 functions
= Vwindow_size_change_functions
;
9704 GCPRO2 (tail
, functions
);
9706 while (CONSP (functions
))
9708 if (!EQ (XCAR (functions
), Qt
))
9709 call1 (XCAR (functions
), frame
);
9710 functions
= XCDR (functions
);
9716 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9717 #ifdef HAVE_WINDOW_SYSTEM
9718 update_tool_bar (f
, 0);
9721 if (windows_or_buffers_changed
9723 ns_set_doc_edited (f
, Fbuffer_modified_p
9724 (XWINDOW (f
->selected_window
)->buffer
));
9729 unbind_to (count
, Qnil
);
9733 struct frame
*sf
= SELECTED_FRAME ();
9734 update_menu_bar (sf
, 1, 0);
9735 #ifdef HAVE_WINDOW_SYSTEM
9736 update_tool_bar (sf
, 1);
9742 /* Update the menu bar item list for frame F. This has to be done
9743 before we start to fill in any display lines, because it can call
9746 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9748 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9749 already ran the menu bar hooks for this redisplay, so there
9750 is no need to run them again. The return value is the
9751 updated value of this flag, to pass to the next call. */
9754 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9757 register struct window
*w
;
9759 /* If called recursively during a menu update, do nothing. This can
9760 happen when, for instance, an activate-menubar-hook causes a
9762 if (inhibit_menubar_update
)
9765 window
= FRAME_SELECTED_WINDOW (f
);
9766 w
= XWINDOW (window
);
9768 if (FRAME_WINDOW_P (f
)
9770 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9771 || defined (HAVE_NS) || defined (USE_GTK)
9772 FRAME_EXTERNAL_MENU_BAR (f
)
9774 FRAME_MENU_BAR_LINES (f
) > 0
9776 : FRAME_MENU_BAR_LINES (f
) > 0)
9778 /* If the user has switched buffers or windows, we need to
9779 recompute to reflect the new bindings. But we'll
9780 recompute when update_mode_lines is set too; that means
9781 that people can use force-mode-line-update to request
9782 that the menu bar be recomputed. The adverse effect on
9783 the rest of the redisplay algorithm is about the same as
9784 windows_or_buffers_changed anyway. */
9785 if (windows_or_buffers_changed
9786 /* This used to test w->update_mode_line, but we believe
9787 there is no need to recompute the menu in that case. */
9788 || update_mode_lines
9789 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9790 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9791 != !NILP (w
->last_had_star
))
9792 || ((!NILP (Vtransient_mark_mode
)
9793 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9794 != !NILP (w
->region_showing
)))
9796 struct buffer
*prev
= current_buffer
;
9797 int count
= SPECPDL_INDEX ();
9799 specbind (Qinhibit_menubar_update
, Qt
);
9801 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9802 if (save_match_data
)
9803 record_unwind_save_match_data ();
9804 if (NILP (Voverriding_local_map_menu_flag
))
9806 specbind (Qoverriding_terminal_local_map
, Qnil
);
9807 specbind (Qoverriding_local_map
, Qnil
);
9812 /* Run the Lucid hook. */
9813 safe_run_hooks (Qactivate_menubar_hook
);
9815 /* If it has changed current-menubar from previous value,
9816 really recompute the menu-bar from the value. */
9817 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9818 call0 (Qrecompute_lucid_menubar
);
9820 safe_run_hooks (Qmenu_bar_update_hook
);
9825 XSETFRAME (Vmenu_updating_frame
, f
);
9826 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9828 /* Redisplay the menu bar in case we changed it. */
9829 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9830 || defined (HAVE_NS) || defined (USE_GTK)
9831 if (FRAME_WINDOW_P (f
))
9833 #if defined (HAVE_NS)
9834 /* All frames on Mac OS share the same menubar. So only
9835 the selected frame should be allowed to set it. */
9836 if (f
== SELECTED_FRAME ())
9838 set_frame_menubar (f
, 0, 0);
9841 /* On a terminal screen, the menu bar is an ordinary screen
9842 line, and this makes it get updated. */
9843 w
->update_mode_line
= Qt
;
9844 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9845 /* In the non-toolkit version, the menu bar is an ordinary screen
9846 line, and this makes it get updated. */
9847 w
->update_mode_line
= Qt
;
9848 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9850 unbind_to (count
, Qnil
);
9851 set_buffer_internal_1 (prev
);
9860 /***********************************************************************
9862 ***********************************************************************/
9864 #ifdef HAVE_WINDOW_SYSTEM
9867 Nominal cursor position -- where to draw output.
9868 HPOS and VPOS are window relative glyph matrix coordinates.
9869 X and Y are window relative pixel coordinates. */
9871 struct cursor_pos output_cursor
;
9875 Set the global variable output_cursor to CURSOR. All cursor
9876 positions are relative to updated_window. */
9879 set_output_cursor (struct cursor_pos
*cursor
)
9881 output_cursor
.hpos
= cursor
->hpos
;
9882 output_cursor
.vpos
= cursor
->vpos
;
9883 output_cursor
.x
= cursor
->x
;
9884 output_cursor
.y
= cursor
->y
;
9889 Set a nominal cursor position.
9891 HPOS and VPOS are column/row positions in a window glyph matrix. X
9892 and Y are window text area relative pixel positions.
9894 If this is done during an update, updated_window will contain the
9895 window that is being updated and the position is the future output
9896 cursor position for that window. If updated_window is null, use
9897 selected_window and display the cursor at the given position. */
9900 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9904 /* If updated_window is not set, work on selected_window. */
9908 w
= XWINDOW (selected_window
);
9910 /* Set the output cursor. */
9911 output_cursor
.hpos
= hpos
;
9912 output_cursor
.vpos
= vpos
;
9913 output_cursor
.x
= x
;
9914 output_cursor
.y
= y
;
9916 /* If not called as part of an update, really display the cursor.
9917 This will also set the cursor position of W. */
9918 if (updated_window
== NULL
)
9921 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9922 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9923 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9928 #endif /* HAVE_WINDOW_SYSTEM */
9931 /***********************************************************************
9933 ***********************************************************************/
9935 #ifdef HAVE_WINDOW_SYSTEM
9937 /* Where the mouse was last time we reported a mouse event. */
9939 FRAME_PTR last_mouse_frame
;
9941 /* Tool-bar item index of the item on which a mouse button was pressed
9944 int last_tool_bar_item
;
9948 update_tool_bar_unwind (Lisp_Object frame
)
9950 selected_frame
= frame
;
9954 /* Update the tool-bar item list for frame F. This has to be done
9955 before we start to fill in any display lines. Called from
9956 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9957 and restore it here. */
9960 update_tool_bar (struct frame
*f
, int save_match_data
)
9962 #if defined (USE_GTK) || defined (HAVE_NS)
9963 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9965 int do_update
= WINDOWP (f
->tool_bar_window
)
9966 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9974 window
= FRAME_SELECTED_WINDOW (f
);
9975 w
= XWINDOW (window
);
9977 /* If the user has switched buffers or windows, we need to
9978 recompute to reflect the new bindings. But we'll
9979 recompute when update_mode_lines is set too; that means
9980 that people can use force-mode-line-update to request
9981 that the menu bar be recomputed. The adverse effect on
9982 the rest of the redisplay algorithm is about the same as
9983 windows_or_buffers_changed anyway. */
9984 if (windows_or_buffers_changed
9985 || !NILP (w
->update_mode_line
)
9986 || update_mode_lines
9987 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9988 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9989 != !NILP (w
->last_had_star
))
9990 || ((!NILP (Vtransient_mark_mode
)
9991 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9992 != !NILP (w
->region_showing
)))
9994 struct buffer
*prev
= current_buffer
;
9995 int count
= SPECPDL_INDEX ();
9996 Lisp_Object frame
, new_tool_bar
;
9998 struct gcpro gcpro1
;
10000 /* Set current_buffer to the buffer of the selected
10001 window of the frame, so that we get the right local
10003 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10005 /* Save match data, if we must. */
10006 if (save_match_data
)
10007 record_unwind_save_match_data ();
10009 /* Make sure that we don't accidentally use bogus keymaps. */
10010 if (NILP (Voverriding_local_map_menu_flag
))
10012 specbind (Qoverriding_terminal_local_map
, Qnil
);
10013 specbind (Qoverriding_local_map
, Qnil
);
10016 GCPRO1 (new_tool_bar
);
10018 /* We must temporarily set the selected frame to this frame
10019 before calling tool_bar_items, because the calculation of
10020 the tool-bar keymap uses the selected frame (see
10021 `tool-bar-make-keymap' in tool-bar.el). */
10022 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10023 XSETFRAME (frame
, f
);
10024 selected_frame
= frame
;
10026 /* Build desired tool-bar items from keymaps. */
10027 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10030 /* Redisplay the tool-bar if we changed it. */
10031 if (new_n_tool_bar
!= f
->n_tool_bar_items
10032 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10034 /* Redisplay that happens asynchronously due to an expose event
10035 may access f->tool_bar_items. Make sure we update both
10036 variables within BLOCK_INPUT so no such event interrupts. */
10038 f
->tool_bar_items
= new_tool_bar
;
10039 f
->n_tool_bar_items
= new_n_tool_bar
;
10040 w
->update_mode_line
= Qt
;
10046 unbind_to (count
, Qnil
);
10047 set_buffer_internal_1 (prev
);
10053 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10054 F's desired tool-bar contents. F->tool_bar_items must have
10055 been set up previously by calling prepare_menu_bars. */
10058 build_desired_tool_bar_string (struct frame
*f
)
10060 int i
, size
, size_needed
;
10061 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10062 Lisp_Object image
, plist
, props
;
10064 image
= plist
= props
= Qnil
;
10065 GCPRO3 (image
, plist
, props
);
10067 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10068 Otherwise, make a new string. */
10070 /* The size of the string we might be able to reuse. */
10071 size
= (STRINGP (f
->desired_tool_bar_string
)
10072 ? SCHARS (f
->desired_tool_bar_string
)
10075 /* We need one space in the string for each image. */
10076 size_needed
= f
->n_tool_bar_items
;
10078 /* Reuse f->desired_tool_bar_string, if possible. */
10079 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10080 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10081 make_number (' '));
10084 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10085 Fremove_text_properties (make_number (0), make_number (size
),
10086 props
, f
->desired_tool_bar_string
);
10089 /* Put a `display' property on the string for the images to display,
10090 put a `menu_item' property on tool-bar items with a value that
10091 is the index of the item in F's tool-bar item vector. */
10092 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10094 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10096 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10097 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10098 int hmargin
, vmargin
, relief
, idx
, end
;
10100 /* If image is a vector, choose the image according to the
10102 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10103 if (VECTORP (image
))
10107 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10108 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10111 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10112 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10114 xassert (ASIZE (image
) >= idx
);
10115 image
= AREF (image
, idx
);
10120 /* Ignore invalid image specifications. */
10121 if (!valid_image_p (image
))
10124 /* Display the tool-bar button pressed, or depressed. */
10125 plist
= Fcopy_sequence (XCDR (image
));
10127 /* Compute margin and relief to draw. */
10128 relief
= (tool_bar_button_relief
>= 0
10129 ? tool_bar_button_relief
10130 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10131 hmargin
= vmargin
= relief
;
10133 if (INTEGERP (Vtool_bar_button_margin
)
10134 && XINT (Vtool_bar_button_margin
) > 0)
10136 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10137 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10139 else if (CONSP (Vtool_bar_button_margin
))
10141 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10142 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10143 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10145 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10146 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10147 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10150 if (auto_raise_tool_bar_buttons_p
)
10152 /* Add a `:relief' property to the image spec if the item is
10156 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10163 /* If image is selected, display it pressed, i.e. with a
10164 negative relief. If it's not selected, display it with a
10166 plist
= Fplist_put (plist
, QCrelief
,
10168 ? make_number (-relief
)
10169 : make_number (relief
)));
10174 /* Put a margin around the image. */
10175 if (hmargin
|| vmargin
)
10177 if (hmargin
== vmargin
)
10178 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10180 plist
= Fplist_put (plist
, QCmargin
,
10181 Fcons (make_number (hmargin
),
10182 make_number (vmargin
)));
10185 /* If button is not enabled, and we don't have special images
10186 for the disabled state, make the image appear disabled by
10187 applying an appropriate algorithm to it. */
10188 if (!enabled_p
&& idx
< 0)
10189 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10191 /* Put a `display' text property on the string for the image to
10192 display. Put a `menu-item' property on the string that gives
10193 the start of this item's properties in the tool-bar items
10195 image
= Fcons (Qimage
, plist
);
10196 props
= list4 (Qdisplay
, image
,
10197 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10199 /* Let the last image hide all remaining spaces in the tool bar
10200 string. The string can be longer than needed when we reuse a
10201 previous string. */
10202 if (i
+ 1 == f
->n_tool_bar_items
)
10203 end
= SCHARS (f
->desired_tool_bar_string
);
10206 Fadd_text_properties (make_number (i
), make_number (end
),
10207 props
, f
->desired_tool_bar_string
);
10215 /* Display one line of the tool-bar of frame IT->f.
10217 HEIGHT specifies the desired height of the tool-bar line.
10218 If the actual height of the glyph row is less than HEIGHT, the
10219 row's height is increased to HEIGHT, and the icons are centered
10220 vertically in the new height.
10222 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10223 count a final empty row in case the tool-bar width exactly matches
10228 display_tool_bar_line (struct it
*it
, int height
)
10230 struct glyph_row
*row
= it
->glyph_row
;
10231 int max_x
= it
->last_visible_x
;
10232 struct glyph
*last
;
10234 prepare_desired_row (row
);
10235 row
->y
= it
->current_y
;
10237 /* Note that this isn't made use of if the face hasn't a box,
10238 so there's no need to check the face here. */
10239 it
->start_of_box_run_p
= 1;
10241 while (it
->current_x
< max_x
)
10243 int x
, n_glyphs_before
, i
, nglyphs
;
10244 struct it it_before
;
10246 /* Get the next display element. */
10247 if (!get_next_display_element (it
))
10249 /* Don't count empty row if we are counting needed tool-bar lines. */
10250 if (height
< 0 && !it
->hpos
)
10255 /* Produce glyphs. */
10256 n_glyphs_before
= row
->used
[TEXT_AREA
];
10259 PRODUCE_GLYPHS (it
);
10261 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10263 x
= it_before
.current_x
;
10264 while (i
< nglyphs
)
10266 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10268 if (x
+ glyph
->pixel_width
> max_x
)
10270 /* Glyph doesn't fit on line. Backtrack. */
10271 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10273 /* If this is the only glyph on this line, it will never fit on the
10274 tool-bar, so skip it. But ensure there is at least one glyph,
10275 so we don't accidentally disable the tool-bar. */
10276 if (n_glyphs_before
== 0
10277 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10283 x
+= glyph
->pixel_width
;
10287 /* Stop at line ends. */
10288 if (ITERATOR_AT_END_OF_LINE_P (it
))
10291 set_iterator_to_next (it
, 1);
10296 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10298 /* Use default face for the border below the tool bar.
10300 FIXME: When auto-resize-tool-bars is grow-only, there is
10301 no additional border below the possibly empty tool-bar lines.
10302 So to make the extra empty lines look "normal", we have to
10303 use the tool-bar face for the border too. */
10304 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10305 it
->face_id
= DEFAULT_FACE_ID
;
10307 extend_face_to_end_of_line (it
);
10308 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10309 last
->right_box_line_p
= 1;
10310 if (last
== row
->glyphs
[TEXT_AREA
])
10311 last
->left_box_line_p
= 1;
10313 /* Make line the desired height and center it vertically. */
10314 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10316 /* Don't add more than one line height. */
10317 height
%= FRAME_LINE_HEIGHT (it
->f
);
10318 it
->max_ascent
+= height
/ 2;
10319 it
->max_descent
+= (height
+ 1) / 2;
10322 compute_line_metrics (it
);
10324 /* If line is empty, make it occupy the rest of the tool-bar. */
10325 if (!row
->displays_text_p
)
10327 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10328 row
->visible_height
= row
->height
;
10329 row
->ascent
= row
->phys_ascent
= 0;
10330 row
->extra_line_spacing
= 0;
10333 row
->full_width_p
= 1;
10334 row
->continued_p
= 0;
10335 row
->truncated_on_left_p
= 0;
10336 row
->truncated_on_right_p
= 0;
10338 it
->current_x
= it
->hpos
= 0;
10339 it
->current_y
+= row
->height
;
10345 /* Max tool-bar height. */
10347 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10348 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10350 /* Value is the number of screen lines needed to make all tool-bar
10351 items of frame F visible. The number of actual rows needed is
10352 returned in *N_ROWS if non-NULL. */
10355 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10357 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10359 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10360 the desired matrix, so use (unused) mode-line row as temporary row to
10361 avoid destroying the first tool-bar row. */
10362 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10364 /* Initialize an iterator for iteration over
10365 F->desired_tool_bar_string in the tool-bar window of frame F. */
10366 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10367 it
.first_visible_x
= 0;
10368 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10369 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10371 while (!ITERATOR_AT_END_P (&it
))
10373 clear_glyph_row (temp_row
);
10374 it
.glyph_row
= temp_row
;
10375 display_tool_bar_line (&it
, -1);
10377 clear_glyph_row (temp_row
);
10379 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10381 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10383 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10387 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10389 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10390 (Lisp_Object frame
)
10397 frame
= selected_frame
;
10399 CHECK_FRAME (frame
);
10400 f
= XFRAME (frame
);
10402 if (WINDOWP (f
->tool_bar_window
)
10403 || (w
= XWINDOW (f
->tool_bar_window
),
10404 WINDOW_TOTAL_LINES (w
) > 0))
10406 update_tool_bar (f
, 1);
10407 if (f
->n_tool_bar_items
)
10409 build_desired_tool_bar_string (f
);
10410 nlines
= tool_bar_lines_needed (f
, NULL
);
10414 return make_number (nlines
);
10418 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10419 height should be changed. */
10422 redisplay_tool_bar (struct frame
*f
)
10426 struct glyph_row
*row
;
10428 #if defined (USE_GTK) || defined (HAVE_NS)
10429 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10430 update_frame_tool_bar (f
);
10434 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10435 do anything. This means you must start with tool-bar-lines
10436 non-zero to get the auto-sizing effect. Or in other words, you
10437 can turn off tool-bars by specifying tool-bar-lines zero. */
10438 if (!WINDOWP (f
->tool_bar_window
)
10439 || (w
= XWINDOW (f
->tool_bar_window
),
10440 WINDOW_TOTAL_LINES (w
) == 0))
10443 /* Set up an iterator for the tool-bar window. */
10444 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10445 it
.first_visible_x
= 0;
10446 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10447 row
= it
.glyph_row
;
10449 /* Build a string that represents the contents of the tool-bar. */
10450 build_desired_tool_bar_string (f
);
10451 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10453 if (f
->n_tool_bar_rows
== 0)
10457 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10458 nlines
!= WINDOW_TOTAL_LINES (w
)))
10461 int old_height
= WINDOW_TOTAL_LINES (w
);
10463 XSETFRAME (frame
, f
);
10464 Fmodify_frame_parameters (frame
,
10465 Fcons (Fcons (Qtool_bar_lines
,
10466 make_number (nlines
)),
10468 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10470 clear_glyph_matrix (w
->desired_matrix
);
10471 fonts_changed_p
= 1;
10477 /* Display as many lines as needed to display all tool-bar items. */
10479 if (f
->n_tool_bar_rows
> 0)
10481 int border
, rows
, height
, extra
;
10483 if (INTEGERP (Vtool_bar_border
))
10484 border
= XINT (Vtool_bar_border
);
10485 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10486 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10487 else if (EQ (Vtool_bar_border
, Qborder_width
))
10488 border
= f
->border_width
;
10494 rows
= f
->n_tool_bar_rows
;
10495 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10496 extra
= it
.last_visible_y
- border
- height
* rows
;
10498 while (it
.current_y
< it
.last_visible_y
)
10501 if (extra
> 0 && rows
-- > 0)
10503 h
= (extra
+ rows
- 1) / rows
;
10506 display_tool_bar_line (&it
, height
+ h
);
10511 while (it
.current_y
< it
.last_visible_y
)
10512 display_tool_bar_line (&it
, 0);
10515 /* It doesn't make much sense to try scrolling in the tool-bar
10516 window, so don't do it. */
10517 w
->desired_matrix
->no_scrolling_p
= 1;
10518 w
->must_be_updated_p
= 1;
10520 if (!NILP (Vauto_resize_tool_bars
))
10522 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10523 int change_height_p
= 0;
10525 /* If we couldn't display everything, change the tool-bar's
10526 height if there is room for more. */
10527 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10528 && it
.current_y
< max_tool_bar_height
)
10529 change_height_p
= 1;
10531 row
= it
.glyph_row
- 1;
10533 /* If there are blank lines at the end, except for a partially
10534 visible blank line at the end that is smaller than
10535 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10536 if (!row
->displays_text_p
10537 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10538 change_height_p
= 1;
10540 /* If row displays tool-bar items, but is partially visible,
10541 change the tool-bar's height. */
10542 if (row
->displays_text_p
10543 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10544 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10545 change_height_p
= 1;
10547 /* Resize windows as needed by changing the `tool-bar-lines'
10548 frame parameter. */
10549 if (change_height_p
)
10552 int old_height
= WINDOW_TOTAL_LINES (w
);
10554 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10556 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10557 && !f
->minimize_tool_bar_window_p
)
10558 ? (nlines
> old_height
)
10559 : (nlines
!= old_height
));
10560 f
->minimize_tool_bar_window_p
= 0;
10562 if (change_height_p
)
10564 XSETFRAME (frame
, f
);
10565 Fmodify_frame_parameters (frame
,
10566 Fcons (Fcons (Qtool_bar_lines
,
10567 make_number (nlines
)),
10569 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10571 clear_glyph_matrix (w
->desired_matrix
);
10572 f
->n_tool_bar_rows
= nrows
;
10573 fonts_changed_p
= 1;
10580 f
->minimize_tool_bar_window_p
= 0;
10585 /* Get information about the tool-bar item which is displayed in GLYPH
10586 on frame F. Return in *PROP_IDX the index where tool-bar item
10587 properties start in F->tool_bar_items. Value is zero if
10588 GLYPH doesn't display a tool-bar item. */
10591 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10597 /* This function can be called asynchronously, which means we must
10598 exclude any possibility that Fget_text_property signals an
10600 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10601 charpos
= max (0, charpos
);
10603 /* Get the text property `menu-item' at pos. The value of that
10604 property is the start index of this item's properties in
10605 F->tool_bar_items. */
10606 prop
= Fget_text_property (make_number (charpos
),
10607 Qmenu_item
, f
->current_tool_bar_string
);
10608 if (INTEGERP (prop
))
10610 *prop_idx
= XINT (prop
);
10620 /* Get information about the tool-bar item at position X/Y on frame F.
10621 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10622 the current matrix of the tool-bar window of F, or NULL if not
10623 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10624 item in F->tool_bar_items. Value is
10626 -1 if X/Y is not on a tool-bar item
10627 0 if X/Y is on the same item that was highlighted before.
10631 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10632 int *hpos
, int *vpos
, int *prop_idx
)
10634 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10635 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10638 /* Find the glyph under X/Y. */
10639 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10640 if (*glyph
== NULL
)
10643 /* Get the start of this tool-bar item's properties in
10644 f->tool_bar_items. */
10645 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10648 /* Is mouse on the highlighted item? */
10649 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10650 && *vpos
>= hlinfo
->mouse_face_beg_row
10651 && *vpos
<= hlinfo
->mouse_face_end_row
10652 && (*vpos
> hlinfo
->mouse_face_beg_row
10653 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10654 && (*vpos
< hlinfo
->mouse_face_end_row
10655 || *hpos
< hlinfo
->mouse_face_end_col
10656 || hlinfo
->mouse_face_past_end
))
10664 Handle mouse button event on the tool-bar of frame F, at
10665 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10666 0 for button release. MODIFIERS is event modifiers for button
10670 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10671 unsigned int modifiers
)
10673 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10674 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10675 int hpos
, vpos
, prop_idx
;
10676 struct glyph
*glyph
;
10677 Lisp_Object enabled_p
;
10679 /* If not on the highlighted tool-bar item, return. */
10680 frame_to_window_pixel_xy (w
, &x
, &y
);
10681 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10684 /* If item is disabled, do nothing. */
10685 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10686 if (NILP (enabled_p
))
10691 /* Show item in pressed state. */
10692 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10693 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10694 last_tool_bar_item
= prop_idx
;
10698 Lisp_Object key
, frame
;
10699 struct input_event event
;
10700 EVENT_INIT (event
);
10702 /* Show item in released state. */
10703 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10704 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10706 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10708 XSETFRAME (frame
, f
);
10709 event
.kind
= TOOL_BAR_EVENT
;
10710 event
.frame_or_window
= frame
;
10712 kbd_buffer_store_event (&event
);
10714 event
.kind
= TOOL_BAR_EVENT
;
10715 event
.frame_or_window
= frame
;
10717 event
.modifiers
= modifiers
;
10718 kbd_buffer_store_event (&event
);
10719 last_tool_bar_item
= -1;
10724 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10725 tool-bar window-relative coordinates X/Y. Called from
10726 note_mouse_highlight. */
10729 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10731 Lisp_Object window
= f
->tool_bar_window
;
10732 struct window
*w
= XWINDOW (window
);
10733 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10734 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10736 struct glyph
*glyph
;
10737 struct glyph_row
*row
;
10739 Lisp_Object enabled_p
;
10741 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10742 int mouse_down_p
, rc
;
10744 /* Function note_mouse_highlight is called with negative X/Y
10745 values when mouse moves outside of the frame. */
10746 if (x
<= 0 || y
<= 0)
10748 clear_mouse_face (hlinfo
);
10752 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10755 /* Not on tool-bar item. */
10756 clear_mouse_face (hlinfo
);
10760 /* On same tool-bar item as before. */
10761 goto set_help_echo
;
10763 clear_mouse_face (hlinfo
);
10765 /* Mouse is down, but on different tool-bar item? */
10766 mouse_down_p
= (dpyinfo
->grabbed
10767 && f
== last_mouse_frame
10768 && FRAME_LIVE_P (f
));
10770 && last_tool_bar_item
!= prop_idx
)
10773 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10774 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10776 /* If tool-bar item is not enabled, don't highlight it. */
10777 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10778 if (!NILP (enabled_p
))
10780 /* Compute the x-position of the glyph. In front and past the
10781 image is a space. We include this in the highlighted area. */
10782 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10783 for (i
= x
= 0; i
< hpos
; ++i
)
10784 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10786 /* Record this as the current active region. */
10787 hlinfo
->mouse_face_beg_col
= hpos
;
10788 hlinfo
->mouse_face_beg_row
= vpos
;
10789 hlinfo
->mouse_face_beg_x
= x
;
10790 hlinfo
->mouse_face_beg_y
= row
->y
;
10791 hlinfo
->mouse_face_past_end
= 0;
10793 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10794 hlinfo
->mouse_face_end_row
= vpos
;
10795 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10796 hlinfo
->mouse_face_end_y
= row
->y
;
10797 hlinfo
->mouse_face_window
= window
;
10798 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10800 /* Display it as active. */
10801 show_mouse_face (hlinfo
, draw
);
10802 hlinfo
->mouse_face_image_state
= draw
;
10807 /* Set help_echo_string to a help string to display for this tool-bar item.
10808 XTread_socket does the rest. */
10809 help_echo_object
= help_echo_window
= Qnil
;
10810 help_echo_pos
= -1;
10811 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10812 if (NILP (help_echo_string
))
10813 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10816 #endif /* HAVE_WINDOW_SYSTEM */
10820 /************************************************************************
10821 Horizontal scrolling
10822 ************************************************************************/
10824 static int hscroll_window_tree (Lisp_Object
);
10825 static int hscroll_windows (Lisp_Object
);
10827 /* For all leaf windows in the window tree rooted at WINDOW, set their
10828 hscroll value so that PT is (i) visible in the window, and (ii) so
10829 that it is not within a certain margin at the window's left and
10830 right border. Value is non-zero if any window's hscroll has been
10834 hscroll_window_tree (Lisp_Object window
)
10836 int hscrolled_p
= 0;
10837 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10838 int hscroll_step_abs
= 0;
10839 double hscroll_step_rel
= 0;
10841 if (hscroll_relative_p
)
10843 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10844 if (hscroll_step_rel
< 0)
10846 hscroll_relative_p
= 0;
10847 hscroll_step_abs
= 0;
10850 else if (INTEGERP (Vhscroll_step
))
10852 hscroll_step_abs
= XINT (Vhscroll_step
);
10853 if (hscroll_step_abs
< 0)
10854 hscroll_step_abs
= 0;
10857 hscroll_step_abs
= 0;
10859 while (WINDOWP (window
))
10861 struct window
*w
= XWINDOW (window
);
10863 if (WINDOWP (w
->hchild
))
10864 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10865 else if (WINDOWP (w
->vchild
))
10866 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10867 else if (w
->cursor
.vpos
>= 0)
10870 int text_area_width
;
10871 struct glyph_row
*current_cursor_row
10872 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10873 struct glyph_row
*desired_cursor_row
10874 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10875 struct glyph_row
*cursor_row
10876 = (desired_cursor_row
->enabled_p
10877 ? desired_cursor_row
10878 : current_cursor_row
);
10880 text_area_width
= window_box_width (w
, TEXT_AREA
);
10882 /* Scroll when cursor is inside this scroll margin. */
10883 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10885 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10886 && ((XFASTINT (w
->hscroll
)
10887 && w
->cursor
.x
<= h_margin
)
10888 || (cursor_row
->enabled_p
10889 && cursor_row
->truncated_on_right_p
10890 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10894 struct buffer
*saved_current_buffer
;
10898 /* Find point in a display of infinite width. */
10899 saved_current_buffer
= current_buffer
;
10900 current_buffer
= XBUFFER (w
->buffer
);
10902 if (w
== XWINDOW (selected_window
))
10906 pt
= marker_position (w
->pointm
);
10907 pt
= max (BEGV
, pt
);
10911 /* Move iterator to pt starting at cursor_row->start in
10912 a line with infinite width. */
10913 init_to_row_start (&it
, w
, cursor_row
);
10914 it
.last_visible_x
= INFINITY
;
10915 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10916 current_buffer
= saved_current_buffer
;
10918 /* Position cursor in window. */
10919 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10920 hscroll
= max (0, (it
.current_x
10921 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10922 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10923 : (text_area_width
/ 2))))
10924 / FRAME_COLUMN_WIDTH (it
.f
);
10925 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10927 if (hscroll_relative_p
)
10928 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10931 wanted_x
= text_area_width
10932 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10935 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10939 if (hscroll_relative_p
)
10940 wanted_x
= text_area_width
* hscroll_step_rel
10943 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10946 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10948 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10950 /* Don't call Fset_window_hscroll if value hasn't
10951 changed because it will prevent redisplay
10953 if (XFASTINT (w
->hscroll
) != hscroll
)
10955 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10956 w
->hscroll
= make_number (hscroll
);
10965 /* Value is non-zero if hscroll of any leaf window has been changed. */
10966 return hscrolled_p
;
10970 /* Set hscroll so that cursor is visible and not inside horizontal
10971 scroll margins for all windows in the tree rooted at WINDOW. See
10972 also hscroll_window_tree above. Value is non-zero if any window's
10973 hscroll has been changed. If it has, desired matrices on the frame
10974 of WINDOW are cleared. */
10977 hscroll_windows (Lisp_Object window
)
10979 int hscrolled_p
= hscroll_window_tree (window
);
10981 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10982 return hscrolled_p
;
10987 /************************************************************************
10989 ************************************************************************/
10991 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10992 to a non-zero value. This is sometimes handy to have in a debugger
10997 /* First and last unchanged row for try_window_id. */
10999 int debug_first_unchanged_at_end_vpos
;
11000 int debug_last_unchanged_at_beg_vpos
;
11002 /* Delta vpos and y. */
11004 int debug_dvpos
, debug_dy
;
11006 /* Delta in characters and bytes for try_window_id. */
11008 EMACS_INT debug_delta
, debug_delta_bytes
;
11010 /* Values of window_end_pos and window_end_vpos at the end of
11013 EMACS_INT debug_end_vpos
;
11015 /* Append a string to W->desired_matrix->method. FMT is a printf
11016 format string. A1...A9 are a supplement for a variable-length
11017 argument list. If trace_redisplay_p is non-zero also printf the
11018 resulting string to stderr. */
11021 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11024 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11027 char *method
= w
->desired_matrix
->method
;
11028 int len
= strlen (method
);
11029 int size
= sizeof w
->desired_matrix
->method
;
11030 int remaining
= size
- len
- 1;
11032 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11033 if (len
&& remaining
)
11036 --remaining
, ++len
;
11039 strncpy (method
+ len
, buffer
, remaining
);
11041 if (trace_redisplay_p
)
11042 fprintf (stderr
, "%p (%s): %s\n",
11044 ((BUFFERP (w
->buffer
)
11045 && STRINGP (XBUFFER (w
->buffer
)->name
))
11046 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11051 #endif /* GLYPH_DEBUG */
11054 /* Value is non-zero if all changes in window W, which displays
11055 current_buffer, are in the text between START and END. START is a
11056 buffer position, END is given as a distance from Z. Used in
11057 redisplay_internal for display optimization. */
11060 text_outside_line_unchanged_p (struct window
*w
,
11061 EMACS_INT start
, EMACS_INT end
)
11063 int unchanged_p
= 1;
11065 /* If text or overlays have changed, see where. */
11066 if (XFASTINT (w
->last_modified
) < MODIFF
11067 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11069 /* Gap in the line? */
11070 if (GPT
< start
|| Z
- GPT
< end
)
11073 /* Changes start in front of the line, or end after it? */
11075 && (BEG_UNCHANGED
< start
- 1
11076 || END_UNCHANGED
< end
))
11079 /* If selective display, can't optimize if changes start at the
11080 beginning of the line. */
11082 && INTEGERP (BVAR (current_buffer
, selective_display
))
11083 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11084 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11087 /* If there are overlays at the start or end of the line, these
11088 may have overlay strings with newlines in them. A change at
11089 START, for instance, may actually concern the display of such
11090 overlay strings as well, and they are displayed on different
11091 lines. So, quickly rule out this case. (For the future, it
11092 might be desirable to implement something more telling than
11093 just BEG/END_UNCHANGED.) */
11096 if (BEG
+ BEG_UNCHANGED
== start
11097 && overlay_touches_p (start
))
11099 if (END_UNCHANGED
== end
11100 && overlay_touches_p (Z
- end
))
11104 /* Under bidi reordering, adding or deleting a character in the
11105 beginning of a paragraph, before the first strong directional
11106 character, can change the base direction of the paragraph (unless
11107 the buffer specifies a fixed paragraph direction), which will
11108 require to redisplay the whole paragraph. It might be worthwhile
11109 to find the paragraph limits and widen the range of redisplayed
11110 lines to that, but for now just give up this optimization. */
11111 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11112 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11116 return unchanged_p
;
11120 /* Do a frame update, taking possible shortcuts into account. This is
11121 the main external entry point for redisplay.
11123 If the last redisplay displayed an echo area message and that message
11124 is no longer requested, we clear the echo area or bring back the
11125 mini-buffer if that is in use. */
11130 redisplay_internal ();
11135 overlay_arrow_string_or_property (Lisp_Object var
)
11139 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11142 return Voverlay_arrow_string
;
11145 /* Return 1 if there are any overlay-arrows in current_buffer. */
11147 overlay_arrow_in_current_buffer_p (void)
11151 for (vlist
= Voverlay_arrow_variable_list
;
11153 vlist
= XCDR (vlist
))
11155 Lisp_Object var
= XCAR (vlist
);
11158 if (!SYMBOLP (var
))
11160 val
= find_symbol_value (var
);
11162 && current_buffer
== XMARKER (val
)->buffer
)
11169 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11173 overlay_arrows_changed_p (void)
11177 for (vlist
= Voverlay_arrow_variable_list
;
11179 vlist
= XCDR (vlist
))
11181 Lisp_Object var
= XCAR (vlist
);
11182 Lisp_Object val
, pstr
;
11184 if (!SYMBOLP (var
))
11186 val
= find_symbol_value (var
);
11187 if (!MARKERP (val
))
11189 if (! EQ (COERCE_MARKER (val
),
11190 Fget (var
, Qlast_arrow_position
))
11191 || ! (pstr
= overlay_arrow_string_or_property (var
),
11192 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11198 /* Mark overlay arrows to be updated on next redisplay. */
11201 update_overlay_arrows (int up_to_date
)
11205 for (vlist
= Voverlay_arrow_variable_list
;
11207 vlist
= XCDR (vlist
))
11209 Lisp_Object var
= XCAR (vlist
);
11211 if (!SYMBOLP (var
))
11214 if (up_to_date
> 0)
11216 Lisp_Object val
= find_symbol_value (var
);
11217 Fput (var
, Qlast_arrow_position
,
11218 COERCE_MARKER (val
));
11219 Fput (var
, Qlast_arrow_string
,
11220 overlay_arrow_string_or_property (var
));
11222 else if (up_to_date
< 0
11223 || !NILP (Fget (var
, Qlast_arrow_position
)))
11225 Fput (var
, Qlast_arrow_position
, Qt
);
11226 Fput (var
, Qlast_arrow_string
, Qt
);
11232 /* Return overlay arrow string to display at row.
11233 Return integer (bitmap number) for arrow bitmap in left fringe.
11234 Return nil if no overlay arrow. */
11237 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11241 for (vlist
= Voverlay_arrow_variable_list
;
11243 vlist
= XCDR (vlist
))
11245 Lisp_Object var
= XCAR (vlist
);
11248 if (!SYMBOLP (var
))
11251 val
= find_symbol_value (var
);
11254 && current_buffer
== XMARKER (val
)->buffer
11255 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11257 if (FRAME_WINDOW_P (it
->f
)
11258 /* FIXME: if ROW->reversed_p is set, this should test
11259 the right fringe, not the left one. */
11260 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11262 #ifdef HAVE_WINDOW_SYSTEM
11263 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11266 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11267 return make_number (fringe_bitmap
);
11270 return make_number (-1); /* Use default arrow bitmap */
11272 return overlay_arrow_string_or_property (var
);
11279 /* Return 1 if point moved out of or into a composition. Otherwise
11280 return 0. PREV_BUF and PREV_PT are the last point buffer and
11281 position. BUF and PT are the current point buffer and position. */
11284 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11285 struct buffer
*buf
, EMACS_INT pt
)
11287 EMACS_INT start
, end
;
11289 Lisp_Object buffer
;
11291 XSETBUFFER (buffer
, buf
);
11292 /* Check a composition at the last point if point moved within the
11294 if (prev_buf
== buf
)
11297 /* Point didn't move. */
11300 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11301 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11302 && COMPOSITION_VALID_P (start
, end
, prop
)
11303 && start
< prev_pt
&& end
> prev_pt
)
11304 /* The last point was within the composition. Return 1 iff
11305 point moved out of the composition. */
11306 return (pt
<= start
|| pt
>= end
);
11309 /* Check a composition at the current point. */
11310 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11311 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11312 && COMPOSITION_VALID_P (start
, end
, prop
)
11313 && start
< pt
&& end
> pt
);
11317 /* Reconsider the setting of B->clip_changed which is displayed
11321 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11323 if (b
->clip_changed
11324 && !NILP (w
->window_end_valid
)
11325 && w
->current_matrix
->buffer
== b
11326 && w
->current_matrix
->zv
== BUF_ZV (b
)
11327 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11328 b
->clip_changed
= 0;
11330 /* If display wasn't paused, and W is not a tool bar window, see if
11331 point has been moved into or out of a composition. In that case,
11332 we set b->clip_changed to 1 to force updating the screen. If
11333 b->clip_changed has already been set to 1, we can skip this
11335 if (!b
->clip_changed
11336 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11340 if (w
== XWINDOW (selected_window
))
11343 pt
= marker_position (w
->pointm
);
11345 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11346 || pt
!= XINT (w
->last_point
))
11347 && check_point_in_composition (w
->current_matrix
->buffer
,
11348 XINT (w
->last_point
),
11349 XBUFFER (w
->buffer
), pt
))
11350 b
->clip_changed
= 1;
11355 /* Select FRAME to forward the values of frame-local variables into C
11356 variables so that the redisplay routines can access those values
11360 select_frame_for_redisplay (Lisp_Object frame
)
11362 Lisp_Object tail
, tem
;
11363 Lisp_Object old
= selected_frame
;
11364 struct Lisp_Symbol
*sym
;
11366 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11368 selected_frame
= frame
;
11371 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11372 if (CONSP (XCAR (tail
))
11373 && (tem
= XCAR (XCAR (tail
)),
11375 && (sym
= indirect_variable (XSYMBOL (tem
)),
11376 sym
->redirect
== SYMBOL_LOCALIZED
)
11377 && sym
->val
.blv
->frame_local
)
11378 /* Use find_symbol_value rather than Fsymbol_value
11379 to avoid an error if it is void. */
11380 find_symbol_value (tem
);
11381 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11385 #define STOP_POLLING \
11386 do { if (! polling_stopped_here) stop_polling (); \
11387 polling_stopped_here = 1; } while (0)
11389 #define RESUME_POLLING \
11390 do { if (polling_stopped_here) start_polling (); \
11391 polling_stopped_here = 0; } while (0)
11394 /* Perhaps in the future avoid recentering windows if it
11395 is not necessary; currently that causes some problems. */
11398 redisplay_internal (void)
11400 struct window
*w
= XWINDOW (selected_window
);
11404 int must_finish
= 0;
11405 struct text_pos tlbufpos
, tlendpos
;
11406 int number_of_visible_frames
;
11409 int polling_stopped_here
= 0;
11410 Lisp_Object old_frame
= selected_frame
;
11412 /* Non-zero means redisplay has to consider all windows on all
11413 frames. Zero means, only selected_window is considered. */
11414 int consider_all_windows_p
;
11416 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11418 /* No redisplay if running in batch mode or frame is not yet fully
11419 initialized, or redisplay is explicitly turned off by setting
11420 Vinhibit_redisplay. */
11421 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11422 || !NILP (Vinhibit_redisplay
))
11425 /* Don't examine these until after testing Vinhibit_redisplay.
11426 When Emacs is shutting down, perhaps because its connection to
11427 X has dropped, we should not look at them at all. */
11428 fr
= XFRAME (w
->frame
);
11429 sf
= SELECTED_FRAME ();
11431 if (!fr
->glyphs_initialized_p
)
11434 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11435 if (popup_activated ())
11439 /* I don't think this happens but let's be paranoid. */
11440 if (redisplaying_p
)
11443 /* Record a function that resets redisplaying_p to its old value
11444 when we leave this function. */
11445 count
= SPECPDL_INDEX ();
11446 record_unwind_protect (unwind_redisplay
,
11447 Fcons (make_number (redisplaying_p
), selected_frame
));
11449 specbind (Qinhibit_free_realized_faces
, Qnil
);
11452 Lisp_Object tail
, frame
;
11454 FOR_EACH_FRAME (tail
, frame
)
11456 struct frame
*f
= XFRAME (frame
);
11457 f
->already_hscrolled_p
= 0;
11462 /* Remember the currently selected window. */
11465 if (!EQ (old_frame
, selected_frame
)
11466 && FRAME_LIVE_P (XFRAME (old_frame
)))
11467 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11468 selected_frame and selected_window to be temporarily out-of-sync so
11469 when we come back here via `goto retry', we need to resync because we
11470 may need to run Elisp code (via prepare_menu_bars). */
11471 select_frame_for_redisplay (old_frame
);
11474 reconsider_clip_changes (w
, current_buffer
);
11475 last_escape_glyph_frame
= NULL
;
11476 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11477 last_glyphless_glyph_frame
= NULL
;
11478 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11480 /* If new fonts have been loaded that make a glyph matrix adjustment
11481 necessary, do it. */
11482 if (fonts_changed_p
)
11484 adjust_glyphs (NULL
);
11485 ++windows_or_buffers_changed
;
11486 fonts_changed_p
= 0;
11489 /* If face_change_count is non-zero, init_iterator will free all
11490 realized faces, which includes the faces referenced from current
11491 matrices. So, we can't reuse current matrices in this case. */
11492 if (face_change_count
)
11493 ++windows_or_buffers_changed
;
11495 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11496 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11498 /* Since frames on a single ASCII terminal share the same
11499 display area, displaying a different frame means redisplay
11500 the whole thing. */
11501 windows_or_buffers_changed
++;
11502 SET_FRAME_GARBAGED (sf
);
11504 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11506 FRAME_TTY (sf
)->previous_frame
= sf
;
11509 /* Set the visible flags for all frames. Do this before checking
11510 for resized or garbaged frames; they want to know if their frames
11511 are visible. See the comment in frame.h for
11512 FRAME_SAMPLE_VISIBILITY. */
11514 Lisp_Object tail
, frame
;
11516 number_of_visible_frames
= 0;
11518 FOR_EACH_FRAME (tail
, frame
)
11520 struct frame
*f
= XFRAME (frame
);
11522 FRAME_SAMPLE_VISIBILITY (f
);
11523 if (FRAME_VISIBLE_P (f
))
11524 ++number_of_visible_frames
;
11525 clear_desired_matrices (f
);
11529 /* Notice any pending interrupt request to change frame size. */
11530 do_pending_window_change (1);
11532 /* do_pending_window_change could change the selected_window due to
11533 frame resizing which makes the selected window too small. */
11534 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11537 reconsider_clip_changes (w
, current_buffer
);
11540 /* Clear frames marked as garbaged. */
11541 if (frame_garbaged
)
11542 clear_garbaged_frames ();
11544 /* Build menubar and tool-bar items. */
11545 if (NILP (Vmemory_full
))
11546 prepare_menu_bars ();
11548 if (windows_or_buffers_changed
)
11549 update_mode_lines
++;
11551 /* Detect case that we need to write or remove a star in the mode line. */
11552 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11554 w
->update_mode_line
= Qt
;
11555 if (buffer_shared
> 1)
11556 update_mode_lines
++;
11559 /* Avoid invocation of point motion hooks by `current_column' below. */
11560 count1
= SPECPDL_INDEX ();
11561 specbind (Qinhibit_point_motion_hooks
, Qt
);
11563 /* If %c is in the mode line, update it if needed. */
11564 if (!NILP (w
->column_number_displayed
)
11565 /* This alternative quickly identifies a common case
11566 where no change is needed. */
11567 && !(PT
== XFASTINT (w
->last_point
)
11568 && XFASTINT (w
->last_modified
) >= MODIFF
11569 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11570 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11571 w
->update_mode_line
= Qt
;
11573 unbind_to (count1
, Qnil
);
11575 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11577 /* The variable buffer_shared is set in redisplay_window and
11578 indicates that we redisplay a buffer in different windows. See
11580 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11581 || cursor_type_changed
);
11583 /* If specs for an arrow have changed, do thorough redisplay
11584 to ensure we remove any arrow that should no longer exist. */
11585 if (overlay_arrows_changed_p ())
11586 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11588 /* Normally the message* functions will have already displayed and
11589 updated the echo area, but the frame may have been trashed, or
11590 the update may have been preempted, so display the echo area
11591 again here. Checking message_cleared_p captures the case that
11592 the echo area should be cleared. */
11593 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11594 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11595 || (message_cleared_p
11596 && minibuf_level
== 0
11597 /* If the mini-window is currently selected, this means the
11598 echo-area doesn't show through. */
11599 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11601 int window_height_changed_p
= echo_area_display (0);
11604 /* If we don't display the current message, don't clear the
11605 message_cleared_p flag, because, if we did, we wouldn't clear
11606 the echo area in the next redisplay which doesn't preserve
11608 if (!display_last_displayed_message_p
)
11609 message_cleared_p
= 0;
11611 if (fonts_changed_p
)
11613 else if (window_height_changed_p
)
11615 consider_all_windows_p
= 1;
11616 ++update_mode_lines
;
11617 ++windows_or_buffers_changed
;
11619 /* If window configuration was changed, frames may have been
11620 marked garbaged. Clear them or we will experience
11621 surprises wrt scrolling. */
11622 if (frame_garbaged
)
11623 clear_garbaged_frames ();
11626 else if (EQ (selected_window
, minibuf_window
)
11627 && (current_buffer
->clip_changed
11628 || XFASTINT (w
->last_modified
) < MODIFF
11629 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11630 && resize_mini_window (w
, 0))
11632 /* Resized active mini-window to fit the size of what it is
11633 showing if its contents might have changed. */
11635 /* FIXME: this causes all frames to be updated, which seems unnecessary
11636 since only the current frame needs to be considered. This function needs
11637 to be rewritten with two variables, consider_all_windows and
11638 consider_all_frames. */
11639 consider_all_windows_p
= 1;
11640 ++windows_or_buffers_changed
;
11641 ++update_mode_lines
;
11643 /* If window configuration was changed, frames may have been
11644 marked garbaged. Clear them or we will experience
11645 surprises wrt scrolling. */
11646 if (frame_garbaged
)
11647 clear_garbaged_frames ();
11651 /* If showing the region, and mark has changed, we must redisplay
11652 the whole window. The assignment to this_line_start_pos prevents
11653 the optimization directly below this if-statement. */
11654 if (((!NILP (Vtransient_mark_mode
)
11655 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11656 != !NILP (w
->region_showing
))
11657 || (!NILP (w
->region_showing
)
11658 && !EQ (w
->region_showing
,
11659 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11660 CHARPOS (this_line_start_pos
) = 0;
11662 /* Optimize the case that only the line containing the cursor in the
11663 selected window has changed. Variables starting with this_ are
11664 set in display_line and record information about the line
11665 containing the cursor. */
11666 tlbufpos
= this_line_start_pos
;
11667 tlendpos
= this_line_end_pos
;
11668 if (!consider_all_windows_p
11669 && CHARPOS (tlbufpos
) > 0
11670 && NILP (w
->update_mode_line
)
11671 && !current_buffer
->clip_changed
11672 && !current_buffer
->prevent_redisplay_optimizations_p
11673 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11674 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11675 /* Make sure recorded data applies to current buffer, etc. */
11676 && this_line_buffer
== current_buffer
11677 && current_buffer
== XBUFFER (w
->buffer
)
11678 && NILP (w
->force_start
)
11679 && NILP (w
->optional_new_start
)
11680 /* Point must be on the line that we have info recorded about. */
11681 && PT
>= CHARPOS (tlbufpos
)
11682 && PT
<= Z
- CHARPOS (tlendpos
)
11683 /* All text outside that line, including its final newline,
11684 must be unchanged. */
11685 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11686 CHARPOS (tlendpos
)))
11688 if (CHARPOS (tlbufpos
) > BEGV
11689 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11690 && (CHARPOS (tlbufpos
) == ZV
11691 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11692 /* Former continuation line has disappeared by becoming empty. */
11694 else if (XFASTINT (w
->last_modified
) < MODIFF
11695 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11696 || MINI_WINDOW_P (w
))
11698 /* We have to handle the case of continuation around a
11699 wide-column character (see the comment in indent.c around
11702 For instance, in the following case:
11704 -------- Insert --------
11705 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11706 J_I_ ==> J_I_ `^^' are cursors.
11710 As we have to redraw the line above, we cannot use this
11714 int line_height_before
= this_line_pixel_height
;
11716 /* Note that start_display will handle the case that the
11717 line starting at tlbufpos is a continuation line. */
11718 start_display (&it
, w
, tlbufpos
);
11720 /* Implementation note: It this still necessary? */
11721 if (it
.current_x
!= this_line_start_x
)
11724 TRACE ((stderr
, "trying display optimization 1\n"));
11725 w
->cursor
.vpos
= -1;
11726 overlay_arrow_seen
= 0;
11727 it
.vpos
= this_line_vpos
;
11728 it
.current_y
= this_line_y
;
11729 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11730 display_line (&it
);
11732 /* If line contains point, is not continued,
11733 and ends at same distance from eob as before, we win. */
11734 if (w
->cursor
.vpos
>= 0
11735 /* Line is not continued, otherwise this_line_start_pos
11736 would have been set to 0 in display_line. */
11737 && CHARPOS (this_line_start_pos
)
11738 /* Line ends as before. */
11739 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11740 /* Line has same height as before. Otherwise other lines
11741 would have to be shifted up or down. */
11742 && this_line_pixel_height
== line_height_before
)
11744 /* If this is not the window's last line, we must adjust
11745 the charstarts of the lines below. */
11746 if (it
.current_y
< it
.last_visible_y
)
11748 struct glyph_row
*row
11749 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11750 EMACS_INT delta
, delta_bytes
;
11752 /* We used to distinguish between two cases here,
11753 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11754 when the line ends in a newline or the end of the
11755 buffer's accessible portion. But both cases did
11756 the same, so they were collapsed. */
11758 - CHARPOS (tlendpos
)
11759 - MATRIX_ROW_START_CHARPOS (row
));
11760 delta_bytes
= (Z_BYTE
11761 - BYTEPOS (tlendpos
)
11762 - MATRIX_ROW_START_BYTEPOS (row
));
11764 increment_matrix_positions (w
->current_matrix
,
11765 this_line_vpos
+ 1,
11766 w
->current_matrix
->nrows
,
11767 delta
, delta_bytes
);
11770 /* If this row displays text now but previously didn't,
11771 or vice versa, w->window_end_vpos may have to be
11773 if ((it
.glyph_row
- 1)->displays_text_p
)
11775 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11776 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11778 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11779 && this_line_vpos
> 0)
11780 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11781 w
->window_end_valid
= Qnil
;
11783 /* Update hint: No need to try to scroll in update_window. */
11784 w
->desired_matrix
->no_scrolling_p
= 1;
11787 *w
->desired_matrix
->method
= 0;
11788 debug_method_add (w
, "optimization 1");
11790 #ifdef HAVE_WINDOW_SYSTEM
11791 update_window_fringes (w
, 0);
11798 else if (/* Cursor position hasn't changed. */
11799 PT
== XFASTINT (w
->last_point
)
11800 /* Make sure the cursor was last displayed
11801 in this window. Otherwise we have to reposition it. */
11802 && 0 <= w
->cursor
.vpos
11803 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11807 do_pending_window_change (1);
11808 /* If selected_window changed, redisplay again. */
11809 if (WINDOWP (selected_window
)
11810 && (w
= XWINDOW (selected_window
)) != sw
)
11813 /* We used to always goto end_of_redisplay here, but this
11814 isn't enough if we have a blinking cursor. */
11815 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11816 goto end_of_redisplay
;
11820 /* If highlighting the region, or if the cursor is in the echo area,
11821 then we can't just move the cursor. */
11822 else if (! (!NILP (Vtransient_mark_mode
)
11823 && !NILP (BVAR (current_buffer
, mark_active
)))
11824 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11825 || highlight_nonselected_windows
)
11826 && NILP (w
->region_showing
)
11827 && NILP (Vshow_trailing_whitespace
)
11828 && !cursor_in_echo_area
)
11831 struct glyph_row
*row
;
11833 /* Skip from tlbufpos to PT and see where it is. Note that
11834 PT may be in invisible text. If so, we will end at the
11835 next visible position. */
11836 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11837 NULL
, DEFAULT_FACE_ID
);
11838 it
.current_x
= this_line_start_x
;
11839 it
.current_y
= this_line_y
;
11840 it
.vpos
= this_line_vpos
;
11842 /* The call to move_it_to stops in front of PT, but
11843 moves over before-strings. */
11844 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11846 if (it
.vpos
== this_line_vpos
11847 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11850 xassert (this_line_vpos
== it
.vpos
);
11851 xassert (this_line_y
== it
.current_y
);
11852 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11854 *w
->desired_matrix
->method
= 0;
11855 debug_method_add (w
, "optimization 3");
11864 /* Text changed drastically or point moved off of line. */
11865 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11868 CHARPOS (this_line_start_pos
) = 0;
11869 consider_all_windows_p
|= buffer_shared
> 1;
11870 ++clear_face_cache_count
;
11871 #ifdef HAVE_WINDOW_SYSTEM
11872 ++clear_image_cache_count
;
11875 /* Build desired matrices, and update the display. If
11876 consider_all_windows_p is non-zero, do it for all windows on all
11877 frames. Otherwise do it for selected_window, only. */
11879 if (consider_all_windows_p
)
11881 Lisp_Object tail
, frame
;
11883 FOR_EACH_FRAME (tail
, frame
)
11884 XFRAME (frame
)->updated_p
= 0;
11886 /* Recompute # windows showing selected buffer. This will be
11887 incremented each time such a window is displayed. */
11890 FOR_EACH_FRAME (tail
, frame
)
11892 struct frame
*f
= XFRAME (frame
);
11894 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11896 if (! EQ (frame
, selected_frame
))
11897 /* Select the frame, for the sake of frame-local
11899 select_frame_for_redisplay (frame
);
11901 /* Mark all the scroll bars to be removed; we'll redeem
11902 the ones we want when we redisplay their windows. */
11903 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11904 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11906 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11907 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11909 /* The X error handler may have deleted that frame. */
11910 if (!FRAME_LIVE_P (f
))
11913 /* Any scroll bars which redisplay_windows should have
11914 nuked should now go away. */
11915 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11916 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11918 /* If fonts changed, display again. */
11919 /* ??? rms: I suspect it is a mistake to jump all the way
11920 back to retry here. It should just retry this frame. */
11921 if (fonts_changed_p
)
11924 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11926 /* See if we have to hscroll. */
11927 if (!f
->already_hscrolled_p
)
11929 f
->already_hscrolled_p
= 1;
11930 if (hscroll_windows (f
->root_window
))
11934 /* Prevent various kinds of signals during display
11935 update. stdio is not robust about handling
11936 signals, which can cause an apparent I/O
11938 if (interrupt_input
)
11939 unrequest_sigio ();
11942 /* Update the display. */
11943 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11944 pending
|= update_frame (f
, 0, 0);
11950 if (!EQ (old_frame
, selected_frame
)
11951 && FRAME_LIVE_P (XFRAME (old_frame
)))
11952 /* We played a bit fast-and-loose above and allowed selected_frame
11953 and selected_window to be temporarily out-of-sync but let's make
11954 sure this stays contained. */
11955 select_frame_for_redisplay (old_frame
);
11956 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11960 /* Do the mark_window_display_accurate after all windows have
11961 been redisplayed because this call resets flags in buffers
11962 which are needed for proper redisplay. */
11963 FOR_EACH_FRAME (tail
, frame
)
11965 struct frame
*f
= XFRAME (frame
);
11968 mark_window_display_accurate (f
->root_window
, 1);
11969 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11970 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11975 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11977 Lisp_Object mini_window
;
11978 struct frame
*mini_frame
;
11980 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11981 /* Use list_of_error, not Qerror, so that
11982 we catch only errors and don't run the debugger. */
11983 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11985 redisplay_window_error
);
11987 /* Compare desired and current matrices, perform output. */
11990 /* If fonts changed, display again. */
11991 if (fonts_changed_p
)
11994 /* Prevent various kinds of signals during display update.
11995 stdio is not robust about handling signals,
11996 which can cause an apparent I/O error. */
11997 if (interrupt_input
)
11998 unrequest_sigio ();
12001 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12003 if (hscroll_windows (selected_window
))
12006 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12007 pending
= update_frame (sf
, 0, 0);
12010 /* We may have called echo_area_display at the top of this
12011 function. If the echo area is on another frame, that may
12012 have put text on a frame other than the selected one, so the
12013 above call to update_frame would not have caught it. Catch
12015 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12016 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12018 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12020 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12021 pending
|= update_frame (mini_frame
, 0, 0);
12022 if (!pending
&& hscroll_windows (mini_window
))
12027 /* If display was paused because of pending input, make sure we do a
12028 thorough update the next time. */
12031 /* Prevent the optimization at the beginning of
12032 redisplay_internal that tries a single-line update of the
12033 line containing the cursor in the selected window. */
12034 CHARPOS (this_line_start_pos
) = 0;
12036 /* Let the overlay arrow be updated the next time. */
12037 update_overlay_arrows (0);
12039 /* If we pause after scrolling, some rows in the current
12040 matrices of some windows are not valid. */
12041 if (!WINDOW_FULL_WIDTH_P (w
)
12042 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12043 update_mode_lines
= 1;
12047 if (!consider_all_windows_p
)
12049 /* This has already been done above if
12050 consider_all_windows_p is set. */
12051 mark_window_display_accurate_1 (w
, 1);
12053 /* Say overlay arrows are up to date. */
12054 update_overlay_arrows (1);
12056 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12057 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12060 update_mode_lines
= 0;
12061 windows_or_buffers_changed
= 0;
12062 cursor_type_changed
= 0;
12065 /* Start SIGIO interrupts coming again. Having them off during the
12066 code above makes it less likely one will discard output, but not
12067 impossible, since there might be stuff in the system buffer here.
12068 But it is much hairier to try to do anything about that. */
12069 if (interrupt_input
)
12073 /* If a frame has become visible which was not before, redisplay
12074 again, so that we display it. Expose events for such a frame
12075 (which it gets when becoming visible) don't call the parts of
12076 redisplay constructing glyphs, so simply exposing a frame won't
12077 display anything in this case. So, we have to display these
12078 frames here explicitly. */
12081 Lisp_Object tail
, frame
;
12084 FOR_EACH_FRAME (tail
, frame
)
12086 int this_is_visible
= 0;
12088 if (XFRAME (frame
)->visible
)
12089 this_is_visible
= 1;
12090 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12091 if (XFRAME (frame
)->visible
)
12092 this_is_visible
= 1;
12094 if (this_is_visible
)
12098 if (new_count
!= number_of_visible_frames
)
12099 windows_or_buffers_changed
++;
12102 /* Change frame size now if a change is pending. */
12103 do_pending_window_change (1);
12105 /* If we just did a pending size change, or have additional
12106 visible frames, or selected_window changed, redisplay again. */
12107 if ((windows_or_buffers_changed
&& !pending
)
12108 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12111 /* Clear the face and image caches.
12113 We used to do this only if consider_all_windows_p. But the cache
12114 needs to be cleared if a timer creates images in the current
12115 buffer (e.g. the test case in Bug#6230). */
12117 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12119 clear_face_cache (0);
12120 clear_face_cache_count
= 0;
12123 #ifdef HAVE_WINDOW_SYSTEM
12124 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12126 clear_image_caches (Qnil
);
12127 clear_image_cache_count
= 0;
12129 #endif /* HAVE_WINDOW_SYSTEM */
12132 unbind_to (count
, Qnil
);
12137 /* Redisplay, but leave alone any recent echo area message unless
12138 another message has been requested in its place.
12140 This is useful in situations where you need to redisplay but no
12141 user action has occurred, making it inappropriate for the message
12142 area to be cleared. See tracking_off and
12143 wait_reading_process_output for examples of these situations.
12145 FROM_WHERE is an integer saying from where this function was
12146 called. This is useful for debugging. */
12149 redisplay_preserve_echo_area (int from_where
)
12151 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12153 if (!NILP (echo_area_buffer
[1]))
12155 /* We have a previously displayed message, but no current
12156 message. Redisplay the previous message. */
12157 display_last_displayed_message_p
= 1;
12158 redisplay_internal ();
12159 display_last_displayed_message_p
= 0;
12162 redisplay_internal ();
12164 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12165 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12166 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12170 /* Function registered with record_unwind_protect in
12171 redisplay_internal. Reset redisplaying_p to the value it had
12172 before redisplay_internal was called, and clear
12173 prevent_freeing_realized_faces_p. It also selects the previously
12174 selected frame, unless it has been deleted (by an X connection
12175 failure during redisplay, for example). */
12178 unwind_redisplay (Lisp_Object val
)
12180 Lisp_Object old_redisplaying_p
, old_frame
;
12182 old_redisplaying_p
= XCAR (val
);
12183 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12184 old_frame
= XCDR (val
);
12185 if (! EQ (old_frame
, selected_frame
)
12186 && FRAME_LIVE_P (XFRAME (old_frame
)))
12187 select_frame_for_redisplay (old_frame
);
12192 /* Mark the display of window W as accurate or inaccurate. If
12193 ACCURATE_P is non-zero mark display of W as accurate. If
12194 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12195 redisplay_internal is called. */
12198 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12200 if (BUFFERP (w
->buffer
))
12202 struct buffer
*b
= XBUFFER (w
->buffer
);
12205 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12206 w
->last_overlay_modified
12207 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12209 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12213 b
->clip_changed
= 0;
12214 b
->prevent_redisplay_optimizations_p
= 0;
12216 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12217 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12218 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12219 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12221 w
->current_matrix
->buffer
= b
;
12222 w
->current_matrix
->begv
= BUF_BEGV (b
);
12223 w
->current_matrix
->zv
= BUF_ZV (b
);
12225 w
->last_cursor
= w
->cursor
;
12226 w
->last_cursor_off_p
= w
->cursor_off_p
;
12228 if (w
== XWINDOW (selected_window
))
12229 w
->last_point
= make_number (BUF_PT (b
));
12231 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12237 w
->window_end_valid
= w
->buffer
;
12238 w
->update_mode_line
= Qnil
;
12243 /* Mark the display of windows in the window tree rooted at WINDOW as
12244 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12245 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12246 be redisplayed the next time redisplay_internal is called. */
12249 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12253 for (; !NILP (window
); window
= w
->next
)
12255 w
= XWINDOW (window
);
12256 mark_window_display_accurate_1 (w
, accurate_p
);
12258 if (!NILP (w
->vchild
))
12259 mark_window_display_accurate (w
->vchild
, accurate_p
);
12260 if (!NILP (w
->hchild
))
12261 mark_window_display_accurate (w
->hchild
, accurate_p
);
12266 update_overlay_arrows (1);
12270 /* Force a thorough redisplay the next time by setting
12271 last_arrow_position and last_arrow_string to t, which is
12272 unequal to any useful value of Voverlay_arrow_... */
12273 update_overlay_arrows (-1);
12278 /* Return value in display table DP (Lisp_Char_Table *) for character
12279 C. Since a display table doesn't have any parent, we don't have to
12280 follow parent. Do not call this function directly but use the
12281 macro DISP_CHAR_VECTOR. */
12284 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12288 if (ASCII_CHAR_P (c
))
12291 if (SUB_CHAR_TABLE_P (val
))
12292 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12298 XSETCHAR_TABLE (table
, dp
);
12299 val
= char_table_ref (table
, c
);
12308 /***********************************************************************
12310 ***********************************************************************/
12312 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12315 redisplay_windows (Lisp_Object window
)
12317 while (!NILP (window
))
12319 struct window
*w
= XWINDOW (window
);
12321 if (!NILP (w
->hchild
))
12322 redisplay_windows (w
->hchild
);
12323 else if (!NILP (w
->vchild
))
12324 redisplay_windows (w
->vchild
);
12325 else if (!NILP (w
->buffer
))
12327 displayed_buffer
= XBUFFER (w
->buffer
);
12328 /* Use list_of_error, not Qerror, so that
12329 we catch only errors and don't run the debugger. */
12330 internal_condition_case_1 (redisplay_window_0
, window
,
12332 redisplay_window_error
);
12340 redisplay_window_error (Lisp_Object ignore
)
12342 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12347 redisplay_window_0 (Lisp_Object window
)
12349 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12350 redisplay_window (window
, 0);
12355 redisplay_window_1 (Lisp_Object window
)
12357 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12358 redisplay_window (window
, 1);
12363 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12364 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12365 which positions recorded in ROW differ from current buffer
12368 Return 0 if cursor is not on this row, 1 otherwise. */
12371 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12372 struct glyph_matrix
*matrix
,
12373 EMACS_INT delta
, EMACS_INT delta_bytes
,
12376 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12377 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12378 struct glyph
*cursor
= NULL
;
12379 /* The last known character position in row. */
12380 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12382 EMACS_INT pt_old
= PT
- delta
;
12383 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12384 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12385 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12386 /* A glyph beyond the edge of TEXT_AREA which we should never
12388 struct glyph
*glyphs_end
= end
;
12389 /* Non-zero means we've found a match for cursor position, but that
12390 glyph has the avoid_cursor_p flag set. */
12391 int match_with_avoid_cursor
= 0;
12392 /* Non-zero means we've seen at least one glyph that came from a
12394 int string_seen
= 0;
12395 /* Largest and smalles buffer positions seen so far during scan of
12397 EMACS_INT bpos_max
= pos_before
;
12398 EMACS_INT bpos_min
= pos_after
;
12399 /* Last buffer position covered by an overlay string with an integer
12400 `cursor' property. */
12401 EMACS_INT bpos_covered
= 0;
12403 /* Skip over glyphs not having an object at the start and the end of
12404 the row. These are special glyphs like truncation marks on
12405 terminal frames. */
12406 if (row
->displays_text_p
)
12408 if (!row
->reversed_p
)
12411 && INTEGERP (glyph
->object
)
12412 && glyph
->charpos
< 0)
12414 x
+= glyph
->pixel_width
;
12418 && INTEGERP ((end
- 1)->object
)
12419 /* CHARPOS is zero for blanks and stretch glyphs
12420 inserted by extend_face_to_end_of_line. */
12421 && (end
- 1)->charpos
<= 0)
12423 glyph_before
= glyph
- 1;
12430 /* If the glyph row is reversed, we need to process it from back
12431 to front, so swap the edge pointers. */
12432 glyphs_end
= end
= glyph
- 1;
12433 glyph
+= row
->used
[TEXT_AREA
] - 1;
12435 while (glyph
> end
+ 1
12436 && INTEGERP (glyph
->object
)
12437 && glyph
->charpos
< 0)
12440 x
-= glyph
->pixel_width
;
12442 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12444 /* By default, in reversed rows we put the cursor on the
12445 rightmost (first in the reading order) glyph. */
12446 for (g
= end
+ 1; g
< glyph
; g
++)
12447 x
+= g
->pixel_width
;
12449 && INTEGERP ((end
+ 1)->object
)
12450 && (end
+ 1)->charpos
<= 0)
12452 glyph_before
= glyph
+ 1;
12456 else if (row
->reversed_p
)
12458 /* In R2L rows that don't display text, put the cursor on the
12459 rightmost glyph. Case in point: an empty last line that is
12460 part of an R2L paragraph. */
12462 /* Avoid placing the cursor on the last glyph of the row, where
12463 on terminal frames we hold the vertical border between
12464 adjacent windows. */
12465 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12466 && !WINDOW_RIGHTMOST_P (w
)
12467 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12469 x
= -1; /* will be computed below, at label compute_x */
12472 /* Step 1: Try to find the glyph whose character position
12473 corresponds to point. If that's not possible, find 2 glyphs
12474 whose character positions are the closest to point, one before
12475 point, the other after it. */
12476 if (!row
->reversed_p
)
12477 while (/* not marched to end of glyph row */
12479 /* glyph was not inserted by redisplay for internal purposes */
12480 && !INTEGERP (glyph
->object
))
12482 if (BUFFERP (glyph
->object
))
12484 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12486 if (glyph
->charpos
> bpos_max
)
12487 bpos_max
= glyph
->charpos
;
12488 if (glyph
->charpos
< bpos_min
)
12489 bpos_min
= glyph
->charpos
;
12490 if (!glyph
->avoid_cursor_p
)
12492 /* If we hit point, we've found the glyph on which to
12493 display the cursor. */
12496 match_with_avoid_cursor
= 0;
12499 /* See if we've found a better approximation to
12500 POS_BEFORE or to POS_AFTER. Note that we want the
12501 first (leftmost) glyph of all those that are the
12502 closest from below, and the last (rightmost) of all
12503 those from above. */
12504 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12506 pos_before
= glyph
->charpos
;
12507 glyph_before
= glyph
;
12509 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12511 pos_after
= glyph
->charpos
;
12512 glyph_after
= glyph
;
12515 else if (dpos
== 0)
12516 match_with_avoid_cursor
= 1;
12518 else if (STRINGP (glyph
->object
))
12520 Lisp_Object chprop
;
12521 EMACS_INT glyph_pos
= glyph
->charpos
;
12523 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12525 if (INTEGERP (chprop
))
12527 bpos_covered
= bpos_max
+ XINT (chprop
);
12528 /* If the `cursor' property covers buffer positions up
12529 to and including point, we should display cursor on
12530 this glyph. Note that overlays and text properties
12531 with string values stop bidi reordering, so every
12532 buffer position to the left of the string is always
12533 smaller than any position to the right of the
12534 string. Therefore, if a `cursor' property on one
12535 of the string's characters has an integer value, we
12536 will break out of the loop below _before_ we get to
12537 the position match above. IOW, integer values of
12538 the `cursor' property override the "exact match for
12539 point" strategy of positioning the cursor. */
12540 /* Implementation note: bpos_max == pt_old when, e.g.,
12541 we are in an empty line, where bpos_max is set to
12542 MATRIX_ROW_START_CHARPOS, see above. */
12543 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12552 x
+= glyph
->pixel_width
;
12555 else if (glyph
> end
) /* row is reversed */
12556 while (!INTEGERP (glyph
->object
))
12558 if (BUFFERP (glyph
->object
))
12560 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12562 if (glyph
->charpos
> bpos_max
)
12563 bpos_max
= glyph
->charpos
;
12564 if (glyph
->charpos
< bpos_min
)
12565 bpos_min
= glyph
->charpos
;
12566 if (!glyph
->avoid_cursor_p
)
12570 match_with_avoid_cursor
= 0;
12573 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12575 pos_before
= glyph
->charpos
;
12576 glyph_before
= glyph
;
12578 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12580 pos_after
= glyph
->charpos
;
12581 glyph_after
= glyph
;
12584 else if (dpos
== 0)
12585 match_with_avoid_cursor
= 1;
12587 else if (STRINGP (glyph
->object
))
12589 Lisp_Object chprop
;
12590 EMACS_INT glyph_pos
= glyph
->charpos
;
12592 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12594 if (INTEGERP (chprop
))
12596 bpos_covered
= bpos_max
+ XINT (chprop
);
12597 /* If the `cursor' property covers buffer positions up
12598 to and including point, we should display cursor on
12600 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12609 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12611 x
--; /* can't use any pixel_width */
12614 x
-= glyph
->pixel_width
;
12617 /* Step 2: If we didn't find an exact match for point, we need to
12618 look for a proper place to put the cursor among glyphs between
12619 GLYPH_BEFORE and GLYPH_AFTER. */
12620 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12621 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12622 && bpos_covered
< pt_old
)
12624 /* An empty line has a single glyph whose OBJECT is zero and
12625 whose CHARPOS is the position of a newline on that line.
12626 Note that on a TTY, there are more glyphs after that, which
12627 were produced by extend_face_to_end_of_line, but their
12628 CHARPOS is zero or negative. */
12630 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12631 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12633 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12635 EMACS_INT ellipsis_pos
;
12637 /* Scan back over the ellipsis glyphs. */
12638 if (!row
->reversed_p
)
12640 ellipsis_pos
= (glyph
- 1)->charpos
;
12641 while (glyph
> row
->glyphs
[TEXT_AREA
]
12642 && (glyph
- 1)->charpos
== ellipsis_pos
)
12643 glyph
--, x
-= glyph
->pixel_width
;
12644 /* That loop always goes one position too far, including
12645 the glyph before the ellipsis. So scan forward over
12647 x
+= glyph
->pixel_width
;
12650 else /* row is reversed */
12652 ellipsis_pos
= (glyph
+ 1)->charpos
;
12653 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12654 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12655 glyph
++, x
+= glyph
->pixel_width
;
12656 x
-= glyph
->pixel_width
;
12660 else if (match_with_avoid_cursor
12661 /* A truncated row may not include PT among its
12662 character positions. Setting the cursor inside the
12663 scroll margin will trigger recalculation of hscroll
12664 in hscroll_window_tree. */
12665 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12666 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12667 /* Zero-width characters produce no glyphs. */
12670 && (row
->reversed_p
12671 ? glyph_after
> glyphs_end
12672 : glyph_after
< glyphs_end
)))
12674 cursor
= glyph_after
;
12677 else if (string_seen
)
12679 int incr
= row
->reversed_p
? -1 : +1;
12681 /* Need to find the glyph that came out of a string which is
12682 present at point. That glyph is somewhere between
12683 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12684 positioned between POS_BEFORE and POS_AFTER in the
12686 struct glyph
*stop
= glyph_after
;
12687 EMACS_INT pos
= pos_before
;
12690 for (glyph
= glyph_before
+ incr
;
12691 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12694 /* Any glyphs that come from the buffer are here because
12695 of bidi reordering. Skip them, and only pay
12696 attention to glyphs that came from some string. */
12697 if (STRINGP (glyph
->object
))
12702 str
= glyph
->object
;
12703 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12704 if (tem
== 0 /* from overlay */
12707 /* If the string from which this glyph came is
12708 found in the buffer at point, then we've
12709 found the glyph we've been looking for. If
12710 it comes from an overlay (tem == 0), and it
12711 has the `cursor' property on one of its
12712 glyphs, record that glyph as a candidate for
12713 displaying the cursor. (As in the
12714 unidirectional version, we will display the
12715 cursor on the last candidate we find.) */
12716 if (tem
== 0 || tem
== pt_old
)
12718 /* The glyphs from this string could have
12719 been reordered. Find the one with the
12720 smallest string position. Or there could
12721 be a character in the string with the
12722 `cursor' property, which means display
12723 cursor on that character's glyph. */
12724 EMACS_INT strpos
= glyph
->charpos
;
12729 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12730 && EQ (glyph
->object
, str
);
12734 EMACS_INT gpos
= glyph
->charpos
;
12736 cprop
= Fget_char_property (make_number (gpos
),
12744 if (tem
&& glyph
->charpos
< strpos
)
12746 strpos
= glyph
->charpos
;
12755 pos
= tem
+ 1; /* don't find previous instances */
12757 /* This string is not what we want; skip all of the
12758 glyphs that came from it. */
12759 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12760 && EQ (glyph
->object
, str
))
12767 /* If we reached the end of the line, and END was from a string,
12768 the cursor is not on this line. */
12770 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12771 && STRINGP (end
->object
)
12772 && row
->continued_p
)
12778 if (cursor
!= NULL
)
12784 /* Need to compute x that corresponds to GLYPH. */
12785 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12787 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12789 x
+= g
->pixel_width
;
12793 /* ROW could be part of a continued line, which, under bidi
12794 reordering, might have other rows whose start and end charpos
12795 occlude point. Only set w->cursor if we found a better
12796 approximation to the cursor position than we have from previously
12797 examined candidate rows belonging to the same continued line. */
12798 if (/* we already have a candidate row */
12799 w
->cursor
.vpos
>= 0
12800 /* that candidate is not the row we are processing */
12801 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12802 /* the row we are processing is part of a continued line */
12803 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12804 /* Make sure cursor.vpos specifies a row whose start and end
12805 charpos occlude point. This is because some callers of this
12806 function leave cursor.vpos at the row where the cursor was
12807 displayed during the last redisplay cycle. */
12808 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12809 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12812 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12814 /* Don't consider glyphs that are outside TEXT_AREA. */
12815 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12817 /* Keep the candidate whose buffer position is the closest to
12819 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12820 w
->cursor
.hpos
>= 0
12821 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12822 && BUFFERP (g1
->object
)
12823 && (g1
->charpos
== pt_old
/* an exact match always wins */
12824 || (BUFFERP (glyph
->object
)
12825 && eabs (g1
->charpos
- pt_old
)
12826 < eabs (glyph
->charpos
- pt_old
))))
12828 /* If this candidate gives an exact match, use that. */
12829 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12830 /* Otherwise, keep the candidate that comes from a row
12831 spanning less buffer positions. This may win when one or
12832 both candidate positions are on glyphs that came from
12833 display strings, for which we cannot compare buffer
12835 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12836 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12837 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12840 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12842 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12843 w
->cursor
.y
= row
->y
+ dy
;
12845 if (w
== XWINDOW (selected_window
))
12847 if (!row
->continued_p
12848 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12851 this_line_buffer
= XBUFFER (w
->buffer
);
12853 CHARPOS (this_line_start_pos
)
12854 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12855 BYTEPOS (this_line_start_pos
)
12856 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12858 CHARPOS (this_line_end_pos
)
12859 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12860 BYTEPOS (this_line_end_pos
)
12861 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12863 this_line_y
= w
->cursor
.y
;
12864 this_line_pixel_height
= row
->height
;
12865 this_line_vpos
= w
->cursor
.vpos
;
12866 this_line_start_x
= row
->x
;
12869 CHARPOS (this_line_start_pos
) = 0;
12876 /* Run window scroll functions, if any, for WINDOW with new window
12877 start STARTP. Sets the window start of WINDOW to that position.
12879 We assume that the window's buffer is really current. */
12881 static INLINE
struct text_pos
12882 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12884 struct window
*w
= XWINDOW (window
);
12885 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12887 if (current_buffer
!= XBUFFER (w
->buffer
))
12890 if (!NILP (Vwindow_scroll_functions
))
12892 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12893 make_number (CHARPOS (startp
)));
12894 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12895 /* In case the hook functions switch buffers. */
12896 if (current_buffer
!= XBUFFER (w
->buffer
))
12897 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12904 /* Make sure the line containing the cursor is fully visible.
12905 A value of 1 means there is nothing to be done.
12906 (Either the line is fully visible, or it cannot be made so,
12907 or we cannot tell.)
12909 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12910 is higher than window.
12912 A value of 0 means the caller should do scrolling
12913 as if point had gone off the screen. */
12916 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12918 struct glyph_matrix
*matrix
;
12919 struct glyph_row
*row
;
12922 if (!make_cursor_line_fully_visible_p
)
12925 /* It's not always possible to find the cursor, e.g, when a window
12926 is full of overlay strings. Don't do anything in that case. */
12927 if (w
->cursor
.vpos
< 0)
12930 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12931 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12933 /* If the cursor row is not partially visible, there's nothing to do. */
12934 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12937 /* If the row the cursor is in is taller than the window's height,
12938 it's not clear what to do, so do nothing. */
12939 window_height
= window_box_height (w
);
12940 if (row
->height
>= window_height
)
12942 if (!force_p
|| MINI_WINDOW_P (w
)
12943 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12950 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12951 non-zero means only WINDOW is redisplayed in redisplay_internal.
12952 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12953 in redisplay_window to bring a partially visible line into view in
12954 the case that only the cursor has moved.
12956 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12957 last screen line's vertical height extends past the end of the screen.
12961 1 if scrolling succeeded
12963 0 if scrolling didn't find point.
12965 -1 if new fonts have been loaded so that we must interrupt
12966 redisplay, adjust glyph matrices, and try again. */
12972 SCROLLING_NEED_LARGER_MATRICES
12975 /* If scroll-conservatively is more than this, never recenter.
12977 If you change this, don't forget to update the doc string of
12978 `scroll-conservatively' and the Emacs manual. */
12979 #define SCROLL_LIMIT 100
12982 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12983 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12984 int temp_scroll_step
, int last_line_misfit
)
12986 struct window
*w
= XWINDOW (window
);
12987 struct frame
*f
= XFRAME (w
->frame
);
12988 struct text_pos pos
, startp
;
12990 int this_scroll_margin
, scroll_max
, rc
, height
;
12991 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12992 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12993 Lisp_Object aggressive
;
12994 /* We will never try scrolling more than this number of lines. */
12995 int scroll_limit
= SCROLL_LIMIT
;
12998 debug_method_add (w
, "try_scrolling");
13001 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13003 /* Compute scroll margin height in pixels. We scroll when point is
13004 within this distance from the top or bottom of the window. */
13005 if (scroll_margin
> 0)
13006 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13007 * FRAME_LINE_HEIGHT (f
);
13009 this_scroll_margin
= 0;
13011 /* Force arg_scroll_conservatively to have a reasonable value, to
13012 avoid scrolling too far away with slow move_it_* functions. Note
13013 that the user can supply scroll-conservatively equal to
13014 `most-positive-fixnum', which can be larger than INT_MAX. */
13015 if (arg_scroll_conservatively
> scroll_limit
)
13017 arg_scroll_conservatively
= scroll_limit
+ 1;
13018 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13020 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13021 /* Compute how much we should try to scroll maximally to bring
13022 point into view. */
13023 scroll_max
= (max (scroll_step
,
13024 max (arg_scroll_conservatively
, temp_scroll_step
))
13025 * FRAME_LINE_HEIGHT (f
));
13026 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13027 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13028 /* We're trying to scroll because of aggressive scrolling but no
13029 scroll_step is set. Choose an arbitrary one. */
13030 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13036 /* Decide whether to scroll down. */
13037 if (PT
> CHARPOS (startp
))
13039 int scroll_margin_y
;
13041 /* Compute the pixel ypos of the scroll margin, then move it to
13042 either that ypos or PT, whichever comes first. */
13043 start_display (&it
, w
, startp
);
13044 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13045 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13046 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13047 (MOVE_TO_POS
| MOVE_TO_Y
));
13049 if (PT
> CHARPOS (it
.current
.pos
))
13051 int y0
= line_bottom_y (&it
);
13052 /* Compute how many pixels below window bottom to stop searching
13053 for PT. This avoids costly search for PT that is far away if
13054 the user limited scrolling by a small number of lines, but
13055 always finds PT if scroll_conservatively is set to a large
13056 number, such as most-positive-fixnum. */
13057 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13058 int y_to_move
= it
.last_visible_y
+ slack
;
13060 /* Compute the distance from the scroll margin to PT or to
13061 the scroll limit, whichever comes first. This should
13062 include the height of the cursor line, to make that line
13064 move_it_to (&it
, PT
, -1, y_to_move
,
13065 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13066 dy
= line_bottom_y (&it
) - y0
;
13068 if (dy
> scroll_max
)
13069 return SCROLLING_FAILED
;
13077 /* Point is in or below the bottom scroll margin, so move the
13078 window start down. If scrolling conservatively, move it just
13079 enough down to make point visible. If scroll_step is set,
13080 move it down by scroll_step. */
13081 if (arg_scroll_conservatively
)
13083 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13084 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13085 else if (scroll_step
|| temp_scroll_step
)
13086 amount_to_scroll
= scroll_max
;
13089 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13090 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13091 if (NUMBERP (aggressive
))
13093 double float_amount
= XFLOATINT (aggressive
) * height
;
13094 amount_to_scroll
= float_amount
;
13095 if (amount_to_scroll
== 0 && float_amount
> 0)
13096 amount_to_scroll
= 1;
13097 /* Don't let point enter the scroll margin near top of
13099 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13100 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13104 if (amount_to_scroll
<= 0)
13105 return SCROLLING_FAILED
;
13107 start_display (&it
, w
, startp
);
13108 if (arg_scroll_conservatively
<= scroll_limit
)
13109 move_it_vertically (&it
, amount_to_scroll
);
13112 /* Extra precision for users who set scroll-conservatively
13113 to a large number: make sure the amount we scroll
13114 the window start is never less than amount_to_scroll,
13115 which was computed as distance from window bottom to
13116 point. This matters when lines at window top and lines
13117 below window bottom have different height. */
13118 struct it it1
= it
;
13119 /* We use a temporary it1 because line_bottom_y can modify
13120 its argument, if it moves one line down; see there. */
13121 int start_y
= line_bottom_y (&it1
);
13124 move_it_by_lines (&it
, 1);
13126 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13129 /* If STARTP is unchanged, move it down another screen line. */
13130 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13131 move_it_by_lines (&it
, 1);
13132 startp
= it
.current
.pos
;
13136 struct text_pos scroll_margin_pos
= startp
;
13138 /* See if point is inside the scroll margin at the top of the
13140 if (this_scroll_margin
)
13142 start_display (&it
, w
, startp
);
13143 move_it_vertically (&it
, this_scroll_margin
);
13144 scroll_margin_pos
= it
.current
.pos
;
13147 if (PT
< CHARPOS (scroll_margin_pos
))
13149 /* Point is in the scroll margin at the top of the window or
13150 above what is displayed in the window. */
13153 /* Compute the vertical distance from PT to the scroll
13154 margin position. Move as far as scroll_max allows, or
13155 one screenful, or 10 screen lines, whichever is largest.
13156 Give up if distance is greater than scroll_max. */
13157 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13158 start_display (&it
, w
, pos
);
13160 y_to_move
= max (it
.last_visible_y
,
13161 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13162 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13164 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13165 dy
= it
.current_y
- y0
;
13166 if (dy
> scroll_max
)
13167 return SCROLLING_FAILED
;
13169 /* Compute new window start. */
13170 start_display (&it
, w
, startp
);
13172 if (arg_scroll_conservatively
)
13173 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13174 max (scroll_step
, temp_scroll_step
));
13175 else if (scroll_step
|| temp_scroll_step
)
13176 amount_to_scroll
= scroll_max
;
13179 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13180 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13181 if (NUMBERP (aggressive
))
13183 double float_amount
= XFLOATINT (aggressive
) * height
;
13184 amount_to_scroll
= float_amount
;
13185 if (amount_to_scroll
== 0 && float_amount
> 0)
13186 amount_to_scroll
= 1;
13187 amount_to_scroll
-=
13188 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13189 /* Don't let point enter the scroll margin near
13190 bottom of the window. */
13191 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13192 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13196 if (amount_to_scroll
<= 0)
13197 return SCROLLING_FAILED
;
13199 move_it_vertically_backward (&it
, amount_to_scroll
);
13200 startp
= it
.current
.pos
;
13204 /* Run window scroll functions. */
13205 startp
= run_window_scroll_functions (window
, startp
);
13207 /* Display the window. Give up if new fonts are loaded, or if point
13209 if (!try_window (window
, startp
, 0))
13210 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13211 else if (w
->cursor
.vpos
< 0)
13213 clear_glyph_matrix (w
->desired_matrix
);
13214 rc
= SCROLLING_FAILED
;
13218 /* Maybe forget recorded base line for line number display. */
13219 if (!just_this_one_p
13220 || current_buffer
->clip_changed
13221 || BEG_UNCHANGED
< CHARPOS (startp
))
13222 w
->base_line_number
= Qnil
;
13224 /* If cursor ends up on a partially visible line,
13225 treat that as being off the bottom of the screen. */
13226 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13227 /* It's possible that the cursor is on the first line of the
13228 buffer, which is partially obscured due to a vscroll
13229 (Bug#7537). In that case, avoid looping forever . */
13230 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13232 clear_glyph_matrix (w
->desired_matrix
);
13233 ++extra_scroll_margin_lines
;
13236 rc
= SCROLLING_SUCCESS
;
13243 /* Compute a suitable window start for window W if display of W starts
13244 on a continuation line. Value is non-zero if a new window start
13247 The new window start will be computed, based on W's width, starting
13248 from the start of the continued line. It is the start of the
13249 screen line with the minimum distance from the old start W->start. */
13252 compute_window_start_on_continuation_line (struct window
*w
)
13254 struct text_pos pos
, start_pos
;
13255 int window_start_changed_p
= 0;
13257 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13259 /* If window start is on a continuation line... Window start may be
13260 < BEGV in case there's invisible text at the start of the
13261 buffer (M-x rmail, for example). */
13262 if (CHARPOS (start_pos
) > BEGV
13263 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13266 struct glyph_row
*row
;
13268 /* Handle the case that the window start is out of range. */
13269 if (CHARPOS (start_pos
) < BEGV
)
13270 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13271 else if (CHARPOS (start_pos
) > ZV
)
13272 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13274 /* Find the start of the continued line. This should be fast
13275 because scan_buffer is fast (newline cache). */
13276 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13277 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13278 row
, DEFAULT_FACE_ID
);
13279 reseat_at_previous_visible_line_start (&it
);
13281 /* If the line start is "too far" away from the window start,
13282 say it takes too much time to compute a new window start. */
13283 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13284 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13286 int min_distance
, distance
;
13288 /* Move forward by display lines to find the new window
13289 start. If window width was enlarged, the new start can
13290 be expected to be > the old start. If window width was
13291 decreased, the new window start will be < the old start.
13292 So, we're looking for the display line start with the
13293 minimum distance from the old window start. */
13294 pos
= it
.current
.pos
;
13295 min_distance
= INFINITY
;
13296 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13297 distance
< min_distance
)
13299 min_distance
= distance
;
13300 pos
= it
.current
.pos
;
13301 move_it_by_lines (&it
, 1);
13304 /* Set the window start there. */
13305 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13306 window_start_changed_p
= 1;
13310 return window_start_changed_p
;
13314 /* Try cursor movement in case text has not changed in window WINDOW,
13315 with window start STARTP. Value is
13317 CURSOR_MOVEMENT_SUCCESS if successful
13319 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13321 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13322 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13323 we want to scroll as if scroll-step were set to 1. See the code.
13325 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13326 which case we have to abort this redisplay, and adjust matrices
13331 CURSOR_MOVEMENT_SUCCESS
,
13332 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13333 CURSOR_MOVEMENT_MUST_SCROLL
,
13334 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13338 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13340 struct window
*w
= XWINDOW (window
);
13341 struct frame
*f
= XFRAME (w
->frame
);
13342 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13345 if (inhibit_try_cursor_movement
)
13349 /* Handle case where text has not changed, only point, and it has
13350 not moved off the frame. */
13351 if (/* Point may be in this window. */
13352 PT
>= CHARPOS (startp
)
13353 /* Selective display hasn't changed. */
13354 && !current_buffer
->clip_changed
13355 /* Function force-mode-line-update is used to force a thorough
13356 redisplay. It sets either windows_or_buffers_changed or
13357 update_mode_lines. So don't take a shortcut here for these
13359 && !update_mode_lines
13360 && !windows_or_buffers_changed
13361 && !cursor_type_changed
13362 /* Can't use this case if highlighting a region. When a
13363 region exists, cursor movement has to do more than just
13365 && !(!NILP (Vtransient_mark_mode
)
13366 && !NILP (BVAR (current_buffer
, mark_active
)))
13367 && NILP (w
->region_showing
)
13368 && NILP (Vshow_trailing_whitespace
)
13369 /* Right after splitting windows, last_point may be nil. */
13370 && INTEGERP (w
->last_point
)
13371 /* This code is not used for mini-buffer for the sake of the case
13372 of redisplaying to replace an echo area message; since in
13373 that case the mini-buffer contents per se are usually
13374 unchanged. This code is of no real use in the mini-buffer
13375 since the handling of this_line_start_pos, etc., in redisplay
13376 handles the same cases. */
13377 && !EQ (window
, minibuf_window
)
13378 /* When splitting windows or for new windows, it happens that
13379 redisplay is called with a nil window_end_vpos or one being
13380 larger than the window. This should really be fixed in
13381 window.c. I don't have this on my list, now, so we do
13382 approximately the same as the old redisplay code. --gerd. */
13383 && INTEGERP (w
->window_end_vpos
)
13384 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13385 && (FRAME_WINDOW_P (f
)
13386 || !overlay_arrow_in_current_buffer_p ()))
13388 int this_scroll_margin
, top_scroll_margin
;
13389 struct glyph_row
*row
= NULL
;
13392 debug_method_add (w
, "cursor movement");
13395 /* Scroll if point within this distance from the top or bottom
13396 of the window. This is a pixel value. */
13397 if (scroll_margin
> 0)
13399 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13400 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13403 this_scroll_margin
= 0;
13405 top_scroll_margin
= this_scroll_margin
;
13406 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13407 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13409 /* Start with the row the cursor was displayed during the last
13410 not paused redisplay. Give up if that row is not valid. */
13411 if (w
->last_cursor
.vpos
< 0
13412 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13413 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13416 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13417 if (row
->mode_line_p
)
13419 if (!row
->enabled_p
)
13420 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13423 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13425 int scroll_p
= 0, must_scroll
= 0;
13426 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13428 if (PT
> XFASTINT (w
->last_point
))
13430 /* Point has moved forward. */
13431 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13432 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13434 xassert (row
->enabled_p
);
13438 /* If the end position of a row equals the start
13439 position of the next row, and PT is at that position,
13440 we would rather display cursor in the next line. */
13441 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13442 && MATRIX_ROW_END_CHARPOS (row
) == PT
13443 && row
< w
->current_matrix
->rows
13444 + w
->current_matrix
->nrows
- 1
13445 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13446 && !cursor_row_p (row
))
13449 /* If within the scroll margin, scroll. Note that
13450 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13451 the next line would be drawn, and that
13452 this_scroll_margin can be zero. */
13453 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13454 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13455 /* Line is completely visible last line in window
13456 and PT is to be set in the next line. */
13457 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13458 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13459 && !row
->ends_at_zv_p
13460 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13463 else if (PT
< XFASTINT (w
->last_point
))
13465 /* Cursor has to be moved backward. Note that PT >=
13466 CHARPOS (startp) because of the outer if-statement. */
13467 while (!row
->mode_line_p
13468 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13469 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13470 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13471 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13472 row
> w
->current_matrix
->rows
13473 && (row
-1)->ends_in_newline_from_string_p
))))
13474 && (row
->y
> top_scroll_margin
13475 || CHARPOS (startp
) == BEGV
))
13477 xassert (row
->enabled_p
);
13481 /* Consider the following case: Window starts at BEGV,
13482 there is invisible, intangible text at BEGV, so that
13483 display starts at some point START > BEGV. It can
13484 happen that we are called with PT somewhere between
13485 BEGV and START. Try to handle that case. */
13486 if (row
< w
->current_matrix
->rows
13487 || row
->mode_line_p
)
13489 row
= w
->current_matrix
->rows
;
13490 if (row
->mode_line_p
)
13494 /* Due to newlines in overlay strings, we may have to
13495 skip forward over overlay strings. */
13496 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13497 && MATRIX_ROW_END_CHARPOS (row
) == PT
13498 && !cursor_row_p (row
))
13501 /* If within the scroll margin, scroll. */
13502 if (row
->y
< top_scroll_margin
13503 && CHARPOS (startp
) != BEGV
)
13508 /* Cursor did not move. So don't scroll even if cursor line
13509 is partially visible, as it was so before. */
13510 rc
= CURSOR_MOVEMENT_SUCCESS
;
13513 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13514 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13516 /* if PT is not in the glyph row, give up. */
13517 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13520 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13521 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13523 /* If rows are bidi-reordered and point moved, back up
13524 until we find a row that does not belong to a
13525 continuation line. This is because we must consider
13526 all rows of a continued line as candidates for the
13527 new cursor positioning, since row start and end
13528 positions change non-linearly with vertical position
13530 /* FIXME: Revisit this when glyph ``spilling'' in
13531 continuation lines' rows is implemented for
13532 bidi-reordered rows. */
13533 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13535 xassert (row
->enabled_p
);
13537 /* If we hit the beginning of the displayed portion
13538 without finding the first row of a continued
13540 if (row
<= w
->current_matrix
->rows
)
13542 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13550 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13551 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13552 && make_cursor_line_fully_visible_p
)
13554 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13555 && !row
->ends_at_zv_p
13556 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13557 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13558 else if (row
->height
> window_box_height (w
))
13560 /* If we end up in a partially visible line, let's
13561 make it fully visible, except when it's taller
13562 than the window, in which case we can't do much
13565 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13569 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13570 if (!cursor_row_fully_visible_p (w
, 0, 1))
13571 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13573 rc
= CURSOR_MOVEMENT_SUCCESS
;
13577 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13578 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13579 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13581 /* With bidi-reordered rows, there could be more than
13582 one candidate row whose start and end positions
13583 occlude point. We need to let set_cursor_from_row
13584 find the best candidate. */
13585 /* FIXME: Revisit this when glyph ``spilling'' in
13586 continuation lines' rows is implemented for
13587 bidi-reordered rows. */
13592 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13593 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13594 && cursor_row_p (row
))
13595 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13597 /* As soon as we've found the first suitable row
13598 whose ends_at_zv_p flag is set, we are done. */
13600 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13602 rc
= CURSOR_MOVEMENT_SUCCESS
;
13607 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13608 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13609 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13610 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13611 /* If we didn't find any candidate rows, or exited the
13612 loop before all the candidates were examined, signal
13613 to the caller that this method failed. */
13614 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13615 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13616 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13618 rc
= CURSOR_MOVEMENT_SUCCESS
;
13624 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13626 rc
= CURSOR_MOVEMENT_SUCCESS
;
13631 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13632 && MATRIX_ROW_START_CHARPOS (row
) == PT
13633 && cursor_row_p (row
));
13641 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13645 set_vertical_scroll_bar (struct window
*w
)
13647 EMACS_INT start
, end
, whole
;
13649 /* Calculate the start and end positions for the current window.
13650 At some point, it would be nice to choose between scrollbars
13651 which reflect the whole buffer size, with special markers
13652 indicating narrowing, and scrollbars which reflect only the
13655 Note that mini-buffers sometimes aren't displaying any text. */
13656 if (!MINI_WINDOW_P (w
)
13657 || (w
== XWINDOW (minibuf_window
)
13658 && NILP (echo_area_buffer
[0])))
13660 struct buffer
*buf
= XBUFFER (w
->buffer
);
13661 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13662 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13663 /* I don't think this is guaranteed to be right. For the
13664 moment, we'll pretend it is. */
13665 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13669 if (whole
< (end
- start
))
13670 whole
= end
- start
;
13673 start
= end
= whole
= 0;
13675 /* Indicate what this scroll bar ought to be displaying now. */
13676 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13677 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13678 (w
, end
- start
, whole
, start
);
13682 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13683 selected_window is redisplayed.
13685 We can return without actually redisplaying the window if
13686 fonts_changed_p is nonzero. In that case, redisplay_internal will
13690 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13692 struct window
*w
= XWINDOW (window
);
13693 struct frame
*f
= XFRAME (w
->frame
);
13694 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13695 struct buffer
*old
= current_buffer
;
13696 struct text_pos lpoint
, opoint
, startp
;
13697 int update_mode_line
;
13700 /* Record it now because it's overwritten. */
13701 int current_matrix_up_to_date_p
= 0;
13702 int used_current_matrix_p
= 0;
13703 /* This is less strict than current_matrix_up_to_date_p.
13704 It indictes that the buffer contents and narrowing are unchanged. */
13705 int buffer_unchanged_p
= 0;
13706 int temp_scroll_step
= 0;
13707 int count
= SPECPDL_INDEX ();
13709 int centering_position
= -1;
13710 int last_line_misfit
= 0;
13711 EMACS_INT beg_unchanged
, end_unchanged
;
13713 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13716 /* W must be a leaf window here. */
13717 xassert (!NILP (w
->buffer
));
13719 *w
->desired_matrix
->method
= 0;
13723 reconsider_clip_changes (w
, buffer
);
13725 /* Has the mode line to be updated? */
13726 update_mode_line
= (!NILP (w
->update_mode_line
)
13727 || update_mode_lines
13728 || buffer
->clip_changed
13729 || buffer
->prevent_redisplay_optimizations_p
);
13731 if (MINI_WINDOW_P (w
))
13733 if (w
== XWINDOW (echo_area_window
)
13734 && !NILP (echo_area_buffer
[0]))
13736 if (update_mode_line
)
13737 /* We may have to update a tty frame's menu bar or a
13738 tool-bar. Example `M-x C-h C-h C-g'. */
13739 goto finish_menu_bars
;
13741 /* We've already displayed the echo area glyphs in this window. */
13742 goto finish_scroll_bars
;
13744 else if ((w
!= XWINDOW (minibuf_window
)
13745 || minibuf_level
== 0)
13746 /* When buffer is nonempty, redisplay window normally. */
13747 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13748 /* Quail displays non-mini buffers in minibuffer window.
13749 In that case, redisplay the window normally. */
13750 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13752 /* W is a mini-buffer window, but it's not active, so clear
13754 int yb
= window_text_bottom_y (w
);
13755 struct glyph_row
*row
;
13758 for (y
= 0, row
= w
->desired_matrix
->rows
;
13760 y
+= row
->height
, ++row
)
13761 blank_row (w
, row
, y
);
13762 goto finish_scroll_bars
;
13765 clear_glyph_matrix (w
->desired_matrix
);
13768 /* Otherwise set up data on this window; select its buffer and point
13770 /* Really select the buffer, for the sake of buffer-local
13772 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13774 current_matrix_up_to_date_p
13775 = (!NILP (w
->window_end_valid
)
13776 && !current_buffer
->clip_changed
13777 && !current_buffer
->prevent_redisplay_optimizations_p
13778 && XFASTINT (w
->last_modified
) >= MODIFF
13779 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13781 /* Run the window-bottom-change-functions
13782 if it is possible that the text on the screen has changed
13783 (either due to modification of the text, or any other reason). */
13784 if (!current_matrix_up_to_date_p
13785 && !NILP (Vwindow_text_change_functions
))
13787 safe_run_hooks (Qwindow_text_change_functions
);
13791 beg_unchanged
= BEG_UNCHANGED
;
13792 end_unchanged
= END_UNCHANGED
;
13794 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13796 specbind (Qinhibit_point_motion_hooks
, Qt
);
13799 = (!NILP (w
->window_end_valid
)
13800 && !current_buffer
->clip_changed
13801 && XFASTINT (w
->last_modified
) >= MODIFF
13802 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13804 /* When windows_or_buffers_changed is non-zero, we can't rely on
13805 the window end being valid, so set it to nil there. */
13806 if (windows_or_buffers_changed
)
13808 /* If window starts on a continuation line, maybe adjust the
13809 window start in case the window's width changed. */
13810 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13811 compute_window_start_on_continuation_line (w
);
13813 w
->window_end_valid
= Qnil
;
13816 /* Some sanity checks. */
13817 CHECK_WINDOW_END (w
);
13818 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13820 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13823 /* If %c is in mode line, update it if needed. */
13824 if (!NILP (w
->column_number_displayed
)
13825 /* This alternative quickly identifies a common case
13826 where no change is needed. */
13827 && !(PT
== XFASTINT (w
->last_point
)
13828 && XFASTINT (w
->last_modified
) >= MODIFF
13829 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13830 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13831 update_mode_line
= 1;
13833 /* Count number of windows showing the selected buffer. An indirect
13834 buffer counts as its base buffer. */
13835 if (!just_this_one_p
)
13837 struct buffer
*current_base
, *window_base
;
13838 current_base
= current_buffer
;
13839 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13840 if (current_base
->base_buffer
)
13841 current_base
= current_base
->base_buffer
;
13842 if (window_base
->base_buffer
)
13843 window_base
= window_base
->base_buffer
;
13844 if (current_base
== window_base
)
13848 /* Point refers normally to the selected window. For any other
13849 window, set up appropriate value. */
13850 if (!EQ (window
, selected_window
))
13852 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13853 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13857 new_pt_byte
= BEGV_BYTE
;
13858 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13860 else if (new_pt
> (ZV
- 1))
13863 new_pt_byte
= ZV_BYTE
;
13864 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13867 /* We don't use SET_PT so that the point-motion hooks don't run. */
13868 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13871 /* If any of the character widths specified in the display table
13872 have changed, invalidate the width run cache. It's true that
13873 this may be a bit late to catch such changes, but the rest of
13874 redisplay goes (non-fatally) haywire when the display table is
13875 changed, so why should we worry about doing any better? */
13876 if (current_buffer
->width_run_cache
)
13878 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13880 if (! disptab_matches_widthtab (disptab
,
13881 XVECTOR (BVAR (current_buffer
, width_table
))))
13883 invalidate_region_cache (current_buffer
,
13884 current_buffer
->width_run_cache
,
13886 recompute_width_table (current_buffer
, disptab
);
13890 /* If window-start is screwed up, choose a new one. */
13891 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13894 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13896 /* If someone specified a new starting point but did not insist,
13897 check whether it can be used. */
13898 if (!NILP (w
->optional_new_start
)
13899 && CHARPOS (startp
) >= BEGV
13900 && CHARPOS (startp
) <= ZV
)
13902 w
->optional_new_start
= Qnil
;
13903 start_display (&it
, w
, startp
);
13904 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13905 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13906 if (IT_CHARPOS (it
) == PT
)
13907 w
->force_start
= Qt
;
13908 /* IT may overshoot PT if text at PT is invisible. */
13909 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13910 w
->force_start
= Qt
;
13915 /* Handle case where place to start displaying has been specified,
13916 unless the specified location is outside the accessible range. */
13917 if (!NILP (w
->force_start
)
13918 || w
->frozen_window_start_p
)
13920 /* We set this later on if we have to adjust point. */
13923 w
->force_start
= Qnil
;
13925 w
->window_end_valid
= Qnil
;
13927 /* Forget any recorded base line for line number display. */
13928 if (!buffer_unchanged_p
)
13929 w
->base_line_number
= Qnil
;
13931 /* Redisplay the mode line. Select the buffer properly for that.
13932 Also, run the hook window-scroll-functions
13933 because we have scrolled. */
13934 /* Note, we do this after clearing force_start because
13935 if there's an error, it is better to forget about force_start
13936 than to get into an infinite loop calling the hook functions
13937 and having them get more errors. */
13938 if (!update_mode_line
13939 || ! NILP (Vwindow_scroll_functions
))
13941 update_mode_line
= 1;
13942 w
->update_mode_line
= Qt
;
13943 startp
= run_window_scroll_functions (window
, startp
);
13946 w
->last_modified
= make_number (0);
13947 w
->last_overlay_modified
= make_number (0);
13948 if (CHARPOS (startp
) < BEGV
)
13949 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13950 else if (CHARPOS (startp
) > ZV
)
13951 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13953 /* Redisplay, then check if cursor has been set during the
13954 redisplay. Give up if new fonts were loaded. */
13955 /* We used to issue a CHECK_MARGINS argument to try_window here,
13956 but this causes scrolling to fail when point begins inside
13957 the scroll margin (bug#148) -- cyd */
13958 if (!try_window (window
, startp
, 0))
13960 w
->force_start
= Qt
;
13961 clear_glyph_matrix (w
->desired_matrix
);
13962 goto need_larger_matrices
;
13965 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13967 /* If point does not appear, try to move point so it does
13968 appear. The desired matrix has been built above, so we
13969 can use it here. */
13970 new_vpos
= window_box_height (w
) / 2;
13973 if (!cursor_row_fully_visible_p (w
, 0, 0))
13975 /* Point does appear, but on a line partly visible at end of window.
13976 Move it back to a fully-visible line. */
13977 new_vpos
= window_box_height (w
);
13980 /* If we need to move point for either of the above reasons,
13981 now actually do it. */
13984 struct glyph_row
*row
;
13986 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13987 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13990 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13991 MATRIX_ROW_START_BYTEPOS (row
));
13993 if (w
!= XWINDOW (selected_window
))
13994 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13995 else if (current_buffer
== old
)
13996 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13998 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14000 /* If we are highlighting the region, then we just changed
14001 the region, so redisplay to show it. */
14002 if (!NILP (Vtransient_mark_mode
)
14003 && !NILP (BVAR (current_buffer
, mark_active
)))
14005 clear_glyph_matrix (w
->desired_matrix
);
14006 if (!try_window (window
, startp
, 0))
14007 goto need_larger_matrices
;
14012 debug_method_add (w
, "forced window start");
14017 /* Handle case where text has not changed, only point, and it has
14018 not moved off the frame, and we are not retrying after hscroll.
14019 (current_matrix_up_to_date_p is nonzero when retrying.) */
14020 if (current_matrix_up_to_date_p
14021 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14022 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14026 case CURSOR_MOVEMENT_SUCCESS
:
14027 used_current_matrix_p
= 1;
14030 case CURSOR_MOVEMENT_MUST_SCROLL
:
14031 goto try_to_scroll
;
14037 /* If current starting point was originally the beginning of a line
14038 but no longer is, find a new starting point. */
14039 else if (!NILP (w
->start_at_line_beg
)
14040 && !(CHARPOS (startp
) <= BEGV
14041 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14044 debug_method_add (w
, "recenter 1");
14049 /* Try scrolling with try_window_id. Value is > 0 if update has
14050 been done, it is -1 if we know that the same window start will
14051 not work. It is 0 if unsuccessful for some other reason. */
14052 else if ((tem
= try_window_id (w
)) != 0)
14055 debug_method_add (w
, "try_window_id %d", tem
);
14058 if (fonts_changed_p
)
14059 goto need_larger_matrices
;
14063 /* Otherwise try_window_id has returned -1 which means that we
14064 don't want the alternative below this comment to execute. */
14066 else if (CHARPOS (startp
) >= BEGV
14067 && CHARPOS (startp
) <= ZV
14068 && PT
>= CHARPOS (startp
)
14069 && (CHARPOS (startp
) < ZV
14070 /* Avoid starting at end of buffer. */
14071 || CHARPOS (startp
) == BEGV
14072 || (XFASTINT (w
->last_modified
) >= MODIFF
14073 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14076 /* If first window line is a continuation line, and window start
14077 is inside the modified region, but the first change is before
14078 current window start, we must select a new window start.
14080 However, if this is the result of a down-mouse event (e.g. by
14081 extending the mouse-drag-overlay), we don't want to select a
14082 new window start, since that would change the position under
14083 the mouse, resulting in an unwanted mouse-movement rather
14084 than a simple mouse-click. */
14085 if (NILP (w
->start_at_line_beg
)
14086 && NILP (do_mouse_tracking
)
14087 && CHARPOS (startp
) > BEGV
14088 && CHARPOS (startp
) > BEG
+ beg_unchanged
14089 && CHARPOS (startp
) <= Z
- end_unchanged
14090 /* Even if w->start_at_line_beg is nil, a new window may
14091 start at a line_beg, since that's how set_buffer_window
14092 sets it. So, we need to check the return value of
14093 compute_window_start_on_continuation_line. (See also
14095 && XMARKER (w
->start
)->buffer
== current_buffer
14096 && compute_window_start_on_continuation_line (w
))
14098 w
->force_start
= Qt
;
14099 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14104 debug_method_add (w
, "same window start");
14107 /* Try to redisplay starting at same place as before.
14108 If point has not moved off frame, accept the results. */
14109 if (!current_matrix_up_to_date_p
14110 /* Don't use try_window_reusing_current_matrix in this case
14111 because a window scroll function can have changed the
14113 || !NILP (Vwindow_scroll_functions
)
14114 || MINI_WINDOW_P (w
)
14115 || !(used_current_matrix_p
14116 = try_window_reusing_current_matrix (w
)))
14118 IF_DEBUG (debug_method_add (w
, "1"));
14119 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14120 /* -1 means we need to scroll.
14121 0 means we need new matrices, but fonts_changed_p
14122 is set in that case, so we will detect it below. */
14123 goto try_to_scroll
;
14126 if (fonts_changed_p
)
14127 goto need_larger_matrices
;
14129 if (w
->cursor
.vpos
>= 0)
14131 if (!just_this_one_p
14132 || current_buffer
->clip_changed
14133 || BEG_UNCHANGED
< CHARPOS (startp
))
14134 /* Forget any recorded base line for line number display. */
14135 w
->base_line_number
= Qnil
;
14137 if (!cursor_row_fully_visible_p (w
, 1, 0))
14139 clear_glyph_matrix (w
->desired_matrix
);
14140 last_line_misfit
= 1;
14142 /* Drop through and scroll. */
14147 clear_glyph_matrix (w
->desired_matrix
);
14152 w
->last_modified
= make_number (0);
14153 w
->last_overlay_modified
= make_number (0);
14155 /* Redisplay the mode line. Select the buffer properly for that. */
14156 if (!update_mode_line
)
14158 update_mode_line
= 1;
14159 w
->update_mode_line
= Qt
;
14162 /* Try to scroll by specified few lines. */
14163 if ((scroll_conservatively
14164 || emacs_scroll_step
14165 || temp_scroll_step
14166 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14167 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14168 && CHARPOS (startp
) >= BEGV
14169 && CHARPOS (startp
) <= ZV
)
14171 /* The function returns -1 if new fonts were loaded, 1 if
14172 successful, 0 if not successful. */
14173 int ss
= try_scrolling (window
, just_this_one_p
,
14174 scroll_conservatively
,
14176 temp_scroll_step
, last_line_misfit
);
14179 case SCROLLING_SUCCESS
:
14182 case SCROLLING_NEED_LARGER_MATRICES
:
14183 goto need_larger_matrices
;
14185 case SCROLLING_FAILED
:
14193 /* Finally, just choose a place to start which positions point
14194 according to user preferences. */
14199 debug_method_add (w
, "recenter");
14202 /* w->vscroll = 0; */
14204 /* Forget any previously recorded base line for line number display. */
14205 if (!buffer_unchanged_p
)
14206 w
->base_line_number
= Qnil
;
14208 /* Determine the window start relative to point. */
14209 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14210 it
.current_y
= it
.last_visible_y
;
14211 if (centering_position
< 0)
14215 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14217 EMACS_INT margin_pos
= CHARPOS (startp
);
14219 Lisp_Object aggressive
;
14221 /* If there is a scroll margin at the top of the window, find
14222 its character position. */
14224 /* Cannot call start_display if startp is not in the
14225 accessible region of the buffer. This can happen when we
14226 have just switched to a different buffer and/or changed
14227 its restriction. In that case, startp is initialized to
14228 the character position 1 (BEG) because we did not yet
14229 have chance to display the buffer even once. */
14230 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14234 start_display (&it1
, w
, startp
);
14235 move_it_vertically (&it1
, margin
);
14236 margin_pos
= IT_CHARPOS (it1
);
14238 scrolling_up
= PT
> margin_pos
;
14241 ? BVAR (current_buffer
, scroll_up_aggressively
)
14242 : BVAR (current_buffer
, scroll_down_aggressively
);
14244 if (!MINI_WINDOW_P (w
)
14245 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14249 /* Setting scroll-conservatively overrides
14250 scroll-*-aggressively. */
14251 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14253 double float_amount
= XFLOATINT (aggressive
);
14255 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14256 if (pt_offset
== 0 && float_amount
> 0)
14261 /* Compute how much to move the window start backward from
14262 point so that point will be displayed where the user
14266 centering_position
= it
.last_visible_y
;
14268 centering_position
-= pt_offset
;
14269 centering_position
-=
14270 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14271 /* Don't let point enter the scroll margin near top of
14273 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14274 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14277 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14280 /* Set the window start half the height of the window backward
14282 centering_position
= window_box_height (w
) / 2;
14284 move_it_vertically_backward (&it
, centering_position
);
14286 xassert (IT_CHARPOS (it
) >= BEGV
);
14288 /* The function move_it_vertically_backward may move over more
14289 than the specified y-distance. If it->w is small, e.g. a
14290 mini-buffer window, we may end up in front of the window's
14291 display area. Start displaying at the start of the line
14292 containing PT in this case. */
14293 if (it
.current_y
<= 0)
14295 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14296 move_it_vertically_backward (&it
, 0);
14300 it
.current_x
= it
.hpos
= 0;
14302 /* Set the window start position here explicitly, to avoid an
14303 infinite loop in case the functions in window-scroll-functions
14305 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14307 /* Run scroll hooks. */
14308 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14310 /* Redisplay the window. */
14311 if (!current_matrix_up_to_date_p
14312 || windows_or_buffers_changed
14313 || cursor_type_changed
14314 /* Don't use try_window_reusing_current_matrix in this case
14315 because it can have changed the buffer. */
14316 || !NILP (Vwindow_scroll_functions
)
14317 || !just_this_one_p
14318 || MINI_WINDOW_P (w
)
14319 || !(used_current_matrix_p
14320 = try_window_reusing_current_matrix (w
)))
14321 try_window (window
, startp
, 0);
14323 /* If new fonts have been loaded (due to fontsets), give up. We
14324 have to start a new redisplay since we need to re-adjust glyph
14326 if (fonts_changed_p
)
14327 goto need_larger_matrices
;
14329 /* If cursor did not appear assume that the middle of the window is
14330 in the first line of the window. Do it again with the next line.
14331 (Imagine a window of height 100, displaying two lines of height
14332 60. Moving back 50 from it->last_visible_y will end in the first
14334 if (w
->cursor
.vpos
< 0)
14336 if (!NILP (w
->window_end_valid
)
14337 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14339 clear_glyph_matrix (w
->desired_matrix
);
14340 move_it_by_lines (&it
, 1);
14341 try_window (window
, it
.current
.pos
, 0);
14343 else if (PT
< IT_CHARPOS (it
))
14345 clear_glyph_matrix (w
->desired_matrix
);
14346 move_it_by_lines (&it
, -1);
14347 try_window (window
, it
.current
.pos
, 0);
14351 /* Not much we can do about it. */
14355 /* Consider the following case: Window starts at BEGV, there is
14356 invisible, intangible text at BEGV, so that display starts at
14357 some point START > BEGV. It can happen that we are called with
14358 PT somewhere between BEGV and START. Try to handle that case. */
14359 if (w
->cursor
.vpos
< 0)
14361 struct glyph_row
*row
= w
->current_matrix
->rows
;
14362 if (row
->mode_line_p
)
14364 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14367 if (!cursor_row_fully_visible_p (w
, 0, 0))
14369 /* If vscroll is enabled, disable it and try again. */
14373 clear_glyph_matrix (w
->desired_matrix
);
14377 /* If centering point failed to make the whole line visible,
14378 put point at the top instead. That has to make the whole line
14379 visible, if it can be done. */
14380 if (centering_position
== 0)
14383 clear_glyph_matrix (w
->desired_matrix
);
14384 centering_position
= 0;
14390 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14391 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14392 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14395 /* Display the mode line, if we must. */
14396 if ((update_mode_line
14397 /* If window not full width, must redo its mode line
14398 if (a) the window to its side is being redone and
14399 (b) we do a frame-based redisplay. This is a consequence
14400 of how inverted lines are drawn in frame-based redisplay. */
14401 || (!just_this_one_p
14402 && !FRAME_WINDOW_P (f
)
14403 && !WINDOW_FULL_WIDTH_P (w
))
14404 /* Line number to display. */
14405 || INTEGERP (w
->base_line_pos
)
14406 /* Column number is displayed and different from the one displayed. */
14407 || (!NILP (w
->column_number_displayed
)
14408 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14409 /* This means that the window has a mode line. */
14410 && (WINDOW_WANTS_MODELINE_P (w
)
14411 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14413 display_mode_lines (w
);
14415 /* If mode line height has changed, arrange for a thorough
14416 immediate redisplay using the correct mode line height. */
14417 if (WINDOW_WANTS_MODELINE_P (w
)
14418 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14420 fonts_changed_p
= 1;
14421 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14422 = DESIRED_MODE_LINE_HEIGHT (w
);
14425 /* If header line height has changed, arrange for a thorough
14426 immediate redisplay using the correct header line height. */
14427 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14428 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14430 fonts_changed_p
= 1;
14431 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14432 = DESIRED_HEADER_LINE_HEIGHT (w
);
14435 if (fonts_changed_p
)
14436 goto need_larger_matrices
;
14439 if (!line_number_displayed
14440 && !BUFFERP (w
->base_line_pos
))
14442 w
->base_line_pos
= Qnil
;
14443 w
->base_line_number
= Qnil
;
14448 /* When we reach a frame's selected window, redo the frame's menu bar. */
14449 if (update_mode_line
14450 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14452 int redisplay_menu_p
= 0;
14454 if (FRAME_WINDOW_P (f
))
14456 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14457 || defined (HAVE_NS) || defined (USE_GTK)
14458 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14460 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14464 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14466 if (redisplay_menu_p
)
14467 display_menu_bar (w
);
14469 #ifdef HAVE_WINDOW_SYSTEM
14470 if (FRAME_WINDOW_P (f
))
14472 #if defined (USE_GTK) || defined (HAVE_NS)
14473 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14474 redisplay_tool_bar (f
);
14476 if (WINDOWP (f
->tool_bar_window
)
14477 && (FRAME_TOOL_BAR_LINES (f
) > 0
14478 || !NILP (Vauto_resize_tool_bars
))
14479 && redisplay_tool_bar (f
))
14480 ignore_mouse_drag_p
= 1;
14486 #ifdef HAVE_WINDOW_SYSTEM
14487 if (FRAME_WINDOW_P (f
)
14488 && update_window_fringes (w
, (just_this_one_p
14489 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14490 || w
->pseudo_window_p
)))
14494 if (draw_window_fringes (w
, 1))
14495 x_draw_vertical_border (w
);
14499 #endif /* HAVE_WINDOW_SYSTEM */
14501 /* We go to this label, with fonts_changed_p nonzero,
14502 if it is necessary to try again using larger glyph matrices.
14503 We have to redeem the scroll bar even in this case,
14504 because the loop in redisplay_internal expects that. */
14505 need_larger_matrices
:
14507 finish_scroll_bars
:
14509 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14511 /* Set the thumb's position and size. */
14512 set_vertical_scroll_bar (w
);
14514 /* Note that we actually used the scroll bar attached to this
14515 window, so it shouldn't be deleted at the end of redisplay. */
14516 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14517 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14520 /* Restore current_buffer and value of point in it. The window
14521 update may have changed the buffer, so first make sure `opoint'
14522 is still valid (Bug#6177). */
14523 if (CHARPOS (opoint
) < BEGV
)
14524 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14525 else if (CHARPOS (opoint
) > ZV
)
14526 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14528 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14530 set_buffer_internal_1 (old
);
14531 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14532 shorter. This can be caused by log truncation in *Messages*. */
14533 if (CHARPOS (lpoint
) <= ZV
)
14534 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14536 unbind_to (count
, Qnil
);
14540 /* Build the complete desired matrix of WINDOW with a window start
14541 buffer position POS.
14543 Value is 1 if successful. It is zero if fonts were loaded during
14544 redisplay which makes re-adjusting glyph matrices necessary, and -1
14545 if point would appear in the scroll margins.
14546 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14547 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14551 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14553 struct window
*w
= XWINDOW (window
);
14555 struct glyph_row
*last_text_row
= NULL
;
14556 struct frame
*f
= XFRAME (w
->frame
);
14558 /* Make POS the new window start. */
14559 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14561 /* Mark cursor position as unknown. No overlay arrow seen. */
14562 w
->cursor
.vpos
= -1;
14563 overlay_arrow_seen
= 0;
14565 /* Initialize iterator and info to start at POS. */
14566 start_display (&it
, w
, pos
);
14568 /* Display all lines of W. */
14569 while (it
.current_y
< it
.last_visible_y
)
14571 if (display_line (&it
))
14572 last_text_row
= it
.glyph_row
- 1;
14573 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14577 /* Don't let the cursor end in the scroll margins. */
14578 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14579 && !MINI_WINDOW_P (w
))
14581 int this_scroll_margin
;
14583 if (scroll_margin
> 0)
14585 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14586 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14589 this_scroll_margin
= 0;
14591 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14592 && w
->cursor
.y
< this_scroll_margin
14593 && CHARPOS (pos
) > BEGV
14594 && IT_CHARPOS (it
) < ZV
)
14595 /* rms: considering make_cursor_line_fully_visible_p here
14596 seems to give wrong results. We don't want to recenter
14597 when the last line is partly visible, we want to allow
14598 that case to be handled in the usual way. */
14599 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14601 w
->cursor
.vpos
= -1;
14602 clear_glyph_matrix (w
->desired_matrix
);
14607 /* If bottom moved off end of frame, change mode line percentage. */
14608 if (XFASTINT (w
->window_end_pos
) <= 0
14609 && Z
!= IT_CHARPOS (it
))
14610 w
->update_mode_line
= Qt
;
14612 /* Set window_end_pos to the offset of the last character displayed
14613 on the window from the end of current_buffer. Set
14614 window_end_vpos to its row number. */
14617 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14618 w
->window_end_bytepos
14619 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14621 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14623 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14624 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14625 ->displays_text_p
);
14629 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14630 w
->window_end_pos
= make_number (Z
- ZV
);
14631 w
->window_end_vpos
= make_number (0);
14634 /* But that is not valid info until redisplay finishes. */
14635 w
->window_end_valid
= Qnil
;
14641 /************************************************************************
14642 Window redisplay reusing current matrix when buffer has not changed
14643 ************************************************************************/
14645 /* Try redisplay of window W showing an unchanged buffer with a
14646 different window start than the last time it was displayed by
14647 reusing its current matrix. Value is non-zero if successful.
14648 W->start is the new window start. */
14651 try_window_reusing_current_matrix (struct window
*w
)
14653 struct frame
*f
= XFRAME (w
->frame
);
14654 struct glyph_row
*bottom_row
;
14657 struct text_pos start
, new_start
;
14658 int nrows_scrolled
, i
;
14659 struct glyph_row
*last_text_row
;
14660 struct glyph_row
*last_reused_text_row
;
14661 struct glyph_row
*start_row
;
14662 int start_vpos
, min_y
, max_y
;
14665 if (inhibit_try_window_reusing
)
14669 if (/* This function doesn't handle terminal frames. */
14670 !FRAME_WINDOW_P (f
)
14671 /* Don't try to reuse the display if windows have been split
14673 || windows_or_buffers_changed
14674 || cursor_type_changed
)
14677 /* Can't do this if region may have changed. */
14678 if ((!NILP (Vtransient_mark_mode
)
14679 && !NILP (BVAR (current_buffer
, mark_active
)))
14680 || !NILP (w
->region_showing
)
14681 || !NILP (Vshow_trailing_whitespace
))
14684 /* If top-line visibility has changed, give up. */
14685 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14686 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14689 /* Give up if old or new display is scrolled vertically. We could
14690 make this function handle this, but right now it doesn't. */
14691 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14692 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14695 /* The variable new_start now holds the new window start. The old
14696 start `start' can be determined from the current matrix. */
14697 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14698 start
= start_row
->minpos
;
14699 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14701 /* Clear the desired matrix for the display below. */
14702 clear_glyph_matrix (w
->desired_matrix
);
14704 if (CHARPOS (new_start
) <= CHARPOS (start
))
14706 /* Don't use this method if the display starts with an ellipsis
14707 displayed for invisible text. It's not easy to handle that case
14708 below, and it's certainly not worth the effort since this is
14709 not a frequent case. */
14710 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14713 IF_DEBUG (debug_method_add (w
, "twu1"));
14715 /* Display up to a row that can be reused. The variable
14716 last_text_row is set to the last row displayed that displays
14717 text. Note that it.vpos == 0 if or if not there is a
14718 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14719 start_display (&it
, w
, new_start
);
14720 w
->cursor
.vpos
= -1;
14721 last_text_row
= last_reused_text_row
= NULL
;
14723 while (it
.current_y
< it
.last_visible_y
14724 && !fonts_changed_p
)
14726 /* If we have reached into the characters in the START row,
14727 that means the line boundaries have changed. So we
14728 can't start copying with the row START. Maybe it will
14729 work to start copying with the following row. */
14730 while (IT_CHARPOS (it
) > CHARPOS (start
))
14732 /* Advance to the next row as the "start". */
14734 start
= start_row
->minpos
;
14735 /* If there are no more rows to try, or just one, give up. */
14736 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14737 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14738 || CHARPOS (start
) == ZV
)
14740 clear_glyph_matrix (w
->desired_matrix
);
14744 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14746 /* If we have reached alignment,
14747 we can copy the rest of the rows. */
14748 if (IT_CHARPOS (it
) == CHARPOS (start
))
14751 if (display_line (&it
))
14752 last_text_row
= it
.glyph_row
- 1;
14755 /* A value of current_y < last_visible_y means that we stopped
14756 at the previous window start, which in turn means that we
14757 have at least one reusable row. */
14758 if (it
.current_y
< it
.last_visible_y
)
14760 struct glyph_row
*row
;
14762 /* IT.vpos always starts from 0; it counts text lines. */
14763 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14765 /* Find PT if not already found in the lines displayed. */
14766 if (w
->cursor
.vpos
< 0)
14768 int dy
= it
.current_y
- start_row
->y
;
14770 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14771 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14773 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14774 dy
, nrows_scrolled
);
14777 clear_glyph_matrix (w
->desired_matrix
);
14782 /* Scroll the display. Do it before the current matrix is
14783 changed. The problem here is that update has not yet
14784 run, i.e. part of the current matrix is not up to date.
14785 scroll_run_hook will clear the cursor, and use the
14786 current matrix to get the height of the row the cursor is
14788 run
.current_y
= start_row
->y
;
14789 run
.desired_y
= it
.current_y
;
14790 run
.height
= it
.last_visible_y
- it
.current_y
;
14792 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14795 FRAME_RIF (f
)->update_window_begin_hook (w
);
14796 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14797 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14798 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14802 /* Shift current matrix down by nrows_scrolled lines. */
14803 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14804 rotate_matrix (w
->current_matrix
,
14806 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14809 /* Disable lines that must be updated. */
14810 for (i
= 0; i
< nrows_scrolled
; ++i
)
14811 (start_row
+ i
)->enabled_p
= 0;
14813 /* Re-compute Y positions. */
14814 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14815 max_y
= it
.last_visible_y
;
14816 for (row
= start_row
+ nrows_scrolled
;
14820 row
->y
= it
.current_y
;
14821 row
->visible_height
= row
->height
;
14823 if (row
->y
< min_y
)
14824 row
->visible_height
-= min_y
- row
->y
;
14825 if (row
->y
+ row
->height
> max_y
)
14826 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14827 row
->redraw_fringe_bitmaps_p
= 1;
14829 it
.current_y
+= row
->height
;
14831 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14832 last_reused_text_row
= row
;
14833 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14837 /* Disable lines in the current matrix which are now
14838 below the window. */
14839 for (++row
; row
< bottom_row
; ++row
)
14840 row
->enabled_p
= row
->mode_line_p
= 0;
14843 /* Update window_end_pos etc.; last_reused_text_row is the last
14844 reused row from the current matrix containing text, if any.
14845 The value of last_text_row is the last displayed line
14846 containing text. */
14847 if (last_reused_text_row
)
14849 w
->window_end_bytepos
14850 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14852 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14854 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14855 w
->current_matrix
));
14857 else if (last_text_row
)
14859 w
->window_end_bytepos
14860 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14862 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14864 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14868 /* This window must be completely empty. */
14869 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14870 w
->window_end_pos
= make_number (Z
- ZV
);
14871 w
->window_end_vpos
= make_number (0);
14873 w
->window_end_valid
= Qnil
;
14875 /* Update hint: don't try scrolling again in update_window. */
14876 w
->desired_matrix
->no_scrolling_p
= 1;
14879 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14883 else if (CHARPOS (new_start
) > CHARPOS (start
))
14885 struct glyph_row
*pt_row
, *row
;
14886 struct glyph_row
*first_reusable_row
;
14887 struct glyph_row
*first_row_to_display
;
14889 int yb
= window_text_bottom_y (w
);
14891 /* Find the row starting at new_start, if there is one. Don't
14892 reuse a partially visible line at the end. */
14893 first_reusable_row
= start_row
;
14894 while (first_reusable_row
->enabled_p
14895 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14896 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14897 < CHARPOS (new_start
)))
14898 ++first_reusable_row
;
14900 /* Give up if there is no row to reuse. */
14901 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14902 || !first_reusable_row
->enabled_p
14903 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14904 != CHARPOS (new_start
)))
14907 /* We can reuse fully visible rows beginning with
14908 first_reusable_row to the end of the window. Set
14909 first_row_to_display to the first row that cannot be reused.
14910 Set pt_row to the row containing point, if there is any. */
14912 for (first_row_to_display
= first_reusable_row
;
14913 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14914 ++first_row_to_display
)
14916 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14917 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14918 pt_row
= first_row_to_display
;
14921 /* Start displaying at the start of first_row_to_display. */
14922 xassert (first_row_to_display
->y
< yb
);
14923 init_to_row_start (&it
, w
, first_row_to_display
);
14925 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14927 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14929 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14930 + WINDOW_HEADER_LINE_HEIGHT (w
));
14932 /* Display lines beginning with first_row_to_display in the
14933 desired matrix. Set last_text_row to the last row displayed
14934 that displays text. */
14935 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14936 if (pt_row
== NULL
)
14937 w
->cursor
.vpos
= -1;
14938 last_text_row
= NULL
;
14939 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14940 if (display_line (&it
))
14941 last_text_row
= it
.glyph_row
- 1;
14943 /* If point is in a reused row, adjust y and vpos of the cursor
14947 w
->cursor
.vpos
-= nrows_scrolled
;
14948 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14951 /* Give up if point isn't in a row displayed or reused. (This
14952 also handles the case where w->cursor.vpos < nrows_scrolled
14953 after the calls to display_line, which can happen with scroll
14954 margins. See bug#1295.) */
14955 if (w
->cursor
.vpos
< 0)
14957 clear_glyph_matrix (w
->desired_matrix
);
14961 /* Scroll the display. */
14962 run
.current_y
= first_reusable_row
->y
;
14963 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14964 run
.height
= it
.last_visible_y
- run
.current_y
;
14965 dy
= run
.current_y
- run
.desired_y
;
14970 FRAME_RIF (f
)->update_window_begin_hook (w
);
14971 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14972 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14973 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14977 /* Adjust Y positions of reused rows. */
14978 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14979 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14980 max_y
= it
.last_visible_y
;
14981 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14984 row
->visible_height
= row
->height
;
14985 if (row
->y
< min_y
)
14986 row
->visible_height
-= min_y
- row
->y
;
14987 if (row
->y
+ row
->height
> max_y
)
14988 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14989 row
->redraw_fringe_bitmaps_p
= 1;
14992 /* Scroll the current matrix. */
14993 xassert (nrows_scrolled
> 0);
14994 rotate_matrix (w
->current_matrix
,
14996 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14999 /* Disable rows not reused. */
15000 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15001 row
->enabled_p
= 0;
15003 /* Point may have moved to a different line, so we cannot assume that
15004 the previous cursor position is valid; locate the correct row. */
15007 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15008 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15012 w
->cursor
.y
= row
->y
;
15014 if (row
< bottom_row
)
15016 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15017 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15019 /* Can't use this optimization with bidi-reordered glyph
15020 rows, unless cursor is already at point. */
15021 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15023 if (!(w
->cursor
.hpos
>= 0
15024 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15025 && BUFFERP (glyph
->object
)
15026 && glyph
->charpos
== PT
))
15031 && (!BUFFERP (glyph
->object
)
15032 || glyph
->charpos
< PT
);
15036 w
->cursor
.x
+= glyph
->pixel_width
;
15041 /* Adjust window end. A null value of last_text_row means that
15042 the window end is in reused rows which in turn means that
15043 only its vpos can have changed. */
15046 w
->window_end_bytepos
15047 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15049 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15051 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15056 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15059 w
->window_end_valid
= Qnil
;
15060 w
->desired_matrix
->no_scrolling_p
= 1;
15063 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15073 /************************************************************************
15074 Window redisplay reusing current matrix when buffer has changed
15075 ************************************************************************/
15077 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15078 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15079 EMACS_INT
*, EMACS_INT
*);
15080 static struct glyph_row
*
15081 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15082 struct glyph_row
*);
15085 /* Return the last row in MATRIX displaying text. If row START is
15086 non-null, start searching with that row. IT gives the dimensions
15087 of the display. Value is null if matrix is empty; otherwise it is
15088 a pointer to the row found. */
15090 static struct glyph_row
*
15091 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15092 struct glyph_row
*start
)
15094 struct glyph_row
*row
, *row_found
;
15096 /* Set row_found to the last row in IT->w's current matrix
15097 displaying text. The loop looks funny but think of partially
15100 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15101 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15103 xassert (row
->enabled_p
);
15105 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15114 /* Return the last row in the current matrix of W that is not affected
15115 by changes at the start of current_buffer that occurred since W's
15116 current matrix was built. Value is null if no such row exists.
15118 BEG_UNCHANGED us the number of characters unchanged at the start of
15119 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15120 first changed character in current_buffer. Characters at positions <
15121 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15122 when the current matrix was built. */
15124 static struct glyph_row
*
15125 find_last_unchanged_at_beg_row (struct window
*w
)
15127 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15128 struct glyph_row
*row
;
15129 struct glyph_row
*row_found
= NULL
;
15130 int yb
= window_text_bottom_y (w
);
15132 /* Find the last row displaying unchanged text. */
15133 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15134 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15135 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15138 if (/* If row ends before first_changed_pos, it is unchanged,
15139 except in some case. */
15140 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15141 /* When row ends in ZV and we write at ZV it is not
15143 && !row
->ends_at_zv_p
15144 /* When first_changed_pos is the end of a continued line,
15145 row is not unchanged because it may be no longer
15147 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15148 && (row
->continued_p
15149 || row
->exact_window_width_line_p
)))
15152 /* Stop if last visible row. */
15153 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15161 /* Find the first glyph row in the current matrix of W that is not
15162 affected by changes at the end of current_buffer since the
15163 time W's current matrix was built.
15165 Return in *DELTA the number of chars by which buffer positions in
15166 unchanged text at the end of current_buffer must be adjusted.
15168 Return in *DELTA_BYTES the corresponding number of bytes.
15170 Value is null if no such row exists, i.e. all rows are affected by
15173 static struct glyph_row
*
15174 find_first_unchanged_at_end_row (struct window
*w
,
15175 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15177 struct glyph_row
*row
;
15178 struct glyph_row
*row_found
= NULL
;
15180 *delta
= *delta_bytes
= 0;
15182 /* Display must not have been paused, otherwise the current matrix
15183 is not up to date. */
15184 eassert (!NILP (w
->window_end_valid
));
15186 /* A value of window_end_pos >= END_UNCHANGED means that the window
15187 end is in the range of changed text. If so, there is no
15188 unchanged row at the end of W's current matrix. */
15189 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15192 /* Set row to the last row in W's current matrix displaying text. */
15193 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15195 /* If matrix is entirely empty, no unchanged row exists. */
15196 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15198 /* The value of row is the last glyph row in the matrix having a
15199 meaningful buffer position in it. The end position of row
15200 corresponds to window_end_pos. This allows us to translate
15201 buffer positions in the current matrix to current buffer
15202 positions for characters not in changed text. */
15204 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15205 EMACS_INT Z_BYTE_old
=
15206 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15207 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15208 struct glyph_row
*first_text_row
15209 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15211 *delta
= Z
- Z_old
;
15212 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15214 /* Set last_unchanged_pos to the buffer position of the last
15215 character in the buffer that has not been changed. Z is the
15216 index + 1 of the last character in current_buffer, i.e. by
15217 subtracting END_UNCHANGED we get the index of the last
15218 unchanged character, and we have to add BEG to get its buffer
15220 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15221 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15223 /* Search backward from ROW for a row displaying a line that
15224 starts at a minimum position >= last_unchanged_pos_old. */
15225 for (; row
> first_text_row
; --row
)
15227 /* This used to abort, but it can happen.
15228 It is ok to just stop the search instead here. KFS. */
15229 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15232 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15237 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15243 /* Make sure that glyph rows in the current matrix of window W
15244 reference the same glyph memory as corresponding rows in the
15245 frame's frame matrix. This function is called after scrolling W's
15246 current matrix on a terminal frame in try_window_id and
15247 try_window_reusing_current_matrix. */
15250 sync_frame_with_window_matrix_rows (struct window
*w
)
15252 struct frame
*f
= XFRAME (w
->frame
);
15253 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15255 /* Preconditions: W must be a leaf window and full-width. Its frame
15256 must have a frame matrix. */
15257 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15258 xassert (WINDOW_FULL_WIDTH_P (w
));
15259 xassert (!FRAME_WINDOW_P (f
));
15261 /* If W is a full-width window, glyph pointers in W's current matrix
15262 have, by definition, to be the same as glyph pointers in the
15263 corresponding frame matrix. Note that frame matrices have no
15264 marginal areas (see build_frame_matrix). */
15265 window_row
= w
->current_matrix
->rows
;
15266 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15267 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15268 while (window_row
< window_row_end
)
15270 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15271 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15273 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15274 frame_row
->glyphs
[TEXT_AREA
] = start
;
15275 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15276 frame_row
->glyphs
[LAST_AREA
] = end
;
15278 /* Disable frame rows whose corresponding window rows have
15279 been disabled in try_window_id. */
15280 if (!window_row
->enabled_p
)
15281 frame_row
->enabled_p
= 0;
15283 ++window_row
, ++frame_row
;
15288 /* Find the glyph row in window W containing CHARPOS. Consider all
15289 rows between START and END (not inclusive). END null means search
15290 all rows to the end of the display area of W. Value is the row
15291 containing CHARPOS or null. */
15294 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15295 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15297 struct glyph_row
*row
= start
;
15298 struct glyph_row
*best_row
= NULL
;
15299 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15302 /* If we happen to start on a header-line, skip that. */
15303 if (row
->mode_line_p
)
15306 if ((end
&& row
>= end
) || !row
->enabled_p
)
15309 last_y
= window_text_bottom_y (w
) - dy
;
15313 /* Give up if we have gone too far. */
15314 if (end
&& row
>= end
)
15316 /* This formerly returned if they were equal.
15317 I think that both quantities are of a "last plus one" type;
15318 if so, when they are equal, the row is within the screen. -- rms. */
15319 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15322 /* If it is in this row, return this row. */
15323 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15324 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15325 /* The end position of a row equals the start
15326 position of the next row. If CHARPOS is there, we
15327 would rather display it in the next line, except
15328 when this line ends in ZV. */
15329 && !row
->ends_at_zv_p
15330 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15331 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15335 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15336 || (!best_row
&& !row
->continued_p
))
15338 /* In bidi-reordered rows, there could be several rows
15339 occluding point, all of them belonging to the same
15340 continued line. We need to find the row which fits
15341 CHARPOS the best. */
15342 for (g
= row
->glyphs
[TEXT_AREA
];
15343 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15346 if (!STRINGP (g
->object
))
15348 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15350 mindif
= eabs (g
->charpos
- charpos
);
15352 /* Exact match always wins. */
15359 else if (best_row
&& !row
->continued_p
)
15366 /* Try to redisplay window W by reusing its existing display. W's
15367 current matrix must be up to date when this function is called,
15368 i.e. window_end_valid must not be nil.
15372 1 if display has been updated
15373 0 if otherwise unsuccessful
15374 -1 if redisplay with same window start is known not to succeed
15376 The following steps are performed:
15378 1. Find the last row in the current matrix of W that is not
15379 affected by changes at the start of current_buffer. If no such row
15382 2. Find the first row in W's current matrix that is not affected by
15383 changes at the end of current_buffer. Maybe there is no such row.
15385 3. Display lines beginning with the row + 1 found in step 1 to the
15386 row found in step 2 or, if step 2 didn't find a row, to the end of
15389 4. If cursor is not known to appear on the window, give up.
15391 5. If display stopped at the row found in step 2, scroll the
15392 display and current matrix as needed.
15394 6. Maybe display some lines at the end of W, if we must. This can
15395 happen under various circumstances, like a partially visible line
15396 becoming fully visible, or because newly displayed lines are displayed
15397 in smaller font sizes.
15399 7. Update W's window end information. */
15402 try_window_id (struct window
*w
)
15404 struct frame
*f
= XFRAME (w
->frame
);
15405 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15406 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15407 struct glyph_row
*last_unchanged_at_beg_row
;
15408 struct glyph_row
*first_unchanged_at_end_row
;
15409 struct glyph_row
*row
;
15410 struct glyph_row
*bottom_row
;
15413 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15415 struct text_pos start_pos
;
15417 int first_unchanged_at_end_vpos
= 0;
15418 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15419 struct text_pos start
;
15420 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15423 if (inhibit_try_window_id
)
15427 /* This is handy for debugging. */
15429 #define GIVE_UP(X) \
15431 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15435 #define GIVE_UP(X) return 0
15438 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15440 /* Don't use this for mini-windows because these can show
15441 messages and mini-buffers, and we don't handle that here. */
15442 if (MINI_WINDOW_P (w
))
15445 /* This flag is used to prevent redisplay optimizations. */
15446 if (windows_or_buffers_changed
|| cursor_type_changed
)
15449 /* Verify that narrowing has not changed.
15450 Also verify that we were not told to prevent redisplay optimizations.
15451 It would be nice to further
15452 reduce the number of cases where this prevents try_window_id. */
15453 if (current_buffer
->clip_changed
15454 || current_buffer
->prevent_redisplay_optimizations_p
)
15457 /* Window must either use window-based redisplay or be full width. */
15458 if (!FRAME_WINDOW_P (f
)
15459 && (!FRAME_LINE_INS_DEL_OK (f
)
15460 || !WINDOW_FULL_WIDTH_P (w
)))
15463 /* Give up if point is known NOT to appear in W. */
15464 if (PT
< CHARPOS (start
))
15467 /* Another way to prevent redisplay optimizations. */
15468 if (XFASTINT (w
->last_modified
) == 0)
15471 /* Verify that window is not hscrolled. */
15472 if (XFASTINT (w
->hscroll
) != 0)
15475 /* Verify that display wasn't paused. */
15476 if (NILP (w
->window_end_valid
))
15479 /* Can't use this if highlighting a region because a cursor movement
15480 will do more than just set the cursor. */
15481 if (!NILP (Vtransient_mark_mode
)
15482 && !NILP (BVAR (current_buffer
, mark_active
)))
15485 /* Likewise if highlighting trailing whitespace. */
15486 if (!NILP (Vshow_trailing_whitespace
))
15489 /* Likewise if showing a region. */
15490 if (!NILP (w
->region_showing
))
15493 /* Can't use this if overlay arrow position and/or string have
15495 if (overlay_arrows_changed_p ())
15498 /* When word-wrap is on, adding a space to the first word of a
15499 wrapped line can change the wrap position, altering the line
15500 above it. It might be worthwhile to handle this more
15501 intelligently, but for now just redisplay from scratch. */
15502 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15505 /* Under bidi reordering, adding or deleting a character in the
15506 beginning of a paragraph, before the first strong directional
15507 character, can change the base direction of the paragraph (unless
15508 the buffer specifies a fixed paragraph direction), which will
15509 require to redisplay the whole paragraph. It might be worthwhile
15510 to find the paragraph limits and widen the range of redisplayed
15511 lines to that, but for now just give up this optimization and
15512 redisplay from scratch. */
15513 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15514 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15517 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15518 only if buffer has really changed. The reason is that the gap is
15519 initially at Z for freshly visited files. The code below would
15520 set end_unchanged to 0 in that case. */
15521 if (MODIFF
> SAVE_MODIFF
15522 /* This seems to happen sometimes after saving a buffer. */
15523 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15525 if (GPT
- BEG
< BEG_UNCHANGED
)
15526 BEG_UNCHANGED
= GPT
- BEG
;
15527 if (Z
- GPT
< END_UNCHANGED
)
15528 END_UNCHANGED
= Z
- GPT
;
15531 /* The position of the first and last character that has been changed. */
15532 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15533 last_changed_charpos
= Z
- END_UNCHANGED
;
15535 /* If window starts after a line end, and the last change is in
15536 front of that newline, then changes don't affect the display.
15537 This case happens with stealth-fontification. Note that although
15538 the display is unchanged, glyph positions in the matrix have to
15539 be adjusted, of course. */
15540 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15541 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15542 && ((last_changed_charpos
< CHARPOS (start
)
15543 && CHARPOS (start
) == BEGV
)
15544 || (last_changed_charpos
< CHARPOS (start
) - 1
15545 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15547 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15548 struct glyph_row
*r0
;
15550 /* Compute how many chars/bytes have been added to or removed
15551 from the buffer. */
15552 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15553 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15554 Z_delta
= Z
- Z_old
;
15555 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15557 /* Give up if PT is not in the window. Note that it already has
15558 been checked at the start of try_window_id that PT is not in
15559 front of the window start. */
15560 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15563 /* If window start is unchanged, we can reuse the whole matrix
15564 as is, after adjusting glyph positions. No need to compute
15565 the window end again, since its offset from Z hasn't changed. */
15566 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15567 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15568 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15569 /* PT must not be in a partially visible line. */
15570 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15571 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15573 /* Adjust positions in the glyph matrix. */
15574 if (Z_delta
|| Z_delta_bytes
)
15576 struct glyph_row
*r1
15577 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15578 increment_matrix_positions (w
->current_matrix
,
15579 MATRIX_ROW_VPOS (r0
, current_matrix
),
15580 MATRIX_ROW_VPOS (r1
, current_matrix
),
15581 Z_delta
, Z_delta_bytes
);
15584 /* Set the cursor. */
15585 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15587 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15594 /* Handle the case that changes are all below what is displayed in
15595 the window, and that PT is in the window. This shortcut cannot
15596 be taken if ZV is visible in the window, and text has been added
15597 there that is visible in the window. */
15598 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15599 /* ZV is not visible in the window, or there are no
15600 changes at ZV, actually. */
15601 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15602 || first_changed_charpos
== last_changed_charpos
))
15604 struct glyph_row
*r0
;
15606 /* Give up if PT is not in the window. Note that it already has
15607 been checked at the start of try_window_id that PT is not in
15608 front of the window start. */
15609 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15612 /* If window start is unchanged, we can reuse the whole matrix
15613 as is, without changing glyph positions since no text has
15614 been added/removed in front of the window end. */
15615 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15616 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15617 /* PT must not be in a partially visible line. */
15618 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15619 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15621 /* We have to compute the window end anew since text
15622 could have been added/removed after it. */
15624 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15625 w
->window_end_bytepos
15626 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15628 /* Set the cursor. */
15629 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15631 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15638 /* Give up if window start is in the changed area.
15640 The condition used to read
15642 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15644 but why that was tested escapes me at the moment. */
15645 if (CHARPOS (start
) >= first_changed_charpos
15646 && CHARPOS (start
) <= last_changed_charpos
)
15649 /* Check that window start agrees with the start of the first glyph
15650 row in its current matrix. Check this after we know the window
15651 start is not in changed text, otherwise positions would not be
15653 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15654 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15657 /* Give up if the window ends in strings. Overlay strings
15658 at the end are difficult to handle, so don't try. */
15659 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15660 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15663 /* Compute the position at which we have to start displaying new
15664 lines. Some of the lines at the top of the window might be
15665 reusable because they are not displaying changed text. Find the
15666 last row in W's current matrix not affected by changes at the
15667 start of current_buffer. Value is null if changes start in the
15668 first line of window. */
15669 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15670 if (last_unchanged_at_beg_row
)
15672 /* Avoid starting to display in the moddle of a character, a TAB
15673 for instance. This is easier than to set up the iterator
15674 exactly, and it's not a frequent case, so the additional
15675 effort wouldn't really pay off. */
15676 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15677 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15678 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15679 --last_unchanged_at_beg_row
;
15681 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15684 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15686 start_pos
= it
.current
.pos
;
15688 /* Start displaying new lines in the desired matrix at the same
15689 vpos we would use in the current matrix, i.e. below
15690 last_unchanged_at_beg_row. */
15691 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15693 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15694 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15696 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15700 /* There are no reusable lines at the start of the window.
15701 Start displaying in the first text line. */
15702 start_display (&it
, w
, start
);
15703 it
.vpos
= it
.first_vpos
;
15704 start_pos
= it
.current
.pos
;
15707 /* Find the first row that is not affected by changes at the end of
15708 the buffer. Value will be null if there is no unchanged row, in
15709 which case we must redisplay to the end of the window. delta
15710 will be set to the value by which buffer positions beginning with
15711 first_unchanged_at_end_row have to be adjusted due to text
15713 first_unchanged_at_end_row
15714 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15715 IF_DEBUG (debug_delta
= delta
);
15716 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15718 /* Set stop_pos to the buffer position up to which we will have to
15719 display new lines. If first_unchanged_at_end_row != NULL, this
15720 is the buffer position of the start of the line displayed in that
15721 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15722 that we don't stop at a buffer position. */
15724 if (first_unchanged_at_end_row
)
15726 xassert (last_unchanged_at_beg_row
== NULL
15727 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15729 /* If this is a continuation line, move forward to the next one
15730 that isn't. Changes in lines above affect this line.
15731 Caution: this may move first_unchanged_at_end_row to a row
15732 not displaying text. */
15733 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15734 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15735 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15736 < it
.last_visible_y
))
15737 ++first_unchanged_at_end_row
;
15739 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15740 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15741 >= it
.last_visible_y
))
15742 first_unchanged_at_end_row
= NULL
;
15745 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15747 first_unchanged_at_end_vpos
15748 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15749 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15752 else if (last_unchanged_at_beg_row
== NULL
)
15758 /* Either there is no unchanged row at the end, or the one we have
15759 now displays text. This is a necessary condition for the window
15760 end pos calculation at the end of this function. */
15761 xassert (first_unchanged_at_end_row
== NULL
15762 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15764 debug_last_unchanged_at_beg_vpos
15765 = (last_unchanged_at_beg_row
15766 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15768 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15770 #endif /* GLYPH_DEBUG != 0 */
15773 /* Display new lines. Set last_text_row to the last new line
15774 displayed which has text on it, i.e. might end up as being the
15775 line where the window_end_vpos is. */
15776 w
->cursor
.vpos
= -1;
15777 last_text_row
= NULL
;
15778 overlay_arrow_seen
= 0;
15779 while (it
.current_y
< it
.last_visible_y
15780 && !fonts_changed_p
15781 && (first_unchanged_at_end_row
== NULL
15782 || IT_CHARPOS (it
) < stop_pos
))
15784 if (display_line (&it
))
15785 last_text_row
= it
.glyph_row
- 1;
15788 if (fonts_changed_p
)
15792 /* Compute differences in buffer positions, y-positions etc. for
15793 lines reused at the bottom of the window. Compute what we can
15795 if (first_unchanged_at_end_row
15796 /* No lines reused because we displayed everything up to the
15797 bottom of the window. */
15798 && it
.current_y
< it
.last_visible_y
)
15801 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15803 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15804 run
.current_y
= first_unchanged_at_end_row
->y
;
15805 run
.desired_y
= run
.current_y
+ dy
;
15806 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15810 delta
= delta_bytes
= dvpos
= dy
15811 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15812 first_unchanged_at_end_row
= NULL
;
15814 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15817 /* Find the cursor if not already found. We have to decide whether
15818 PT will appear on this window (it sometimes doesn't, but this is
15819 not a very frequent case.) This decision has to be made before
15820 the current matrix is altered. A value of cursor.vpos < 0 means
15821 that PT is either in one of the lines beginning at
15822 first_unchanged_at_end_row or below the window. Don't care for
15823 lines that might be displayed later at the window end; as
15824 mentioned, this is not a frequent case. */
15825 if (w
->cursor
.vpos
< 0)
15827 /* Cursor in unchanged rows at the top? */
15828 if (PT
< CHARPOS (start_pos
)
15829 && last_unchanged_at_beg_row
)
15831 row
= row_containing_pos (w
, PT
,
15832 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15833 last_unchanged_at_beg_row
+ 1, 0);
15835 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15838 /* Start from first_unchanged_at_end_row looking for PT. */
15839 else if (first_unchanged_at_end_row
)
15841 row
= row_containing_pos (w
, PT
- delta
,
15842 first_unchanged_at_end_row
, NULL
, 0);
15844 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15845 delta_bytes
, dy
, dvpos
);
15848 /* Give up if cursor was not found. */
15849 if (w
->cursor
.vpos
< 0)
15851 clear_glyph_matrix (w
->desired_matrix
);
15856 /* Don't let the cursor end in the scroll margins. */
15858 int this_scroll_margin
, cursor_height
;
15860 this_scroll_margin
= max (0, scroll_margin
);
15861 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15862 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15863 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15865 if ((w
->cursor
.y
< this_scroll_margin
15866 && CHARPOS (start
) > BEGV
)
15867 /* Old redisplay didn't take scroll margin into account at the bottom,
15868 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15869 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15870 ? cursor_height
+ this_scroll_margin
15871 : 1)) > it
.last_visible_y
)
15873 w
->cursor
.vpos
= -1;
15874 clear_glyph_matrix (w
->desired_matrix
);
15879 /* Scroll the display. Do it before changing the current matrix so
15880 that xterm.c doesn't get confused about where the cursor glyph is
15882 if (dy
&& run
.height
)
15886 if (FRAME_WINDOW_P (f
))
15888 FRAME_RIF (f
)->update_window_begin_hook (w
);
15889 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15890 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15891 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15895 /* Terminal frame. In this case, dvpos gives the number of
15896 lines to scroll by; dvpos < 0 means scroll up. */
15898 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15899 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15900 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15901 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15902 + window_internal_height (w
));
15904 #if defined (HAVE_GPM) || defined (MSDOS)
15905 x_clear_window_mouse_face (w
);
15907 /* Perform the operation on the screen. */
15910 /* Scroll last_unchanged_at_beg_row to the end of the
15911 window down dvpos lines. */
15912 set_terminal_window (f
, end
);
15914 /* On dumb terminals delete dvpos lines at the end
15915 before inserting dvpos empty lines. */
15916 if (!FRAME_SCROLL_REGION_OK (f
))
15917 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15919 /* Insert dvpos empty lines in front of
15920 last_unchanged_at_beg_row. */
15921 ins_del_lines (f
, from
, dvpos
);
15923 else if (dvpos
< 0)
15925 /* Scroll up last_unchanged_at_beg_vpos to the end of
15926 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15927 set_terminal_window (f
, end
);
15929 /* Delete dvpos lines in front of
15930 last_unchanged_at_beg_vpos. ins_del_lines will set
15931 the cursor to the given vpos and emit |dvpos| delete
15933 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15935 /* On a dumb terminal insert dvpos empty lines at the
15937 if (!FRAME_SCROLL_REGION_OK (f
))
15938 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15941 set_terminal_window (f
, 0);
15947 /* Shift reused rows of the current matrix to the right position.
15948 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15950 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15951 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15954 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15955 bottom_vpos
, dvpos
);
15956 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15959 else if (dvpos
> 0)
15961 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15962 bottom_vpos
, dvpos
);
15963 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15964 first_unchanged_at_end_vpos
+ dvpos
, 0);
15967 /* For frame-based redisplay, make sure that current frame and window
15968 matrix are in sync with respect to glyph memory. */
15969 if (!FRAME_WINDOW_P (f
))
15970 sync_frame_with_window_matrix_rows (w
);
15972 /* Adjust buffer positions in reused rows. */
15973 if (delta
|| delta_bytes
)
15974 increment_matrix_positions (current_matrix
,
15975 first_unchanged_at_end_vpos
+ dvpos
,
15976 bottom_vpos
, delta
, delta_bytes
);
15978 /* Adjust Y positions. */
15980 shift_glyph_matrix (w
, current_matrix
,
15981 first_unchanged_at_end_vpos
+ dvpos
,
15984 if (first_unchanged_at_end_row
)
15986 first_unchanged_at_end_row
+= dvpos
;
15987 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15988 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15989 first_unchanged_at_end_row
= NULL
;
15992 /* If scrolling up, there may be some lines to display at the end of
15994 last_text_row_at_end
= NULL
;
15997 /* Scrolling up can leave for example a partially visible line
15998 at the end of the window to be redisplayed. */
15999 /* Set last_row to the glyph row in the current matrix where the
16000 window end line is found. It has been moved up or down in
16001 the matrix by dvpos. */
16002 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16003 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16005 /* If last_row is the window end line, it should display text. */
16006 xassert (last_row
->displays_text_p
);
16008 /* If window end line was partially visible before, begin
16009 displaying at that line. Otherwise begin displaying with the
16010 line following it. */
16011 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16013 init_to_row_start (&it
, w
, last_row
);
16014 it
.vpos
= last_vpos
;
16015 it
.current_y
= last_row
->y
;
16019 init_to_row_end (&it
, w
, last_row
);
16020 it
.vpos
= 1 + last_vpos
;
16021 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16025 /* We may start in a continuation line. If so, we have to
16026 get the right continuation_lines_width and current_x. */
16027 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16028 it
.hpos
= it
.current_x
= 0;
16030 /* Display the rest of the lines at the window end. */
16031 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16032 while (it
.current_y
< it
.last_visible_y
16033 && !fonts_changed_p
)
16035 /* Is it always sure that the display agrees with lines in
16036 the current matrix? I don't think so, so we mark rows
16037 displayed invalid in the current matrix by setting their
16038 enabled_p flag to zero. */
16039 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16040 if (display_line (&it
))
16041 last_text_row_at_end
= it
.glyph_row
- 1;
16045 /* Update window_end_pos and window_end_vpos. */
16046 if (first_unchanged_at_end_row
16047 && !last_text_row_at_end
)
16049 /* Window end line if one of the preserved rows from the current
16050 matrix. Set row to the last row displaying text in current
16051 matrix starting at first_unchanged_at_end_row, after
16053 xassert (first_unchanged_at_end_row
->displays_text_p
);
16054 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16055 first_unchanged_at_end_row
);
16056 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16058 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16059 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16061 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16062 xassert (w
->window_end_bytepos
>= 0);
16063 IF_DEBUG (debug_method_add (w
, "A"));
16065 else if (last_text_row_at_end
)
16068 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16069 w
->window_end_bytepos
16070 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16072 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16073 xassert (w
->window_end_bytepos
>= 0);
16074 IF_DEBUG (debug_method_add (w
, "B"));
16076 else if (last_text_row
)
16078 /* We have displayed either to the end of the window or at the
16079 end of the window, i.e. the last row with text is to be found
16080 in the desired matrix. */
16082 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16083 w
->window_end_bytepos
16084 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16086 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16087 xassert (w
->window_end_bytepos
>= 0);
16089 else if (first_unchanged_at_end_row
== NULL
16090 && last_text_row
== NULL
16091 && last_text_row_at_end
== NULL
)
16093 /* Displayed to end of window, but no line containing text was
16094 displayed. Lines were deleted at the end of the window. */
16095 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16096 int vpos
= XFASTINT (w
->window_end_vpos
);
16097 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16098 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16101 row
== NULL
&& vpos
>= first_vpos
;
16102 --vpos
, --current_row
, --desired_row
)
16104 if (desired_row
->enabled_p
)
16106 if (desired_row
->displays_text_p
)
16109 else if (current_row
->displays_text_p
)
16113 xassert (row
!= NULL
);
16114 w
->window_end_vpos
= make_number (vpos
+ 1);
16115 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16116 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16117 xassert (w
->window_end_bytepos
>= 0);
16118 IF_DEBUG (debug_method_add (w
, "C"));
16123 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16124 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16126 /* Record that display has not been completed. */
16127 w
->window_end_valid
= Qnil
;
16128 w
->desired_matrix
->no_scrolling_p
= 1;
16136 /***********************************************************************
16137 More debugging support
16138 ***********************************************************************/
16142 void dump_glyph_row (struct glyph_row
*, int, int);
16143 void dump_glyph_matrix (struct glyph_matrix
*, int);
16144 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16147 /* Dump the contents of glyph matrix MATRIX on stderr.
16149 GLYPHS 0 means don't show glyph contents.
16150 GLYPHS 1 means show glyphs in short form
16151 GLYPHS > 1 means show glyphs in long form. */
16154 dump_glyph_matrix (matrix
, glyphs
)
16155 struct glyph_matrix
*matrix
;
16159 for (i
= 0; i
< matrix
->nrows
; ++i
)
16160 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16164 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16165 the glyph row and area where the glyph comes from. */
16168 dump_glyph (row
, glyph
, area
)
16169 struct glyph_row
*row
;
16170 struct glyph
*glyph
;
16173 if (glyph
->type
== CHAR_GLYPH
)
16176 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16177 glyph
- row
->glyphs
[TEXT_AREA
],
16180 (BUFFERP (glyph
->object
)
16182 : (STRINGP (glyph
->object
)
16185 glyph
->pixel_width
,
16187 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16191 glyph
->left_box_line_p
,
16192 glyph
->right_box_line_p
);
16194 else if (glyph
->type
== STRETCH_GLYPH
)
16197 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16198 glyph
- row
->glyphs
[TEXT_AREA
],
16201 (BUFFERP (glyph
->object
)
16203 : (STRINGP (glyph
->object
)
16206 glyph
->pixel_width
,
16210 glyph
->left_box_line_p
,
16211 glyph
->right_box_line_p
);
16213 else if (glyph
->type
== IMAGE_GLYPH
)
16216 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16217 glyph
- row
->glyphs
[TEXT_AREA
],
16220 (BUFFERP (glyph
->object
)
16222 : (STRINGP (glyph
->object
)
16225 glyph
->pixel_width
,
16229 glyph
->left_box_line_p
,
16230 glyph
->right_box_line_p
);
16232 else if (glyph
->type
== COMPOSITE_GLYPH
)
16235 " %5d %4c %6d %c %3d 0x%05x",
16236 glyph
- row
->glyphs
[TEXT_AREA
],
16239 (BUFFERP (glyph
->object
)
16241 : (STRINGP (glyph
->object
)
16244 glyph
->pixel_width
,
16246 if (glyph
->u
.cmp
.automatic
)
16249 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16250 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16252 glyph
->left_box_line_p
,
16253 glyph
->right_box_line_p
);
16258 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16259 GLYPHS 0 means don't show glyph contents.
16260 GLYPHS 1 means show glyphs in short form
16261 GLYPHS > 1 means show glyphs in long form. */
16264 dump_glyph_row (row
, vpos
, glyphs
)
16265 struct glyph_row
*row
;
16270 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16271 fprintf (stderr
, "======================================================================\n");
16273 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16274 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16276 MATRIX_ROW_START_CHARPOS (row
),
16277 MATRIX_ROW_END_CHARPOS (row
),
16278 row
->used
[TEXT_AREA
],
16279 row
->contains_overlapping_glyphs_p
,
16281 row
->truncated_on_left_p
,
16282 row
->truncated_on_right_p
,
16284 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16285 row
->displays_text_p
,
16288 row
->ends_in_middle_of_char_p
,
16289 row
->starts_in_middle_of_char_p
,
16295 row
->visible_height
,
16298 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16299 row
->end
.overlay_string_index
,
16300 row
->continuation_lines_width
);
16301 fprintf (stderr
, "%9d %5d\n",
16302 CHARPOS (row
->start
.string_pos
),
16303 CHARPOS (row
->end
.string_pos
));
16304 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16305 row
->end
.dpvec_index
);
16312 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16314 struct glyph
*glyph
= row
->glyphs
[area
];
16315 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16317 /* Glyph for a line end in text. */
16318 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16321 if (glyph
< glyph_end
)
16322 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16324 for (; glyph
< glyph_end
; ++glyph
)
16325 dump_glyph (row
, glyph
, area
);
16328 else if (glyphs
== 1)
16332 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16334 char *s
= (char *) alloca (row
->used
[area
] + 1);
16337 for (i
= 0; i
< row
->used
[area
]; ++i
)
16339 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16340 if (glyph
->type
== CHAR_GLYPH
16341 && glyph
->u
.ch
< 0x80
16342 && glyph
->u
.ch
>= ' ')
16343 s
[i
] = glyph
->u
.ch
;
16349 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16355 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16356 Sdump_glyph_matrix
, 0, 1, "p",
16357 doc
: /* Dump the current matrix of the selected window to stderr.
16358 Shows contents of glyph row structures. With non-nil
16359 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16360 glyphs in short form, otherwise show glyphs in long form. */)
16361 (Lisp_Object glyphs
)
16363 struct window
*w
= XWINDOW (selected_window
);
16364 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16366 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16367 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16368 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16369 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16370 fprintf (stderr
, "=============================================\n");
16371 dump_glyph_matrix (w
->current_matrix
,
16372 NILP (glyphs
) ? 0 : XINT (glyphs
));
16377 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16378 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16381 struct frame
*f
= XFRAME (selected_frame
);
16382 dump_glyph_matrix (f
->current_matrix
, 1);
16387 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16388 doc
: /* Dump glyph row ROW to stderr.
16389 GLYPH 0 means don't dump glyphs.
16390 GLYPH 1 means dump glyphs in short form.
16391 GLYPH > 1 or omitted means dump glyphs in long form. */)
16392 (Lisp_Object row
, Lisp_Object glyphs
)
16394 struct glyph_matrix
*matrix
;
16397 CHECK_NUMBER (row
);
16398 matrix
= XWINDOW (selected_window
)->current_matrix
;
16400 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16401 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16403 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16408 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16409 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16410 GLYPH 0 means don't dump glyphs.
16411 GLYPH 1 means dump glyphs in short form.
16412 GLYPH > 1 or omitted means dump glyphs in long form. */)
16413 (Lisp_Object row
, Lisp_Object glyphs
)
16415 struct frame
*sf
= SELECTED_FRAME ();
16416 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16419 CHECK_NUMBER (row
);
16421 if (vpos
>= 0 && vpos
< m
->nrows
)
16422 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16423 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16428 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16429 doc
: /* Toggle tracing of redisplay.
16430 With ARG, turn tracing on if and only if ARG is positive. */)
16434 trace_redisplay_p
= !trace_redisplay_p
;
16437 arg
= Fprefix_numeric_value (arg
);
16438 trace_redisplay_p
= XINT (arg
) > 0;
16445 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16446 doc
: /* Like `format', but print result to stderr.
16447 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16448 (size_t nargs
, Lisp_Object
*args
)
16450 Lisp_Object s
= Fformat (nargs
, args
);
16451 fprintf (stderr
, "%s", SDATA (s
));
16455 #endif /* GLYPH_DEBUG */
16459 /***********************************************************************
16460 Building Desired Matrix Rows
16461 ***********************************************************************/
16463 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16464 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16466 static struct glyph_row
*
16467 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16469 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16470 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16471 struct buffer
*old
= current_buffer
;
16472 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16473 int arrow_len
= SCHARS (overlay_arrow_string
);
16474 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16475 const unsigned char *p
;
16478 int n_glyphs_before
;
16480 set_buffer_temp (buffer
);
16481 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16482 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16483 SET_TEXT_POS (it
.position
, 0, 0);
16485 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16487 while (p
< arrow_end
)
16489 Lisp_Object face
, ilisp
;
16491 /* Get the next character. */
16493 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16496 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16497 if (! ASCII_CHAR_P (it
.c
))
16498 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16502 /* Get its face. */
16503 ilisp
= make_number (p
- arrow_string
);
16504 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16505 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16507 /* Compute its width, get its glyphs. */
16508 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16509 SET_TEXT_POS (it
.position
, -1, -1);
16510 PRODUCE_GLYPHS (&it
);
16512 /* If this character doesn't fit any more in the line, we have
16513 to remove some glyphs. */
16514 if (it
.current_x
> it
.last_visible_x
)
16516 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16521 set_buffer_temp (old
);
16522 return it
.glyph_row
;
16526 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16527 glyphs are only inserted for terminal frames since we can't really
16528 win with truncation glyphs when partially visible glyphs are
16529 involved. Which glyphs to insert is determined by
16530 produce_special_glyphs. */
16533 insert_left_trunc_glyphs (struct it
*it
)
16535 struct it truncate_it
;
16536 struct glyph
*from
, *end
, *to
, *toend
;
16538 xassert (!FRAME_WINDOW_P (it
->f
));
16540 /* Get the truncation glyphs. */
16542 truncate_it
.current_x
= 0;
16543 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16544 truncate_it
.glyph_row
= &scratch_glyph_row
;
16545 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16546 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16547 truncate_it
.object
= make_number (0);
16548 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16550 /* Overwrite glyphs from IT with truncation glyphs. */
16551 if (!it
->glyph_row
->reversed_p
)
16553 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16554 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16555 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16556 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16561 /* There may be padding glyphs left over. Overwrite them too. */
16562 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16564 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16570 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16574 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16575 that back to front. */
16576 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16577 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16578 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16579 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16581 while (from
>= end
&& to
>= toend
)
16583 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16586 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16587 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16588 while (from
>= end
&& to
>= toend
)
16593 /* Need to free some room before prepending additional
16595 int move_by
= from
- end
+ 1;
16596 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16597 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16599 for ( ; g
>= g0
; g
--)
16601 while (from
>= end
)
16603 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16609 /* Compute the pixel height and width of IT->glyph_row.
16611 Most of the time, ascent and height of a display line will be equal
16612 to the max_ascent and max_height values of the display iterator
16613 structure. This is not the case if
16615 1. We hit ZV without displaying anything. In this case, max_ascent
16616 and max_height will be zero.
16618 2. We have some glyphs that don't contribute to the line height.
16619 (The glyph row flag contributes_to_line_height_p is for future
16620 pixmap extensions).
16622 The first case is easily covered by using default values because in
16623 these cases, the line height does not really matter, except that it
16624 must not be zero. */
16627 compute_line_metrics (struct it
*it
)
16629 struct glyph_row
*row
= it
->glyph_row
;
16631 if (FRAME_WINDOW_P (it
->f
))
16633 int i
, min_y
, max_y
;
16635 /* The line may consist of one space only, that was added to
16636 place the cursor on it. If so, the row's height hasn't been
16638 if (row
->height
== 0)
16640 if (it
->max_ascent
+ it
->max_descent
== 0)
16641 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16642 row
->ascent
= it
->max_ascent
;
16643 row
->height
= it
->max_ascent
+ it
->max_descent
;
16644 row
->phys_ascent
= it
->max_phys_ascent
;
16645 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16646 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16649 /* Compute the width of this line. */
16650 row
->pixel_width
= row
->x
;
16651 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16652 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16654 xassert (row
->pixel_width
>= 0);
16655 xassert (row
->ascent
>= 0 && row
->height
> 0);
16657 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16658 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16660 /* If first line's physical ascent is larger than its logical
16661 ascent, use the physical ascent, and make the row taller.
16662 This makes accented characters fully visible. */
16663 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16664 && row
->phys_ascent
> row
->ascent
)
16666 row
->height
+= row
->phys_ascent
- row
->ascent
;
16667 row
->ascent
= row
->phys_ascent
;
16670 /* Compute how much of the line is visible. */
16671 row
->visible_height
= row
->height
;
16673 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16674 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16676 if (row
->y
< min_y
)
16677 row
->visible_height
-= min_y
- row
->y
;
16678 if (row
->y
+ row
->height
> max_y
)
16679 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16683 row
->pixel_width
= row
->used
[TEXT_AREA
];
16684 if (row
->continued_p
)
16685 row
->pixel_width
-= it
->continuation_pixel_width
;
16686 else if (row
->truncated_on_right_p
)
16687 row
->pixel_width
-= it
->truncation_pixel_width
;
16688 row
->ascent
= row
->phys_ascent
= 0;
16689 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16690 row
->extra_line_spacing
= 0;
16693 /* Compute a hash code for this row. */
16697 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16698 for (i
= 0; i
< row
->used
[area
]; ++i
)
16699 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16700 + row
->glyphs
[area
][i
].u
.val
16701 + row
->glyphs
[area
][i
].face_id
16702 + row
->glyphs
[area
][i
].padding_p
16703 + (row
->glyphs
[area
][i
].type
<< 2));
16706 it
->max_ascent
= it
->max_descent
= 0;
16707 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16711 /* Append one space to the glyph row of iterator IT if doing a
16712 window-based redisplay. The space has the same face as
16713 IT->face_id. Value is non-zero if a space was added.
16715 This function is called to make sure that there is always one glyph
16716 at the end of a glyph row that the cursor can be set on under
16717 window-systems. (If there weren't such a glyph we would not know
16718 how wide and tall a box cursor should be displayed).
16720 At the same time this space let's a nicely handle clearing to the
16721 end of the line if the row ends in italic text. */
16724 append_space_for_newline (struct it
*it
, int default_face_p
)
16726 if (FRAME_WINDOW_P (it
->f
))
16728 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16730 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16731 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16733 /* Save some values that must not be changed.
16734 Must save IT->c and IT->len because otherwise
16735 ITERATOR_AT_END_P wouldn't work anymore after
16736 append_space_for_newline has been called. */
16737 enum display_element_type saved_what
= it
->what
;
16738 int saved_c
= it
->c
, saved_len
= it
->len
;
16739 int saved_char_to_display
= it
->char_to_display
;
16740 int saved_x
= it
->current_x
;
16741 int saved_face_id
= it
->face_id
;
16742 struct text_pos saved_pos
;
16743 Lisp_Object saved_object
;
16746 saved_object
= it
->object
;
16747 saved_pos
= it
->position
;
16749 it
->what
= IT_CHARACTER
;
16750 memset (&it
->position
, 0, sizeof it
->position
);
16751 it
->object
= make_number (0);
16752 it
->c
= it
->char_to_display
= ' ';
16755 if (default_face_p
)
16756 it
->face_id
= DEFAULT_FACE_ID
;
16757 else if (it
->face_before_selective_p
)
16758 it
->face_id
= it
->saved_face_id
;
16759 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16760 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16762 PRODUCE_GLYPHS (it
);
16764 it
->override_ascent
= -1;
16765 it
->constrain_row_ascent_descent_p
= 0;
16766 it
->current_x
= saved_x
;
16767 it
->object
= saved_object
;
16768 it
->position
= saved_pos
;
16769 it
->what
= saved_what
;
16770 it
->face_id
= saved_face_id
;
16771 it
->len
= saved_len
;
16773 it
->char_to_display
= saved_char_to_display
;
16782 /* Extend the face of the last glyph in the text area of IT->glyph_row
16783 to the end of the display line. Called from display_line. If the
16784 glyph row is empty, add a space glyph to it so that we know the
16785 face to draw. Set the glyph row flag fill_line_p. If the glyph
16786 row is R2L, prepend a stretch glyph to cover the empty space to the
16787 left of the leftmost glyph. */
16790 extend_face_to_end_of_line (struct it
*it
)
16793 struct frame
*f
= it
->f
;
16795 /* If line is already filled, do nothing. Non window-system frames
16796 get a grace of one more ``pixel'' because their characters are
16797 1-``pixel'' wide, so they hit the equality too early. This grace
16798 is needed only for R2L rows that are not continued, to produce
16799 one extra blank where we could display the cursor. */
16800 if (it
->current_x
>= it
->last_visible_x
16801 + (!FRAME_WINDOW_P (f
)
16802 && it
->glyph_row
->reversed_p
16803 && !it
->glyph_row
->continued_p
))
16806 /* Face extension extends the background and box of IT->face_id
16807 to the end of the line. If the background equals the background
16808 of the frame, we don't have to do anything. */
16809 if (it
->face_before_selective_p
)
16810 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16812 face
= FACE_FROM_ID (f
, it
->face_id
);
16814 if (FRAME_WINDOW_P (f
)
16815 && it
->glyph_row
->displays_text_p
16816 && face
->box
== FACE_NO_BOX
16817 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16819 && !it
->glyph_row
->reversed_p
)
16822 /* Set the glyph row flag indicating that the face of the last glyph
16823 in the text area has to be drawn to the end of the text area. */
16824 it
->glyph_row
->fill_line_p
= 1;
16826 /* If current character of IT is not ASCII, make sure we have the
16827 ASCII face. This will be automatically undone the next time
16828 get_next_display_element returns a multibyte character. Note
16829 that the character will always be single byte in unibyte
16831 if (!ASCII_CHAR_P (it
->c
))
16833 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16836 if (FRAME_WINDOW_P (f
))
16838 /* If the row is empty, add a space with the current face of IT,
16839 so that we know which face to draw. */
16840 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16842 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16843 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16844 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16846 #ifdef HAVE_WINDOW_SYSTEM
16847 if (it
->glyph_row
->reversed_p
)
16849 /* Prepend a stretch glyph to the row, such that the
16850 rightmost glyph will be drawn flushed all the way to the
16851 right margin of the window. The stretch glyph that will
16852 occupy the empty space, if any, to the left of the
16854 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16855 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16856 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16858 int row_width
, stretch_ascent
, stretch_width
;
16859 struct text_pos saved_pos
;
16860 int saved_face_id
, saved_avoid_cursor
;
16862 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16863 row_width
+= g
->pixel_width
;
16864 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16865 if (stretch_width
> 0)
16868 (((it
->ascent
+ it
->descent
)
16869 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16870 saved_pos
= it
->position
;
16871 memset (&it
->position
, 0, sizeof it
->position
);
16872 saved_avoid_cursor
= it
->avoid_cursor_p
;
16873 it
->avoid_cursor_p
= 1;
16874 saved_face_id
= it
->face_id
;
16875 /* The last row's stretch glyph should get the default
16876 face, to avoid painting the rest of the window with
16877 the region face, if the region ends at ZV. */
16878 if (it
->glyph_row
->ends_at_zv_p
)
16879 it
->face_id
= DEFAULT_FACE_ID
;
16881 it
->face_id
= face
->id
;
16882 append_stretch_glyph (it
, make_number (0), stretch_width
,
16883 it
->ascent
+ it
->descent
, stretch_ascent
);
16884 it
->position
= saved_pos
;
16885 it
->avoid_cursor_p
= saved_avoid_cursor
;
16886 it
->face_id
= saved_face_id
;
16889 #endif /* HAVE_WINDOW_SYSTEM */
16893 /* Save some values that must not be changed. */
16894 int saved_x
= it
->current_x
;
16895 struct text_pos saved_pos
;
16896 Lisp_Object saved_object
;
16897 enum display_element_type saved_what
= it
->what
;
16898 int saved_face_id
= it
->face_id
;
16900 saved_object
= it
->object
;
16901 saved_pos
= it
->position
;
16903 it
->what
= IT_CHARACTER
;
16904 memset (&it
->position
, 0, sizeof it
->position
);
16905 it
->object
= make_number (0);
16906 it
->c
= it
->char_to_display
= ' ';
16908 /* The last row's blank glyphs should get the default face, to
16909 avoid painting the rest of the window with the region face,
16910 if the region ends at ZV. */
16911 if (it
->glyph_row
->ends_at_zv_p
)
16912 it
->face_id
= DEFAULT_FACE_ID
;
16914 it
->face_id
= face
->id
;
16916 PRODUCE_GLYPHS (it
);
16918 while (it
->current_x
<= it
->last_visible_x
)
16919 PRODUCE_GLYPHS (it
);
16921 /* Don't count these blanks really. It would let us insert a left
16922 truncation glyph below and make us set the cursor on them, maybe. */
16923 it
->current_x
= saved_x
;
16924 it
->object
= saved_object
;
16925 it
->position
= saved_pos
;
16926 it
->what
= saved_what
;
16927 it
->face_id
= saved_face_id
;
16932 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16933 trailing whitespace. */
16936 trailing_whitespace_p (EMACS_INT charpos
)
16938 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16941 while (bytepos
< ZV_BYTE
16942 && (c
= FETCH_CHAR (bytepos
),
16943 c
== ' ' || c
== '\t'))
16946 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16948 if (bytepos
!= PT_BYTE
)
16955 /* Highlight trailing whitespace, if any, in ROW. */
16958 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16960 int used
= row
->used
[TEXT_AREA
];
16964 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16965 struct glyph
*glyph
= start
+ used
- 1;
16967 if (row
->reversed_p
)
16969 /* Right-to-left rows need to be processed in the opposite
16970 direction, so swap the edge pointers. */
16972 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16975 /* Skip over glyphs inserted to display the cursor at the
16976 end of a line, for extending the face of the last glyph
16977 to the end of the line on terminals, and for truncation
16978 and continuation glyphs. */
16979 if (!row
->reversed_p
)
16981 while (glyph
>= start
16982 && glyph
->type
== CHAR_GLYPH
16983 && INTEGERP (glyph
->object
))
16988 while (glyph
<= start
16989 && glyph
->type
== CHAR_GLYPH
16990 && INTEGERP (glyph
->object
))
16994 /* If last glyph is a space or stretch, and it's trailing
16995 whitespace, set the face of all trailing whitespace glyphs in
16996 IT->glyph_row to `trailing-whitespace'. */
16997 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16998 && BUFFERP (glyph
->object
)
16999 && (glyph
->type
== STRETCH_GLYPH
17000 || (glyph
->type
== CHAR_GLYPH
17001 && glyph
->u
.ch
== ' '))
17002 && trailing_whitespace_p (glyph
->charpos
))
17004 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17008 if (!row
->reversed_p
)
17010 while (glyph
>= start
17011 && BUFFERP (glyph
->object
)
17012 && (glyph
->type
== STRETCH_GLYPH
17013 || (glyph
->type
== CHAR_GLYPH
17014 && glyph
->u
.ch
== ' ')))
17015 (glyph
--)->face_id
= face_id
;
17019 while (glyph
<= start
17020 && BUFFERP (glyph
->object
)
17021 && (glyph
->type
== STRETCH_GLYPH
17022 || (glyph
->type
== CHAR_GLYPH
17023 && glyph
->u
.ch
== ' ')))
17024 (glyph
++)->face_id
= face_id
;
17031 /* Value is non-zero if glyph row ROW should be
17032 used to hold the cursor. */
17035 cursor_row_p (struct glyph_row
*row
)
17039 if (PT
== CHARPOS (row
->end
.pos
))
17041 /* Suppose the row ends on a string.
17042 Unless the row is continued, that means it ends on a newline
17043 in the string. If it's anything other than a display string
17044 (e.g. a before-string from an overlay), we don't want the
17045 cursor there. (This heuristic seems to give the optimal
17046 behavior for the various types of multi-line strings.) */
17047 if (CHARPOS (row
->end
.string_pos
) >= 0)
17049 if (row
->continued_p
)
17053 /* Check for `display' property. */
17054 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17055 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17056 struct glyph
*glyph
;
17059 for (glyph
= end
; glyph
>= beg
; --glyph
)
17060 if (STRINGP (glyph
->object
))
17063 = Fget_char_property (make_number (PT
),
17067 && display_prop_string_p (prop
, glyph
->object
));
17072 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17074 /* If the row ends in middle of a real character,
17075 and the line is continued, we want the cursor here.
17076 That's because CHARPOS (ROW->end.pos) would equal
17077 PT if PT is before the character. */
17078 if (!row
->ends_in_ellipsis_p
)
17079 result
= row
->continued_p
;
17081 /* If the row ends in an ellipsis, then
17082 CHARPOS (ROW->end.pos) will equal point after the
17083 invisible text. We want that position to be displayed
17084 after the ellipsis. */
17087 /* If the row ends at ZV, display the cursor at the end of that
17088 row instead of at the start of the row below. */
17089 else if (row
->ends_at_zv_p
)
17100 /* Push the display property PROP so that it will be rendered at the
17101 current position in IT. Return 1 if PROP was successfully pushed,
17105 push_display_prop (struct it
*it
, Lisp_Object prop
)
17109 if (STRINGP (prop
))
17111 if (SCHARS (prop
) == 0)
17118 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17119 it
->current
.overlay_string_index
= -1;
17120 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17121 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17122 it
->method
= GET_FROM_STRING
;
17123 it
->stop_charpos
= 0;
17125 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17127 it
->method
= GET_FROM_STRETCH
;
17130 #ifdef HAVE_WINDOW_SYSTEM
17131 else if (IMAGEP (prop
))
17133 it
->what
= IT_IMAGE
;
17134 it
->image_id
= lookup_image (it
->f
, prop
);
17135 it
->method
= GET_FROM_IMAGE
;
17137 #endif /* HAVE_WINDOW_SYSTEM */
17140 pop_it (it
); /* bogus display property, give up */
17147 /* Return the character-property PROP at the current position in IT. */
17150 get_it_property (struct it
*it
, Lisp_Object prop
)
17152 Lisp_Object position
;
17154 if (STRINGP (it
->object
))
17155 position
= make_number (IT_STRING_CHARPOS (*it
));
17156 else if (BUFFERP (it
->object
))
17157 position
= make_number (IT_CHARPOS (*it
));
17161 return Fget_char_property (position
, prop
, it
->object
);
17164 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17167 handle_line_prefix (struct it
*it
)
17169 Lisp_Object prefix
;
17170 if (it
->continuation_lines_width
> 0)
17172 prefix
= get_it_property (it
, Qwrap_prefix
);
17174 prefix
= Vwrap_prefix
;
17178 prefix
= get_it_property (it
, Qline_prefix
);
17180 prefix
= Vline_prefix
;
17182 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17184 /* If the prefix is wider than the window, and we try to wrap
17185 it, it would acquire its own wrap prefix, and so on till the
17186 iterator stack overflows. So, don't wrap the prefix. */
17187 it
->line_wrap
= TRUNCATE
;
17188 it
->avoid_cursor_p
= 1;
17194 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17195 only for R2L lines from display_line, when it decides that too many
17196 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17199 unproduce_glyphs (struct it
*it
, int n
)
17201 struct glyph
*glyph
, *end
;
17203 xassert (it
->glyph_row
);
17204 xassert (it
->glyph_row
->reversed_p
);
17205 xassert (it
->area
== TEXT_AREA
);
17206 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17208 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17209 n
= it
->glyph_row
->used
[TEXT_AREA
];
17210 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17211 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17212 for ( ; glyph
< end
; glyph
++)
17213 glyph
[-n
] = *glyph
;
17216 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17217 and ROW->maxpos. */
17219 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17220 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17221 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17223 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17224 lines' rows is implemented for bidi-reordered rows. */
17226 /* ROW->minpos is the value of min_pos, the minimal buffer position
17229 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17231 /* We didn't find _any_ valid buffer positions in any of the
17232 glyphs, so we must trust the iterator's computed positions. */
17233 row
->minpos
= row
->start
.pos
;
17236 max_pos
= CHARPOS (it
->current
.pos
);
17237 max_bpos
= BYTEPOS (it
->current
.pos
);
17240 /* Here are the various use-cases for ending the row, and the
17241 corresponding values for ROW->maxpos:
17243 Line ends in a newline from buffer eol_pos + 1
17244 Line is continued from buffer max_pos + 1
17245 Line is truncated on right it->current.pos
17246 Line ends in a newline from string max_pos
17247 Line is continued from string max_pos
17248 Line is continued from display vector max_pos
17249 Line is entirely from a string min_pos == max_pos
17250 Line is entirely from a display vector min_pos == max_pos
17251 Line that ends at ZV ZV
17253 If you discover other use-cases, please add them here as
17255 if (row
->ends_at_zv_p
)
17256 row
->maxpos
= it
->current
.pos
;
17257 else if (row
->used
[TEXT_AREA
])
17259 if (row
->ends_in_newline_from_string_p
)
17260 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17261 else if (CHARPOS (it
->eol_pos
) > 0)
17262 SET_TEXT_POS (row
->maxpos
,
17263 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17264 else if (row
->continued_p
)
17266 /* If max_pos is different from IT's current position, it
17267 means IT->method does not belong to the display element
17268 at max_pos. However, it also means that the display
17269 element at max_pos was displayed in its entirety on this
17270 line, which is equivalent to saying that the next line
17271 starts at the next buffer position. */
17272 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17273 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17276 INC_BOTH (max_pos
, max_bpos
);
17277 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17280 else if (row
->truncated_on_right_p
)
17281 /* display_line already called reseat_at_next_visible_line_start,
17282 which puts the iterator at the beginning of the next line, in
17283 the logical order. */
17284 row
->maxpos
= it
->current
.pos
;
17285 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17286 /* A line that is entirely from a string/image/stretch... */
17287 row
->maxpos
= row
->minpos
;
17292 row
->maxpos
= it
->current
.pos
;
17295 /* Construct the glyph row IT->glyph_row in the desired matrix of
17296 IT->w from text at the current position of IT. See dispextern.h
17297 for an overview of struct it. Value is non-zero if
17298 IT->glyph_row displays text, as opposed to a line displaying ZV
17302 display_line (struct it
*it
)
17304 struct glyph_row
*row
= it
->glyph_row
;
17305 Lisp_Object overlay_arrow_string
;
17307 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17308 int wrap_row_used
= -1;
17309 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17310 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17311 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17312 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17313 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17315 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17316 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17318 /* We always start displaying at hpos zero even if hscrolled. */
17319 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17321 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17322 >= it
->w
->desired_matrix
->nrows
)
17324 it
->w
->nrows_scale_factor
++;
17325 fonts_changed_p
= 1;
17329 /* Is IT->w showing the region? */
17330 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17332 /* Clear the result glyph row and enable it. */
17333 prepare_desired_row (row
);
17335 row
->y
= it
->current_y
;
17336 row
->start
= it
->start
;
17337 row
->continuation_lines_width
= it
->continuation_lines_width
;
17338 row
->displays_text_p
= 1;
17339 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17340 it
->starts_in_middle_of_char_p
= 0;
17342 /* Arrange the overlays nicely for our purposes. Usually, we call
17343 display_line on only one line at a time, in which case this
17344 can't really hurt too much, or we call it on lines which appear
17345 one after another in the buffer, in which case all calls to
17346 recenter_overlay_lists but the first will be pretty cheap. */
17347 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17349 /* Move over display elements that are not visible because we are
17350 hscrolled. This may stop at an x-position < IT->first_visible_x
17351 if the first glyph is partially visible or if we hit a line end. */
17352 if (it
->current_x
< it
->first_visible_x
)
17354 this_line_min_pos
= row
->start
.pos
;
17355 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17356 MOVE_TO_POS
| MOVE_TO_X
);
17357 /* Record the smallest positions seen while we moved over
17358 display elements that are not visible. This is needed by
17359 redisplay_internal for optimizing the case where the cursor
17360 stays inside the same line. The rest of this function only
17361 considers positions that are actually displayed, so
17362 RECORD_MAX_MIN_POS will not otherwise record positions that
17363 are hscrolled to the left of the left edge of the window. */
17364 min_pos
= CHARPOS (this_line_min_pos
);
17365 min_bpos
= BYTEPOS (this_line_min_pos
);
17369 /* We only do this when not calling `move_it_in_display_line_to'
17370 above, because move_it_in_display_line_to calls
17371 handle_line_prefix itself. */
17372 handle_line_prefix (it
);
17375 /* Get the initial row height. This is either the height of the
17376 text hscrolled, if there is any, or zero. */
17377 row
->ascent
= it
->max_ascent
;
17378 row
->height
= it
->max_ascent
+ it
->max_descent
;
17379 row
->phys_ascent
= it
->max_phys_ascent
;
17380 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17381 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17383 /* Utility macro to record max and min buffer positions seen until now. */
17384 #define RECORD_MAX_MIN_POS(IT) \
17387 if (IT_CHARPOS (*(IT)) < min_pos) \
17389 min_pos = IT_CHARPOS (*(IT)); \
17390 min_bpos = IT_BYTEPOS (*(IT)); \
17392 if (IT_CHARPOS (*(IT)) > max_pos) \
17394 max_pos = IT_CHARPOS (*(IT)); \
17395 max_bpos = IT_BYTEPOS (*(IT)); \
17400 /* Loop generating characters. The loop is left with IT on the next
17401 character to display. */
17404 int n_glyphs_before
, hpos_before
, x_before
;
17406 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17408 /* Retrieve the next thing to display. Value is zero if end of
17410 if (!get_next_display_element (it
))
17412 /* Maybe add a space at the end of this line that is used to
17413 display the cursor there under X. Set the charpos of the
17414 first glyph of blank lines not corresponding to any text
17416 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17417 row
->exact_window_width_line_p
= 1;
17418 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17419 || row
->used
[TEXT_AREA
] == 0)
17421 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17422 row
->displays_text_p
= 0;
17424 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17425 && (!MINI_WINDOW_P (it
->w
)
17426 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17427 row
->indicate_empty_line_p
= 1;
17430 it
->continuation_lines_width
= 0;
17431 row
->ends_at_zv_p
= 1;
17432 /* A row that displays right-to-left text must always have
17433 its last face extended all the way to the end of line,
17434 even if this row ends in ZV, because we still write to
17435 the screen left to right. */
17436 if (row
->reversed_p
)
17437 extend_face_to_end_of_line (it
);
17441 /* Now, get the metrics of what we want to display. This also
17442 generates glyphs in `row' (which is IT->glyph_row). */
17443 n_glyphs_before
= row
->used
[TEXT_AREA
];
17446 /* Remember the line height so far in case the next element doesn't
17447 fit on the line. */
17448 if (it
->line_wrap
!= TRUNCATE
)
17450 ascent
= it
->max_ascent
;
17451 descent
= it
->max_descent
;
17452 phys_ascent
= it
->max_phys_ascent
;
17453 phys_descent
= it
->max_phys_descent
;
17455 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17457 if (IT_DISPLAYING_WHITESPACE (it
))
17463 wrap_row_used
= row
->used
[TEXT_AREA
];
17464 wrap_row_ascent
= row
->ascent
;
17465 wrap_row_height
= row
->height
;
17466 wrap_row_phys_ascent
= row
->phys_ascent
;
17467 wrap_row_phys_height
= row
->phys_height
;
17468 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17469 wrap_row_min_pos
= min_pos
;
17470 wrap_row_min_bpos
= min_bpos
;
17471 wrap_row_max_pos
= max_pos
;
17472 wrap_row_max_bpos
= max_bpos
;
17478 PRODUCE_GLYPHS (it
);
17480 /* If this display element was in marginal areas, continue with
17482 if (it
->area
!= TEXT_AREA
)
17484 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17485 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17486 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17487 row
->phys_height
= max (row
->phys_height
,
17488 it
->max_phys_ascent
+ it
->max_phys_descent
);
17489 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17490 it
->max_extra_line_spacing
);
17491 set_iterator_to_next (it
, 1);
17495 /* Does the display element fit on the line? If we truncate
17496 lines, we should draw past the right edge of the window. If
17497 we don't truncate, we want to stop so that we can display the
17498 continuation glyph before the right margin. If lines are
17499 continued, there are two possible strategies for characters
17500 resulting in more than 1 glyph (e.g. tabs): Display as many
17501 glyphs as possible in this line and leave the rest for the
17502 continuation line, or display the whole element in the next
17503 line. Original redisplay did the former, so we do it also. */
17504 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17505 hpos_before
= it
->hpos
;
17508 if (/* Not a newline. */
17510 /* Glyphs produced fit entirely in the line. */
17511 && it
->current_x
< it
->last_visible_x
)
17513 it
->hpos
+= nglyphs
;
17514 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17515 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17516 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17517 row
->phys_height
= max (row
->phys_height
,
17518 it
->max_phys_ascent
+ it
->max_phys_descent
);
17519 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17520 it
->max_extra_line_spacing
);
17521 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17522 row
->x
= x
- it
->first_visible_x
;
17523 /* Record the maximum and minimum buffer positions seen so
17524 far in glyphs that will be displayed by this row. */
17526 RECORD_MAX_MIN_POS (it
);
17531 struct glyph
*glyph
;
17533 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17535 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17536 new_x
= x
+ glyph
->pixel_width
;
17538 if (/* Lines are continued. */
17539 it
->line_wrap
!= TRUNCATE
17540 && (/* Glyph doesn't fit on the line. */
17541 new_x
> it
->last_visible_x
17542 /* Or it fits exactly on a window system frame. */
17543 || (new_x
== it
->last_visible_x
17544 && FRAME_WINDOW_P (it
->f
))))
17546 /* End of a continued line. */
17549 || (new_x
== it
->last_visible_x
17550 && FRAME_WINDOW_P (it
->f
)))
17552 /* Current glyph is the only one on the line or
17553 fits exactly on the line. We must continue
17554 the line because we can't draw the cursor
17555 after the glyph. */
17556 row
->continued_p
= 1;
17557 it
->current_x
= new_x
;
17558 it
->continuation_lines_width
+= new_x
;
17560 /* Record the maximum and minimum buffer
17561 positions seen so far in glyphs that will be
17562 displayed by this row. */
17564 RECORD_MAX_MIN_POS (it
);
17565 if (i
== nglyphs
- 1)
17567 /* If line-wrap is on, check if a previous
17568 wrap point was found. */
17569 if (wrap_row_used
> 0
17570 /* Even if there is a previous wrap
17571 point, continue the line here as
17572 usual, if (i) the previous character
17573 was a space or tab AND (ii) the
17574 current character is not. */
17576 || IT_DISPLAYING_WHITESPACE (it
)))
17579 set_iterator_to_next (it
, 1);
17580 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17582 if (!get_next_display_element (it
))
17584 row
->exact_window_width_line_p
= 1;
17585 it
->continuation_lines_width
= 0;
17586 row
->continued_p
= 0;
17587 row
->ends_at_zv_p
= 1;
17589 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17591 row
->continued_p
= 0;
17592 row
->exact_window_width_line_p
= 1;
17597 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17598 && !FRAME_WINDOW_P (it
->f
))
17600 /* A padding glyph that doesn't fit on this line.
17601 This means the whole character doesn't fit
17603 if (row
->reversed_p
)
17604 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17605 - n_glyphs_before
);
17606 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17608 /* Fill the rest of the row with continuation
17609 glyphs like in 20.x. */
17610 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17611 < row
->glyphs
[1 + TEXT_AREA
])
17612 produce_special_glyphs (it
, IT_CONTINUATION
);
17614 row
->continued_p
= 1;
17615 it
->current_x
= x_before
;
17616 it
->continuation_lines_width
+= x_before
;
17618 /* Restore the height to what it was before the
17619 element not fitting on the line. */
17620 it
->max_ascent
= ascent
;
17621 it
->max_descent
= descent
;
17622 it
->max_phys_ascent
= phys_ascent
;
17623 it
->max_phys_descent
= phys_descent
;
17625 else if (wrap_row_used
> 0)
17628 if (row
->reversed_p
)
17629 unproduce_glyphs (it
,
17630 row
->used
[TEXT_AREA
] - wrap_row_used
);
17632 it
->continuation_lines_width
+= wrap_x
;
17633 row
->used
[TEXT_AREA
] = wrap_row_used
;
17634 row
->ascent
= wrap_row_ascent
;
17635 row
->height
= wrap_row_height
;
17636 row
->phys_ascent
= wrap_row_phys_ascent
;
17637 row
->phys_height
= wrap_row_phys_height
;
17638 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17639 min_pos
= wrap_row_min_pos
;
17640 min_bpos
= wrap_row_min_bpos
;
17641 max_pos
= wrap_row_max_pos
;
17642 max_bpos
= wrap_row_max_bpos
;
17643 row
->continued_p
= 1;
17644 row
->ends_at_zv_p
= 0;
17645 row
->exact_window_width_line_p
= 0;
17646 it
->continuation_lines_width
+= x
;
17648 /* Make sure that a non-default face is extended
17649 up to the right margin of the window. */
17650 extend_face_to_end_of_line (it
);
17652 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17654 /* A TAB that extends past the right edge of the
17655 window. This produces a single glyph on
17656 window system frames. We leave the glyph in
17657 this row and let it fill the row, but don't
17658 consume the TAB. */
17659 it
->continuation_lines_width
+= it
->last_visible_x
;
17660 row
->ends_in_middle_of_char_p
= 1;
17661 row
->continued_p
= 1;
17662 glyph
->pixel_width
= it
->last_visible_x
- x
;
17663 it
->starts_in_middle_of_char_p
= 1;
17667 /* Something other than a TAB that draws past
17668 the right edge of the window. Restore
17669 positions to values before the element. */
17670 if (row
->reversed_p
)
17671 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17672 - (n_glyphs_before
+ i
));
17673 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17675 /* Display continuation glyphs. */
17676 if (!FRAME_WINDOW_P (it
->f
))
17677 produce_special_glyphs (it
, IT_CONTINUATION
);
17678 row
->continued_p
= 1;
17680 it
->current_x
= x_before
;
17681 it
->continuation_lines_width
+= x
;
17682 extend_face_to_end_of_line (it
);
17684 if (nglyphs
> 1 && i
> 0)
17686 row
->ends_in_middle_of_char_p
= 1;
17687 it
->starts_in_middle_of_char_p
= 1;
17690 /* Restore the height to what it was before the
17691 element not fitting on the line. */
17692 it
->max_ascent
= ascent
;
17693 it
->max_descent
= descent
;
17694 it
->max_phys_ascent
= phys_ascent
;
17695 it
->max_phys_descent
= phys_descent
;
17700 else if (new_x
> it
->first_visible_x
)
17702 /* Increment number of glyphs actually displayed. */
17705 /* Record the maximum and minimum buffer positions
17706 seen so far in glyphs that will be displayed by
17709 RECORD_MAX_MIN_POS (it
);
17711 if (x
< it
->first_visible_x
)
17712 /* Glyph is partially visible, i.e. row starts at
17713 negative X position. */
17714 row
->x
= x
- it
->first_visible_x
;
17718 /* Glyph is completely off the left margin of the
17719 window. This should not happen because of the
17720 move_it_in_display_line at the start of this
17721 function, unless the text display area of the
17722 window is empty. */
17723 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17727 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17728 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17729 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17730 row
->phys_height
= max (row
->phys_height
,
17731 it
->max_phys_ascent
+ it
->max_phys_descent
);
17732 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17733 it
->max_extra_line_spacing
);
17735 /* End of this display line if row is continued. */
17736 if (row
->continued_p
|| row
->ends_at_zv_p
)
17741 /* Is this a line end? If yes, we're also done, after making
17742 sure that a non-default face is extended up to the right
17743 margin of the window. */
17744 if (ITERATOR_AT_END_OF_LINE_P (it
))
17746 int used_before
= row
->used
[TEXT_AREA
];
17748 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17750 /* Add a space at the end of the line that is used to
17751 display the cursor there. */
17752 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17753 append_space_for_newline (it
, 0);
17755 /* Extend the face to the end of the line. */
17756 extend_face_to_end_of_line (it
);
17758 /* Make sure we have the position. */
17759 if (used_before
== 0)
17760 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17762 /* Record the position of the newline, for use in
17764 it
->eol_pos
= it
->current
.pos
;
17766 /* Consume the line end. This skips over invisible lines. */
17767 set_iterator_to_next (it
, 1);
17768 it
->continuation_lines_width
= 0;
17772 /* Proceed with next display element. Note that this skips
17773 over lines invisible because of selective display. */
17774 set_iterator_to_next (it
, 1);
17776 /* If we truncate lines, we are done when the last displayed
17777 glyphs reach past the right margin of the window. */
17778 if (it
->line_wrap
== TRUNCATE
17779 && (FRAME_WINDOW_P (it
->f
)
17780 ? (it
->current_x
>= it
->last_visible_x
)
17781 : (it
->current_x
> it
->last_visible_x
)))
17783 /* Maybe add truncation glyphs. */
17784 if (!FRAME_WINDOW_P (it
->f
))
17788 if (!row
->reversed_p
)
17790 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17791 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17796 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17797 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17799 /* Remove any padding glyphs at the front of ROW, to
17800 make room for the truncation glyphs we will be
17801 adding below. The loop below always inserts at
17802 least one truncation glyph, so also remove the
17803 last glyph added to ROW. */
17804 unproduce_glyphs (it
, i
+ 1);
17805 /* Adjust i for the loop below. */
17806 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17809 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17811 row
->used
[TEXT_AREA
] = i
;
17812 produce_special_glyphs (it
, IT_TRUNCATION
);
17815 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17817 /* Don't truncate if we can overflow newline into fringe. */
17818 if (!get_next_display_element (it
))
17820 it
->continuation_lines_width
= 0;
17821 row
->ends_at_zv_p
= 1;
17822 row
->exact_window_width_line_p
= 1;
17825 if (ITERATOR_AT_END_OF_LINE_P (it
))
17827 row
->exact_window_width_line_p
= 1;
17828 goto at_end_of_line
;
17832 row
->truncated_on_right_p
= 1;
17833 it
->continuation_lines_width
= 0;
17834 reseat_at_next_visible_line_start (it
, 0);
17835 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17836 it
->hpos
= hpos_before
;
17837 it
->current_x
= x_before
;
17842 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17843 at the left window margin. */
17844 if (it
->first_visible_x
17845 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17847 if (!FRAME_WINDOW_P (it
->f
))
17848 insert_left_trunc_glyphs (it
);
17849 row
->truncated_on_left_p
= 1;
17852 /* Remember the position at which this line ends.
17854 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17855 cannot be before the call to find_row_edges below, since that is
17856 where these positions are determined. */
17857 row
->end
= it
->current
;
17860 row
->minpos
= row
->start
.pos
;
17861 row
->maxpos
= row
->end
.pos
;
17865 /* ROW->minpos and ROW->maxpos must be the smallest and
17866 `1 + the largest' buffer positions in ROW. But if ROW was
17867 bidi-reordered, these two positions can be anywhere in the
17868 row, so we must determine them now. */
17869 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17872 /* If the start of this line is the overlay arrow-position, then
17873 mark this glyph row as the one containing the overlay arrow.
17874 This is clearly a mess with variable size fonts. It would be
17875 better to let it be displayed like cursors under X. */
17876 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17877 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17878 !NILP (overlay_arrow_string
)))
17880 /* Overlay arrow in window redisplay is a fringe bitmap. */
17881 if (STRINGP (overlay_arrow_string
))
17883 struct glyph_row
*arrow_row
17884 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17885 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17886 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17887 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17888 struct glyph
*p2
, *end
;
17890 /* Copy the arrow glyphs. */
17891 while (glyph
< arrow_end
)
17894 /* Throw away padding glyphs. */
17896 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17897 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17903 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17908 xassert (INTEGERP (overlay_arrow_string
));
17909 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17911 overlay_arrow_seen
= 1;
17914 /* Compute pixel dimensions of this line. */
17915 compute_line_metrics (it
);
17917 /* Record whether this row ends inside an ellipsis. */
17918 row
->ends_in_ellipsis_p
17919 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17920 && it
->ellipsis_p
);
17922 /* Save fringe bitmaps in this row. */
17923 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17924 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17925 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17926 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17928 it
->left_user_fringe_bitmap
= 0;
17929 it
->left_user_fringe_face_id
= 0;
17930 it
->right_user_fringe_bitmap
= 0;
17931 it
->right_user_fringe_face_id
= 0;
17933 /* Maybe set the cursor. */
17934 cvpos
= it
->w
->cursor
.vpos
;
17936 /* In bidi-reordered rows, keep checking for proper cursor
17937 position even if one has been found already, because buffer
17938 positions in such rows change non-linearly with ROW->VPOS,
17939 when a line is continued. One exception: when we are at ZV,
17940 display cursor on the first suitable glyph row, since all
17941 the empty rows after that also have their position set to ZV. */
17942 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17943 lines' rows is implemented for bidi-reordered rows. */
17945 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17946 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17947 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17948 && cursor_row_p (row
))
17949 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17951 /* Highlight trailing whitespace. */
17952 if (!NILP (Vshow_trailing_whitespace
))
17953 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17955 /* Prepare for the next line. This line starts horizontally at (X
17956 HPOS) = (0 0). Vertical positions are incremented. As a
17957 convenience for the caller, IT->glyph_row is set to the next
17959 it
->current_x
= it
->hpos
= 0;
17960 it
->current_y
+= row
->height
;
17961 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17964 /* The next row should by default use the same value of the
17965 reversed_p flag as this one. set_iterator_to_next decides when
17966 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17967 the flag accordingly. */
17968 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17969 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17970 it
->start
= row
->end
;
17971 return row
->displays_text_p
;
17973 #undef RECORD_MAX_MIN_POS
17976 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17977 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17978 doc
: /* Return paragraph direction at point in BUFFER.
17979 Value is either `left-to-right' or `right-to-left'.
17980 If BUFFER is omitted or nil, it defaults to the current buffer.
17982 Paragraph direction determines how the text in the paragraph is displayed.
17983 In left-to-right paragraphs, text begins at the left margin of the window
17984 and the reading direction is generally left to right. In right-to-left
17985 paragraphs, text begins at the right margin and is read from right to left.
17987 See also `bidi-paragraph-direction'. */)
17988 (Lisp_Object buffer
)
17990 struct buffer
*buf
= current_buffer
;
17991 struct buffer
*old
= buf
;
17993 if (! NILP (buffer
))
17995 CHECK_BUFFER (buffer
);
17996 buf
= XBUFFER (buffer
);
17999 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18000 return Qleft_to_right
;
18001 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18002 return BVAR (buf
, bidi_paragraph_direction
);
18005 /* Determine the direction from buffer text. We could try to
18006 use current_matrix if it is up to date, but this seems fast
18007 enough as it is. */
18008 struct bidi_it itb
;
18009 EMACS_INT pos
= BUF_PT (buf
);
18010 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18013 set_buffer_temp (buf
);
18014 /* bidi_paragraph_init finds the base direction of the paragraph
18015 by searching forward from paragraph start. We need the base
18016 direction of the current or _previous_ paragraph, so we need
18017 to make sure we are within that paragraph. To that end, find
18018 the previous non-empty line. */
18019 if (pos
>= ZV
&& pos
> BEGV
)
18022 bytepos
= CHAR_TO_BYTE (pos
);
18024 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18025 || c
== ' ' || c
== '\t' || c
== '\f')
18027 if (bytepos
<= BEGV_BYTE
)
18032 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18035 itb
.bytepos
= bytepos
;
18037 itb
.separator_limit
= -1;
18038 itb
.paragraph_dir
= NEUTRAL_DIR
;
18040 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18041 set_buffer_temp (old
);
18042 switch (itb
.paragraph_dir
)
18045 return Qleft_to_right
;
18048 return Qright_to_left
;
18058 /***********************************************************************
18060 ***********************************************************************/
18062 /* Redisplay the menu bar in the frame for window W.
18064 The menu bar of X frames that don't have X toolkit support is
18065 displayed in a special window W->frame->menu_bar_window.
18067 The menu bar of terminal frames is treated specially as far as
18068 glyph matrices are concerned. Menu bar lines are not part of
18069 windows, so the update is done directly on the frame matrix rows
18070 for the menu bar. */
18073 display_menu_bar (struct window
*w
)
18075 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18080 /* Don't do all this for graphical frames. */
18082 if (FRAME_W32_P (f
))
18085 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18091 if (FRAME_NS_P (f
))
18093 #endif /* HAVE_NS */
18095 #ifdef USE_X_TOOLKIT
18096 xassert (!FRAME_WINDOW_P (f
));
18097 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18098 it
.first_visible_x
= 0;
18099 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18100 #else /* not USE_X_TOOLKIT */
18101 if (FRAME_WINDOW_P (f
))
18103 /* Menu bar lines are displayed in the desired matrix of the
18104 dummy window menu_bar_window. */
18105 struct window
*menu_w
;
18106 xassert (WINDOWP (f
->menu_bar_window
));
18107 menu_w
= XWINDOW (f
->menu_bar_window
);
18108 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18110 it
.first_visible_x
= 0;
18111 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18115 /* This is a TTY frame, i.e. character hpos/vpos are used as
18117 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18119 it
.first_visible_x
= 0;
18120 it
.last_visible_x
= FRAME_COLS (f
);
18122 #endif /* not USE_X_TOOLKIT */
18124 if (! mode_line_inverse_video
)
18125 /* Force the menu-bar to be displayed in the default face. */
18126 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18128 /* Clear all rows of the menu bar. */
18129 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18131 struct glyph_row
*row
= it
.glyph_row
+ i
;
18132 clear_glyph_row (row
);
18133 row
->enabled_p
= 1;
18134 row
->full_width_p
= 1;
18137 /* Display all items of the menu bar. */
18138 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18139 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18141 Lisp_Object string
;
18143 /* Stop at nil string. */
18144 string
= AREF (items
, i
+ 1);
18148 /* Remember where item was displayed. */
18149 ASET (items
, i
+ 3, make_number (it
.hpos
));
18151 /* Display the item, pad with one space. */
18152 if (it
.current_x
< it
.last_visible_x
)
18153 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18154 SCHARS (string
) + 1, 0, 0, -1);
18157 /* Fill out the line with spaces. */
18158 if (it
.current_x
< it
.last_visible_x
)
18159 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18161 /* Compute the total height of the lines. */
18162 compute_line_metrics (&it
);
18167 /***********************************************************************
18169 ***********************************************************************/
18171 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18172 FORCE is non-zero, redisplay mode lines unconditionally.
18173 Otherwise, redisplay only mode lines that are garbaged. Value is
18174 the number of windows whose mode lines were redisplayed. */
18177 redisplay_mode_lines (Lisp_Object window
, int force
)
18181 while (!NILP (window
))
18183 struct window
*w
= XWINDOW (window
);
18185 if (WINDOWP (w
->hchild
))
18186 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18187 else if (WINDOWP (w
->vchild
))
18188 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18190 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18191 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18193 struct text_pos lpoint
;
18194 struct buffer
*old
= current_buffer
;
18196 /* Set the window's buffer for the mode line display. */
18197 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18198 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18200 /* Point refers normally to the selected window. For any
18201 other window, set up appropriate value. */
18202 if (!EQ (window
, selected_window
))
18204 struct text_pos pt
;
18206 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18207 if (CHARPOS (pt
) < BEGV
)
18208 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18209 else if (CHARPOS (pt
) > (ZV
- 1))
18210 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18212 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18215 /* Display mode lines. */
18216 clear_glyph_matrix (w
->desired_matrix
);
18217 if (display_mode_lines (w
))
18220 w
->must_be_updated_p
= 1;
18223 /* Restore old settings. */
18224 set_buffer_internal_1 (old
);
18225 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18235 /* Display the mode and/or header line of window W. Value is the
18236 sum number of mode lines and header lines displayed. */
18239 display_mode_lines (struct window
*w
)
18241 Lisp_Object old_selected_window
, old_selected_frame
;
18244 old_selected_frame
= selected_frame
;
18245 selected_frame
= w
->frame
;
18246 old_selected_window
= selected_window
;
18247 XSETWINDOW (selected_window
, w
);
18249 /* These will be set while the mode line specs are processed. */
18250 line_number_displayed
= 0;
18251 w
->column_number_displayed
= Qnil
;
18253 if (WINDOW_WANTS_MODELINE_P (w
))
18255 struct window
*sel_w
= XWINDOW (old_selected_window
);
18257 /* Select mode line face based on the real selected window. */
18258 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18259 BVAR (current_buffer
, mode_line_format
));
18263 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18265 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18266 BVAR (current_buffer
, header_line_format
));
18270 selected_frame
= old_selected_frame
;
18271 selected_window
= old_selected_window
;
18276 /* Display mode or header line of window W. FACE_ID specifies which
18277 line to display; it is either MODE_LINE_FACE_ID or
18278 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18279 display. Value is the pixel height of the mode/header line
18283 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18287 int count
= SPECPDL_INDEX ();
18289 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18290 /* Don't extend on a previously drawn mode-line.
18291 This may happen if called from pos_visible_p. */
18292 it
.glyph_row
->enabled_p
= 0;
18293 prepare_desired_row (it
.glyph_row
);
18295 it
.glyph_row
->mode_line_p
= 1;
18297 if (! mode_line_inverse_video
)
18298 /* Force the mode-line to be displayed in the default face. */
18299 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18301 record_unwind_protect (unwind_format_mode_line
,
18302 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18304 mode_line_target
= MODE_LINE_DISPLAY
;
18306 /* Temporarily make frame's keyboard the current kboard so that
18307 kboard-local variables in the mode_line_format will get the right
18309 push_kboard (FRAME_KBOARD (it
.f
));
18310 record_unwind_save_match_data ();
18311 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18314 unbind_to (count
, Qnil
);
18316 /* Fill up with spaces. */
18317 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18319 compute_line_metrics (&it
);
18320 it
.glyph_row
->full_width_p
= 1;
18321 it
.glyph_row
->continued_p
= 0;
18322 it
.glyph_row
->truncated_on_left_p
= 0;
18323 it
.glyph_row
->truncated_on_right_p
= 0;
18325 /* Make a 3D mode-line have a shadow at its right end. */
18326 face
= FACE_FROM_ID (it
.f
, face_id
);
18327 extend_face_to_end_of_line (&it
);
18328 if (face
->box
!= FACE_NO_BOX
)
18330 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18331 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18332 last
->right_box_line_p
= 1;
18335 return it
.glyph_row
->height
;
18338 /* Move element ELT in LIST to the front of LIST.
18339 Return the updated list. */
18342 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18344 register Lisp_Object tail
, prev
;
18345 register Lisp_Object tem
;
18349 while (CONSP (tail
))
18355 /* Splice out the link TAIL. */
18357 list
= XCDR (tail
);
18359 Fsetcdr (prev
, XCDR (tail
));
18361 /* Now make it the first. */
18362 Fsetcdr (tail
, list
);
18367 tail
= XCDR (tail
);
18371 /* Not found--return unchanged LIST. */
18375 /* Contribute ELT to the mode line for window IT->w. How it
18376 translates into text depends on its data type.
18378 IT describes the display environment in which we display, as usual.
18380 DEPTH is the depth in recursion. It is used to prevent
18381 infinite recursion here.
18383 FIELD_WIDTH is the number of characters the display of ELT should
18384 occupy in the mode line, and PRECISION is the maximum number of
18385 characters to display from ELT's representation. See
18386 display_string for details.
18388 Returns the hpos of the end of the text generated by ELT.
18390 PROPS is a property list to add to any string we encounter.
18392 If RISKY is nonzero, remove (disregard) any properties in any string
18393 we encounter, and ignore :eval and :propertize.
18395 The global variable `mode_line_target' determines whether the
18396 output is passed to `store_mode_line_noprop',
18397 `store_mode_line_string', or `display_string'. */
18400 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18401 Lisp_Object elt
, Lisp_Object props
, int risky
)
18403 int n
= 0, field
, prec
;
18408 elt
= build_string ("*too-deep*");
18412 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18416 /* A string: output it and check for %-constructs within it. */
18418 EMACS_INT offset
= 0;
18420 if (SCHARS (elt
) > 0
18421 && (!NILP (props
) || risky
))
18423 Lisp_Object oprops
, aelt
;
18424 oprops
= Ftext_properties_at (make_number (0), elt
);
18426 /* If the starting string's properties are not what
18427 we want, translate the string. Also, if the string
18428 is risky, do that anyway. */
18430 if (NILP (Fequal (props
, oprops
)) || risky
)
18432 /* If the starting string has properties,
18433 merge the specified ones onto the existing ones. */
18434 if (! NILP (oprops
) && !risky
)
18438 oprops
= Fcopy_sequence (oprops
);
18440 while (CONSP (tem
))
18442 oprops
= Fplist_put (oprops
, XCAR (tem
),
18443 XCAR (XCDR (tem
)));
18444 tem
= XCDR (XCDR (tem
));
18449 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18450 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18452 /* AELT is what we want. Move it to the front
18453 without consing. */
18455 mode_line_proptrans_alist
18456 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18462 /* If AELT has the wrong props, it is useless.
18463 so get rid of it. */
18465 mode_line_proptrans_alist
18466 = Fdelq (aelt
, mode_line_proptrans_alist
);
18468 elt
= Fcopy_sequence (elt
);
18469 Fset_text_properties (make_number (0), Flength (elt
),
18471 /* Add this item to mode_line_proptrans_alist. */
18472 mode_line_proptrans_alist
18473 = Fcons (Fcons (elt
, props
),
18474 mode_line_proptrans_alist
);
18475 /* Truncate mode_line_proptrans_alist
18476 to at most 50 elements. */
18477 tem
= Fnthcdr (make_number (50),
18478 mode_line_proptrans_alist
);
18480 XSETCDR (tem
, Qnil
);
18489 prec
= precision
- n
;
18490 switch (mode_line_target
)
18492 case MODE_LINE_NOPROP
:
18493 case MODE_LINE_TITLE
:
18494 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18496 case MODE_LINE_STRING
:
18497 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18499 case MODE_LINE_DISPLAY
:
18500 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18501 0, prec
, 0, STRING_MULTIBYTE (elt
));
18508 /* Handle the non-literal case. */
18510 while ((precision
<= 0 || n
< precision
)
18511 && SREF (elt
, offset
) != 0
18512 && (mode_line_target
!= MODE_LINE_DISPLAY
18513 || it
->current_x
< it
->last_visible_x
))
18515 EMACS_INT last_offset
= offset
;
18517 /* Advance to end of string or next format specifier. */
18518 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18521 if (offset
- 1 != last_offset
)
18523 EMACS_INT nchars
, nbytes
;
18525 /* Output to end of string or up to '%'. Field width
18526 is length of string. Don't output more than
18527 PRECISION allows us. */
18530 prec
= c_string_width (SDATA (elt
) + last_offset
,
18531 offset
- last_offset
, precision
- n
,
18534 switch (mode_line_target
)
18536 case MODE_LINE_NOPROP
:
18537 case MODE_LINE_TITLE
:
18538 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18540 case MODE_LINE_STRING
:
18542 EMACS_INT bytepos
= last_offset
;
18543 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18544 EMACS_INT endpos
= (precision
<= 0
18545 ? string_byte_to_char (elt
, offset
)
18546 : charpos
+ nchars
);
18548 n
+= store_mode_line_string (NULL
,
18549 Fsubstring (elt
, make_number (charpos
),
18550 make_number (endpos
)),
18554 case MODE_LINE_DISPLAY
:
18556 EMACS_INT bytepos
= last_offset
;
18557 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18559 if (precision
<= 0)
18560 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18561 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18563 STRING_MULTIBYTE (elt
));
18568 else /* c == '%' */
18570 EMACS_INT percent_position
= offset
;
18572 /* Get the specified minimum width. Zero means
18575 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18576 field
= field
* 10 + c
- '0';
18578 /* Don't pad beyond the total padding allowed. */
18579 if (field_width
- n
> 0 && field
> field_width
- n
)
18580 field
= field_width
- n
;
18582 /* Note that either PRECISION <= 0 or N < PRECISION. */
18583 prec
= precision
- n
;
18586 n
+= display_mode_element (it
, depth
, field
, prec
,
18587 Vglobal_mode_string
, props
,
18592 EMACS_INT bytepos
, charpos
;
18594 Lisp_Object string
;
18596 bytepos
= percent_position
;
18597 charpos
= (STRING_MULTIBYTE (elt
)
18598 ? string_byte_to_char (elt
, bytepos
)
18600 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18601 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18603 switch (mode_line_target
)
18605 case MODE_LINE_NOPROP
:
18606 case MODE_LINE_TITLE
:
18607 n
+= store_mode_line_noprop (spec
, field
, prec
);
18609 case MODE_LINE_STRING
:
18611 int len
= strlen (spec
);
18612 Lisp_Object tem
= make_string (spec
, len
);
18613 props
= Ftext_properties_at (make_number (charpos
), elt
);
18614 /* Should only keep face property in props */
18615 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18618 case MODE_LINE_DISPLAY
:
18620 int nglyphs_before
, nwritten
;
18622 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18623 nwritten
= display_string (spec
, string
, elt
,
18628 /* Assign to the glyphs written above the
18629 string where the `%x' came from, position
18633 struct glyph
*glyph
18634 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18638 for (i
= 0; i
< nwritten
; ++i
)
18640 glyph
[i
].object
= elt
;
18641 glyph
[i
].charpos
= charpos
;
18658 /* A symbol: process the value of the symbol recursively
18659 as if it appeared here directly. Avoid error if symbol void.
18660 Special case: if value of symbol is a string, output the string
18663 register Lisp_Object tem
;
18665 /* If the variable is not marked as risky to set
18666 then its contents are risky to use. */
18667 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18670 tem
= Fboundp (elt
);
18673 tem
= Fsymbol_value (elt
);
18674 /* If value is a string, output that string literally:
18675 don't check for % within it. */
18679 if (!EQ (tem
, elt
))
18681 /* Give up right away for nil or t. */
18691 register Lisp_Object car
, tem
;
18693 /* A cons cell: five distinct cases.
18694 If first element is :eval or :propertize, do something special.
18695 If first element is a string or a cons, process all the elements
18696 and effectively concatenate them.
18697 If first element is a negative number, truncate displaying cdr to
18698 at most that many characters. If positive, pad (with spaces)
18699 to at least that many characters.
18700 If first element is a symbol, process the cadr or caddr recursively
18701 according to whether the symbol's value is non-nil or nil. */
18703 if (EQ (car
, QCeval
))
18705 /* An element of the form (:eval FORM) means evaluate FORM
18706 and use the result as mode line elements. */
18711 if (CONSP (XCDR (elt
)))
18714 spec
= safe_eval (XCAR (XCDR (elt
)));
18715 n
+= display_mode_element (it
, depth
, field_width
- n
,
18716 precision
- n
, spec
, props
,
18720 else if (EQ (car
, QCpropertize
))
18722 /* An element of the form (:propertize ELT PROPS...)
18723 means display ELT but applying properties PROPS. */
18728 if (CONSP (XCDR (elt
)))
18729 n
+= display_mode_element (it
, depth
, field_width
- n
,
18730 precision
- n
, XCAR (XCDR (elt
)),
18731 XCDR (XCDR (elt
)), risky
);
18733 else if (SYMBOLP (car
))
18735 tem
= Fboundp (car
);
18739 /* elt is now the cdr, and we know it is a cons cell.
18740 Use its car if CAR has a non-nil value. */
18743 tem
= Fsymbol_value (car
);
18750 /* Symbol's value is nil (or symbol is unbound)
18751 Get the cddr of the original list
18752 and if possible find the caddr and use that. */
18756 else if (!CONSP (elt
))
18761 else if (INTEGERP (car
))
18763 register int lim
= XINT (car
);
18767 /* Negative int means reduce maximum width. */
18768 if (precision
<= 0)
18771 precision
= min (precision
, -lim
);
18775 /* Padding specified. Don't let it be more than
18776 current maximum. */
18778 lim
= min (precision
, lim
);
18780 /* If that's more padding than already wanted, queue it.
18781 But don't reduce padding already specified even if
18782 that is beyond the current truncation point. */
18783 field_width
= max (lim
, field_width
);
18787 else if (STRINGP (car
) || CONSP (car
))
18789 Lisp_Object halftail
= elt
;
18793 && (precision
<= 0 || n
< precision
))
18795 n
+= display_mode_element (it
, depth
,
18796 /* Do padding only after the last
18797 element in the list. */
18798 (! CONSP (XCDR (elt
))
18801 precision
- n
, XCAR (elt
),
18805 if ((len
& 1) == 0)
18806 halftail
= XCDR (halftail
);
18807 /* Check for cycle. */
18808 if (EQ (halftail
, elt
))
18817 elt
= build_string ("*invalid*");
18821 /* Pad to FIELD_WIDTH. */
18822 if (field_width
> 0 && n
< field_width
)
18824 switch (mode_line_target
)
18826 case MODE_LINE_NOPROP
:
18827 case MODE_LINE_TITLE
:
18828 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18830 case MODE_LINE_STRING
:
18831 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18833 case MODE_LINE_DISPLAY
:
18834 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18843 /* Store a mode-line string element in mode_line_string_list.
18845 If STRING is non-null, display that C string. Otherwise, the Lisp
18846 string LISP_STRING is displayed.
18848 FIELD_WIDTH is the minimum number of output glyphs to produce.
18849 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18850 with spaces. FIELD_WIDTH <= 0 means don't pad.
18852 PRECISION is the maximum number of characters to output from
18853 STRING. PRECISION <= 0 means don't truncate the string.
18855 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18856 properties to the string.
18858 PROPS are the properties to add to the string.
18859 The mode_line_string_face face property is always added to the string.
18863 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18864 int field_width
, int precision
, Lisp_Object props
)
18869 if (string
!= NULL
)
18871 len
= strlen (string
);
18872 if (precision
> 0 && len
> precision
)
18874 lisp_string
= make_string (string
, len
);
18876 props
= mode_line_string_face_prop
;
18877 else if (!NILP (mode_line_string_face
))
18879 Lisp_Object face
= Fplist_get (props
, Qface
);
18880 props
= Fcopy_sequence (props
);
18882 face
= mode_line_string_face
;
18884 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18885 props
= Fplist_put (props
, Qface
, face
);
18887 Fadd_text_properties (make_number (0), make_number (len
),
18888 props
, lisp_string
);
18892 len
= XFASTINT (Flength (lisp_string
));
18893 if (precision
> 0 && len
> precision
)
18896 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18899 if (!NILP (mode_line_string_face
))
18903 props
= Ftext_properties_at (make_number (0), lisp_string
);
18904 face
= Fplist_get (props
, Qface
);
18906 face
= mode_line_string_face
;
18908 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18909 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18911 lisp_string
= Fcopy_sequence (lisp_string
);
18914 Fadd_text_properties (make_number (0), make_number (len
),
18915 props
, lisp_string
);
18920 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18924 if (field_width
> len
)
18926 field_width
-= len
;
18927 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18929 Fadd_text_properties (make_number (0), make_number (field_width
),
18930 props
, lisp_string
);
18931 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18939 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18941 doc
: /* Format a string out of a mode line format specification.
18942 First arg FORMAT specifies the mode line format (see `mode-line-format'
18943 for details) to use.
18945 By default, the format is evaluated for the currently selected window.
18947 Optional second arg FACE specifies the face property to put on all
18948 characters for which no face is specified. The value nil means the
18949 default face. The value t means whatever face the window's mode line
18950 currently uses (either `mode-line' or `mode-line-inactive',
18951 depending on whether the window is the selected window or not).
18952 An integer value means the value string has no text
18955 Optional third and fourth args WINDOW and BUFFER specify the window
18956 and buffer to use as the context for the formatting (defaults
18957 are the selected window and the WINDOW's buffer). */)
18958 (Lisp_Object format
, Lisp_Object face
,
18959 Lisp_Object window
, Lisp_Object buffer
)
18964 struct buffer
*old_buffer
= NULL
;
18966 int no_props
= INTEGERP (face
);
18967 int count
= SPECPDL_INDEX ();
18969 int string_start
= 0;
18972 window
= selected_window
;
18973 CHECK_WINDOW (window
);
18974 w
= XWINDOW (window
);
18977 buffer
= w
->buffer
;
18978 CHECK_BUFFER (buffer
);
18980 /* Make formatting the modeline a non-op when noninteractive, otherwise
18981 there will be problems later caused by a partially initialized frame. */
18982 if (NILP (format
) || noninteractive
)
18983 return empty_unibyte_string
;
18988 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18989 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18990 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18991 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18992 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18993 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18994 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18997 if (XBUFFER (buffer
) != current_buffer
)
18998 old_buffer
= current_buffer
;
19000 /* Save things including mode_line_proptrans_alist,
19001 and set that to nil so that we don't alter the outer value. */
19002 record_unwind_protect (unwind_format_mode_line
,
19003 format_mode_line_unwind_data
19004 (old_buffer
, selected_window
, 1));
19005 mode_line_proptrans_alist
= Qnil
;
19007 Fselect_window (window
, Qt
);
19009 set_buffer_internal_1 (XBUFFER (buffer
));
19011 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19015 mode_line_target
= MODE_LINE_NOPROP
;
19016 mode_line_string_face_prop
= Qnil
;
19017 mode_line_string_list
= Qnil
;
19018 string_start
= MODE_LINE_NOPROP_LEN (0);
19022 mode_line_target
= MODE_LINE_STRING
;
19023 mode_line_string_list
= Qnil
;
19024 mode_line_string_face
= face
;
19025 mode_line_string_face_prop
19026 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19029 push_kboard (FRAME_KBOARD (it
.f
));
19030 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19035 len
= MODE_LINE_NOPROP_LEN (string_start
);
19036 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19040 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19041 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19042 empty_unibyte_string
);
19045 unbind_to (count
, Qnil
);
19049 /* Write a null-terminated, right justified decimal representation of
19050 the positive integer D to BUF using a minimal field width WIDTH. */
19053 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19055 register char *p
= buf
;
19063 *p
++ = d
% 10 + '0';
19068 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19079 /* Write a null-terminated, right justified decimal and "human
19080 readable" representation of the nonnegative integer D to BUF using
19081 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19083 static const char power_letter
[] =
19097 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19099 /* We aim to represent the nonnegative integer D as
19100 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19101 EMACS_INT quotient
= d
;
19103 /* -1 means: do not use TENTHS. */
19107 /* Length of QUOTIENT.TENTHS as a string. */
19113 if (1000 <= quotient
)
19115 /* Scale to the appropriate EXPONENT. */
19118 remainder
= quotient
% 1000;
19122 while (1000 <= quotient
);
19124 /* Round to nearest and decide whether to use TENTHS or not. */
19127 tenths
= remainder
/ 100;
19128 if (50 <= remainder
% 100)
19135 if (quotient
== 10)
19143 if (500 <= remainder
)
19145 if (quotient
< 999)
19156 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19157 if (tenths
== -1 && quotient
<= 99)
19164 p
= psuffix
= buf
+ max (width
, length
);
19166 /* Print EXPONENT. */
19167 *psuffix
++ = power_letter
[exponent
];
19170 /* Print TENTHS. */
19173 *--p
= '0' + tenths
;
19177 /* Print QUOTIENT. */
19180 int digit
= quotient
% 10;
19181 *--p
= '0' + digit
;
19183 while ((quotient
/= 10) != 0);
19185 /* Print leading spaces. */
19190 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19191 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19192 type of CODING_SYSTEM. Return updated pointer into BUF. */
19194 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19197 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19200 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19201 const unsigned char *eol_str
;
19203 /* The EOL conversion we are using. */
19204 Lisp_Object eoltype
;
19206 val
= CODING_SYSTEM_SPEC (coding_system
);
19209 if (!VECTORP (val
)) /* Not yet decided. */
19214 eoltype
= eol_mnemonic_undecided
;
19215 /* Don't mention EOL conversion if it isn't decided. */
19220 Lisp_Object eolvalue
;
19222 attrs
= AREF (val
, 0);
19223 eolvalue
= AREF (val
, 2);
19226 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19230 /* The EOL conversion that is normal on this system. */
19232 if (NILP (eolvalue
)) /* Not yet decided. */
19233 eoltype
= eol_mnemonic_undecided
;
19234 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19235 eoltype
= eol_mnemonic_undecided
;
19236 else /* eolvalue is Qunix, Qdos, or Qmac. */
19237 eoltype
= (EQ (eolvalue
, Qunix
)
19238 ? eol_mnemonic_unix
19239 : (EQ (eolvalue
, Qdos
) == 1
19240 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19246 /* Mention the EOL conversion if it is not the usual one. */
19247 if (STRINGP (eoltype
))
19249 eol_str
= SDATA (eoltype
);
19250 eol_str_len
= SBYTES (eoltype
);
19252 else if (CHARACTERP (eoltype
))
19254 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19255 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19260 eol_str
= invalid_eol_type
;
19261 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19263 memcpy (buf
, eol_str
, eol_str_len
);
19264 buf
+= eol_str_len
;
19270 /* Return a string for the output of a mode line %-spec for window W,
19271 generated by character C. FIELD_WIDTH > 0 means pad the string
19272 returned with spaces to that value. Return a Lisp string in
19273 *STRING if the resulting string is taken from that Lisp string.
19275 Note we operate on the current buffer for most purposes,
19276 the exception being w->base_line_pos. */
19278 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19280 static const char *
19281 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19282 Lisp_Object
*string
)
19285 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19286 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19287 struct buffer
*b
= current_buffer
;
19295 if (!NILP (BVAR (b
, read_only
)))
19297 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19302 /* This differs from %* only for a modified read-only buffer. */
19303 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19305 if (!NILP (BVAR (b
, read_only
)))
19310 /* This differs from %* in ignoring read-only-ness. */
19311 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19323 if (command_loop_level
> 5)
19325 p
= decode_mode_spec_buf
;
19326 for (i
= 0; i
< command_loop_level
; i
++)
19329 return decode_mode_spec_buf
;
19337 if (command_loop_level
> 5)
19339 p
= decode_mode_spec_buf
;
19340 for (i
= 0; i
< command_loop_level
; i
++)
19343 return decode_mode_spec_buf
;
19350 /* Let lots_of_dashes be a string of infinite length. */
19351 if (mode_line_target
== MODE_LINE_NOPROP
||
19352 mode_line_target
== MODE_LINE_STRING
)
19354 if (field_width
<= 0
19355 || field_width
> sizeof (lots_of_dashes
))
19357 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19358 decode_mode_spec_buf
[i
] = '-';
19359 decode_mode_spec_buf
[i
] = '\0';
19360 return decode_mode_spec_buf
;
19363 return lots_of_dashes
;
19367 obj
= BVAR (b
, name
);
19371 /* %c and %l are ignored in `frame-title-format'.
19372 (In redisplay_internal, the frame title is drawn _before_ the
19373 windows are updated, so the stuff which depends on actual
19374 window contents (such as %l) may fail to render properly, or
19375 even crash emacs.) */
19376 if (mode_line_target
== MODE_LINE_TITLE
)
19380 EMACS_INT col
= current_column ();
19381 w
->column_number_displayed
= make_number (col
);
19382 pint2str (decode_mode_spec_buf
, field_width
, col
);
19383 return decode_mode_spec_buf
;
19387 #ifndef SYSTEM_MALLOC
19389 if (NILP (Vmemory_full
))
19392 return "!MEM FULL! ";
19399 /* %F displays the frame name. */
19400 if (!NILP (f
->title
))
19401 return SSDATA (f
->title
);
19402 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19403 return SSDATA (f
->name
);
19407 obj
= BVAR (b
, filename
);
19412 EMACS_INT size
= ZV
- BEGV
;
19413 pint2str (decode_mode_spec_buf
, field_width
, size
);
19414 return decode_mode_spec_buf
;
19419 EMACS_INT size
= ZV
- BEGV
;
19420 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19421 return decode_mode_spec_buf
;
19426 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19427 EMACS_INT topline
, nlines
, height
;
19430 /* %c and %l are ignored in `frame-title-format'. */
19431 if (mode_line_target
== MODE_LINE_TITLE
)
19434 startpos
= XMARKER (w
->start
)->charpos
;
19435 startpos_byte
= marker_byte_position (w
->start
);
19436 height
= WINDOW_TOTAL_LINES (w
);
19438 /* If we decided that this buffer isn't suitable for line numbers,
19439 don't forget that too fast. */
19440 if (EQ (w
->base_line_pos
, w
->buffer
))
19442 /* But do forget it, if the window shows a different buffer now. */
19443 else if (BUFFERP (w
->base_line_pos
))
19444 w
->base_line_pos
= Qnil
;
19446 /* If the buffer is very big, don't waste time. */
19447 if (INTEGERP (Vline_number_display_limit
)
19448 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19450 w
->base_line_pos
= Qnil
;
19451 w
->base_line_number
= Qnil
;
19455 if (INTEGERP (w
->base_line_number
)
19456 && INTEGERP (w
->base_line_pos
)
19457 && XFASTINT (w
->base_line_pos
) <= startpos
)
19459 line
= XFASTINT (w
->base_line_number
);
19460 linepos
= XFASTINT (w
->base_line_pos
);
19461 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19466 linepos
= BUF_BEGV (b
);
19467 linepos_byte
= BUF_BEGV_BYTE (b
);
19470 /* Count lines from base line to window start position. */
19471 nlines
= display_count_lines (linepos_byte
,
19475 topline
= nlines
+ line
;
19477 /* Determine a new base line, if the old one is too close
19478 or too far away, or if we did not have one.
19479 "Too close" means it's plausible a scroll-down would
19480 go back past it. */
19481 if (startpos
== BUF_BEGV (b
))
19483 w
->base_line_number
= make_number (topline
);
19484 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19486 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19487 || linepos
== BUF_BEGV (b
))
19489 EMACS_INT limit
= BUF_BEGV (b
);
19490 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19491 EMACS_INT position
;
19492 EMACS_INT distance
=
19493 (height
* 2 + 30) * line_number_display_limit_width
;
19495 if (startpos
- distance
> limit
)
19497 limit
= startpos
- distance
;
19498 limit_byte
= CHAR_TO_BYTE (limit
);
19501 nlines
= display_count_lines (startpos_byte
,
19503 - (height
* 2 + 30),
19505 /* If we couldn't find the lines we wanted within
19506 line_number_display_limit_width chars per line,
19507 give up on line numbers for this window. */
19508 if (position
== limit_byte
&& limit
== startpos
- distance
)
19510 w
->base_line_pos
= w
->buffer
;
19511 w
->base_line_number
= Qnil
;
19515 w
->base_line_number
= make_number (topline
- nlines
);
19516 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19519 /* Now count lines from the start pos to point. */
19520 nlines
= display_count_lines (startpos_byte
,
19521 PT_BYTE
, PT
, &junk
);
19523 /* Record that we did display the line number. */
19524 line_number_displayed
= 1;
19526 /* Make the string to show. */
19527 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19528 return decode_mode_spec_buf
;
19531 char* p
= decode_mode_spec_buf
;
19532 int pad
= field_width
- 2;
19538 return decode_mode_spec_buf
;
19544 obj
= BVAR (b
, mode_name
);
19548 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19554 EMACS_INT pos
= marker_position (w
->start
);
19555 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19557 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19559 if (pos
<= BUF_BEGV (b
))
19564 else if (pos
<= BUF_BEGV (b
))
19568 if (total
> 1000000)
19569 /* Do it differently for a large value, to avoid overflow. */
19570 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19572 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19573 /* We can't normally display a 3-digit number,
19574 so get us a 2-digit number that is close. */
19577 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19578 return decode_mode_spec_buf
;
19582 /* Display percentage of size above the bottom of the screen. */
19585 EMACS_INT toppos
= marker_position (w
->start
);
19586 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19587 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19589 if (botpos
>= BUF_ZV (b
))
19591 if (toppos
<= BUF_BEGV (b
))
19598 if (total
> 1000000)
19599 /* Do it differently for a large value, to avoid overflow. */
19600 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19602 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19603 /* We can't normally display a 3-digit number,
19604 so get us a 2-digit number that is close. */
19607 if (toppos
<= BUF_BEGV (b
))
19608 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19610 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19611 return decode_mode_spec_buf
;
19616 /* status of process */
19617 obj
= Fget_buffer_process (Fcurrent_buffer ());
19619 return "no process";
19621 obj
= Fsymbol_name (Fprocess_status (obj
));
19627 int count
= inhibit_garbage_collection ();
19628 Lisp_Object val
= call1 (intern ("file-remote-p"),
19629 BVAR (current_buffer
, directory
));
19630 unbind_to (count
, Qnil
);
19638 case 't': /* indicate TEXT or BINARY */
19642 /* coding-system (not including end-of-line format) */
19644 /* coding-system (including end-of-line type) */
19646 int eol_flag
= (c
== 'Z');
19647 char *p
= decode_mode_spec_buf
;
19649 if (! FRAME_WINDOW_P (f
))
19651 /* No need to mention EOL here--the terminal never needs
19652 to do EOL conversion. */
19653 p
= decode_mode_spec_coding (CODING_ID_NAME
19654 (FRAME_KEYBOARD_CODING (f
)->id
),
19656 p
= decode_mode_spec_coding (CODING_ID_NAME
19657 (FRAME_TERMINAL_CODING (f
)->id
),
19660 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19663 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19664 #ifdef subprocesses
19665 obj
= Fget_buffer_process (Fcurrent_buffer ());
19666 if (PROCESSP (obj
))
19668 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19670 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19673 #endif /* subprocesses */
19676 return decode_mode_spec_buf
;
19683 return SSDATA (obj
);
19690 /* Count up to COUNT lines starting from START_BYTE.
19691 But don't go beyond LIMIT_BYTE.
19692 Return the number of lines thus found (always nonnegative).
19694 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19697 display_count_lines (EMACS_INT start_byte
,
19698 EMACS_INT limit_byte
, EMACS_INT count
,
19699 EMACS_INT
*byte_pos_ptr
)
19701 register unsigned char *cursor
;
19702 unsigned char *base
;
19704 register EMACS_INT ceiling
;
19705 register unsigned char *ceiling_addr
;
19706 EMACS_INT orig_count
= count
;
19708 /* If we are not in selective display mode,
19709 check only for newlines. */
19710 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19711 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19715 while (start_byte
< limit_byte
)
19717 ceiling
= BUFFER_CEILING_OF (start_byte
);
19718 ceiling
= min (limit_byte
- 1, ceiling
);
19719 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19720 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19723 if (selective_display
)
19724 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19727 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19730 if (cursor
!= ceiling_addr
)
19734 start_byte
+= cursor
- base
+ 1;
19735 *byte_pos_ptr
= start_byte
;
19739 if (++cursor
== ceiling_addr
)
19745 start_byte
+= cursor
- base
;
19750 while (start_byte
> limit_byte
)
19752 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19753 ceiling
= max (limit_byte
, ceiling
);
19754 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19755 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19758 if (selective_display
)
19759 while (--cursor
!= ceiling_addr
19760 && *cursor
!= '\n' && *cursor
!= 015)
19763 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19766 if (cursor
!= ceiling_addr
)
19770 start_byte
+= cursor
- base
+ 1;
19771 *byte_pos_ptr
= start_byte
;
19772 /* When scanning backwards, we should
19773 not count the newline posterior to which we stop. */
19774 return - orig_count
- 1;
19780 /* Here we add 1 to compensate for the last decrement
19781 of CURSOR, which took it past the valid range. */
19782 start_byte
+= cursor
- base
+ 1;
19786 *byte_pos_ptr
= limit_byte
;
19789 return - orig_count
+ count
;
19790 return orig_count
- count
;
19796 /***********************************************************************
19798 ***********************************************************************/
19800 /* Display a NUL-terminated string, starting with index START.
19802 If STRING is non-null, display that C string. Otherwise, the Lisp
19803 string LISP_STRING is displayed. There's a case that STRING is
19804 non-null and LISP_STRING is not nil. It means STRING is a string
19805 data of LISP_STRING. In that case, we display LISP_STRING while
19806 ignoring its text properties.
19808 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19809 FACE_STRING. Display STRING or LISP_STRING with the face at
19810 FACE_STRING_POS in FACE_STRING:
19812 Display the string in the environment given by IT, but use the
19813 standard display table, temporarily.
19815 FIELD_WIDTH is the minimum number of output glyphs to produce.
19816 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19817 with spaces. If STRING has more characters, more than FIELD_WIDTH
19818 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19820 PRECISION is the maximum number of characters to output from
19821 STRING. PRECISION < 0 means don't truncate the string.
19823 This is roughly equivalent to printf format specifiers:
19825 FIELD_WIDTH PRECISION PRINTF
19826 ----------------------------------------
19832 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19833 display them, and < 0 means obey the current buffer's value of
19834 enable_multibyte_characters.
19836 Value is the number of columns displayed. */
19839 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19840 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19841 int field_width
, int precision
, int max_x
, int multibyte
)
19843 int hpos_at_start
= it
->hpos
;
19844 int saved_face_id
= it
->face_id
;
19845 struct glyph_row
*row
= it
->glyph_row
;
19847 /* Initialize the iterator IT for iteration over STRING beginning
19848 with index START. */
19849 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19850 precision
, field_width
, multibyte
);
19851 if (string
&& STRINGP (lisp_string
))
19852 /* LISP_STRING is the one returned by decode_mode_spec. We should
19853 ignore its text properties. */
19854 it
->stop_charpos
= -1;
19856 /* If displaying STRING, set up the face of the iterator
19857 from LISP_STRING, if that's given. */
19858 if (STRINGP (face_string
))
19864 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19865 0, it
->region_beg_charpos
,
19866 it
->region_end_charpos
,
19867 &endptr
, it
->base_face_id
, 0);
19868 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19869 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19872 /* Set max_x to the maximum allowed X position. Don't let it go
19873 beyond the right edge of the window. */
19875 max_x
= it
->last_visible_x
;
19877 max_x
= min (max_x
, it
->last_visible_x
);
19879 /* Skip over display elements that are not visible. because IT->w is
19881 if (it
->current_x
< it
->first_visible_x
)
19882 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19883 MOVE_TO_POS
| MOVE_TO_X
);
19885 row
->ascent
= it
->max_ascent
;
19886 row
->height
= it
->max_ascent
+ it
->max_descent
;
19887 row
->phys_ascent
= it
->max_phys_ascent
;
19888 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19889 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19891 /* This condition is for the case that we are called with current_x
19892 past last_visible_x. */
19893 while (it
->current_x
< max_x
)
19895 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19897 /* Get the next display element. */
19898 if (!get_next_display_element (it
))
19901 /* Produce glyphs. */
19902 x_before
= it
->current_x
;
19903 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19904 PRODUCE_GLYPHS (it
);
19906 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19909 while (i
< nglyphs
)
19911 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19913 if (it
->line_wrap
!= TRUNCATE
19914 && x
+ glyph
->pixel_width
> max_x
)
19916 /* End of continued line or max_x reached. */
19917 if (CHAR_GLYPH_PADDING_P (*glyph
))
19919 /* A wide character is unbreakable. */
19920 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19921 it
->current_x
= x_before
;
19925 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19930 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19932 /* Glyph is at least partially visible. */
19934 if (x
< it
->first_visible_x
)
19935 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19939 /* Glyph is off the left margin of the display area.
19940 Should not happen. */
19944 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19945 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19946 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19947 row
->phys_height
= max (row
->phys_height
,
19948 it
->max_phys_ascent
+ it
->max_phys_descent
);
19949 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19950 it
->max_extra_line_spacing
);
19951 x
+= glyph
->pixel_width
;
19955 /* Stop if max_x reached. */
19959 /* Stop at line ends. */
19960 if (ITERATOR_AT_END_OF_LINE_P (it
))
19962 it
->continuation_lines_width
= 0;
19966 set_iterator_to_next (it
, 1);
19968 /* Stop if truncating at the right edge. */
19969 if (it
->line_wrap
== TRUNCATE
19970 && it
->current_x
>= it
->last_visible_x
)
19972 /* Add truncation mark, but don't do it if the line is
19973 truncated at a padding space. */
19974 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19976 if (!FRAME_WINDOW_P (it
->f
))
19980 if (it
->current_x
> it
->last_visible_x
)
19982 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19983 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19985 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19987 row
->used
[TEXT_AREA
] = ii
;
19988 produce_special_glyphs (it
, IT_TRUNCATION
);
19991 produce_special_glyphs (it
, IT_TRUNCATION
);
19993 it
->glyph_row
->truncated_on_right_p
= 1;
19999 /* Maybe insert a truncation at the left. */
20000 if (it
->first_visible_x
20001 && IT_CHARPOS (*it
) > 0)
20003 if (!FRAME_WINDOW_P (it
->f
))
20004 insert_left_trunc_glyphs (it
);
20005 it
->glyph_row
->truncated_on_left_p
= 1;
20008 it
->face_id
= saved_face_id
;
20010 /* Value is number of columns displayed. */
20011 return it
->hpos
- hpos_at_start
;
20016 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20017 appears as an element of LIST or as the car of an element of LIST.
20018 If PROPVAL is a list, compare each element against LIST in that
20019 way, and return 1/2 if any element of PROPVAL is found in LIST.
20020 Otherwise return 0. This function cannot quit.
20021 The return value is 2 if the text is invisible but with an ellipsis
20022 and 1 if it's invisible and without an ellipsis. */
20025 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20027 register Lisp_Object tail
, proptail
;
20029 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20031 register Lisp_Object tem
;
20033 if (EQ (propval
, tem
))
20035 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20036 return NILP (XCDR (tem
)) ? 1 : 2;
20039 if (CONSP (propval
))
20041 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20043 Lisp_Object propelt
;
20044 propelt
= XCAR (proptail
);
20045 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20047 register Lisp_Object tem
;
20049 if (EQ (propelt
, tem
))
20051 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20052 return NILP (XCDR (tem
)) ? 1 : 2;
20060 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20061 doc
: /* Non-nil if the property makes the text invisible.
20062 POS-OR-PROP can be a marker or number, in which case it is taken to be
20063 a position in the current buffer and the value of the `invisible' property
20064 is checked; or it can be some other value, which is then presumed to be the
20065 value of the `invisible' property of the text of interest.
20066 The non-nil value returned can be t for truly invisible text or something
20067 else if the text is replaced by an ellipsis. */)
20068 (Lisp_Object pos_or_prop
)
20071 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20072 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20074 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20075 return (invis
== 0 ? Qnil
20077 : make_number (invis
));
20080 /* Calculate a width or height in pixels from a specification using
20081 the following elements:
20084 NUM - a (fractional) multiple of the default font width/height
20085 (NUM) - specifies exactly NUM pixels
20086 UNIT - a fixed number of pixels, see below.
20087 ELEMENT - size of a display element in pixels, see below.
20088 (NUM . SPEC) - equals NUM * SPEC
20089 (+ SPEC SPEC ...) - add pixel values
20090 (- SPEC SPEC ...) - subtract pixel values
20091 (- SPEC) - negate pixel value
20094 INT or FLOAT - a number constant
20095 SYMBOL - use symbol's (buffer local) variable binding.
20098 in - pixels per inch *)
20099 mm - pixels per 1/1000 meter *)
20100 cm - pixels per 1/100 meter *)
20101 width - width of current font in pixels.
20102 height - height of current font in pixels.
20104 *) using the ratio(s) defined in display-pixels-per-inch.
20108 left-fringe - left fringe width in pixels
20109 right-fringe - right fringe width in pixels
20111 left-margin - left margin width in pixels
20112 right-margin - right margin width in pixels
20114 scroll-bar - scroll-bar area width in pixels
20118 Pixels corresponding to 5 inches:
20121 Total width of non-text areas on left side of window (if scroll-bar is on left):
20122 '(space :width (+ left-fringe left-margin scroll-bar))
20124 Align to first text column (in header line):
20125 '(space :align-to 0)
20127 Align to middle of text area minus half the width of variable `my-image'
20128 containing a loaded image:
20129 '(space :align-to (0.5 . (- text my-image)))
20131 Width of left margin minus width of 1 character in the default font:
20132 '(space :width (- left-margin 1))
20134 Width of left margin minus width of 2 characters in the current font:
20135 '(space :width (- left-margin (2 . width)))
20137 Center 1 character over left-margin (in header line):
20138 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20140 Different ways to express width of left fringe plus left margin minus one pixel:
20141 '(space :width (- (+ left-fringe left-margin) (1)))
20142 '(space :width (+ left-fringe left-margin (- (1))))
20143 '(space :width (+ left-fringe left-margin (-1)))
20147 #define NUMVAL(X) \
20148 ((INTEGERP (X) || FLOATP (X)) \
20153 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20154 struct font
*font
, int width_p
, int *align_to
)
20158 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20159 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20162 return OK_PIXELS (0);
20164 xassert (FRAME_LIVE_P (it
->f
));
20166 if (SYMBOLP (prop
))
20168 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20170 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20172 if (unit
[0] == 'i' && unit
[1] == 'n')
20174 else if (unit
[0] == 'm' && unit
[1] == 'm')
20176 else if (unit
[0] == 'c' && unit
[1] == 'm')
20183 #ifdef HAVE_WINDOW_SYSTEM
20184 if (FRAME_WINDOW_P (it
->f
)
20186 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20187 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20189 return OK_PIXELS (ppi
/ pixels
);
20192 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20193 || (CONSP (Vdisplay_pixels_per_inch
)
20195 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20196 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20198 return OK_PIXELS (ppi
/ pixels
);
20204 #ifdef HAVE_WINDOW_SYSTEM
20205 if (EQ (prop
, Qheight
))
20206 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20207 if (EQ (prop
, Qwidth
))
20208 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20210 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20211 return OK_PIXELS (1);
20214 if (EQ (prop
, Qtext
))
20215 return OK_PIXELS (width_p
20216 ? window_box_width (it
->w
, TEXT_AREA
)
20217 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20219 if (align_to
&& *align_to
< 0)
20222 if (EQ (prop
, Qleft
))
20223 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20224 if (EQ (prop
, Qright
))
20225 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20226 if (EQ (prop
, Qcenter
))
20227 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20228 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20229 if (EQ (prop
, Qleft_fringe
))
20230 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20231 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20232 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20233 if (EQ (prop
, Qright_fringe
))
20234 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20235 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20236 : window_box_right_offset (it
->w
, TEXT_AREA
));
20237 if (EQ (prop
, Qleft_margin
))
20238 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20239 if (EQ (prop
, Qright_margin
))
20240 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20241 if (EQ (prop
, Qscroll_bar
))
20242 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20244 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20245 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20246 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20251 if (EQ (prop
, Qleft_fringe
))
20252 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20253 if (EQ (prop
, Qright_fringe
))
20254 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20255 if (EQ (prop
, Qleft_margin
))
20256 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20257 if (EQ (prop
, Qright_margin
))
20258 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20259 if (EQ (prop
, Qscroll_bar
))
20260 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20263 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20266 if (INTEGERP (prop
) || FLOATP (prop
))
20268 int base_unit
= (width_p
20269 ? FRAME_COLUMN_WIDTH (it
->f
)
20270 : FRAME_LINE_HEIGHT (it
->f
));
20271 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20276 Lisp_Object car
= XCAR (prop
);
20277 Lisp_Object cdr
= XCDR (prop
);
20281 #ifdef HAVE_WINDOW_SYSTEM
20282 if (FRAME_WINDOW_P (it
->f
)
20283 && valid_image_p (prop
))
20285 int id
= lookup_image (it
->f
, prop
);
20286 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20288 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20291 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20297 while (CONSP (cdr
))
20299 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20300 font
, width_p
, align_to
))
20303 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20308 if (EQ (car
, Qminus
))
20310 return OK_PIXELS (pixels
);
20313 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20316 if (INTEGERP (car
) || FLOATP (car
))
20319 pixels
= XFLOATINT (car
);
20321 return OK_PIXELS (pixels
);
20322 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20323 font
, width_p
, align_to
))
20324 return OK_PIXELS (pixels
* fact
);
20335 /***********************************************************************
20337 ***********************************************************************/
20339 #ifdef HAVE_WINDOW_SYSTEM
20344 dump_glyph_string (s
)
20345 struct glyph_string
*s
;
20347 fprintf (stderr
, "glyph string\n");
20348 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20349 s
->x
, s
->y
, s
->width
, s
->height
);
20350 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20351 fprintf (stderr
, " hl = %d\n", s
->hl
);
20352 fprintf (stderr
, " left overhang = %d, right = %d\n",
20353 s
->left_overhang
, s
->right_overhang
);
20354 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20355 fprintf (stderr
, " extends to end of line = %d\n",
20356 s
->extends_to_end_of_line_p
);
20357 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20358 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20361 #endif /* GLYPH_DEBUG */
20363 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20364 of XChar2b structures for S; it can't be allocated in
20365 init_glyph_string because it must be allocated via `alloca'. W
20366 is the window on which S is drawn. ROW and AREA are the glyph row
20367 and area within the row from which S is constructed. START is the
20368 index of the first glyph structure covered by S. HL is a
20369 face-override for drawing S. */
20372 #define OPTIONAL_HDC(hdc) HDC hdc,
20373 #define DECLARE_HDC(hdc) HDC hdc;
20374 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20375 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20378 #ifndef OPTIONAL_HDC
20379 #define OPTIONAL_HDC(hdc)
20380 #define DECLARE_HDC(hdc)
20381 #define ALLOCATE_HDC(hdc, f)
20382 #define RELEASE_HDC(hdc, f)
20386 init_glyph_string (struct glyph_string
*s
,
20388 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20389 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20391 memset (s
, 0, sizeof *s
);
20393 s
->f
= XFRAME (w
->frame
);
20397 s
->display
= FRAME_X_DISPLAY (s
->f
);
20398 s
->window
= FRAME_X_WINDOW (s
->f
);
20399 s
->char2b
= char2b
;
20403 s
->first_glyph
= row
->glyphs
[area
] + start
;
20404 s
->height
= row
->height
;
20405 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20406 s
->ybase
= s
->y
+ row
->ascent
;
20410 /* Append the list of glyph strings with head H and tail T to the list
20411 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20414 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20415 struct glyph_string
*h
, struct glyph_string
*t
)
20429 /* Prepend the list of glyph strings with head H and tail T to the
20430 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20434 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20435 struct glyph_string
*h
, struct glyph_string
*t
)
20449 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20450 Set *HEAD and *TAIL to the resulting list. */
20453 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20454 struct glyph_string
*s
)
20456 s
->next
= s
->prev
= NULL
;
20457 append_glyph_string_lists (head
, tail
, s
, s
);
20461 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20462 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20463 make sure that X resources for the face returned are allocated.
20464 Value is a pointer to a realized face that is ready for display if
20465 DISPLAY_P is non-zero. */
20467 static INLINE
struct face
*
20468 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20469 XChar2b
*char2b
, int display_p
)
20471 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20475 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20477 if (code
!= FONT_INVALID_CODE
)
20478 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20480 STORE_XCHAR2B (char2b
, 0, 0);
20483 /* Make sure X resources of the face are allocated. */
20484 #ifdef HAVE_X_WINDOWS
20488 xassert (face
!= NULL
);
20489 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20496 /* Get face and two-byte form of character glyph GLYPH on frame F.
20497 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20498 a pointer to a realized face that is ready for display. */
20500 static INLINE
struct face
*
20501 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20502 XChar2b
*char2b
, int *two_byte_p
)
20506 xassert (glyph
->type
== CHAR_GLYPH
);
20507 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20516 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20517 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20519 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20521 if (code
!= FONT_INVALID_CODE
)
20522 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20524 STORE_XCHAR2B (char2b
, 0, 0);
20527 /* Make sure X resources of the face are allocated. */
20528 xassert (face
!= NULL
);
20529 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20534 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20535 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20538 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20542 if (CHAR_BYTE8_P (c
))
20543 code
= CHAR_TO_BYTE8 (c
);
20545 code
= font
->driver
->encode_char (font
, c
);
20547 if (code
== FONT_INVALID_CODE
)
20549 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20554 /* Fill glyph string S with composition components specified by S->cmp.
20556 BASE_FACE is the base face of the composition.
20557 S->cmp_from is the index of the first component for S.
20559 OVERLAPS non-zero means S should draw the foreground only, and use
20560 its physical height for clipping. See also draw_glyphs.
20562 Value is the index of a component not in S. */
20565 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20569 /* For all glyphs of this composition, starting at the offset
20570 S->cmp_from, until we reach the end of the definition or encounter a
20571 glyph that requires the different face, add it to S. */
20576 s
->for_overlaps
= overlaps
;
20579 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20581 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20585 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20588 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20595 s
->font
= s
->face
->font
;
20597 else if (s
->face
!= face
)
20605 /* All glyph strings for the same composition has the same width,
20606 i.e. the width set for the first component of the composition. */
20607 s
->width
= s
->first_glyph
->pixel_width
;
20609 /* If the specified font could not be loaded, use the frame's
20610 default font, but record the fact that we couldn't load it in
20611 the glyph string so that we can draw rectangles for the
20612 characters of the glyph string. */
20613 if (s
->font
== NULL
)
20615 s
->font_not_found_p
= 1;
20616 s
->font
= FRAME_FONT (s
->f
);
20619 /* Adjust base line for subscript/superscript text. */
20620 s
->ybase
+= s
->first_glyph
->voffset
;
20622 /* This glyph string must always be drawn with 16-bit functions. */
20629 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20630 int start
, int end
, int overlaps
)
20632 struct glyph
*glyph
, *last
;
20633 Lisp_Object lgstring
;
20636 s
->for_overlaps
= overlaps
;
20637 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20638 last
= s
->row
->glyphs
[s
->area
] + end
;
20639 s
->cmp_id
= glyph
->u
.cmp
.id
;
20640 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20641 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20642 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20643 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20644 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20646 while (glyph
< last
20647 && glyph
->u
.cmp
.automatic
20648 && glyph
->u
.cmp
.id
== s
->cmp_id
20649 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20650 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20652 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20654 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20655 unsigned code
= LGLYPH_CODE (lglyph
);
20657 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20659 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20660 return glyph
- s
->row
->glyphs
[s
->area
];
20664 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20665 See the comment of fill_glyph_string for arguments.
20666 Value is the index of the first glyph not in S. */
20670 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20671 int start
, int end
, int overlaps
)
20673 struct glyph
*glyph
, *last
;
20676 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20677 s
->for_overlaps
= overlaps
;
20678 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20679 last
= s
->row
->glyphs
[s
->area
] + end
;
20680 voffset
= glyph
->voffset
;
20681 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20682 s
->font
= s
->face
->font
;
20684 s
->width
= glyph
->pixel_width
;
20686 while (glyph
< last
20687 && glyph
->type
== GLYPHLESS_GLYPH
20688 && glyph
->voffset
== voffset
20689 && glyph
->face_id
== face_id
)
20692 s
->width
+= glyph
->pixel_width
;
20695 s
->ybase
+= voffset
;
20696 return glyph
- s
->row
->glyphs
[s
->area
];
20700 /* Fill glyph string S from a sequence of character glyphs.
20702 FACE_ID is the face id of the string. START is the index of the
20703 first glyph to consider, END is the index of the last + 1.
20704 OVERLAPS non-zero means S should draw the foreground only, and use
20705 its physical height for clipping. See also draw_glyphs.
20707 Value is the index of the first glyph not in S. */
20710 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20711 int start
, int end
, int overlaps
)
20713 struct glyph
*glyph
, *last
;
20715 int glyph_not_available_p
;
20717 xassert (s
->f
== XFRAME (s
->w
->frame
));
20718 xassert (s
->nchars
== 0);
20719 xassert (start
>= 0 && end
> start
);
20721 s
->for_overlaps
= overlaps
;
20722 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20723 last
= s
->row
->glyphs
[s
->area
] + end
;
20724 voffset
= glyph
->voffset
;
20725 s
->padding_p
= glyph
->padding_p
;
20726 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20728 while (glyph
< last
20729 && glyph
->type
== CHAR_GLYPH
20730 && glyph
->voffset
== voffset
20731 /* Same face id implies same font, nowadays. */
20732 && glyph
->face_id
== face_id
20733 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20737 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20738 s
->char2b
+ s
->nchars
,
20740 s
->two_byte_p
= two_byte_p
;
20742 xassert (s
->nchars
<= end
- start
);
20743 s
->width
+= glyph
->pixel_width
;
20744 if (glyph
++->padding_p
!= s
->padding_p
)
20748 s
->font
= s
->face
->font
;
20750 /* If the specified font could not be loaded, use the frame's font,
20751 but record the fact that we couldn't load it in
20752 S->font_not_found_p so that we can draw rectangles for the
20753 characters of the glyph string. */
20754 if (s
->font
== NULL
|| glyph_not_available_p
)
20756 s
->font_not_found_p
= 1;
20757 s
->font
= FRAME_FONT (s
->f
);
20760 /* Adjust base line for subscript/superscript text. */
20761 s
->ybase
+= voffset
;
20763 xassert (s
->face
&& s
->face
->gc
);
20764 return glyph
- s
->row
->glyphs
[s
->area
];
20768 /* Fill glyph string S from image glyph S->first_glyph. */
20771 fill_image_glyph_string (struct glyph_string
*s
)
20773 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20774 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20776 s
->slice
= s
->first_glyph
->slice
.img
;
20777 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20778 s
->font
= s
->face
->font
;
20779 s
->width
= s
->first_glyph
->pixel_width
;
20781 /* Adjust base line for subscript/superscript text. */
20782 s
->ybase
+= s
->first_glyph
->voffset
;
20786 /* Fill glyph string S from a sequence of stretch glyphs.
20788 START is the index of the first glyph to consider,
20789 END is the index of the last + 1.
20791 Value is the index of the first glyph not in S. */
20794 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20796 struct glyph
*glyph
, *last
;
20797 int voffset
, face_id
;
20799 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20801 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20802 last
= s
->row
->glyphs
[s
->area
] + end
;
20803 face_id
= glyph
->face_id
;
20804 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20805 s
->font
= s
->face
->font
;
20806 s
->width
= glyph
->pixel_width
;
20808 voffset
= glyph
->voffset
;
20812 && glyph
->type
== STRETCH_GLYPH
20813 && glyph
->voffset
== voffset
20814 && glyph
->face_id
== face_id
);
20816 s
->width
+= glyph
->pixel_width
;
20818 /* Adjust base line for subscript/superscript text. */
20819 s
->ybase
+= voffset
;
20821 /* The case that face->gc == 0 is handled when drawing the glyph
20822 string by calling PREPARE_FACE_FOR_DISPLAY. */
20824 return glyph
- s
->row
->glyphs
[s
->area
];
20827 static struct font_metrics
*
20828 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20830 static struct font_metrics metrics
;
20831 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20833 if (! font
|| code
== FONT_INVALID_CODE
)
20835 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20840 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20841 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20842 assumed to be zero. */
20845 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20847 *left
= *right
= 0;
20849 if (glyph
->type
== CHAR_GLYPH
)
20853 struct font_metrics
*pcm
;
20855 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20856 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20858 if (pcm
->rbearing
> pcm
->width
)
20859 *right
= pcm
->rbearing
- pcm
->width
;
20860 if (pcm
->lbearing
< 0)
20861 *left
= -pcm
->lbearing
;
20864 else if (glyph
->type
== COMPOSITE_GLYPH
)
20866 if (! glyph
->u
.cmp
.automatic
)
20868 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20870 if (cmp
->rbearing
> cmp
->pixel_width
)
20871 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20872 if (cmp
->lbearing
< 0)
20873 *left
= - cmp
->lbearing
;
20877 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20878 struct font_metrics metrics
;
20880 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20881 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20882 if (metrics
.rbearing
> metrics
.width
)
20883 *right
= metrics
.rbearing
- metrics
.width
;
20884 if (metrics
.lbearing
< 0)
20885 *left
= - metrics
.lbearing
;
20891 /* Return the index of the first glyph preceding glyph string S that
20892 is overwritten by S because of S's left overhang. Value is -1
20893 if no glyphs are overwritten. */
20896 left_overwritten (struct glyph_string
*s
)
20900 if (s
->left_overhang
)
20903 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20904 int first
= s
->first_glyph
- glyphs
;
20906 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20907 x
-= glyphs
[i
].pixel_width
;
20918 /* Return the index of the first glyph preceding glyph string S that
20919 is overwriting S because of its right overhang. Value is -1 if no
20920 glyph in front of S overwrites S. */
20923 left_overwriting (struct glyph_string
*s
)
20926 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20927 int first
= s
->first_glyph
- glyphs
;
20931 for (i
= first
- 1; i
>= 0; --i
)
20934 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20937 x
-= glyphs
[i
].pixel_width
;
20944 /* Return the index of the last glyph following glyph string S that is
20945 overwritten by S because of S's right overhang. Value is -1 if
20946 no such glyph is found. */
20949 right_overwritten (struct glyph_string
*s
)
20953 if (s
->right_overhang
)
20956 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20957 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20958 int end
= s
->row
->used
[s
->area
];
20960 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20961 x
+= glyphs
[i
].pixel_width
;
20970 /* Return the index of the last glyph following glyph string S that
20971 overwrites S because of its left overhang. Value is negative
20972 if no such glyph is found. */
20975 right_overwriting (struct glyph_string
*s
)
20978 int end
= s
->row
->used
[s
->area
];
20979 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20980 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20984 for (i
= first
; i
< end
; ++i
)
20987 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20990 x
+= glyphs
[i
].pixel_width
;
20997 /* Set background width of glyph string S. START is the index of the
20998 first glyph following S. LAST_X is the right-most x-position + 1
20999 in the drawing area. */
21002 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21004 /* If the face of this glyph string has to be drawn to the end of
21005 the drawing area, set S->extends_to_end_of_line_p. */
21007 if (start
== s
->row
->used
[s
->area
]
21008 && s
->area
== TEXT_AREA
21009 && ((s
->row
->fill_line_p
21010 && (s
->hl
== DRAW_NORMAL_TEXT
21011 || s
->hl
== DRAW_IMAGE_RAISED
21012 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21013 || s
->hl
== DRAW_MOUSE_FACE
))
21014 s
->extends_to_end_of_line_p
= 1;
21016 /* If S extends its face to the end of the line, set its
21017 background_width to the distance to the right edge of the drawing
21019 if (s
->extends_to_end_of_line_p
)
21020 s
->background_width
= last_x
- s
->x
+ 1;
21022 s
->background_width
= s
->width
;
21026 /* Compute overhangs and x-positions for glyph string S and its
21027 predecessors, or successors. X is the starting x-position for S.
21028 BACKWARD_P non-zero means process predecessors. */
21031 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21037 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21038 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21048 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21049 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21059 /* The following macros are only called from draw_glyphs below.
21060 They reference the following parameters of that function directly:
21061 `w', `row', `area', and `overlap_p'
21062 as well as the following local variables:
21063 `s', `f', and `hdc' (in W32) */
21066 /* On W32, silently add local `hdc' variable to argument list of
21067 init_glyph_string. */
21068 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21069 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21071 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21072 init_glyph_string (s, char2b, w, row, area, start, hl)
21075 /* Add a glyph string for a stretch glyph to the list of strings
21076 between HEAD and TAIL. START is the index of the stretch glyph in
21077 row area AREA of glyph row ROW. END is the index of the last glyph
21078 in that glyph row area. X is the current output position assigned
21079 to the new glyph string constructed. HL overrides that face of the
21080 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21081 is the right-most x-position of the drawing area. */
21083 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21084 and below -- keep them on one line. */
21085 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21088 s = (struct glyph_string *) alloca (sizeof *s); \
21089 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21090 START = fill_stretch_glyph_string (s, START, END); \
21091 append_glyph_string (&HEAD, &TAIL, s); \
21097 /* Add a glyph string for an image glyph to the list of strings
21098 between HEAD and TAIL. START is the index of the image glyph in
21099 row area AREA of glyph row ROW. END is the index of the last glyph
21100 in that glyph row area. X is the current output position assigned
21101 to the new glyph string constructed. HL overrides that face of the
21102 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21103 is the right-most x-position of the drawing area. */
21105 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21108 s = (struct glyph_string *) alloca (sizeof *s); \
21109 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21110 fill_image_glyph_string (s); \
21111 append_glyph_string (&HEAD, &TAIL, s); \
21118 /* Add a glyph string for a sequence of character glyphs to the list
21119 of strings between HEAD and TAIL. START is the index of the first
21120 glyph in row area AREA of glyph row ROW that is part of the new
21121 glyph string. END is the index of the last glyph in that glyph row
21122 area. X is the current output position assigned to the new glyph
21123 string constructed. HL overrides that face of the glyph; e.g. it
21124 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21125 right-most x-position of the drawing area. */
21127 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21133 face_id = (row)->glyphs[area][START].face_id; \
21135 s = (struct glyph_string *) alloca (sizeof *s); \
21136 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21137 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21138 append_glyph_string (&HEAD, &TAIL, s); \
21140 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21145 /* Add a glyph string for a composite sequence to the list of strings
21146 between HEAD and TAIL. START is the index of the first glyph in
21147 row area AREA of glyph row ROW that is part of the new glyph
21148 string. END is the index of the last glyph in that glyph row area.
21149 X is the current output position assigned to the new glyph string
21150 constructed. HL overrides that face of the glyph; e.g. it is
21151 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21152 x-position of the drawing area. */
21154 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21156 int face_id = (row)->glyphs[area][START].face_id; \
21157 struct face *base_face = FACE_FROM_ID (f, face_id); \
21158 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21159 struct composition *cmp = composition_table[cmp_id]; \
21161 struct glyph_string *first_s IF_LINT (= NULL); \
21164 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21166 /* Make glyph_strings for each glyph sequence that is drawable by \
21167 the same face, and append them to HEAD/TAIL. */ \
21168 for (n = 0; n < cmp->glyph_len;) \
21170 s = (struct glyph_string *) alloca (sizeof *s); \
21171 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21172 append_glyph_string (&(HEAD), &(TAIL), s); \
21178 n = fill_composite_glyph_string (s, base_face, overlaps); \
21186 /* Add a glyph string for a glyph-string sequence to the list of strings
21187 between HEAD and TAIL. */
21189 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21193 Lisp_Object gstring; \
21195 face_id = (row)->glyphs[area][START].face_id; \
21196 gstring = (composition_gstring_from_id \
21197 ((row)->glyphs[area][START].u.cmp.id)); \
21198 s = (struct glyph_string *) alloca (sizeof *s); \
21199 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21200 * LGSTRING_GLYPH_LEN (gstring)); \
21201 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21202 append_glyph_string (&(HEAD), &(TAIL), s); \
21204 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21208 /* Add a glyph string for a sequence of glyphless character's glyphs
21209 to the list of strings between HEAD and TAIL. The meanings of
21210 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21212 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21217 face_id = (row)->glyphs[area][START].face_id; \
21219 s = (struct glyph_string *) alloca (sizeof *s); \
21220 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21221 append_glyph_string (&HEAD, &TAIL, s); \
21223 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21229 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21230 of AREA of glyph row ROW on window W between indices START and END.
21231 HL overrides the face for drawing glyph strings, e.g. it is
21232 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21233 x-positions of the drawing area.
21235 This is an ugly monster macro construct because we must use alloca
21236 to allocate glyph strings (because draw_glyphs can be called
21237 asynchronously). */
21239 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21242 HEAD = TAIL = NULL; \
21243 while (START < END) \
21245 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21246 switch (first_glyph->type) \
21249 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21253 case COMPOSITE_GLYPH: \
21254 if (first_glyph->u.cmp.automatic) \
21255 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21258 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21262 case STRETCH_GLYPH: \
21263 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21267 case IMAGE_GLYPH: \
21268 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21272 case GLYPHLESS_GLYPH: \
21273 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21283 set_glyph_string_background_width (s, START, LAST_X); \
21290 /* Draw glyphs between START and END in AREA of ROW on window W,
21291 starting at x-position X. X is relative to AREA in W. HL is a
21292 face-override with the following meaning:
21294 DRAW_NORMAL_TEXT draw normally
21295 DRAW_CURSOR draw in cursor face
21296 DRAW_MOUSE_FACE draw in mouse face.
21297 DRAW_INVERSE_VIDEO draw in mode line face
21298 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21299 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21301 If OVERLAPS is non-zero, draw only the foreground of characters and
21302 clip to the physical height of ROW. Non-zero value also defines
21303 the overlapping part to be drawn:
21305 OVERLAPS_PRED overlap with preceding rows
21306 OVERLAPS_SUCC overlap with succeeding rows
21307 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21308 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21310 Value is the x-position reached, relative to AREA of W. */
21313 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21314 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21315 enum draw_glyphs_face hl
, int overlaps
)
21317 struct glyph_string
*head
, *tail
;
21318 struct glyph_string
*s
;
21319 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21320 int i
, j
, x_reached
, last_x
, area_left
= 0;
21321 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21324 ALLOCATE_HDC (hdc
, f
);
21326 /* Let's rather be paranoid than getting a SEGV. */
21327 end
= min (end
, row
->used
[area
]);
21328 start
= max (0, start
);
21329 start
= min (end
, start
);
21331 /* Translate X to frame coordinates. Set last_x to the right
21332 end of the drawing area. */
21333 if (row
->full_width_p
)
21335 /* X is relative to the left edge of W, without scroll bars
21337 area_left
= WINDOW_LEFT_EDGE_X (w
);
21338 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21342 area_left
= window_box_left (w
, area
);
21343 last_x
= area_left
+ window_box_width (w
, area
);
21347 /* Build a doubly-linked list of glyph_string structures between
21348 head and tail from what we have to draw. Note that the macro
21349 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21350 the reason we use a separate variable `i'. */
21352 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21354 x_reached
= tail
->x
+ tail
->background_width
;
21358 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21359 the row, redraw some glyphs in front or following the glyph
21360 strings built above. */
21361 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21363 struct glyph_string
*h
, *t
;
21364 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21365 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21366 int check_mouse_face
= 0;
21369 /* If mouse highlighting is on, we may need to draw adjacent
21370 glyphs using mouse-face highlighting. */
21371 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21373 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21375 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21376 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21378 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21380 check_mouse_face
= 1;
21381 mouse_beg_col
= (row
== mouse_beg_row
)
21382 ? hlinfo
->mouse_face_beg_col
: 0;
21383 mouse_end_col
= (row
== mouse_end_row
)
21384 ? hlinfo
->mouse_face_end_col
21385 : row
->used
[TEXT_AREA
];
21389 /* Compute overhangs for all glyph strings. */
21390 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21391 for (s
= head
; s
; s
= s
->next
)
21392 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21394 /* Prepend glyph strings for glyphs in front of the first glyph
21395 string that are overwritten because of the first glyph
21396 string's left overhang. The background of all strings
21397 prepended must be drawn because the first glyph string
21399 i
= left_overwritten (head
);
21402 enum draw_glyphs_face overlap_hl
;
21404 /* If this row contains mouse highlighting, attempt to draw
21405 the overlapped glyphs with the correct highlight. This
21406 code fails if the overlap encompasses more than one glyph
21407 and mouse-highlight spans only some of these glyphs.
21408 However, making it work perfectly involves a lot more
21409 code, and I don't know if the pathological case occurs in
21410 practice, so we'll stick to this for now. --- cyd */
21411 if (check_mouse_face
21412 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21413 overlap_hl
= DRAW_MOUSE_FACE
;
21415 overlap_hl
= DRAW_NORMAL_TEXT
;
21418 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21419 overlap_hl
, dummy_x
, last_x
);
21421 compute_overhangs_and_x (t
, head
->x
, 1);
21422 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21426 /* Prepend glyph strings for glyphs in front of the first glyph
21427 string that overwrite that glyph string because of their
21428 right overhang. For these strings, only the foreground must
21429 be drawn, because it draws over the glyph string at `head'.
21430 The background must not be drawn because this would overwrite
21431 right overhangs of preceding glyphs for which no glyph
21433 i
= left_overwriting (head
);
21436 enum draw_glyphs_face overlap_hl
;
21438 if (check_mouse_face
21439 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21440 overlap_hl
= DRAW_MOUSE_FACE
;
21442 overlap_hl
= DRAW_NORMAL_TEXT
;
21445 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21446 overlap_hl
, dummy_x
, last_x
);
21447 for (s
= h
; s
; s
= s
->next
)
21448 s
->background_filled_p
= 1;
21449 compute_overhangs_and_x (t
, head
->x
, 1);
21450 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21453 /* Append glyphs strings for glyphs following the last glyph
21454 string tail that are overwritten by tail. The background of
21455 these strings has to be drawn because tail's foreground draws
21457 i
= right_overwritten (tail
);
21460 enum draw_glyphs_face overlap_hl
;
21462 if (check_mouse_face
21463 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21464 overlap_hl
= DRAW_MOUSE_FACE
;
21466 overlap_hl
= DRAW_NORMAL_TEXT
;
21468 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21469 overlap_hl
, x
, last_x
);
21470 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21471 we don't have `end = i;' here. */
21472 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21473 append_glyph_string_lists (&head
, &tail
, h
, t
);
21477 /* Append glyph strings for glyphs following the last glyph
21478 string tail that overwrite tail. The foreground of such
21479 glyphs has to be drawn because it writes into the background
21480 of tail. The background must not be drawn because it could
21481 paint over the foreground of following glyphs. */
21482 i
= right_overwriting (tail
);
21485 enum draw_glyphs_face overlap_hl
;
21486 if (check_mouse_face
21487 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21488 overlap_hl
= DRAW_MOUSE_FACE
;
21490 overlap_hl
= DRAW_NORMAL_TEXT
;
21493 i
++; /* We must include the Ith glyph. */
21494 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21495 overlap_hl
, x
, last_x
);
21496 for (s
= h
; s
; s
= s
->next
)
21497 s
->background_filled_p
= 1;
21498 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21499 append_glyph_string_lists (&head
, &tail
, h
, t
);
21501 if (clip_head
|| clip_tail
)
21502 for (s
= head
; s
; s
= s
->next
)
21504 s
->clip_head
= clip_head
;
21505 s
->clip_tail
= clip_tail
;
21509 /* Draw all strings. */
21510 for (s
= head
; s
; s
= s
->next
)
21511 FRAME_RIF (f
)->draw_glyph_string (s
);
21514 /* When focus a sole frame and move horizontally, this sets on_p to 0
21515 causing a failure to erase prev cursor position. */
21516 if (area
== TEXT_AREA
21517 && !row
->full_width_p
21518 /* When drawing overlapping rows, only the glyph strings'
21519 foreground is drawn, which doesn't erase a cursor
21523 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21524 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21525 : (tail
? tail
->x
+ tail
->background_width
: x
));
21529 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21530 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21534 /* Value is the x-position up to which drawn, relative to AREA of W.
21535 This doesn't include parts drawn because of overhangs. */
21536 if (row
->full_width_p
)
21537 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21539 x_reached
-= area_left
;
21541 RELEASE_HDC (hdc
, f
);
21546 /* Expand row matrix if too narrow. Don't expand if area
21549 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21551 if (!fonts_changed_p \
21552 && (it->glyph_row->glyphs[area] \
21553 < it->glyph_row->glyphs[area + 1])) \
21555 it->w->ncols_scale_factor++; \
21556 fonts_changed_p = 1; \
21560 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21561 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21564 append_glyph (struct it
*it
)
21566 struct glyph
*glyph
;
21567 enum glyph_row_area area
= it
->area
;
21569 xassert (it
->glyph_row
);
21570 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21572 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21573 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21575 /* If the glyph row is reversed, we need to prepend the glyph
21576 rather than append it. */
21577 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21581 /* Make room for the additional glyph. */
21582 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21584 glyph
= it
->glyph_row
->glyphs
[area
];
21586 glyph
->charpos
= CHARPOS (it
->position
);
21587 glyph
->object
= it
->object
;
21588 if (it
->pixel_width
> 0)
21590 glyph
->pixel_width
= it
->pixel_width
;
21591 glyph
->padding_p
= 0;
21595 /* Assure at least 1-pixel width. Otherwise, cursor can't
21596 be displayed correctly. */
21597 glyph
->pixel_width
= 1;
21598 glyph
->padding_p
= 1;
21600 glyph
->ascent
= it
->ascent
;
21601 glyph
->descent
= it
->descent
;
21602 glyph
->voffset
= it
->voffset
;
21603 glyph
->type
= CHAR_GLYPH
;
21604 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21605 glyph
->multibyte_p
= it
->multibyte_p
;
21606 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21607 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21608 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21609 || it
->phys_descent
> it
->descent
);
21610 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21611 glyph
->face_id
= it
->face_id
;
21612 glyph
->u
.ch
= it
->char_to_display
;
21613 glyph
->slice
.img
= null_glyph_slice
;
21614 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21617 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21618 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21620 glyph
->bidi_type
= it
->bidi_it
.type
;
21624 glyph
->resolved_level
= 0;
21625 glyph
->bidi_type
= UNKNOWN_BT
;
21627 ++it
->glyph_row
->used
[area
];
21630 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21633 /* Store one glyph for the composition IT->cmp_it.id in
21634 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21638 append_composite_glyph (struct it
*it
)
21640 struct glyph
*glyph
;
21641 enum glyph_row_area area
= it
->area
;
21643 xassert (it
->glyph_row
);
21645 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21646 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21648 /* If the glyph row is reversed, we need to prepend the glyph
21649 rather than append it. */
21650 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21654 /* Make room for the new glyph. */
21655 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21657 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21659 glyph
->charpos
= it
->cmp_it
.charpos
;
21660 glyph
->object
= it
->object
;
21661 glyph
->pixel_width
= it
->pixel_width
;
21662 glyph
->ascent
= it
->ascent
;
21663 glyph
->descent
= it
->descent
;
21664 glyph
->voffset
= it
->voffset
;
21665 glyph
->type
= COMPOSITE_GLYPH
;
21666 if (it
->cmp_it
.ch
< 0)
21668 glyph
->u
.cmp
.automatic
= 0;
21669 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21670 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21674 glyph
->u
.cmp
.automatic
= 1;
21675 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21676 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21677 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21679 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21680 glyph
->multibyte_p
= it
->multibyte_p
;
21681 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21682 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21683 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21684 || it
->phys_descent
> it
->descent
);
21685 glyph
->padding_p
= 0;
21686 glyph
->glyph_not_available_p
= 0;
21687 glyph
->face_id
= it
->face_id
;
21688 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21691 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21692 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21694 glyph
->bidi_type
= it
->bidi_it
.type
;
21696 ++it
->glyph_row
->used
[area
];
21699 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21703 /* Change IT->ascent and IT->height according to the setting of
21707 take_vertical_position_into_account (struct it
*it
)
21711 if (it
->voffset
< 0)
21712 /* Increase the ascent so that we can display the text higher
21714 it
->ascent
-= it
->voffset
;
21716 /* Increase the descent so that we can display the text lower
21718 it
->descent
+= it
->voffset
;
21723 /* Produce glyphs/get display metrics for the image IT is loaded with.
21724 See the description of struct display_iterator in dispextern.h for
21725 an overview of struct display_iterator. */
21728 produce_image_glyph (struct it
*it
)
21732 int glyph_ascent
, crop
;
21733 struct glyph_slice slice
;
21735 xassert (it
->what
== IT_IMAGE
);
21737 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21739 /* Make sure X resources of the face is loaded. */
21740 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21742 if (it
->image_id
< 0)
21744 /* Fringe bitmap. */
21745 it
->ascent
= it
->phys_ascent
= 0;
21746 it
->descent
= it
->phys_descent
= 0;
21747 it
->pixel_width
= 0;
21752 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21754 /* Make sure X resources of the image is loaded. */
21755 prepare_image_for_display (it
->f
, img
);
21757 slice
.x
= slice
.y
= 0;
21758 slice
.width
= img
->width
;
21759 slice
.height
= img
->height
;
21761 if (INTEGERP (it
->slice
.x
))
21762 slice
.x
= XINT (it
->slice
.x
);
21763 else if (FLOATP (it
->slice
.x
))
21764 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21766 if (INTEGERP (it
->slice
.y
))
21767 slice
.y
= XINT (it
->slice
.y
);
21768 else if (FLOATP (it
->slice
.y
))
21769 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21771 if (INTEGERP (it
->slice
.width
))
21772 slice
.width
= XINT (it
->slice
.width
);
21773 else if (FLOATP (it
->slice
.width
))
21774 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21776 if (INTEGERP (it
->slice
.height
))
21777 slice
.height
= XINT (it
->slice
.height
);
21778 else if (FLOATP (it
->slice
.height
))
21779 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21781 if (slice
.x
>= img
->width
)
21782 slice
.x
= img
->width
;
21783 if (slice
.y
>= img
->height
)
21784 slice
.y
= img
->height
;
21785 if (slice
.x
+ slice
.width
>= img
->width
)
21786 slice
.width
= img
->width
- slice
.x
;
21787 if (slice
.y
+ slice
.height
> img
->height
)
21788 slice
.height
= img
->height
- slice
.y
;
21790 if (slice
.width
== 0 || slice
.height
== 0)
21793 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21795 it
->descent
= slice
.height
- glyph_ascent
;
21797 it
->descent
+= img
->vmargin
;
21798 if (slice
.y
+ slice
.height
== img
->height
)
21799 it
->descent
+= img
->vmargin
;
21800 it
->phys_descent
= it
->descent
;
21802 it
->pixel_width
= slice
.width
;
21804 it
->pixel_width
+= img
->hmargin
;
21805 if (slice
.x
+ slice
.width
== img
->width
)
21806 it
->pixel_width
+= img
->hmargin
;
21808 /* It's quite possible for images to have an ascent greater than
21809 their height, so don't get confused in that case. */
21810 if (it
->descent
< 0)
21815 if (face
->box
!= FACE_NO_BOX
)
21817 if (face
->box_line_width
> 0)
21820 it
->ascent
+= face
->box_line_width
;
21821 if (slice
.y
+ slice
.height
== img
->height
)
21822 it
->descent
+= face
->box_line_width
;
21825 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21826 it
->pixel_width
+= eabs (face
->box_line_width
);
21827 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21828 it
->pixel_width
+= eabs (face
->box_line_width
);
21831 take_vertical_position_into_account (it
);
21833 /* Automatically crop wide image glyphs at right edge so we can
21834 draw the cursor on same display row. */
21835 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21836 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21838 it
->pixel_width
-= crop
;
21839 slice
.width
-= crop
;
21844 struct glyph
*glyph
;
21845 enum glyph_row_area area
= it
->area
;
21847 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21848 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21850 glyph
->charpos
= CHARPOS (it
->position
);
21851 glyph
->object
= it
->object
;
21852 glyph
->pixel_width
= it
->pixel_width
;
21853 glyph
->ascent
= glyph_ascent
;
21854 glyph
->descent
= it
->descent
;
21855 glyph
->voffset
= it
->voffset
;
21856 glyph
->type
= IMAGE_GLYPH
;
21857 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21858 glyph
->multibyte_p
= it
->multibyte_p
;
21859 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21860 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21861 glyph
->overlaps_vertically_p
= 0;
21862 glyph
->padding_p
= 0;
21863 glyph
->glyph_not_available_p
= 0;
21864 glyph
->face_id
= it
->face_id
;
21865 glyph
->u
.img_id
= img
->id
;
21866 glyph
->slice
.img
= slice
;
21867 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21870 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21871 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21873 glyph
->bidi_type
= it
->bidi_it
.type
;
21875 ++it
->glyph_row
->used
[area
];
21878 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21883 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21884 of the glyph, WIDTH and HEIGHT are the width and height of the
21885 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21888 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21889 int width
, int height
, int ascent
)
21891 struct glyph
*glyph
;
21892 enum glyph_row_area area
= it
->area
;
21894 xassert (ascent
>= 0 && ascent
<= height
);
21896 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21897 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21899 /* If the glyph row is reversed, we need to prepend the glyph
21900 rather than append it. */
21901 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21905 /* Make room for the additional glyph. */
21906 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21908 glyph
= it
->glyph_row
->glyphs
[area
];
21910 glyph
->charpos
= CHARPOS (it
->position
);
21911 glyph
->object
= object
;
21912 glyph
->pixel_width
= width
;
21913 glyph
->ascent
= ascent
;
21914 glyph
->descent
= height
- ascent
;
21915 glyph
->voffset
= it
->voffset
;
21916 glyph
->type
= STRETCH_GLYPH
;
21917 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21918 glyph
->multibyte_p
= it
->multibyte_p
;
21919 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21920 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21921 glyph
->overlaps_vertically_p
= 0;
21922 glyph
->padding_p
= 0;
21923 glyph
->glyph_not_available_p
= 0;
21924 glyph
->face_id
= it
->face_id
;
21925 glyph
->u
.stretch
.ascent
= ascent
;
21926 glyph
->u
.stretch
.height
= height
;
21927 glyph
->slice
.img
= null_glyph_slice
;
21928 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21931 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21932 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21934 glyph
->bidi_type
= it
->bidi_it
.type
;
21938 glyph
->resolved_level
= 0;
21939 glyph
->bidi_type
= UNKNOWN_BT
;
21941 ++it
->glyph_row
->used
[area
];
21944 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21948 /* Produce a stretch glyph for iterator IT. IT->object is the value
21949 of the glyph property displayed. The value must be a list
21950 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21953 1. `:width WIDTH' specifies that the space should be WIDTH *
21954 canonical char width wide. WIDTH may be an integer or floating
21957 2. `:relative-width FACTOR' specifies that the width of the stretch
21958 should be computed from the width of the first character having the
21959 `glyph' property, and should be FACTOR times that width.
21961 3. `:align-to HPOS' specifies that the space should be wide enough
21962 to reach HPOS, a value in canonical character units.
21964 Exactly one of the above pairs must be present.
21966 4. `:height HEIGHT' specifies that the height of the stretch produced
21967 should be HEIGHT, measured in canonical character units.
21969 5. `:relative-height FACTOR' specifies that the height of the
21970 stretch should be FACTOR times the height of the characters having
21971 the glyph property.
21973 Either none or exactly one of 4 or 5 must be present.
21975 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21976 of the stretch should be used for the ascent of the stretch.
21977 ASCENT must be in the range 0 <= ASCENT <= 100. */
21980 produce_stretch_glyph (struct it
*it
)
21982 /* (space :width WIDTH :height HEIGHT ...) */
21983 Lisp_Object prop
, plist
;
21984 int width
= 0, height
= 0, align_to
= -1;
21985 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21988 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21989 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21991 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21993 /* List should start with `space'. */
21994 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21995 plist
= XCDR (it
->object
);
21997 /* Compute the width of the stretch. */
21998 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21999 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22001 /* Absolute width `:width WIDTH' specified and valid. */
22002 zero_width_ok_p
= 1;
22005 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22008 /* Relative width `:relative-width FACTOR' specified and valid.
22009 Compute the width of the characters having the `glyph'
22012 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22015 if (it
->multibyte_p
)
22016 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22019 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22020 if (! ASCII_CHAR_P (it2
.c
))
22021 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22024 it2
.glyph_row
= NULL
;
22025 it2
.what
= IT_CHARACTER
;
22026 x_produce_glyphs (&it2
);
22027 width
= NUMVAL (prop
) * it2
.pixel_width
;
22029 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22030 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22032 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22033 align_to
= (align_to
< 0
22035 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22036 else if (align_to
< 0)
22037 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22038 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22039 zero_width_ok_p
= 1;
22042 /* Nothing specified -> width defaults to canonical char width. */
22043 width
= FRAME_COLUMN_WIDTH (it
->f
);
22045 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22048 /* Compute height. */
22049 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22050 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22053 zero_height_ok_p
= 1;
22055 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22057 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22059 height
= FONT_HEIGHT (font
);
22061 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22064 /* Compute percentage of height used for ascent. If
22065 `:ascent ASCENT' is present and valid, use that. Otherwise,
22066 derive the ascent from the font in use. */
22067 if (prop
= Fplist_get (plist
, QCascent
),
22068 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22069 ascent
= height
* NUMVAL (prop
) / 100.0;
22070 else if (!NILP (prop
)
22071 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22072 ascent
= min (max (0, (int)tem
), height
);
22074 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22076 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22077 && it
->current_x
+ width
> it
->last_visible_x
)
22078 width
= it
->last_visible_x
- it
->current_x
- 1;
22080 if (width
> 0 && height
> 0 && it
->glyph_row
)
22082 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22083 if (!STRINGP (object
))
22084 object
= it
->w
->buffer
;
22085 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22088 it
->pixel_width
= width
;
22089 it
->ascent
= it
->phys_ascent
= ascent
;
22090 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22091 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22093 take_vertical_position_into_account (it
);
22096 /* Calculate line-height and line-spacing properties.
22097 An integer value specifies explicit pixel value.
22098 A float value specifies relative value to current face height.
22099 A cons (float . face-name) specifies relative value to
22100 height of specified face font.
22102 Returns height in pixels, or nil. */
22106 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22107 int boff
, int override
)
22109 Lisp_Object face_name
= Qnil
;
22110 int ascent
, descent
, height
;
22112 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22117 face_name
= XCAR (val
);
22119 if (!NUMBERP (val
))
22120 val
= make_number (1);
22121 if (NILP (face_name
))
22123 height
= it
->ascent
+ it
->descent
;
22128 if (NILP (face_name
))
22130 font
= FRAME_FONT (it
->f
);
22131 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22133 else if (EQ (face_name
, Qt
))
22142 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22144 return make_number (-1);
22146 face
= FACE_FROM_ID (it
->f
, face_id
);
22149 return make_number (-1);
22150 boff
= font
->baseline_offset
;
22151 if (font
->vertical_centering
)
22152 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22155 ascent
= FONT_BASE (font
) + boff
;
22156 descent
= FONT_DESCENT (font
) - boff
;
22160 it
->override_ascent
= ascent
;
22161 it
->override_descent
= descent
;
22162 it
->override_boff
= boff
;
22165 height
= ascent
+ descent
;
22169 height
= (int)(XFLOAT_DATA (val
) * height
);
22170 else if (INTEGERP (val
))
22171 height
*= XINT (val
);
22173 return make_number (height
);
22177 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22178 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22179 and only if this is for a character for which no font was found.
22181 If the display method (it->glyphless_method) is
22182 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22183 length of the acronym or the hexadecimal string, UPPER_XOFF and
22184 UPPER_YOFF are pixel offsets for the upper part of the string,
22185 LOWER_XOFF and LOWER_YOFF are for the lower part.
22187 For the other display methods, LEN through LOWER_YOFF are zero. */
22190 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22191 short upper_xoff
, short upper_yoff
,
22192 short lower_xoff
, short lower_yoff
)
22194 struct glyph
*glyph
;
22195 enum glyph_row_area area
= it
->area
;
22197 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22198 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22200 /* If the glyph row is reversed, we need to prepend the glyph
22201 rather than append it. */
22202 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22206 /* Make room for the additional glyph. */
22207 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22209 glyph
= it
->glyph_row
->glyphs
[area
];
22211 glyph
->charpos
= CHARPOS (it
->position
);
22212 glyph
->object
= it
->object
;
22213 glyph
->pixel_width
= it
->pixel_width
;
22214 glyph
->ascent
= it
->ascent
;
22215 glyph
->descent
= it
->descent
;
22216 glyph
->voffset
= it
->voffset
;
22217 glyph
->type
= GLYPHLESS_GLYPH
;
22218 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22219 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22220 glyph
->u
.glyphless
.len
= len
;
22221 glyph
->u
.glyphless
.ch
= it
->c
;
22222 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22223 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22224 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22225 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22226 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22227 glyph
->multibyte_p
= it
->multibyte_p
;
22228 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22229 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22230 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22231 || it
->phys_descent
> it
->descent
);
22232 glyph
->padding_p
= 0;
22233 glyph
->glyph_not_available_p
= 0;
22234 glyph
->face_id
= face_id
;
22235 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22238 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22239 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22241 glyph
->bidi_type
= it
->bidi_it
.type
;
22243 ++it
->glyph_row
->used
[area
];
22246 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22250 /* Produce a glyph for a glyphless character for iterator IT.
22251 IT->glyphless_method specifies which method to use for displaying
22252 the character. See the description of enum
22253 glyphless_display_method in dispextern.h for the detail.
22255 FOR_NO_FONT is nonzero if and only if this is for a character for
22256 which no font was found. ACRONYM, if non-nil, is an acronym string
22257 for the character. */
22260 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22265 int base_width
, base_height
, width
, height
;
22266 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22269 /* Get the metrics of the base font. We always refer to the current
22271 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22272 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22273 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22274 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22275 base_height
= it
->ascent
+ it
->descent
;
22276 base_width
= font
->average_width
;
22278 /* Get a face ID for the glyph by utilizing a cache (the same way as
22279 doen for `escape-glyph' in get_next_display_element). */
22280 if (it
->f
== last_glyphless_glyph_frame
22281 && it
->face_id
== last_glyphless_glyph_face_id
)
22283 face_id
= last_glyphless_glyph_merged_face_id
;
22287 /* Merge the `glyphless-char' face into the current face. */
22288 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22289 last_glyphless_glyph_frame
= it
->f
;
22290 last_glyphless_glyph_face_id
= it
->face_id
;
22291 last_glyphless_glyph_merged_face_id
= face_id
;
22294 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22296 it
->pixel_width
= THIN_SPACE_WIDTH
;
22298 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22300 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22302 width
= CHAR_WIDTH (it
->c
);
22305 else if (width
> 4)
22307 it
->pixel_width
= base_width
* width
;
22309 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22315 unsigned int code
[6];
22317 int ascent
, descent
;
22318 struct font_metrics metrics_upper
, metrics_lower
;
22320 face
= FACE_FROM_ID (it
->f
, face_id
);
22321 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22322 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22324 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22326 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22327 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22328 if (CONSP (acronym
))
22329 acronym
= XCAR (acronym
);
22330 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22334 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22335 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22338 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22339 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22340 upper_len
= (len
+ 1) / 2;
22341 font
->driver
->text_extents (font
, code
, upper_len
,
22343 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22348 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22349 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22350 upper_xoff
= upper_yoff
= 2; /* the typical case */
22351 if (base_width
>= width
)
22353 /* Align the upper to the left, the lower to the right. */
22354 it
->pixel_width
= base_width
;
22355 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22359 /* Center the shorter one. */
22360 it
->pixel_width
= width
;
22361 if (metrics_upper
.width
>= metrics_lower
.width
)
22362 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22365 /* FIXME: This code doesn't look right. It formerly was
22366 missing the "lower_xoff = 0;", which couldn't have
22367 been right since it left lower_xoff uninitialized. */
22369 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22373 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22374 top, bottom, and between upper and lower strings. */
22375 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22376 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22377 /* Center vertically.
22378 H:base_height, D:base_descent
22379 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22381 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22382 descent = D - H/2 + h/2;
22383 lower_yoff = descent - 2 - ld;
22384 upper_yoff = lower_yoff - la - 1 - ud; */
22385 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22386 descent
= it
->descent
- (base_height
- height
) / 2;
22387 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22388 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22389 - metrics_upper
.descent
);
22390 /* Don't make the height shorter than the base height. */
22391 if (height
> base_height
)
22393 it
->ascent
= ascent
;
22394 it
->descent
= descent
;
22398 it
->phys_ascent
= it
->ascent
;
22399 it
->phys_descent
= it
->descent
;
22401 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22402 upper_xoff
, upper_yoff
,
22403 lower_xoff
, lower_yoff
);
22405 take_vertical_position_into_account (it
);
22410 Produce glyphs/get display metrics for the display element IT is
22411 loaded with. See the description of struct it in dispextern.h
22412 for an overview of struct it. */
22415 x_produce_glyphs (struct it
*it
)
22417 int extra_line_spacing
= it
->extra_line_spacing
;
22419 it
->glyph_not_available_p
= 0;
22421 if (it
->what
== IT_CHARACTER
)
22424 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22425 struct font
*font
= face
->font
;
22426 struct font_metrics
*pcm
= NULL
;
22427 int boff
; /* baseline offset */
22431 /* When no suitable font is found, display this character by
22432 the method specified in the first extra slot of
22433 Vglyphless_char_display. */
22434 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22436 xassert (it
->what
== IT_GLYPHLESS
);
22437 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22441 boff
= font
->baseline_offset
;
22442 if (font
->vertical_centering
)
22443 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22445 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22451 if (it
->override_ascent
>= 0)
22453 it
->ascent
= it
->override_ascent
;
22454 it
->descent
= it
->override_descent
;
22455 boff
= it
->override_boff
;
22459 it
->ascent
= FONT_BASE (font
) + boff
;
22460 it
->descent
= FONT_DESCENT (font
) - boff
;
22463 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22465 pcm
= get_per_char_metric (font
, &char2b
);
22466 if (pcm
->width
== 0
22467 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22473 it
->phys_ascent
= pcm
->ascent
+ boff
;
22474 it
->phys_descent
= pcm
->descent
- boff
;
22475 it
->pixel_width
= pcm
->width
;
22479 it
->glyph_not_available_p
= 1;
22480 it
->phys_ascent
= it
->ascent
;
22481 it
->phys_descent
= it
->descent
;
22482 it
->pixel_width
= font
->space_width
;
22485 if (it
->constrain_row_ascent_descent_p
)
22487 if (it
->descent
> it
->max_descent
)
22489 it
->ascent
+= it
->descent
- it
->max_descent
;
22490 it
->descent
= it
->max_descent
;
22492 if (it
->ascent
> it
->max_ascent
)
22494 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22495 it
->ascent
= it
->max_ascent
;
22497 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22498 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22499 extra_line_spacing
= 0;
22502 /* If this is a space inside a region of text with
22503 `space-width' property, change its width. */
22504 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22506 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22508 /* If face has a box, add the box thickness to the character
22509 height. If character has a box line to the left and/or
22510 right, add the box line width to the character's width. */
22511 if (face
->box
!= FACE_NO_BOX
)
22513 int thick
= face
->box_line_width
;
22517 it
->ascent
+= thick
;
22518 it
->descent
+= thick
;
22523 if (it
->start_of_box_run_p
)
22524 it
->pixel_width
+= thick
;
22525 if (it
->end_of_box_run_p
)
22526 it
->pixel_width
+= thick
;
22529 /* If face has an overline, add the height of the overline
22530 (1 pixel) and a 1 pixel margin to the character height. */
22531 if (face
->overline_p
)
22532 it
->ascent
+= overline_margin
;
22534 if (it
->constrain_row_ascent_descent_p
)
22536 if (it
->ascent
> it
->max_ascent
)
22537 it
->ascent
= it
->max_ascent
;
22538 if (it
->descent
> it
->max_descent
)
22539 it
->descent
= it
->max_descent
;
22542 take_vertical_position_into_account (it
);
22544 /* If we have to actually produce glyphs, do it. */
22549 /* Translate a space with a `space-width' property
22550 into a stretch glyph. */
22551 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22552 / FONT_HEIGHT (font
));
22553 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22554 it
->ascent
+ it
->descent
, ascent
);
22559 /* If characters with lbearing or rbearing are displayed
22560 in this line, record that fact in a flag of the
22561 glyph row. This is used to optimize X output code. */
22562 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22563 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22565 if (! stretched_p
&& it
->pixel_width
== 0)
22566 /* We assure that all visible glyphs have at least 1-pixel
22568 it
->pixel_width
= 1;
22570 else if (it
->char_to_display
== '\n')
22572 /* A newline has no width, but we need the height of the
22573 line. But if previous part of the line sets a height,
22574 don't increase that height */
22576 Lisp_Object height
;
22577 Lisp_Object total_height
= Qnil
;
22579 it
->override_ascent
= -1;
22580 it
->pixel_width
= 0;
22583 height
= get_it_property (it
, Qline_height
);
22584 /* Split (line-height total-height) list */
22586 && CONSP (XCDR (height
))
22587 && NILP (XCDR (XCDR (height
))))
22589 total_height
= XCAR (XCDR (height
));
22590 height
= XCAR (height
);
22592 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22594 if (it
->override_ascent
>= 0)
22596 it
->ascent
= it
->override_ascent
;
22597 it
->descent
= it
->override_descent
;
22598 boff
= it
->override_boff
;
22602 it
->ascent
= FONT_BASE (font
) + boff
;
22603 it
->descent
= FONT_DESCENT (font
) - boff
;
22606 if (EQ (height
, Qt
))
22608 if (it
->descent
> it
->max_descent
)
22610 it
->ascent
+= it
->descent
- it
->max_descent
;
22611 it
->descent
= it
->max_descent
;
22613 if (it
->ascent
> it
->max_ascent
)
22615 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22616 it
->ascent
= it
->max_ascent
;
22618 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22619 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22620 it
->constrain_row_ascent_descent_p
= 1;
22621 extra_line_spacing
= 0;
22625 Lisp_Object spacing
;
22627 it
->phys_ascent
= it
->ascent
;
22628 it
->phys_descent
= it
->descent
;
22630 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22631 && face
->box
!= FACE_NO_BOX
22632 && face
->box_line_width
> 0)
22634 it
->ascent
+= face
->box_line_width
;
22635 it
->descent
+= face
->box_line_width
;
22638 && XINT (height
) > it
->ascent
+ it
->descent
)
22639 it
->ascent
= XINT (height
) - it
->descent
;
22641 if (!NILP (total_height
))
22642 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22645 spacing
= get_it_property (it
, Qline_spacing
);
22646 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22648 if (INTEGERP (spacing
))
22650 extra_line_spacing
= XINT (spacing
);
22651 if (!NILP (total_height
))
22652 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22656 else /* i.e. (it->char_to_display == '\t') */
22658 if (font
->space_width
> 0)
22660 int tab_width
= it
->tab_width
* font
->space_width
;
22661 int x
= it
->current_x
+ it
->continuation_lines_width
;
22662 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22664 /* If the distance from the current position to the next tab
22665 stop is less than a space character width, use the
22666 tab stop after that. */
22667 if (next_tab_x
- x
< font
->space_width
)
22668 next_tab_x
+= tab_width
;
22670 it
->pixel_width
= next_tab_x
- x
;
22672 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22673 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22677 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22678 it
->ascent
+ it
->descent
, it
->ascent
);
22683 it
->pixel_width
= 0;
22688 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22690 /* A static composition.
22692 Note: A composition is represented as one glyph in the
22693 glyph matrix. There are no padding glyphs.
22695 Important note: pixel_width, ascent, and descent are the
22696 values of what is drawn by draw_glyphs (i.e. the values of
22697 the overall glyphs composed). */
22698 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22699 int boff
; /* baseline offset */
22700 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22701 int glyph_len
= cmp
->glyph_len
;
22702 struct font
*font
= face
->font
;
22706 /* If we have not yet calculated pixel size data of glyphs of
22707 the composition for the current face font, calculate them
22708 now. Theoretically, we have to check all fonts for the
22709 glyphs, but that requires much time and memory space. So,
22710 here we check only the font of the first glyph. This may
22711 lead to incorrect display, but it's very rare, and C-l
22712 (recenter-top-bottom) can correct the display anyway. */
22713 if (! cmp
->font
|| cmp
->font
!= font
)
22715 /* Ascent and descent of the font of the first character
22716 of this composition (adjusted by baseline offset).
22717 Ascent and descent of overall glyphs should not be less
22718 than these, respectively. */
22719 int font_ascent
, font_descent
, font_height
;
22720 /* Bounding box of the overall glyphs. */
22721 int leftmost
, rightmost
, lowest
, highest
;
22722 int lbearing
, rbearing
;
22723 int i
, width
, ascent
, descent
;
22724 int left_padded
= 0, right_padded
= 0;
22725 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22727 struct font_metrics
*pcm
;
22728 int font_not_found_p
;
22731 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22732 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22734 if (glyph_len
< cmp
->glyph_len
)
22736 for (i
= 0; i
< glyph_len
; i
++)
22738 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22740 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22745 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22746 : IT_CHARPOS (*it
));
22747 /* If no suitable font is found, use the default font. */
22748 font_not_found_p
= font
== NULL
;
22749 if (font_not_found_p
)
22751 face
= face
->ascii_face
;
22754 boff
= font
->baseline_offset
;
22755 if (font
->vertical_centering
)
22756 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22757 font_ascent
= FONT_BASE (font
) + boff
;
22758 font_descent
= FONT_DESCENT (font
) - boff
;
22759 font_height
= FONT_HEIGHT (font
);
22761 cmp
->font
= (void *) font
;
22764 if (! font_not_found_p
)
22766 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22768 pcm
= get_per_char_metric (font
, &char2b
);
22771 /* Initialize the bounding box. */
22774 width
= pcm
->width
;
22775 ascent
= pcm
->ascent
;
22776 descent
= pcm
->descent
;
22777 lbearing
= pcm
->lbearing
;
22778 rbearing
= pcm
->rbearing
;
22782 width
= font
->space_width
;
22783 ascent
= FONT_BASE (font
);
22784 descent
= FONT_DESCENT (font
);
22791 lowest
= - descent
+ boff
;
22792 highest
= ascent
+ boff
;
22794 if (! font_not_found_p
22795 && font
->default_ascent
22796 && CHAR_TABLE_P (Vuse_default_ascent
)
22797 && !NILP (Faref (Vuse_default_ascent
,
22798 make_number (it
->char_to_display
))))
22799 highest
= font
->default_ascent
+ boff
;
22801 /* Draw the first glyph at the normal position. It may be
22802 shifted to right later if some other glyphs are drawn
22804 cmp
->offsets
[i
* 2] = 0;
22805 cmp
->offsets
[i
* 2 + 1] = boff
;
22806 cmp
->lbearing
= lbearing
;
22807 cmp
->rbearing
= rbearing
;
22809 /* Set cmp->offsets for the remaining glyphs. */
22810 for (i
++; i
< glyph_len
; i
++)
22812 int left
, right
, btm
, top
;
22813 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22815 struct face
*this_face
;
22819 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22820 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22821 font
= this_face
->font
;
22827 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22829 pcm
= get_per_char_metric (font
, &char2b
);
22832 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22835 width
= pcm
->width
;
22836 ascent
= pcm
->ascent
;
22837 descent
= pcm
->descent
;
22838 lbearing
= pcm
->lbearing
;
22839 rbearing
= pcm
->rbearing
;
22840 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22842 /* Relative composition with or without
22843 alternate chars. */
22844 left
= (leftmost
+ rightmost
- width
) / 2;
22845 btm
= - descent
+ boff
;
22846 if (font
->relative_compose
22847 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22848 || NILP (Faref (Vignore_relative_composition
,
22849 make_number (ch
)))))
22852 if (- descent
>= font
->relative_compose
)
22853 /* One extra pixel between two glyphs. */
22855 else if (ascent
<= 0)
22856 /* One extra pixel between two glyphs. */
22857 btm
= lowest
- 1 - ascent
- descent
;
22862 /* A composition rule is specified by an integer
22863 value that encodes global and new reference
22864 points (GREF and NREF). GREF and NREF are
22865 specified by numbers as below:
22867 0---1---2 -- ascent
22871 9--10--11 -- center
22873 ---3---4---5--- baseline
22875 6---7---8 -- descent
22877 int rule
= COMPOSITION_RULE (cmp
, i
);
22878 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22880 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22881 grefx
= gref
% 3, nrefx
= nref
% 3;
22882 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22884 xoff
= font_height
* (xoff
- 128) / 256;
22886 yoff
= font_height
* (yoff
- 128) / 256;
22889 + grefx
* (rightmost
- leftmost
) / 2
22890 - nrefx
* width
/ 2
22893 btm
= ((grefy
== 0 ? highest
22895 : grefy
== 2 ? lowest
22896 : (highest
+ lowest
) / 2)
22897 - (nrefy
== 0 ? ascent
+ descent
22898 : nrefy
== 1 ? descent
- boff
22900 : (ascent
+ descent
) / 2)
22904 cmp
->offsets
[i
* 2] = left
;
22905 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22907 /* Update the bounding box of the overall glyphs. */
22910 right
= left
+ width
;
22911 if (left
< leftmost
)
22913 if (right
> rightmost
)
22916 top
= btm
+ descent
+ ascent
;
22922 if (cmp
->lbearing
> left
+ lbearing
)
22923 cmp
->lbearing
= left
+ lbearing
;
22924 if (cmp
->rbearing
< left
+ rbearing
)
22925 cmp
->rbearing
= left
+ rbearing
;
22929 /* If there are glyphs whose x-offsets are negative,
22930 shift all glyphs to the right and make all x-offsets
22934 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22935 cmp
->offsets
[i
* 2] -= leftmost
;
22936 rightmost
-= leftmost
;
22937 cmp
->lbearing
-= leftmost
;
22938 cmp
->rbearing
-= leftmost
;
22941 if (left_padded
&& cmp
->lbearing
< 0)
22943 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22944 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22945 rightmost
-= cmp
->lbearing
;
22946 cmp
->rbearing
-= cmp
->lbearing
;
22949 if (right_padded
&& rightmost
< cmp
->rbearing
)
22951 rightmost
= cmp
->rbearing
;
22954 cmp
->pixel_width
= rightmost
;
22955 cmp
->ascent
= highest
;
22956 cmp
->descent
= - lowest
;
22957 if (cmp
->ascent
< font_ascent
)
22958 cmp
->ascent
= font_ascent
;
22959 if (cmp
->descent
< font_descent
)
22960 cmp
->descent
= font_descent
;
22964 && (cmp
->lbearing
< 0
22965 || cmp
->rbearing
> cmp
->pixel_width
))
22966 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22968 it
->pixel_width
= cmp
->pixel_width
;
22969 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22970 it
->descent
= it
->phys_descent
= cmp
->descent
;
22971 if (face
->box
!= FACE_NO_BOX
)
22973 int thick
= face
->box_line_width
;
22977 it
->ascent
+= thick
;
22978 it
->descent
+= thick
;
22983 if (it
->start_of_box_run_p
)
22984 it
->pixel_width
+= thick
;
22985 if (it
->end_of_box_run_p
)
22986 it
->pixel_width
+= thick
;
22989 /* If face has an overline, add the height of the overline
22990 (1 pixel) and a 1 pixel margin to the character height. */
22991 if (face
->overline_p
)
22992 it
->ascent
+= overline_margin
;
22994 take_vertical_position_into_account (it
);
22995 if (it
->ascent
< 0)
22997 if (it
->descent
< 0)
23001 append_composite_glyph (it
);
23003 else if (it
->what
== IT_COMPOSITION
)
23005 /* A dynamic (automatic) composition. */
23006 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23007 Lisp_Object gstring
;
23008 struct font_metrics metrics
;
23010 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23012 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23015 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23016 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23017 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23018 it
->descent
= it
->phys_descent
= metrics
.descent
;
23019 if (face
->box
!= FACE_NO_BOX
)
23021 int thick
= face
->box_line_width
;
23025 it
->ascent
+= thick
;
23026 it
->descent
+= thick
;
23031 if (it
->start_of_box_run_p
)
23032 it
->pixel_width
+= thick
;
23033 if (it
->end_of_box_run_p
)
23034 it
->pixel_width
+= thick
;
23036 /* If face has an overline, add the height of the overline
23037 (1 pixel) and a 1 pixel margin to the character height. */
23038 if (face
->overline_p
)
23039 it
->ascent
+= overline_margin
;
23040 take_vertical_position_into_account (it
);
23041 if (it
->ascent
< 0)
23043 if (it
->descent
< 0)
23047 append_composite_glyph (it
);
23049 else if (it
->what
== IT_GLYPHLESS
)
23050 produce_glyphless_glyph (it
, 0, Qnil
);
23051 else if (it
->what
== IT_IMAGE
)
23052 produce_image_glyph (it
);
23053 else if (it
->what
== IT_STRETCH
)
23054 produce_stretch_glyph (it
);
23057 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23058 because this isn't true for images with `:ascent 100'. */
23059 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23060 if (it
->area
== TEXT_AREA
)
23061 it
->current_x
+= it
->pixel_width
;
23063 if (extra_line_spacing
> 0)
23065 it
->descent
+= extra_line_spacing
;
23066 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23067 it
->max_extra_line_spacing
= extra_line_spacing
;
23070 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23071 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23072 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23073 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23077 Output LEN glyphs starting at START at the nominal cursor position.
23078 Advance the nominal cursor over the text. The global variable
23079 updated_window contains the window being updated, updated_row is
23080 the glyph row being updated, and updated_area is the area of that
23081 row being updated. */
23084 x_write_glyphs (struct glyph
*start
, int len
)
23088 xassert (updated_window
&& updated_row
);
23091 /* Write glyphs. */
23093 hpos
= start
- updated_row
->glyphs
[updated_area
];
23094 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23095 updated_row
, updated_area
,
23097 DRAW_NORMAL_TEXT
, 0);
23099 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23100 if (updated_area
== TEXT_AREA
23101 && updated_window
->phys_cursor_on_p
23102 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23103 && updated_window
->phys_cursor
.hpos
>= hpos
23104 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23105 updated_window
->phys_cursor_on_p
= 0;
23109 /* Advance the output cursor. */
23110 output_cursor
.hpos
+= len
;
23111 output_cursor
.x
= x
;
23116 Insert LEN glyphs from START at the nominal cursor position. */
23119 x_insert_glyphs (struct glyph
*start
, int len
)
23123 int line_height
, shift_by_width
, shifted_region_width
;
23124 struct glyph_row
*row
;
23125 struct glyph
*glyph
;
23126 int frame_x
, frame_y
;
23129 xassert (updated_window
&& updated_row
);
23131 w
= updated_window
;
23132 f
= XFRAME (WINDOW_FRAME (w
));
23134 /* Get the height of the line we are in. */
23136 line_height
= row
->height
;
23138 /* Get the width of the glyphs to insert. */
23139 shift_by_width
= 0;
23140 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23141 shift_by_width
+= glyph
->pixel_width
;
23143 /* Get the width of the region to shift right. */
23144 shifted_region_width
= (window_box_width (w
, updated_area
)
23149 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23150 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23152 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23153 line_height
, shift_by_width
);
23155 /* Write the glyphs. */
23156 hpos
= start
- row
->glyphs
[updated_area
];
23157 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23159 DRAW_NORMAL_TEXT
, 0);
23161 /* Advance the output cursor. */
23162 output_cursor
.hpos
+= len
;
23163 output_cursor
.x
+= shift_by_width
;
23169 Erase the current text line from the nominal cursor position
23170 (inclusive) to pixel column TO_X (exclusive). The idea is that
23171 everything from TO_X onward is already erased.
23173 TO_X is a pixel position relative to updated_area of
23174 updated_window. TO_X == -1 means clear to the end of this area. */
23177 x_clear_end_of_line (int to_x
)
23180 struct window
*w
= updated_window
;
23181 int max_x
, min_y
, max_y
;
23182 int from_x
, from_y
, to_y
;
23184 xassert (updated_window
&& updated_row
);
23185 f
= XFRAME (w
->frame
);
23187 if (updated_row
->full_width_p
)
23188 max_x
= WINDOW_TOTAL_WIDTH (w
);
23190 max_x
= window_box_width (w
, updated_area
);
23191 max_y
= window_text_bottom_y (w
);
23193 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23194 of window. For TO_X > 0, truncate to end of drawing area. */
23200 to_x
= min (to_x
, max_x
);
23202 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23204 /* Notice if the cursor will be cleared by this operation. */
23205 if (!updated_row
->full_width_p
)
23206 notice_overwritten_cursor (w
, updated_area
,
23207 output_cursor
.x
, -1,
23209 MATRIX_ROW_BOTTOM_Y (updated_row
));
23211 from_x
= output_cursor
.x
;
23213 /* Translate to frame coordinates. */
23214 if (updated_row
->full_width_p
)
23216 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23217 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23221 int area_left
= window_box_left (w
, updated_area
);
23222 from_x
+= area_left
;
23226 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23227 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23228 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23230 /* Prevent inadvertently clearing to end of the X window. */
23231 if (to_x
> from_x
&& to_y
> from_y
)
23234 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23235 to_x
- from_x
, to_y
- from_y
);
23240 #endif /* HAVE_WINDOW_SYSTEM */
23244 /***********************************************************************
23246 ***********************************************************************/
23248 /* Value is the internal representation of the specified cursor type
23249 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23250 of the bar cursor. */
23252 static enum text_cursor_kinds
23253 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23255 enum text_cursor_kinds type
;
23260 if (EQ (arg
, Qbox
))
23261 return FILLED_BOX_CURSOR
;
23263 if (EQ (arg
, Qhollow
))
23264 return HOLLOW_BOX_CURSOR
;
23266 if (EQ (arg
, Qbar
))
23273 && EQ (XCAR (arg
), Qbar
)
23274 && INTEGERP (XCDR (arg
))
23275 && XINT (XCDR (arg
)) >= 0)
23277 *width
= XINT (XCDR (arg
));
23281 if (EQ (arg
, Qhbar
))
23284 return HBAR_CURSOR
;
23288 && EQ (XCAR (arg
), Qhbar
)
23289 && INTEGERP (XCDR (arg
))
23290 && XINT (XCDR (arg
)) >= 0)
23292 *width
= XINT (XCDR (arg
));
23293 return HBAR_CURSOR
;
23296 /* Treat anything unknown as "hollow box cursor".
23297 It was bad to signal an error; people have trouble fixing
23298 .Xdefaults with Emacs, when it has something bad in it. */
23299 type
= HOLLOW_BOX_CURSOR
;
23304 /* Set the default cursor types for specified frame. */
23306 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23311 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23312 FRAME_CURSOR_WIDTH (f
) = width
;
23314 /* By default, set up the blink-off state depending on the on-state. */
23316 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23319 FRAME_BLINK_OFF_CURSOR (f
)
23320 = get_specified_cursor_type (XCDR (tem
), &width
);
23321 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23324 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23328 #ifdef HAVE_WINDOW_SYSTEM
23330 /* Return the cursor we want to be displayed in window W. Return
23331 width of bar/hbar cursor through WIDTH arg. Return with
23332 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23333 (i.e. if the `system caret' should track this cursor).
23335 In a mini-buffer window, we want the cursor only to appear if we
23336 are reading input from this window. For the selected window, we
23337 want the cursor type given by the frame parameter or buffer local
23338 setting of cursor-type. If explicitly marked off, draw no cursor.
23339 In all other cases, we want a hollow box cursor. */
23341 static enum text_cursor_kinds
23342 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23343 int *active_cursor
)
23345 struct frame
*f
= XFRAME (w
->frame
);
23346 struct buffer
*b
= XBUFFER (w
->buffer
);
23347 int cursor_type
= DEFAULT_CURSOR
;
23348 Lisp_Object alt_cursor
;
23349 int non_selected
= 0;
23351 *active_cursor
= 1;
23354 if (cursor_in_echo_area
23355 && FRAME_HAS_MINIBUF_P (f
)
23356 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23358 if (w
== XWINDOW (echo_area_window
))
23360 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23362 *width
= FRAME_CURSOR_WIDTH (f
);
23363 return FRAME_DESIRED_CURSOR (f
);
23366 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23369 *active_cursor
= 0;
23373 /* Detect a nonselected window or nonselected frame. */
23374 else if (w
!= XWINDOW (f
->selected_window
)
23375 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23377 *active_cursor
= 0;
23379 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23385 /* Never display a cursor in a window in which cursor-type is nil. */
23386 if (NILP (BVAR (b
, cursor_type
)))
23389 /* Get the normal cursor type for this window. */
23390 if (EQ (BVAR (b
, cursor_type
), Qt
))
23392 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23393 *width
= FRAME_CURSOR_WIDTH (f
);
23396 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23398 /* Use cursor-in-non-selected-windows instead
23399 for non-selected window or frame. */
23402 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23403 if (!EQ (Qt
, alt_cursor
))
23404 return get_specified_cursor_type (alt_cursor
, width
);
23405 /* t means modify the normal cursor type. */
23406 if (cursor_type
== FILLED_BOX_CURSOR
)
23407 cursor_type
= HOLLOW_BOX_CURSOR
;
23408 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23410 return cursor_type
;
23413 /* Use normal cursor if not blinked off. */
23414 if (!w
->cursor_off_p
)
23416 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23418 if (cursor_type
== FILLED_BOX_CURSOR
)
23420 /* Using a block cursor on large images can be very annoying.
23421 So use a hollow cursor for "large" images.
23422 If image is not transparent (no mask), also use hollow cursor. */
23423 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23424 if (img
!= NULL
&& IMAGEP (img
->spec
))
23426 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23427 where N = size of default frame font size.
23428 This should cover most of the "tiny" icons people may use. */
23430 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23431 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23432 cursor_type
= HOLLOW_BOX_CURSOR
;
23435 else if (cursor_type
!= NO_CURSOR
)
23437 /* Display current only supports BOX and HOLLOW cursors for images.
23438 So for now, unconditionally use a HOLLOW cursor when cursor is
23439 not a solid box cursor. */
23440 cursor_type
= HOLLOW_BOX_CURSOR
;
23443 return cursor_type
;
23446 /* Cursor is blinked off, so determine how to "toggle" it. */
23448 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23449 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23450 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23452 /* Then see if frame has specified a specific blink off cursor type. */
23453 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23455 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23456 return FRAME_BLINK_OFF_CURSOR (f
);
23460 /* Some people liked having a permanently visible blinking cursor,
23461 while others had very strong opinions against it. So it was
23462 decided to remove it. KFS 2003-09-03 */
23464 /* Finally perform built-in cursor blinking:
23465 filled box <-> hollow box
23466 wide [h]bar <-> narrow [h]bar
23467 narrow [h]bar <-> no cursor
23468 other type <-> no cursor */
23470 if (cursor_type
== FILLED_BOX_CURSOR
)
23471 return HOLLOW_BOX_CURSOR
;
23473 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23476 return cursor_type
;
23484 /* Notice when the text cursor of window W has been completely
23485 overwritten by a drawing operation that outputs glyphs in AREA
23486 starting at X0 and ending at X1 in the line starting at Y0 and
23487 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23488 the rest of the line after X0 has been written. Y coordinates
23489 are window-relative. */
23492 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23493 int x0
, int x1
, int y0
, int y1
)
23495 int cx0
, cx1
, cy0
, cy1
;
23496 struct glyph_row
*row
;
23498 if (!w
->phys_cursor_on_p
)
23500 if (area
!= TEXT_AREA
)
23503 if (w
->phys_cursor
.vpos
< 0
23504 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23505 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23506 !(row
->enabled_p
&& row
->displays_text_p
)))
23509 if (row
->cursor_in_fringe_p
)
23511 row
->cursor_in_fringe_p
= 0;
23512 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23513 w
->phys_cursor_on_p
= 0;
23517 cx0
= w
->phys_cursor
.x
;
23518 cx1
= cx0
+ w
->phys_cursor_width
;
23519 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23522 /* The cursor image will be completely removed from the
23523 screen if the output area intersects the cursor area in
23524 y-direction. When we draw in [y0 y1[, and some part of
23525 the cursor is at y < y0, that part must have been drawn
23526 before. When scrolling, the cursor is erased before
23527 actually scrolling, so we don't come here. When not
23528 scrolling, the rows above the old cursor row must have
23529 changed, and in this case these rows must have written
23530 over the cursor image.
23532 Likewise if part of the cursor is below y1, with the
23533 exception of the cursor being in the first blank row at
23534 the buffer and window end because update_text_area
23535 doesn't draw that row. (Except when it does, but
23536 that's handled in update_text_area.) */
23538 cy0
= w
->phys_cursor
.y
;
23539 cy1
= cy0
+ w
->phys_cursor_height
;
23540 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23543 w
->phys_cursor_on_p
= 0;
23546 #endif /* HAVE_WINDOW_SYSTEM */
23549 /************************************************************************
23551 ************************************************************************/
23553 #ifdef HAVE_WINDOW_SYSTEM
23556 Fix the display of area AREA of overlapping row ROW in window W
23557 with respect to the overlapping part OVERLAPS. */
23560 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23561 enum glyph_row_area area
, int overlaps
)
23568 for (i
= 0; i
< row
->used
[area
];)
23570 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23572 int start
= i
, start_x
= x
;
23576 x
+= row
->glyphs
[area
][i
].pixel_width
;
23579 while (i
< row
->used
[area
]
23580 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23582 draw_glyphs (w
, start_x
, row
, area
,
23584 DRAW_NORMAL_TEXT
, overlaps
);
23588 x
+= row
->glyphs
[area
][i
].pixel_width
;
23598 Draw the cursor glyph of window W in glyph row ROW. See the
23599 comment of draw_glyphs for the meaning of HL. */
23602 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23603 enum draw_glyphs_face hl
)
23605 /* If cursor hpos is out of bounds, don't draw garbage. This can
23606 happen in mini-buffer windows when switching between echo area
23607 glyphs and mini-buffer. */
23608 if ((row
->reversed_p
23609 ? (w
->phys_cursor
.hpos
>= 0)
23610 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23612 int on_p
= w
->phys_cursor_on_p
;
23614 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23615 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23617 w
->phys_cursor_on_p
= on_p
;
23619 if (hl
== DRAW_CURSOR
)
23620 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23621 /* When we erase the cursor, and ROW is overlapped by other
23622 rows, make sure that these overlapping parts of other rows
23624 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23626 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23628 if (row
> w
->current_matrix
->rows
23629 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23630 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23631 OVERLAPS_ERASED_CURSOR
);
23633 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23634 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23635 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23636 OVERLAPS_ERASED_CURSOR
);
23643 Erase the image of a cursor of window W from the screen. */
23646 erase_phys_cursor (struct window
*w
)
23648 struct frame
*f
= XFRAME (w
->frame
);
23649 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23650 int hpos
= w
->phys_cursor
.hpos
;
23651 int vpos
= w
->phys_cursor
.vpos
;
23652 int mouse_face_here_p
= 0;
23653 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23654 struct glyph_row
*cursor_row
;
23655 struct glyph
*cursor_glyph
;
23656 enum draw_glyphs_face hl
;
23658 /* No cursor displayed or row invalidated => nothing to do on the
23660 if (w
->phys_cursor_type
== NO_CURSOR
)
23661 goto mark_cursor_off
;
23663 /* VPOS >= active_glyphs->nrows means that window has been resized.
23664 Don't bother to erase the cursor. */
23665 if (vpos
>= active_glyphs
->nrows
)
23666 goto mark_cursor_off
;
23668 /* If row containing cursor is marked invalid, there is nothing we
23670 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23671 if (!cursor_row
->enabled_p
)
23672 goto mark_cursor_off
;
23674 /* If line spacing is > 0, old cursor may only be partially visible in
23675 window after split-window. So adjust visible height. */
23676 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23677 window_text_bottom_y (w
) - cursor_row
->y
);
23679 /* If row is completely invisible, don't attempt to delete a cursor which
23680 isn't there. This can happen if cursor is at top of a window, and
23681 we switch to a buffer with a header line in that window. */
23682 if (cursor_row
->visible_height
<= 0)
23683 goto mark_cursor_off
;
23685 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23686 if (cursor_row
->cursor_in_fringe_p
)
23688 cursor_row
->cursor_in_fringe_p
= 0;
23689 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23690 goto mark_cursor_off
;
23693 /* This can happen when the new row is shorter than the old one.
23694 In this case, either draw_glyphs or clear_end_of_line
23695 should have cleared the cursor. Note that we wouldn't be
23696 able to erase the cursor in this case because we don't have a
23697 cursor glyph at hand. */
23698 if ((cursor_row
->reversed_p
23699 ? (w
->phys_cursor
.hpos
< 0)
23700 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23701 goto mark_cursor_off
;
23703 /* If the cursor is in the mouse face area, redisplay that when
23704 we clear the cursor. */
23705 if (! NILP (hlinfo
->mouse_face_window
)
23706 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23707 /* Don't redraw the cursor's spot in mouse face if it is at the
23708 end of a line (on a newline). The cursor appears there, but
23709 mouse highlighting does not. */
23710 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23711 mouse_face_here_p
= 1;
23713 /* Maybe clear the display under the cursor. */
23714 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23717 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23720 cursor_glyph
= get_phys_cursor_glyph (w
);
23721 if (cursor_glyph
== NULL
)
23722 goto mark_cursor_off
;
23724 width
= cursor_glyph
->pixel_width
;
23725 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23726 x
= w
->phys_cursor
.x
;
23728 width
-= left_x
- x
;
23729 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23730 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23731 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23734 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23737 /* Erase the cursor by redrawing the character underneath it. */
23738 if (mouse_face_here_p
)
23739 hl
= DRAW_MOUSE_FACE
;
23741 hl
= DRAW_NORMAL_TEXT
;
23742 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23745 w
->phys_cursor_on_p
= 0;
23746 w
->phys_cursor_type
= NO_CURSOR
;
23751 Display or clear cursor of window W. If ON is zero, clear the
23752 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23753 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23756 display_and_set_cursor (struct window
*w
, int on
,
23757 int hpos
, int vpos
, int x
, int y
)
23759 struct frame
*f
= XFRAME (w
->frame
);
23760 int new_cursor_type
;
23761 int new_cursor_width
;
23763 struct glyph_row
*glyph_row
;
23764 struct glyph
*glyph
;
23766 /* This is pointless on invisible frames, and dangerous on garbaged
23767 windows and frames; in the latter case, the frame or window may
23768 be in the midst of changing its size, and x and y may be off the
23770 if (! FRAME_VISIBLE_P (f
)
23771 || FRAME_GARBAGED_P (f
)
23772 || vpos
>= w
->current_matrix
->nrows
23773 || hpos
>= w
->current_matrix
->matrix_w
)
23776 /* If cursor is off and we want it off, return quickly. */
23777 if (!on
&& !w
->phys_cursor_on_p
)
23780 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23781 /* If cursor row is not enabled, we don't really know where to
23782 display the cursor. */
23783 if (!glyph_row
->enabled_p
)
23785 w
->phys_cursor_on_p
= 0;
23790 if (!glyph_row
->exact_window_width_line_p
23791 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23792 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23794 xassert (interrupt_input_blocked
);
23796 /* Set new_cursor_type to the cursor we want to be displayed. */
23797 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23798 &new_cursor_width
, &active_cursor
);
23800 /* If cursor is currently being shown and we don't want it to be or
23801 it is in the wrong place, or the cursor type is not what we want,
23803 if (w
->phys_cursor_on_p
23805 || w
->phys_cursor
.x
!= x
23806 || w
->phys_cursor
.y
!= y
23807 || new_cursor_type
!= w
->phys_cursor_type
23808 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23809 && new_cursor_width
!= w
->phys_cursor_width
)))
23810 erase_phys_cursor (w
);
23812 /* Don't check phys_cursor_on_p here because that flag is only set
23813 to zero in some cases where we know that the cursor has been
23814 completely erased, to avoid the extra work of erasing the cursor
23815 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23816 still not be visible, or it has only been partly erased. */
23819 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23820 w
->phys_cursor_height
= glyph_row
->height
;
23822 /* Set phys_cursor_.* before x_draw_.* is called because some
23823 of them may need the information. */
23824 w
->phys_cursor
.x
= x
;
23825 w
->phys_cursor
.y
= glyph_row
->y
;
23826 w
->phys_cursor
.hpos
= hpos
;
23827 w
->phys_cursor
.vpos
= vpos
;
23830 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23831 new_cursor_type
, new_cursor_width
,
23832 on
, active_cursor
);
23836 /* Switch the display of W's cursor on or off, according to the value
23840 update_window_cursor (struct window
*w
, int on
)
23842 /* Don't update cursor in windows whose frame is in the process
23843 of being deleted. */
23844 if (w
->current_matrix
)
23847 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23848 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23854 /* Call update_window_cursor with parameter ON_P on all leaf windows
23855 in the window tree rooted at W. */
23858 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23862 if (!NILP (w
->hchild
))
23863 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23864 else if (!NILP (w
->vchild
))
23865 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23867 update_window_cursor (w
, on_p
);
23869 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23875 Display the cursor on window W, or clear it, according to ON_P.
23876 Don't change the cursor's position. */
23879 x_update_cursor (struct frame
*f
, int on_p
)
23881 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23886 Clear the cursor of window W to background color, and mark the
23887 cursor as not shown. This is used when the text where the cursor
23888 is about to be rewritten. */
23891 x_clear_cursor (struct window
*w
)
23893 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23894 update_window_cursor (w
, 0);
23897 #endif /* HAVE_WINDOW_SYSTEM */
23899 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23902 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23903 int start_hpos
, int end_hpos
,
23904 enum draw_glyphs_face draw
)
23906 #ifdef HAVE_WINDOW_SYSTEM
23907 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23909 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23913 #if defined (HAVE_GPM) || defined (MSDOS)
23914 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23918 /* Display the active region described by mouse_face_* according to DRAW. */
23921 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23923 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23924 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23926 if (/* If window is in the process of being destroyed, don't bother
23928 w
->current_matrix
!= NULL
23929 /* Don't update mouse highlight if hidden */
23930 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23931 /* Recognize when we are called to operate on rows that don't exist
23932 anymore. This can happen when a window is split. */
23933 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23935 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23936 struct glyph_row
*row
, *first
, *last
;
23938 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23939 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23941 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23943 int start_hpos
, end_hpos
, start_x
;
23945 /* For all but the first row, the highlight starts at column 0. */
23948 /* R2L rows have BEG and END in reversed order, but the
23949 screen drawing geometry is always left to right. So
23950 we need to mirror the beginning and end of the
23951 highlighted area in R2L rows. */
23952 if (!row
->reversed_p
)
23954 start_hpos
= hlinfo
->mouse_face_beg_col
;
23955 start_x
= hlinfo
->mouse_face_beg_x
;
23957 else if (row
== last
)
23959 start_hpos
= hlinfo
->mouse_face_end_col
;
23960 start_x
= hlinfo
->mouse_face_end_x
;
23968 else if (row
->reversed_p
&& row
== last
)
23970 start_hpos
= hlinfo
->mouse_face_end_col
;
23971 start_x
= hlinfo
->mouse_face_end_x
;
23981 if (!row
->reversed_p
)
23982 end_hpos
= hlinfo
->mouse_face_end_col
;
23983 else if (row
== first
)
23984 end_hpos
= hlinfo
->mouse_face_beg_col
;
23987 end_hpos
= row
->used
[TEXT_AREA
];
23988 if (draw
== DRAW_NORMAL_TEXT
)
23989 row
->fill_line_p
= 1; /* Clear to end of line */
23992 else if (row
->reversed_p
&& row
== first
)
23993 end_hpos
= hlinfo
->mouse_face_beg_col
;
23996 end_hpos
= row
->used
[TEXT_AREA
];
23997 if (draw
== DRAW_NORMAL_TEXT
)
23998 row
->fill_line_p
= 1; /* Clear to end of line */
24001 if (end_hpos
> start_hpos
)
24003 draw_row_with_mouse_face (w
, start_x
, row
,
24004 start_hpos
, end_hpos
, draw
);
24007 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24011 #ifdef HAVE_WINDOW_SYSTEM
24012 /* When we've written over the cursor, arrange for it to
24013 be displayed again. */
24014 if (FRAME_WINDOW_P (f
)
24015 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24018 display_and_set_cursor (w
, 1,
24019 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24020 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24023 #endif /* HAVE_WINDOW_SYSTEM */
24026 #ifdef HAVE_WINDOW_SYSTEM
24027 /* Change the mouse cursor. */
24028 if (FRAME_WINDOW_P (f
))
24030 if (draw
== DRAW_NORMAL_TEXT
24031 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24032 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24033 else if (draw
== DRAW_MOUSE_FACE
)
24034 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24036 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24038 #endif /* HAVE_WINDOW_SYSTEM */
24042 Clear out the mouse-highlighted active region.
24043 Redraw it un-highlighted first. Value is non-zero if mouse
24044 face was actually drawn unhighlighted. */
24047 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24051 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24053 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24057 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24058 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24059 hlinfo
->mouse_face_window
= Qnil
;
24060 hlinfo
->mouse_face_overlay
= Qnil
;
24064 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24065 within the mouse face on that window. */
24067 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24069 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24071 /* Quickly resolve the easy cases. */
24072 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24073 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24075 if (vpos
< hlinfo
->mouse_face_beg_row
24076 || vpos
> hlinfo
->mouse_face_end_row
)
24078 if (vpos
> hlinfo
->mouse_face_beg_row
24079 && vpos
< hlinfo
->mouse_face_end_row
)
24082 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24084 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24086 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24089 else if ((vpos
== hlinfo
->mouse_face_beg_row
24090 && hpos
>= hlinfo
->mouse_face_beg_col
)
24091 || (vpos
== hlinfo
->mouse_face_end_row
24092 && hpos
< hlinfo
->mouse_face_end_col
))
24097 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24099 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24102 else if ((vpos
== hlinfo
->mouse_face_beg_row
24103 && hpos
<= hlinfo
->mouse_face_beg_col
)
24104 || (vpos
== hlinfo
->mouse_face_end_row
24105 && hpos
> hlinfo
->mouse_face_end_col
))
24113 Non-zero if physical cursor of window W is within mouse face. */
24116 cursor_in_mouse_face_p (struct window
*w
)
24118 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24123 /* Find the glyph rows START_ROW and END_ROW of window W that display
24124 characters between buffer positions START_CHARPOS and END_CHARPOS
24125 (excluding END_CHARPOS). This is similar to row_containing_pos,
24126 but is more accurate when bidi reordering makes buffer positions
24127 change non-linearly with glyph rows. */
24129 rows_from_pos_range (struct window
*w
,
24130 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24131 struct glyph_row
**start
, struct glyph_row
**end
)
24133 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24134 int last_y
= window_text_bottom_y (w
);
24135 struct glyph_row
*row
;
24140 while (!first
->enabled_p
24141 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24144 /* Find the START row. */
24146 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24149 /* A row can potentially be the START row if the range of the
24150 characters it displays intersects the range
24151 [START_CHARPOS..END_CHARPOS). */
24152 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24153 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24154 /* See the commentary in row_containing_pos, for the
24155 explanation of the complicated way to check whether
24156 some position is beyond the end of the characters
24157 displayed by a row. */
24158 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24159 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24160 && !row
->ends_at_zv_p
24161 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24162 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24163 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24164 && !row
->ends_at_zv_p
24165 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24167 /* Found a candidate row. Now make sure at least one of the
24168 glyphs it displays has a charpos from the range
24169 [START_CHARPOS..END_CHARPOS).
24171 This is not obvious because bidi reordering could make
24172 buffer positions of a row be 1,2,3,102,101,100, and if we
24173 want to highlight characters in [50..60), we don't want
24174 this row, even though [50..60) does intersect [1..103),
24175 the range of character positions given by the row's start
24176 and end positions. */
24177 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24178 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24182 if (BUFFERP (g
->object
)
24183 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24192 /* Find the END row. */
24194 /* If the last row is partially visible, start looking for END
24195 from that row, instead of starting from FIRST. */
24196 && !(row
->enabled_p
24197 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24199 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24201 struct glyph_row
*next
= row
+ 1;
24203 if (!next
->enabled_p
24204 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24205 /* The first row >= START whose range of displayed characters
24206 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24207 is the row END + 1. */
24208 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24209 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24210 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24211 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24212 && !next
->ends_at_zv_p
24213 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24214 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24215 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24216 && !next
->ends_at_zv_p
24217 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24224 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24225 but none of the characters it displays are in the range, it is
24227 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24228 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24232 if (BUFFERP (g
->object
)
24233 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24246 /* This function sets the mouse_face_* elements of HLINFO, assuming
24247 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24248 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24249 for the overlay or run of text properties specifying the mouse
24250 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24251 before-string and after-string that must also be highlighted.
24252 COVER_STRING, if non-nil, is a display string that may cover some
24253 or all of the highlighted text. */
24256 mouse_face_from_buffer_pos (Lisp_Object window
,
24257 Mouse_HLInfo
*hlinfo
,
24258 EMACS_INT mouse_charpos
,
24259 EMACS_INT start_charpos
,
24260 EMACS_INT end_charpos
,
24261 Lisp_Object before_string
,
24262 Lisp_Object after_string
,
24263 Lisp_Object cover_string
)
24265 struct window
*w
= XWINDOW (window
);
24266 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24267 struct glyph_row
*r1
, *r2
;
24268 struct glyph
*glyph
, *end
;
24269 EMACS_INT ignore
, pos
;
24272 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24273 xassert (NILP (before_string
) || STRINGP (before_string
));
24274 xassert (NILP (after_string
) || STRINGP (after_string
));
24276 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24277 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24279 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24280 /* If the before-string or display-string contains newlines,
24281 rows_from_pos_range skips to its last row. Move back. */
24282 if (!NILP (before_string
) || !NILP (cover_string
))
24284 struct glyph_row
*prev
;
24285 while ((prev
= r1
- 1, prev
>= first
)
24286 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24287 && prev
->used
[TEXT_AREA
] > 0)
24289 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24290 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24291 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24293 || !(EQ (glyph
->object
, before_string
)
24294 || EQ (glyph
->object
, cover_string
)))
24301 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24302 hlinfo
->mouse_face_past_end
= 1;
24304 else if (!NILP (after_string
))
24306 /* If the after-string has newlines, advance to its last row. */
24307 struct glyph_row
*next
;
24308 struct glyph_row
*last
24309 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24311 for (next
= r2
+ 1;
24313 && next
->used
[TEXT_AREA
] > 0
24314 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24318 /* The rest of the display engine assumes that mouse_face_beg_row is
24319 either above below mouse_face_end_row or identical to it. But
24320 with bidi-reordered continued lines, the row for START_CHARPOS
24321 could be below the row for END_CHARPOS. If so, swap the rows and
24322 store them in correct order. */
24325 struct glyph_row
*tem
= r2
;
24331 hlinfo
->mouse_face_beg_y
= r1
->y
;
24332 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24333 hlinfo
->mouse_face_end_y
= r2
->y
;
24334 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24336 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24337 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24338 could be anywhere in the row and in any order. The strategy
24339 below is to find the leftmost and the rightmost glyph that
24340 belongs to either of these 3 strings, or whose position is
24341 between START_CHARPOS and END_CHARPOS, and highlight all the
24342 glyphs between those two. This may cover more than just the text
24343 between START_CHARPOS and END_CHARPOS if the range of characters
24344 strides the bidi level boundary, e.g. if the beginning is in R2L
24345 text while the end is in L2R text or vice versa. */
24346 if (!r1
->reversed_p
)
24348 /* This row is in a left to right paragraph. Scan it left to
24350 glyph
= r1
->glyphs
[TEXT_AREA
];
24351 end
= glyph
+ r1
->used
[TEXT_AREA
];
24354 /* Skip truncation glyphs at the start of the glyph row. */
24355 if (r1
->displays_text_p
)
24357 && INTEGERP (glyph
->object
)
24358 && glyph
->charpos
< 0;
24360 x
+= glyph
->pixel_width
;
24362 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24363 or COVER_STRING, and the first glyph from buffer whose
24364 position is between START_CHARPOS and END_CHARPOS. */
24366 && !INTEGERP (glyph
->object
)
24367 && !EQ (glyph
->object
, cover_string
)
24368 && !(BUFFERP (glyph
->object
)
24369 && (glyph
->charpos
>= start_charpos
24370 && glyph
->charpos
< end_charpos
));
24373 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24374 are present at buffer positions between START_CHARPOS and
24375 END_CHARPOS, or if they come from an overlay. */
24376 if (EQ (glyph
->object
, before_string
))
24378 pos
= string_buffer_position (before_string
,
24380 /* If pos == 0, it means before_string came from an
24381 overlay, not from a buffer position. */
24382 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24385 else if (EQ (glyph
->object
, after_string
))
24387 pos
= string_buffer_position (after_string
, end_charpos
);
24388 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24391 x
+= glyph
->pixel_width
;
24393 hlinfo
->mouse_face_beg_x
= x
;
24394 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24398 /* This row is in a right to left paragraph. Scan it right to
24402 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24403 glyph
= end
+ r1
->used
[TEXT_AREA
];
24405 /* Skip truncation glyphs at the start of the glyph row. */
24406 if (r1
->displays_text_p
)
24408 && INTEGERP (glyph
->object
)
24409 && glyph
->charpos
< 0;
24413 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24414 or COVER_STRING, and the first glyph from buffer whose
24415 position is between START_CHARPOS and END_CHARPOS. */
24417 && !INTEGERP (glyph
->object
)
24418 && !EQ (glyph
->object
, cover_string
)
24419 && !(BUFFERP (glyph
->object
)
24420 && (glyph
->charpos
>= start_charpos
24421 && glyph
->charpos
< end_charpos
));
24424 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24425 are present at buffer positions between START_CHARPOS and
24426 END_CHARPOS, or if they come from an overlay. */
24427 if (EQ (glyph
->object
, before_string
))
24429 pos
= string_buffer_position (before_string
, start_charpos
);
24430 /* If pos == 0, it means before_string came from an
24431 overlay, not from a buffer position. */
24432 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24435 else if (EQ (glyph
->object
, after_string
))
24437 pos
= string_buffer_position (after_string
, end_charpos
);
24438 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24443 glyph
++; /* first glyph to the right of the highlighted area */
24444 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24445 x
+= g
->pixel_width
;
24446 hlinfo
->mouse_face_beg_x
= x
;
24447 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24450 /* If the highlight ends in a different row, compute GLYPH and END
24451 for the end row. Otherwise, reuse the values computed above for
24452 the row where the highlight begins. */
24455 if (!r2
->reversed_p
)
24457 glyph
= r2
->glyphs
[TEXT_AREA
];
24458 end
= glyph
+ r2
->used
[TEXT_AREA
];
24463 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24464 glyph
= end
+ r2
->used
[TEXT_AREA
];
24468 if (!r2
->reversed_p
)
24470 /* Skip truncation and continuation glyphs near the end of the
24471 row, and also blanks and stretch glyphs inserted by
24472 extend_face_to_end_of_line. */
24474 && INTEGERP ((end
- 1)->object
)
24475 && (end
- 1)->charpos
<= 0)
24477 /* Scan the rest of the glyph row from the end, looking for the
24478 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24479 COVER_STRING, or whose position is between START_CHARPOS
24483 && !INTEGERP (end
->object
)
24484 && !EQ (end
->object
, cover_string
)
24485 && !(BUFFERP (end
->object
)
24486 && (end
->charpos
>= start_charpos
24487 && end
->charpos
< end_charpos
));
24490 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24491 are present at buffer positions between START_CHARPOS and
24492 END_CHARPOS, or if they come from an overlay. */
24493 if (EQ (end
->object
, before_string
))
24495 pos
= string_buffer_position (before_string
, start_charpos
);
24496 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24499 else if (EQ (end
->object
, after_string
))
24501 pos
= string_buffer_position (after_string
, end_charpos
);
24502 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24506 /* Find the X coordinate of the last glyph to be highlighted. */
24507 for (; glyph
<= end
; ++glyph
)
24508 x
+= glyph
->pixel_width
;
24510 hlinfo
->mouse_face_end_x
= x
;
24511 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24515 /* Skip truncation and continuation glyphs near the end of the
24516 row, and also blanks and stretch glyphs inserted by
24517 extend_face_to_end_of_line. */
24521 && INTEGERP (end
->object
)
24522 && end
->charpos
<= 0)
24524 x
+= end
->pixel_width
;
24527 /* Scan the rest of the glyph row from the end, looking for the
24528 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24529 COVER_STRING, or whose position is between START_CHARPOS
24533 && !INTEGERP (end
->object
)
24534 && !EQ (end
->object
, cover_string
)
24535 && !(BUFFERP (end
->object
)
24536 && (end
->charpos
>= start_charpos
24537 && end
->charpos
< end_charpos
));
24540 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24541 are present at buffer positions between START_CHARPOS and
24542 END_CHARPOS, or if they come from an overlay. */
24543 if (EQ (end
->object
, before_string
))
24545 pos
= string_buffer_position (before_string
, start_charpos
);
24546 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24549 else if (EQ (end
->object
, after_string
))
24551 pos
= string_buffer_position (after_string
, end_charpos
);
24552 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24555 x
+= end
->pixel_width
;
24557 hlinfo
->mouse_face_end_x
= x
;
24558 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24561 hlinfo
->mouse_face_window
= window
;
24562 hlinfo
->mouse_face_face_id
24563 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24565 !hlinfo
->mouse_face_hidden
, -1);
24566 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24569 /* The following function is not used anymore (replaced with
24570 mouse_face_from_string_pos), but I leave it here for the time
24571 being, in case someone would. */
24573 #if 0 /* not used */
24575 /* Find the position of the glyph for position POS in OBJECT in
24576 window W's current matrix, and return in *X, *Y the pixel
24577 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24579 RIGHT_P non-zero means return the position of the right edge of the
24580 glyph, RIGHT_P zero means return the left edge position.
24582 If no glyph for POS exists in the matrix, return the position of
24583 the glyph with the next smaller position that is in the matrix, if
24584 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24585 exists in the matrix, return the position of the glyph with the
24586 next larger position in OBJECT.
24588 Value is non-zero if a glyph was found. */
24591 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24592 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24594 int yb
= window_text_bottom_y (w
);
24595 struct glyph_row
*r
;
24596 struct glyph
*best_glyph
= NULL
;
24597 struct glyph_row
*best_row
= NULL
;
24600 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24601 r
->enabled_p
&& r
->y
< yb
;
24604 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24605 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24608 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24609 if (EQ (g
->object
, object
))
24611 if (g
->charpos
== pos
)
24618 else if (best_glyph
== NULL
24619 || ((eabs (g
->charpos
- pos
)
24620 < eabs (best_glyph
->charpos
- pos
))
24623 : g
->charpos
> pos
)))
24637 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24641 *x
+= best_glyph
->pixel_width
;
24646 *vpos
= best_row
- w
->current_matrix
->rows
;
24649 return best_glyph
!= NULL
;
24651 #endif /* not used */
24653 /* Find the positions of the first and the last glyphs in window W's
24654 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24655 (assumed to be a string), and return in HLINFO's mouse_face_*
24656 members the pixel and column/row coordinates of those glyphs. */
24659 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24660 Lisp_Object object
,
24661 EMACS_INT startpos
, EMACS_INT endpos
)
24663 int yb
= window_text_bottom_y (w
);
24664 struct glyph_row
*r
;
24665 struct glyph
*g
, *e
;
24669 /* Find the glyph row with at least one position in the range
24670 [STARTPOS..ENDPOS], and the first glyph in that row whose
24671 position belongs to that range. */
24672 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24673 r
->enabled_p
&& r
->y
< yb
;
24676 if (!r
->reversed_p
)
24678 g
= r
->glyphs
[TEXT_AREA
];
24679 e
= g
+ r
->used
[TEXT_AREA
];
24680 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24681 if (EQ (g
->object
, object
)
24682 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24684 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24685 hlinfo
->mouse_face_beg_y
= r
->y
;
24686 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24687 hlinfo
->mouse_face_beg_x
= gx
;
24696 e
= r
->glyphs
[TEXT_AREA
];
24697 g
= e
+ r
->used
[TEXT_AREA
];
24698 for ( ; g
> e
; --g
)
24699 if (EQ ((g
-1)->object
, object
)
24700 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24702 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24703 hlinfo
->mouse_face_beg_y
= r
->y
;
24704 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24705 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24706 gx
+= g1
->pixel_width
;
24707 hlinfo
->mouse_face_beg_x
= gx
;
24719 /* Starting with the next row, look for the first row which does NOT
24720 include any glyphs whose positions are in the range. */
24721 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24723 g
= r
->glyphs
[TEXT_AREA
];
24724 e
= g
+ r
->used
[TEXT_AREA
];
24726 for ( ; g
< e
; ++g
)
24727 if (EQ (g
->object
, object
)
24728 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24737 /* The highlighted region ends on the previous row. */
24740 /* Set the end row and its vertical pixel coordinate. */
24741 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24742 hlinfo
->mouse_face_end_y
= r
->y
;
24744 /* Compute and set the end column and the end column's horizontal
24745 pixel coordinate. */
24746 if (!r
->reversed_p
)
24748 g
= r
->glyphs
[TEXT_AREA
];
24749 e
= g
+ r
->used
[TEXT_AREA
];
24750 for ( ; e
> g
; --e
)
24751 if (EQ ((e
-1)->object
, object
)
24752 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24754 hlinfo
->mouse_face_end_col
= e
- g
;
24756 for (gx
= r
->x
; g
< e
; ++g
)
24757 gx
+= g
->pixel_width
;
24758 hlinfo
->mouse_face_end_x
= gx
;
24762 e
= r
->glyphs
[TEXT_AREA
];
24763 g
= e
+ r
->used
[TEXT_AREA
];
24764 for (gx
= r
->x
; e
< g
; ++e
)
24766 if (EQ (e
->object
, object
)
24767 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24769 gx
+= e
->pixel_width
;
24771 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24772 hlinfo
->mouse_face_end_x
= gx
;
24776 #ifdef HAVE_WINDOW_SYSTEM
24778 /* See if position X, Y is within a hot-spot of an image. */
24781 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24783 if (!CONSP (hot_spot
))
24786 if (EQ (XCAR (hot_spot
), Qrect
))
24788 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24789 Lisp_Object rect
= XCDR (hot_spot
);
24793 if (!CONSP (XCAR (rect
)))
24795 if (!CONSP (XCDR (rect
)))
24797 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24799 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24801 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24803 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24807 else if (EQ (XCAR (hot_spot
), Qcircle
))
24809 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24810 Lisp_Object circ
= XCDR (hot_spot
);
24811 Lisp_Object lr
, lx0
, ly0
;
24813 && CONSP (XCAR (circ
))
24814 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24815 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24816 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24818 double r
= XFLOATINT (lr
);
24819 double dx
= XINT (lx0
) - x
;
24820 double dy
= XINT (ly0
) - y
;
24821 return (dx
* dx
+ dy
* dy
<= r
* r
);
24824 else if (EQ (XCAR (hot_spot
), Qpoly
))
24826 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24827 if (VECTORP (XCDR (hot_spot
)))
24829 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24830 Lisp_Object
*poly
= v
->contents
;
24834 Lisp_Object lx
, ly
;
24837 /* Need an even number of coordinates, and at least 3 edges. */
24838 if (n
< 6 || n
& 1)
24841 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24842 If count is odd, we are inside polygon. Pixels on edges
24843 may or may not be included depending on actual geometry of the
24845 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24846 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24848 x0
= XINT (lx
), y0
= XINT (ly
);
24849 for (i
= 0; i
< n
; i
+= 2)
24851 int x1
= x0
, y1
= y0
;
24852 if ((lx
= poly
[i
], !INTEGERP (lx
))
24853 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24855 x0
= XINT (lx
), y0
= XINT (ly
);
24857 /* Does this segment cross the X line? */
24865 if (y
> y0
&& y
> y1
)
24867 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24877 find_hot_spot (Lisp_Object map
, int x
, int y
)
24879 while (CONSP (map
))
24881 if (CONSP (XCAR (map
))
24882 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24890 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24892 doc
: /* Lookup in image map MAP coordinates X and Y.
24893 An image map is an alist where each element has the format (AREA ID PLIST).
24894 An AREA is specified as either a rectangle, a circle, or a polygon:
24895 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24896 pixel coordinates of the upper left and bottom right corners.
24897 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24898 and the radius of the circle; r may be a float or integer.
24899 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24900 vector describes one corner in the polygon.
24901 Returns the alist element for the first matching AREA in MAP. */)
24902 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24910 return find_hot_spot (map
, XINT (x
), XINT (y
));
24914 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24916 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24918 /* Do not change cursor shape while dragging mouse. */
24919 if (!NILP (do_mouse_tracking
))
24922 if (!NILP (pointer
))
24924 if (EQ (pointer
, Qarrow
))
24925 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24926 else if (EQ (pointer
, Qhand
))
24927 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24928 else if (EQ (pointer
, Qtext
))
24929 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24930 else if (EQ (pointer
, intern ("hdrag")))
24931 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24932 #ifdef HAVE_X_WINDOWS
24933 else if (EQ (pointer
, intern ("vdrag")))
24934 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24936 else if (EQ (pointer
, intern ("hourglass")))
24937 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24938 else if (EQ (pointer
, Qmodeline
))
24939 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24941 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24944 if (cursor
!= No_Cursor
)
24945 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24948 #endif /* HAVE_WINDOW_SYSTEM */
24950 /* Take proper action when mouse has moved to the mode or header line
24951 or marginal area AREA of window W, x-position X and y-position Y.
24952 X is relative to the start of the text display area of W, so the
24953 width of bitmap areas and scroll bars must be subtracted to get a
24954 position relative to the start of the mode line. */
24957 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24958 enum window_part area
)
24960 struct window
*w
= XWINDOW (window
);
24961 struct frame
*f
= XFRAME (w
->frame
);
24962 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24963 #ifdef HAVE_WINDOW_SYSTEM
24964 Display_Info
*dpyinfo
;
24966 Cursor cursor
= No_Cursor
;
24967 Lisp_Object pointer
= Qnil
;
24968 int dx
, dy
, width
, height
;
24970 Lisp_Object string
, object
= Qnil
;
24971 Lisp_Object pos
, help
;
24973 Lisp_Object mouse_face
;
24974 int original_x_pixel
= x
;
24975 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24976 struct glyph_row
*row
;
24978 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24983 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24984 returns them in row/column units! */
24985 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24986 &object
, &dx
, &dy
, &width
, &height
);
24988 row
= (area
== ON_MODE_LINE
24989 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24990 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24992 /* Find the glyph under the mouse pointer. */
24993 if (row
->mode_line_p
&& row
->enabled_p
)
24995 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24996 end
= glyph
+ row
->used
[TEXT_AREA
];
24998 for (x0
= original_x_pixel
;
24999 glyph
< end
&& x0
>= glyph
->pixel_width
;
25001 x0
-= glyph
->pixel_width
;
25009 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25010 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25011 returns them in row/column units! */
25012 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25013 &object
, &dx
, &dy
, &width
, &height
);
25018 #ifdef HAVE_WINDOW_SYSTEM
25019 if (IMAGEP (object
))
25021 Lisp_Object image_map
, hotspot
;
25022 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25024 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25026 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25030 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25031 If so, we could look for mouse-enter, mouse-leave
25032 properties in PLIST (and do something...). */
25033 hotspot
= XCDR (hotspot
);
25034 if (CONSP (hotspot
)
25035 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25037 pointer
= Fplist_get (plist
, Qpointer
);
25038 if (NILP (pointer
))
25040 help
= Fplist_get (plist
, Qhelp_echo
);
25043 help_echo_string
= help
;
25044 /* Is this correct? ++kfs */
25045 XSETWINDOW (help_echo_window
, w
);
25046 help_echo_object
= w
->buffer
;
25047 help_echo_pos
= charpos
;
25051 if (NILP (pointer
))
25052 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25054 #endif /* HAVE_WINDOW_SYSTEM */
25056 if (STRINGP (string
))
25058 pos
= make_number (charpos
);
25059 /* If we're on a string with `help-echo' text property, arrange
25060 for the help to be displayed. This is done by setting the
25061 global variable help_echo_string to the help string. */
25064 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25067 help_echo_string
= help
;
25068 XSETWINDOW (help_echo_window
, w
);
25069 help_echo_object
= string
;
25070 help_echo_pos
= charpos
;
25074 #ifdef HAVE_WINDOW_SYSTEM
25075 if (FRAME_WINDOW_P (f
))
25077 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25078 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25079 if (NILP (pointer
))
25080 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25082 /* Change the mouse pointer according to what is under X/Y. */
25084 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25087 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25088 if (!KEYMAPP (map
))
25089 map
= Fget_text_property (pos
, Qkeymap
, string
);
25090 if (!KEYMAPP (map
))
25091 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25096 /* Change the mouse face according to what is under X/Y. */
25097 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25098 if (!NILP (mouse_face
)
25099 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25104 struct glyph
* tmp_glyph
;
25108 int total_pixel_width
;
25109 EMACS_INT begpos
, endpos
, ignore
;
25113 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25114 Qmouse_face
, string
, Qnil
);
25120 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25122 endpos
= SCHARS (string
);
25126 /* Calculate the glyph position GPOS of GLYPH in the
25127 displayed string, relative to the beginning of the
25128 highlighted part of the string.
25130 Note: GPOS is different from CHARPOS. CHARPOS is the
25131 position of GLYPH in the internal string object. A mode
25132 line string format has structures which are converted to
25133 a flattened string by the Emacs Lisp interpreter. The
25134 internal string is an element of those structures. The
25135 displayed string is the flattened string. */
25136 tmp_glyph
= row_start_glyph
;
25137 while (tmp_glyph
< glyph
25138 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25139 && begpos
<= tmp_glyph
->charpos
25140 && tmp_glyph
->charpos
< endpos
)))
25142 gpos
= glyph
- tmp_glyph
;
25144 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25145 the highlighted part of the displayed string to which
25146 GLYPH belongs. Note: GSEQ_LENGTH is different from
25147 SCHARS (STRING), because the latter returns the length of
25148 the internal string. */
25149 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25151 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25152 && begpos
<= tmp_glyph
->charpos
25153 && tmp_glyph
->charpos
< endpos
));
25156 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25158 /* Calculate the total pixel width of all the glyphs between
25159 the beginning of the highlighted area and GLYPH. */
25160 total_pixel_width
= 0;
25161 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25162 total_pixel_width
+= tmp_glyph
->pixel_width
;
25164 /* Pre calculation of re-rendering position. Note: X is in
25165 column units here, after the call to mode_line_string or
25166 marginal_area_string. */
25168 vpos
= (area
== ON_MODE_LINE
25169 ? (w
->current_matrix
)->nrows
- 1
25172 /* If GLYPH's position is included in the region that is
25173 already drawn in mouse face, we have nothing to do. */
25174 if ( EQ (window
, hlinfo
->mouse_face_window
)
25175 && (!row
->reversed_p
25176 ? (hlinfo
->mouse_face_beg_col
<= hpos
25177 && hpos
< hlinfo
->mouse_face_end_col
)
25178 /* In R2L rows we swap BEG and END, see below. */
25179 : (hlinfo
->mouse_face_end_col
<= hpos
25180 && hpos
< hlinfo
->mouse_face_beg_col
))
25181 && hlinfo
->mouse_face_beg_row
== vpos
)
25184 if (clear_mouse_face (hlinfo
))
25185 cursor
= No_Cursor
;
25187 if (!row
->reversed_p
)
25189 hlinfo
->mouse_face_beg_col
= hpos
;
25190 hlinfo
->mouse_face_beg_x
= original_x_pixel
25191 - (total_pixel_width
+ dx
);
25192 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25193 hlinfo
->mouse_face_end_x
= 0;
25197 /* In R2L rows, show_mouse_face expects BEG and END
25198 coordinates to be swapped. */
25199 hlinfo
->mouse_face_end_col
= hpos
;
25200 hlinfo
->mouse_face_end_x
= original_x_pixel
25201 - (total_pixel_width
+ dx
);
25202 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25203 hlinfo
->mouse_face_beg_x
= 0;
25206 hlinfo
->mouse_face_beg_row
= vpos
;
25207 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25208 hlinfo
->mouse_face_beg_y
= 0;
25209 hlinfo
->mouse_face_end_y
= 0;
25210 hlinfo
->mouse_face_past_end
= 0;
25211 hlinfo
->mouse_face_window
= window
;
25213 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25219 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25221 if (NILP (pointer
))
25224 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25225 clear_mouse_face (hlinfo
);
25227 #ifdef HAVE_WINDOW_SYSTEM
25228 if (FRAME_WINDOW_P (f
))
25229 define_frame_cursor1 (f
, cursor
, pointer
);
25235 Take proper action when the mouse has moved to position X, Y on
25236 frame F as regards highlighting characters that have mouse-face
25237 properties. Also de-highlighting chars where the mouse was before.
25238 X and Y can be negative or out of range. */
25241 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25243 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25244 enum window_part part
;
25245 Lisp_Object window
;
25247 Cursor cursor
= No_Cursor
;
25248 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25251 /* When a menu is active, don't highlight because this looks odd. */
25252 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25253 if (popup_activated ())
25257 if (NILP (Vmouse_highlight
)
25258 || !f
->glyphs_initialized_p
25259 || f
->pointer_invisible
)
25262 hlinfo
->mouse_face_mouse_x
= x
;
25263 hlinfo
->mouse_face_mouse_y
= y
;
25264 hlinfo
->mouse_face_mouse_frame
= f
;
25266 if (hlinfo
->mouse_face_defer
)
25269 if (gc_in_progress
)
25271 hlinfo
->mouse_face_deferred_gc
= 1;
25275 /* Which window is that in? */
25276 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25278 /* If we were displaying active text in another window, clear that.
25279 Also clear if we move out of text area in same window. */
25280 if (! EQ (window
, hlinfo
->mouse_face_window
)
25281 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25282 && !NILP (hlinfo
->mouse_face_window
)))
25283 clear_mouse_face (hlinfo
);
25285 /* Not on a window -> return. */
25286 if (!WINDOWP (window
))
25289 /* Reset help_echo_string. It will get recomputed below. */
25290 help_echo_string
= Qnil
;
25292 /* Convert to window-relative pixel coordinates. */
25293 w
= XWINDOW (window
);
25294 frame_to_window_pixel_xy (w
, &x
, &y
);
25296 #ifdef HAVE_WINDOW_SYSTEM
25297 /* Handle tool-bar window differently since it doesn't display a
25299 if (EQ (window
, f
->tool_bar_window
))
25301 note_tool_bar_highlight (f
, x
, y
);
25306 /* Mouse is on the mode, header line or margin? */
25307 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25308 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25310 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25314 #ifdef HAVE_WINDOW_SYSTEM
25315 if (part
== ON_VERTICAL_BORDER
)
25317 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25318 help_echo_string
= build_string ("drag-mouse-1: resize");
25320 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25321 || part
== ON_SCROLL_BAR
)
25322 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25324 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25327 /* Are we in a window whose display is up to date?
25328 And verify the buffer's text has not changed. */
25329 b
= XBUFFER (w
->buffer
);
25330 if (part
== ON_TEXT
25331 && EQ (w
->window_end_valid
, w
->buffer
)
25332 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25333 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25335 int hpos
, vpos
, i
, dx
, dy
, area
;
25337 struct glyph
*glyph
;
25338 Lisp_Object object
;
25339 Lisp_Object mouse_face
= Qnil
, position
;
25340 Lisp_Object
*overlay_vec
= NULL
;
25342 struct buffer
*obuf
;
25343 EMACS_INT obegv
, ozv
;
25346 /* Find the glyph under X/Y. */
25347 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25349 #ifdef HAVE_WINDOW_SYSTEM
25350 /* Look for :pointer property on image. */
25351 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25353 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25354 if (img
!= NULL
&& IMAGEP (img
->spec
))
25356 Lisp_Object image_map
, hotspot
;
25357 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25359 && (hotspot
= find_hot_spot (image_map
,
25360 glyph
->slice
.img
.x
+ dx
,
25361 glyph
->slice
.img
.y
+ dy
),
25363 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25367 /* Could check XCAR (hotspot) to see if we enter/leave
25369 If so, we could look for mouse-enter, mouse-leave
25370 properties in PLIST (and do something...). */
25371 hotspot
= XCDR (hotspot
);
25372 if (CONSP (hotspot
)
25373 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25375 pointer
= Fplist_get (plist
, Qpointer
);
25376 if (NILP (pointer
))
25378 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25379 if (!NILP (help_echo_string
))
25381 help_echo_window
= window
;
25382 help_echo_object
= glyph
->object
;
25383 help_echo_pos
= glyph
->charpos
;
25387 if (NILP (pointer
))
25388 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25391 #endif /* HAVE_WINDOW_SYSTEM */
25393 /* Clear mouse face if X/Y not over text. */
25395 || area
!= TEXT_AREA
25396 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25397 /* Glyph's OBJECT is an integer for glyphs inserted by the
25398 display engine for its internal purposes, like truncation
25399 and continuation glyphs and blanks beyond the end of
25400 line's text on text terminals. If we are over such a
25401 glyph, we are not over any text. */
25402 || INTEGERP (glyph
->object
)
25403 /* R2L rows have a stretch glyph at their front, which
25404 stands for no text, whereas L2R rows have no glyphs at
25405 all beyond the end of text. Treat such stretch glyphs
25406 like we do with NULL glyphs in L2R rows. */
25407 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25408 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25409 && glyph
->type
== STRETCH_GLYPH
25410 && glyph
->avoid_cursor_p
))
25412 if (clear_mouse_face (hlinfo
))
25413 cursor
= No_Cursor
;
25414 #ifdef HAVE_WINDOW_SYSTEM
25415 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25417 if (area
!= TEXT_AREA
)
25418 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25420 pointer
= Vvoid_text_area_pointer
;
25426 pos
= glyph
->charpos
;
25427 object
= glyph
->object
;
25428 if (!STRINGP (object
) && !BUFFERP (object
))
25431 /* If we get an out-of-range value, return now; avoid an error. */
25432 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25435 /* Make the window's buffer temporarily current for
25436 overlays_at and compute_char_face. */
25437 obuf
= current_buffer
;
25438 current_buffer
= b
;
25444 /* Is this char mouse-active or does it have help-echo? */
25445 position
= make_number (pos
);
25447 if (BUFFERP (object
))
25449 /* Put all the overlays we want in a vector in overlay_vec. */
25450 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25451 /* Sort overlays into increasing priority order. */
25452 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25457 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25460 cursor
= No_Cursor
;
25462 /* Check mouse-face highlighting. */
25464 /* If there exists an overlay with mouse-face overlapping
25465 the one we are currently highlighting, we have to
25466 check if we enter the overlapping overlay, and then
25467 highlight only that. */
25468 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25469 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25471 /* Find the highest priority overlay with a mouse-face. */
25472 Lisp_Object overlay
= Qnil
;
25473 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25475 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25476 if (!NILP (mouse_face
))
25477 overlay
= overlay_vec
[i
];
25480 /* If we're highlighting the same overlay as before, there's
25481 no need to do that again. */
25482 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25483 goto check_help_echo
;
25484 hlinfo
->mouse_face_overlay
= overlay
;
25486 /* Clear the display of the old active region, if any. */
25487 if (clear_mouse_face (hlinfo
))
25488 cursor
= No_Cursor
;
25490 /* If no overlay applies, get a text property. */
25491 if (NILP (overlay
))
25492 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25494 /* Next, compute the bounds of the mouse highlighting and
25496 if (!NILP (mouse_face
) && STRINGP (object
))
25498 /* The mouse-highlighting comes from a display string
25499 with a mouse-face. */
25503 s
= Fprevious_single_property_change
25504 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25505 e
= Fnext_single_property_change
25506 (position
, Qmouse_face
, object
, Qnil
);
25508 s
= make_number (0);
25510 e
= make_number (SCHARS (object
) - 1);
25511 mouse_face_from_string_pos (w
, hlinfo
, object
,
25512 XINT (s
), XINT (e
));
25513 hlinfo
->mouse_face_past_end
= 0;
25514 hlinfo
->mouse_face_window
= window
;
25515 hlinfo
->mouse_face_face_id
25516 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25517 glyph
->face_id
, 1);
25518 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25519 cursor
= No_Cursor
;
25523 /* The mouse-highlighting, if any, comes from an overlay
25524 or text property in the buffer. */
25525 Lisp_Object buffer
IF_LINT (= Qnil
);
25526 Lisp_Object cover_string
IF_LINT (= Qnil
);
25528 if (STRINGP (object
))
25530 /* If we are on a display string with no mouse-face,
25531 check if the text under it has one. */
25532 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25533 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25534 pos
= string_buffer_position (object
, start
);
25537 mouse_face
= get_char_property_and_overlay
25538 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25539 buffer
= w
->buffer
;
25540 cover_string
= object
;
25546 cover_string
= Qnil
;
25549 if (!NILP (mouse_face
))
25551 Lisp_Object before
, after
;
25552 Lisp_Object before_string
, after_string
;
25553 /* To correctly find the limits of mouse highlight
25554 in a bidi-reordered buffer, we must not use the
25555 optimization of limiting the search in
25556 previous-single-property-change and
25557 next-single-property-change, because
25558 rows_from_pos_range needs the real start and end
25559 positions to DTRT in this case. That's because
25560 the first row visible in a window does not
25561 necessarily display the character whose position
25562 is the smallest. */
25564 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25565 ? Fmarker_position (w
->start
)
25568 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25569 ? make_number (BUF_Z (XBUFFER (buffer
))
25570 - XFASTINT (w
->window_end_pos
))
25573 if (NILP (overlay
))
25575 /* Handle the text property case. */
25576 before
= Fprevious_single_property_change
25577 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25578 after
= Fnext_single_property_change
25579 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25580 before_string
= after_string
= Qnil
;
25584 /* Handle the overlay case. */
25585 before
= Foverlay_start (overlay
);
25586 after
= Foverlay_end (overlay
);
25587 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25588 after_string
= Foverlay_get (overlay
, Qafter_string
);
25590 if (!STRINGP (before_string
)) before_string
= Qnil
;
25591 if (!STRINGP (after_string
)) after_string
= Qnil
;
25594 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25597 before_string
, after_string
,
25599 cursor
= No_Cursor
;
25606 /* Look for a `help-echo' property. */
25607 if (NILP (help_echo_string
)) {
25608 Lisp_Object help
, overlay
;
25610 /* Check overlays first. */
25611 help
= overlay
= Qnil
;
25612 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25614 overlay
= overlay_vec
[i
];
25615 help
= Foverlay_get (overlay
, Qhelp_echo
);
25620 help_echo_string
= help
;
25621 help_echo_window
= window
;
25622 help_echo_object
= overlay
;
25623 help_echo_pos
= pos
;
25627 Lisp_Object obj
= glyph
->object
;
25628 EMACS_INT charpos
= glyph
->charpos
;
25630 /* Try text properties. */
25633 && charpos
< SCHARS (obj
))
25635 help
= Fget_text_property (make_number (charpos
),
25639 /* If the string itself doesn't specify a help-echo,
25640 see if the buffer text ``under'' it does. */
25641 struct glyph_row
*r
25642 = MATRIX_ROW (w
->current_matrix
, vpos
);
25643 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25644 EMACS_INT p
= string_buffer_position (obj
, start
);
25647 help
= Fget_char_property (make_number (p
),
25648 Qhelp_echo
, w
->buffer
);
25657 else if (BUFFERP (obj
)
25660 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25665 help_echo_string
= help
;
25666 help_echo_window
= window
;
25667 help_echo_object
= obj
;
25668 help_echo_pos
= charpos
;
25673 #ifdef HAVE_WINDOW_SYSTEM
25674 /* Look for a `pointer' property. */
25675 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25677 /* Check overlays first. */
25678 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25679 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25681 if (NILP (pointer
))
25683 Lisp_Object obj
= glyph
->object
;
25684 EMACS_INT charpos
= glyph
->charpos
;
25686 /* Try text properties. */
25689 && charpos
< SCHARS (obj
))
25691 pointer
= Fget_text_property (make_number (charpos
),
25693 if (NILP (pointer
))
25695 /* If the string itself doesn't specify a pointer,
25696 see if the buffer text ``under'' it does. */
25697 struct glyph_row
*r
25698 = MATRIX_ROW (w
->current_matrix
, vpos
);
25699 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25700 EMACS_INT p
= string_buffer_position (obj
, start
);
25702 pointer
= Fget_char_property (make_number (p
),
25703 Qpointer
, w
->buffer
);
25706 else if (BUFFERP (obj
)
25709 pointer
= Fget_text_property (make_number (charpos
),
25713 #endif /* HAVE_WINDOW_SYSTEM */
25717 current_buffer
= obuf
;
25722 #ifdef HAVE_WINDOW_SYSTEM
25723 if (FRAME_WINDOW_P (f
))
25724 define_frame_cursor1 (f
, cursor
, pointer
);
25726 /* This is here to prevent a compiler error, about "label at end of
25727 compound statement". */
25734 Clear any mouse-face on window W. This function is part of the
25735 redisplay interface, and is called from try_window_id and similar
25736 functions to ensure the mouse-highlight is off. */
25739 x_clear_window_mouse_face (struct window
*w
)
25741 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25742 Lisp_Object window
;
25745 XSETWINDOW (window
, w
);
25746 if (EQ (window
, hlinfo
->mouse_face_window
))
25747 clear_mouse_face (hlinfo
);
25753 Just discard the mouse face information for frame F, if any.
25754 This is used when the size of F is changed. */
25757 cancel_mouse_face (struct frame
*f
)
25759 Lisp_Object window
;
25760 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25762 window
= hlinfo
->mouse_face_window
;
25763 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25765 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25766 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25767 hlinfo
->mouse_face_window
= Qnil
;
25773 /***********************************************************************
25775 ***********************************************************************/
25777 #ifdef HAVE_WINDOW_SYSTEM
25779 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25780 which intersects rectangle R. R is in window-relative coordinates. */
25783 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25784 enum glyph_row_area area
)
25786 struct glyph
*first
= row
->glyphs
[area
];
25787 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25788 struct glyph
*last
;
25789 int first_x
, start_x
, x
;
25791 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25792 /* If row extends face to end of line write the whole line. */
25793 draw_glyphs (w
, 0, row
, area
,
25794 0, row
->used
[area
],
25795 DRAW_NORMAL_TEXT
, 0);
25798 /* Set START_X to the window-relative start position for drawing glyphs of
25799 AREA. The first glyph of the text area can be partially visible.
25800 The first glyphs of other areas cannot. */
25801 start_x
= window_box_left_offset (w
, area
);
25803 if (area
== TEXT_AREA
)
25806 /* Find the first glyph that must be redrawn. */
25808 && x
+ first
->pixel_width
< r
->x
)
25810 x
+= first
->pixel_width
;
25814 /* Find the last one. */
25818 && x
< r
->x
+ r
->width
)
25820 x
+= last
->pixel_width
;
25826 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25827 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25828 DRAW_NORMAL_TEXT
, 0);
25833 /* Redraw the parts of the glyph row ROW on window W intersecting
25834 rectangle R. R is in window-relative coordinates. Value is
25835 non-zero if mouse-face was overwritten. */
25838 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25840 xassert (row
->enabled_p
);
25842 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25843 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25844 0, row
->used
[TEXT_AREA
],
25845 DRAW_NORMAL_TEXT
, 0);
25848 if (row
->used
[LEFT_MARGIN_AREA
])
25849 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25850 if (row
->used
[TEXT_AREA
])
25851 expose_area (w
, row
, r
, TEXT_AREA
);
25852 if (row
->used
[RIGHT_MARGIN_AREA
])
25853 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25854 draw_row_fringe_bitmaps (w
, row
);
25857 return row
->mouse_face_p
;
25861 /* Redraw those parts of glyphs rows during expose event handling that
25862 overlap other rows. Redrawing of an exposed line writes over parts
25863 of lines overlapping that exposed line; this function fixes that.
25865 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25866 row in W's current matrix that is exposed and overlaps other rows.
25867 LAST_OVERLAPPING_ROW is the last such row. */
25870 expose_overlaps (struct window
*w
,
25871 struct glyph_row
*first_overlapping_row
,
25872 struct glyph_row
*last_overlapping_row
,
25875 struct glyph_row
*row
;
25877 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25878 if (row
->overlapping_p
)
25880 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25883 if (row
->used
[LEFT_MARGIN_AREA
])
25884 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25886 if (row
->used
[TEXT_AREA
])
25887 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25889 if (row
->used
[RIGHT_MARGIN_AREA
])
25890 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25896 /* Return non-zero if W's cursor intersects rectangle R. */
25899 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25901 XRectangle cr
, result
;
25902 struct glyph
*cursor_glyph
;
25903 struct glyph_row
*row
;
25905 if (w
->phys_cursor
.vpos
>= 0
25906 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25907 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25909 && row
->cursor_in_fringe_p
)
25911 /* Cursor is in the fringe. */
25912 cr
.x
= window_box_right_offset (w
,
25913 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25914 ? RIGHT_MARGIN_AREA
25917 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25918 cr
.height
= row
->height
;
25919 return x_intersect_rectangles (&cr
, r
, &result
);
25922 cursor_glyph
= get_phys_cursor_glyph (w
);
25925 /* r is relative to W's box, but w->phys_cursor.x is relative
25926 to left edge of W's TEXT area. Adjust it. */
25927 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25928 cr
.y
= w
->phys_cursor
.y
;
25929 cr
.width
= cursor_glyph
->pixel_width
;
25930 cr
.height
= w
->phys_cursor_height
;
25931 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25932 I assume the effect is the same -- and this is portable. */
25933 return x_intersect_rectangles (&cr
, r
, &result
);
25935 /* If we don't understand the format, pretend we're not in the hot-spot. */
25941 Draw a vertical window border to the right of window W if W doesn't
25942 have vertical scroll bars. */
25945 x_draw_vertical_border (struct window
*w
)
25947 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25949 /* We could do better, if we knew what type of scroll-bar the adjacent
25950 windows (on either side) have... But we don't :-(
25951 However, I think this works ok. ++KFS 2003-04-25 */
25953 /* Redraw borders between horizontally adjacent windows. Don't
25954 do it for frames with vertical scroll bars because either the
25955 right scroll bar of a window, or the left scroll bar of its
25956 neighbor will suffice as a border. */
25957 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25960 if (!WINDOW_RIGHTMOST_P (w
)
25961 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25963 int x0
, x1
, y0
, y1
;
25965 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25968 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25971 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25973 else if (!WINDOW_LEFTMOST_P (w
)
25974 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25976 int x0
, x1
, y0
, y1
;
25978 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25981 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25984 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25989 /* Redraw the part of window W intersection rectangle FR. Pixel
25990 coordinates in FR are frame-relative. Call this function with
25991 input blocked. Value is non-zero if the exposure overwrites
25995 expose_window (struct window
*w
, XRectangle
*fr
)
25997 struct frame
*f
= XFRAME (w
->frame
);
25999 int mouse_face_overwritten_p
= 0;
26001 /* If window is not yet fully initialized, do nothing. This can
26002 happen when toolkit scroll bars are used and a window is split.
26003 Reconfiguring the scroll bar will generate an expose for a newly
26005 if (w
->current_matrix
== NULL
)
26008 /* When we're currently updating the window, display and current
26009 matrix usually don't agree. Arrange for a thorough display
26011 if (w
== updated_window
)
26013 SET_FRAME_GARBAGED (f
);
26017 /* Frame-relative pixel rectangle of W. */
26018 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26019 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26020 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26021 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26023 if (x_intersect_rectangles (fr
, &wr
, &r
))
26025 int yb
= window_text_bottom_y (w
);
26026 struct glyph_row
*row
;
26027 int cursor_cleared_p
;
26028 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26030 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26031 r
.x
, r
.y
, r
.width
, r
.height
));
26033 /* Convert to window coordinates. */
26034 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26035 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26037 /* Turn off the cursor. */
26038 if (!w
->pseudo_window_p
26039 && phys_cursor_in_rect_p (w
, &r
))
26041 x_clear_cursor (w
);
26042 cursor_cleared_p
= 1;
26045 cursor_cleared_p
= 0;
26047 /* Update lines intersecting rectangle R. */
26048 first_overlapping_row
= last_overlapping_row
= NULL
;
26049 for (row
= w
->current_matrix
->rows
;
26054 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26056 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26057 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26058 || (r
.y
>= y0
&& r
.y
< y1
)
26059 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26061 /* A header line may be overlapping, but there is no need
26062 to fix overlapping areas for them. KFS 2005-02-12 */
26063 if (row
->overlapping_p
&& !row
->mode_line_p
)
26065 if (first_overlapping_row
== NULL
)
26066 first_overlapping_row
= row
;
26067 last_overlapping_row
= row
;
26071 if (expose_line (w
, row
, &r
))
26072 mouse_face_overwritten_p
= 1;
26075 else if (row
->overlapping_p
)
26077 /* We must redraw a row overlapping the exposed area. */
26079 ? y0
+ row
->phys_height
> r
.y
26080 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26082 if (first_overlapping_row
== NULL
)
26083 first_overlapping_row
= row
;
26084 last_overlapping_row
= row
;
26092 /* Display the mode line if there is one. */
26093 if (WINDOW_WANTS_MODELINE_P (w
)
26094 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26096 && row
->y
< r
.y
+ r
.height
)
26098 if (expose_line (w
, row
, &r
))
26099 mouse_face_overwritten_p
= 1;
26102 if (!w
->pseudo_window_p
)
26104 /* Fix the display of overlapping rows. */
26105 if (first_overlapping_row
)
26106 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26109 /* Draw border between windows. */
26110 x_draw_vertical_border (w
);
26112 /* Turn the cursor on again. */
26113 if (cursor_cleared_p
)
26114 update_window_cursor (w
, 1);
26118 return mouse_face_overwritten_p
;
26123 /* Redraw (parts) of all windows in the window tree rooted at W that
26124 intersect R. R contains frame pixel coordinates. Value is
26125 non-zero if the exposure overwrites mouse-face. */
26128 expose_window_tree (struct window
*w
, XRectangle
*r
)
26130 struct frame
*f
= XFRAME (w
->frame
);
26131 int mouse_face_overwritten_p
= 0;
26133 while (w
&& !FRAME_GARBAGED_P (f
))
26135 if (!NILP (w
->hchild
))
26136 mouse_face_overwritten_p
26137 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26138 else if (!NILP (w
->vchild
))
26139 mouse_face_overwritten_p
26140 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26142 mouse_face_overwritten_p
|= expose_window (w
, r
);
26144 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26147 return mouse_face_overwritten_p
;
26152 Redisplay an exposed area of frame F. X and Y are the upper-left
26153 corner of the exposed rectangle. W and H are width and height of
26154 the exposed area. All are pixel values. W or H zero means redraw
26155 the entire frame. */
26158 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26161 int mouse_face_overwritten_p
= 0;
26163 TRACE ((stderr
, "expose_frame "));
26165 /* No need to redraw if frame will be redrawn soon. */
26166 if (FRAME_GARBAGED_P (f
))
26168 TRACE ((stderr
, " garbaged\n"));
26172 /* If basic faces haven't been realized yet, there is no point in
26173 trying to redraw anything. This can happen when we get an expose
26174 event while Emacs is starting, e.g. by moving another window. */
26175 if (FRAME_FACE_CACHE (f
) == NULL
26176 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26178 TRACE ((stderr
, " no faces\n"));
26182 if (w
== 0 || h
== 0)
26185 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26186 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26196 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26197 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26199 if (WINDOWP (f
->tool_bar_window
))
26200 mouse_face_overwritten_p
26201 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26203 #ifdef HAVE_X_WINDOWS
26205 #ifndef USE_X_TOOLKIT
26206 if (WINDOWP (f
->menu_bar_window
))
26207 mouse_face_overwritten_p
26208 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26209 #endif /* not USE_X_TOOLKIT */
26213 /* Some window managers support a focus-follows-mouse style with
26214 delayed raising of frames. Imagine a partially obscured frame,
26215 and moving the mouse into partially obscured mouse-face on that
26216 frame. The visible part of the mouse-face will be highlighted,
26217 then the WM raises the obscured frame. With at least one WM, KDE
26218 2.1, Emacs is not getting any event for the raising of the frame
26219 (even tried with SubstructureRedirectMask), only Expose events.
26220 These expose events will draw text normally, i.e. not
26221 highlighted. Which means we must redo the highlight here.
26222 Subsume it under ``we love X''. --gerd 2001-08-15 */
26223 /* Included in Windows version because Windows most likely does not
26224 do the right thing if any third party tool offers
26225 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26226 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26228 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26229 if (f
== hlinfo
->mouse_face_mouse_frame
)
26231 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26232 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26233 clear_mouse_face (hlinfo
);
26234 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26241 Determine the intersection of two rectangles R1 and R2. Return
26242 the intersection in *RESULT. Value is non-zero if RESULT is not
26246 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26248 XRectangle
*left
, *right
;
26249 XRectangle
*upper
, *lower
;
26250 int intersection_p
= 0;
26252 /* Rearrange so that R1 is the left-most rectangle. */
26254 left
= r1
, right
= r2
;
26256 left
= r2
, right
= r1
;
26258 /* X0 of the intersection is right.x0, if this is inside R1,
26259 otherwise there is no intersection. */
26260 if (right
->x
<= left
->x
+ left
->width
)
26262 result
->x
= right
->x
;
26264 /* The right end of the intersection is the minimum of the
26265 the right ends of left and right. */
26266 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26269 /* Same game for Y. */
26271 upper
= r1
, lower
= r2
;
26273 upper
= r2
, lower
= r1
;
26275 /* The upper end of the intersection is lower.y0, if this is inside
26276 of upper. Otherwise, there is no intersection. */
26277 if (lower
->y
<= upper
->y
+ upper
->height
)
26279 result
->y
= lower
->y
;
26281 /* The lower end of the intersection is the minimum of the lower
26282 ends of upper and lower. */
26283 result
->height
= (min (lower
->y
+ lower
->height
,
26284 upper
->y
+ upper
->height
)
26286 intersection_p
= 1;
26290 return intersection_p
;
26293 #endif /* HAVE_WINDOW_SYSTEM */
26296 /***********************************************************************
26298 ***********************************************************************/
26301 syms_of_xdisp (void)
26303 Vwith_echo_area_save_vector
= Qnil
;
26304 staticpro (&Vwith_echo_area_save_vector
);
26306 Vmessage_stack
= Qnil
;
26307 staticpro (&Vmessage_stack
);
26309 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26310 staticpro (&Qinhibit_redisplay
);
26312 message_dolog_marker1
= Fmake_marker ();
26313 staticpro (&message_dolog_marker1
);
26314 message_dolog_marker2
= Fmake_marker ();
26315 staticpro (&message_dolog_marker2
);
26316 message_dolog_marker3
= Fmake_marker ();
26317 staticpro (&message_dolog_marker3
);
26320 defsubr (&Sdump_frame_glyph_matrix
);
26321 defsubr (&Sdump_glyph_matrix
);
26322 defsubr (&Sdump_glyph_row
);
26323 defsubr (&Sdump_tool_bar_row
);
26324 defsubr (&Strace_redisplay
);
26325 defsubr (&Strace_to_stderr
);
26327 #ifdef HAVE_WINDOW_SYSTEM
26328 defsubr (&Stool_bar_lines_needed
);
26329 defsubr (&Slookup_image_map
);
26331 defsubr (&Sformat_mode_line
);
26332 defsubr (&Sinvisible_p
);
26333 defsubr (&Scurrent_bidi_paragraph_direction
);
26335 staticpro (&Qmenu_bar_update_hook
);
26336 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26338 staticpro (&Qoverriding_terminal_local_map
);
26339 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26341 staticpro (&Qoverriding_local_map
);
26342 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26344 staticpro (&Qwindow_scroll_functions
);
26345 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26347 staticpro (&Qwindow_text_change_functions
);
26348 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26350 staticpro (&Qredisplay_end_trigger_functions
);
26351 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26353 staticpro (&Qinhibit_point_motion_hooks
);
26354 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26356 Qeval
= intern_c_string ("eval");
26357 staticpro (&Qeval
);
26359 QCdata
= intern_c_string (":data");
26360 staticpro (&QCdata
);
26361 Qdisplay
= intern_c_string ("display");
26362 staticpro (&Qdisplay
);
26363 Qspace_width
= intern_c_string ("space-width");
26364 staticpro (&Qspace_width
);
26365 Qraise
= intern_c_string ("raise");
26366 staticpro (&Qraise
);
26367 Qslice
= intern_c_string ("slice");
26368 staticpro (&Qslice
);
26369 Qspace
= intern_c_string ("space");
26370 staticpro (&Qspace
);
26371 Qmargin
= intern_c_string ("margin");
26372 staticpro (&Qmargin
);
26373 Qpointer
= intern_c_string ("pointer");
26374 staticpro (&Qpointer
);
26375 Qleft_margin
= intern_c_string ("left-margin");
26376 staticpro (&Qleft_margin
);
26377 Qright_margin
= intern_c_string ("right-margin");
26378 staticpro (&Qright_margin
);
26379 Qcenter
= intern_c_string ("center");
26380 staticpro (&Qcenter
);
26381 Qline_height
= intern_c_string ("line-height");
26382 staticpro (&Qline_height
);
26383 QCalign_to
= intern_c_string (":align-to");
26384 staticpro (&QCalign_to
);
26385 QCrelative_width
= intern_c_string (":relative-width");
26386 staticpro (&QCrelative_width
);
26387 QCrelative_height
= intern_c_string (":relative-height");
26388 staticpro (&QCrelative_height
);
26389 QCeval
= intern_c_string (":eval");
26390 staticpro (&QCeval
);
26391 QCpropertize
= intern_c_string (":propertize");
26392 staticpro (&QCpropertize
);
26393 QCfile
= intern_c_string (":file");
26394 staticpro (&QCfile
);
26395 Qfontified
= intern_c_string ("fontified");
26396 staticpro (&Qfontified
);
26397 Qfontification_functions
= intern_c_string ("fontification-functions");
26398 staticpro (&Qfontification_functions
);
26399 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26400 staticpro (&Qtrailing_whitespace
);
26401 Qescape_glyph
= intern_c_string ("escape-glyph");
26402 staticpro (&Qescape_glyph
);
26403 Qnobreak_space
= intern_c_string ("nobreak-space");
26404 staticpro (&Qnobreak_space
);
26405 Qimage
= intern_c_string ("image");
26406 staticpro (&Qimage
);
26407 Qtext
= intern_c_string ("text");
26408 staticpro (&Qtext
);
26409 Qboth
= intern_c_string ("both");
26410 staticpro (&Qboth
);
26411 Qboth_horiz
= intern_c_string ("both-horiz");
26412 staticpro (&Qboth_horiz
);
26413 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26414 staticpro (&Qtext_image_horiz
);
26415 QCmap
= intern_c_string (":map");
26416 staticpro (&QCmap
);
26417 QCpointer
= intern_c_string (":pointer");
26418 staticpro (&QCpointer
);
26419 Qrect
= intern_c_string ("rect");
26420 staticpro (&Qrect
);
26421 Qcircle
= intern_c_string ("circle");
26422 staticpro (&Qcircle
);
26423 Qpoly
= intern_c_string ("poly");
26424 staticpro (&Qpoly
);
26425 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26426 staticpro (&Qmessage_truncate_lines
);
26427 Qgrow_only
= intern_c_string ("grow-only");
26428 staticpro (&Qgrow_only
);
26429 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26430 staticpro (&Qinhibit_menubar_update
);
26431 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26432 staticpro (&Qinhibit_eval_during_redisplay
);
26433 Qposition
= intern_c_string ("position");
26434 staticpro (&Qposition
);
26435 Qbuffer_position
= intern_c_string ("buffer-position");
26436 staticpro (&Qbuffer_position
);
26437 Qobject
= intern_c_string ("object");
26438 staticpro (&Qobject
);
26439 Qbar
= intern_c_string ("bar");
26441 Qhbar
= intern_c_string ("hbar");
26442 staticpro (&Qhbar
);
26443 Qbox
= intern_c_string ("box");
26445 Qhollow
= intern_c_string ("hollow");
26446 staticpro (&Qhollow
);
26447 Qhand
= intern_c_string ("hand");
26448 staticpro (&Qhand
);
26449 Qarrow
= intern_c_string ("arrow");
26450 staticpro (&Qarrow
);
26451 Qtext
= intern_c_string ("text");
26452 staticpro (&Qtext
);
26453 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26454 staticpro (&Qinhibit_free_realized_faces
);
26456 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26457 Fcons (intern_c_string ("void-variable"), Qnil
)),
26459 staticpro (&list_of_error
);
26461 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26462 staticpro (&Qlast_arrow_position
);
26463 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26464 staticpro (&Qlast_arrow_string
);
26466 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26467 staticpro (&Qoverlay_arrow_string
);
26468 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26469 staticpro (&Qoverlay_arrow_bitmap
);
26471 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26472 staticpro (&echo_buffer
[0]);
26473 staticpro (&echo_buffer
[1]);
26475 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26476 staticpro (&echo_area_buffer
[0]);
26477 staticpro (&echo_area_buffer
[1]);
26479 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26480 staticpro (&Vmessages_buffer_name
);
26482 mode_line_proptrans_alist
= Qnil
;
26483 staticpro (&mode_line_proptrans_alist
);
26484 mode_line_string_list
= Qnil
;
26485 staticpro (&mode_line_string_list
);
26486 mode_line_string_face
= Qnil
;
26487 staticpro (&mode_line_string_face
);
26488 mode_line_string_face_prop
= Qnil
;
26489 staticpro (&mode_line_string_face_prop
);
26490 Vmode_line_unwind_vector
= Qnil
;
26491 staticpro (&Vmode_line_unwind_vector
);
26493 help_echo_string
= Qnil
;
26494 staticpro (&help_echo_string
);
26495 help_echo_object
= Qnil
;
26496 staticpro (&help_echo_object
);
26497 help_echo_window
= Qnil
;
26498 staticpro (&help_echo_window
);
26499 previous_help_echo_string
= Qnil
;
26500 staticpro (&previous_help_echo_string
);
26501 help_echo_pos
= -1;
26503 Qright_to_left
= intern_c_string ("right-to-left");
26504 staticpro (&Qright_to_left
);
26505 Qleft_to_right
= intern_c_string ("left-to-right");
26506 staticpro (&Qleft_to_right
);
26508 #ifdef HAVE_WINDOW_SYSTEM
26509 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26510 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26511 For example, if a block cursor is over a tab, it will be drawn as
26512 wide as that tab on the display. */);
26513 x_stretch_cursor_p
= 0;
26516 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26517 doc
: /* *Non-nil means highlight trailing whitespace.
26518 The face used for trailing whitespace is `trailing-whitespace'. */);
26519 Vshow_trailing_whitespace
= Qnil
;
26521 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26522 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26523 A value of t means highlight the character itself (for nobreak space,
26524 use face `nobreak-space').
26525 A value of nil means no highlighting.
26526 Other values mean display the escape glyph followed by an ordinary
26527 space or ordinary hyphen. */);
26528 Vnobreak_char_display
= Qt
;
26530 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26531 doc
: /* *The pointer shape to show in void text areas.
26532 A value of nil means to show the text pointer. Other options are `arrow',
26533 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26534 Vvoid_text_area_pointer
= Qarrow
;
26536 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26537 doc
: /* Non-nil means don't actually do any redisplay.
26538 This is used for internal purposes. */);
26539 Vinhibit_redisplay
= Qnil
;
26541 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26542 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26543 Vglobal_mode_string
= Qnil
;
26545 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26546 doc
: /* Marker for where to display an arrow on top of the buffer text.
26547 This must be the beginning of a line in order to work.
26548 See also `overlay-arrow-string'. */);
26549 Voverlay_arrow_position
= Qnil
;
26551 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26552 doc
: /* String to display as an arrow in non-window frames.
26553 See also `overlay-arrow-position'. */);
26554 Voverlay_arrow_string
= make_pure_c_string ("=>");
26556 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26557 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26558 The symbols on this list are examined during redisplay to determine
26559 where to display overlay arrows. */);
26560 Voverlay_arrow_variable_list
26561 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26563 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26564 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26565 If that fails to bring point back on frame, point is centered instead.
26566 If this is zero, point is always centered after it moves off frame.
26567 If you want scrolling to always be a line at a time, you should set
26568 `scroll-conservatively' to a large value rather than set this to 1. */);
26570 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26571 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26572 If point moves off-screen, redisplay will scroll by up to
26573 `scroll-conservatively' lines in order to bring point just barely
26574 onto the screen again. If that cannot be done, then redisplay
26575 recenters point as usual.
26577 If the value is greater than 100, redisplay will never recenter point,
26578 but will always scroll just enough text to bring point into view, even
26579 if you move far away.
26581 A value of zero means always recenter point if it moves off screen. */);
26582 scroll_conservatively
= 0;
26584 DEFVAR_INT ("scroll-margin", scroll_margin
,
26585 doc
: /* *Number of lines of margin at the top and bottom of a window.
26586 Recenter the window whenever point gets within this many lines
26587 of the top or bottom of the window. */);
26590 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26591 doc
: /* Pixels per inch value for non-window system displays.
26592 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26593 Vdisplay_pixels_per_inch
= make_float (72.0);
26596 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26599 DEFVAR_LISP ("truncate-partial-width-windows",
26600 Vtruncate_partial_width_windows
,
26601 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26602 For an integer value, truncate lines in each window narrower than the
26603 full frame width, provided the window width is less than that integer;
26604 otherwise, respect the value of `truncate-lines'.
26606 For any other non-nil value, truncate lines in all windows that do
26607 not span the full frame width.
26609 A value of nil means to respect the value of `truncate-lines'.
26611 If `word-wrap' is enabled, you might want to reduce this. */);
26612 Vtruncate_partial_width_windows
= make_number (50);
26614 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26615 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26616 Any other value means to use the appropriate face, `mode-line',
26617 `header-line', or `menu' respectively. */);
26618 mode_line_inverse_video
= 1;
26620 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26621 doc
: /* *Maximum buffer size for which line number should be displayed.
26622 If the buffer is bigger than this, the line number does not appear
26623 in the mode line. A value of nil means no limit. */);
26624 Vline_number_display_limit
= Qnil
;
26626 DEFVAR_INT ("line-number-display-limit-width",
26627 line_number_display_limit_width
,
26628 doc
: /* *Maximum line width (in characters) for line number display.
26629 If the average length of the lines near point is bigger than this, then the
26630 line number may be omitted from the mode line. */);
26631 line_number_display_limit_width
= 200;
26633 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26634 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26635 highlight_nonselected_windows
= 0;
26637 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26638 doc
: /* Non-nil if more than one frame is visible on this display.
26639 Minibuffer-only frames don't count, but iconified frames do.
26640 This variable is not guaranteed to be accurate except while processing
26641 `frame-title-format' and `icon-title-format'. */);
26643 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26644 doc
: /* Template for displaying the title bar of visible frames.
26645 \(Assuming the window manager supports this feature.)
26647 This variable has the same structure as `mode-line-format', except that
26648 the %c and %l constructs are ignored. It is used only on frames for
26649 which no explicit name has been set \(see `modify-frame-parameters'). */);
26651 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26652 doc
: /* Template for displaying the title bar of an iconified frame.
26653 \(Assuming the window manager supports this feature.)
26654 This variable has the same structure as `mode-line-format' (which see),
26655 and is used only on frames for which no explicit name has been set
26656 \(see `modify-frame-parameters'). */);
26658 = Vframe_title_format
26659 = pure_cons (intern_c_string ("multiple-frames"),
26660 pure_cons (make_pure_c_string ("%b"),
26661 pure_cons (pure_cons (empty_unibyte_string
,
26662 pure_cons (intern_c_string ("invocation-name"),
26663 pure_cons (make_pure_c_string ("@"),
26664 pure_cons (intern_c_string ("system-name"),
26668 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26669 doc
: /* Maximum number of lines to keep in the message log buffer.
26670 If nil, disable message logging. If t, log messages but don't truncate
26671 the buffer when it becomes large. */);
26672 Vmessage_log_max
= make_number (100);
26674 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26675 doc
: /* Functions called before redisplay, if window sizes have changed.
26676 The value should be a list of functions that take one argument.
26677 Just before redisplay, for each frame, if any of its windows have changed
26678 size since the last redisplay, or have been split or deleted,
26679 all the functions in the list are called, with the frame as argument. */);
26680 Vwindow_size_change_functions
= Qnil
;
26682 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26683 doc
: /* List of functions to call before redisplaying a window with scrolling.
26684 Each function is called with two arguments, the window and its new
26685 display-start position. Note that these functions are also called by
26686 `set-window-buffer'. Also note that the value of `window-end' is not
26687 valid when these functions are called. */);
26688 Vwindow_scroll_functions
= Qnil
;
26690 DEFVAR_LISP ("window-text-change-functions",
26691 Vwindow_text_change_functions
,
26692 doc
: /* Functions to call in redisplay when text in the window might change. */);
26693 Vwindow_text_change_functions
= Qnil
;
26695 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26696 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26697 Each function is called with two arguments, the window and the end trigger value.
26698 See `set-window-redisplay-end-trigger'. */);
26699 Vredisplay_end_trigger_functions
= Qnil
;
26701 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26702 doc
: /* *Non-nil means autoselect window with mouse pointer.
26703 If nil, do not autoselect windows.
26704 A positive number means delay autoselection by that many seconds: a
26705 window is autoselected only after the mouse has remained in that
26706 window for the duration of the delay.
26707 A negative number has a similar effect, but causes windows to be
26708 autoselected only after the mouse has stopped moving. \(Because of
26709 the way Emacs compares mouse events, you will occasionally wait twice
26710 that time before the window gets selected.\)
26711 Any other value means to autoselect window instantaneously when the
26712 mouse pointer enters it.
26714 Autoselection selects the minibuffer only if it is active, and never
26715 unselects the minibuffer if it is active.
26717 When customizing this variable make sure that the actual value of
26718 `focus-follows-mouse' matches the behavior of your window manager. */);
26719 Vmouse_autoselect_window
= Qnil
;
26721 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26722 doc
: /* *Non-nil means automatically resize tool-bars.
26723 This dynamically changes the tool-bar's height to the minimum height
26724 that is needed to make all tool-bar items visible.
26725 If value is `grow-only', the tool-bar's height is only increased
26726 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26727 Vauto_resize_tool_bars
= Qt
;
26729 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26730 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26731 auto_raise_tool_bar_buttons_p
= 1;
26733 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26734 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26735 make_cursor_line_fully_visible_p
= 1;
26737 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26738 doc
: /* *Border below tool-bar in pixels.
26739 If an integer, use it as the height of the border.
26740 If it is one of `internal-border-width' or `border-width', use the
26741 value of the corresponding frame parameter.
26742 Otherwise, no border is added below the tool-bar. */);
26743 Vtool_bar_border
= Qinternal_border_width
;
26745 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26746 doc
: /* *Margin around tool-bar buttons in pixels.
26747 If an integer, use that for both horizontal and vertical margins.
26748 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26749 HORZ specifying the horizontal margin, and VERT specifying the
26750 vertical margin. */);
26751 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26753 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26754 doc
: /* *Relief thickness of tool-bar buttons. */);
26755 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26757 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26758 doc
: /* Tool bar style to use.
26760 image - show images only
26761 text - show text only
26762 both - show both, text below image
26763 both-horiz - show text to the right of the image
26764 text-image-horiz - show text to the left of the image
26765 any other - use system default or image if no system default. */);
26766 Vtool_bar_style
= Qnil
;
26768 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26769 doc
: /* *Maximum number of characters a label can have to be shown.
26770 The tool bar style must also show labels for this to have any effect, see
26771 `tool-bar-style'. */);
26772 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26774 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26775 doc
: /* List of functions to call to fontify regions of text.
26776 Each function is called with one argument POS. Functions must
26777 fontify a region starting at POS in the current buffer, and give
26778 fontified regions the property `fontified'. */);
26779 Vfontification_functions
= Qnil
;
26780 Fmake_variable_buffer_local (Qfontification_functions
);
26782 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26783 unibyte_display_via_language_environment
,
26784 doc
: /* *Non-nil means display unibyte text according to language environment.
26785 Specifically, this means that raw bytes in the range 160-255 decimal
26786 are displayed by converting them to the equivalent multibyte characters
26787 according to the current language environment. As a result, they are
26788 displayed according to the current fontset.
26790 Note that this variable affects only how these bytes are displayed,
26791 but does not change the fact they are interpreted as raw bytes. */);
26792 unibyte_display_via_language_environment
= 0;
26794 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26795 doc
: /* *Maximum height for resizing mini-windows.
26796 If a float, it specifies a fraction of the mini-window frame's height.
26797 If an integer, it specifies a number of lines. */);
26798 Vmax_mini_window_height
= make_float (0.25);
26800 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26801 doc
: /* *How to resize mini-windows.
26802 A value of nil means don't automatically resize mini-windows.
26803 A value of t means resize them to fit the text displayed in them.
26804 A value of `grow-only', the default, means let mini-windows grow
26805 only, until their display becomes empty, at which point the windows
26806 go back to their normal size. */);
26807 Vresize_mini_windows
= Qgrow_only
;
26809 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26810 doc
: /* Alist specifying how to blink the cursor off.
26811 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26812 `cursor-type' frame-parameter or variable equals ON-STATE,
26813 comparing using `equal', Emacs uses OFF-STATE to specify
26814 how to blink it off. ON-STATE and OFF-STATE are values for
26815 the `cursor-type' frame parameter.
26817 If a frame's ON-STATE has no entry in this list,
26818 the frame's other specifications determine how to blink the cursor off. */);
26819 Vblink_cursor_alist
= Qnil
;
26821 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26822 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26823 If non-nil, windows are automatically scrolled horizontally to make
26824 point visible. */);
26825 automatic_hscrolling_p
= 1;
26826 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26827 staticpro (&Qauto_hscroll_mode
);
26829 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26830 doc
: /* *How many columns away from the window edge point is allowed to get
26831 before automatic hscrolling will horizontally scroll the window. */);
26832 hscroll_margin
= 5;
26834 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26835 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26836 When point is less than `hscroll-margin' columns from the window
26837 edge, automatic hscrolling will scroll the window by the amount of columns
26838 determined by this variable. If its value is a positive integer, scroll that
26839 many columns. If it's a positive floating-point number, it specifies the
26840 fraction of the window's width to scroll. If it's nil or zero, point will be
26841 centered horizontally after the scroll. Any other value, including negative
26842 numbers, are treated as if the value were zero.
26844 Automatic hscrolling always moves point outside the scroll margin, so if
26845 point was more than scroll step columns inside the margin, the window will
26846 scroll more than the value given by the scroll step.
26848 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26849 and `scroll-right' overrides this variable's effect. */);
26850 Vhscroll_step
= make_number (0);
26852 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26853 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26854 Bind this around calls to `message' to let it take effect. */);
26855 message_truncate_lines
= 0;
26857 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26858 doc
: /* Normal hook run to update the menu bar definitions.
26859 Redisplay runs this hook before it redisplays the menu bar.
26860 This is used to update submenus such as Buffers,
26861 whose contents depend on various data. */);
26862 Vmenu_bar_update_hook
= Qnil
;
26864 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26865 doc
: /* Frame for which we are updating a menu.
26866 The enable predicate for a menu binding should check this variable. */);
26867 Vmenu_updating_frame
= Qnil
;
26869 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26870 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26871 inhibit_menubar_update
= 0;
26873 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26874 doc
: /* Prefix prepended to all continuation lines at display time.
26875 The value may be a string, an image, or a stretch-glyph; it is
26876 interpreted in the same way as the value of a `display' text property.
26878 This variable is overridden by any `wrap-prefix' text or overlay
26881 To add a prefix to non-continuation lines, use `line-prefix'. */);
26882 Vwrap_prefix
= Qnil
;
26883 staticpro (&Qwrap_prefix
);
26884 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26885 Fmake_variable_buffer_local (Qwrap_prefix
);
26887 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26888 doc
: /* Prefix prepended to all non-continuation lines at display time.
26889 The value may be a string, an image, or a stretch-glyph; it is
26890 interpreted in the same way as the value of a `display' text property.
26892 This variable is overridden by any `line-prefix' text or overlay
26895 To add a prefix to continuation lines, use `wrap-prefix'. */);
26896 Vline_prefix
= Qnil
;
26897 staticpro (&Qline_prefix
);
26898 Qline_prefix
= intern_c_string ("line-prefix");
26899 Fmake_variable_buffer_local (Qline_prefix
);
26901 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26902 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26903 inhibit_eval_during_redisplay
= 0;
26905 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26906 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26907 inhibit_free_realized_faces
= 0;
26910 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26911 doc
: /* Inhibit try_window_id display optimization. */);
26912 inhibit_try_window_id
= 0;
26914 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26915 doc
: /* Inhibit try_window_reusing display optimization. */);
26916 inhibit_try_window_reusing
= 0;
26918 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26919 doc
: /* Inhibit try_cursor_movement display optimization. */);
26920 inhibit_try_cursor_movement
= 0;
26921 #endif /* GLYPH_DEBUG */
26923 DEFVAR_INT ("overline-margin", overline_margin
,
26924 doc
: /* *Space between overline and text, in pixels.
26925 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26926 margin to the caracter height. */);
26927 overline_margin
= 2;
26929 DEFVAR_INT ("underline-minimum-offset",
26930 underline_minimum_offset
,
26931 doc
: /* Minimum distance between baseline and underline.
26932 This can improve legibility of underlined text at small font sizes,
26933 particularly when using variable `x-use-underline-position-properties'
26934 with fonts that specify an UNDERLINE_POSITION relatively close to the
26935 baseline. The default value is 1. */);
26936 underline_minimum_offset
= 1;
26938 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26939 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26940 This feature only works when on a window system that can change
26941 cursor shapes. */);
26942 display_hourglass_p
= 1;
26944 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26945 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26946 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26948 hourglass_atimer
= NULL
;
26949 hourglass_shown_p
= 0;
26951 DEFSYM (Qglyphless_char
, "glyphless-char");
26952 DEFSYM (Qhex_code
, "hex-code");
26953 DEFSYM (Qempty_box
, "empty-box");
26954 DEFSYM (Qthin_space
, "thin-space");
26955 DEFSYM (Qzero_width
, "zero-width");
26957 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26958 /* Intern this now in case it isn't already done.
26959 Setting this variable twice is harmless.
26960 But don't staticpro it here--that is done in alloc.c. */
26961 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26962 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26964 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26965 doc
: /* Char-table defining glyphless characters.
26966 Each element, if non-nil, should be one of the following:
26967 an ASCII acronym string: display this string in a box
26968 `hex-code': display the hexadecimal code of a character in a box
26969 `empty-box': display as an empty box
26970 `thin-space': display as 1-pixel width space
26971 `zero-width': don't display
26972 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
26973 display method for graphical terminals and text terminals respectively.
26974 GRAPHICAL and TEXT should each have one of the values listed above.
26976 The char-table has one extra slot to control the display of a character for
26977 which no font is found. This slot only takes effect on graphical terminals.
26978 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
26979 `thin-space'. The default is `empty-box'. */);
26980 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26981 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26986 /* Initialize this module when Emacs starts. */
26991 Lisp_Object root_window
;
26992 struct window
*mini_w
;
26994 current_header_line_height
= current_mode_line_height
= -1;
26996 CHARPOS (this_line_start_pos
) = 0;
26998 mini_w
= XWINDOW (minibuf_window
);
26999 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27000 echo_area_window
= minibuf_window
;
27002 if (!noninteractive
)
27004 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27007 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27008 set_window_height (root_window
,
27009 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27011 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27012 set_window_height (minibuf_window
, 1, 0);
27014 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27015 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27017 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27018 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27019 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27021 /* The default ellipsis glyphs `...'. */
27022 for (i
= 0; i
< 3; ++i
)
27023 default_invis_vector
[i
] = make_number ('.');
27027 /* Allocate the buffer for frame titles.
27028 Also used for `format-mode-line'. */
27030 mode_line_noprop_buf
= (char *) xmalloc (size
);
27031 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27032 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27033 mode_line_target
= MODE_LINE_DISPLAY
;
27036 help_echo_showing_p
= 0;
27039 /* Since w32 does not support atimers, it defines its own implementation of
27040 the following three functions in w32fns.c. */
27043 /* Platform-independent portion of hourglass implementation. */
27045 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27047 hourglass_started (void)
27049 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27052 /* Cancel a currently active hourglass timer, and start a new one. */
27054 start_hourglass (void)
27056 #if defined (HAVE_WINDOW_SYSTEM)
27058 int secs
, usecs
= 0;
27060 cancel_hourglass ();
27062 if (INTEGERP (Vhourglass_delay
)
27063 && XINT (Vhourglass_delay
) > 0)
27064 secs
= XFASTINT (Vhourglass_delay
);
27065 else if (FLOATP (Vhourglass_delay
)
27066 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27069 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27070 secs
= XFASTINT (tem
);
27071 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27074 secs
= DEFAULT_HOURGLASS_DELAY
;
27076 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27077 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27078 show_hourglass
, NULL
);
27083 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27086 cancel_hourglass (void)
27088 #if defined (HAVE_WINDOW_SYSTEM)
27089 if (hourglass_atimer
)
27091 cancel_atimer (hourglass_atimer
);
27092 hourglass_atimer
= NULL
;
27095 if (hourglass_shown_p
)
27099 #endif /* ! WINDOWSNT */