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)
5543 glyphless_method
= (c
>= 0
5544 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5545 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5547 if (NILP (glyphless_method
))
5550 /* The default is to display the character by a proper font. */
5552 /* The default for the no-font case is to display an empty box. */
5553 glyphless_method
= Qempty_box
;
5555 if (EQ (glyphless_method
, Qzero_width
))
5558 return glyphless_method
;
5559 /* This method can't be used for the no-font case. */
5560 glyphless_method
= Qempty_box
;
5562 if (EQ (glyphless_method
, Qthin_space
))
5563 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5564 else if (EQ (glyphless_method
, Qempty_box
))
5565 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5566 else if (EQ (glyphless_method
, Qhex_code
))
5567 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5568 else if (STRINGP (glyphless_method
))
5569 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5572 /* Invalid value. We use the default method. */
5573 glyphless_method
= Qnil
;
5576 it
->what
= IT_GLYPHLESS
;
5577 return glyphless_method
;
5580 /* Load IT's display element fields with information about the next
5581 display element from the current position of IT. Value is zero if
5582 end of buffer (or C string) is reached. */
5584 static struct frame
*last_escape_glyph_frame
= NULL
;
5585 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5586 static int last_escape_glyph_merged_face_id
= 0;
5588 struct frame
*last_glyphless_glyph_frame
= NULL
;
5589 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5590 int last_glyphless_glyph_merged_face_id
= 0;
5593 get_next_display_element (struct it
*it
)
5595 /* Non-zero means that we found a display element. Zero means that
5596 we hit the end of what we iterate over. Performance note: the
5597 function pointer `method' used here turns out to be faster than
5598 using a sequence of if-statements. */
5602 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5604 if (it
->what
== IT_CHARACTER
)
5606 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5607 and only if (a) the resolved directionality of that character
5609 /* FIXME: Do we need an exception for characters from display
5611 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5612 it
->c
= bidi_mirror_char (it
->c
);
5613 /* Map via display table or translate control characters.
5614 IT->c, IT->len etc. have been set to the next character by
5615 the function call above. If we have a display table, and it
5616 contains an entry for IT->c, translate it. Don't do this if
5617 IT->c itself comes from a display table, otherwise we could
5618 end up in an infinite recursion. (An alternative could be to
5619 count the recursion depth of this function and signal an
5620 error when a certain maximum depth is reached.) Is it worth
5622 if (success_p
&& it
->dpvec
== NULL
)
5625 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5626 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5627 nbsp_or_shy
= char_is_other
;
5628 int c
= it
->c
; /* This is the character to display. */
5630 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5632 xassert (SINGLE_BYTE_CHAR_P (c
));
5633 if (unibyte_display_via_language_environment
)
5635 c
= DECODE_CHAR (unibyte
, c
);
5637 c
= BYTE8_TO_CHAR (it
->c
);
5640 c
= BYTE8_TO_CHAR (it
->c
);
5644 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5647 struct Lisp_Vector
*v
= XVECTOR (dv
);
5649 /* Return the first character from the display table
5650 entry, if not empty. If empty, don't display the
5651 current character. */
5654 it
->dpvec_char_len
= it
->len
;
5655 it
->dpvec
= v
->contents
;
5656 it
->dpend
= v
->contents
+ v
->size
;
5657 it
->current
.dpvec_index
= 0;
5658 it
->dpvec_face_id
= -1;
5659 it
->saved_face_id
= it
->face_id
;
5660 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5665 set_iterator_to_next (it
, 0);
5670 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5672 if (it
->what
== IT_GLYPHLESS
)
5674 /* Don't display this character. */
5675 set_iterator_to_next (it
, 0);
5679 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5680 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5681 : c
== 0xAD ? char_is_soft_hyphen
5684 /* Translate control characters into `\003' or `^C' form.
5685 Control characters coming from a display table entry are
5686 currently not translated because we use IT->dpvec to hold
5687 the translation. This could easily be changed but I
5688 don't believe that it is worth doing.
5690 NBSP and SOFT-HYPEN are property translated too.
5692 Non-printable characters and raw-byte characters are also
5693 translated to octal form. */
5694 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5695 ? (it
->area
!= TEXT_AREA
5696 /* In mode line, treat \n, \t like other crl chars. */
5699 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5700 || (c
!= '\n' && c
!= '\t'))
5703 || ! CHAR_PRINTABLE_P (c
))))
5705 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5706 or a non-printable character which must be displayed
5707 either as '\003' or as `^C' where the '\\' and '^'
5708 can be defined in the display table. Fill
5709 IT->ctl_chars with glyphs for what we have to
5710 display. Then, set IT->dpvec to these glyphs. */
5713 int face_id
, lface_id
= 0 ;
5716 /* Handle control characters with ^. */
5718 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5722 g
= '^'; /* default glyph for Control */
5723 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5725 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5726 && GLYPH_CODE_CHAR_VALID_P (gc
))
5728 g
= GLYPH_CODE_CHAR (gc
);
5729 lface_id
= GLYPH_CODE_FACE (gc
);
5733 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5735 else if (it
->f
== last_escape_glyph_frame
5736 && it
->face_id
== last_escape_glyph_face_id
)
5738 face_id
= last_escape_glyph_merged_face_id
;
5742 /* Merge the escape-glyph face into the current face. */
5743 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5745 last_escape_glyph_frame
= it
->f
;
5746 last_escape_glyph_face_id
= it
->face_id
;
5747 last_escape_glyph_merged_face_id
= face_id
;
5750 XSETINT (it
->ctl_chars
[0], g
);
5751 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5753 goto display_control
;
5756 /* Handle non-break space in the mode where it only gets
5759 if (EQ (Vnobreak_char_display
, Qt
)
5760 && nbsp_or_shy
== char_is_nbsp
)
5762 /* Merge the no-break-space face into the current face. */
5763 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5767 XSETINT (it
->ctl_chars
[0], ' ');
5769 goto display_control
;
5772 /* Handle sequences that start with the "escape glyph". */
5774 /* the default escape glyph is \. */
5775 escape_glyph
= '\\';
5778 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5779 && GLYPH_CODE_CHAR_VALID_P (gc
))
5781 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5782 lface_id
= GLYPH_CODE_FACE (gc
);
5786 /* The display table specified a face.
5787 Merge it into face_id and also into escape_glyph. */
5788 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5791 else if (it
->f
== last_escape_glyph_frame
5792 && it
->face_id
== last_escape_glyph_face_id
)
5794 face_id
= last_escape_glyph_merged_face_id
;
5798 /* Merge the escape-glyph face into the current face. */
5799 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5801 last_escape_glyph_frame
= it
->f
;
5802 last_escape_glyph_face_id
= it
->face_id
;
5803 last_escape_glyph_merged_face_id
= face_id
;
5806 /* Handle soft hyphens in the mode where they only get
5809 if (EQ (Vnobreak_char_display
, Qt
)
5810 && nbsp_or_shy
== char_is_soft_hyphen
)
5812 XSETINT (it
->ctl_chars
[0], '-');
5814 goto display_control
;
5817 /* Handle non-break space and soft hyphen
5818 with the escape glyph. */
5822 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5823 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5824 XSETINT (it
->ctl_chars
[1], c
);
5826 goto display_control
;
5833 if (CHAR_BYTE8_P (c
))
5834 /* Display \200 instead of \17777600. */
5835 c
= CHAR_TO_BYTE8 (c
);
5836 len
= sprintf (str
, "%03o", c
);
5838 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5839 for (i
= 0; i
< len
; i
++)
5840 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5845 /* Set up IT->dpvec and return first character from it. */
5846 it
->dpvec_char_len
= it
->len
;
5847 it
->dpvec
= it
->ctl_chars
;
5848 it
->dpend
= it
->dpvec
+ ctl_len
;
5849 it
->current
.dpvec_index
= 0;
5850 it
->dpvec_face_id
= face_id
;
5851 it
->saved_face_id
= it
->face_id
;
5852 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5856 it
->char_to_display
= c
;
5860 it
->char_to_display
= it
->c
;
5864 /* Adjust face id for a multibyte character. There are no multibyte
5865 character in unibyte text. */
5866 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5869 && FRAME_WINDOW_P (it
->f
))
5871 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5873 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5875 /* Automatic composition with glyph-string. */
5876 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5878 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5882 EMACS_INT pos
= (it
->s
? -1
5883 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5884 : IT_CHARPOS (*it
));
5886 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5892 /* Is this character the last one of a run of characters with
5893 box? If yes, set IT->end_of_box_run_p to 1. */
5897 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5899 int face_id
= underlying_face_id (it
);
5900 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5904 if (face
->box
== FACE_NO_BOX
)
5906 /* If the box comes from face properties in a
5907 display string, check faces in that string. */
5908 int string_face_id
= face_after_it_pos (it
);
5909 it
->end_of_box_run_p
5910 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5913 /* Otherwise, the box comes from the underlying face.
5914 If this is the last string character displayed, check
5915 the next buffer location. */
5916 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5917 && (it
->current
.overlay_string_index
5918 == it
->n_overlay_strings
- 1))
5922 struct text_pos pos
= it
->current
.pos
;
5923 INC_TEXT_POS (pos
, it
->multibyte_p
);
5925 next_face_id
= face_at_buffer_position
5926 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5927 it
->region_end_charpos
, &ignore
,
5928 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5930 it
->end_of_box_run_p
5931 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5938 int face_id
= face_after_it_pos (it
);
5939 it
->end_of_box_run_p
5940 = (face_id
!= it
->face_id
5941 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5945 /* Value is 0 if end of buffer or string reached. */
5950 /* Move IT to the next display element.
5952 RESEAT_P non-zero means if called on a newline in buffer text,
5953 skip to the next visible line start.
5955 Functions get_next_display_element and set_iterator_to_next are
5956 separate because I find this arrangement easier to handle than a
5957 get_next_display_element function that also increments IT's
5958 position. The way it is we can first look at an iterator's current
5959 display element, decide whether it fits on a line, and if it does,
5960 increment the iterator position. The other way around we probably
5961 would either need a flag indicating whether the iterator has to be
5962 incremented the next time, or we would have to implement a
5963 decrement position function which would not be easy to write. */
5966 set_iterator_to_next (struct it
*it
, int reseat_p
)
5968 /* Reset flags indicating start and end of a sequence of characters
5969 with box. Reset them at the start of this function because
5970 moving the iterator to a new position might set them. */
5971 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5975 case GET_FROM_BUFFER
:
5976 /* The current display element of IT is a character from
5977 current_buffer. Advance in the buffer, and maybe skip over
5978 invisible lines that are so because of selective display. */
5979 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5980 reseat_at_next_visible_line_start (it
, 0);
5981 else if (it
->cmp_it
.id
>= 0)
5983 /* We are currently getting glyphs from a composition. */
5988 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
5989 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
5990 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
5992 it
->cmp_it
.from
= it
->cmp_it
.to
;
5997 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
5999 it
->end_charpos
, Qnil
);
6002 else if (! it
->cmp_it
.reversed_p
)
6004 /* Composition created while scanning forward. */
6005 /* Update IT's char/byte positions to point to the first
6006 character of the next grapheme cluster, or to the
6007 character visually after the current composition. */
6008 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6009 bidi_move_to_visually_next (&it
->bidi_it
);
6010 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6011 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6013 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6015 /* Proceed to the next grapheme cluster. */
6016 it
->cmp_it
.from
= it
->cmp_it
.to
;
6020 /* No more grapheme clusters in this composition.
6021 Find the next stop position. */
6022 EMACS_INT stop
= it
->end_charpos
;
6023 if (it
->bidi_it
.scan_dir
< 0)
6024 /* Now we are scanning backward and don't know
6027 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6028 IT_BYTEPOS (*it
), stop
, Qnil
);
6033 /* Composition created while scanning backward. */
6034 /* Update IT's char/byte positions to point to the last
6035 character of the previous grapheme cluster, or the
6036 character visually after the current composition. */
6037 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6038 bidi_move_to_visually_next (&it
->bidi_it
);
6039 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6040 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6041 if (it
->cmp_it
.from
> 0)
6043 /* Proceed to the previous grapheme cluster. */
6044 it
->cmp_it
.to
= it
->cmp_it
.from
;
6048 /* No more grapheme clusters in this composition.
6049 Find the next stop position. */
6050 EMACS_INT stop
= it
->end_charpos
;
6051 if (it
->bidi_it
.scan_dir
< 0)
6052 /* Now we are scanning backward and don't know
6055 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6056 IT_BYTEPOS (*it
), stop
, Qnil
);
6062 xassert (it
->len
!= 0);
6066 IT_BYTEPOS (*it
) += it
->len
;
6067 IT_CHARPOS (*it
) += 1;
6071 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6072 /* If this is a new paragraph, determine its base
6073 direction (a.k.a. its base embedding level). */
6074 if (it
->bidi_it
.new_paragraph
)
6075 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6076 bidi_move_to_visually_next (&it
->bidi_it
);
6077 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6078 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6079 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6081 /* As the scan direction was changed, we must
6082 re-compute the stop position for composition. */
6083 EMACS_INT stop
= it
->end_charpos
;
6084 if (it
->bidi_it
.scan_dir
< 0)
6086 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6087 IT_BYTEPOS (*it
), stop
, Qnil
);
6090 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6094 case GET_FROM_C_STRING
:
6095 /* Current display element of IT is from a C string. */
6096 IT_BYTEPOS (*it
) += it
->len
;
6097 IT_CHARPOS (*it
) += 1;
6100 case GET_FROM_DISPLAY_VECTOR
:
6101 /* Current display element of IT is from a display table entry.
6102 Advance in the display table definition. Reset it to null if
6103 end reached, and continue with characters from buffers/
6105 ++it
->current
.dpvec_index
;
6107 /* Restore face of the iterator to what they were before the
6108 display vector entry (these entries may contain faces). */
6109 it
->face_id
= it
->saved_face_id
;
6111 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6113 int recheck_faces
= it
->ellipsis_p
;
6116 it
->method
= GET_FROM_C_STRING
;
6117 else if (STRINGP (it
->string
))
6118 it
->method
= GET_FROM_STRING
;
6121 it
->method
= GET_FROM_BUFFER
;
6122 it
->object
= it
->w
->buffer
;
6126 it
->current
.dpvec_index
= -1;
6128 /* Skip over characters which were displayed via IT->dpvec. */
6129 if (it
->dpvec_char_len
< 0)
6130 reseat_at_next_visible_line_start (it
, 1);
6131 else if (it
->dpvec_char_len
> 0)
6133 if (it
->method
== GET_FROM_STRING
6134 && it
->n_overlay_strings
> 0)
6135 it
->ignore_overlay_strings_at_pos_p
= 1;
6136 it
->len
= it
->dpvec_char_len
;
6137 set_iterator_to_next (it
, reseat_p
);
6140 /* Maybe recheck faces after display vector */
6142 it
->stop_charpos
= IT_CHARPOS (*it
);
6146 case GET_FROM_STRING
:
6147 /* Current display element is a character from a Lisp string. */
6148 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6149 if (it
->cmp_it
.id
>= 0)
6151 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6152 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6153 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6154 it
->cmp_it
.from
= it
->cmp_it
.to
;
6158 composition_compute_stop_pos (&it
->cmp_it
,
6159 IT_STRING_CHARPOS (*it
),
6160 IT_STRING_BYTEPOS (*it
),
6161 it
->end_charpos
, it
->string
);
6166 IT_STRING_BYTEPOS (*it
) += it
->len
;
6167 IT_STRING_CHARPOS (*it
) += 1;
6170 consider_string_end
:
6172 if (it
->current
.overlay_string_index
>= 0)
6174 /* IT->string is an overlay string. Advance to the
6175 next, if there is one. */
6176 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6179 next_overlay_string (it
);
6181 setup_for_ellipsis (it
, 0);
6186 /* IT->string is not an overlay string. If we reached
6187 its end, and there is something on IT->stack, proceed
6188 with what is on the stack. This can be either another
6189 string, this time an overlay string, or a buffer. */
6190 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6194 if (it
->method
== GET_FROM_STRING
)
6195 goto consider_string_end
;
6200 case GET_FROM_IMAGE
:
6201 case GET_FROM_STRETCH
:
6202 /* The position etc with which we have to proceed are on
6203 the stack. The position may be at the end of a string,
6204 if the `display' property takes up the whole string. */
6205 xassert (it
->sp
> 0);
6207 if (it
->method
== GET_FROM_STRING
)
6208 goto consider_string_end
;
6212 /* There are no other methods defined, so this should be a bug. */
6216 xassert (it
->method
!= GET_FROM_STRING
6217 || (STRINGP (it
->string
)
6218 && IT_STRING_CHARPOS (*it
) >= 0));
6221 /* Load IT's display element fields with information about the next
6222 display element which comes from a display table entry or from the
6223 result of translating a control character to one of the forms `^C'
6226 IT->dpvec holds the glyphs to return as characters.
6227 IT->saved_face_id holds the face id before the display vector--it
6228 is restored into IT->face_id in set_iterator_to_next. */
6231 next_element_from_display_vector (struct it
*it
)
6236 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6238 it
->face_id
= it
->saved_face_id
;
6240 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6241 That seemed totally bogus - so I changed it... */
6242 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6244 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6246 it
->c
= GLYPH_CODE_CHAR (gc
);
6247 it
->len
= CHAR_BYTES (it
->c
);
6249 /* The entry may contain a face id to use. Such a face id is
6250 the id of a Lisp face, not a realized face. A face id of
6251 zero means no face is specified. */
6252 if (it
->dpvec_face_id
>= 0)
6253 it
->face_id
= it
->dpvec_face_id
;
6256 int lface_id
= GLYPH_CODE_FACE (gc
);
6258 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6263 /* Display table entry is invalid. Return a space. */
6264 it
->c
= ' ', it
->len
= 1;
6266 /* Don't change position and object of the iterator here. They are
6267 still the values of the character that had this display table
6268 entry or was translated, and that's what we want. */
6269 it
->what
= IT_CHARACTER
;
6274 /* Load IT with the next display element from Lisp string IT->string.
6275 IT->current.string_pos is the current position within the string.
6276 If IT->current.overlay_string_index >= 0, the Lisp string is an
6280 next_element_from_string (struct it
*it
)
6282 struct text_pos position
;
6284 xassert (STRINGP (it
->string
));
6285 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6286 position
= it
->current
.string_pos
;
6288 /* Time to check for invisible text? */
6289 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6290 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6294 /* Since a handler may have changed IT->method, we must
6296 return GET_NEXT_DISPLAY_ELEMENT (it
);
6299 if (it
->current
.overlay_string_index
>= 0)
6301 /* Get the next character from an overlay string. In overlay
6302 strings, There is no field width or padding with spaces to
6304 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6309 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6310 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6311 && next_element_from_composition (it
))
6315 else if (STRING_MULTIBYTE (it
->string
))
6317 const unsigned char *s
= (SDATA (it
->string
)
6318 + IT_STRING_BYTEPOS (*it
));
6319 it
->c
= string_char_and_length (s
, &it
->len
);
6323 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6329 /* Get the next character from a Lisp string that is not an
6330 overlay string. Such strings come from the mode line, for
6331 example. We may have to pad with spaces, or truncate the
6332 string. See also next_element_from_c_string. */
6333 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6338 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6340 /* Pad with spaces. */
6341 it
->c
= ' ', it
->len
= 1;
6342 CHARPOS (position
) = BYTEPOS (position
) = -1;
6344 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6345 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6346 && next_element_from_composition (it
))
6350 else if (STRING_MULTIBYTE (it
->string
))
6352 const unsigned char *s
= (SDATA (it
->string
)
6353 + IT_STRING_BYTEPOS (*it
));
6354 it
->c
= string_char_and_length (s
, &it
->len
);
6358 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6363 /* Record what we have and where it came from. */
6364 it
->what
= IT_CHARACTER
;
6365 it
->object
= it
->string
;
6366 it
->position
= position
;
6371 /* Load IT with next display element from C string IT->s.
6372 IT->string_nchars is the maximum number of characters to return
6373 from the string. IT->end_charpos may be greater than
6374 IT->string_nchars when this function is called, in which case we
6375 may have to return padding spaces. Value is zero if end of string
6376 reached, including padding spaces. */
6379 next_element_from_c_string (struct it
*it
)
6384 it
->what
= IT_CHARACTER
;
6385 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6388 /* IT's position can be greater IT->string_nchars in case a field
6389 width or precision has been specified when the iterator was
6391 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6393 /* End of the game. */
6397 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6399 /* Pad with spaces. */
6400 it
->c
= ' ', it
->len
= 1;
6401 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6403 else if (it
->multibyte_p
)
6404 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6406 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6412 /* Set up IT to return characters from an ellipsis, if appropriate.
6413 The definition of the ellipsis glyphs may come from a display table
6414 entry. This function fills IT with the first glyph from the
6415 ellipsis if an ellipsis is to be displayed. */
6418 next_element_from_ellipsis (struct it
*it
)
6420 if (it
->selective_display_ellipsis_p
)
6421 setup_for_ellipsis (it
, it
->len
);
6424 /* The face at the current position may be different from the
6425 face we find after the invisible text. Remember what it
6426 was in IT->saved_face_id, and signal that it's there by
6427 setting face_before_selective_p. */
6428 it
->saved_face_id
= it
->face_id
;
6429 it
->method
= GET_FROM_BUFFER
;
6430 it
->object
= it
->w
->buffer
;
6431 reseat_at_next_visible_line_start (it
, 1);
6432 it
->face_before_selective_p
= 1;
6435 return GET_NEXT_DISPLAY_ELEMENT (it
);
6439 /* Deliver an image display element. The iterator IT is already
6440 filled with image information (done in handle_display_prop). Value
6445 next_element_from_image (struct it
*it
)
6447 it
->what
= IT_IMAGE
;
6448 it
->ignore_overlay_strings_at_pos_p
= 0;
6453 /* Fill iterator IT with next display element from a stretch glyph
6454 property. IT->object is the value of the text property. Value is
6458 next_element_from_stretch (struct it
*it
)
6460 it
->what
= IT_STRETCH
;
6464 /* Scan forward from CHARPOS in the current buffer, until we find a
6465 stop position > current IT's position. Then handle the stop
6466 position before that. This is called when we bump into a stop
6467 position while reordering bidirectional text. CHARPOS should be
6468 the last previously processed stop_pos (or BEGV, if none were
6469 processed yet) whose position is less that IT's current
6473 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6475 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6476 struct display_pos save_current
= it
->current
;
6477 struct text_pos save_position
= it
->position
;
6478 struct text_pos pos1
;
6479 EMACS_INT next_stop
;
6481 /* Scan in strict logical order. */
6485 it
->prev_stop
= charpos
;
6486 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6487 reseat_1 (it
, pos1
, 0);
6488 compute_stop_pos (it
);
6489 /* We must advance forward, right? */
6490 if (it
->stop_charpos
<= it
->prev_stop
)
6492 charpos
= it
->stop_charpos
;
6494 while (charpos
<= where_we_are
);
6496 next_stop
= it
->stop_charpos
;
6497 it
->stop_charpos
= it
->prev_stop
;
6499 it
->current
= save_current
;
6500 it
->position
= save_position
;
6502 it
->stop_charpos
= next_stop
;
6505 /* Load IT with the next display element from current_buffer. Value
6506 is zero if end of buffer reached. IT->stop_charpos is the next
6507 position at which to stop and check for text properties or buffer
6511 next_element_from_buffer (struct it
*it
)
6515 xassert (IT_CHARPOS (*it
) >= BEGV
);
6517 /* With bidi reordering, the character to display might not be the
6518 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6519 we were reseat()ed to a new buffer position, which is potentially
6520 a different paragraph. */
6521 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6523 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6524 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6525 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6527 /* Nothing to do, but reset the FIRST_ELT flag, like
6528 bidi_paragraph_init does, because we are not going to
6530 it
->bidi_it
.first_elt
= 0;
6532 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6533 /* FIXME: Should support all Unicode line separators. */
6534 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6535 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6537 /* If we are at the beginning of a line, we can produce the
6538 next element right away. */
6539 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6540 bidi_move_to_visually_next (&it
->bidi_it
);
6544 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6546 /* We need to prime the bidi iterator starting at the line's
6547 beginning, before we will be able to produce the next
6549 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6550 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6551 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6552 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6553 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6556 /* Now return to buffer position where we were asked to
6557 get the next display element, and produce that. */
6558 bidi_move_to_visually_next (&it
->bidi_it
);
6560 while (it
->bidi_it
.bytepos
!= orig_bytepos
6561 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6564 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6565 /* Adjust IT's position information to where we ended up. */
6566 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6567 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6568 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6570 EMACS_INT stop
= it
->end_charpos
;
6571 if (it
->bidi_it
.scan_dir
< 0)
6573 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6574 IT_BYTEPOS (*it
), stop
, Qnil
);
6578 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6580 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6582 int overlay_strings_follow_p
;
6584 /* End of the game, except when overlay strings follow that
6585 haven't been returned yet. */
6586 if (it
->overlay_strings_at_end_processed_p
)
6587 overlay_strings_follow_p
= 0;
6590 it
->overlay_strings_at_end_processed_p
= 1;
6591 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6594 if (overlay_strings_follow_p
)
6595 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6599 it
->position
= it
->current
.pos
;
6603 else if (!(!it
->bidi_p
6604 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6605 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6607 /* With bidi non-linear iteration, we could find ourselves
6608 far beyond the last computed stop_charpos, with several
6609 other stop positions in between that we missed. Scan
6610 them all now, in buffer's logical order, until we find
6611 and handle the last stop_charpos that precedes our
6612 current position. */
6613 handle_stop_backwards (it
, it
->stop_charpos
);
6614 return GET_NEXT_DISPLAY_ELEMENT (it
);
6620 /* Take note of the stop position we just moved across,
6621 for when we will move back across it. */
6622 it
->prev_stop
= it
->stop_charpos
;
6623 /* If we are at base paragraph embedding level, take
6624 note of the last stop position seen at this
6626 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6627 it
->base_level_stop
= it
->stop_charpos
;
6630 return GET_NEXT_DISPLAY_ELEMENT (it
);
6634 /* We can sometimes back up for reasons that have nothing
6635 to do with bidi reordering. E.g., compositions. The
6636 code below is only needed when we are above the base
6637 embedding level, so test for that explicitly. */
6638 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6639 && IT_CHARPOS (*it
) < it
->prev_stop
)
6641 if (it
->base_level_stop
<= 0)
6642 it
->base_level_stop
= BEGV
;
6643 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6645 handle_stop_backwards (it
, it
->base_level_stop
);
6646 return GET_NEXT_DISPLAY_ELEMENT (it
);
6650 /* No face changes, overlays etc. in sight, so just return a
6651 character from current_buffer. */
6655 /* Maybe run the redisplay end trigger hook. Performance note:
6656 This doesn't seem to cost measurable time. */
6657 if (it
->redisplay_end_trigger_charpos
6659 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6660 run_redisplay_end_trigger_hook (it
);
6662 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6663 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6665 && next_element_from_composition (it
))
6670 /* Get the next character, maybe multibyte. */
6671 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6672 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6673 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6675 it
->c
= *p
, it
->len
= 1;
6677 /* Record what we have and where it came from. */
6678 it
->what
= IT_CHARACTER
;
6679 it
->object
= it
->w
->buffer
;
6680 it
->position
= it
->current
.pos
;
6682 /* Normally we return the character found above, except when we
6683 really want to return an ellipsis for selective display. */
6688 /* A value of selective > 0 means hide lines indented more
6689 than that number of columns. */
6690 if (it
->selective
> 0
6691 && IT_CHARPOS (*it
) + 1 < ZV
6692 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6693 IT_BYTEPOS (*it
) + 1,
6694 (double) it
->selective
)) /* iftc */
6696 success_p
= next_element_from_ellipsis (it
);
6697 it
->dpvec_char_len
= -1;
6700 else if (it
->c
== '\r' && it
->selective
== -1)
6702 /* A value of selective == -1 means that everything from the
6703 CR to the end of the line is invisible, with maybe an
6704 ellipsis displayed for it. */
6705 success_p
= next_element_from_ellipsis (it
);
6706 it
->dpvec_char_len
= -1;
6711 /* Value is zero if end of buffer reached. */
6712 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6717 /* Run the redisplay end trigger hook for IT. */
6720 run_redisplay_end_trigger_hook (struct it
*it
)
6722 Lisp_Object args
[3];
6724 /* IT->glyph_row should be non-null, i.e. we should be actually
6725 displaying something, or otherwise we should not run the hook. */
6726 xassert (it
->glyph_row
);
6728 /* Set up hook arguments. */
6729 args
[0] = Qredisplay_end_trigger_functions
;
6730 args
[1] = it
->window
;
6731 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6732 it
->redisplay_end_trigger_charpos
= 0;
6734 /* Since we are *trying* to run these functions, don't try to run
6735 them again, even if they get an error. */
6736 it
->w
->redisplay_end_trigger
= Qnil
;
6737 Frun_hook_with_args (3, args
);
6739 /* Notice if it changed the face of the character we are on. */
6740 handle_face_prop (it
);
6744 /* Deliver a composition display element. Unlike the other
6745 next_element_from_XXX, this function is not registered in the array
6746 get_next_element[]. It is called from next_element_from_buffer and
6747 next_element_from_string when necessary. */
6750 next_element_from_composition (struct it
*it
)
6752 it
->what
= IT_COMPOSITION
;
6753 it
->len
= it
->cmp_it
.nbytes
;
6754 if (STRINGP (it
->string
))
6758 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6759 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6762 it
->position
= it
->current
.string_pos
;
6763 it
->object
= it
->string
;
6764 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6765 IT_STRING_BYTEPOS (*it
), it
->string
);
6771 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6772 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6775 if (it
->bidi_it
.new_paragraph
)
6776 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6777 /* Resync the bidi iterator with IT's new position.
6778 FIXME: this doesn't support bidirectional text. */
6779 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6780 bidi_move_to_visually_next (&it
->bidi_it
);
6784 it
->position
= it
->current
.pos
;
6785 it
->object
= it
->w
->buffer
;
6786 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6787 IT_BYTEPOS (*it
), Qnil
);
6794 /***********************************************************************
6795 Moving an iterator without producing glyphs
6796 ***********************************************************************/
6798 /* Check if iterator is at a position corresponding to a valid buffer
6799 position after some move_it_ call. */
6801 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6802 ((it)->method == GET_FROM_STRING \
6803 ? IT_STRING_CHARPOS (*it) == 0 \
6807 /* Move iterator IT to a specified buffer or X position within one
6808 line on the display without producing glyphs.
6810 OP should be a bit mask including some or all of these bits:
6811 MOVE_TO_X: Stop upon reaching x-position TO_X.
6812 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6813 Regardless of OP's value, stop upon reaching the end of the display line.
6815 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6816 This means, in particular, that TO_X includes window's horizontal
6819 The return value has several possible values that
6820 say what condition caused the scan to stop:
6822 MOVE_POS_MATCH_OR_ZV
6823 - when TO_POS or ZV was reached.
6826 -when TO_X was reached before TO_POS or ZV were reached.
6829 - when we reached the end of the display area and the line must
6833 - when we reached the end of the display area and the line is
6837 - when we stopped at a line end, i.e. a newline or a CR and selective
6840 static enum move_it_result
6841 move_it_in_display_line_to (struct it
*it
,
6842 EMACS_INT to_charpos
, int to_x
,
6843 enum move_operation_enum op
)
6845 enum move_it_result result
= MOVE_UNDEFINED
;
6846 struct glyph_row
*saved_glyph_row
;
6847 struct it wrap_it
, atpos_it
, atx_it
;
6849 enum it_method prev_method
= it
->method
;
6850 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6852 /* Don't produce glyphs in produce_glyphs. */
6853 saved_glyph_row
= it
->glyph_row
;
6854 it
->glyph_row
= NULL
;
6856 /* Use wrap_it to save a copy of IT wherever a word wrap could
6857 occur. Use atpos_it to save a copy of IT at the desired buffer
6858 position, if found, so that we can scan ahead and check if the
6859 word later overshoots the window edge. Use atx_it similarly, for
6865 #define BUFFER_POS_REACHED_P() \
6866 ((op & MOVE_TO_POS) != 0 \
6867 && BUFFERP (it->object) \
6868 && (IT_CHARPOS (*it) == to_charpos \
6869 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6870 && (it->method == GET_FROM_BUFFER \
6871 || (it->method == GET_FROM_DISPLAY_VECTOR \
6872 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6874 /* If there's a line-/wrap-prefix, handle it. */
6875 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6876 && it
->current_y
< it
->last_visible_y
)
6877 handle_line_prefix (it
);
6879 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6880 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6884 int x
, i
, ascent
= 0, descent
= 0;
6886 /* Utility macro to reset an iterator with x, ascent, and descent. */
6887 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6888 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6889 (IT)->max_descent = descent)
6891 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6893 if ((op
& MOVE_TO_POS
) != 0
6894 && BUFFERP (it
->object
)
6895 && it
->method
== GET_FROM_BUFFER
6896 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6898 && (prev_method
== GET_FROM_IMAGE
6899 || prev_method
== GET_FROM_STRETCH
)
6900 /* Passed TO_CHARPOS from left to right. */
6901 && ((prev_pos
< to_charpos
6902 && IT_CHARPOS (*it
) > to_charpos
)
6903 /* Passed TO_CHARPOS from right to left. */
6904 || (prev_pos
> to_charpos
6905 && IT_CHARPOS (*it
) < to_charpos
)))))
6907 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6909 result
= MOVE_POS_MATCH_OR_ZV
;
6912 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6913 /* If wrap_it is valid, the current position might be in a
6914 word that is wrapped. So, save the iterator in
6915 atpos_it and continue to see if wrapping happens. */
6919 prev_method
= it
->method
;
6920 if (it
->method
== GET_FROM_BUFFER
)
6921 prev_pos
= IT_CHARPOS (*it
);
6922 /* Stop when ZV reached.
6923 We used to stop here when TO_CHARPOS reached as well, but that is
6924 too soon if this glyph does not fit on this line. So we handle it
6925 explicitly below. */
6926 if (!get_next_display_element (it
))
6928 result
= MOVE_POS_MATCH_OR_ZV
;
6932 if (it
->line_wrap
== TRUNCATE
)
6934 if (BUFFER_POS_REACHED_P ())
6936 result
= MOVE_POS_MATCH_OR_ZV
;
6942 if (it
->line_wrap
== WORD_WRAP
)
6944 if (IT_DISPLAYING_WHITESPACE (it
))
6948 /* We have reached a glyph that follows one or more
6949 whitespace characters. If the position is
6950 already found, we are done. */
6951 if (atpos_it
.sp
>= 0)
6954 result
= MOVE_POS_MATCH_OR_ZV
;
6960 result
= MOVE_X_REACHED
;
6963 /* Otherwise, we can wrap here. */
6970 /* Remember the line height for the current line, in case
6971 the next element doesn't fit on the line. */
6972 ascent
= it
->max_ascent
;
6973 descent
= it
->max_descent
;
6975 /* The call to produce_glyphs will get the metrics of the
6976 display element IT is loaded with. Record the x-position
6977 before this display element, in case it doesn't fit on the
6981 PRODUCE_GLYPHS (it
);
6983 if (it
->area
!= TEXT_AREA
)
6985 set_iterator_to_next (it
, 1);
6986 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6987 SET_TEXT_POS (this_line_min_pos
,
6988 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6992 /* The number of glyphs we get back in IT->nglyphs will normally
6993 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6994 character on a terminal frame, or (iii) a line end. For the
6995 second case, IT->nglyphs - 1 padding glyphs will be present.
6996 (On X frames, there is only one glyph produced for a
6997 composite character.)
6999 The behavior implemented below means, for continuation lines,
7000 that as many spaces of a TAB as fit on the current line are
7001 displayed there. For terminal frames, as many glyphs of a
7002 multi-glyph character are displayed in the current line, too.
7003 This is what the old redisplay code did, and we keep it that
7004 way. Under X, the whole shape of a complex character must
7005 fit on the line or it will be completely displayed in the
7008 Note that both for tabs and padding glyphs, all glyphs have
7012 /* More than one glyph or glyph doesn't fit on line. All
7013 glyphs have the same width. */
7014 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7016 int x_before_this_char
= x
;
7017 int hpos_before_this_char
= it
->hpos
;
7019 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7021 new_x
= x
+ single_glyph_width
;
7023 /* We want to leave anything reaching TO_X to the caller. */
7024 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7026 if (BUFFER_POS_REACHED_P ())
7028 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7029 goto buffer_pos_reached
;
7030 if (atpos_it
.sp
< 0)
7033 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7038 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7041 result
= MOVE_X_REACHED
;
7047 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7052 if (/* Lines are continued. */
7053 it
->line_wrap
!= TRUNCATE
7054 && (/* And glyph doesn't fit on the line. */
7055 new_x
> it
->last_visible_x
7056 /* Or it fits exactly and we're on a window
7058 || (new_x
== it
->last_visible_x
7059 && FRAME_WINDOW_P (it
->f
))))
7061 if (/* IT->hpos == 0 means the very first glyph
7062 doesn't fit on the line, e.g. a wide image. */
7064 || (new_x
== it
->last_visible_x
7065 && FRAME_WINDOW_P (it
->f
)))
7068 it
->current_x
= new_x
;
7070 /* The character's last glyph just barely fits
7072 if (i
== it
->nglyphs
- 1)
7074 /* If this is the destination position,
7075 return a position *before* it in this row,
7076 now that we know it fits in this row. */
7077 if (BUFFER_POS_REACHED_P ())
7079 if (it
->line_wrap
!= WORD_WRAP
7082 it
->hpos
= hpos_before_this_char
;
7083 it
->current_x
= x_before_this_char
;
7084 result
= MOVE_POS_MATCH_OR_ZV
;
7087 if (it
->line_wrap
== WORD_WRAP
7091 atpos_it
.current_x
= x_before_this_char
;
7092 atpos_it
.hpos
= hpos_before_this_char
;
7096 set_iterator_to_next (it
, 1);
7097 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7098 SET_TEXT_POS (this_line_min_pos
,
7099 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7100 /* On graphical terminals, newlines may
7101 "overflow" into the fringe if
7102 overflow-newline-into-fringe is non-nil.
7103 On text-only terminals, newlines may
7104 overflow into the last glyph on the
7106 if (!FRAME_WINDOW_P (it
->f
)
7107 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7109 if (!get_next_display_element (it
))
7111 result
= MOVE_POS_MATCH_OR_ZV
;
7114 if (BUFFER_POS_REACHED_P ())
7116 if (ITERATOR_AT_END_OF_LINE_P (it
))
7117 result
= MOVE_POS_MATCH_OR_ZV
;
7119 result
= MOVE_LINE_CONTINUED
;
7122 if (ITERATOR_AT_END_OF_LINE_P (it
))
7124 result
= MOVE_NEWLINE_OR_CR
;
7131 IT_RESET_X_ASCENT_DESCENT (it
);
7133 if (wrap_it
.sp
>= 0)
7140 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7142 result
= MOVE_LINE_CONTINUED
;
7146 if (BUFFER_POS_REACHED_P ())
7148 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7149 goto buffer_pos_reached
;
7150 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7153 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7157 if (new_x
> it
->first_visible_x
)
7159 /* Glyph is visible. Increment number of glyphs that
7160 would be displayed. */
7165 if (result
!= MOVE_UNDEFINED
)
7168 else if (BUFFER_POS_REACHED_P ())
7171 IT_RESET_X_ASCENT_DESCENT (it
);
7172 result
= MOVE_POS_MATCH_OR_ZV
;
7175 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7177 /* Stop when TO_X specified and reached. This check is
7178 necessary here because of lines consisting of a line end,
7179 only. The line end will not produce any glyphs and we
7180 would never get MOVE_X_REACHED. */
7181 xassert (it
->nglyphs
== 0);
7182 result
= MOVE_X_REACHED
;
7186 /* Is this a line end? If yes, we're done. */
7187 if (ITERATOR_AT_END_OF_LINE_P (it
))
7189 result
= MOVE_NEWLINE_OR_CR
;
7193 if (it
->method
== GET_FROM_BUFFER
)
7194 prev_pos
= IT_CHARPOS (*it
);
7195 /* The current display element has been consumed. Advance
7197 set_iterator_to_next (it
, 1);
7198 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7199 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7201 /* Stop if lines are truncated and IT's current x-position is
7202 past the right edge of the window now. */
7203 if (it
->line_wrap
== TRUNCATE
7204 && it
->current_x
>= it
->last_visible_x
)
7206 if (!FRAME_WINDOW_P (it
->f
)
7207 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7209 if (!get_next_display_element (it
)
7210 || BUFFER_POS_REACHED_P ())
7212 result
= MOVE_POS_MATCH_OR_ZV
;
7215 if (ITERATOR_AT_END_OF_LINE_P (it
))
7217 result
= MOVE_NEWLINE_OR_CR
;
7221 result
= MOVE_LINE_TRUNCATED
;
7224 #undef IT_RESET_X_ASCENT_DESCENT
7227 #undef BUFFER_POS_REACHED_P
7229 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7230 restore the saved iterator. */
7231 if (atpos_it
.sp
>= 0)
7233 else if (atx_it
.sp
>= 0)
7238 /* Restore the iterator settings altered at the beginning of this
7240 it
->glyph_row
= saved_glyph_row
;
7244 /* For external use. */
7246 move_it_in_display_line (struct it
*it
,
7247 EMACS_INT to_charpos
, int to_x
,
7248 enum move_operation_enum op
)
7250 if (it
->line_wrap
== WORD_WRAP
7251 && (op
& MOVE_TO_X
))
7253 struct it save_it
= *it
;
7254 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7255 /* When word-wrap is on, TO_X may lie past the end
7256 of a wrapped line. Then it->current is the
7257 character on the next line, so backtrack to the
7258 space before the wrap point. */
7259 if (skip
== MOVE_LINE_CONTINUED
)
7261 int prev_x
= max (it
->current_x
- 1, 0);
7263 move_it_in_display_line_to
7264 (it
, -1, prev_x
, MOVE_TO_X
);
7268 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7272 /* Move IT forward until it satisfies one or more of the criteria in
7273 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7275 OP is a bit-mask that specifies where to stop, and in particular,
7276 which of those four position arguments makes a difference. See the
7277 description of enum move_operation_enum.
7279 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7280 screen line, this function will set IT to the next position >
7284 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7286 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7287 int line_height
, line_start_x
= 0, reached
= 0;
7291 if (op
& MOVE_TO_VPOS
)
7293 /* If no TO_CHARPOS and no TO_X specified, stop at the
7294 start of the line TO_VPOS. */
7295 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7297 if (it
->vpos
== to_vpos
)
7303 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7307 /* TO_VPOS >= 0 means stop at TO_X in the line at
7308 TO_VPOS, or at TO_POS, whichever comes first. */
7309 if (it
->vpos
== to_vpos
)
7315 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7317 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7322 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7324 /* We have reached TO_X but not in the line we want. */
7325 skip
= move_it_in_display_line_to (it
, to_charpos
,
7327 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7335 else if (op
& MOVE_TO_Y
)
7337 struct it it_backup
;
7339 if (it
->line_wrap
== WORD_WRAP
)
7342 /* TO_Y specified means stop at TO_X in the line containing
7343 TO_Y---or at TO_CHARPOS if this is reached first. The
7344 problem is that we can't really tell whether the line
7345 contains TO_Y before we have completely scanned it, and
7346 this may skip past TO_X. What we do is to first scan to
7349 If TO_X is not specified, use a TO_X of zero. The reason
7350 is to make the outcome of this function more predictable.
7351 If we didn't use TO_X == 0, we would stop at the end of
7352 the line which is probably not what a caller would expect
7354 skip
= move_it_in_display_line_to
7355 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7356 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7358 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7359 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7361 else if (skip
== MOVE_X_REACHED
)
7363 /* If TO_X was reached, we want to know whether TO_Y is
7364 in the line. We know this is the case if the already
7365 scanned glyphs make the line tall enough. Otherwise,
7366 we must check by scanning the rest of the line. */
7367 line_height
= it
->max_ascent
+ it
->max_descent
;
7368 if (to_y
>= it
->current_y
7369 && to_y
< it
->current_y
+ line_height
)
7375 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7376 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7378 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7379 line_height
= it
->max_ascent
+ it
->max_descent
;
7380 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7382 if (to_y
>= it
->current_y
7383 && to_y
< it
->current_y
+ line_height
)
7385 /* If TO_Y is in this line and TO_X was reached
7386 above, we scanned too far. We have to restore
7387 IT's settings to the ones before skipping. */
7394 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7400 /* Check whether TO_Y is in this line. */
7401 line_height
= it
->max_ascent
+ it
->max_descent
;
7402 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7404 if (to_y
>= it
->current_y
7405 && to_y
< it
->current_y
+ line_height
)
7407 /* When word-wrap is on, TO_X may lie past the end
7408 of a wrapped line. Then it->current is the
7409 character on the next line, so backtrack to the
7410 space before the wrap point. */
7411 if (skip
== MOVE_LINE_CONTINUED
7412 && it
->line_wrap
== WORD_WRAP
)
7414 int prev_x
= max (it
->current_x
- 1, 0);
7416 skip
= move_it_in_display_line_to
7417 (it
, -1, prev_x
, MOVE_TO_X
);
7426 else if (BUFFERP (it
->object
)
7427 && (it
->method
== GET_FROM_BUFFER
7428 || it
->method
== GET_FROM_STRETCH
)
7429 && IT_CHARPOS (*it
) >= to_charpos
)
7430 skip
= MOVE_POS_MATCH_OR_ZV
;
7432 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7436 case MOVE_POS_MATCH_OR_ZV
:
7440 case MOVE_NEWLINE_OR_CR
:
7441 set_iterator_to_next (it
, 1);
7442 it
->continuation_lines_width
= 0;
7445 case MOVE_LINE_TRUNCATED
:
7446 it
->continuation_lines_width
= 0;
7447 reseat_at_next_visible_line_start (it
, 0);
7448 if ((op
& MOVE_TO_POS
) != 0
7449 && IT_CHARPOS (*it
) > to_charpos
)
7456 case MOVE_LINE_CONTINUED
:
7457 /* For continued lines ending in a tab, some of the glyphs
7458 associated with the tab are displayed on the current
7459 line. Since it->current_x does not include these glyphs,
7460 we use it->last_visible_x instead. */
7463 it
->continuation_lines_width
+= it
->last_visible_x
;
7464 /* When moving by vpos, ensure that the iterator really
7465 advances to the next line (bug#847, bug#969). Fixme:
7466 do we need to do this in other circumstances? */
7467 if (it
->current_x
!= it
->last_visible_x
7468 && (op
& MOVE_TO_VPOS
)
7469 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7471 line_start_x
= it
->current_x
+ it
->pixel_width
7472 - it
->last_visible_x
;
7473 set_iterator_to_next (it
, 0);
7477 it
->continuation_lines_width
+= it
->current_x
;
7484 /* Reset/increment for the next run. */
7485 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7486 it
->current_x
= line_start_x
;
7489 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7491 last_height
= it
->max_ascent
+ it
->max_descent
;
7492 last_max_ascent
= it
->max_ascent
;
7493 it
->max_ascent
= it
->max_descent
= 0;
7498 /* On text terminals, we may stop at the end of a line in the middle
7499 of a multi-character glyph. If the glyph itself is continued,
7500 i.e. it is actually displayed on the next line, don't treat this
7501 stopping point as valid; move to the next line instead (unless
7502 that brings us offscreen). */
7503 if (!FRAME_WINDOW_P (it
->f
)
7505 && IT_CHARPOS (*it
) == to_charpos
7506 && it
->what
== IT_CHARACTER
7508 && it
->line_wrap
== WINDOW_WRAP
7509 && it
->current_x
== it
->last_visible_x
- 1
7512 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7514 it
->continuation_lines_width
+= it
->current_x
;
7515 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7516 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7518 last_height
= it
->max_ascent
+ it
->max_descent
;
7519 last_max_ascent
= it
->max_ascent
;
7522 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7526 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7528 If DY > 0, move IT backward at least that many pixels. DY = 0
7529 means move IT backward to the preceding line start or BEGV. This
7530 function may move over more than DY pixels if IT->current_y - DY
7531 ends up in the middle of a line; in this case IT->current_y will be
7532 set to the top of the line moved to. */
7535 move_it_vertically_backward (struct it
*it
, int dy
)
7539 EMACS_INT start_pos
;
7544 start_pos
= IT_CHARPOS (*it
);
7546 /* Estimate how many newlines we must move back. */
7547 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7549 /* Set the iterator's position that many lines back. */
7550 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7551 back_to_previous_visible_line_start (it
);
7553 /* Reseat the iterator here. When moving backward, we don't want
7554 reseat to skip forward over invisible text, set up the iterator
7555 to deliver from overlay strings at the new position etc. So,
7556 use reseat_1 here. */
7557 reseat_1 (it
, it
->current
.pos
, 1);
7559 /* We are now surely at a line start. */
7560 it
->current_x
= it
->hpos
= 0;
7561 it
->continuation_lines_width
= 0;
7563 /* Move forward and see what y-distance we moved. First move to the
7564 start of the next line so that we get its height. We need this
7565 height to be able to tell whether we reached the specified
7568 it2
.max_ascent
= it2
.max_descent
= 0;
7571 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7572 MOVE_TO_POS
| MOVE_TO_VPOS
);
7574 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7575 xassert (IT_CHARPOS (*it
) >= BEGV
);
7578 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7579 xassert (IT_CHARPOS (*it
) >= BEGV
);
7580 /* H is the actual vertical distance from the position in *IT
7581 and the starting position. */
7582 h
= it2
.current_y
- it
->current_y
;
7583 /* NLINES is the distance in number of lines. */
7584 nlines
= it2
.vpos
- it
->vpos
;
7586 /* Correct IT's y and vpos position
7587 so that they are relative to the starting point. */
7593 /* DY == 0 means move to the start of the screen line. The
7594 value of nlines is > 0 if continuation lines were involved. */
7596 move_it_by_lines (it
, nlines
);
7600 /* The y-position we try to reach, relative to *IT.
7601 Note that H has been subtracted in front of the if-statement. */
7602 int target_y
= it
->current_y
+ h
- dy
;
7603 int y0
= it3
.current_y
;
7604 int y1
= line_bottom_y (&it3
);
7605 int line_height
= y1
- y0
;
7607 /* If we did not reach target_y, try to move further backward if
7608 we can. If we moved too far backward, try to move forward. */
7609 if (target_y
< it
->current_y
7610 /* This is heuristic. In a window that's 3 lines high, with
7611 a line height of 13 pixels each, recentering with point
7612 on the bottom line will try to move -39/2 = 19 pixels
7613 backward. Try to avoid moving into the first line. */
7614 && (it
->current_y
- target_y
7615 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7616 && IT_CHARPOS (*it
) > BEGV
)
7618 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7619 target_y
- it
->current_y
));
7620 dy
= it
->current_y
- target_y
;
7621 goto move_further_back
;
7623 else if (target_y
>= it
->current_y
+ line_height
7624 && IT_CHARPOS (*it
) < ZV
)
7626 /* Should move forward by at least one line, maybe more.
7628 Note: Calling move_it_by_lines can be expensive on
7629 terminal frames, where compute_motion is used (via
7630 vmotion) to do the job, when there are very long lines
7631 and truncate-lines is nil. That's the reason for
7632 treating terminal frames specially here. */
7634 if (!FRAME_WINDOW_P (it
->f
))
7635 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7640 move_it_by_lines (it
, 1);
7642 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7649 /* Move IT by a specified amount of pixel lines DY. DY negative means
7650 move backwards. DY = 0 means move to start of screen line. At the
7651 end, IT will be on the start of a screen line. */
7654 move_it_vertically (struct it
*it
, int dy
)
7657 move_it_vertically_backward (it
, -dy
);
7660 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7661 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7662 MOVE_TO_POS
| MOVE_TO_Y
);
7663 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7665 /* If buffer ends in ZV without a newline, move to the start of
7666 the line to satisfy the post-condition. */
7667 if (IT_CHARPOS (*it
) == ZV
7669 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7670 move_it_by_lines (it
, 0);
7675 /* Move iterator IT past the end of the text line it is in. */
7678 move_it_past_eol (struct it
*it
)
7680 enum move_it_result rc
;
7682 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7683 if (rc
== MOVE_NEWLINE_OR_CR
)
7684 set_iterator_to_next (it
, 0);
7688 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7689 negative means move up. DVPOS == 0 means move to the start of the
7692 Optimization idea: If we would know that IT->f doesn't use
7693 a face with proportional font, we could be faster for
7694 truncate-lines nil. */
7697 move_it_by_lines (struct it
*it
, int dvpos
)
7700 /* The commented-out optimization uses vmotion on terminals. This
7701 gives bad results, because elements like it->what, on which
7702 callers such as pos_visible_p rely, aren't updated. */
7703 /* struct position pos;
7704 if (!FRAME_WINDOW_P (it->f))
7706 struct text_pos textpos;
7708 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7709 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7710 reseat (it, textpos, 1);
7711 it->vpos += pos.vpos;
7712 it->current_y += pos.vpos;
7718 /* DVPOS == 0 means move to the start of the screen line. */
7719 move_it_vertically_backward (it
, 0);
7720 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7721 /* Let next call to line_bottom_y calculate real line height */
7726 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7727 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7728 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7733 EMACS_INT start_charpos
, i
;
7735 /* Start at the beginning of the screen line containing IT's
7736 position. This may actually move vertically backwards,
7737 in case of overlays, so adjust dvpos accordingly. */
7739 move_it_vertically_backward (it
, 0);
7742 /* Go back -DVPOS visible lines and reseat the iterator there. */
7743 start_charpos
= IT_CHARPOS (*it
);
7744 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7745 back_to_previous_visible_line_start (it
);
7746 reseat (it
, it
->current
.pos
, 1);
7748 /* Move further back if we end up in a string or an image. */
7749 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7751 /* First try to move to start of display line. */
7753 move_it_vertically_backward (it
, 0);
7755 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7757 /* If start of line is still in string or image,
7758 move further back. */
7759 back_to_previous_visible_line_start (it
);
7760 reseat (it
, it
->current
.pos
, 1);
7764 it
->current_x
= it
->hpos
= 0;
7766 /* Above call may have moved too far if continuation lines
7767 are involved. Scan forward and see if it did. */
7769 it2
.vpos
= it2
.current_y
= 0;
7770 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7771 it
->vpos
-= it2
.vpos
;
7772 it
->current_y
-= it2
.current_y
;
7773 it
->current_x
= it
->hpos
= 0;
7775 /* If we moved too far back, move IT some lines forward. */
7776 if (it2
.vpos
> -dvpos
)
7778 int delta
= it2
.vpos
+ dvpos
;
7780 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7781 /* Move back again if we got too far ahead. */
7782 if (IT_CHARPOS (*it
) >= start_charpos
)
7788 /* Return 1 if IT points into the middle of a display vector. */
7791 in_display_vector_p (struct it
*it
)
7793 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7794 && it
->current
.dpvec_index
> 0
7795 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7799 /***********************************************************************
7801 ***********************************************************************/
7804 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7808 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7810 Lisp_Object args
[3];
7811 Lisp_Object msg
, fmt
;
7814 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7817 /* Do nothing if called asynchronously. Inserting text into
7818 a buffer may call after-change-functions and alike and
7819 that would means running Lisp asynchronously. */
7820 if (handling_signal
)
7824 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7826 args
[0] = fmt
= build_string (format
);
7829 msg
= Fformat (3, args
);
7831 len
= SBYTES (msg
) + 1;
7832 SAFE_ALLOCA (buffer
, char *, len
);
7833 memcpy (buffer
, SDATA (msg
), len
);
7835 message_dolog (buffer
, len
- 1, 1, 0);
7842 /* Output a newline in the *Messages* buffer if "needs" one. */
7845 message_log_maybe_newline (void)
7847 if (message_log_need_newline
)
7848 message_dolog ("", 0, 1, 0);
7852 /* Add a string M of length NBYTES to the message log, optionally
7853 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7854 nonzero, means interpret the contents of M as multibyte. This
7855 function calls low-level routines in order to bypass text property
7856 hooks, etc. which might not be safe to run.
7858 This may GC (insert may run before/after change hooks),
7859 so the buffer M must NOT point to a Lisp string. */
7862 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7864 const unsigned char *msg
= (const unsigned char *) m
;
7866 if (!NILP (Vmemory_full
))
7869 if (!NILP (Vmessage_log_max
))
7871 struct buffer
*oldbuf
;
7872 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7873 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7874 EMACS_INT point_at_end
= 0;
7875 EMACS_INT zv_at_end
= 0;
7876 Lisp_Object old_deactivate_mark
, tem
;
7877 struct gcpro gcpro1
;
7879 old_deactivate_mark
= Vdeactivate_mark
;
7880 oldbuf
= current_buffer
;
7881 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7882 BVAR (current_buffer
, undo_list
) = Qt
;
7884 oldpoint
= message_dolog_marker1
;
7885 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7886 oldbegv
= message_dolog_marker2
;
7887 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7888 oldzv
= message_dolog_marker3
;
7889 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7890 GCPRO1 (old_deactivate_mark
);
7898 BEGV_BYTE
= BEG_BYTE
;
7901 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7903 /* Insert the string--maybe converting multibyte to single byte
7904 or vice versa, so that all the text fits the buffer. */
7906 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7912 /* Convert a multibyte string to single-byte
7913 for the *Message* buffer. */
7914 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7916 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7917 work
[0] = (ASCII_CHAR_P (c
)
7919 : multibyte_char_to_unibyte (c
));
7920 insert_1_both (work
, 1, 1, 1, 0, 0);
7923 else if (! multibyte
7924 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7928 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7929 /* Convert a single-byte string to multibyte
7930 for the *Message* buffer. */
7931 for (i
= 0; i
< nbytes
; i
++)
7934 MAKE_CHAR_MULTIBYTE (c
);
7935 char_bytes
= CHAR_STRING (c
, str
);
7936 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7940 insert_1 (m
, nbytes
, 1, 0, 0);
7944 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7945 unsigned long int dups
;
7946 insert_1 ("\n", 1, 1, 0, 0);
7948 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7950 this_bol_byte
= PT_BYTE
;
7952 /* See if this line duplicates the previous one.
7953 If so, combine duplicates. */
7956 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7958 prev_bol_byte
= PT_BYTE
;
7960 dups
= message_log_check_duplicate (prev_bol_byte
,
7964 del_range_both (prev_bol
, prev_bol_byte
,
7965 this_bol
, this_bol_byte
, 0);
7971 /* If you change this format, don't forget to also
7972 change message_log_check_duplicate. */
7973 sprintf (dupstr
, " [%lu times]", dups
);
7974 duplen
= strlen (dupstr
);
7975 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7976 insert_1 (dupstr
, duplen
, 1, 0, 1);
7981 /* If we have more than the desired maximum number of lines
7982 in the *Messages* buffer now, delete the oldest ones.
7983 This is safe because we don't have undo in this buffer. */
7985 if (NATNUMP (Vmessage_log_max
))
7987 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7988 -XFASTINT (Vmessage_log_max
) - 1, 0);
7989 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7992 BEGV
= XMARKER (oldbegv
)->charpos
;
7993 BEGV_BYTE
= marker_byte_position (oldbegv
);
8002 ZV
= XMARKER (oldzv
)->charpos
;
8003 ZV_BYTE
= marker_byte_position (oldzv
);
8007 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8009 /* We can't do Fgoto_char (oldpoint) because it will run some
8011 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8012 XMARKER (oldpoint
)->bytepos
);
8015 unchain_marker (XMARKER (oldpoint
));
8016 unchain_marker (XMARKER (oldbegv
));
8017 unchain_marker (XMARKER (oldzv
));
8019 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8020 set_buffer_internal (oldbuf
);
8022 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8023 message_log_need_newline
= !nlflag
;
8024 Vdeactivate_mark
= old_deactivate_mark
;
8029 /* We are at the end of the buffer after just having inserted a newline.
8030 (Note: We depend on the fact we won't be crossing the gap.)
8031 Check to see if the most recent message looks a lot like the previous one.
8032 Return 0 if different, 1 if the new one should just replace it, or a
8033 value N > 1 if we should also append " [N times]". */
8035 static unsigned long int
8036 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8039 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8041 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8042 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8044 for (i
= 0; i
< len
; i
++)
8046 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8054 if (*p1
++ == ' ' && *p1
++ == '[')
8057 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8058 if (strncmp (pend
, " times]\n", 8) == 0)
8065 /* Display an echo area message M with a specified length of NBYTES
8066 bytes. The string may include null characters. If M is 0, clear
8067 out any existing message, and let the mini-buffer text show
8070 This may GC, so the buffer M must NOT point to a Lisp string. */
8073 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8075 /* First flush out any partial line written with print. */
8076 message_log_maybe_newline ();
8078 message_dolog (m
, nbytes
, 1, multibyte
);
8079 message2_nolog (m
, nbytes
, multibyte
);
8083 /* The non-logging counterpart of message2. */
8086 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8088 struct frame
*sf
= SELECTED_FRAME ();
8089 message_enable_multibyte
= multibyte
;
8091 if (FRAME_INITIAL_P (sf
))
8093 if (noninteractive_need_newline
)
8094 putc ('\n', stderr
);
8095 noninteractive_need_newline
= 0;
8097 fwrite (m
, nbytes
, 1, stderr
);
8098 if (cursor_in_echo_area
== 0)
8099 fprintf (stderr
, "\n");
8102 /* A null message buffer means that the frame hasn't really been
8103 initialized yet. Error messages get reported properly by
8104 cmd_error, so this must be just an informative message; toss it. */
8105 else if (INTERACTIVE
8106 && sf
->glyphs_initialized_p
8107 && FRAME_MESSAGE_BUF (sf
))
8109 Lisp_Object mini_window
;
8112 /* Get the frame containing the mini-buffer
8113 that the selected frame is using. */
8114 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8115 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8117 FRAME_SAMPLE_VISIBILITY (f
);
8118 if (FRAME_VISIBLE_P (sf
)
8119 && ! FRAME_VISIBLE_P (f
))
8120 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8124 set_message (m
, Qnil
, nbytes
, multibyte
);
8125 if (minibuffer_auto_raise
)
8126 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8129 clear_message (1, 1);
8131 do_pending_window_change (0);
8132 echo_area_display (1);
8133 do_pending_window_change (0);
8134 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8135 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8140 /* Display an echo area message M with a specified length of NBYTES
8141 bytes. The string may include null characters. If M is not a
8142 string, clear out any existing message, and let the mini-buffer
8145 This function cancels echoing. */
8148 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8150 struct gcpro gcpro1
;
8153 clear_message (1,1);
8156 /* First flush out any partial line written with print. */
8157 message_log_maybe_newline ();
8163 SAFE_ALLOCA (buffer
, char *, nbytes
);
8164 memcpy (buffer
, SDATA (m
), nbytes
);
8165 message_dolog (buffer
, nbytes
, 1, multibyte
);
8168 message3_nolog (m
, nbytes
, multibyte
);
8174 /* The non-logging version of message3.
8175 This does not cancel echoing, because it is used for echoing.
8176 Perhaps we need to make a separate function for echoing
8177 and make this cancel echoing. */
8180 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8182 struct frame
*sf
= SELECTED_FRAME ();
8183 message_enable_multibyte
= multibyte
;
8185 if (FRAME_INITIAL_P (sf
))
8187 if (noninteractive_need_newline
)
8188 putc ('\n', stderr
);
8189 noninteractive_need_newline
= 0;
8191 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8192 if (cursor_in_echo_area
== 0)
8193 fprintf (stderr
, "\n");
8196 /* A null message buffer means that the frame hasn't really been
8197 initialized yet. Error messages get reported properly by
8198 cmd_error, so this must be just an informative message; toss it. */
8199 else if (INTERACTIVE
8200 && sf
->glyphs_initialized_p
8201 && FRAME_MESSAGE_BUF (sf
))
8203 Lisp_Object mini_window
;
8207 /* Get the frame containing the mini-buffer
8208 that the selected frame is using. */
8209 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8210 frame
= XWINDOW (mini_window
)->frame
;
8213 FRAME_SAMPLE_VISIBILITY (f
);
8214 if (FRAME_VISIBLE_P (sf
)
8215 && !FRAME_VISIBLE_P (f
))
8216 Fmake_frame_visible (frame
);
8218 if (STRINGP (m
) && SCHARS (m
) > 0)
8220 set_message (NULL
, m
, nbytes
, multibyte
);
8221 if (minibuffer_auto_raise
)
8222 Fraise_frame (frame
);
8223 /* Assume we are not echoing.
8224 (If we are, echo_now will override this.) */
8225 echo_message_buffer
= Qnil
;
8228 clear_message (1, 1);
8230 do_pending_window_change (0);
8231 echo_area_display (1);
8232 do_pending_window_change (0);
8233 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8234 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8239 /* Display a null-terminated echo area message M. If M is 0, clear
8240 out any existing message, and let the mini-buffer text show through.
8242 The buffer M must continue to exist until after the echo area gets
8243 cleared or some other message gets displayed there. Do not pass
8244 text that is stored in a Lisp string. Do not pass text in a buffer
8245 that was alloca'd. */
8248 message1 (const char *m
)
8250 message2 (m
, (m
? strlen (m
) : 0), 0);
8254 /* The non-logging counterpart of message1. */
8257 message1_nolog (const char *m
)
8259 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8262 /* Display a message M which contains a single %s
8263 which gets replaced with STRING. */
8266 message_with_string (const char *m
, Lisp_Object string
, int log
)
8268 CHECK_STRING (string
);
8274 if (noninteractive_need_newline
)
8275 putc ('\n', stderr
);
8276 noninteractive_need_newline
= 0;
8277 fprintf (stderr
, m
, SDATA (string
));
8278 if (!cursor_in_echo_area
)
8279 fprintf (stderr
, "\n");
8283 else if (INTERACTIVE
)
8285 /* The frame whose minibuffer we're going to display the message on.
8286 It may be larger than the selected frame, so we need
8287 to use its buffer, not the selected frame's buffer. */
8288 Lisp_Object mini_window
;
8289 struct frame
*f
, *sf
= SELECTED_FRAME ();
8291 /* Get the frame containing the minibuffer
8292 that the selected frame is using. */
8293 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8294 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8296 /* A null message buffer means that the frame hasn't really been
8297 initialized yet. Error messages get reported properly by
8298 cmd_error, so this must be just an informative message; toss it. */
8299 if (FRAME_MESSAGE_BUF (f
))
8301 Lisp_Object args
[2], msg
;
8302 struct gcpro gcpro1
, gcpro2
;
8304 args
[0] = build_string (m
);
8305 args
[1] = msg
= string
;
8306 GCPRO2 (args
[0], msg
);
8309 msg
= Fformat (2, args
);
8312 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8314 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8318 /* Print should start at the beginning of the message
8319 buffer next time. */
8320 message_buf_print
= 0;
8326 /* Dump an informative message to the minibuf. If M is 0, clear out
8327 any existing message, and let the mini-buffer text show through. */
8330 vmessage (const char *m
, va_list ap
)
8336 if (noninteractive_need_newline
)
8337 putc ('\n', stderr
);
8338 noninteractive_need_newline
= 0;
8339 vfprintf (stderr
, m
, ap
);
8340 if (cursor_in_echo_area
== 0)
8341 fprintf (stderr
, "\n");
8345 else if (INTERACTIVE
)
8347 /* The frame whose mini-buffer we're going to display the message
8348 on. It may be larger than the selected frame, so we need to
8349 use its buffer, not the selected frame's buffer. */
8350 Lisp_Object mini_window
;
8351 struct frame
*f
, *sf
= SELECTED_FRAME ();
8353 /* Get the frame containing the mini-buffer
8354 that the selected frame is using. */
8355 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8356 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8358 /* A null message buffer means that the frame hasn't really been
8359 initialized yet. Error messages get reported properly by
8360 cmd_error, so this must be just an informative message; toss
8362 if (FRAME_MESSAGE_BUF (f
))
8366 char *buf
= FRAME_MESSAGE_BUF (f
);
8367 size_t bufsize
= FRAME_MESSAGE_BUF_SIZE (f
);
8370 memset (buf
, 0, bufsize
);
8371 len
= vsnprintf (buf
, bufsize
, m
, ap
);
8373 /* Do any truncation at a character boundary. */
8374 if (! (0 <= len
&& len
< bufsize
))
8376 char *end
= memchr (buf
, 0, bufsize
);
8377 for (len
= end
? end
- buf
: bufsize
;
8378 len
&& ! CHAR_HEAD_P (buf
[len
- 1]);
8383 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8388 /* Print should start at the beginning of the message
8389 buffer next time. */
8390 message_buf_print
= 0;
8396 message (const char *m
, ...)
8406 /* The non-logging version of message. */
8409 message_nolog (const char *m
, ...)
8411 Lisp_Object old_log_max
;
8414 old_log_max
= Vmessage_log_max
;
8415 Vmessage_log_max
= Qnil
;
8417 Vmessage_log_max
= old_log_max
;
8423 /* Display the current message in the current mini-buffer. This is
8424 only called from error handlers in process.c, and is not time
8428 update_echo_area (void)
8430 if (!NILP (echo_area_buffer
[0]))
8433 string
= Fcurrent_message ();
8434 message3 (string
, SBYTES (string
),
8435 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8440 /* Make sure echo area buffers in `echo_buffers' are live.
8441 If they aren't, make new ones. */
8444 ensure_echo_area_buffers (void)
8448 for (i
= 0; i
< 2; ++i
)
8449 if (!BUFFERP (echo_buffer
[i
])
8450 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8453 Lisp_Object old_buffer
;
8456 old_buffer
= echo_buffer
[i
];
8457 sprintf (name
, " *Echo Area %d*", i
);
8458 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8459 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8460 /* to force word wrap in echo area -
8461 it was decided to postpone this*/
8462 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8464 for (j
= 0; j
< 2; ++j
)
8465 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8466 echo_area_buffer
[j
] = echo_buffer
[i
];
8471 /* Call FN with args A1..A4 with either the current or last displayed
8472 echo_area_buffer as current buffer.
8474 WHICH zero means use the current message buffer
8475 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8476 from echo_buffer[] and clear it.
8478 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8479 suitable buffer from echo_buffer[] and clear it.
8481 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8482 that the current message becomes the last displayed one, make
8483 choose a suitable buffer for echo_area_buffer[0], and clear it.
8485 Value is what FN returns. */
8488 with_echo_area_buffer (struct window
*w
, int which
,
8489 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8490 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8493 int this_one
, the_other
, clear_buffer_p
, rc
;
8494 int count
= SPECPDL_INDEX ();
8496 /* If buffers aren't live, make new ones. */
8497 ensure_echo_area_buffers ();
8502 this_one
= 0, the_other
= 1;
8504 this_one
= 1, the_other
= 0;
8507 this_one
= 0, the_other
= 1;
8510 /* We need a fresh one in case the current echo buffer equals
8511 the one containing the last displayed echo area message. */
8512 if (!NILP (echo_area_buffer
[this_one
])
8513 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8514 echo_area_buffer
[this_one
] = Qnil
;
8517 /* Choose a suitable buffer from echo_buffer[] is we don't
8519 if (NILP (echo_area_buffer
[this_one
]))
8521 echo_area_buffer
[this_one
]
8522 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8523 ? echo_buffer
[the_other
]
8524 : echo_buffer
[this_one
]);
8528 buffer
= echo_area_buffer
[this_one
];
8530 /* Don't get confused by reusing the buffer used for echoing
8531 for a different purpose. */
8532 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8535 record_unwind_protect (unwind_with_echo_area_buffer
,
8536 with_echo_area_buffer_unwind_data (w
));
8538 /* Make the echo area buffer current. Note that for display
8539 purposes, it is not necessary that the displayed window's buffer
8540 == current_buffer, except for text property lookup. So, let's
8541 only set that buffer temporarily here without doing a full
8542 Fset_window_buffer. We must also change w->pointm, though,
8543 because otherwise an assertions in unshow_buffer fails, and Emacs
8545 set_buffer_internal_1 (XBUFFER (buffer
));
8549 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8552 BVAR (current_buffer
, undo_list
) = Qt
;
8553 BVAR (current_buffer
, read_only
) = Qnil
;
8554 specbind (Qinhibit_read_only
, Qt
);
8555 specbind (Qinhibit_modification_hooks
, Qt
);
8557 if (clear_buffer_p
&& Z
> BEG
)
8560 xassert (BEGV
>= BEG
);
8561 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8563 rc
= fn (a1
, a2
, a3
, a4
);
8565 xassert (BEGV
>= BEG
);
8566 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8568 unbind_to (count
, Qnil
);
8573 /* Save state that should be preserved around the call to the function
8574 FN called in with_echo_area_buffer. */
8577 with_echo_area_buffer_unwind_data (struct window
*w
)
8580 Lisp_Object vector
, tmp
;
8582 /* Reduce consing by keeping one vector in
8583 Vwith_echo_area_save_vector. */
8584 vector
= Vwith_echo_area_save_vector
;
8585 Vwith_echo_area_save_vector
= Qnil
;
8588 vector
= Fmake_vector (make_number (7), Qnil
);
8590 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8591 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8592 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8596 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8597 ASET (vector
, i
, w
->buffer
); ++i
;
8598 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8599 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8604 for (; i
< end
; ++i
)
8605 ASET (vector
, i
, Qnil
);
8608 xassert (i
== ASIZE (vector
));
8613 /* Restore global state from VECTOR which was created by
8614 with_echo_area_buffer_unwind_data. */
8617 unwind_with_echo_area_buffer (Lisp_Object vector
)
8619 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8620 Vdeactivate_mark
= AREF (vector
, 1);
8621 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8623 if (WINDOWP (AREF (vector
, 3)))
8626 Lisp_Object buffer
, charpos
, bytepos
;
8628 w
= XWINDOW (AREF (vector
, 3));
8629 buffer
= AREF (vector
, 4);
8630 charpos
= AREF (vector
, 5);
8631 bytepos
= AREF (vector
, 6);
8634 set_marker_both (w
->pointm
, buffer
,
8635 XFASTINT (charpos
), XFASTINT (bytepos
));
8638 Vwith_echo_area_save_vector
= vector
;
8643 /* Set up the echo area for use by print functions. MULTIBYTE_P
8644 non-zero means we will print multibyte. */
8647 setup_echo_area_for_printing (int multibyte_p
)
8649 /* If we can't find an echo area any more, exit. */
8650 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8653 ensure_echo_area_buffers ();
8655 if (!message_buf_print
)
8657 /* A message has been output since the last time we printed.
8658 Choose a fresh echo area buffer. */
8659 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8660 echo_area_buffer
[0] = echo_buffer
[1];
8662 echo_area_buffer
[0] = echo_buffer
[0];
8664 /* Switch to that buffer and clear it. */
8665 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8666 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8670 int count
= SPECPDL_INDEX ();
8671 specbind (Qinhibit_read_only
, Qt
);
8672 /* Note that undo recording is always disabled. */
8674 unbind_to (count
, Qnil
);
8676 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8678 /* Set up the buffer for the multibyteness we need. */
8680 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8681 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8683 /* Raise the frame containing the echo area. */
8684 if (minibuffer_auto_raise
)
8686 struct frame
*sf
= SELECTED_FRAME ();
8687 Lisp_Object mini_window
;
8688 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8689 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8692 message_log_maybe_newline ();
8693 message_buf_print
= 1;
8697 if (NILP (echo_area_buffer
[0]))
8699 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8700 echo_area_buffer
[0] = echo_buffer
[1];
8702 echo_area_buffer
[0] = echo_buffer
[0];
8705 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8707 /* Someone switched buffers between print requests. */
8708 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8709 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8715 /* Display an echo area message in window W. Value is non-zero if W's
8716 height is changed. If display_last_displayed_message_p is
8717 non-zero, display the message that was last displayed, otherwise
8718 display the current message. */
8721 display_echo_area (struct window
*w
)
8723 int i
, no_message_p
, window_height_changed_p
, count
;
8725 /* Temporarily disable garbage collections while displaying the echo
8726 area. This is done because a GC can print a message itself.
8727 That message would modify the echo area buffer's contents while a
8728 redisplay of the buffer is going on, and seriously confuse
8730 count
= inhibit_garbage_collection ();
8732 /* If there is no message, we must call display_echo_area_1
8733 nevertheless because it resizes the window. But we will have to
8734 reset the echo_area_buffer in question to nil at the end because
8735 with_echo_area_buffer will sets it to an empty buffer. */
8736 i
= display_last_displayed_message_p
? 1 : 0;
8737 no_message_p
= NILP (echo_area_buffer
[i
]);
8739 window_height_changed_p
8740 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8741 display_echo_area_1
,
8742 (EMACS_INT
) w
, Qnil
, 0, 0);
8745 echo_area_buffer
[i
] = Qnil
;
8747 unbind_to (count
, Qnil
);
8748 return window_height_changed_p
;
8752 /* Helper for display_echo_area. Display the current buffer which
8753 contains the current echo area message in window W, a mini-window,
8754 a pointer to which is passed in A1. A2..A4 are currently not used.
8755 Change the height of W so that all of the message is displayed.
8756 Value is non-zero if height of W was changed. */
8759 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8761 struct window
*w
= (struct window
*) a1
;
8763 struct text_pos start
;
8764 int window_height_changed_p
= 0;
8766 /* Do this before displaying, so that we have a large enough glyph
8767 matrix for the display. If we can't get enough space for the
8768 whole text, display the last N lines. That works by setting w->start. */
8769 window_height_changed_p
= resize_mini_window (w
, 0);
8771 /* Use the starting position chosen by resize_mini_window. */
8772 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8775 clear_glyph_matrix (w
->desired_matrix
);
8776 XSETWINDOW (window
, w
);
8777 try_window (window
, start
, 0);
8779 return window_height_changed_p
;
8783 /* Resize the echo area window to exactly the size needed for the
8784 currently displayed message, if there is one. If a mini-buffer
8785 is active, don't shrink it. */
8788 resize_echo_area_exactly (void)
8790 if (BUFFERP (echo_area_buffer
[0])
8791 && WINDOWP (echo_area_window
))
8793 struct window
*w
= XWINDOW (echo_area_window
);
8795 Lisp_Object resize_exactly
;
8797 if (minibuf_level
== 0)
8798 resize_exactly
= Qt
;
8800 resize_exactly
= Qnil
;
8802 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8803 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8806 ++windows_or_buffers_changed
;
8807 ++update_mode_lines
;
8808 redisplay_internal ();
8814 /* Callback function for with_echo_area_buffer, when used from
8815 resize_echo_area_exactly. A1 contains a pointer to the window to
8816 resize, EXACTLY non-nil means resize the mini-window exactly to the
8817 size of the text displayed. A3 and A4 are not used. Value is what
8818 resize_mini_window returns. */
8821 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8823 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8827 /* Resize mini-window W to fit the size of its contents. EXACT_P
8828 means size the window exactly to the size needed. Otherwise, it's
8829 only enlarged until W's buffer is empty.
8831 Set W->start to the right place to begin display. If the whole
8832 contents fit, start at the beginning. Otherwise, start so as
8833 to make the end of the contents appear. This is particularly
8834 important for y-or-n-p, but seems desirable generally.
8836 Value is non-zero if the window height has been changed. */
8839 resize_mini_window (struct window
*w
, int exact_p
)
8841 struct frame
*f
= XFRAME (w
->frame
);
8842 int window_height_changed_p
= 0;
8844 xassert (MINI_WINDOW_P (w
));
8846 /* By default, start display at the beginning. */
8847 set_marker_both (w
->start
, w
->buffer
,
8848 BUF_BEGV (XBUFFER (w
->buffer
)),
8849 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8851 /* Don't resize windows while redisplaying a window; it would
8852 confuse redisplay functions when the size of the window they are
8853 displaying changes from under them. Such a resizing can happen,
8854 for instance, when which-func prints a long message while
8855 we are running fontification-functions. We're running these
8856 functions with safe_call which binds inhibit-redisplay to t. */
8857 if (!NILP (Vinhibit_redisplay
))
8860 /* Nil means don't try to resize. */
8861 if (NILP (Vresize_mini_windows
)
8862 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8865 if (!FRAME_MINIBUF_ONLY_P (f
))
8868 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8869 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8870 int height
, max_height
;
8871 int unit
= FRAME_LINE_HEIGHT (f
);
8872 struct text_pos start
;
8873 struct buffer
*old_current_buffer
= NULL
;
8875 if (current_buffer
!= XBUFFER (w
->buffer
))
8877 old_current_buffer
= current_buffer
;
8878 set_buffer_internal (XBUFFER (w
->buffer
));
8881 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8883 /* Compute the max. number of lines specified by the user. */
8884 if (FLOATP (Vmax_mini_window_height
))
8885 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8886 else if (INTEGERP (Vmax_mini_window_height
))
8887 max_height
= XINT (Vmax_mini_window_height
);
8889 max_height
= total_height
/ 4;
8891 /* Correct that max. height if it's bogus. */
8892 max_height
= max (1, max_height
);
8893 max_height
= min (total_height
, max_height
);
8895 /* Find out the height of the text in the window. */
8896 if (it
.line_wrap
== TRUNCATE
)
8901 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8902 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8903 height
= it
.current_y
+ last_height
;
8905 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8906 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8907 height
= (height
+ unit
- 1) / unit
;
8910 /* Compute a suitable window start. */
8911 if (height
> max_height
)
8913 height
= max_height
;
8914 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8915 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8916 start
= it
.current
.pos
;
8919 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8920 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8922 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8924 /* Let it grow only, until we display an empty message, in which
8925 case the window shrinks again. */
8926 if (height
> WINDOW_TOTAL_LINES (w
))
8928 int old_height
= WINDOW_TOTAL_LINES (w
);
8929 freeze_window_starts (f
, 1);
8930 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8931 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8933 else if (height
< WINDOW_TOTAL_LINES (w
)
8934 && (exact_p
|| BEGV
== ZV
))
8936 int old_height
= WINDOW_TOTAL_LINES (w
);
8937 freeze_window_starts (f
, 0);
8938 shrink_mini_window (w
);
8939 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8944 /* Always resize to exact size needed. */
8945 if (height
> WINDOW_TOTAL_LINES (w
))
8947 int old_height
= WINDOW_TOTAL_LINES (w
);
8948 freeze_window_starts (f
, 1);
8949 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8950 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8952 else if (height
< WINDOW_TOTAL_LINES (w
))
8954 int old_height
= WINDOW_TOTAL_LINES (w
);
8955 freeze_window_starts (f
, 0);
8956 shrink_mini_window (w
);
8960 freeze_window_starts (f
, 1);
8961 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8964 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8968 if (old_current_buffer
)
8969 set_buffer_internal (old_current_buffer
);
8972 return window_height_changed_p
;
8976 /* Value is the current message, a string, or nil if there is no
8980 current_message (void)
8984 if (!BUFFERP (echo_area_buffer
[0]))
8988 with_echo_area_buffer (0, 0, current_message_1
,
8989 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8991 echo_area_buffer
[0] = Qnil
;
8999 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9001 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9004 *msg
= make_buffer_string (BEG
, Z
, 1);
9011 /* Push the current message on Vmessage_stack for later restauration
9012 by restore_message. Value is non-zero if the current message isn't
9013 empty. This is a relatively infrequent operation, so it's not
9014 worth optimizing. */
9020 msg
= current_message ();
9021 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9022 return STRINGP (msg
);
9026 /* Restore message display from the top of Vmessage_stack. */
9029 restore_message (void)
9033 xassert (CONSP (Vmessage_stack
));
9034 msg
= XCAR (Vmessage_stack
);
9036 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9038 message3_nolog (msg
, 0, 0);
9042 /* Handler for record_unwind_protect calling pop_message. */
9045 pop_message_unwind (Lisp_Object dummy
)
9051 /* Pop the top-most entry off Vmessage_stack. */
9056 xassert (CONSP (Vmessage_stack
));
9057 Vmessage_stack
= XCDR (Vmessage_stack
);
9061 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9062 exits. If the stack is not empty, we have a missing pop_message
9066 check_message_stack (void)
9068 if (!NILP (Vmessage_stack
))
9073 /* Truncate to NCHARS what will be displayed in the echo area the next
9074 time we display it---but don't redisplay it now. */
9077 truncate_echo_area (EMACS_INT nchars
)
9080 echo_area_buffer
[0] = Qnil
;
9081 /* A null message buffer means that the frame hasn't really been
9082 initialized yet. Error messages get reported properly by
9083 cmd_error, so this must be just an informative message; toss it. */
9084 else if (!noninteractive
9086 && !NILP (echo_area_buffer
[0]))
9088 struct frame
*sf
= SELECTED_FRAME ();
9089 if (FRAME_MESSAGE_BUF (sf
))
9090 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9095 /* Helper function for truncate_echo_area. Truncate the current
9096 message to at most NCHARS characters. */
9099 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9101 if (BEG
+ nchars
< Z
)
9102 del_range (BEG
+ nchars
, Z
);
9104 echo_area_buffer
[0] = Qnil
;
9109 /* Set the current message to a substring of S or STRING.
9111 If STRING is a Lisp string, set the message to the first NBYTES
9112 bytes from STRING. NBYTES zero means use the whole string. If
9113 STRING is multibyte, the message will be displayed multibyte.
9115 If S is not null, set the message to the first LEN bytes of S. LEN
9116 zero means use the whole string. MULTIBYTE_P non-zero means S is
9117 multibyte. Display the message multibyte in that case.
9119 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9120 to t before calling set_message_1 (which calls insert).
9124 set_message (const char *s
, Lisp_Object string
,
9125 EMACS_INT nbytes
, int multibyte_p
)
9127 message_enable_multibyte
9128 = ((s
&& multibyte_p
)
9129 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9131 with_echo_area_buffer (0, -1, set_message_1
,
9132 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9133 message_buf_print
= 0;
9134 help_echo_showing_p
= 0;
9138 /* Helper function for set_message. Arguments have the same meaning
9139 as there, with A1 corresponding to S and A2 corresponding to STRING
9140 This function is called with the echo area buffer being
9144 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9146 const char *s
= (const char *) a1
;
9147 const unsigned char *msg
= (const unsigned char *) s
;
9148 Lisp_Object string
= a2
;
9150 /* Change multibyteness of the echo buffer appropriately. */
9151 if (message_enable_multibyte
9152 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9153 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9155 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9156 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9157 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9159 /* Insert new message at BEG. */
9160 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9162 if (STRINGP (string
))
9167 nbytes
= SBYTES (string
);
9168 nchars
= string_byte_to_char (string
, nbytes
);
9170 /* This function takes care of single/multibyte conversion. We
9171 just have to ensure that the echo area buffer has the right
9172 setting of enable_multibyte_characters. */
9173 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9178 nbytes
= strlen (s
);
9180 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9182 /* Convert from multi-byte to single-byte. */
9187 /* Convert a multibyte string to single-byte. */
9188 for (i
= 0; i
< nbytes
; i
+= n
)
9190 c
= string_char_and_length (msg
+ i
, &n
);
9191 work
[0] = (ASCII_CHAR_P (c
)
9193 : multibyte_char_to_unibyte (c
));
9194 insert_1_both (work
, 1, 1, 1, 0, 0);
9197 else if (!multibyte_p
9198 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9200 /* Convert from single-byte to multi-byte. */
9203 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9205 /* Convert a single-byte string to multibyte. */
9206 for (i
= 0; i
< nbytes
; i
++)
9209 MAKE_CHAR_MULTIBYTE (c
);
9210 n
= CHAR_STRING (c
, str
);
9211 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9215 insert_1 (s
, nbytes
, 1, 0, 0);
9222 /* Clear messages. CURRENT_P non-zero means clear the current
9223 message. LAST_DISPLAYED_P non-zero means clear the message
9227 clear_message (int current_p
, int last_displayed_p
)
9231 echo_area_buffer
[0] = Qnil
;
9232 message_cleared_p
= 1;
9235 if (last_displayed_p
)
9236 echo_area_buffer
[1] = Qnil
;
9238 message_buf_print
= 0;
9241 /* Clear garbaged frames.
9243 This function is used where the old redisplay called
9244 redraw_garbaged_frames which in turn called redraw_frame which in
9245 turn called clear_frame. The call to clear_frame was a source of
9246 flickering. I believe a clear_frame is not necessary. It should
9247 suffice in the new redisplay to invalidate all current matrices,
9248 and ensure a complete redisplay of all windows. */
9251 clear_garbaged_frames (void)
9255 Lisp_Object tail
, frame
;
9256 int changed_count
= 0;
9258 FOR_EACH_FRAME (tail
, frame
)
9260 struct frame
*f
= XFRAME (frame
);
9262 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9266 Fredraw_frame (frame
);
9267 f
->force_flush_display_p
= 1;
9269 clear_current_matrices (f
);
9278 ++windows_or_buffers_changed
;
9283 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9284 is non-zero update selected_frame. Value is non-zero if the
9285 mini-windows height has been changed. */
9288 echo_area_display (int update_frame_p
)
9290 Lisp_Object mini_window
;
9293 int window_height_changed_p
= 0;
9294 struct frame
*sf
= SELECTED_FRAME ();
9296 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9297 w
= XWINDOW (mini_window
);
9298 f
= XFRAME (WINDOW_FRAME (w
));
9300 /* Don't display if frame is invisible or not yet initialized. */
9301 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9304 #ifdef HAVE_WINDOW_SYSTEM
9305 /* When Emacs starts, selected_frame may be the initial terminal
9306 frame. If we let this through, a message would be displayed on
9308 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9310 #endif /* HAVE_WINDOW_SYSTEM */
9312 /* Redraw garbaged frames. */
9314 clear_garbaged_frames ();
9316 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9318 echo_area_window
= mini_window
;
9319 window_height_changed_p
= display_echo_area (w
);
9320 w
->must_be_updated_p
= 1;
9322 /* Update the display, unless called from redisplay_internal.
9323 Also don't update the screen during redisplay itself. The
9324 update will happen at the end of redisplay, and an update
9325 here could cause confusion. */
9326 if (update_frame_p
&& !redisplaying_p
)
9330 /* If the display update has been interrupted by pending
9331 input, update mode lines in the frame. Due to the
9332 pending input, it might have been that redisplay hasn't
9333 been called, so that mode lines above the echo area are
9334 garbaged. This looks odd, so we prevent it here. */
9335 if (!display_completed
)
9336 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9338 if (window_height_changed_p
9339 /* Don't do this if Emacs is shutting down. Redisplay
9340 needs to run hooks. */
9341 && !NILP (Vrun_hooks
))
9343 /* Must update other windows. Likewise as in other
9344 cases, don't let this update be interrupted by
9346 int count
= SPECPDL_INDEX ();
9347 specbind (Qredisplay_dont_pause
, Qt
);
9348 windows_or_buffers_changed
= 1;
9349 redisplay_internal ();
9350 unbind_to (count
, Qnil
);
9352 else if (FRAME_WINDOW_P (f
) && n
== 0)
9354 /* Window configuration is the same as before.
9355 Can do with a display update of the echo area,
9356 unless we displayed some mode lines. */
9357 update_single_window (w
, 1);
9358 FRAME_RIF (f
)->flush_display (f
);
9361 update_frame (f
, 1, 1);
9363 /* If cursor is in the echo area, make sure that the next
9364 redisplay displays the minibuffer, so that the cursor will
9365 be replaced with what the minibuffer wants. */
9366 if (cursor_in_echo_area
)
9367 ++windows_or_buffers_changed
;
9370 else if (!EQ (mini_window
, selected_window
))
9371 windows_or_buffers_changed
++;
9373 /* Last displayed message is now the current message. */
9374 echo_area_buffer
[1] = echo_area_buffer
[0];
9375 /* Inform read_char that we're not echoing. */
9376 echo_message_buffer
= Qnil
;
9378 /* Prevent redisplay optimization in redisplay_internal by resetting
9379 this_line_start_pos. This is done because the mini-buffer now
9380 displays the message instead of its buffer text. */
9381 if (EQ (mini_window
, selected_window
))
9382 CHARPOS (this_line_start_pos
) = 0;
9384 return window_height_changed_p
;
9389 /***********************************************************************
9390 Mode Lines and Frame Titles
9391 ***********************************************************************/
9393 /* A buffer for constructing non-propertized mode-line strings and
9394 frame titles in it; allocated from the heap in init_xdisp and
9395 resized as needed in store_mode_line_noprop_char. */
9397 static char *mode_line_noprop_buf
;
9399 /* The buffer's end, and a current output position in it. */
9401 static char *mode_line_noprop_buf_end
;
9402 static char *mode_line_noprop_ptr
;
9404 #define MODE_LINE_NOPROP_LEN(start) \
9405 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9408 MODE_LINE_DISPLAY
= 0,
9414 /* Alist that caches the results of :propertize.
9415 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9416 static Lisp_Object mode_line_proptrans_alist
;
9418 /* List of strings making up the mode-line. */
9419 static Lisp_Object mode_line_string_list
;
9421 /* Base face property when building propertized mode line string. */
9422 static Lisp_Object mode_line_string_face
;
9423 static Lisp_Object mode_line_string_face_prop
;
9426 /* Unwind data for mode line strings */
9428 static Lisp_Object Vmode_line_unwind_vector
;
9431 format_mode_line_unwind_data (struct buffer
*obuf
,
9435 Lisp_Object vector
, tmp
;
9437 /* Reduce consing by keeping one vector in
9438 Vwith_echo_area_save_vector. */
9439 vector
= Vmode_line_unwind_vector
;
9440 Vmode_line_unwind_vector
= Qnil
;
9443 vector
= Fmake_vector (make_number (8), Qnil
);
9445 ASET (vector
, 0, make_number (mode_line_target
));
9446 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9447 ASET (vector
, 2, mode_line_string_list
);
9448 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9449 ASET (vector
, 4, mode_line_string_face
);
9450 ASET (vector
, 5, mode_line_string_face_prop
);
9453 XSETBUFFER (tmp
, obuf
);
9456 ASET (vector
, 6, tmp
);
9457 ASET (vector
, 7, owin
);
9463 unwind_format_mode_line (Lisp_Object vector
)
9465 mode_line_target
= XINT (AREF (vector
, 0));
9466 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9467 mode_line_string_list
= AREF (vector
, 2);
9468 if (! EQ (AREF (vector
, 3), Qt
))
9469 mode_line_proptrans_alist
= AREF (vector
, 3);
9470 mode_line_string_face
= AREF (vector
, 4);
9471 mode_line_string_face_prop
= AREF (vector
, 5);
9473 if (!NILP (AREF (vector
, 7)))
9474 /* Select window before buffer, since it may change the buffer. */
9475 Fselect_window (AREF (vector
, 7), Qt
);
9477 if (!NILP (AREF (vector
, 6)))
9479 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9480 ASET (vector
, 6, Qnil
);
9483 Vmode_line_unwind_vector
= vector
;
9488 /* Store a single character C for the frame title in mode_line_noprop_buf.
9489 Re-allocate mode_line_noprop_buf if necessary. */
9492 store_mode_line_noprop_char (char c
)
9494 /* If output position has reached the end of the allocated buffer,
9495 double the buffer's size. */
9496 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9498 int len
= MODE_LINE_NOPROP_LEN (0);
9499 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9500 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9501 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9502 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9505 *mode_line_noprop_ptr
++ = c
;
9509 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9510 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9511 characters that yield more columns than PRECISION; PRECISION <= 0
9512 means copy the whole string. Pad with spaces until FIELD_WIDTH
9513 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9514 pad. Called from display_mode_element when it is used to build a
9518 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9520 const unsigned char *str
= (const unsigned char *) string
;
9522 EMACS_INT dummy
, nbytes
;
9524 /* Copy at most PRECISION chars from STR. */
9525 nbytes
= strlen (string
);
9526 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9528 store_mode_line_noprop_char (*str
++);
9530 /* Fill up with spaces until FIELD_WIDTH reached. */
9531 while (field_width
> 0
9534 store_mode_line_noprop_char (' ');
9541 /***********************************************************************
9543 ***********************************************************************/
9545 #ifdef HAVE_WINDOW_SYSTEM
9547 /* Set the title of FRAME, if it has changed. The title format is
9548 Vicon_title_format if FRAME is iconified, otherwise it is
9549 frame_title_format. */
9552 x_consider_frame_title (Lisp_Object frame
)
9554 struct frame
*f
= XFRAME (frame
);
9556 if (FRAME_WINDOW_P (f
)
9557 || FRAME_MINIBUF_ONLY_P (f
)
9558 || f
->explicit_name
)
9560 /* Do we have more than one visible frame on this X display? */
9567 int count
= SPECPDL_INDEX ();
9569 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9571 Lisp_Object other_frame
= XCAR (tail
);
9572 struct frame
*tf
= XFRAME (other_frame
);
9575 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9576 && !FRAME_MINIBUF_ONLY_P (tf
)
9577 && !EQ (other_frame
, tip_frame
)
9578 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9582 /* Set global variable indicating that multiple frames exist. */
9583 multiple_frames
= CONSP (tail
);
9585 /* Switch to the buffer of selected window of the frame. Set up
9586 mode_line_target so that display_mode_element will output into
9587 mode_line_noprop_buf; then display the title. */
9588 record_unwind_protect (unwind_format_mode_line
,
9589 format_mode_line_unwind_data
9590 (current_buffer
, selected_window
, 0));
9592 Fselect_window (f
->selected_window
, Qt
);
9593 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9594 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9596 mode_line_target
= MODE_LINE_TITLE
;
9597 title_start
= MODE_LINE_NOPROP_LEN (0);
9598 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9599 NULL
, DEFAULT_FACE_ID
);
9600 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9601 len
= MODE_LINE_NOPROP_LEN (title_start
);
9602 title
= mode_line_noprop_buf
+ title_start
;
9603 unbind_to (count
, Qnil
);
9605 /* Set the title only if it's changed. This avoids consing in
9606 the common case where it hasn't. (If it turns out that we've
9607 already wasted too much time by walking through the list with
9608 display_mode_element, then we might need to optimize at a
9609 higher level than this.) */
9610 if (! STRINGP (f
->name
)
9611 || SBYTES (f
->name
) != len
9612 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9613 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9617 #endif /* not HAVE_WINDOW_SYSTEM */
9622 /***********************************************************************
9624 ***********************************************************************/
9627 /* Prepare for redisplay by updating menu-bar item lists when
9628 appropriate. This can call eval. */
9631 prepare_menu_bars (void)
9634 struct gcpro gcpro1
, gcpro2
;
9636 Lisp_Object tooltip_frame
;
9638 #ifdef HAVE_WINDOW_SYSTEM
9639 tooltip_frame
= tip_frame
;
9641 tooltip_frame
= Qnil
;
9644 /* Update all frame titles based on their buffer names, etc. We do
9645 this before the menu bars so that the buffer-menu will show the
9646 up-to-date frame titles. */
9647 #ifdef HAVE_WINDOW_SYSTEM
9648 if (windows_or_buffers_changed
|| update_mode_lines
)
9650 Lisp_Object tail
, frame
;
9652 FOR_EACH_FRAME (tail
, frame
)
9655 if (!EQ (frame
, tooltip_frame
)
9656 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9657 x_consider_frame_title (frame
);
9660 #endif /* HAVE_WINDOW_SYSTEM */
9662 /* Update the menu bar item lists, if appropriate. This has to be
9663 done before any actual redisplay or generation of display lines. */
9664 all_windows
= (update_mode_lines
9665 || buffer_shared
> 1
9666 || windows_or_buffers_changed
);
9669 Lisp_Object tail
, frame
;
9670 int count
= SPECPDL_INDEX ();
9671 /* 1 means that update_menu_bar has run its hooks
9672 so any further calls to update_menu_bar shouldn't do so again. */
9673 int menu_bar_hooks_run
= 0;
9675 record_unwind_save_match_data ();
9677 FOR_EACH_FRAME (tail
, frame
)
9681 /* Ignore tooltip frame. */
9682 if (EQ (frame
, tooltip_frame
))
9685 /* If a window on this frame changed size, report that to
9686 the user and clear the size-change flag. */
9687 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9689 Lisp_Object functions
;
9691 /* Clear flag first in case we get an error below. */
9692 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9693 functions
= Vwindow_size_change_functions
;
9694 GCPRO2 (tail
, functions
);
9696 while (CONSP (functions
))
9698 if (!EQ (XCAR (functions
), Qt
))
9699 call1 (XCAR (functions
), frame
);
9700 functions
= XCDR (functions
);
9706 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9707 #ifdef HAVE_WINDOW_SYSTEM
9708 update_tool_bar (f
, 0);
9711 if (windows_or_buffers_changed
9713 ns_set_doc_edited (f
, Fbuffer_modified_p
9714 (XWINDOW (f
->selected_window
)->buffer
));
9719 unbind_to (count
, Qnil
);
9723 struct frame
*sf
= SELECTED_FRAME ();
9724 update_menu_bar (sf
, 1, 0);
9725 #ifdef HAVE_WINDOW_SYSTEM
9726 update_tool_bar (sf
, 1);
9732 /* Update the menu bar item list for frame F. This has to be done
9733 before we start to fill in any display lines, because it can call
9736 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9738 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9739 already ran the menu bar hooks for this redisplay, so there
9740 is no need to run them again. The return value is the
9741 updated value of this flag, to pass to the next call. */
9744 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9747 register struct window
*w
;
9749 /* If called recursively during a menu update, do nothing. This can
9750 happen when, for instance, an activate-menubar-hook causes a
9752 if (inhibit_menubar_update
)
9755 window
= FRAME_SELECTED_WINDOW (f
);
9756 w
= XWINDOW (window
);
9758 if (FRAME_WINDOW_P (f
)
9760 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9761 || defined (HAVE_NS) || defined (USE_GTK)
9762 FRAME_EXTERNAL_MENU_BAR (f
)
9764 FRAME_MENU_BAR_LINES (f
) > 0
9766 : FRAME_MENU_BAR_LINES (f
) > 0)
9768 /* If the user has switched buffers or windows, we need to
9769 recompute to reflect the new bindings. But we'll
9770 recompute when update_mode_lines is set too; that means
9771 that people can use force-mode-line-update to request
9772 that the menu bar be recomputed. The adverse effect on
9773 the rest of the redisplay algorithm is about the same as
9774 windows_or_buffers_changed anyway. */
9775 if (windows_or_buffers_changed
9776 /* This used to test w->update_mode_line, but we believe
9777 there is no need to recompute the menu in that case. */
9778 || update_mode_lines
9779 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9780 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9781 != !NILP (w
->last_had_star
))
9782 || ((!NILP (Vtransient_mark_mode
)
9783 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9784 != !NILP (w
->region_showing
)))
9786 struct buffer
*prev
= current_buffer
;
9787 int count
= SPECPDL_INDEX ();
9789 specbind (Qinhibit_menubar_update
, Qt
);
9791 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9792 if (save_match_data
)
9793 record_unwind_save_match_data ();
9794 if (NILP (Voverriding_local_map_menu_flag
))
9796 specbind (Qoverriding_terminal_local_map
, Qnil
);
9797 specbind (Qoverriding_local_map
, Qnil
);
9802 /* Run the Lucid hook. */
9803 safe_run_hooks (Qactivate_menubar_hook
);
9805 /* If it has changed current-menubar from previous value,
9806 really recompute the menu-bar from the value. */
9807 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9808 call0 (Qrecompute_lucid_menubar
);
9810 safe_run_hooks (Qmenu_bar_update_hook
);
9815 XSETFRAME (Vmenu_updating_frame
, f
);
9816 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9818 /* Redisplay the menu bar in case we changed it. */
9819 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9820 || defined (HAVE_NS) || defined (USE_GTK)
9821 if (FRAME_WINDOW_P (f
))
9823 #if defined (HAVE_NS)
9824 /* All frames on Mac OS share the same menubar. So only
9825 the selected frame should be allowed to set it. */
9826 if (f
== SELECTED_FRAME ())
9828 set_frame_menubar (f
, 0, 0);
9831 /* On a terminal screen, the menu bar is an ordinary screen
9832 line, and this makes it get updated. */
9833 w
->update_mode_line
= Qt
;
9834 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9835 /* In the non-toolkit version, the menu bar is an ordinary screen
9836 line, and this makes it get updated. */
9837 w
->update_mode_line
= Qt
;
9838 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9840 unbind_to (count
, Qnil
);
9841 set_buffer_internal_1 (prev
);
9850 /***********************************************************************
9852 ***********************************************************************/
9854 #ifdef HAVE_WINDOW_SYSTEM
9857 Nominal cursor position -- where to draw output.
9858 HPOS and VPOS are window relative glyph matrix coordinates.
9859 X and Y are window relative pixel coordinates. */
9861 struct cursor_pos output_cursor
;
9865 Set the global variable output_cursor to CURSOR. All cursor
9866 positions are relative to updated_window. */
9869 set_output_cursor (struct cursor_pos
*cursor
)
9871 output_cursor
.hpos
= cursor
->hpos
;
9872 output_cursor
.vpos
= cursor
->vpos
;
9873 output_cursor
.x
= cursor
->x
;
9874 output_cursor
.y
= cursor
->y
;
9879 Set a nominal cursor position.
9881 HPOS and VPOS are column/row positions in a window glyph matrix. X
9882 and Y are window text area relative pixel positions.
9884 If this is done during an update, updated_window will contain the
9885 window that is being updated and the position is the future output
9886 cursor position for that window. If updated_window is null, use
9887 selected_window and display the cursor at the given position. */
9890 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9894 /* If updated_window is not set, work on selected_window. */
9898 w
= XWINDOW (selected_window
);
9900 /* Set the output cursor. */
9901 output_cursor
.hpos
= hpos
;
9902 output_cursor
.vpos
= vpos
;
9903 output_cursor
.x
= x
;
9904 output_cursor
.y
= y
;
9906 /* If not called as part of an update, really display the cursor.
9907 This will also set the cursor position of W. */
9908 if (updated_window
== NULL
)
9911 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9912 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9913 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9918 #endif /* HAVE_WINDOW_SYSTEM */
9921 /***********************************************************************
9923 ***********************************************************************/
9925 #ifdef HAVE_WINDOW_SYSTEM
9927 /* Where the mouse was last time we reported a mouse event. */
9929 FRAME_PTR last_mouse_frame
;
9931 /* Tool-bar item index of the item on which a mouse button was pressed
9934 int last_tool_bar_item
;
9938 update_tool_bar_unwind (Lisp_Object frame
)
9940 selected_frame
= frame
;
9944 /* Update the tool-bar item list for frame F. This has to be done
9945 before we start to fill in any display lines. Called from
9946 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9947 and restore it here. */
9950 update_tool_bar (struct frame
*f
, int save_match_data
)
9952 #if defined (USE_GTK) || defined (HAVE_NS)
9953 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9955 int do_update
= WINDOWP (f
->tool_bar_window
)
9956 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9964 window
= FRAME_SELECTED_WINDOW (f
);
9965 w
= XWINDOW (window
);
9967 /* If the user has switched buffers or windows, we need to
9968 recompute to reflect the new bindings. But we'll
9969 recompute when update_mode_lines is set too; that means
9970 that people can use force-mode-line-update to request
9971 that the menu bar be recomputed. The adverse effect on
9972 the rest of the redisplay algorithm is about the same as
9973 windows_or_buffers_changed anyway. */
9974 if (windows_or_buffers_changed
9975 || !NILP (w
->update_mode_line
)
9976 || update_mode_lines
9977 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9978 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9979 != !NILP (w
->last_had_star
))
9980 || ((!NILP (Vtransient_mark_mode
)
9981 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9982 != !NILP (w
->region_showing
)))
9984 struct buffer
*prev
= current_buffer
;
9985 int count
= SPECPDL_INDEX ();
9986 Lisp_Object frame
, new_tool_bar
;
9988 struct gcpro gcpro1
;
9990 /* Set current_buffer to the buffer of the selected
9991 window of the frame, so that we get the right local
9993 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9995 /* Save match data, if we must. */
9996 if (save_match_data
)
9997 record_unwind_save_match_data ();
9999 /* Make sure that we don't accidentally use bogus keymaps. */
10000 if (NILP (Voverriding_local_map_menu_flag
))
10002 specbind (Qoverriding_terminal_local_map
, Qnil
);
10003 specbind (Qoverriding_local_map
, Qnil
);
10006 GCPRO1 (new_tool_bar
);
10008 /* We must temporarily set the selected frame to this frame
10009 before calling tool_bar_items, because the calculation of
10010 the tool-bar keymap uses the selected frame (see
10011 `tool-bar-make-keymap' in tool-bar.el). */
10012 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10013 XSETFRAME (frame
, f
);
10014 selected_frame
= frame
;
10016 /* Build desired tool-bar items from keymaps. */
10017 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10020 /* Redisplay the tool-bar if we changed it. */
10021 if (new_n_tool_bar
!= f
->n_tool_bar_items
10022 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10024 /* Redisplay that happens asynchronously due to an expose event
10025 may access f->tool_bar_items. Make sure we update both
10026 variables within BLOCK_INPUT so no such event interrupts. */
10028 f
->tool_bar_items
= new_tool_bar
;
10029 f
->n_tool_bar_items
= new_n_tool_bar
;
10030 w
->update_mode_line
= Qt
;
10036 unbind_to (count
, Qnil
);
10037 set_buffer_internal_1 (prev
);
10043 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10044 F's desired tool-bar contents. F->tool_bar_items must have
10045 been set up previously by calling prepare_menu_bars. */
10048 build_desired_tool_bar_string (struct frame
*f
)
10050 int i
, size
, size_needed
;
10051 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10052 Lisp_Object image
, plist
, props
;
10054 image
= plist
= props
= Qnil
;
10055 GCPRO3 (image
, plist
, props
);
10057 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10058 Otherwise, make a new string. */
10060 /* The size of the string we might be able to reuse. */
10061 size
= (STRINGP (f
->desired_tool_bar_string
)
10062 ? SCHARS (f
->desired_tool_bar_string
)
10065 /* We need one space in the string for each image. */
10066 size_needed
= f
->n_tool_bar_items
;
10068 /* Reuse f->desired_tool_bar_string, if possible. */
10069 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10070 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10071 make_number (' '));
10074 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10075 Fremove_text_properties (make_number (0), make_number (size
),
10076 props
, f
->desired_tool_bar_string
);
10079 /* Put a `display' property on the string for the images to display,
10080 put a `menu_item' property on tool-bar items with a value that
10081 is the index of the item in F's tool-bar item vector. */
10082 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10084 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10086 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10087 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10088 int hmargin
, vmargin
, relief
, idx
, end
;
10090 /* If image is a vector, choose the image according to the
10092 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10093 if (VECTORP (image
))
10097 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10098 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10101 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10102 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10104 xassert (ASIZE (image
) >= idx
);
10105 image
= AREF (image
, idx
);
10110 /* Ignore invalid image specifications. */
10111 if (!valid_image_p (image
))
10114 /* Display the tool-bar button pressed, or depressed. */
10115 plist
= Fcopy_sequence (XCDR (image
));
10117 /* Compute margin and relief to draw. */
10118 relief
= (tool_bar_button_relief
>= 0
10119 ? tool_bar_button_relief
10120 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10121 hmargin
= vmargin
= relief
;
10123 if (INTEGERP (Vtool_bar_button_margin
)
10124 && XINT (Vtool_bar_button_margin
) > 0)
10126 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10127 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10129 else if (CONSP (Vtool_bar_button_margin
))
10131 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10132 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10133 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10135 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10136 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10137 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10140 if (auto_raise_tool_bar_buttons_p
)
10142 /* Add a `:relief' property to the image spec if the item is
10146 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10153 /* If image is selected, display it pressed, i.e. with a
10154 negative relief. If it's not selected, display it with a
10156 plist
= Fplist_put (plist
, QCrelief
,
10158 ? make_number (-relief
)
10159 : make_number (relief
)));
10164 /* Put a margin around the image. */
10165 if (hmargin
|| vmargin
)
10167 if (hmargin
== vmargin
)
10168 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10170 plist
= Fplist_put (plist
, QCmargin
,
10171 Fcons (make_number (hmargin
),
10172 make_number (vmargin
)));
10175 /* If button is not enabled, and we don't have special images
10176 for the disabled state, make the image appear disabled by
10177 applying an appropriate algorithm to it. */
10178 if (!enabled_p
&& idx
< 0)
10179 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10181 /* Put a `display' text property on the string for the image to
10182 display. Put a `menu-item' property on the string that gives
10183 the start of this item's properties in the tool-bar items
10185 image
= Fcons (Qimage
, plist
);
10186 props
= list4 (Qdisplay
, image
,
10187 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10189 /* Let the last image hide all remaining spaces in the tool bar
10190 string. The string can be longer than needed when we reuse a
10191 previous string. */
10192 if (i
+ 1 == f
->n_tool_bar_items
)
10193 end
= SCHARS (f
->desired_tool_bar_string
);
10196 Fadd_text_properties (make_number (i
), make_number (end
),
10197 props
, f
->desired_tool_bar_string
);
10205 /* Display one line of the tool-bar of frame IT->f.
10207 HEIGHT specifies the desired height of the tool-bar line.
10208 If the actual height of the glyph row is less than HEIGHT, the
10209 row's height is increased to HEIGHT, and the icons are centered
10210 vertically in the new height.
10212 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10213 count a final empty row in case the tool-bar width exactly matches
10218 display_tool_bar_line (struct it
*it
, int height
)
10220 struct glyph_row
*row
= it
->glyph_row
;
10221 int max_x
= it
->last_visible_x
;
10222 struct glyph
*last
;
10224 prepare_desired_row (row
);
10225 row
->y
= it
->current_y
;
10227 /* Note that this isn't made use of if the face hasn't a box,
10228 so there's no need to check the face here. */
10229 it
->start_of_box_run_p
= 1;
10231 while (it
->current_x
< max_x
)
10233 int x
, n_glyphs_before
, i
, nglyphs
;
10234 struct it it_before
;
10236 /* Get the next display element. */
10237 if (!get_next_display_element (it
))
10239 /* Don't count empty row if we are counting needed tool-bar lines. */
10240 if (height
< 0 && !it
->hpos
)
10245 /* Produce glyphs. */
10246 n_glyphs_before
= row
->used
[TEXT_AREA
];
10249 PRODUCE_GLYPHS (it
);
10251 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10253 x
= it_before
.current_x
;
10254 while (i
< nglyphs
)
10256 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10258 if (x
+ glyph
->pixel_width
> max_x
)
10260 /* Glyph doesn't fit on line. Backtrack. */
10261 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10263 /* If this is the only glyph on this line, it will never fit on the
10264 tool-bar, so skip it. But ensure there is at least one glyph,
10265 so we don't accidentally disable the tool-bar. */
10266 if (n_glyphs_before
== 0
10267 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10273 x
+= glyph
->pixel_width
;
10277 /* Stop at line ends. */
10278 if (ITERATOR_AT_END_OF_LINE_P (it
))
10281 set_iterator_to_next (it
, 1);
10286 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10288 /* Use default face for the border below the tool bar.
10290 FIXME: When auto-resize-tool-bars is grow-only, there is
10291 no additional border below the possibly empty tool-bar lines.
10292 So to make the extra empty lines look "normal", we have to
10293 use the tool-bar face for the border too. */
10294 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10295 it
->face_id
= DEFAULT_FACE_ID
;
10297 extend_face_to_end_of_line (it
);
10298 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10299 last
->right_box_line_p
= 1;
10300 if (last
== row
->glyphs
[TEXT_AREA
])
10301 last
->left_box_line_p
= 1;
10303 /* Make line the desired height and center it vertically. */
10304 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10306 /* Don't add more than one line height. */
10307 height
%= FRAME_LINE_HEIGHT (it
->f
);
10308 it
->max_ascent
+= height
/ 2;
10309 it
->max_descent
+= (height
+ 1) / 2;
10312 compute_line_metrics (it
);
10314 /* If line is empty, make it occupy the rest of the tool-bar. */
10315 if (!row
->displays_text_p
)
10317 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10318 row
->visible_height
= row
->height
;
10319 row
->ascent
= row
->phys_ascent
= 0;
10320 row
->extra_line_spacing
= 0;
10323 row
->full_width_p
= 1;
10324 row
->continued_p
= 0;
10325 row
->truncated_on_left_p
= 0;
10326 row
->truncated_on_right_p
= 0;
10328 it
->current_x
= it
->hpos
= 0;
10329 it
->current_y
+= row
->height
;
10335 /* Max tool-bar height. */
10337 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10338 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10340 /* Value is the number of screen lines needed to make all tool-bar
10341 items of frame F visible. The number of actual rows needed is
10342 returned in *N_ROWS if non-NULL. */
10345 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10347 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10349 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10350 the desired matrix, so use (unused) mode-line row as temporary row to
10351 avoid destroying the first tool-bar row. */
10352 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10354 /* Initialize an iterator for iteration over
10355 F->desired_tool_bar_string in the tool-bar window of frame F. */
10356 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10357 it
.first_visible_x
= 0;
10358 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10359 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10361 while (!ITERATOR_AT_END_P (&it
))
10363 clear_glyph_row (temp_row
);
10364 it
.glyph_row
= temp_row
;
10365 display_tool_bar_line (&it
, -1);
10367 clear_glyph_row (temp_row
);
10369 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10371 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10373 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10377 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10379 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10380 (Lisp_Object frame
)
10387 frame
= selected_frame
;
10389 CHECK_FRAME (frame
);
10390 f
= XFRAME (frame
);
10392 if (WINDOWP (f
->tool_bar_window
)
10393 || (w
= XWINDOW (f
->tool_bar_window
),
10394 WINDOW_TOTAL_LINES (w
) > 0))
10396 update_tool_bar (f
, 1);
10397 if (f
->n_tool_bar_items
)
10399 build_desired_tool_bar_string (f
);
10400 nlines
= tool_bar_lines_needed (f
, NULL
);
10404 return make_number (nlines
);
10408 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10409 height should be changed. */
10412 redisplay_tool_bar (struct frame
*f
)
10416 struct glyph_row
*row
;
10418 #if defined (USE_GTK) || defined (HAVE_NS)
10419 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10420 update_frame_tool_bar (f
);
10424 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10425 do anything. This means you must start with tool-bar-lines
10426 non-zero to get the auto-sizing effect. Or in other words, you
10427 can turn off tool-bars by specifying tool-bar-lines zero. */
10428 if (!WINDOWP (f
->tool_bar_window
)
10429 || (w
= XWINDOW (f
->tool_bar_window
),
10430 WINDOW_TOTAL_LINES (w
) == 0))
10433 /* Set up an iterator for the tool-bar window. */
10434 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10435 it
.first_visible_x
= 0;
10436 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10437 row
= it
.glyph_row
;
10439 /* Build a string that represents the contents of the tool-bar. */
10440 build_desired_tool_bar_string (f
);
10441 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10443 if (f
->n_tool_bar_rows
== 0)
10447 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10448 nlines
!= WINDOW_TOTAL_LINES (w
)))
10451 int old_height
= WINDOW_TOTAL_LINES (w
);
10453 XSETFRAME (frame
, f
);
10454 Fmodify_frame_parameters (frame
,
10455 Fcons (Fcons (Qtool_bar_lines
,
10456 make_number (nlines
)),
10458 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10460 clear_glyph_matrix (w
->desired_matrix
);
10461 fonts_changed_p
= 1;
10467 /* Display as many lines as needed to display all tool-bar items. */
10469 if (f
->n_tool_bar_rows
> 0)
10471 int border
, rows
, height
, extra
;
10473 if (INTEGERP (Vtool_bar_border
))
10474 border
= XINT (Vtool_bar_border
);
10475 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10476 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10477 else if (EQ (Vtool_bar_border
, Qborder_width
))
10478 border
= f
->border_width
;
10484 rows
= f
->n_tool_bar_rows
;
10485 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10486 extra
= it
.last_visible_y
- border
- height
* rows
;
10488 while (it
.current_y
< it
.last_visible_y
)
10491 if (extra
> 0 && rows
-- > 0)
10493 h
= (extra
+ rows
- 1) / rows
;
10496 display_tool_bar_line (&it
, height
+ h
);
10501 while (it
.current_y
< it
.last_visible_y
)
10502 display_tool_bar_line (&it
, 0);
10505 /* It doesn't make much sense to try scrolling in the tool-bar
10506 window, so don't do it. */
10507 w
->desired_matrix
->no_scrolling_p
= 1;
10508 w
->must_be_updated_p
= 1;
10510 if (!NILP (Vauto_resize_tool_bars
))
10512 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10513 int change_height_p
= 0;
10515 /* If we couldn't display everything, change the tool-bar's
10516 height if there is room for more. */
10517 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10518 && it
.current_y
< max_tool_bar_height
)
10519 change_height_p
= 1;
10521 row
= it
.glyph_row
- 1;
10523 /* If there are blank lines at the end, except for a partially
10524 visible blank line at the end that is smaller than
10525 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10526 if (!row
->displays_text_p
10527 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10528 change_height_p
= 1;
10530 /* If row displays tool-bar items, but is partially visible,
10531 change the tool-bar's height. */
10532 if (row
->displays_text_p
10533 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10534 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10535 change_height_p
= 1;
10537 /* Resize windows as needed by changing the `tool-bar-lines'
10538 frame parameter. */
10539 if (change_height_p
)
10542 int old_height
= WINDOW_TOTAL_LINES (w
);
10544 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10546 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10547 && !f
->minimize_tool_bar_window_p
)
10548 ? (nlines
> old_height
)
10549 : (nlines
!= old_height
));
10550 f
->minimize_tool_bar_window_p
= 0;
10552 if (change_height_p
)
10554 XSETFRAME (frame
, f
);
10555 Fmodify_frame_parameters (frame
,
10556 Fcons (Fcons (Qtool_bar_lines
,
10557 make_number (nlines
)),
10559 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10561 clear_glyph_matrix (w
->desired_matrix
);
10562 f
->n_tool_bar_rows
= nrows
;
10563 fonts_changed_p
= 1;
10570 f
->minimize_tool_bar_window_p
= 0;
10575 /* Get information about the tool-bar item which is displayed in GLYPH
10576 on frame F. Return in *PROP_IDX the index where tool-bar item
10577 properties start in F->tool_bar_items. Value is zero if
10578 GLYPH doesn't display a tool-bar item. */
10581 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10587 /* This function can be called asynchronously, which means we must
10588 exclude any possibility that Fget_text_property signals an
10590 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10591 charpos
= max (0, charpos
);
10593 /* Get the text property `menu-item' at pos. The value of that
10594 property is the start index of this item's properties in
10595 F->tool_bar_items. */
10596 prop
= Fget_text_property (make_number (charpos
),
10597 Qmenu_item
, f
->current_tool_bar_string
);
10598 if (INTEGERP (prop
))
10600 *prop_idx
= XINT (prop
);
10610 /* Get information about the tool-bar item at position X/Y on frame F.
10611 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10612 the current matrix of the tool-bar window of F, or NULL if not
10613 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10614 item in F->tool_bar_items. Value is
10616 -1 if X/Y is not on a tool-bar item
10617 0 if X/Y is on the same item that was highlighted before.
10621 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10622 int *hpos
, int *vpos
, int *prop_idx
)
10624 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10625 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10628 /* Find the glyph under X/Y. */
10629 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10630 if (*glyph
== NULL
)
10633 /* Get the start of this tool-bar item's properties in
10634 f->tool_bar_items. */
10635 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10638 /* Is mouse on the highlighted item? */
10639 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10640 && *vpos
>= hlinfo
->mouse_face_beg_row
10641 && *vpos
<= hlinfo
->mouse_face_end_row
10642 && (*vpos
> hlinfo
->mouse_face_beg_row
10643 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10644 && (*vpos
< hlinfo
->mouse_face_end_row
10645 || *hpos
< hlinfo
->mouse_face_end_col
10646 || hlinfo
->mouse_face_past_end
))
10654 Handle mouse button event on the tool-bar of frame F, at
10655 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10656 0 for button release. MODIFIERS is event modifiers for button
10660 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10661 unsigned int modifiers
)
10663 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10664 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10665 int hpos
, vpos
, prop_idx
;
10666 struct glyph
*glyph
;
10667 Lisp_Object enabled_p
;
10669 /* If not on the highlighted tool-bar item, return. */
10670 frame_to_window_pixel_xy (w
, &x
, &y
);
10671 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10674 /* If item is disabled, do nothing. */
10675 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10676 if (NILP (enabled_p
))
10681 /* Show item in pressed state. */
10682 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10683 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10684 last_tool_bar_item
= prop_idx
;
10688 Lisp_Object key
, frame
;
10689 struct input_event event
;
10690 EVENT_INIT (event
);
10692 /* Show item in released state. */
10693 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10694 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10696 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10698 XSETFRAME (frame
, f
);
10699 event
.kind
= TOOL_BAR_EVENT
;
10700 event
.frame_or_window
= frame
;
10702 kbd_buffer_store_event (&event
);
10704 event
.kind
= TOOL_BAR_EVENT
;
10705 event
.frame_or_window
= frame
;
10707 event
.modifiers
= modifiers
;
10708 kbd_buffer_store_event (&event
);
10709 last_tool_bar_item
= -1;
10714 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10715 tool-bar window-relative coordinates X/Y. Called from
10716 note_mouse_highlight. */
10719 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10721 Lisp_Object window
= f
->tool_bar_window
;
10722 struct window
*w
= XWINDOW (window
);
10723 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10724 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10726 struct glyph
*glyph
;
10727 struct glyph_row
*row
;
10729 Lisp_Object enabled_p
;
10731 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10732 int mouse_down_p
, rc
;
10734 /* Function note_mouse_highlight is called with negative X/Y
10735 values when mouse moves outside of the frame. */
10736 if (x
<= 0 || y
<= 0)
10738 clear_mouse_face (hlinfo
);
10742 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10745 /* Not on tool-bar item. */
10746 clear_mouse_face (hlinfo
);
10750 /* On same tool-bar item as before. */
10751 goto set_help_echo
;
10753 clear_mouse_face (hlinfo
);
10755 /* Mouse is down, but on different tool-bar item? */
10756 mouse_down_p
= (dpyinfo
->grabbed
10757 && f
== last_mouse_frame
10758 && FRAME_LIVE_P (f
));
10760 && last_tool_bar_item
!= prop_idx
)
10763 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10764 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10766 /* If tool-bar item is not enabled, don't highlight it. */
10767 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10768 if (!NILP (enabled_p
))
10770 /* Compute the x-position of the glyph. In front and past the
10771 image is a space. We include this in the highlighted area. */
10772 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10773 for (i
= x
= 0; i
< hpos
; ++i
)
10774 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10776 /* Record this as the current active region. */
10777 hlinfo
->mouse_face_beg_col
= hpos
;
10778 hlinfo
->mouse_face_beg_row
= vpos
;
10779 hlinfo
->mouse_face_beg_x
= x
;
10780 hlinfo
->mouse_face_beg_y
= row
->y
;
10781 hlinfo
->mouse_face_past_end
= 0;
10783 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10784 hlinfo
->mouse_face_end_row
= vpos
;
10785 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10786 hlinfo
->mouse_face_end_y
= row
->y
;
10787 hlinfo
->mouse_face_window
= window
;
10788 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10790 /* Display it as active. */
10791 show_mouse_face (hlinfo
, draw
);
10792 hlinfo
->mouse_face_image_state
= draw
;
10797 /* Set help_echo_string to a help string to display for this tool-bar item.
10798 XTread_socket does the rest. */
10799 help_echo_object
= help_echo_window
= Qnil
;
10800 help_echo_pos
= -1;
10801 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10802 if (NILP (help_echo_string
))
10803 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10806 #endif /* HAVE_WINDOW_SYSTEM */
10810 /************************************************************************
10811 Horizontal scrolling
10812 ************************************************************************/
10814 static int hscroll_window_tree (Lisp_Object
);
10815 static int hscroll_windows (Lisp_Object
);
10817 /* For all leaf windows in the window tree rooted at WINDOW, set their
10818 hscroll value so that PT is (i) visible in the window, and (ii) so
10819 that it is not within a certain margin at the window's left and
10820 right border. Value is non-zero if any window's hscroll has been
10824 hscroll_window_tree (Lisp_Object window
)
10826 int hscrolled_p
= 0;
10827 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10828 int hscroll_step_abs
= 0;
10829 double hscroll_step_rel
= 0;
10831 if (hscroll_relative_p
)
10833 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10834 if (hscroll_step_rel
< 0)
10836 hscroll_relative_p
= 0;
10837 hscroll_step_abs
= 0;
10840 else if (INTEGERP (Vhscroll_step
))
10842 hscroll_step_abs
= XINT (Vhscroll_step
);
10843 if (hscroll_step_abs
< 0)
10844 hscroll_step_abs
= 0;
10847 hscroll_step_abs
= 0;
10849 while (WINDOWP (window
))
10851 struct window
*w
= XWINDOW (window
);
10853 if (WINDOWP (w
->hchild
))
10854 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10855 else if (WINDOWP (w
->vchild
))
10856 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10857 else if (w
->cursor
.vpos
>= 0)
10860 int text_area_width
;
10861 struct glyph_row
*current_cursor_row
10862 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10863 struct glyph_row
*desired_cursor_row
10864 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10865 struct glyph_row
*cursor_row
10866 = (desired_cursor_row
->enabled_p
10867 ? desired_cursor_row
10868 : current_cursor_row
);
10870 text_area_width
= window_box_width (w
, TEXT_AREA
);
10872 /* Scroll when cursor is inside this scroll margin. */
10873 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10875 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10876 && ((XFASTINT (w
->hscroll
)
10877 && w
->cursor
.x
<= h_margin
)
10878 || (cursor_row
->enabled_p
10879 && cursor_row
->truncated_on_right_p
10880 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10884 struct buffer
*saved_current_buffer
;
10888 /* Find point in a display of infinite width. */
10889 saved_current_buffer
= current_buffer
;
10890 current_buffer
= XBUFFER (w
->buffer
);
10892 if (w
== XWINDOW (selected_window
))
10896 pt
= marker_position (w
->pointm
);
10897 pt
= max (BEGV
, pt
);
10901 /* Move iterator to pt starting at cursor_row->start in
10902 a line with infinite width. */
10903 init_to_row_start (&it
, w
, cursor_row
);
10904 it
.last_visible_x
= INFINITY
;
10905 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10906 current_buffer
= saved_current_buffer
;
10908 /* Position cursor in window. */
10909 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10910 hscroll
= max (0, (it
.current_x
10911 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10912 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10913 : (text_area_width
/ 2))))
10914 / FRAME_COLUMN_WIDTH (it
.f
);
10915 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10917 if (hscroll_relative_p
)
10918 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10921 wanted_x
= text_area_width
10922 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10925 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10929 if (hscroll_relative_p
)
10930 wanted_x
= text_area_width
* hscroll_step_rel
10933 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10936 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10938 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10940 /* Don't call Fset_window_hscroll if value hasn't
10941 changed because it will prevent redisplay
10943 if (XFASTINT (w
->hscroll
) != hscroll
)
10945 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10946 w
->hscroll
= make_number (hscroll
);
10955 /* Value is non-zero if hscroll of any leaf window has been changed. */
10956 return hscrolled_p
;
10960 /* Set hscroll so that cursor is visible and not inside horizontal
10961 scroll margins for all windows in the tree rooted at WINDOW. See
10962 also hscroll_window_tree above. Value is non-zero if any window's
10963 hscroll has been changed. If it has, desired matrices on the frame
10964 of WINDOW are cleared. */
10967 hscroll_windows (Lisp_Object window
)
10969 int hscrolled_p
= hscroll_window_tree (window
);
10971 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10972 return hscrolled_p
;
10977 /************************************************************************
10979 ************************************************************************/
10981 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10982 to a non-zero value. This is sometimes handy to have in a debugger
10987 /* First and last unchanged row for try_window_id. */
10989 int debug_first_unchanged_at_end_vpos
;
10990 int debug_last_unchanged_at_beg_vpos
;
10992 /* Delta vpos and y. */
10994 int debug_dvpos
, debug_dy
;
10996 /* Delta in characters and bytes for try_window_id. */
10998 EMACS_INT debug_delta
, debug_delta_bytes
;
11000 /* Values of window_end_pos and window_end_vpos at the end of
11003 EMACS_INT debug_end_vpos
;
11005 /* Append a string to W->desired_matrix->method. FMT is a printf
11006 format string. A1...A9 are a supplement for a variable-length
11007 argument list. If trace_redisplay_p is non-zero also printf the
11008 resulting string to stderr. */
11011 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11014 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11017 char *method
= w
->desired_matrix
->method
;
11018 int len
= strlen (method
);
11019 int size
= sizeof w
->desired_matrix
->method
;
11020 int remaining
= size
- len
- 1;
11022 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11023 if (len
&& remaining
)
11026 --remaining
, ++len
;
11029 strncpy (method
+ len
, buffer
, remaining
);
11031 if (trace_redisplay_p
)
11032 fprintf (stderr
, "%p (%s): %s\n",
11034 ((BUFFERP (w
->buffer
)
11035 && STRINGP (XBUFFER (w
->buffer
)->name
))
11036 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11041 #endif /* GLYPH_DEBUG */
11044 /* Value is non-zero if all changes in window W, which displays
11045 current_buffer, are in the text between START and END. START is a
11046 buffer position, END is given as a distance from Z. Used in
11047 redisplay_internal for display optimization. */
11050 text_outside_line_unchanged_p (struct window
*w
,
11051 EMACS_INT start
, EMACS_INT end
)
11053 int unchanged_p
= 1;
11055 /* If text or overlays have changed, see where. */
11056 if (XFASTINT (w
->last_modified
) < MODIFF
11057 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11059 /* Gap in the line? */
11060 if (GPT
< start
|| Z
- GPT
< end
)
11063 /* Changes start in front of the line, or end after it? */
11065 && (BEG_UNCHANGED
< start
- 1
11066 || END_UNCHANGED
< end
))
11069 /* If selective display, can't optimize if changes start at the
11070 beginning of the line. */
11072 && INTEGERP (BVAR (current_buffer
, selective_display
))
11073 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11074 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11077 /* If there are overlays at the start or end of the line, these
11078 may have overlay strings with newlines in them. A change at
11079 START, for instance, may actually concern the display of such
11080 overlay strings as well, and they are displayed on different
11081 lines. So, quickly rule out this case. (For the future, it
11082 might be desirable to implement something more telling than
11083 just BEG/END_UNCHANGED.) */
11086 if (BEG
+ BEG_UNCHANGED
== start
11087 && overlay_touches_p (start
))
11089 if (END_UNCHANGED
== end
11090 && overlay_touches_p (Z
- end
))
11094 /* Under bidi reordering, adding or deleting a character in the
11095 beginning of a paragraph, before the first strong directional
11096 character, can change the base direction of the paragraph (unless
11097 the buffer specifies a fixed paragraph direction), which will
11098 require to redisplay the whole paragraph. It might be worthwhile
11099 to find the paragraph limits and widen the range of redisplayed
11100 lines to that, but for now just give up this optimization. */
11101 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11102 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11106 return unchanged_p
;
11110 /* Do a frame update, taking possible shortcuts into account. This is
11111 the main external entry point for redisplay.
11113 If the last redisplay displayed an echo area message and that message
11114 is no longer requested, we clear the echo area or bring back the
11115 mini-buffer if that is in use. */
11120 redisplay_internal ();
11125 overlay_arrow_string_or_property (Lisp_Object var
)
11129 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11132 return Voverlay_arrow_string
;
11135 /* Return 1 if there are any overlay-arrows in current_buffer. */
11137 overlay_arrow_in_current_buffer_p (void)
11141 for (vlist
= Voverlay_arrow_variable_list
;
11143 vlist
= XCDR (vlist
))
11145 Lisp_Object var
= XCAR (vlist
);
11148 if (!SYMBOLP (var
))
11150 val
= find_symbol_value (var
);
11152 && current_buffer
== XMARKER (val
)->buffer
)
11159 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11163 overlay_arrows_changed_p (void)
11167 for (vlist
= Voverlay_arrow_variable_list
;
11169 vlist
= XCDR (vlist
))
11171 Lisp_Object var
= XCAR (vlist
);
11172 Lisp_Object val
, pstr
;
11174 if (!SYMBOLP (var
))
11176 val
= find_symbol_value (var
);
11177 if (!MARKERP (val
))
11179 if (! EQ (COERCE_MARKER (val
),
11180 Fget (var
, Qlast_arrow_position
))
11181 || ! (pstr
= overlay_arrow_string_or_property (var
),
11182 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11188 /* Mark overlay arrows to be updated on next redisplay. */
11191 update_overlay_arrows (int up_to_date
)
11195 for (vlist
= Voverlay_arrow_variable_list
;
11197 vlist
= XCDR (vlist
))
11199 Lisp_Object var
= XCAR (vlist
);
11201 if (!SYMBOLP (var
))
11204 if (up_to_date
> 0)
11206 Lisp_Object val
= find_symbol_value (var
);
11207 Fput (var
, Qlast_arrow_position
,
11208 COERCE_MARKER (val
));
11209 Fput (var
, Qlast_arrow_string
,
11210 overlay_arrow_string_or_property (var
));
11212 else if (up_to_date
< 0
11213 || !NILP (Fget (var
, Qlast_arrow_position
)))
11215 Fput (var
, Qlast_arrow_position
, Qt
);
11216 Fput (var
, Qlast_arrow_string
, Qt
);
11222 /* Return overlay arrow string to display at row.
11223 Return integer (bitmap number) for arrow bitmap in left fringe.
11224 Return nil if no overlay arrow. */
11227 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11231 for (vlist
= Voverlay_arrow_variable_list
;
11233 vlist
= XCDR (vlist
))
11235 Lisp_Object var
= XCAR (vlist
);
11238 if (!SYMBOLP (var
))
11241 val
= find_symbol_value (var
);
11244 && current_buffer
== XMARKER (val
)->buffer
11245 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11247 if (FRAME_WINDOW_P (it
->f
)
11248 /* FIXME: if ROW->reversed_p is set, this should test
11249 the right fringe, not the left one. */
11250 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11252 #ifdef HAVE_WINDOW_SYSTEM
11253 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11256 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11257 return make_number (fringe_bitmap
);
11260 return make_number (-1); /* Use default arrow bitmap */
11262 return overlay_arrow_string_or_property (var
);
11269 /* Return 1 if point moved out of or into a composition. Otherwise
11270 return 0. PREV_BUF and PREV_PT are the last point buffer and
11271 position. BUF and PT are the current point buffer and position. */
11274 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11275 struct buffer
*buf
, EMACS_INT pt
)
11277 EMACS_INT start
, end
;
11279 Lisp_Object buffer
;
11281 XSETBUFFER (buffer
, buf
);
11282 /* Check a composition at the last point if point moved within the
11284 if (prev_buf
== buf
)
11287 /* Point didn't move. */
11290 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11291 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11292 && COMPOSITION_VALID_P (start
, end
, prop
)
11293 && start
< prev_pt
&& end
> prev_pt
)
11294 /* The last point was within the composition. Return 1 iff
11295 point moved out of the composition. */
11296 return (pt
<= start
|| pt
>= end
);
11299 /* Check a composition at the current point. */
11300 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11301 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11302 && COMPOSITION_VALID_P (start
, end
, prop
)
11303 && start
< pt
&& end
> pt
);
11307 /* Reconsider the setting of B->clip_changed which is displayed
11311 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11313 if (b
->clip_changed
11314 && !NILP (w
->window_end_valid
)
11315 && w
->current_matrix
->buffer
== b
11316 && w
->current_matrix
->zv
== BUF_ZV (b
)
11317 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11318 b
->clip_changed
= 0;
11320 /* If display wasn't paused, and W is not a tool bar window, see if
11321 point has been moved into or out of a composition. In that case,
11322 we set b->clip_changed to 1 to force updating the screen. If
11323 b->clip_changed has already been set to 1, we can skip this
11325 if (!b
->clip_changed
11326 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11330 if (w
== XWINDOW (selected_window
))
11333 pt
= marker_position (w
->pointm
);
11335 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11336 || pt
!= XINT (w
->last_point
))
11337 && check_point_in_composition (w
->current_matrix
->buffer
,
11338 XINT (w
->last_point
),
11339 XBUFFER (w
->buffer
), pt
))
11340 b
->clip_changed
= 1;
11345 /* Select FRAME to forward the values of frame-local variables into C
11346 variables so that the redisplay routines can access those values
11350 select_frame_for_redisplay (Lisp_Object frame
)
11352 Lisp_Object tail
, tem
;
11353 Lisp_Object old
= selected_frame
;
11354 struct Lisp_Symbol
*sym
;
11356 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11358 selected_frame
= frame
;
11361 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11362 if (CONSP (XCAR (tail
))
11363 && (tem
= XCAR (XCAR (tail
)),
11365 && (sym
= indirect_variable (XSYMBOL (tem
)),
11366 sym
->redirect
== SYMBOL_LOCALIZED
)
11367 && sym
->val
.blv
->frame_local
)
11368 /* Use find_symbol_value rather than Fsymbol_value
11369 to avoid an error if it is void. */
11370 find_symbol_value (tem
);
11371 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11375 #define STOP_POLLING \
11376 do { if (! polling_stopped_here) stop_polling (); \
11377 polling_stopped_here = 1; } while (0)
11379 #define RESUME_POLLING \
11380 do { if (polling_stopped_here) start_polling (); \
11381 polling_stopped_here = 0; } while (0)
11384 /* Perhaps in the future avoid recentering windows if it
11385 is not necessary; currently that causes some problems. */
11388 redisplay_internal (void)
11390 struct window
*w
= XWINDOW (selected_window
);
11394 int must_finish
= 0;
11395 struct text_pos tlbufpos
, tlendpos
;
11396 int number_of_visible_frames
;
11399 int polling_stopped_here
= 0;
11400 Lisp_Object old_frame
= selected_frame
;
11402 /* Non-zero means redisplay has to consider all windows on all
11403 frames. Zero means, only selected_window is considered. */
11404 int consider_all_windows_p
;
11406 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11408 /* No redisplay if running in batch mode or frame is not yet fully
11409 initialized, or redisplay is explicitly turned off by setting
11410 Vinhibit_redisplay. */
11411 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11412 || !NILP (Vinhibit_redisplay
))
11415 /* Don't examine these until after testing Vinhibit_redisplay.
11416 When Emacs is shutting down, perhaps because its connection to
11417 X has dropped, we should not look at them at all. */
11418 fr
= XFRAME (w
->frame
);
11419 sf
= SELECTED_FRAME ();
11421 if (!fr
->glyphs_initialized_p
)
11424 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11425 if (popup_activated ())
11429 /* I don't think this happens but let's be paranoid. */
11430 if (redisplaying_p
)
11433 /* Record a function that resets redisplaying_p to its old value
11434 when we leave this function. */
11435 count
= SPECPDL_INDEX ();
11436 record_unwind_protect (unwind_redisplay
,
11437 Fcons (make_number (redisplaying_p
), selected_frame
));
11439 specbind (Qinhibit_free_realized_faces
, Qnil
);
11442 Lisp_Object tail
, frame
;
11444 FOR_EACH_FRAME (tail
, frame
)
11446 struct frame
*f
= XFRAME (frame
);
11447 f
->already_hscrolled_p
= 0;
11452 /* Remember the currently selected window. */
11455 if (!EQ (old_frame
, selected_frame
)
11456 && FRAME_LIVE_P (XFRAME (old_frame
)))
11457 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11458 selected_frame and selected_window to be temporarily out-of-sync so
11459 when we come back here via `goto retry', we need to resync because we
11460 may need to run Elisp code (via prepare_menu_bars). */
11461 select_frame_for_redisplay (old_frame
);
11464 reconsider_clip_changes (w
, current_buffer
);
11465 last_escape_glyph_frame
= NULL
;
11466 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11467 last_glyphless_glyph_frame
= NULL
;
11468 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11470 /* If new fonts have been loaded that make a glyph matrix adjustment
11471 necessary, do it. */
11472 if (fonts_changed_p
)
11474 adjust_glyphs (NULL
);
11475 ++windows_or_buffers_changed
;
11476 fonts_changed_p
= 0;
11479 /* If face_change_count is non-zero, init_iterator will free all
11480 realized faces, which includes the faces referenced from current
11481 matrices. So, we can't reuse current matrices in this case. */
11482 if (face_change_count
)
11483 ++windows_or_buffers_changed
;
11485 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11486 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11488 /* Since frames on a single ASCII terminal share the same
11489 display area, displaying a different frame means redisplay
11490 the whole thing. */
11491 windows_or_buffers_changed
++;
11492 SET_FRAME_GARBAGED (sf
);
11494 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11496 FRAME_TTY (sf
)->previous_frame
= sf
;
11499 /* Set the visible flags for all frames. Do this before checking
11500 for resized or garbaged frames; they want to know if their frames
11501 are visible. See the comment in frame.h for
11502 FRAME_SAMPLE_VISIBILITY. */
11504 Lisp_Object tail
, frame
;
11506 number_of_visible_frames
= 0;
11508 FOR_EACH_FRAME (tail
, frame
)
11510 struct frame
*f
= XFRAME (frame
);
11512 FRAME_SAMPLE_VISIBILITY (f
);
11513 if (FRAME_VISIBLE_P (f
))
11514 ++number_of_visible_frames
;
11515 clear_desired_matrices (f
);
11519 /* Notice any pending interrupt request to change frame size. */
11520 do_pending_window_change (1);
11522 /* do_pending_window_change could change the selected_window due to
11523 frame resizing which makes the selected window too small. */
11524 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11527 reconsider_clip_changes (w
, current_buffer
);
11530 /* Clear frames marked as garbaged. */
11531 if (frame_garbaged
)
11532 clear_garbaged_frames ();
11534 /* Build menubar and tool-bar items. */
11535 if (NILP (Vmemory_full
))
11536 prepare_menu_bars ();
11538 if (windows_or_buffers_changed
)
11539 update_mode_lines
++;
11541 /* Detect case that we need to write or remove a star in the mode line. */
11542 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11544 w
->update_mode_line
= Qt
;
11545 if (buffer_shared
> 1)
11546 update_mode_lines
++;
11549 /* Avoid invocation of point motion hooks by `current_column' below. */
11550 count1
= SPECPDL_INDEX ();
11551 specbind (Qinhibit_point_motion_hooks
, Qt
);
11553 /* If %c is in the mode line, update it if needed. */
11554 if (!NILP (w
->column_number_displayed
)
11555 /* This alternative quickly identifies a common case
11556 where no change is needed. */
11557 && !(PT
== XFASTINT (w
->last_point
)
11558 && XFASTINT (w
->last_modified
) >= MODIFF
11559 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11560 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11561 w
->update_mode_line
= Qt
;
11563 unbind_to (count1
, Qnil
);
11565 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11567 /* The variable buffer_shared is set in redisplay_window and
11568 indicates that we redisplay a buffer in different windows. See
11570 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11571 || cursor_type_changed
);
11573 /* If specs for an arrow have changed, do thorough redisplay
11574 to ensure we remove any arrow that should no longer exist. */
11575 if (overlay_arrows_changed_p ())
11576 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11578 /* Normally the message* functions will have already displayed and
11579 updated the echo area, but the frame may have been trashed, or
11580 the update may have been preempted, so display the echo area
11581 again here. Checking message_cleared_p captures the case that
11582 the echo area should be cleared. */
11583 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11584 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11585 || (message_cleared_p
11586 && minibuf_level
== 0
11587 /* If the mini-window is currently selected, this means the
11588 echo-area doesn't show through. */
11589 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11591 int window_height_changed_p
= echo_area_display (0);
11594 /* If we don't display the current message, don't clear the
11595 message_cleared_p flag, because, if we did, we wouldn't clear
11596 the echo area in the next redisplay which doesn't preserve
11598 if (!display_last_displayed_message_p
)
11599 message_cleared_p
= 0;
11601 if (fonts_changed_p
)
11603 else if (window_height_changed_p
)
11605 consider_all_windows_p
= 1;
11606 ++update_mode_lines
;
11607 ++windows_or_buffers_changed
;
11609 /* If window configuration was changed, frames may have been
11610 marked garbaged. Clear them or we will experience
11611 surprises wrt scrolling. */
11612 if (frame_garbaged
)
11613 clear_garbaged_frames ();
11616 else if (EQ (selected_window
, minibuf_window
)
11617 && (current_buffer
->clip_changed
11618 || XFASTINT (w
->last_modified
) < MODIFF
11619 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11620 && resize_mini_window (w
, 0))
11622 /* Resized active mini-window to fit the size of what it is
11623 showing if its contents might have changed. */
11625 /* FIXME: this causes all frames to be updated, which seems unnecessary
11626 since only the current frame needs to be considered. This function needs
11627 to be rewritten with two variables, consider_all_windows and
11628 consider_all_frames. */
11629 consider_all_windows_p
= 1;
11630 ++windows_or_buffers_changed
;
11631 ++update_mode_lines
;
11633 /* If window configuration was changed, frames may have been
11634 marked garbaged. Clear them or we will experience
11635 surprises wrt scrolling. */
11636 if (frame_garbaged
)
11637 clear_garbaged_frames ();
11641 /* If showing the region, and mark has changed, we must redisplay
11642 the whole window. The assignment to this_line_start_pos prevents
11643 the optimization directly below this if-statement. */
11644 if (((!NILP (Vtransient_mark_mode
)
11645 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11646 != !NILP (w
->region_showing
))
11647 || (!NILP (w
->region_showing
)
11648 && !EQ (w
->region_showing
,
11649 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11650 CHARPOS (this_line_start_pos
) = 0;
11652 /* Optimize the case that only the line containing the cursor in the
11653 selected window has changed. Variables starting with this_ are
11654 set in display_line and record information about the line
11655 containing the cursor. */
11656 tlbufpos
= this_line_start_pos
;
11657 tlendpos
= this_line_end_pos
;
11658 if (!consider_all_windows_p
11659 && CHARPOS (tlbufpos
) > 0
11660 && NILP (w
->update_mode_line
)
11661 && !current_buffer
->clip_changed
11662 && !current_buffer
->prevent_redisplay_optimizations_p
11663 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11664 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11665 /* Make sure recorded data applies to current buffer, etc. */
11666 && this_line_buffer
== current_buffer
11667 && current_buffer
== XBUFFER (w
->buffer
)
11668 && NILP (w
->force_start
)
11669 && NILP (w
->optional_new_start
)
11670 /* Point must be on the line that we have info recorded about. */
11671 && PT
>= CHARPOS (tlbufpos
)
11672 && PT
<= Z
- CHARPOS (tlendpos
)
11673 /* All text outside that line, including its final newline,
11674 must be unchanged. */
11675 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11676 CHARPOS (tlendpos
)))
11678 if (CHARPOS (tlbufpos
) > BEGV
11679 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11680 && (CHARPOS (tlbufpos
) == ZV
11681 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11682 /* Former continuation line has disappeared by becoming empty. */
11684 else if (XFASTINT (w
->last_modified
) < MODIFF
11685 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11686 || MINI_WINDOW_P (w
))
11688 /* We have to handle the case of continuation around a
11689 wide-column character (see the comment in indent.c around
11692 For instance, in the following case:
11694 -------- Insert --------
11695 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11696 J_I_ ==> J_I_ `^^' are cursors.
11700 As we have to redraw the line above, we cannot use this
11704 int line_height_before
= this_line_pixel_height
;
11706 /* Note that start_display will handle the case that the
11707 line starting at tlbufpos is a continuation line. */
11708 start_display (&it
, w
, tlbufpos
);
11710 /* Implementation note: It this still necessary? */
11711 if (it
.current_x
!= this_line_start_x
)
11714 TRACE ((stderr
, "trying display optimization 1\n"));
11715 w
->cursor
.vpos
= -1;
11716 overlay_arrow_seen
= 0;
11717 it
.vpos
= this_line_vpos
;
11718 it
.current_y
= this_line_y
;
11719 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11720 display_line (&it
);
11722 /* If line contains point, is not continued,
11723 and ends at same distance from eob as before, we win. */
11724 if (w
->cursor
.vpos
>= 0
11725 /* Line is not continued, otherwise this_line_start_pos
11726 would have been set to 0 in display_line. */
11727 && CHARPOS (this_line_start_pos
)
11728 /* Line ends as before. */
11729 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11730 /* Line has same height as before. Otherwise other lines
11731 would have to be shifted up or down. */
11732 && this_line_pixel_height
== line_height_before
)
11734 /* If this is not the window's last line, we must adjust
11735 the charstarts of the lines below. */
11736 if (it
.current_y
< it
.last_visible_y
)
11738 struct glyph_row
*row
11739 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11740 EMACS_INT delta
, delta_bytes
;
11742 /* We used to distinguish between two cases here,
11743 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11744 when the line ends in a newline or the end of the
11745 buffer's accessible portion. But both cases did
11746 the same, so they were collapsed. */
11748 - CHARPOS (tlendpos
)
11749 - MATRIX_ROW_START_CHARPOS (row
));
11750 delta_bytes
= (Z_BYTE
11751 - BYTEPOS (tlendpos
)
11752 - MATRIX_ROW_START_BYTEPOS (row
));
11754 increment_matrix_positions (w
->current_matrix
,
11755 this_line_vpos
+ 1,
11756 w
->current_matrix
->nrows
,
11757 delta
, delta_bytes
);
11760 /* If this row displays text now but previously didn't,
11761 or vice versa, w->window_end_vpos may have to be
11763 if ((it
.glyph_row
- 1)->displays_text_p
)
11765 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11766 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11768 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11769 && this_line_vpos
> 0)
11770 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11771 w
->window_end_valid
= Qnil
;
11773 /* Update hint: No need to try to scroll in update_window. */
11774 w
->desired_matrix
->no_scrolling_p
= 1;
11777 *w
->desired_matrix
->method
= 0;
11778 debug_method_add (w
, "optimization 1");
11780 #ifdef HAVE_WINDOW_SYSTEM
11781 update_window_fringes (w
, 0);
11788 else if (/* Cursor position hasn't changed. */
11789 PT
== XFASTINT (w
->last_point
)
11790 /* Make sure the cursor was last displayed
11791 in this window. Otherwise we have to reposition it. */
11792 && 0 <= w
->cursor
.vpos
11793 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11797 do_pending_window_change (1);
11798 /* If selected_window changed, redisplay again. */
11799 if (WINDOWP (selected_window
)
11800 && (w
= XWINDOW (selected_window
)) != sw
)
11803 /* We used to always goto end_of_redisplay here, but this
11804 isn't enough if we have a blinking cursor. */
11805 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11806 goto end_of_redisplay
;
11810 /* If highlighting the region, or if the cursor is in the echo area,
11811 then we can't just move the cursor. */
11812 else if (! (!NILP (Vtransient_mark_mode
)
11813 && !NILP (BVAR (current_buffer
, mark_active
)))
11814 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11815 || highlight_nonselected_windows
)
11816 && NILP (w
->region_showing
)
11817 && NILP (Vshow_trailing_whitespace
)
11818 && !cursor_in_echo_area
)
11821 struct glyph_row
*row
;
11823 /* Skip from tlbufpos to PT and see where it is. Note that
11824 PT may be in invisible text. If so, we will end at the
11825 next visible position. */
11826 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11827 NULL
, DEFAULT_FACE_ID
);
11828 it
.current_x
= this_line_start_x
;
11829 it
.current_y
= this_line_y
;
11830 it
.vpos
= this_line_vpos
;
11832 /* The call to move_it_to stops in front of PT, but
11833 moves over before-strings. */
11834 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11836 if (it
.vpos
== this_line_vpos
11837 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11840 xassert (this_line_vpos
== it
.vpos
);
11841 xassert (this_line_y
== it
.current_y
);
11842 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11844 *w
->desired_matrix
->method
= 0;
11845 debug_method_add (w
, "optimization 3");
11854 /* Text changed drastically or point moved off of line. */
11855 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11858 CHARPOS (this_line_start_pos
) = 0;
11859 consider_all_windows_p
|= buffer_shared
> 1;
11860 ++clear_face_cache_count
;
11861 #ifdef HAVE_WINDOW_SYSTEM
11862 ++clear_image_cache_count
;
11865 /* Build desired matrices, and update the display. If
11866 consider_all_windows_p is non-zero, do it for all windows on all
11867 frames. Otherwise do it for selected_window, only. */
11869 if (consider_all_windows_p
)
11871 Lisp_Object tail
, frame
;
11873 FOR_EACH_FRAME (tail
, frame
)
11874 XFRAME (frame
)->updated_p
= 0;
11876 /* Recompute # windows showing selected buffer. This will be
11877 incremented each time such a window is displayed. */
11880 FOR_EACH_FRAME (tail
, frame
)
11882 struct frame
*f
= XFRAME (frame
);
11884 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11886 if (! EQ (frame
, selected_frame
))
11887 /* Select the frame, for the sake of frame-local
11889 select_frame_for_redisplay (frame
);
11891 /* Mark all the scroll bars to be removed; we'll redeem
11892 the ones we want when we redisplay their windows. */
11893 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11894 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11896 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11897 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11899 /* The X error handler may have deleted that frame. */
11900 if (!FRAME_LIVE_P (f
))
11903 /* Any scroll bars which redisplay_windows should have
11904 nuked should now go away. */
11905 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11906 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11908 /* If fonts changed, display again. */
11909 /* ??? rms: I suspect it is a mistake to jump all the way
11910 back to retry here. It should just retry this frame. */
11911 if (fonts_changed_p
)
11914 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11916 /* See if we have to hscroll. */
11917 if (!f
->already_hscrolled_p
)
11919 f
->already_hscrolled_p
= 1;
11920 if (hscroll_windows (f
->root_window
))
11924 /* Prevent various kinds of signals during display
11925 update. stdio is not robust about handling
11926 signals, which can cause an apparent I/O
11928 if (interrupt_input
)
11929 unrequest_sigio ();
11932 /* Update the display. */
11933 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11934 pending
|= update_frame (f
, 0, 0);
11940 if (!EQ (old_frame
, selected_frame
)
11941 && FRAME_LIVE_P (XFRAME (old_frame
)))
11942 /* We played a bit fast-and-loose above and allowed selected_frame
11943 and selected_window to be temporarily out-of-sync but let's make
11944 sure this stays contained. */
11945 select_frame_for_redisplay (old_frame
);
11946 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11950 /* Do the mark_window_display_accurate after all windows have
11951 been redisplayed because this call resets flags in buffers
11952 which are needed for proper redisplay. */
11953 FOR_EACH_FRAME (tail
, frame
)
11955 struct frame
*f
= XFRAME (frame
);
11958 mark_window_display_accurate (f
->root_window
, 1);
11959 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11960 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11965 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11967 Lisp_Object mini_window
;
11968 struct frame
*mini_frame
;
11970 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11971 /* Use list_of_error, not Qerror, so that
11972 we catch only errors and don't run the debugger. */
11973 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11975 redisplay_window_error
);
11977 /* Compare desired and current matrices, perform output. */
11980 /* If fonts changed, display again. */
11981 if (fonts_changed_p
)
11984 /* Prevent various kinds of signals during display update.
11985 stdio is not robust about handling signals,
11986 which can cause an apparent I/O error. */
11987 if (interrupt_input
)
11988 unrequest_sigio ();
11991 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11993 if (hscroll_windows (selected_window
))
11996 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11997 pending
= update_frame (sf
, 0, 0);
12000 /* We may have called echo_area_display at the top of this
12001 function. If the echo area is on another frame, that may
12002 have put text on a frame other than the selected one, so the
12003 above call to update_frame would not have caught it. Catch
12005 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12006 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12008 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12010 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12011 pending
|= update_frame (mini_frame
, 0, 0);
12012 if (!pending
&& hscroll_windows (mini_window
))
12017 /* If display was paused because of pending input, make sure we do a
12018 thorough update the next time. */
12021 /* Prevent the optimization at the beginning of
12022 redisplay_internal that tries a single-line update of the
12023 line containing the cursor in the selected window. */
12024 CHARPOS (this_line_start_pos
) = 0;
12026 /* Let the overlay arrow be updated the next time. */
12027 update_overlay_arrows (0);
12029 /* If we pause after scrolling, some rows in the current
12030 matrices of some windows are not valid. */
12031 if (!WINDOW_FULL_WIDTH_P (w
)
12032 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12033 update_mode_lines
= 1;
12037 if (!consider_all_windows_p
)
12039 /* This has already been done above if
12040 consider_all_windows_p is set. */
12041 mark_window_display_accurate_1 (w
, 1);
12043 /* Say overlay arrows are up to date. */
12044 update_overlay_arrows (1);
12046 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12047 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12050 update_mode_lines
= 0;
12051 windows_or_buffers_changed
= 0;
12052 cursor_type_changed
= 0;
12055 /* Start SIGIO interrupts coming again. Having them off during the
12056 code above makes it less likely one will discard output, but not
12057 impossible, since there might be stuff in the system buffer here.
12058 But it is much hairier to try to do anything about that. */
12059 if (interrupt_input
)
12063 /* If a frame has become visible which was not before, redisplay
12064 again, so that we display it. Expose events for such a frame
12065 (which it gets when becoming visible) don't call the parts of
12066 redisplay constructing glyphs, so simply exposing a frame won't
12067 display anything in this case. So, we have to display these
12068 frames here explicitly. */
12071 Lisp_Object tail
, frame
;
12074 FOR_EACH_FRAME (tail
, frame
)
12076 int this_is_visible
= 0;
12078 if (XFRAME (frame
)->visible
)
12079 this_is_visible
= 1;
12080 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12081 if (XFRAME (frame
)->visible
)
12082 this_is_visible
= 1;
12084 if (this_is_visible
)
12088 if (new_count
!= number_of_visible_frames
)
12089 windows_or_buffers_changed
++;
12092 /* Change frame size now if a change is pending. */
12093 do_pending_window_change (1);
12095 /* If we just did a pending size change, or have additional
12096 visible frames, or selected_window changed, redisplay again. */
12097 if ((windows_or_buffers_changed
&& !pending
)
12098 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12101 /* Clear the face and image caches.
12103 We used to do this only if consider_all_windows_p. But the cache
12104 needs to be cleared if a timer creates images in the current
12105 buffer (e.g. the test case in Bug#6230). */
12107 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12109 clear_face_cache (0);
12110 clear_face_cache_count
= 0;
12113 #ifdef HAVE_WINDOW_SYSTEM
12114 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12116 clear_image_caches (Qnil
);
12117 clear_image_cache_count
= 0;
12119 #endif /* HAVE_WINDOW_SYSTEM */
12122 unbind_to (count
, Qnil
);
12127 /* Redisplay, but leave alone any recent echo area message unless
12128 another message has been requested in its place.
12130 This is useful in situations where you need to redisplay but no
12131 user action has occurred, making it inappropriate for the message
12132 area to be cleared. See tracking_off and
12133 wait_reading_process_output for examples of these situations.
12135 FROM_WHERE is an integer saying from where this function was
12136 called. This is useful for debugging. */
12139 redisplay_preserve_echo_area (int from_where
)
12141 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12143 if (!NILP (echo_area_buffer
[1]))
12145 /* We have a previously displayed message, but no current
12146 message. Redisplay the previous message. */
12147 display_last_displayed_message_p
= 1;
12148 redisplay_internal ();
12149 display_last_displayed_message_p
= 0;
12152 redisplay_internal ();
12154 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12155 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12156 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12160 /* Function registered with record_unwind_protect in
12161 redisplay_internal. Reset redisplaying_p to the value it had
12162 before redisplay_internal was called, and clear
12163 prevent_freeing_realized_faces_p. It also selects the previously
12164 selected frame, unless it has been deleted (by an X connection
12165 failure during redisplay, for example). */
12168 unwind_redisplay (Lisp_Object val
)
12170 Lisp_Object old_redisplaying_p
, old_frame
;
12172 old_redisplaying_p
= XCAR (val
);
12173 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12174 old_frame
= XCDR (val
);
12175 if (! EQ (old_frame
, selected_frame
)
12176 && FRAME_LIVE_P (XFRAME (old_frame
)))
12177 select_frame_for_redisplay (old_frame
);
12182 /* Mark the display of window W as accurate or inaccurate. If
12183 ACCURATE_P is non-zero mark display of W as accurate. If
12184 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12185 redisplay_internal is called. */
12188 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12190 if (BUFFERP (w
->buffer
))
12192 struct buffer
*b
= XBUFFER (w
->buffer
);
12195 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12196 w
->last_overlay_modified
12197 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12199 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12203 b
->clip_changed
= 0;
12204 b
->prevent_redisplay_optimizations_p
= 0;
12206 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12207 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12208 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12209 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12211 w
->current_matrix
->buffer
= b
;
12212 w
->current_matrix
->begv
= BUF_BEGV (b
);
12213 w
->current_matrix
->zv
= BUF_ZV (b
);
12215 w
->last_cursor
= w
->cursor
;
12216 w
->last_cursor_off_p
= w
->cursor_off_p
;
12218 if (w
== XWINDOW (selected_window
))
12219 w
->last_point
= make_number (BUF_PT (b
));
12221 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12227 w
->window_end_valid
= w
->buffer
;
12228 w
->update_mode_line
= Qnil
;
12233 /* Mark the display of windows in the window tree rooted at WINDOW as
12234 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12235 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12236 be redisplayed the next time redisplay_internal is called. */
12239 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12243 for (; !NILP (window
); window
= w
->next
)
12245 w
= XWINDOW (window
);
12246 mark_window_display_accurate_1 (w
, accurate_p
);
12248 if (!NILP (w
->vchild
))
12249 mark_window_display_accurate (w
->vchild
, accurate_p
);
12250 if (!NILP (w
->hchild
))
12251 mark_window_display_accurate (w
->hchild
, accurate_p
);
12256 update_overlay_arrows (1);
12260 /* Force a thorough redisplay the next time by setting
12261 last_arrow_position and last_arrow_string to t, which is
12262 unequal to any useful value of Voverlay_arrow_... */
12263 update_overlay_arrows (-1);
12268 /* Return value in display table DP (Lisp_Char_Table *) for character
12269 C. Since a display table doesn't have any parent, we don't have to
12270 follow parent. Do not call this function directly but use the
12271 macro DISP_CHAR_VECTOR. */
12274 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12278 if (ASCII_CHAR_P (c
))
12281 if (SUB_CHAR_TABLE_P (val
))
12282 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12288 XSETCHAR_TABLE (table
, dp
);
12289 val
= char_table_ref (table
, c
);
12298 /***********************************************************************
12300 ***********************************************************************/
12302 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12305 redisplay_windows (Lisp_Object window
)
12307 while (!NILP (window
))
12309 struct window
*w
= XWINDOW (window
);
12311 if (!NILP (w
->hchild
))
12312 redisplay_windows (w
->hchild
);
12313 else if (!NILP (w
->vchild
))
12314 redisplay_windows (w
->vchild
);
12315 else if (!NILP (w
->buffer
))
12317 displayed_buffer
= XBUFFER (w
->buffer
);
12318 /* Use list_of_error, not Qerror, so that
12319 we catch only errors and don't run the debugger. */
12320 internal_condition_case_1 (redisplay_window_0
, window
,
12322 redisplay_window_error
);
12330 redisplay_window_error (Lisp_Object ignore
)
12332 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12337 redisplay_window_0 (Lisp_Object window
)
12339 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12340 redisplay_window (window
, 0);
12345 redisplay_window_1 (Lisp_Object window
)
12347 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12348 redisplay_window (window
, 1);
12353 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12354 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12355 which positions recorded in ROW differ from current buffer
12358 Return 0 if cursor is not on this row, 1 otherwise. */
12361 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12362 struct glyph_matrix
*matrix
,
12363 EMACS_INT delta
, EMACS_INT delta_bytes
,
12366 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12367 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12368 struct glyph
*cursor
= NULL
;
12369 /* The last known character position in row. */
12370 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12372 EMACS_INT pt_old
= PT
- delta
;
12373 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12374 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12375 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12376 /* A glyph beyond the edge of TEXT_AREA which we should never
12378 struct glyph
*glyphs_end
= end
;
12379 /* Non-zero means we've found a match for cursor position, but that
12380 glyph has the avoid_cursor_p flag set. */
12381 int match_with_avoid_cursor
= 0;
12382 /* Non-zero means we've seen at least one glyph that came from a
12384 int string_seen
= 0;
12385 /* Largest and smalles buffer positions seen so far during scan of
12387 EMACS_INT bpos_max
= pos_before
;
12388 EMACS_INT bpos_min
= pos_after
;
12389 /* Last buffer position covered by an overlay string with an integer
12390 `cursor' property. */
12391 EMACS_INT bpos_covered
= 0;
12393 /* Skip over glyphs not having an object at the start and the end of
12394 the row. These are special glyphs like truncation marks on
12395 terminal frames. */
12396 if (row
->displays_text_p
)
12398 if (!row
->reversed_p
)
12401 && INTEGERP (glyph
->object
)
12402 && glyph
->charpos
< 0)
12404 x
+= glyph
->pixel_width
;
12408 && INTEGERP ((end
- 1)->object
)
12409 /* CHARPOS is zero for blanks and stretch glyphs
12410 inserted by extend_face_to_end_of_line. */
12411 && (end
- 1)->charpos
<= 0)
12413 glyph_before
= glyph
- 1;
12420 /* If the glyph row is reversed, we need to process it from back
12421 to front, so swap the edge pointers. */
12422 glyphs_end
= end
= glyph
- 1;
12423 glyph
+= row
->used
[TEXT_AREA
] - 1;
12425 while (glyph
> end
+ 1
12426 && INTEGERP (glyph
->object
)
12427 && glyph
->charpos
< 0)
12430 x
-= glyph
->pixel_width
;
12432 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12434 /* By default, in reversed rows we put the cursor on the
12435 rightmost (first in the reading order) glyph. */
12436 for (g
= end
+ 1; g
< glyph
; g
++)
12437 x
+= g
->pixel_width
;
12439 && INTEGERP ((end
+ 1)->object
)
12440 && (end
+ 1)->charpos
<= 0)
12442 glyph_before
= glyph
+ 1;
12446 else if (row
->reversed_p
)
12448 /* In R2L rows that don't display text, put the cursor on the
12449 rightmost glyph. Case in point: an empty last line that is
12450 part of an R2L paragraph. */
12452 /* Avoid placing the cursor on the last glyph of the row, where
12453 on terminal frames we hold the vertical border between
12454 adjacent windows. */
12455 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12456 && !WINDOW_RIGHTMOST_P (w
)
12457 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12459 x
= -1; /* will be computed below, at label compute_x */
12462 /* Step 1: Try to find the glyph whose character position
12463 corresponds to point. If that's not possible, find 2 glyphs
12464 whose character positions are the closest to point, one before
12465 point, the other after it. */
12466 if (!row
->reversed_p
)
12467 while (/* not marched to end of glyph row */
12469 /* glyph was not inserted by redisplay for internal purposes */
12470 && !INTEGERP (glyph
->object
))
12472 if (BUFFERP (glyph
->object
))
12474 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12476 if (glyph
->charpos
> bpos_max
)
12477 bpos_max
= glyph
->charpos
;
12478 if (glyph
->charpos
< bpos_min
)
12479 bpos_min
= glyph
->charpos
;
12480 if (!glyph
->avoid_cursor_p
)
12482 /* If we hit point, we've found the glyph on which to
12483 display the cursor. */
12486 match_with_avoid_cursor
= 0;
12489 /* See if we've found a better approximation to
12490 POS_BEFORE or to POS_AFTER. Note that we want the
12491 first (leftmost) glyph of all those that are the
12492 closest from below, and the last (rightmost) of all
12493 those from above. */
12494 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12496 pos_before
= glyph
->charpos
;
12497 glyph_before
= glyph
;
12499 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12501 pos_after
= glyph
->charpos
;
12502 glyph_after
= glyph
;
12505 else if (dpos
== 0)
12506 match_with_avoid_cursor
= 1;
12508 else if (STRINGP (glyph
->object
))
12510 Lisp_Object chprop
;
12511 EMACS_INT glyph_pos
= glyph
->charpos
;
12513 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12515 if (INTEGERP (chprop
))
12517 bpos_covered
= bpos_max
+ XINT (chprop
);
12518 /* If the `cursor' property covers buffer positions up
12519 to and including point, we should display cursor on
12520 this glyph. Note that overlays and text properties
12521 with string values stop bidi reordering, so every
12522 buffer position to the left of the string is always
12523 smaller than any position to the right of the
12524 string. Therefore, if a `cursor' property on one
12525 of the string's characters has an integer value, we
12526 will break out of the loop below _before_ we get to
12527 the position match above. IOW, integer values of
12528 the `cursor' property override the "exact match for
12529 point" strategy of positioning the cursor. */
12530 /* Implementation note: bpos_max == pt_old when, e.g.,
12531 we are in an empty line, where bpos_max is set to
12532 MATRIX_ROW_START_CHARPOS, see above. */
12533 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12542 x
+= glyph
->pixel_width
;
12545 else if (glyph
> end
) /* row is reversed */
12546 while (!INTEGERP (glyph
->object
))
12548 if (BUFFERP (glyph
->object
))
12550 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12552 if (glyph
->charpos
> bpos_max
)
12553 bpos_max
= glyph
->charpos
;
12554 if (glyph
->charpos
< bpos_min
)
12555 bpos_min
= glyph
->charpos
;
12556 if (!glyph
->avoid_cursor_p
)
12560 match_with_avoid_cursor
= 0;
12563 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12565 pos_before
= glyph
->charpos
;
12566 glyph_before
= glyph
;
12568 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12570 pos_after
= glyph
->charpos
;
12571 glyph_after
= glyph
;
12574 else if (dpos
== 0)
12575 match_with_avoid_cursor
= 1;
12577 else if (STRINGP (glyph
->object
))
12579 Lisp_Object chprop
;
12580 EMACS_INT glyph_pos
= glyph
->charpos
;
12582 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12584 if (INTEGERP (chprop
))
12586 bpos_covered
= bpos_max
+ XINT (chprop
);
12587 /* If the `cursor' property covers buffer positions up
12588 to and including point, we should display cursor on
12590 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12599 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12601 x
--; /* can't use any pixel_width */
12604 x
-= glyph
->pixel_width
;
12607 /* Step 2: If we didn't find an exact match for point, we need to
12608 look for a proper place to put the cursor among glyphs between
12609 GLYPH_BEFORE and GLYPH_AFTER. */
12610 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12611 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12612 && bpos_covered
< pt_old
)
12614 /* An empty line has a single glyph whose OBJECT is zero and
12615 whose CHARPOS is the position of a newline on that line.
12616 Note that on a TTY, there are more glyphs after that, which
12617 were produced by extend_face_to_end_of_line, but their
12618 CHARPOS is zero or negative. */
12620 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12621 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12623 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12625 EMACS_INT ellipsis_pos
;
12627 /* Scan back over the ellipsis glyphs. */
12628 if (!row
->reversed_p
)
12630 ellipsis_pos
= (glyph
- 1)->charpos
;
12631 while (glyph
> row
->glyphs
[TEXT_AREA
]
12632 && (glyph
- 1)->charpos
== ellipsis_pos
)
12633 glyph
--, x
-= glyph
->pixel_width
;
12634 /* That loop always goes one position too far, including
12635 the glyph before the ellipsis. So scan forward over
12637 x
+= glyph
->pixel_width
;
12640 else /* row is reversed */
12642 ellipsis_pos
= (glyph
+ 1)->charpos
;
12643 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12644 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12645 glyph
++, x
+= glyph
->pixel_width
;
12646 x
-= glyph
->pixel_width
;
12650 else if (match_with_avoid_cursor
12651 /* A truncated row may not include PT among its
12652 character positions. Setting the cursor inside the
12653 scroll margin will trigger recalculation of hscroll
12654 in hscroll_window_tree. */
12655 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12656 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12657 /* Zero-width characters produce no glyphs. */
12660 && (row
->reversed_p
12661 ? glyph_after
> glyphs_end
12662 : glyph_after
< glyphs_end
)))
12664 cursor
= glyph_after
;
12667 else if (string_seen
)
12669 int incr
= row
->reversed_p
? -1 : +1;
12671 /* Need to find the glyph that came out of a string which is
12672 present at point. That glyph is somewhere between
12673 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12674 positioned between POS_BEFORE and POS_AFTER in the
12676 struct glyph
*stop
= glyph_after
;
12677 EMACS_INT pos
= pos_before
;
12680 for (glyph
= glyph_before
+ incr
;
12681 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12684 /* Any glyphs that come from the buffer are here because
12685 of bidi reordering. Skip them, and only pay
12686 attention to glyphs that came from some string. */
12687 if (STRINGP (glyph
->object
))
12692 str
= glyph
->object
;
12693 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12694 if (tem
== 0 /* from overlay */
12697 /* If the string from which this glyph came is
12698 found in the buffer at point, then we've
12699 found the glyph we've been looking for. If
12700 it comes from an overlay (tem == 0), and it
12701 has the `cursor' property on one of its
12702 glyphs, record that glyph as a candidate for
12703 displaying the cursor. (As in the
12704 unidirectional version, we will display the
12705 cursor on the last candidate we find.) */
12706 if (tem
== 0 || tem
== pt_old
)
12708 /* The glyphs from this string could have
12709 been reordered. Find the one with the
12710 smallest string position. Or there could
12711 be a character in the string with the
12712 `cursor' property, which means display
12713 cursor on that character's glyph. */
12714 EMACS_INT strpos
= glyph
->charpos
;
12719 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12720 && EQ (glyph
->object
, str
);
12724 EMACS_INT gpos
= glyph
->charpos
;
12726 cprop
= Fget_char_property (make_number (gpos
),
12734 if (tem
&& glyph
->charpos
< strpos
)
12736 strpos
= glyph
->charpos
;
12745 pos
= tem
+ 1; /* don't find previous instances */
12747 /* This string is not what we want; skip all of the
12748 glyphs that came from it. */
12749 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12750 && EQ (glyph
->object
, str
))
12757 /* If we reached the end of the line, and END was from a string,
12758 the cursor is not on this line. */
12760 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12761 && STRINGP (end
->object
)
12762 && row
->continued_p
)
12768 if (cursor
!= NULL
)
12774 /* Need to compute x that corresponds to GLYPH. */
12775 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12777 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12779 x
+= g
->pixel_width
;
12783 /* ROW could be part of a continued line, which, under bidi
12784 reordering, might have other rows whose start and end charpos
12785 occlude point. Only set w->cursor if we found a better
12786 approximation to the cursor position than we have from previously
12787 examined candidate rows belonging to the same continued line. */
12788 if (/* we already have a candidate row */
12789 w
->cursor
.vpos
>= 0
12790 /* that candidate is not the row we are processing */
12791 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12792 /* the row we are processing is part of a continued line */
12793 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12794 /* Make sure cursor.vpos specifies a row whose start and end
12795 charpos occlude point. This is because some callers of this
12796 function leave cursor.vpos at the row where the cursor was
12797 displayed during the last redisplay cycle. */
12798 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12799 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12802 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12804 /* Don't consider glyphs that are outside TEXT_AREA. */
12805 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12807 /* Keep the candidate whose buffer position is the closest to
12809 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12810 w
->cursor
.hpos
>= 0
12811 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12812 && BUFFERP (g1
->object
)
12813 && (g1
->charpos
== pt_old
/* an exact match always wins */
12814 || (BUFFERP (glyph
->object
)
12815 && eabs (g1
->charpos
- pt_old
)
12816 < eabs (glyph
->charpos
- pt_old
))))
12818 /* If this candidate gives an exact match, use that. */
12819 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12820 /* Otherwise, keep the candidate that comes from a row
12821 spanning less buffer positions. This may win when one or
12822 both candidate positions are on glyphs that came from
12823 display strings, for which we cannot compare buffer
12825 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12826 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12827 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12830 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12832 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12833 w
->cursor
.y
= row
->y
+ dy
;
12835 if (w
== XWINDOW (selected_window
))
12837 if (!row
->continued_p
12838 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12841 this_line_buffer
= XBUFFER (w
->buffer
);
12843 CHARPOS (this_line_start_pos
)
12844 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12845 BYTEPOS (this_line_start_pos
)
12846 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12848 CHARPOS (this_line_end_pos
)
12849 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12850 BYTEPOS (this_line_end_pos
)
12851 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12853 this_line_y
= w
->cursor
.y
;
12854 this_line_pixel_height
= row
->height
;
12855 this_line_vpos
= w
->cursor
.vpos
;
12856 this_line_start_x
= row
->x
;
12859 CHARPOS (this_line_start_pos
) = 0;
12866 /* Run window scroll functions, if any, for WINDOW with new window
12867 start STARTP. Sets the window start of WINDOW to that position.
12869 We assume that the window's buffer is really current. */
12871 static INLINE
struct text_pos
12872 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12874 struct window
*w
= XWINDOW (window
);
12875 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12877 if (current_buffer
!= XBUFFER (w
->buffer
))
12880 if (!NILP (Vwindow_scroll_functions
))
12882 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12883 make_number (CHARPOS (startp
)));
12884 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12885 /* In case the hook functions switch buffers. */
12886 if (current_buffer
!= XBUFFER (w
->buffer
))
12887 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12894 /* Make sure the line containing the cursor is fully visible.
12895 A value of 1 means there is nothing to be done.
12896 (Either the line is fully visible, or it cannot be made so,
12897 or we cannot tell.)
12899 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12900 is higher than window.
12902 A value of 0 means the caller should do scrolling
12903 as if point had gone off the screen. */
12906 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12908 struct glyph_matrix
*matrix
;
12909 struct glyph_row
*row
;
12912 if (!make_cursor_line_fully_visible_p
)
12915 /* It's not always possible to find the cursor, e.g, when a window
12916 is full of overlay strings. Don't do anything in that case. */
12917 if (w
->cursor
.vpos
< 0)
12920 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12921 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12923 /* If the cursor row is not partially visible, there's nothing to do. */
12924 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12927 /* If the row the cursor is in is taller than the window's height,
12928 it's not clear what to do, so do nothing. */
12929 window_height
= window_box_height (w
);
12930 if (row
->height
>= window_height
)
12932 if (!force_p
|| MINI_WINDOW_P (w
)
12933 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12940 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12941 non-zero means only WINDOW is redisplayed in redisplay_internal.
12942 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12943 in redisplay_window to bring a partially visible line into view in
12944 the case that only the cursor has moved.
12946 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12947 last screen line's vertical height extends past the end of the screen.
12951 1 if scrolling succeeded
12953 0 if scrolling didn't find point.
12955 -1 if new fonts have been loaded so that we must interrupt
12956 redisplay, adjust glyph matrices, and try again. */
12962 SCROLLING_NEED_LARGER_MATRICES
12965 /* If scroll-conservatively is more than this, never recenter.
12967 If you change this, don't forget to update the doc string of
12968 `scroll-conservatively' and the Emacs manual. */
12969 #define SCROLL_LIMIT 100
12972 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12973 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12974 int temp_scroll_step
, int last_line_misfit
)
12976 struct window
*w
= XWINDOW (window
);
12977 struct frame
*f
= XFRAME (w
->frame
);
12978 struct text_pos pos
, startp
;
12980 int this_scroll_margin
, scroll_max
, rc
, height
;
12981 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12982 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12983 Lisp_Object aggressive
;
12984 /* We will never try scrolling more than this number of lines. */
12985 int scroll_limit
= SCROLL_LIMIT
;
12988 debug_method_add (w
, "try_scrolling");
12991 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12993 /* Compute scroll margin height in pixels. We scroll when point is
12994 within this distance from the top or bottom of the window. */
12995 if (scroll_margin
> 0)
12996 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12997 * FRAME_LINE_HEIGHT (f
);
12999 this_scroll_margin
= 0;
13001 /* Force arg_scroll_conservatively to have a reasonable value, to
13002 avoid scrolling too far away with slow move_it_* functions. Note
13003 that the user can supply scroll-conservatively equal to
13004 `most-positive-fixnum', which can be larger than INT_MAX. */
13005 if (arg_scroll_conservatively
> scroll_limit
)
13007 arg_scroll_conservatively
= scroll_limit
+ 1;
13008 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13010 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13011 /* Compute how much we should try to scroll maximally to bring
13012 point into view. */
13013 scroll_max
= (max (scroll_step
,
13014 max (arg_scroll_conservatively
, temp_scroll_step
))
13015 * FRAME_LINE_HEIGHT (f
));
13016 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13017 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13018 /* We're trying to scroll because of aggressive scrolling but no
13019 scroll_step is set. Choose an arbitrary one. */
13020 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13026 /* Decide whether to scroll down. */
13027 if (PT
> CHARPOS (startp
))
13029 int scroll_margin_y
;
13031 /* Compute the pixel ypos of the scroll margin, then move it to
13032 either that ypos or PT, whichever comes first. */
13033 start_display (&it
, w
, startp
);
13034 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13035 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13036 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13037 (MOVE_TO_POS
| MOVE_TO_Y
));
13039 if (PT
> CHARPOS (it
.current
.pos
))
13041 int y0
= line_bottom_y (&it
);
13042 /* Compute how many pixels below window bottom to stop searching
13043 for PT. This avoids costly search for PT that is far away if
13044 the user limited scrolling by a small number of lines, but
13045 always finds PT if scroll_conservatively is set to a large
13046 number, such as most-positive-fixnum. */
13047 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13048 int y_to_move
= it
.last_visible_y
+ slack
;
13050 /* Compute the distance from the scroll margin to PT or to
13051 the scroll limit, whichever comes first. This should
13052 include the height of the cursor line, to make that line
13054 move_it_to (&it
, PT
, -1, y_to_move
,
13055 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13056 dy
= line_bottom_y (&it
) - y0
;
13058 if (dy
> scroll_max
)
13059 return SCROLLING_FAILED
;
13067 /* Point is in or below the bottom scroll margin, so move the
13068 window start down. If scrolling conservatively, move it just
13069 enough down to make point visible. If scroll_step is set,
13070 move it down by scroll_step. */
13071 if (arg_scroll_conservatively
)
13073 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13074 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13075 else if (scroll_step
|| temp_scroll_step
)
13076 amount_to_scroll
= scroll_max
;
13079 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13080 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13081 if (NUMBERP (aggressive
))
13083 double float_amount
= XFLOATINT (aggressive
) * height
;
13084 amount_to_scroll
= float_amount
;
13085 if (amount_to_scroll
== 0 && float_amount
> 0)
13086 amount_to_scroll
= 1;
13087 /* Don't let point enter the scroll margin near top of
13089 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13090 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13094 if (amount_to_scroll
<= 0)
13095 return SCROLLING_FAILED
;
13097 start_display (&it
, w
, startp
);
13098 if (arg_scroll_conservatively
<= scroll_limit
)
13099 move_it_vertically (&it
, amount_to_scroll
);
13102 /* Extra precision for users who set scroll-conservatively
13103 to a large number: make sure the amount we scroll
13104 the window start is never less than amount_to_scroll,
13105 which was computed as distance from window bottom to
13106 point. This matters when lines at window top and lines
13107 below window bottom have different height. */
13108 struct it it1
= it
;
13109 /* We use a temporary it1 because line_bottom_y can modify
13110 its argument, if it moves one line down; see there. */
13111 int start_y
= line_bottom_y (&it1
);
13114 move_it_by_lines (&it
, 1);
13116 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13119 /* If STARTP is unchanged, move it down another screen line. */
13120 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13121 move_it_by_lines (&it
, 1);
13122 startp
= it
.current
.pos
;
13126 struct text_pos scroll_margin_pos
= startp
;
13128 /* See if point is inside the scroll margin at the top of the
13130 if (this_scroll_margin
)
13132 start_display (&it
, w
, startp
);
13133 move_it_vertically (&it
, this_scroll_margin
);
13134 scroll_margin_pos
= it
.current
.pos
;
13137 if (PT
< CHARPOS (scroll_margin_pos
))
13139 /* Point is in the scroll margin at the top of the window or
13140 above what is displayed in the window. */
13143 /* Compute the vertical distance from PT to the scroll
13144 margin position. Move as far as scroll_max allows, or
13145 one screenful, or 10 screen lines, whichever is largest.
13146 Give up if distance is greater than scroll_max. */
13147 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13148 start_display (&it
, w
, pos
);
13150 y_to_move
= max (it
.last_visible_y
,
13151 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13152 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13154 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13155 dy
= it
.current_y
- y0
;
13156 if (dy
> scroll_max
)
13157 return SCROLLING_FAILED
;
13159 /* Compute new window start. */
13160 start_display (&it
, w
, startp
);
13162 if (arg_scroll_conservatively
)
13163 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13164 max (scroll_step
, temp_scroll_step
));
13165 else if (scroll_step
|| temp_scroll_step
)
13166 amount_to_scroll
= scroll_max
;
13169 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13170 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13171 if (NUMBERP (aggressive
))
13173 double float_amount
= XFLOATINT (aggressive
) * height
;
13174 amount_to_scroll
= float_amount
;
13175 if (amount_to_scroll
== 0 && float_amount
> 0)
13176 amount_to_scroll
= 1;
13177 amount_to_scroll
-=
13178 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13179 /* Don't let point enter the scroll margin near
13180 bottom of the window. */
13181 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13182 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13186 if (amount_to_scroll
<= 0)
13187 return SCROLLING_FAILED
;
13189 move_it_vertically_backward (&it
, amount_to_scroll
);
13190 startp
= it
.current
.pos
;
13194 /* Run window scroll functions. */
13195 startp
= run_window_scroll_functions (window
, startp
);
13197 /* Display the window. Give up if new fonts are loaded, or if point
13199 if (!try_window (window
, startp
, 0))
13200 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13201 else if (w
->cursor
.vpos
< 0)
13203 clear_glyph_matrix (w
->desired_matrix
);
13204 rc
= SCROLLING_FAILED
;
13208 /* Maybe forget recorded base line for line number display. */
13209 if (!just_this_one_p
13210 || current_buffer
->clip_changed
13211 || BEG_UNCHANGED
< CHARPOS (startp
))
13212 w
->base_line_number
= Qnil
;
13214 /* If cursor ends up on a partially visible line,
13215 treat that as being off the bottom of the screen. */
13216 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13217 /* It's possible that the cursor is on the first line of the
13218 buffer, which is partially obscured due to a vscroll
13219 (Bug#7537). In that case, avoid looping forever . */
13220 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13222 clear_glyph_matrix (w
->desired_matrix
);
13223 ++extra_scroll_margin_lines
;
13226 rc
= SCROLLING_SUCCESS
;
13233 /* Compute a suitable window start for window W if display of W starts
13234 on a continuation line. Value is non-zero if a new window start
13237 The new window start will be computed, based on W's width, starting
13238 from the start of the continued line. It is the start of the
13239 screen line with the minimum distance from the old start W->start. */
13242 compute_window_start_on_continuation_line (struct window
*w
)
13244 struct text_pos pos
, start_pos
;
13245 int window_start_changed_p
= 0;
13247 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13249 /* If window start is on a continuation line... Window start may be
13250 < BEGV in case there's invisible text at the start of the
13251 buffer (M-x rmail, for example). */
13252 if (CHARPOS (start_pos
) > BEGV
13253 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13256 struct glyph_row
*row
;
13258 /* Handle the case that the window start is out of range. */
13259 if (CHARPOS (start_pos
) < BEGV
)
13260 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13261 else if (CHARPOS (start_pos
) > ZV
)
13262 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13264 /* Find the start of the continued line. This should be fast
13265 because scan_buffer is fast (newline cache). */
13266 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13267 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13268 row
, DEFAULT_FACE_ID
);
13269 reseat_at_previous_visible_line_start (&it
);
13271 /* If the line start is "too far" away from the window start,
13272 say it takes too much time to compute a new window start. */
13273 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13274 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13276 int min_distance
, distance
;
13278 /* Move forward by display lines to find the new window
13279 start. If window width was enlarged, the new start can
13280 be expected to be > the old start. If window width was
13281 decreased, the new window start will be < the old start.
13282 So, we're looking for the display line start with the
13283 minimum distance from the old window start. */
13284 pos
= it
.current
.pos
;
13285 min_distance
= INFINITY
;
13286 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13287 distance
< min_distance
)
13289 min_distance
= distance
;
13290 pos
= it
.current
.pos
;
13291 move_it_by_lines (&it
, 1);
13294 /* Set the window start there. */
13295 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13296 window_start_changed_p
= 1;
13300 return window_start_changed_p
;
13304 /* Try cursor movement in case text has not changed in window WINDOW,
13305 with window start STARTP. Value is
13307 CURSOR_MOVEMENT_SUCCESS if successful
13309 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13311 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13312 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13313 we want to scroll as if scroll-step were set to 1. See the code.
13315 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13316 which case we have to abort this redisplay, and adjust matrices
13321 CURSOR_MOVEMENT_SUCCESS
,
13322 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13323 CURSOR_MOVEMENT_MUST_SCROLL
,
13324 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13328 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13330 struct window
*w
= XWINDOW (window
);
13331 struct frame
*f
= XFRAME (w
->frame
);
13332 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13335 if (inhibit_try_cursor_movement
)
13339 /* Handle case where text has not changed, only point, and it has
13340 not moved off the frame. */
13341 if (/* Point may be in this window. */
13342 PT
>= CHARPOS (startp
)
13343 /* Selective display hasn't changed. */
13344 && !current_buffer
->clip_changed
13345 /* Function force-mode-line-update is used to force a thorough
13346 redisplay. It sets either windows_or_buffers_changed or
13347 update_mode_lines. So don't take a shortcut here for these
13349 && !update_mode_lines
13350 && !windows_or_buffers_changed
13351 && !cursor_type_changed
13352 /* Can't use this case if highlighting a region. When a
13353 region exists, cursor movement has to do more than just
13355 && !(!NILP (Vtransient_mark_mode
)
13356 && !NILP (BVAR (current_buffer
, mark_active
)))
13357 && NILP (w
->region_showing
)
13358 && NILP (Vshow_trailing_whitespace
)
13359 /* Right after splitting windows, last_point may be nil. */
13360 && INTEGERP (w
->last_point
)
13361 /* This code is not used for mini-buffer for the sake of the case
13362 of redisplaying to replace an echo area message; since in
13363 that case the mini-buffer contents per se are usually
13364 unchanged. This code is of no real use in the mini-buffer
13365 since the handling of this_line_start_pos, etc., in redisplay
13366 handles the same cases. */
13367 && !EQ (window
, minibuf_window
)
13368 /* When splitting windows or for new windows, it happens that
13369 redisplay is called with a nil window_end_vpos or one being
13370 larger than the window. This should really be fixed in
13371 window.c. I don't have this on my list, now, so we do
13372 approximately the same as the old redisplay code. --gerd. */
13373 && INTEGERP (w
->window_end_vpos
)
13374 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13375 && (FRAME_WINDOW_P (f
)
13376 || !overlay_arrow_in_current_buffer_p ()))
13378 int this_scroll_margin
, top_scroll_margin
;
13379 struct glyph_row
*row
= NULL
;
13382 debug_method_add (w
, "cursor movement");
13385 /* Scroll if point within this distance from the top or bottom
13386 of the window. This is a pixel value. */
13387 if (scroll_margin
> 0)
13389 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13390 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13393 this_scroll_margin
= 0;
13395 top_scroll_margin
= this_scroll_margin
;
13396 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13397 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13399 /* Start with the row the cursor was displayed during the last
13400 not paused redisplay. Give up if that row is not valid. */
13401 if (w
->last_cursor
.vpos
< 0
13402 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13403 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13406 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13407 if (row
->mode_line_p
)
13409 if (!row
->enabled_p
)
13410 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13413 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13415 int scroll_p
= 0, must_scroll
= 0;
13416 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13418 if (PT
> XFASTINT (w
->last_point
))
13420 /* Point has moved forward. */
13421 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13422 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13424 xassert (row
->enabled_p
);
13428 /* If the end position of a row equals the start
13429 position of the next row, and PT is at that position,
13430 we would rather display cursor in the next line. */
13431 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13432 && MATRIX_ROW_END_CHARPOS (row
) == PT
13433 && row
< w
->current_matrix
->rows
13434 + w
->current_matrix
->nrows
- 1
13435 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13436 && !cursor_row_p (row
))
13439 /* If within the scroll margin, scroll. Note that
13440 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13441 the next line would be drawn, and that
13442 this_scroll_margin can be zero. */
13443 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13444 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13445 /* Line is completely visible last line in window
13446 and PT is to be set in the next line. */
13447 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13448 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13449 && !row
->ends_at_zv_p
13450 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13453 else if (PT
< XFASTINT (w
->last_point
))
13455 /* Cursor has to be moved backward. Note that PT >=
13456 CHARPOS (startp) because of the outer if-statement. */
13457 while (!row
->mode_line_p
13458 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13459 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13460 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13461 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13462 row
> w
->current_matrix
->rows
13463 && (row
-1)->ends_in_newline_from_string_p
))))
13464 && (row
->y
> top_scroll_margin
13465 || CHARPOS (startp
) == BEGV
))
13467 xassert (row
->enabled_p
);
13471 /* Consider the following case: Window starts at BEGV,
13472 there is invisible, intangible text at BEGV, so that
13473 display starts at some point START > BEGV. It can
13474 happen that we are called with PT somewhere between
13475 BEGV and START. Try to handle that case. */
13476 if (row
< w
->current_matrix
->rows
13477 || row
->mode_line_p
)
13479 row
= w
->current_matrix
->rows
;
13480 if (row
->mode_line_p
)
13484 /* Due to newlines in overlay strings, we may have to
13485 skip forward over overlay strings. */
13486 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13487 && MATRIX_ROW_END_CHARPOS (row
) == PT
13488 && !cursor_row_p (row
))
13491 /* If within the scroll margin, scroll. */
13492 if (row
->y
< top_scroll_margin
13493 && CHARPOS (startp
) != BEGV
)
13498 /* Cursor did not move. So don't scroll even if cursor line
13499 is partially visible, as it was so before. */
13500 rc
= CURSOR_MOVEMENT_SUCCESS
;
13503 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13504 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13506 /* if PT is not in the glyph row, give up. */
13507 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13510 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13511 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13513 /* If rows are bidi-reordered and point moved, back up
13514 until we find a row that does not belong to a
13515 continuation line. This is because we must consider
13516 all rows of a continued line as candidates for the
13517 new cursor positioning, since row start and end
13518 positions change non-linearly with vertical position
13520 /* FIXME: Revisit this when glyph ``spilling'' in
13521 continuation lines' rows is implemented for
13522 bidi-reordered rows. */
13523 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13525 xassert (row
->enabled_p
);
13527 /* If we hit the beginning of the displayed portion
13528 without finding the first row of a continued
13530 if (row
<= w
->current_matrix
->rows
)
13532 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13540 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13541 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13542 && make_cursor_line_fully_visible_p
)
13544 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13545 && !row
->ends_at_zv_p
13546 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13547 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13548 else if (row
->height
> window_box_height (w
))
13550 /* If we end up in a partially visible line, let's
13551 make it fully visible, except when it's taller
13552 than the window, in which case we can't do much
13555 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13559 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13560 if (!cursor_row_fully_visible_p (w
, 0, 1))
13561 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13563 rc
= CURSOR_MOVEMENT_SUCCESS
;
13567 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13568 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13569 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13571 /* With bidi-reordered rows, there could be more than
13572 one candidate row whose start and end positions
13573 occlude point. We need to let set_cursor_from_row
13574 find the best candidate. */
13575 /* FIXME: Revisit this when glyph ``spilling'' in
13576 continuation lines' rows is implemented for
13577 bidi-reordered rows. */
13582 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13583 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13584 && cursor_row_p (row
))
13585 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13587 /* As soon as we've found the first suitable row
13588 whose ends_at_zv_p flag is set, we are done. */
13590 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13592 rc
= CURSOR_MOVEMENT_SUCCESS
;
13597 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13598 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13599 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13600 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13601 /* If we didn't find any candidate rows, or exited the
13602 loop before all the candidates were examined, signal
13603 to the caller that this method failed. */
13604 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13605 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13608 rc
= CURSOR_MOVEMENT_SUCCESS
;
13614 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13616 rc
= CURSOR_MOVEMENT_SUCCESS
;
13621 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13622 && MATRIX_ROW_START_CHARPOS (row
) == PT
13623 && cursor_row_p (row
));
13631 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13635 set_vertical_scroll_bar (struct window
*w
)
13637 EMACS_INT start
, end
, whole
;
13639 /* Calculate the start and end positions for the current window.
13640 At some point, it would be nice to choose between scrollbars
13641 which reflect the whole buffer size, with special markers
13642 indicating narrowing, and scrollbars which reflect only the
13645 Note that mini-buffers sometimes aren't displaying any text. */
13646 if (!MINI_WINDOW_P (w
)
13647 || (w
== XWINDOW (minibuf_window
)
13648 && NILP (echo_area_buffer
[0])))
13650 struct buffer
*buf
= XBUFFER (w
->buffer
);
13651 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13652 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13653 /* I don't think this is guaranteed to be right. For the
13654 moment, we'll pretend it is. */
13655 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13659 if (whole
< (end
- start
))
13660 whole
= end
- start
;
13663 start
= end
= whole
= 0;
13665 /* Indicate what this scroll bar ought to be displaying now. */
13666 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13667 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13668 (w
, end
- start
, whole
, start
);
13672 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13673 selected_window is redisplayed.
13675 We can return without actually redisplaying the window if
13676 fonts_changed_p is nonzero. In that case, redisplay_internal will
13680 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13682 struct window
*w
= XWINDOW (window
);
13683 struct frame
*f
= XFRAME (w
->frame
);
13684 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13685 struct buffer
*old
= current_buffer
;
13686 struct text_pos lpoint
, opoint
, startp
;
13687 int update_mode_line
;
13690 /* Record it now because it's overwritten. */
13691 int current_matrix_up_to_date_p
= 0;
13692 int used_current_matrix_p
= 0;
13693 /* This is less strict than current_matrix_up_to_date_p.
13694 It indictes that the buffer contents and narrowing are unchanged. */
13695 int buffer_unchanged_p
= 0;
13696 int temp_scroll_step
= 0;
13697 int count
= SPECPDL_INDEX ();
13699 int centering_position
= -1;
13700 int last_line_misfit
= 0;
13701 EMACS_INT beg_unchanged
, end_unchanged
;
13703 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13706 /* W must be a leaf window here. */
13707 xassert (!NILP (w
->buffer
));
13709 *w
->desired_matrix
->method
= 0;
13713 reconsider_clip_changes (w
, buffer
);
13715 /* Has the mode line to be updated? */
13716 update_mode_line
= (!NILP (w
->update_mode_line
)
13717 || update_mode_lines
13718 || buffer
->clip_changed
13719 || buffer
->prevent_redisplay_optimizations_p
);
13721 if (MINI_WINDOW_P (w
))
13723 if (w
== XWINDOW (echo_area_window
)
13724 && !NILP (echo_area_buffer
[0]))
13726 if (update_mode_line
)
13727 /* We may have to update a tty frame's menu bar or a
13728 tool-bar. Example `M-x C-h C-h C-g'. */
13729 goto finish_menu_bars
;
13731 /* We've already displayed the echo area glyphs in this window. */
13732 goto finish_scroll_bars
;
13734 else if ((w
!= XWINDOW (minibuf_window
)
13735 || minibuf_level
== 0)
13736 /* When buffer is nonempty, redisplay window normally. */
13737 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13738 /* Quail displays non-mini buffers in minibuffer window.
13739 In that case, redisplay the window normally. */
13740 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13742 /* W is a mini-buffer window, but it's not active, so clear
13744 int yb
= window_text_bottom_y (w
);
13745 struct glyph_row
*row
;
13748 for (y
= 0, row
= w
->desired_matrix
->rows
;
13750 y
+= row
->height
, ++row
)
13751 blank_row (w
, row
, y
);
13752 goto finish_scroll_bars
;
13755 clear_glyph_matrix (w
->desired_matrix
);
13758 /* Otherwise set up data on this window; select its buffer and point
13760 /* Really select the buffer, for the sake of buffer-local
13762 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13764 current_matrix_up_to_date_p
13765 = (!NILP (w
->window_end_valid
)
13766 && !current_buffer
->clip_changed
13767 && !current_buffer
->prevent_redisplay_optimizations_p
13768 && XFASTINT (w
->last_modified
) >= MODIFF
13769 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13771 /* Run the window-bottom-change-functions
13772 if it is possible that the text on the screen has changed
13773 (either due to modification of the text, or any other reason). */
13774 if (!current_matrix_up_to_date_p
13775 && !NILP (Vwindow_text_change_functions
))
13777 safe_run_hooks (Qwindow_text_change_functions
);
13781 beg_unchanged
= BEG_UNCHANGED
;
13782 end_unchanged
= END_UNCHANGED
;
13784 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13786 specbind (Qinhibit_point_motion_hooks
, Qt
);
13789 = (!NILP (w
->window_end_valid
)
13790 && !current_buffer
->clip_changed
13791 && XFASTINT (w
->last_modified
) >= MODIFF
13792 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13794 /* When windows_or_buffers_changed is non-zero, we can't rely on
13795 the window end being valid, so set it to nil there. */
13796 if (windows_or_buffers_changed
)
13798 /* If window starts on a continuation line, maybe adjust the
13799 window start in case the window's width changed. */
13800 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13801 compute_window_start_on_continuation_line (w
);
13803 w
->window_end_valid
= Qnil
;
13806 /* Some sanity checks. */
13807 CHECK_WINDOW_END (w
);
13808 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13810 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13813 /* If %c is in mode line, update it if needed. */
13814 if (!NILP (w
->column_number_displayed
)
13815 /* This alternative quickly identifies a common case
13816 where no change is needed. */
13817 && !(PT
== XFASTINT (w
->last_point
)
13818 && XFASTINT (w
->last_modified
) >= MODIFF
13819 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13820 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13821 update_mode_line
= 1;
13823 /* Count number of windows showing the selected buffer. An indirect
13824 buffer counts as its base buffer. */
13825 if (!just_this_one_p
)
13827 struct buffer
*current_base
, *window_base
;
13828 current_base
= current_buffer
;
13829 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13830 if (current_base
->base_buffer
)
13831 current_base
= current_base
->base_buffer
;
13832 if (window_base
->base_buffer
)
13833 window_base
= window_base
->base_buffer
;
13834 if (current_base
== window_base
)
13838 /* Point refers normally to the selected window. For any other
13839 window, set up appropriate value. */
13840 if (!EQ (window
, selected_window
))
13842 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13843 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13847 new_pt_byte
= BEGV_BYTE
;
13848 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13850 else if (new_pt
> (ZV
- 1))
13853 new_pt_byte
= ZV_BYTE
;
13854 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13857 /* We don't use SET_PT so that the point-motion hooks don't run. */
13858 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13861 /* If any of the character widths specified in the display table
13862 have changed, invalidate the width run cache. It's true that
13863 this may be a bit late to catch such changes, but the rest of
13864 redisplay goes (non-fatally) haywire when the display table is
13865 changed, so why should we worry about doing any better? */
13866 if (current_buffer
->width_run_cache
)
13868 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13870 if (! disptab_matches_widthtab (disptab
,
13871 XVECTOR (BVAR (current_buffer
, width_table
))))
13873 invalidate_region_cache (current_buffer
,
13874 current_buffer
->width_run_cache
,
13876 recompute_width_table (current_buffer
, disptab
);
13880 /* If window-start is screwed up, choose a new one. */
13881 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13884 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13886 /* If someone specified a new starting point but did not insist,
13887 check whether it can be used. */
13888 if (!NILP (w
->optional_new_start
)
13889 && CHARPOS (startp
) >= BEGV
13890 && CHARPOS (startp
) <= ZV
)
13892 w
->optional_new_start
= Qnil
;
13893 start_display (&it
, w
, startp
);
13894 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13895 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13896 if (IT_CHARPOS (it
) == PT
)
13897 w
->force_start
= Qt
;
13898 /* IT may overshoot PT if text at PT is invisible. */
13899 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13900 w
->force_start
= Qt
;
13905 /* Handle case where place to start displaying has been specified,
13906 unless the specified location is outside the accessible range. */
13907 if (!NILP (w
->force_start
)
13908 || w
->frozen_window_start_p
)
13910 /* We set this later on if we have to adjust point. */
13913 w
->force_start
= Qnil
;
13915 w
->window_end_valid
= Qnil
;
13917 /* Forget any recorded base line for line number display. */
13918 if (!buffer_unchanged_p
)
13919 w
->base_line_number
= Qnil
;
13921 /* Redisplay the mode line. Select the buffer properly for that.
13922 Also, run the hook window-scroll-functions
13923 because we have scrolled. */
13924 /* Note, we do this after clearing force_start because
13925 if there's an error, it is better to forget about force_start
13926 than to get into an infinite loop calling the hook functions
13927 and having them get more errors. */
13928 if (!update_mode_line
13929 || ! NILP (Vwindow_scroll_functions
))
13931 update_mode_line
= 1;
13932 w
->update_mode_line
= Qt
;
13933 startp
= run_window_scroll_functions (window
, startp
);
13936 w
->last_modified
= make_number (0);
13937 w
->last_overlay_modified
= make_number (0);
13938 if (CHARPOS (startp
) < BEGV
)
13939 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13940 else if (CHARPOS (startp
) > ZV
)
13941 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13943 /* Redisplay, then check if cursor has been set during the
13944 redisplay. Give up if new fonts were loaded. */
13945 /* We used to issue a CHECK_MARGINS argument to try_window here,
13946 but this causes scrolling to fail when point begins inside
13947 the scroll margin (bug#148) -- cyd */
13948 if (!try_window (window
, startp
, 0))
13950 w
->force_start
= Qt
;
13951 clear_glyph_matrix (w
->desired_matrix
);
13952 goto need_larger_matrices
;
13955 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13957 /* If point does not appear, try to move point so it does
13958 appear. The desired matrix has been built above, so we
13959 can use it here. */
13960 new_vpos
= window_box_height (w
) / 2;
13963 if (!cursor_row_fully_visible_p (w
, 0, 0))
13965 /* Point does appear, but on a line partly visible at end of window.
13966 Move it back to a fully-visible line. */
13967 new_vpos
= window_box_height (w
);
13970 /* If we need to move point for either of the above reasons,
13971 now actually do it. */
13974 struct glyph_row
*row
;
13976 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13977 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13980 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13981 MATRIX_ROW_START_BYTEPOS (row
));
13983 if (w
!= XWINDOW (selected_window
))
13984 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13985 else if (current_buffer
== old
)
13986 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13988 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13990 /* If we are highlighting the region, then we just changed
13991 the region, so redisplay to show it. */
13992 if (!NILP (Vtransient_mark_mode
)
13993 && !NILP (BVAR (current_buffer
, mark_active
)))
13995 clear_glyph_matrix (w
->desired_matrix
);
13996 if (!try_window (window
, startp
, 0))
13997 goto need_larger_matrices
;
14002 debug_method_add (w
, "forced window start");
14007 /* Handle case where text has not changed, only point, and it has
14008 not moved off the frame, and we are not retrying after hscroll.
14009 (current_matrix_up_to_date_p is nonzero when retrying.) */
14010 if (current_matrix_up_to_date_p
14011 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14012 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14016 case CURSOR_MOVEMENT_SUCCESS
:
14017 used_current_matrix_p
= 1;
14020 case CURSOR_MOVEMENT_MUST_SCROLL
:
14021 goto try_to_scroll
;
14027 /* If current starting point was originally the beginning of a line
14028 but no longer is, find a new starting point. */
14029 else if (!NILP (w
->start_at_line_beg
)
14030 && !(CHARPOS (startp
) <= BEGV
14031 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14034 debug_method_add (w
, "recenter 1");
14039 /* Try scrolling with try_window_id. Value is > 0 if update has
14040 been done, it is -1 if we know that the same window start will
14041 not work. It is 0 if unsuccessful for some other reason. */
14042 else if ((tem
= try_window_id (w
)) != 0)
14045 debug_method_add (w
, "try_window_id %d", tem
);
14048 if (fonts_changed_p
)
14049 goto need_larger_matrices
;
14053 /* Otherwise try_window_id has returned -1 which means that we
14054 don't want the alternative below this comment to execute. */
14056 else if (CHARPOS (startp
) >= BEGV
14057 && CHARPOS (startp
) <= ZV
14058 && PT
>= CHARPOS (startp
)
14059 && (CHARPOS (startp
) < ZV
14060 /* Avoid starting at end of buffer. */
14061 || CHARPOS (startp
) == BEGV
14062 || (XFASTINT (w
->last_modified
) >= MODIFF
14063 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14066 /* If first window line is a continuation line, and window start
14067 is inside the modified region, but the first change is before
14068 current window start, we must select a new window start.
14070 However, if this is the result of a down-mouse event (e.g. by
14071 extending the mouse-drag-overlay), we don't want to select a
14072 new window start, since that would change the position under
14073 the mouse, resulting in an unwanted mouse-movement rather
14074 than a simple mouse-click. */
14075 if (NILP (w
->start_at_line_beg
)
14076 && NILP (do_mouse_tracking
)
14077 && CHARPOS (startp
) > BEGV
14078 && CHARPOS (startp
) > BEG
+ beg_unchanged
14079 && CHARPOS (startp
) <= Z
- end_unchanged
14080 /* Even if w->start_at_line_beg is nil, a new window may
14081 start at a line_beg, since that's how set_buffer_window
14082 sets it. So, we need to check the return value of
14083 compute_window_start_on_continuation_line. (See also
14085 && XMARKER (w
->start
)->buffer
== current_buffer
14086 && compute_window_start_on_continuation_line (w
))
14088 w
->force_start
= Qt
;
14089 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14094 debug_method_add (w
, "same window start");
14097 /* Try to redisplay starting at same place as before.
14098 If point has not moved off frame, accept the results. */
14099 if (!current_matrix_up_to_date_p
14100 /* Don't use try_window_reusing_current_matrix in this case
14101 because a window scroll function can have changed the
14103 || !NILP (Vwindow_scroll_functions
)
14104 || MINI_WINDOW_P (w
)
14105 || !(used_current_matrix_p
14106 = try_window_reusing_current_matrix (w
)))
14108 IF_DEBUG (debug_method_add (w
, "1"));
14109 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14110 /* -1 means we need to scroll.
14111 0 means we need new matrices, but fonts_changed_p
14112 is set in that case, so we will detect it below. */
14113 goto try_to_scroll
;
14116 if (fonts_changed_p
)
14117 goto need_larger_matrices
;
14119 if (w
->cursor
.vpos
>= 0)
14121 if (!just_this_one_p
14122 || current_buffer
->clip_changed
14123 || BEG_UNCHANGED
< CHARPOS (startp
))
14124 /* Forget any recorded base line for line number display. */
14125 w
->base_line_number
= Qnil
;
14127 if (!cursor_row_fully_visible_p (w
, 1, 0))
14129 clear_glyph_matrix (w
->desired_matrix
);
14130 last_line_misfit
= 1;
14132 /* Drop through and scroll. */
14137 clear_glyph_matrix (w
->desired_matrix
);
14142 w
->last_modified
= make_number (0);
14143 w
->last_overlay_modified
= make_number (0);
14145 /* Redisplay the mode line. Select the buffer properly for that. */
14146 if (!update_mode_line
)
14148 update_mode_line
= 1;
14149 w
->update_mode_line
= Qt
;
14152 /* Try to scroll by specified few lines. */
14153 if ((scroll_conservatively
14154 || emacs_scroll_step
14155 || temp_scroll_step
14156 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14157 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14158 && CHARPOS (startp
) >= BEGV
14159 && CHARPOS (startp
) <= ZV
)
14161 /* The function returns -1 if new fonts were loaded, 1 if
14162 successful, 0 if not successful. */
14163 int ss
= try_scrolling (window
, just_this_one_p
,
14164 scroll_conservatively
,
14166 temp_scroll_step
, last_line_misfit
);
14169 case SCROLLING_SUCCESS
:
14172 case SCROLLING_NEED_LARGER_MATRICES
:
14173 goto need_larger_matrices
;
14175 case SCROLLING_FAILED
:
14183 /* Finally, just choose a place to start which positions point
14184 according to user preferences. */
14189 debug_method_add (w
, "recenter");
14192 /* w->vscroll = 0; */
14194 /* Forget any previously recorded base line for line number display. */
14195 if (!buffer_unchanged_p
)
14196 w
->base_line_number
= Qnil
;
14198 /* Determine the window start relative to point. */
14199 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14200 it
.current_y
= it
.last_visible_y
;
14201 if (centering_position
< 0)
14205 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14207 EMACS_INT margin_pos
= CHARPOS (startp
);
14209 Lisp_Object aggressive
;
14211 /* If there is a scroll margin at the top of the window, find
14212 its character position. */
14214 /* Cannot call start_display if startp is not in the
14215 accessible region of the buffer. This can happen when we
14216 have just switched to a different buffer and/or changed
14217 its restriction. In that case, startp is initialized to
14218 the character position 1 (BEG) because we did not yet
14219 have chance to display the buffer even once. */
14220 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14224 start_display (&it1
, w
, startp
);
14225 move_it_vertically (&it1
, margin
);
14226 margin_pos
= IT_CHARPOS (it1
);
14228 scrolling_up
= PT
> margin_pos
;
14231 ? BVAR (current_buffer
, scroll_up_aggressively
)
14232 : BVAR (current_buffer
, scroll_down_aggressively
);
14234 if (!MINI_WINDOW_P (w
)
14235 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14239 /* Setting scroll-conservatively overrides
14240 scroll-*-aggressively. */
14241 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14243 double float_amount
= XFLOATINT (aggressive
);
14245 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14246 if (pt_offset
== 0 && float_amount
> 0)
14251 /* Compute how much to move the window start backward from
14252 point so that point will be displayed where the user
14256 centering_position
= it
.last_visible_y
;
14258 centering_position
-= pt_offset
;
14259 centering_position
-=
14260 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14261 /* Don't let point enter the scroll margin near top of
14263 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14264 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14267 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14270 /* Set the window start half the height of the window backward
14272 centering_position
= window_box_height (w
) / 2;
14274 move_it_vertically_backward (&it
, centering_position
);
14276 xassert (IT_CHARPOS (it
) >= BEGV
);
14278 /* The function move_it_vertically_backward may move over more
14279 than the specified y-distance. If it->w is small, e.g. a
14280 mini-buffer window, we may end up in front of the window's
14281 display area. Start displaying at the start of the line
14282 containing PT in this case. */
14283 if (it
.current_y
<= 0)
14285 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14286 move_it_vertically_backward (&it
, 0);
14290 it
.current_x
= it
.hpos
= 0;
14292 /* Set the window start position here explicitly, to avoid an
14293 infinite loop in case the functions in window-scroll-functions
14295 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14297 /* Run scroll hooks. */
14298 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14300 /* Redisplay the window. */
14301 if (!current_matrix_up_to_date_p
14302 || windows_or_buffers_changed
14303 || cursor_type_changed
14304 /* Don't use try_window_reusing_current_matrix in this case
14305 because it can have changed the buffer. */
14306 || !NILP (Vwindow_scroll_functions
)
14307 || !just_this_one_p
14308 || MINI_WINDOW_P (w
)
14309 || !(used_current_matrix_p
14310 = try_window_reusing_current_matrix (w
)))
14311 try_window (window
, startp
, 0);
14313 /* If new fonts have been loaded (due to fontsets), give up. We
14314 have to start a new redisplay since we need to re-adjust glyph
14316 if (fonts_changed_p
)
14317 goto need_larger_matrices
;
14319 /* If cursor did not appear assume that the middle of the window is
14320 in the first line of the window. Do it again with the next line.
14321 (Imagine a window of height 100, displaying two lines of height
14322 60. Moving back 50 from it->last_visible_y will end in the first
14324 if (w
->cursor
.vpos
< 0)
14326 if (!NILP (w
->window_end_valid
)
14327 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14329 clear_glyph_matrix (w
->desired_matrix
);
14330 move_it_by_lines (&it
, 1);
14331 try_window (window
, it
.current
.pos
, 0);
14333 else if (PT
< IT_CHARPOS (it
))
14335 clear_glyph_matrix (w
->desired_matrix
);
14336 move_it_by_lines (&it
, -1);
14337 try_window (window
, it
.current
.pos
, 0);
14341 /* Not much we can do about it. */
14345 /* Consider the following case: Window starts at BEGV, there is
14346 invisible, intangible text at BEGV, so that display starts at
14347 some point START > BEGV. It can happen that we are called with
14348 PT somewhere between BEGV and START. Try to handle that case. */
14349 if (w
->cursor
.vpos
< 0)
14351 struct glyph_row
*row
= w
->current_matrix
->rows
;
14352 if (row
->mode_line_p
)
14354 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14357 if (!cursor_row_fully_visible_p (w
, 0, 0))
14359 /* If vscroll is enabled, disable it and try again. */
14363 clear_glyph_matrix (w
->desired_matrix
);
14367 /* If centering point failed to make the whole line visible,
14368 put point at the top instead. That has to make the whole line
14369 visible, if it can be done. */
14370 if (centering_position
== 0)
14373 clear_glyph_matrix (w
->desired_matrix
);
14374 centering_position
= 0;
14380 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14381 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14382 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14385 /* Display the mode line, if we must. */
14386 if ((update_mode_line
14387 /* If window not full width, must redo its mode line
14388 if (a) the window to its side is being redone and
14389 (b) we do a frame-based redisplay. This is a consequence
14390 of how inverted lines are drawn in frame-based redisplay. */
14391 || (!just_this_one_p
14392 && !FRAME_WINDOW_P (f
)
14393 && !WINDOW_FULL_WIDTH_P (w
))
14394 /* Line number to display. */
14395 || INTEGERP (w
->base_line_pos
)
14396 /* Column number is displayed and different from the one displayed. */
14397 || (!NILP (w
->column_number_displayed
)
14398 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14399 /* This means that the window has a mode line. */
14400 && (WINDOW_WANTS_MODELINE_P (w
)
14401 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14403 display_mode_lines (w
);
14405 /* If mode line height has changed, arrange for a thorough
14406 immediate redisplay using the correct mode line height. */
14407 if (WINDOW_WANTS_MODELINE_P (w
)
14408 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14410 fonts_changed_p
= 1;
14411 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14412 = DESIRED_MODE_LINE_HEIGHT (w
);
14415 /* If header line height has changed, arrange for a thorough
14416 immediate redisplay using the correct header line height. */
14417 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14418 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14420 fonts_changed_p
= 1;
14421 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14422 = DESIRED_HEADER_LINE_HEIGHT (w
);
14425 if (fonts_changed_p
)
14426 goto need_larger_matrices
;
14429 if (!line_number_displayed
14430 && !BUFFERP (w
->base_line_pos
))
14432 w
->base_line_pos
= Qnil
;
14433 w
->base_line_number
= Qnil
;
14438 /* When we reach a frame's selected window, redo the frame's menu bar. */
14439 if (update_mode_line
14440 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14442 int redisplay_menu_p
= 0;
14444 if (FRAME_WINDOW_P (f
))
14446 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14447 || defined (HAVE_NS) || defined (USE_GTK)
14448 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14450 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14454 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14456 if (redisplay_menu_p
)
14457 display_menu_bar (w
);
14459 #ifdef HAVE_WINDOW_SYSTEM
14460 if (FRAME_WINDOW_P (f
))
14462 #if defined (USE_GTK) || defined (HAVE_NS)
14463 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14464 redisplay_tool_bar (f
);
14466 if (WINDOWP (f
->tool_bar_window
)
14467 && (FRAME_TOOL_BAR_LINES (f
) > 0
14468 || !NILP (Vauto_resize_tool_bars
))
14469 && redisplay_tool_bar (f
))
14470 ignore_mouse_drag_p
= 1;
14476 #ifdef HAVE_WINDOW_SYSTEM
14477 if (FRAME_WINDOW_P (f
)
14478 && update_window_fringes (w
, (just_this_one_p
14479 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14480 || w
->pseudo_window_p
)))
14484 if (draw_window_fringes (w
, 1))
14485 x_draw_vertical_border (w
);
14489 #endif /* HAVE_WINDOW_SYSTEM */
14491 /* We go to this label, with fonts_changed_p nonzero,
14492 if it is necessary to try again using larger glyph matrices.
14493 We have to redeem the scroll bar even in this case,
14494 because the loop in redisplay_internal expects that. */
14495 need_larger_matrices
:
14497 finish_scroll_bars
:
14499 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14501 /* Set the thumb's position and size. */
14502 set_vertical_scroll_bar (w
);
14504 /* Note that we actually used the scroll bar attached to this
14505 window, so it shouldn't be deleted at the end of redisplay. */
14506 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14507 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14510 /* Restore current_buffer and value of point in it. The window
14511 update may have changed the buffer, so first make sure `opoint'
14512 is still valid (Bug#6177). */
14513 if (CHARPOS (opoint
) < BEGV
)
14514 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14515 else if (CHARPOS (opoint
) > ZV
)
14516 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14518 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14520 set_buffer_internal_1 (old
);
14521 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14522 shorter. This can be caused by log truncation in *Messages*. */
14523 if (CHARPOS (lpoint
) <= ZV
)
14524 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14526 unbind_to (count
, Qnil
);
14530 /* Build the complete desired matrix of WINDOW with a window start
14531 buffer position POS.
14533 Value is 1 if successful. It is zero if fonts were loaded during
14534 redisplay which makes re-adjusting glyph matrices necessary, and -1
14535 if point would appear in the scroll margins.
14536 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14537 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14541 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14543 struct window
*w
= XWINDOW (window
);
14545 struct glyph_row
*last_text_row
= NULL
;
14546 struct frame
*f
= XFRAME (w
->frame
);
14548 /* Make POS the new window start. */
14549 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14551 /* Mark cursor position as unknown. No overlay arrow seen. */
14552 w
->cursor
.vpos
= -1;
14553 overlay_arrow_seen
= 0;
14555 /* Initialize iterator and info to start at POS. */
14556 start_display (&it
, w
, pos
);
14558 /* Display all lines of W. */
14559 while (it
.current_y
< it
.last_visible_y
)
14561 if (display_line (&it
))
14562 last_text_row
= it
.glyph_row
- 1;
14563 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14567 /* Don't let the cursor end in the scroll margins. */
14568 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14569 && !MINI_WINDOW_P (w
))
14571 int this_scroll_margin
;
14573 if (scroll_margin
> 0)
14575 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14576 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14579 this_scroll_margin
= 0;
14581 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14582 && w
->cursor
.y
< this_scroll_margin
14583 && CHARPOS (pos
) > BEGV
14584 && IT_CHARPOS (it
) < ZV
)
14585 /* rms: considering make_cursor_line_fully_visible_p here
14586 seems to give wrong results. We don't want to recenter
14587 when the last line is partly visible, we want to allow
14588 that case to be handled in the usual way. */
14589 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14591 w
->cursor
.vpos
= -1;
14592 clear_glyph_matrix (w
->desired_matrix
);
14597 /* If bottom moved off end of frame, change mode line percentage. */
14598 if (XFASTINT (w
->window_end_pos
) <= 0
14599 && Z
!= IT_CHARPOS (it
))
14600 w
->update_mode_line
= Qt
;
14602 /* Set window_end_pos to the offset of the last character displayed
14603 on the window from the end of current_buffer. Set
14604 window_end_vpos to its row number. */
14607 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14608 w
->window_end_bytepos
14609 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14611 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14613 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14614 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14615 ->displays_text_p
);
14619 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14620 w
->window_end_pos
= make_number (Z
- ZV
);
14621 w
->window_end_vpos
= make_number (0);
14624 /* But that is not valid info until redisplay finishes. */
14625 w
->window_end_valid
= Qnil
;
14631 /************************************************************************
14632 Window redisplay reusing current matrix when buffer has not changed
14633 ************************************************************************/
14635 /* Try redisplay of window W showing an unchanged buffer with a
14636 different window start than the last time it was displayed by
14637 reusing its current matrix. Value is non-zero if successful.
14638 W->start is the new window start. */
14641 try_window_reusing_current_matrix (struct window
*w
)
14643 struct frame
*f
= XFRAME (w
->frame
);
14644 struct glyph_row
*bottom_row
;
14647 struct text_pos start
, new_start
;
14648 int nrows_scrolled
, i
;
14649 struct glyph_row
*last_text_row
;
14650 struct glyph_row
*last_reused_text_row
;
14651 struct glyph_row
*start_row
;
14652 int start_vpos
, min_y
, max_y
;
14655 if (inhibit_try_window_reusing
)
14659 if (/* This function doesn't handle terminal frames. */
14660 !FRAME_WINDOW_P (f
)
14661 /* Don't try to reuse the display if windows have been split
14663 || windows_or_buffers_changed
14664 || cursor_type_changed
)
14667 /* Can't do this if region may have changed. */
14668 if ((!NILP (Vtransient_mark_mode
)
14669 && !NILP (BVAR (current_buffer
, mark_active
)))
14670 || !NILP (w
->region_showing
)
14671 || !NILP (Vshow_trailing_whitespace
))
14674 /* If top-line visibility has changed, give up. */
14675 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14676 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14679 /* Give up if old or new display is scrolled vertically. We could
14680 make this function handle this, but right now it doesn't. */
14681 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14682 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14685 /* The variable new_start now holds the new window start. The old
14686 start `start' can be determined from the current matrix. */
14687 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14688 start
= start_row
->minpos
;
14689 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14691 /* Clear the desired matrix for the display below. */
14692 clear_glyph_matrix (w
->desired_matrix
);
14694 if (CHARPOS (new_start
) <= CHARPOS (start
))
14696 /* Don't use this method if the display starts with an ellipsis
14697 displayed for invisible text. It's not easy to handle that case
14698 below, and it's certainly not worth the effort since this is
14699 not a frequent case. */
14700 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14703 IF_DEBUG (debug_method_add (w
, "twu1"));
14705 /* Display up to a row that can be reused. The variable
14706 last_text_row is set to the last row displayed that displays
14707 text. Note that it.vpos == 0 if or if not there is a
14708 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14709 start_display (&it
, w
, new_start
);
14710 w
->cursor
.vpos
= -1;
14711 last_text_row
= last_reused_text_row
= NULL
;
14713 while (it
.current_y
< it
.last_visible_y
14714 && !fonts_changed_p
)
14716 /* If we have reached into the characters in the START row,
14717 that means the line boundaries have changed. So we
14718 can't start copying with the row START. Maybe it will
14719 work to start copying with the following row. */
14720 while (IT_CHARPOS (it
) > CHARPOS (start
))
14722 /* Advance to the next row as the "start". */
14724 start
= start_row
->minpos
;
14725 /* If there are no more rows to try, or just one, give up. */
14726 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14727 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14728 || CHARPOS (start
) == ZV
)
14730 clear_glyph_matrix (w
->desired_matrix
);
14734 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14736 /* If we have reached alignment,
14737 we can copy the rest of the rows. */
14738 if (IT_CHARPOS (it
) == CHARPOS (start
))
14741 if (display_line (&it
))
14742 last_text_row
= it
.glyph_row
- 1;
14745 /* A value of current_y < last_visible_y means that we stopped
14746 at the previous window start, which in turn means that we
14747 have at least one reusable row. */
14748 if (it
.current_y
< it
.last_visible_y
)
14750 struct glyph_row
*row
;
14752 /* IT.vpos always starts from 0; it counts text lines. */
14753 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14755 /* Find PT if not already found in the lines displayed. */
14756 if (w
->cursor
.vpos
< 0)
14758 int dy
= it
.current_y
- start_row
->y
;
14760 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14761 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14763 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14764 dy
, nrows_scrolled
);
14767 clear_glyph_matrix (w
->desired_matrix
);
14772 /* Scroll the display. Do it before the current matrix is
14773 changed. The problem here is that update has not yet
14774 run, i.e. part of the current matrix is not up to date.
14775 scroll_run_hook will clear the cursor, and use the
14776 current matrix to get the height of the row the cursor is
14778 run
.current_y
= start_row
->y
;
14779 run
.desired_y
= it
.current_y
;
14780 run
.height
= it
.last_visible_y
- it
.current_y
;
14782 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14785 FRAME_RIF (f
)->update_window_begin_hook (w
);
14786 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14787 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14788 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14792 /* Shift current matrix down by nrows_scrolled lines. */
14793 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14794 rotate_matrix (w
->current_matrix
,
14796 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14799 /* Disable lines that must be updated. */
14800 for (i
= 0; i
< nrows_scrolled
; ++i
)
14801 (start_row
+ i
)->enabled_p
= 0;
14803 /* Re-compute Y positions. */
14804 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14805 max_y
= it
.last_visible_y
;
14806 for (row
= start_row
+ nrows_scrolled
;
14810 row
->y
= it
.current_y
;
14811 row
->visible_height
= row
->height
;
14813 if (row
->y
< min_y
)
14814 row
->visible_height
-= min_y
- row
->y
;
14815 if (row
->y
+ row
->height
> max_y
)
14816 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14817 row
->redraw_fringe_bitmaps_p
= 1;
14819 it
.current_y
+= row
->height
;
14821 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14822 last_reused_text_row
= row
;
14823 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14827 /* Disable lines in the current matrix which are now
14828 below the window. */
14829 for (++row
; row
< bottom_row
; ++row
)
14830 row
->enabled_p
= row
->mode_line_p
= 0;
14833 /* Update window_end_pos etc.; last_reused_text_row is the last
14834 reused row from the current matrix containing text, if any.
14835 The value of last_text_row is the last displayed line
14836 containing text. */
14837 if (last_reused_text_row
)
14839 w
->window_end_bytepos
14840 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14842 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14844 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14845 w
->current_matrix
));
14847 else if (last_text_row
)
14849 w
->window_end_bytepos
14850 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14852 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14854 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14858 /* This window must be completely empty. */
14859 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14860 w
->window_end_pos
= make_number (Z
- ZV
);
14861 w
->window_end_vpos
= make_number (0);
14863 w
->window_end_valid
= Qnil
;
14865 /* Update hint: don't try scrolling again in update_window. */
14866 w
->desired_matrix
->no_scrolling_p
= 1;
14869 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14873 else if (CHARPOS (new_start
) > CHARPOS (start
))
14875 struct glyph_row
*pt_row
, *row
;
14876 struct glyph_row
*first_reusable_row
;
14877 struct glyph_row
*first_row_to_display
;
14879 int yb
= window_text_bottom_y (w
);
14881 /* Find the row starting at new_start, if there is one. Don't
14882 reuse a partially visible line at the end. */
14883 first_reusable_row
= start_row
;
14884 while (first_reusable_row
->enabled_p
14885 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14886 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14887 < CHARPOS (new_start
)))
14888 ++first_reusable_row
;
14890 /* Give up if there is no row to reuse. */
14891 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14892 || !first_reusable_row
->enabled_p
14893 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14894 != CHARPOS (new_start
)))
14897 /* We can reuse fully visible rows beginning with
14898 first_reusable_row to the end of the window. Set
14899 first_row_to_display to the first row that cannot be reused.
14900 Set pt_row to the row containing point, if there is any. */
14902 for (first_row_to_display
= first_reusable_row
;
14903 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14904 ++first_row_to_display
)
14906 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14907 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14908 pt_row
= first_row_to_display
;
14911 /* Start displaying at the start of first_row_to_display. */
14912 xassert (first_row_to_display
->y
< yb
);
14913 init_to_row_start (&it
, w
, first_row_to_display
);
14915 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14917 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14919 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14920 + WINDOW_HEADER_LINE_HEIGHT (w
));
14922 /* Display lines beginning with first_row_to_display in the
14923 desired matrix. Set last_text_row to the last row displayed
14924 that displays text. */
14925 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14926 if (pt_row
== NULL
)
14927 w
->cursor
.vpos
= -1;
14928 last_text_row
= NULL
;
14929 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14930 if (display_line (&it
))
14931 last_text_row
= it
.glyph_row
- 1;
14933 /* If point is in a reused row, adjust y and vpos of the cursor
14937 w
->cursor
.vpos
-= nrows_scrolled
;
14938 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14941 /* Give up if point isn't in a row displayed or reused. (This
14942 also handles the case where w->cursor.vpos < nrows_scrolled
14943 after the calls to display_line, which can happen with scroll
14944 margins. See bug#1295.) */
14945 if (w
->cursor
.vpos
< 0)
14947 clear_glyph_matrix (w
->desired_matrix
);
14951 /* Scroll the display. */
14952 run
.current_y
= first_reusable_row
->y
;
14953 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14954 run
.height
= it
.last_visible_y
- run
.current_y
;
14955 dy
= run
.current_y
- run
.desired_y
;
14960 FRAME_RIF (f
)->update_window_begin_hook (w
);
14961 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14962 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14963 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14967 /* Adjust Y positions of reused rows. */
14968 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14969 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14970 max_y
= it
.last_visible_y
;
14971 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14974 row
->visible_height
= row
->height
;
14975 if (row
->y
< min_y
)
14976 row
->visible_height
-= min_y
- row
->y
;
14977 if (row
->y
+ row
->height
> max_y
)
14978 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14979 row
->redraw_fringe_bitmaps_p
= 1;
14982 /* Scroll the current matrix. */
14983 xassert (nrows_scrolled
> 0);
14984 rotate_matrix (w
->current_matrix
,
14986 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14989 /* Disable rows not reused. */
14990 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14991 row
->enabled_p
= 0;
14993 /* Point may have moved to a different line, so we cannot assume that
14994 the previous cursor position is valid; locate the correct row. */
14997 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14998 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15002 w
->cursor
.y
= row
->y
;
15004 if (row
< bottom_row
)
15006 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15007 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15009 /* Can't use this optimization with bidi-reordered glyph
15010 rows, unless cursor is already at point. */
15011 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15013 if (!(w
->cursor
.hpos
>= 0
15014 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15015 && BUFFERP (glyph
->object
)
15016 && glyph
->charpos
== PT
))
15021 && (!BUFFERP (glyph
->object
)
15022 || glyph
->charpos
< PT
);
15026 w
->cursor
.x
+= glyph
->pixel_width
;
15031 /* Adjust window end. A null value of last_text_row means that
15032 the window end is in reused rows which in turn means that
15033 only its vpos can have changed. */
15036 w
->window_end_bytepos
15037 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15039 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15041 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15046 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15049 w
->window_end_valid
= Qnil
;
15050 w
->desired_matrix
->no_scrolling_p
= 1;
15053 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15063 /************************************************************************
15064 Window redisplay reusing current matrix when buffer has changed
15065 ************************************************************************/
15067 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15068 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15069 EMACS_INT
*, EMACS_INT
*);
15070 static struct glyph_row
*
15071 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15072 struct glyph_row
*);
15075 /* Return the last row in MATRIX displaying text. If row START is
15076 non-null, start searching with that row. IT gives the dimensions
15077 of the display. Value is null if matrix is empty; otherwise it is
15078 a pointer to the row found. */
15080 static struct glyph_row
*
15081 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15082 struct glyph_row
*start
)
15084 struct glyph_row
*row
, *row_found
;
15086 /* Set row_found to the last row in IT->w's current matrix
15087 displaying text. The loop looks funny but think of partially
15090 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15091 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15093 xassert (row
->enabled_p
);
15095 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15104 /* Return the last row in the current matrix of W that is not affected
15105 by changes at the start of current_buffer that occurred since W's
15106 current matrix was built. Value is null if no such row exists.
15108 BEG_UNCHANGED us the number of characters unchanged at the start of
15109 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15110 first changed character in current_buffer. Characters at positions <
15111 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15112 when the current matrix was built. */
15114 static struct glyph_row
*
15115 find_last_unchanged_at_beg_row (struct window
*w
)
15117 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15118 struct glyph_row
*row
;
15119 struct glyph_row
*row_found
= NULL
;
15120 int yb
= window_text_bottom_y (w
);
15122 /* Find the last row displaying unchanged text. */
15123 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15124 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15125 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15128 if (/* If row ends before first_changed_pos, it is unchanged,
15129 except in some case. */
15130 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15131 /* When row ends in ZV and we write at ZV it is not
15133 && !row
->ends_at_zv_p
15134 /* When first_changed_pos is the end of a continued line,
15135 row is not unchanged because it may be no longer
15137 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15138 && (row
->continued_p
15139 || row
->exact_window_width_line_p
)))
15142 /* Stop if last visible row. */
15143 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15151 /* Find the first glyph row in the current matrix of W that is not
15152 affected by changes at the end of current_buffer since the
15153 time W's current matrix was built.
15155 Return in *DELTA the number of chars by which buffer positions in
15156 unchanged text at the end of current_buffer must be adjusted.
15158 Return in *DELTA_BYTES the corresponding number of bytes.
15160 Value is null if no such row exists, i.e. all rows are affected by
15163 static struct glyph_row
*
15164 find_first_unchanged_at_end_row (struct window
*w
,
15165 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15167 struct glyph_row
*row
;
15168 struct glyph_row
*row_found
= NULL
;
15170 *delta
= *delta_bytes
= 0;
15172 /* Display must not have been paused, otherwise the current matrix
15173 is not up to date. */
15174 eassert (!NILP (w
->window_end_valid
));
15176 /* A value of window_end_pos >= END_UNCHANGED means that the window
15177 end is in the range of changed text. If so, there is no
15178 unchanged row at the end of W's current matrix. */
15179 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15182 /* Set row to the last row in W's current matrix displaying text. */
15183 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15185 /* If matrix is entirely empty, no unchanged row exists. */
15186 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15188 /* The value of row is the last glyph row in the matrix having a
15189 meaningful buffer position in it. The end position of row
15190 corresponds to window_end_pos. This allows us to translate
15191 buffer positions in the current matrix to current buffer
15192 positions for characters not in changed text. */
15194 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15195 EMACS_INT Z_BYTE_old
=
15196 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15197 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15198 struct glyph_row
*first_text_row
15199 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15201 *delta
= Z
- Z_old
;
15202 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15204 /* Set last_unchanged_pos to the buffer position of the last
15205 character in the buffer that has not been changed. Z is the
15206 index + 1 of the last character in current_buffer, i.e. by
15207 subtracting END_UNCHANGED we get the index of the last
15208 unchanged character, and we have to add BEG to get its buffer
15210 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15211 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15213 /* Search backward from ROW for a row displaying a line that
15214 starts at a minimum position >= last_unchanged_pos_old. */
15215 for (; row
> first_text_row
; --row
)
15217 /* This used to abort, but it can happen.
15218 It is ok to just stop the search instead here. KFS. */
15219 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15222 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15227 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15233 /* Make sure that glyph rows in the current matrix of window W
15234 reference the same glyph memory as corresponding rows in the
15235 frame's frame matrix. This function is called after scrolling W's
15236 current matrix on a terminal frame in try_window_id and
15237 try_window_reusing_current_matrix. */
15240 sync_frame_with_window_matrix_rows (struct window
*w
)
15242 struct frame
*f
= XFRAME (w
->frame
);
15243 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15245 /* Preconditions: W must be a leaf window and full-width. Its frame
15246 must have a frame matrix. */
15247 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15248 xassert (WINDOW_FULL_WIDTH_P (w
));
15249 xassert (!FRAME_WINDOW_P (f
));
15251 /* If W is a full-width window, glyph pointers in W's current matrix
15252 have, by definition, to be the same as glyph pointers in the
15253 corresponding frame matrix. Note that frame matrices have no
15254 marginal areas (see build_frame_matrix). */
15255 window_row
= w
->current_matrix
->rows
;
15256 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15257 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15258 while (window_row
< window_row_end
)
15260 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15261 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15263 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15264 frame_row
->glyphs
[TEXT_AREA
] = start
;
15265 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15266 frame_row
->glyphs
[LAST_AREA
] = end
;
15268 /* Disable frame rows whose corresponding window rows have
15269 been disabled in try_window_id. */
15270 if (!window_row
->enabled_p
)
15271 frame_row
->enabled_p
= 0;
15273 ++window_row
, ++frame_row
;
15278 /* Find the glyph row in window W containing CHARPOS. Consider all
15279 rows between START and END (not inclusive). END null means search
15280 all rows to the end of the display area of W. Value is the row
15281 containing CHARPOS or null. */
15284 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15285 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15287 struct glyph_row
*row
= start
;
15288 struct glyph_row
*best_row
= NULL
;
15289 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15292 /* If we happen to start on a header-line, skip that. */
15293 if (row
->mode_line_p
)
15296 if ((end
&& row
>= end
) || !row
->enabled_p
)
15299 last_y
= window_text_bottom_y (w
) - dy
;
15303 /* Give up if we have gone too far. */
15304 if (end
&& row
>= end
)
15306 /* This formerly returned if they were equal.
15307 I think that both quantities are of a "last plus one" type;
15308 if so, when they are equal, the row is within the screen. -- rms. */
15309 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15312 /* If it is in this row, return this row. */
15313 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15314 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15315 /* The end position of a row equals the start
15316 position of the next row. If CHARPOS is there, we
15317 would rather display it in the next line, except
15318 when this line ends in ZV. */
15319 && !row
->ends_at_zv_p
15320 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15321 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15325 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15326 || (!best_row
&& !row
->continued_p
))
15328 /* In bidi-reordered rows, there could be several rows
15329 occluding point, all of them belonging to the same
15330 continued line. We need to find the row which fits
15331 CHARPOS the best. */
15332 for (g
= row
->glyphs
[TEXT_AREA
];
15333 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15336 if (!STRINGP (g
->object
))
15338 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15340 mindif
= eabs (g
->charpos
- charpos
);
15342 /* Exact match always wins. */
15349 else if (best_row
&& !row
->continued_p
)
15356 /* Try to redisplay window W by reusing its existing display. W's
15357 current matrix must be up to date when this function is called,
15358 i.e. window_end_valid must not be nil.
15362 1 if display has been updated
15363 0 if otherwise unsuccessful
15364 -1 if redisplay with same window start is known not to succeed
15366 The following steps are performed:
15368 1. Find the last row in the current matrix of W that is not
15369 affected by changes at the start of current_buffer. If no such row
15372 2. Find the first row in W's current matrix that is not affected by
15373 changes at the end of current_buffer. Maybe there is no such row.
15375 3. Display lines beginning with the row + 1 found in step 1 to the
15376 row found in step 2 or, if step 2 didn't find a row, to the end of
15379 4. If cursor is not known to appear on the window, give up.
15381 5. If display stopped at the row found in step 2, scroll the
15382 display and current matrix as needed.
15384 6. Maybe display some lines at the end of W, if we must. This can
15385 happen under various circumstances, like a partially visible line
15386 becoming fully visible, or because newly displayed lines are displayed
15387 in smaller font sizes.
15389 7. Update W's window end information. */
15392 try_window_id (struct window
*w
)
15394 struct frame
*f
= XFRAME (w
->frame
);
15395 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15396 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15397 struct glyph_row
*last_unchanged_at_beg_row
;
15398 struct glyph_row
*first_unchanged_at_end_row
;
15399 struct glyph_row
*row
;
15400 struct glyph_row
*bottom_row
;
15403 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15405 struct text_pos start_pos
;
15407 int first_unchanged_at_end_vpos
= 0;
15408 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15409 struct text_pos start
;
15410 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15413 if (inhibit_try_window_id
)
15417 /* This is handy for debugging. */
15419 #define GIVE_UP(X) \
15421 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15425 #define GIVE_UP(X) return 0
15428 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15430 /* Don't use this for mini-windows because these can show
15431 messages and mini-buffers, and we don't handle that here. */
15432 if (MINI_WINDOW_P (w
))
15435 /* This flag is used to prevent redisplay optimizations. */
15436 if (windows_or_buffers_changed
|| cursor_type_changed
)
15439 /* Verify that narrowing has not changed.
15440 Also verify that we were not told to prevent redisplay optimizations.
15441 It would be nice to further
15442 reduce the number of cases where this prevents try_window_id. */
15443 if (current_buffer
->clip_changed
15444 || current_buffer
->prevent_redisplay_optimizations_p
)
15447 /* Window must either use window-based redisplay or be full width. */
15448 if (!FRAME_WINDOW_P (f
)
15449 && (!FRAME_LINE_INS_DEL_OK (f
)
15450 || !WINDOW_FULL_WIDTH_P (w
)))
15453 /* Give up if point is known NOT to appear in W. */
15454 if (PT
< CHARPOS (start
))
15457 /* Another way to prevent redisplay optimizations. */
15458 if (XFASTINT (w
->last_modified
) == 0)
15461 /* Verify that window is not hscrolled. */
15462 if (XFASTINT (w
->hscroll
) != 0)
15465 /* Verify that display wasn't paused. */
15466 if (NILP (w
->window_end_valid
))
15469 /* Can't use this if highlighting a region because a cursor movement
15470 will do more than just set the cursor. */
15471 if (!NILP (Vtransient_mark_mode
)
15472 && !NILP (BVAR (current_buffer
, mark_active
)))
15475 /* Likewise if highlighting trailing whitespace. */
15476 if (!NILP (Vshow_trailing_whitespace
))
15479 /* Likewise if showing a region. */
15480 if (!NILP (w
->region_showing
))
15483 /* Can't use this if overlay arrow position and/or string have
15485 if (overlay_arrows_changed_p ())
15488 /* When word-wrap is on, adding a space to the first word of a
15489 wrapped line can change the wrap position, altering the line
15490 above it. It might be worthwhile to handle this more
15491 intelligently, but for now just redisplay from scratch. */
15492 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15495 /* Under bidi reordering, adding or deleting a character in the
15496 beginning of a paragraph, before the first strong directional
15497 character, can change the base direction of the paragraph (unless
15498 the buffer specifies a fixed paragraph direction), which will
15499 require to redisplay the whole paragraph. It might be worthwhile
15500 to find the paragraph limits and widen the range of redisplayed
15501 lines to that, but for now just give up this optimization and
15502 redisplay from scratch. */
15503 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15504 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15507 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15508 only if buffer has really changed. The reason is that the gap is
15509 initially at Z for freshly visited files. The code below would
15510 set end_unchanged to 0 in that case. */
15511 if (MODIFF
> SAVE_MODIFF
15512 /* This seems to happen sometimes after saving a buffer. */
15513 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15515 if (GPT
- BEG
< BEG_UNCHANGED
)
15516 BEG_UNCHANGED
= GPT
- BEG
;
15517 if (Z
- GPT
< END_UNCHANGED
)
15518 END_UNCHANGED
= Z
- GPT
;
15521 /* The position of the first and last character that has been changed. */
15522 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15523 last_changed_charpos
= Z
- END_UNCHANGED
;
15525 /* If window starts after a line end, and the last change is in
15526 front of that newline, then changes don't affect the display.
15527 This case happens with stealth-fontification. Note that although
15528 the display is unchanged, glyph positions in the matrix have to
15529 be adjusted, of course. */
15530 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15531 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15532 && ((last_changed_charpos
< CHARPOS (start
)
15533 && CHARPOS (start
) == BEGV
)
15534 || (last_changed_charpos
< CHARPOS (start
) - 1
15535 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15537 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15538 struct glyph_row
*r0
;
15540 /* Compute how many chars/bytes have been added to or removed
15541 from the buffer. */
15542 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15543 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15544 Z_delta
= Z
- Z_old
;
15545 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15547 /* Give up if PT is not in the window. Note that it already has
15548 been checked at the start of try_window_id that PT is not in
15549 front of the window start. */
15550 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15553 /* If window start is unchanged, we can reuse the whole matrix
15554 as is, after adjusting glyph positions. No need to compute
15555 the window end again, since its offset from Z hasn't changed. */
15556 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15557 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15558 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15559 /* PT must not be in a partially visible line. */
15560 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15561 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15563 /* Adjust positions in the glyph matrix. */
15564 if (Z_delta
|| Z_delta_bytes
)
15566 struct glyph_row
*r1
15567 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15568 increment_matrix_positions (w
->current_matrix
,
15569 MATRIX_ROW_VPOS (r0
, current_matrix
),
15570 MATRIX_ROW_VPOS (r1
, current_matrix
),
15571 Z_delta
, Z_delta_bytes
);
15574 /* Set the cursor. */
15575 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15577 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15584 /* Handle the case that changes are all below what is displayed in
15585 the window, and that PT is in the window. This shortcut cannot
15586 be taken if ZV is visible in the window, and text has been added
15587 there that is visible in the window. */
15588 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15589 /* ZV is not visible in the window, or there are no
15590 changes at ZV, actually. */
15591 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15592 || first_changed_charpos
== last_changed_charpos
))
15594 struct glyph_row
*r0
;
15596 /* Give up if PT is not in the window. Note that it already has
15597 been checked at the start of try_window_id that PT is not in
15598 front of the window start. */
15599 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15602 /* If window start is unchanged, we can reuse the whole matrix
15603 as is, without changing glyph positions since no text has
15604 been added/removed in front of the window end. */
15605 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15606 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15607 /* PT must not be in a partially visible line. */
15608 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15609 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15611 /* We have to compute the window end anew since text
15612 could have been added/removed after it. */
15614 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15615 w
->window_end_bytepos
15616 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15618 /* Set the cursor. */
15619 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15621 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15628 /* Give up if window start is in the changed area.
15630 The condition used to read
15632 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15634 but why that was tested escapes me at the moment. */
15635 if (CHARPOS (start
) >= first_changed_charpos
15636 && CHARPOS (start
) <= last_changed_charpos
)
15639 /* Check that window start agrees with the start of the first glyph
15640 row in its current matrix. Check this after we know the window
15641 start is not in changed text, otherwise positions would not be
15643 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15644 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15647 /* Give up if the window ends in strings. Overlay strings
15648 at the end are difficult to handle, so don't try. */
15649 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15650 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15653 /* Compute the position at which we have to start displaying new
15654 lines. Some of the lines at the top of the window might be
15655 reusable because they are not displaying changed text. Find the
15656 last row in W's current matrix not affected by changes at the
15657 start of current_buffer. Value is null if changes start in the
15658 first line of window. */
15659 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15660 if (last_unchanged_at_beg_row
)
15662 /* Avoid starting to display in the moddle of a character, a TAB
15663 for instance. This is easier than to set up the iterator
15664 exactly, and it's not a frequent case, so the additional
15665 effort wouldn't really pay off. */
15666 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15667 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15668 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15669 --last_unchanged_at_beg_row
;
15671 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15674 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15676 start_pos
= it
.current
.pos
;
15678 /* Start displaying new lines in the desired matrix at the same
15679 vpos we would use in the current matrix, i.e. below
15680 last_unchanged_at_beg_row. */
15681 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15683 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15684 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15686 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15690 /* There are no reusable lines at the start of the window.
15691 Start displaying in the first text line. */
15692 start_display (&it
, w
, start
);
15693 it
.vpos
= it
.first_vpos
;
15694 start_pos
= it
.current
.pos
;
15697 /* Find the first row that is not affected by changes at the end of
15698 the buffer. Value will be null if there is no unchanged row, in
15699 which case we must redisplay to the end of the window. delta
15700 will be set to the value by which buffer positions beginning with
15701 first_unchanged_at_end_row have to be adjusted due to text
15703 first_unchanged_at_end_row
15704 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15705 IF_DEBUG (debug_delta
= delta
);
15706 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15708 /* Set stop_pos to the buffer position up to which we will have to
15709 display new lines. If first_unchanged_at_end_row != NULL, this
15710 is the buffer position of the start of the line displayed in that
15711 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15712 that we don't stop at a buffer position. */
15714 if (first_unchanged_at_end_row
)
15716 xassert (last_unchanged_at_beg_row
== NULL
15717 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15719 /* If this is a continuation line, move forward to the next one
15720 that isn't. Changes in lines above affect this line.
15721 Caution: this may move first_unchanged_at_end_row to a row
15722 not displaying text. */
15723 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15724 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15725 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15726 < it
.last_visible_y
))
15727 ++first_unchanged_at_end_row
;
15729 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15730 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15731 >= it
.last_visible_y
))
15732 first_unchanged_at_end_row
= NULL
;
15735 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15737 first_unchanged_at_end_vpos
15738 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15739 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15742 else if (last_unchanged_at_beg_row
== NULL
)
15748 /* Either there is no unchanged row at the end, or the one we have
15749 now displays text. This is a necessary condition for the window
15750 end pos calculation at the end of this function. */
15751 xassert (first_unchanged_at_end_row
== NULL
15752 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15754 debug_last_unchanged_at_beg_vpos
15755 = (last_unchanged_at_beg_row
15756 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15758 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15760 #endif /* GLYPH_DEBUG != 0 */
15763 /* Display new lines. Set last_text_row to the last new line
15764 displayed which has text on it, i.e. might end up as being the
15765 line where the window_end_vpos is. */
15766 w
->cursor
.vpos
= -1;
15767 last_text_row
= NULL
;
15768 overlay_arrow_seen
= 0;
15769 while (it
.current_y
< it
.last_visible_y
15770 && !fonts_changed_p
15771 && (first_unchanged_at_end_row
== NULL
15772 || IT_CHARPOS (it
) < stop_pos
))
15774 if (display_line (&it
))
15775 last_text_row
= it
.glyph_row
- 1;
15778 if (fonts_changed_p
)
15782 /* Compute differences in buffer positions, y-positions etc. for
15783 lines reused at the bottom of the window. Compute what we can
15785 if (first_unchanged_at_end_row
15786 /* No lines reused because we displayed everything up to the
15787 bottom of the window. */
15788 && it
.current_y
< it
.last_visible_y
)
15791 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15793 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15794 run
.current_y
= first_unchanged_at_end_row
->y
;
15795 run
.desired_y
= run
.current_y
+ dy
;
15796 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15800 delta
= delta_bytes
= dvpos
= dy
15801 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15802 first_unchanged_at_end_row
= NULL
;
15804 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15807 /* Find the cursor if not already found. We have to decide whether
15808 PT will appear on this window (it sometimes doesn't, but this is
15809 not a very frequent case.) This decision has to be made before
15810 the current matrix is altered. A value of cursor.vpos < 0 means
15811 that PT is either in one of the lines beginning at
15812 first_unchanged_at_end_row or below the window. Don't care for
15813 lines that might be displayed later at the window end; as
15814 mentioned, this is not a frequent case. */
15815 if (w
->cursor
.vpos
< 0)
15817 /* Cursor in unchanged rows at the top? */
15818 if (PT
< CHARPOS (start_pos
)
15819 && last_unchanged_at_beg_row
)
15821 row
= row_containing_pos (w
, PT
,
15822 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15823 last_unchanged_at_beg_row
+ 1, 0);
15825 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15828 /* Start from first_unchanged_at_end_row looking for PT. */
15829 else if (first_unchanged_at_end_row
)
15831 row
= row_containing_pos (w
, PT
- delta
,
15832 first_unchanged_at_end_row
, NULL
, 0);
15834 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15835 delta_bytes
, dy
, dvpos
);
15838 /* Give up if cursor was not found. */
15839 if (w
->cursor
.vpos
< 0)
15841 clear_glyph_matrix (w
->desired_matrix
);
15846 /* Don't let the cursor end in the scroll margins. */
15848 int this_scroll_margin
, cursor_height
;
15850 this_scroll_margin
= max (0, scroll_margin
);
15851 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15852 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15853 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15855 if ((w
->cursor
.y
< this_scroll_margin
15856 && CHARPOS (start
) > BEGV
)
15857 /* Old redisplay didn't take scroll margin into account at the bottom,
15858 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15859 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15860 ? cursor_height
+ this_scroll_margin
15861 : 1)) > it
.last_visible_y
)
15863 w
->cursor
.vpos
= -1;
15864 clear_glyph_matrix (w
->desired_matrix
);
15869 /* Scroll the display. Do it before changing the current matrix so
15870 that xterm.c doesn't get confused about where the cursor glyph is
15872 if (dy
&& run
.height
)
15876 if (FRAME_WINDOW_P (f
))
15878 FRAME_RIF (f
)->update_window_begin_hook (w
);
15879 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15880 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15881 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15885 /* Terminal frame. In this case, dvpos gives the number of
15886 lines to scroll by; dvpos < 0 means scroll up. */
15888 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15889 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15890 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15891 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15892 + window_internal_height (w
));
15894 #if defined (HAVE_GPM) || defined (MSDOS)
15895 x_clear_window_mouse_face (w
);
15897 /* Perform the operation on the screen. */
15900 /* Scroll last_unchanged_at_beg_row to the end of the
15901 window down dvpos lines. */
15902 set_terminal_window (f
, end
);
15904 /* On dumb terminals delete dvpos lines at the end
15905 before inserting dvpos empty lines. */
15906 if (!FRAME_SCROLL_REGION_OK (f
))
15907 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15909 /* Insert dvpos empty lines in front of
15910 last_unchanged_at_beg_row. */
15911 ins_del_lines (f
, from
, dvpos
);
15913 else if (dvpos
< 0)
15915 /* Scroll up last_unchanged_at_beg_vpos to the end of
15916 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15917 set_terminal_window (f
, end
);
15919 /* Delete dvpos lines in front of
15920 last_unchanged_at_beg_vpos. ins_del_lines will set
15921 the cursor to the given vpos and emit |dvpos| delete
15923 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15925 /* On a dumb terminal insert dvpos empty lines at the
15927 if (!FRAME_SCROLL_REGION_OK (f
))
15928 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15931 set_terminal_window (f
, 0);
15937 /* Shift reused rows of the current matrix to the right position.
15938 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15940 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15941 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15944 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15945 bottom_vpos
, dvpos
);
15946 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15949 else if (dvpos
> 0)
15951 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15952 bottom_vpos
, dvpos
);
15953 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15954 first_unchanged_at_end_vpos
+ dvpos
, 0);
15957 /* For frame-based redisplay, make sure that current frame and window
15958 matrix are in sync with respect to glyph memory. */
15959 if (!FRAME_WINDOW_P (f
))
15960 sync_frame_with_window_matrix_rows (w
);
15962 /* Adjust buffer positions in reused rows. */
15963 if (delta
|| delta_bytes
)
15964 increment_matrix_positions (current_matrix
,
15965 first_unchanged_at_end_vpos
+ dvpos
,
15966 bottom_vpos
, delta
, delta_bytes
);
15968 /* Adjust Y positions. */
15970 shift_glyph_matrix (w
, current_matrix
,
15971 first_unchanged_at_end_vpos
+ dvpos
,
15974 if (first_unchanged_at_end_row
)
15976 first_unchanged_at_end_row
+= dvpos
;
15977 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15978 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15979 first_unchanged_at_end_row
= NULL
;
15982 /* If scrolling up, there may be some lines to display at the end of
15984 last_text_row_at_end
= NULL
;
15987 /* Scrolling up can leave for example a partially visible line
15988 at the end of the window to be redisplayed. */
15989 /* Set last_row to the glyph row in the current matrix where the
15990 window end line is found. It has been moved up or down in
15991 the matrix by dvpos. */
15992 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15993 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15995 /* If last_row is the window end line, it should display text. */
15996 xassert (last_row
->displays_text_p
);
15998 /* If window end line was partially visible before, begin
15999 displaying at that line. Otherwise begin displaying with the
16000 line following it. */
16001 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16003 init_to_row_start (&it
, w
, last_row
);
16004 it
.vpos
= last_vpos
;
16005 it
.current_y
= last_row
->y
;
16009 init_to_row_end (&it
, w
, last_row
);
16010 it
.vpos
= 1 + last_vpos
;
16011 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16015 /* We may start in a continuation line. If so, we have to
16016 get the right continuation_lines_width and current_x. */
16017 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16018 it
.hpos
= it
.current_x
= 0;
16020 /* Display the rest of the lines at the window end. */
16021 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16022 while (it
.current_y
< it
.last_visible_y
16023 && !fonts_changed_p
)
16025 /* Is it always sure that the display agrees with lines in
16026 the current matrix? I don't think so, so we mark rows
16027 displayed invalid in the current matrix by setting their
16028 enabled_p flag to zero. */
16029 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16030 if (display_line (&it
))
16031 last_text_row_at_end
= it
.glyph_row
- 1;
16035 /* Update window_end_pos and window_end_vpos. */
16036 if (first_unchanged_at_end_row
16037 && !last_text_row_at_end
)
16039 /* Window end line if one of the preserved rows from the current
16040 matrix. Set row to the last row displaying text in current
16041 matrix starting at first_unchanged_at_end_row, after
16043 xassert (first_unchanged_at_end_row
->displays_text_p
);
16044 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16045 first_unchanged_at_end_row
);
16046 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16048 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16049 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16051 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16052 xassert (w
->window_end_bytepos
>= 0);
16053 IF_DEBUG (debug_method_add (w
, "A"));
16055 else if (last_text_row_at_end
)
16058 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16059 w
->window_end_bytepos
16060 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16062 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16063 xassert (w
->window_end_bytepos
>= 0);
16064 IF_DEBUG (debug_method_add (w
, "B"));
16066 else if (last_text_row
)
16068 /* We have displayed either to the end of the window or at the
16069 end of the window, i.e. the last row with text is to be found
16070 in the desired matrix. */
16072 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16073 w
->window_end_bytepos
16074 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16076 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16077 xassert (w
->window_end_bytepos
>= 0);
16079 else if (first_unchanged_at_end_row
== NULL
16080 && last_text_row
== NULL
16081 && last_text_row_at_end
== NULL
)
16083 /* Displayed to end of window, but no line containing text was
16084 displayed. Lines were deleted at the end of the window. */
16085 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16086 int vpos
= XFASTINT (w
->window_end_vpos
);
16087 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16088 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16091 row
== NULL
&& vpos
>= first_vpos
;
16092 --vpos
, --current_row
, --desired_row
)
16094 if (desired_row
->enabled_p
)
16096 if (desired_row
->displays_text_p
)
16099 else if (current_row
->displays_text_p
)
16103 xassert (row
!= NULL
);
16104 w
->window_end_vpos
= make_number (vpos
+ 1);
16105 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16106 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16107 xassert (w
->window_end_bytepos
>= 0);
16108 IF_DEBUG (debug_method_add (w
, "C"));
16113 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16114 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16116 /* Record that display has not been completed. */
16117 w
->window_end_valid
= Qnil
;
16118 w
->desired_matrix
->no_scrolling_p
= 1;
16126 /***********************************************************************
16127 More debugging support
16128 ***********************************************************************/
16132 void dump_glyph_row (struct glyph_row
*, int, int);
16133 void dump_glyph_matrix (struct glyph_matrix
*, int);
16134 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16137 /* Dump the contents of glyph matrix MATRIX on stderr.
16139 GLYPHS 0 means don't show glyph contents.
16140 GLYPHS 1 means show glyphs in short form
16141 GLYPHS > 1 means show glyphs in long form. */
16144 dump_glyph_matrix (matrix
, glyphs
)
16145 struct glyph_matrix
*matrix
;
16149 for (i
= 0; i
< matrix
->nrows
; ++i
)
16150 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16154 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16155 the glyph row and area where the glyph comes from. */
16158 dump_glyph (row
, glyph
, area
)
16159 struct glyph_row
*row
;
16160 struct glyph
*glyph
;
16163 if (glyph
->type
== CHAR_GLYPH
)
16166 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16167 glyph
- row
->glyphs
[TEXT_AREA
],
16170 (BUFFERP (glyph
->object
)
16172 : (STRINGP (glyph
->object
)
16175 glyph
->pixel_width
,
16177 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16181 glyph
->left_box_line_p
,
16182 glyph
->right_box_line_p
);
16184 else if (glyph
->type
== STRETCH_GLYPH
)
16187 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16188 glyph
- row
->glyphs
[TEXT_AREA
],
16191 (BUFFERP (glyph
->object
)
16193 : (STRINGP (glyph
->object
)
16196 glyph
->pixel_width
,
16200 glyph
->left_box_line_p
,
16201 glyph
->right_box_line_p
);
16203 else if (glyph
->type
== IMAGE_GLYPH
)
16206 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16207 glyph
- row
->glyphs
[TEXT_AREA
],
16210 (BUFFERP (glyph
->object
)
16212 : (STRINGP (glyph
->object
)
16215 glyph
->pixel_width
,
16219 glyph
->left_box_line_p
,
16220 glyph
->right_box_line_p
);
16222 else if (glyph
->type
== COMPOSITE_GLYPH
)
16225 " %5d %4c %6d %c %3d 0x%05x",
16226 glyph
- row
->glyphs
[TEXT_AREA
],
16229 (BUFFERP (glyph
->object
)
16231 : (STRINGP (glyph
->object
)
16234 glyph
->pixel_width
,
16236 if (glyph
->u
.cmp
.automatic
)
16239 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16240 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16242 glyph
->left_box_line_p
,
16243 glyph
->right_box_line_p
);
16248 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16249 GLYPHS 0 means don't show glyph contents.
16250 GLYPHS 1 means show glyphs in short form
16251 GLYPHS > 1 means show glyphs in long form. */
16254 dump_glyph_row (row
, vpos
, glyphs
)
16255 struct glyph_row
*row
;
16260 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16261 fprintf (stderr
, "======================================================================\n");
16263 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16264 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16266 MATRIX_ROW_START_CHARPOS (row
),
16267 MATRIX_ROW_END_CHARPOS (row
),
16268 row
->used
[TEXT_AREA
],
16269 row
->contains_overlapping_glyphs_p
,
16271 row
->truncated_on_left_p
,
16272 row
->truncated_on_right_p
,
16274 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16275 row
->displays_text_p
,
16278 row
->ends_in_middle_of_char_p
,
16279 row
->starts_in_middle_of_char_p
,
16285 row
->visible_height
,
16288 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16289 row
->end
.overlay_string_index
,
16290 row
->continuation_lines_width
);
16291 fprintf (stderr
, "%9d %5d\n",
16292 CHARPOS (row
->start
.string_pos
),
16293 CHARPOS (row
->end
.string_pos
));
16294 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16295 row
->end
.dpvec_index
);
16302 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16304 struct glyph
*glyph
= row
->glyphs
[area
];
16305 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16307 /* Glyph for a line end in text. */
16308 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16311 if (glyph
< glyph_end
)
16312 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16314 for (; glyph
< glyph_end
; ++glyph
)
16315 dump_glyph (row
, glyph
, area
);
16318 else if (glyphs
== 1)
16322 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16324 char *s
= (char *) alloca (row
->used
[area
] + 1);
16327 for (i
= 0; i
< row
->used
[area
]; ++i
)
16329 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16330 if (glyph
->type
== CHAR_GLYPH
16331 && glyph
->u
.ch
< 0x80
16332 && glyph
->u
.ch
>= ' ')
16333 s
[i
] = glyph
->u
.ch
;
16339 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16345 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16346 Sdump_glyph_matrix
, 0, 1, "p",
16347 doc
: /* Dump the current matrix of the selected window to stderr.
16348 Shows contents of glyph row structures. With non-nil
16349 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16350 glyphs in short form, otherwise show glyphs in long form. */)
16351 (Lisp_Object glyphs
)
16353 struct window
*w
= XWINDOW (selected_window
);
16354 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16356 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16357 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16358 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16359 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16360 fprintf (stderr
, "=============================================\n");
16361 dump_glyph_matrix (w
->current_matrix
,
16362 NILP (glyphs
) ? 0 : XINT (glyphs
));
16367 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16368 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16371 struct frame
*f
= XFRAME (selected_frame
);
16372 dump_glyph_matrix (f
->current_matrix
, 1);
16377 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16378 doc
: /* Dump glyph row ROW to stderr.
16379 GLYPH 0 means don't dump glyphs.
16380 GLYPH 1 means dump glyphs in short form.
16381 GLYPH > 1 or omitted means dump glyphs in long form. */)
16382 (Lisp_Object row
, Lisp_Object glyphs
)
16384 struct glyph_matrix
*matrix
;
16387 CHECK_NUMBER (row
);
16388 matrix
= XWINDOW (selected_window
)->current_matrix
;
16390 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16391 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16393 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16398 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16399 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16400 GLYPH 0 means don't dump glyphs.
16401 GLYPH 1 means dump glyphs in short form.
16402 GLYPH > 1 or omitted means dump glyphs in long form. */)
16403 (Lisp_Object row
, Lisp_Object glyphs
)
16405 struct frame
*sf
= SELECTED_FRAME ();
16406 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16409 CHECK_NUMBER (row
);
16411 if (vpos
>= 0 && vpos
< m
->nrows
)
16412 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16413 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16418 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16419 doc
: /* Toggle tracing of redisplay.
16420 With ARG, turn tracing on if and only if ARG is positive. */)
16424 trace_redisplay_p
= !trace_redisplay_p
;
16427 arg
= Fprefix_numeric_value (arg
);
16428 trace_redisplay_p
= XINT (arg
) > 0;
16435 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16436 doc
: /* Like `format', but print result to stderr.
16437 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16438 (size_t nargs
, Lisp_Object
*args
)
16440 Lisp_Object s
= Fformat (nargs
, args
);
16441 fprintf (stderr
, "%s", SDATA (s
));
16445 #endif /* GLYPH_DEBUG */
16449 /***********************************************************************
16450 Building Desired Matrix Rows
16451 ***********************************************************************/
16453 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16454 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16456 static struct glyph_row
*
16457 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16459 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16460 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16461 struct buffer
*old
= current_buffer
;
16462 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16463 int arrow_len
= SCHARS (overlay_arrow_string
);
16464 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16465 const unsigned char *p
;
16468 int n_glyphs_before
;
16470 set_buffer_temp (buffer
);
16471 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16472 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16473 SET_TEXT_POS (it
.position
, 0, 0);
16475 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16477 while (p
< arrow_end
)
16479 Lisp_Object face
, ilisp
;
16481 /* Get the next character. */
16483 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16486 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16487 if (! ASCII_CHAR_P (it
.c
))
16488 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16492 /* Get its face. */
16493 ilisp
= make_number (p
- arrow_string
);
16494 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16495 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16497 /* Compute its width, get its glyphs. */
16498 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16499 SET_TEXT_POS (it
.position
, -1, -1);
16500 PRODUCE_GLYPHS (&it
);
16502 /* If this character doesn't fit any more in the line, we have
16503 to remove some glyphs. */
16504 if (it
.current_x
> it
.last_visible_x
)
16506 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16511 set_buffer_temp (old
);
16512 return it
.glyph_row
;
16516 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16517 glyphs are only inserted for terminal frames since we can't really
16518 win with truncation glyphs when partially visible glyphs are
16519 involved. Which glyphs to insert is determined by
16520 produce_special_glyphs. */
16523 insert_left_trunc_glyphs (struct it
*it
)
16525 struct it truncate_it
;
16526 struct glyph
*from
, *end
, *to
, *toend
;
16528 xassert (!FRAME_WINDOW_P (it
->f
));
16530 /* Get the truncation glyphs. */
16532 truncate_it
.current_x
= 0;
16533 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16534 truncate_it
.glyph_row
= &scratch_glyph_row
;
16535 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16536 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16537 truncate_it
.object
= make_number (0);
16538 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16540 /* Overwrite glyphs from IT with truncation glyphs. */
16541 if (!it
->glyph_row
->reversed_p
)
16543 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16544 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16545 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16546 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16551 /* There may be padding glyphs left over. Overwrite them too. */
16552 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16554 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16560 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16564 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16565 that back to front. */
16566 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16567 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16568 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16569 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16571 while (from
>= end
&& to
>= toend
)
16573 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16576 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16577 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16578 while (from
>= end
&& to
>= toend
)
16583 /* Need to free some room before prepending additional
16585 int move_by
= from
- end
+ 1;
16586 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16587 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16589 for ( ; g
>= g0
; g
--)
16591 while (from
>= end
)
16593 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16599 /* Compute the pixel height and width of IT->glyph_row.
16601 Most of the time, ascent and height of a display line will be equal
16602 to the max_ascent and max_height values of the display iterator
16603 structure. This is not the case if
16605 1. We hit ZV without displaying anything. In this case, max_ascent
16606 and max_height will be zero.
16608 2. We have some glyphs that don't contribute to the line height.
16609 (The glyph row flag contributes_to_line_height_p is for future
16610 pixmap extensions).
16612 The first case is easily covered by using default values because in
16613 these cases, the line height does not really matter, except that it
16614 must not be zero. */
16617 compute_line_metrics (struct it
*it
)
16619 struct glyph_row
*row
= it
->glyph_row
;
16621 if (FRAME_WINDOW_P (it
->f
))
16623 int i
, min_y
, max_y
;
16625 /* The line may consist of one space only, that was added to
16626 place the cursor on it. If so, the row's height hasn't been
16628 if (row
->height
== 0)
16630 if (it
->max_ascent
+ it
->max_descent
== 0)
16631 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16632 row
->ascent
= it
->max_ascent
;
16633 row
->height
= it
->max_ascent
+ it
->max_descent
;
16634 row
->phys_ascent
= it
->max_phys_ascent
;
16635 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16636 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16639 /* Compute the width of this line. */
16640 row
->pixel_width
= row
->x
;
16641 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16642 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16644 xassert (row
->pixel_width
>= 0);
16645 xassert (row
->ascent
>= 0 && row
->height
> 0);
16647 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16648 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16650 /* If first line's physical ascent is larger than its logical
16651 ascent, use the physical ascent, and make the row taller.
16652 This makes accented characters fully visible. */
16653 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16654 && row
->phys_ascent
> row
->ascent
)
16656 row
->height
+= row
->phys_ascent
- row
->ascent
;
16657 row
->ascent
= row
->phys_ascent
;
16660 /* Compute how much of the line is visible. */
16661 row
->visible_height
= row
->height
;
16663 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16664 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16666 if (row
->y
< min_y
)
16667 row
->visible_height
-= min_y
- row
->y
;
16668 if (row
->y
+ row
->height
> max_y
)
16669 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16673 row
->pixel_width
= row
->used
[TEXT_AREA
];
16674 if (row
->continued_p
)
16675 row
->pixel_width
-= it
->continuation_pixel_width
;
16676 else if (row
->truncated_on_right_p
)
16677 row
->pixel_width
-= it
->truncation_pixel_width
;
16678 row
->ascent
= row
->phys_ascent
= 0;
16679 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16680 row
->extra_line_spacing
= 0;
16683 /* Compute a hash code for this row. */
16687 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16688 for (i
= 0; i
< row
->used
[area
]; ++i
)
16689 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16690 + row
->glyphs
[area
][i
].u
.val
16691 + row
->glyphs
[area
][i
].face_id
16692 + row
->glyphs
[area
][i
].padding_p
16693 + (row
->glyphs
[area
][i
].type
<< 2));
16696 it
->max_ascent
= it
->max_descent
= 0;
16697 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16701 /* Append one space to the glyph row of iterator IT if doing a
16702 window-based redisplay. The space has the same face as
16703 IT->face_id. Value is non-zero if a space was added.
16705 This function is called to make sure that there is always one glyph
16706 at the end of a glyph row that the cursor can be set on under
16707 window-systems. (If there weren't such a glyph we would not know
16708 how wide and tall a box cursor should be displayed).
16710 At the same time this space let's a nicely handle clearing to the
16711 end of the line if the row ends in italic text. */
16714 append_space_for_newline (struct it
*it
, int default_face_p
)
16716 if (FRAME_WINDOW_P (it
->f
))
16718 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16720 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16721 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16723 /* Save some values that must not be changed.
16724 Must save IT->c and IT->len because otherwise
16725 ITERATOR_AT_END_P wouldn't work anymore after
16726 append_space_for_newline has been called. */
16727 enum display_element_type saved_what
= it
->what
;
16728 int saved_c
= it
->c
, saved_len
= it
->len
;
16729 int saved_char_to_display
= it
->char_to_display
;
16730 int saved_x
= it
->current_x
;
16731 int saved_face_id
= it
->face_id
;
16732 struct text_pos saved_pos
;
16733 Lisp_Object saved_object
;
16736 saved_object
= it
->object
;
16737 saved_pos
= it
->position
;
16739 it
->what
= IT_CHARACTER
;
16740 memset (&it
->position
, 0, sizeof it
->position
);
16741 it
->object
= make_number (0);
16742 it
->c
= it
->char_to_display
= ' ';
16745 if (default_face_p
)
16746 it
->face_id
= DEFAULT_FACE_ID
;
16747 else if (it
->face_before_selective_p
)
16748 it
->face_id
= it
->saved_face_id
;
16749 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16750 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16752 PRODUCE_GLYPHS (it
);
16754 it
->override_ascent
= -1;
16755 it
->constrain_row_ascent_descent_p
= 0;
16756 it
->current_x
= saved_x
;
16757 it
->object
= saved_object
;
16758 it
->position
= saved_pos
;
16759 it
->what
= saved_what
;
16760 it
->face_id
= saved_face_id
;
16761 it
->len
= saved_len
;
16763 it
->char_to_display
= saved_char_to_display
;
16772 /* Extend the face of the last glyph in the text area of IT->glyph_row
16773 to the end of the display line. Called from display_line. If the
16774 glyph row is empty, add a space glyph to it so that we know the
16775 face to draw. Set the glyph row flag fill_line_p. If the glyph
16776 row is R2L, prepend a stretch glyph to cover the empty space to the
16777 left of the leftmost glyph. */
16780 extend_face_to_end_of_line (struct it
*it
)
16783 struct frame
*f
= it
->f
;
16785 /* If line is already filled, do nothing. Non window-system frames
16786 get a grace of one more ``pixel'' because their characters are
16787 1-``pixel'' wide, so they hit the equality too early. This grace
16788 is needed only for R2L rows that are not continued, to produce
16789 one extra blank where we could display the cursor. */
16790 if (it
->current_x
>= it
->last_visible_x
16791 + (!FRAME_WINDOW_P (f
)
16792 && it
->glyph_row
->reversed_p
16793 && !it
->glyph_row
->continued_p
))
16796 /* Face extension extends the background and box of IT->face_id
16797 to the end of the line. If the background equals the background
16798 of the frame, we don't have to do anything. */
16799 if (it
->face_before_selective_p
)
16800 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16802 face
= FACE_FROM_ID (f
, it
->face_id
);
16804 if (FRAME_WINDOW_P (f
)
16805 && it
->glyph_row
->displays_text_p
16806 && face
->box
== FACE_NO_BOX
16807 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16809 && !it
->glyph_row
->reversed_p
)
16812 /* Set the glyph row flag indicating that the face of the last glyph
16813 in the text area has to be drawn to the end of the text area. */
16814 it
->glyph_row
->fill_line_p
= 1;
16816 /* If current character of IT is not ASCII, make sure we have the
16817 ASCII face. This will be automatically undone the next time
16818 get_next_display_element returns a multibyte character. Note
16819 that the character will always be single byte in unibyte
16821 if (!ASCII_CHAR_P (it
->c
))
16823 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16826 if (FRAME_WINDOW_P (f
))
16828 /* If the row is empty, add a space with the current face of IT,
16829 so that we know which face to draw. */
16830 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16832 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16833 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16834 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16836 #ifdef HAVE_WINDOW_SYSTEM
16837 if (it
->glyph_row
->reversed_p
)
16839 /* Prepend a stretch glyph to the row, such that the
16840 rightmost glyph will be drawn flushed all the way to the
16841 right margin of the window. The stretch glyph that will
16842 occupy the empty space, if any, to the left of the
16844 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16845 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16846 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16848 int row_width
, stretch_ascent
, stretch_width
;
16849 struct text_pos saved_pos
;
16850 int saved_face_id
, saved_avoid_cursor
;
16852 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16853 row_width
+= g
->pixel_width
;
16854 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16855 if (stretch_width
> 0)
16858 (((it
->ascent
+ it
->descent
)
16859 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16860 saved_pos
= it
->position
;
16861 memset (&it
->position
, 0, sizeof it
->position
);
16862 saved_avoid_cursor
= it
->avoid_cursor_p
;
16863 it
->avoid_cursor_p
= 1;
16864 saved_face_id
= it
->face_id
;
16865 /* The last row's stretch glyph should get the default
16866 face, to avoid painting the rest of the window with
16867 the region face, if the region ends at ZV. */
16868 if (it
->glyph_row
->ends_at_zv_p
)
16869 it
->face_id
= DEFAULT_FACE_ID
;
16871 it
->face_id
= face
->id
;
16872 append_stretch_glyph (it
, make_number (0), stretch_width
,
16873 it
->ascent
+ it
->descent
, stretch_ascent
);
16874 it
->position
= saved_pos
;
16875 it
->avoid_cursor_p
= saved_avoid_cursor
;
16876 it
->face_id
= saved_face_id
;
16879 #endif /* HAVE_WINDOW_SYSTEM */
16883 /* Save some values that must not be changed. */
16884 int saved_x
= it
->current_x
;
16885 struct text_pos saved_pos
;
16886 Lisp_Object saved_object
;
16887 enum display_element_type saved_what
= it
->what
;
16888 int saved_face_id
= it
->face_id
;
16890 saved_object
= it
->object
;
16891 saved_pos
= it
->position
;
16893 it
->what
= IT_CHARACTER
;
16894 memset (&it
->position
, 0, sizeof it
->position
);
16895 it
->object
= make_number (0);
16896 it
->c
= it
->char_to_display
= ' ';
16898 /* The last row's blank glyphs should get the default face, to
16899 avoid painting the rest of the window with the region face,
16900 if the region ends at ZV. */
16901 if (it
->glyph_row
->ends_at_zv_p
)
16902 it
->face_id
= DEFAULT_FACE_ID
;
16904 it
->face_id
= face
->id
;
16906 PRODUCE_GLYPHS (it
);
16908 while (it
->current_x
<= it
->last_visible_x
)
16909 PRODUCE_GLYPHS (it
);
16911 /* Don't count these blanks really. It would let us insert a left
16912 truncation glyph below and make us set the cursor on them, maybe. */
16913 it
->current_x
= saved_x
;
16914 it
->object
= saved_object
;
16915 it
->position
= saved_pos
;
16916 it
->what
= saved_what
;
16917 it
->face_id
= saved_face_id
;
16922 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16923 trailing whitespace. */
16926 trailing_whitespace_p (EMACS_INT charpos
)
16928 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16931 while (bytepos
< ZV_BYTE
16932 && (c
= FETCH_CHAR (bytepos
),
16933 c
== ' ' || c
== '\t'))
16936 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16938 if (bytepos
!= PT_BYTE
)
16945 /* Highlight trailing whitespace, if any, in ROW. */
16948 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16950 int used
= row
->used
[TEXT_AREA
];
16954 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16955 struct glyph
*glyph
= start
+ used
- 1;
16957 if (row
->reversed_p
)
16959 /* Right-to-left rows need to be processed in the opposite
16960 direction, so swap the edge pointers. */
16962 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16965 /* Skip over glyphs inserted to display the cursor at the
16966 end of a line, for extending the face of the last glyph
16967 to the end of the line on terminals, and for truncation
16968 and continuation glyphs. */
16969 if (!row
->reversed_p
)
16971 while (glyph
>= start
16972 && glyph
->type
== CHAR_GLYPH
16973 && INTEGERP (glyph
->object
))
16978 while (glyph
<= start
16979 && glyph
->type
== CHAR_GLYPH
16980 && INTEGERP (glyph
->object
))
16984 /* If last glyph is a space or stretch, and it's trailing
16985 whitespace, set the face of all trailing whitespace glyphs in
16986 IT->glyph_row to `trailing-whitespace'. */
16987 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16988 && BUFFERP (glyph
->object
)
16989 && (glyph
->type
== STRETCH_GLYPH
16990 || (glyph
->type
== CHAR_GLYPH
16991 && glyph
->u
.ch
== ' '))
16992 && trailing_whitespace_p (glyph
->charpos
))
16994 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16998 if (!row
->reversed_p
)
17000 while (glyph
>= start
17001 && BUFFERP (glyph
->object
)
17002 && (glyph
->type
== STRETCH_GLYPH
17003 || (glyph
->type
== CHAR_GLYPH
17004 && glyph
->u
.ch
== ' ')))
17005 (glyph
--)->face_id
= face_id
;
17009 while (glyph
<= start
17010 && BUFFERP (glyph
->object
)
17011 && (glyph
->type
== STRETCH_GLYPH
17012 || (glyph
->type
== CHAR_GLYPH
17013 && glyph
->u
.ch
== ' ')))
17014 (glyph
++)->face_id
= face_id
;
17021 /* Value is non-zero if glyph row ROW should be
17022 used to hold the cursor. */
17025 cursor_row_p (struct glyph_row
*row
)
17029 if (PT
== CHARPOS (row
->end
.pos
))
17031 /* Suppose the row ends on a string.
17032 Unless the row is continued, that means it ends on a newline
17033 in the string. If it's anything other than a display string
17034 (e.g. a before-string from an overlay), we don't want the
17035 cursor there. (This heuristic seems to give the optimal
17036 behavior for the various types of multi-line strings.) */
17037 if (CHARPOS (row
->end
.string_pos
) >= 0)
17039 if (row
->continued_p
)
17043 /* Check for `display' property. */
17044 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17045 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17046 struct glyph
*glyph
;
17049 for (glyph
= end
; glyph
>= beg
; --glyph
)
17050 if (STRINGP (glyph
->object
))
17053 = Fget_char_property (make_number (PT
),
17057 && display_prop_string_p (prop
, glyph
->object
));
17062 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17064 /* If the row ends in middle of a real character,
17065 and the line is continued, we want the cursor here.
17066 That's because CHARPOS (ROW->end.pos) would equal
17067 PT if PT is before the character. */
17068 if (!row
->ends_in_ellipsis_p
)
17069 result
= row
->continued_p
;
17071 /* If the row ends in an ellipsis, then
17072 CHARPOS (ROW->end.pos) will equal point after the
17073 invisible text. We want that position to be displayed
17074 after the ellipsis. */
17077 /* If the row ends at ZV, display the cursor at the end of that
17078 row instead of at the start of the row below. */
17079 else if (row
->ends_at_zv_p
)
17090 /* Push the display property PROP so that it will be rendered at the
17091 current position in IT. Return 1 if PROP was successfully pushed,
17095 push_display_prop (struct it
*it
, Lisp_Object prop
)
17099 if (STRINGP (prop
))
17101 if (SCHARS (prop
) == 0)
17108 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17109 it
->current
.overlay_string_index
= -1;
17110 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17111 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17112 it
->method
= GET_FROM_STRING
;
17113 it
->stop_charpos
= 0;
17115 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17117 it
->method
= GET_FROM_STRETCH
;
17120 #ifdef HAVE_WINDOW_SYSTEM
17121 else if (IMAGEP (prop
))
17123 it
->what
= IT_IMAGE
;
17124 it
->image_id
= lookup_image (it
->f
, prop
);
17125 it
->method
= GET_FROM_IMAGE
;
17127 #endif /* HAVE_WINDOW_SYSTEM */
17130 pop_it (it
); /* bogus display property, give up */
17137 /* Return the character-property PROP at the current position in IT. */
17140 get_it_property (struct it
*it
, Lisp_Object prop
)
17142 Lisp_Object position
;
17144 if (STRINGP (it
->object
))
17145 position
= make_number (IT_STRING_CHARPOS (*it
));
17146 else if (BUFFERP (it
->object
))
17147 position
= make_number (IT_CHARPOS (*it
));
17151 return Fget_char_property (position
, prop
, it
->object
);
17154 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17157 handle_line_prefix (struct it
*it
)
17159 Lisp_Object prefix
;
17160 if (it
->continuation_lines_width
> 0)
17162 prefix
= get_it_property (it
, Qwrap_prefix
);
17164 prefix
= Vwrap_prefix
;
17168 prefix
= get_it_property (it
, Qline_prefix
);
17170 prefix
= Vline_prefix
;
17172 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17174 /* If the prefix is wider than the window, and we try to wrap
17175 it, it would acquire its own wrap prefix, and so on till the
17176 iterator stack overflows. So, don't wrap the prefix. */
17177 it
->line_wrap
= TRUNCATE
;
17178 it
->avoid_cursor_p
= 1;
17184 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17185 only for R2L lines from display_line, when it decides that too many
17186 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17189 unproduce_glyphs (struct it
*it
, int n
)
17191 struct glyph
*glyph
, *end
;
17193 xassert (it
->glyph_row
);
17194 xassert (it
->glyph_row
->reversed_p
);
17195 xassert (it
->area
== TEXT_AREA
);
17196 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17198 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17199 n
= it
->glyph_row
->used
[TEXT_AREA
];
17200 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17201 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17202 for ( ; glyph
< end
; glyph
++)
17203 glyph
[-n
] = *glyph
;
17206 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17207 and ROW->maxpos. */
17209 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17210 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17211 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17213 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17214 lines' rows is implemented for bidi-reordered rows. */
17216 /* ROW->minpos is the value of min_pos, the minimal buffer position
17219 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17221 /* We didn't find _any_ valid buffer positions in any of the
17222 glyphs, so we must trust the iterator's computed positions. */
17223 row
->minpos
= row
->start
.pos
;
17226 max_pos
= CHARPOS (it
->current
.pos
);
17227 max_bpos
= BYTEPOS (it
->current
.pos
);
17230 /* Here are the various use-cases for ending the row, and the
17231 corresponding values for ROW->maxpos:
17233 Line ends in a newline from buffer eol_pos + 1
17234 Line is continued from buffer max_pos + 1
17235 Line is truncated on right it->current.pos
17236 Line ends in a newline from string max_pos
17237 Line is continued from string max_pos
17238 Line is continued from display vector max_pos
17239 Line is entirely from a string min_pos == max_pos
17240 Line is entirely from a display vector min_pos == max_pos
17241 Line that ends at ZV ZV
17243 If you discover other use-cases, please add them here as
17245 if (row
->ends_at_zv_p
)
17246 row
->maxpos
= it
->current
.pos
;
17247 else if (row
->used
[TEXT_AREA
])
17249 if (row
->ends_in_newline_from_string_p
)
17250 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17251 else if (CHARPOS (it
->eol_pos
) > 0)
17252 SET_TEXT_POS (row
->maxpos
,
17253 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17254 else if (row
->continued_p
)
17256 /* If max_pos is different from IT's current position, it
17257 means IT->method does not belong to the display element
17258 at max_pos. However, it also means that the display
17259 element at max_pos was displayed in its entirety on this
17260 line, which is equivalent to saying that the next line
17261 starts at the next buffer position. */
17262 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17263 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17266 INC_BOTH (max_pos
, max_bpos
);
17267 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17270 else if (row
->truncated_on_right_p
)
17271 /* display_line already called reseat_at_next_visible_line_start,
17272 which puts the iterator at the beginning of the next line, in
17273 the logical order. */
17274 row
->maxpos
= it
->current
.pos
;
17275 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17276 /* A line that is entirely from a string/image/stretch... */
17277 row
->maxpos
= row
->minpos
;
17282 row
->maxpos
= it
->current
.pos
;
17285 /* Construct the glyph row IT->glyph_row in the desired matrix of
17286 IT->w from text at the current position of IT. See dispextern.h
17287 for an overview of struct it. Value is non-zero if
17288 IT->glyph_row displays text, as opposed to a line displaying ZV
17292 display_line (struct it
*it
)
17294 struct glyph_row
*row
= it
->glyph_row
;
17295 Lisp_Object overlay_arrow_string
;
17297 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17298 int wrap_row_used
= -1;
17299 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17300 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17301 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17302 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17303 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17305 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17306 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17308 /* We always start displaying at hpos zero even if hscrolled. */
17309 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17311 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17312 >= it
->w
->desired_matrix
->nrows
)
17314 it
->w
->nrows_scale_factor
++;
17315 fonts_changed_p
= 1;
17319 /* Is IT->w showing the region? */
17320 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17322 /* Clear the result glyph row and enable it. */
17323 prepare_desired_row (row
);
17325 row
->y
= it
->current_y
;
17326 row
->start
= it
->start
;
17327 row
->continuation_lines_width
= it
->continuation_lines_width
;
17328 row
->displays_text_p
= 1;
17329 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17330 it
->starts_in_middle_of_char_p
= 0;
17332 /* Arrange the overlays nicely for our purposes. Usually, we call
17333 display_line on only one line at a time, in which case this
17334 can't really hurt too much, or we call it on lines which appear
17335 one after another in the buffer, in which case all calls to
17336 recenter_overlay_lists but the first will be pretty cheap. */
17337 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17339 /* Move over display elements that are not visible because we are
17340 hscrolled. This may stop at an x-position < IT->first_visible_x
17341 if the first glyph is partially visible or if we hit a line end. */
17342 if (it
->current_x
< it
->first_visible_x
)
17344 this_line_min_pos
= row
->start
.pos
;
17345 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17346 MOVE_TO_POS
| MOVE_TO_X
);
17347 /* Record the smallest positions seen while we moved over
17348 display elements that are not visible. This is needed by
17349 redisplay_internal for optimizing the case where the cursor
17350 stays inside the same line. The rest of this function only
17351 considers positions that are actually displayed, so
17352 RECORD_MAX_MIN_POS will not otherwise record positions that
17353 are hscrolled to the left of the left edge of the window. */
17354 min_pos
= CHARPOS (this_line_min_pos
);
17355 min_bpos
= BYTEPOS (this_line_min_pos
);
17359 /* We only do this when not calling `move_it_in_display_line_to'
17360 above, because move_it_in_display_line_to calls
17361 handle_line_prefix itself. */
17362 handle_line_prefix (it
);
17365 /* Get the initial row height. This is either the height of the
17366 text hscrolled, if there is any, or zero. */
17367 row
->ascent
= it
->max_ascent
;
17368 row
->height
= it
->max_ascent
+ it
->max_descent
;
17369 row
->phys_ascent
= it
->max_phys_ascent
;
17370 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17371 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17373 /* Utility macro to record max and min buffer positions seen until now. */
17374 #define RECORD_MAX_MIN_POS(IT) \
17377 if (IT_CHARPOS (*(IT)) < min_pos) \
17379 min_pos = IT_CHARPOS (*(IT)); \
17380 min_bpos = IT_BYTEPOS (*(IT)); \
17382 if (IT_CHARPOS (*(IT)) > max_pos) \
17384 max_pos = IT_CHARPOS (*(IT)); \
17385 max_bpos = IT_BYTEPOS (*(IT)); \
17390 /* Loop generating characters. The loop is left with IT on the next
17391 character to display. */
17394 int n_glyphs_before
, hpos_before
, x_before
;
17396 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17398 /* Retrieve the next thing to display. Value is zero if end of
17400 if (!get_next_display_element (it
))
17402 /* Maybe add a space at the end of this line that is used to
17403 display the cursor there under X. Set the charpos of the
17404 first glyph of blank lines not corresponding to any text
17406 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17407 row
->exact_window_width_line_p
= 1;
17408 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17409 || row
->used
[TEXT_AREA
] == 0)
17411 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17412 row
->displays_text_p
= 0;
17414 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17415 && (!MINI_WINDOW_P (it
->w
)
17416 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17417 row
->indicate_empty_line_p
= 1;
17420 it
->continuation_lines_width
= 0;
17421 row
->ends_at_zv_p
= 1;
17422 /* A row that displays right-to-left text must always have
17423 its last face extended all the way to the end of line,
17424 even if this row ends in ZV, because we still write to
17425 the screen left to right. */
17426 if (row
->reversed_p
)
17427 extend_face_to_end_of_line (it
);
17431 /* Now, get the metrics of what we want to display. This also
17432 generates glyphs in `row' (which is IT->glyph_row). */
17433 n_glyphs_before
= row
->used
[TEXT_AREA
];
17436 /* Remember the line height so far in case the next element doesn't
17437 fit on the line. */
17438 if (it
->line_wrap
!= TRUNCATE
)
17440 ascent
= it
->max_ascent
;
17441 descent
= it
->max_descent
;
17442 phys_ascent
= it
->max_phys_ascent
;
17443 phys_descent
= it
->max_phys_descent
;
17445 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17447 if (IT_DISPLAYING_WHITESPACE (it
))
17453 wrap_row_used
= row
->used
[TEXT_AREA
];
17454 wrap_row_ascent
= row
->ascent
;
17455 wrap_row_height
= row
->height
;
17456 wrap_row_phys_ascent
= row
->phys_ascent
;
17457 wrap_row_phys_height
= row
->phys_height
;
17458 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17459 wrap_row_min_pos
= min_pos
;
17460 wrap_row_min_bpos
= min_bpos
;
17461 wrap_row_max_pos
= max_pos
;
17462 wrap_row_max_bpos
= max_bpos
;
17468 PRODUCE_GLYPHS (it
);
17470 /* If this display element was in marginal areas, continue with
17472 if (it
->area
!= TEXT_AREA
)
17474 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17475 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17476 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17477 row
->phys_height
= max (row
->phys_height
,
17478 it
->max_phys_ascent
+ it
->max_phys_descent
);
17479 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17480 it
->max_extra_line_spacing
);
17481 set_iterator_to_next (it
, 1);
17485 /* Does the display element fit on the line? If we truncate
17486 lines, we should draw past the right edge of the window. If
17487 we don't truncate, we want to stop so that we can display the
17488 continuation glyph before the right margin. If lines are
17489 continued, there are two possible strategies for characters
17490 resulting in more than 1 glyph (e.g. tabs): Display as many
17491 glyphs as possible in this line and leave the rest for the
17492 continuation line, or display the whole element in the next
17493 line. Original redisplay did the former, so we do it also. */
17494 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17495 hpos_before
= it
->hpos
;
17498 if (/* Not a newline. */
17500 /* Glyphs produced fit entirely in the line. */
17501 && it
->current_x
< it
->last_visible_x
)
17503 it
->hpos
+= nglyphs
;
17504 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17505 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17506 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17507 row
->phys_height
= max (row
->phys_height
,
17508 it
->max_phys_ascent
+ it
->max_phys_descent
);
17509 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17510 it
->max_extra_line_spacing
);
17511 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17512 row
->x
= x
- it
->first_visible_x
;
17513 /* Record the maximum and minimum buffer positions seen so
17514 far in glyphs that will be displayed by this row. */
17516 RECORD_MAX_MIN_POS (it
);
17521 struct glyph
*glyph
;
17523 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17525 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17526 new_x
= x
+ glyph
->pixel_width
;
17528 if (/* Lines are continued. */
17529 it
->line_wrap
!= TRUNCATE
17530 && (/* Glyph doesn't fit on the line. */
17531 new_x
> it
->last_visible_x
17532 /* Or it fits exactly on a window system frame. */
17533 || (new_x
== it
->last_visible_x
17534 && FRAME_WINDOW_P (it
->f
))))
17536 /* End of a continued line. */
17539 || (new_x
== it
->last_visible_x
17540 && FRAME_WINDOW_P (it
->f
)))
17542 /* Current glyph is the only one on the line or
17543 fits exactly on the line. We must continue
17544 the line because we can't draw the cursor
17545 after the glyph. */
17546 row
->continued_p
= 1;
17547 it
->current_x
= new_x
;
17548 it
->continuation_lines_width
+= new_x
;
17550 /* Record the maximum and minimum buffer
17551 positions seen so far in glyphs that will be
17552 displayed by this row. */
17554 RECORD_MAX_MIN_POS (it
);
17555 if (i
== nglyphs
- 1)
17557 /* If line-wrap is on, check if a previous
17558 wrap point was found. */
17559 if (wrap_row_used
> 0
17560 /* Even if there is a previous wrap
17561 point, continue the line here as
17562 usual, if (i) the previous character
17563 was a space or tab AND (ii) the
17564 current character is not. */
17566 || IT_DISPLAYING_WHITESPACE (it
)))
17569 set_iterator_to_next (it
, 1);
17570 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17572 if (!get_next_display_element (it
))
17574 row
->exact_window_width_line_p
= 1;
17575 it
->continuation_lines_width
= 0;
17576 row
->continued_p
= 0;
17577 row
->ends_at_zv_p
= 1;
17579 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17581 row
->continued_p
= 0;
17582 row
->exact_window_width_line_p
= 1;
17587 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17588 && !FRAME_WINDOW_P (it
->f
))
17590 /* A padding glyph that doesn't fit on this line.
17591 This means the whole character doesn't fit
17593 if (row
->reversed_p
)
17594 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17595 - n_glyphs_before
);
17596 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17598 /* Fill the rest of the row with continuation
17599 glyphs like in 20.x. */
17600 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17601 < row
->glyphs
[1 + TEXT_AREA
])
17602 produce_special_glyphs (it
, IT_CONTINUATION
);
17604 row
->continued_p
= 1;
17605 it
->current_x
= x_before
;
17606 it
->continuation_lines_width
+= x_before
;
17608 /* Restore the height to what it was before the
17609 element not fitting on the line. */
17610 it
->max_ascent
= ascent
;
17611 it
->max_descent
= descent
;
17612 it
->max_phys_ascent
= phys_ascent
;
17613 it
->max_phys_descent
= phys_descent
;
17615 else if (wrap_row_used
> 0)
17618 if (row
->reversed_p
)
17619 unproduce_glyphs (it
,
17620 row
->used
[TEXT_AREA
] - wrap_row_used
);
17622 it
->continuation_lines_width
+= wrap_x
;
17623 row
->used
[TEXT_AREA
] = wrap_row_used
;
17624 row
->ascent
= wrap_row_ascent
;
17625 row
->height
= wrap_row_height
;
17626 row
->phys_ascent
= wrap_row_phys_ascent
;
17627 row
->phys_height
= wrap_row_phys_height
;
17628 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17629 min_pos
= wrap_row_min_pos
;
17630 min_bpos
= wrap_row_min_bpos
;
17631 max_pos
= wrap_row_max_pos
;
17632 max_bpos
= wrap_row_max_bpos
;
17633 row
->continued_p
= 1;
17634 row
->ends_at_zv_p
= 0;
17635 row
->exact_window_width_line_p
= 0;
17636 it
->continuation_lines_width
+= x
;
17638 /* Make sure that a non-default face is extended
17639 up to the right margin of the window. */
17640 extend_face_to_end_of_line (it
);
17642 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17644 /* A TAB that extends past the right edge of the
17645 window. This produces a single glyph on
17646 window system frames. We leave the glyph in
17647 this row and let it fill the row, but don't
17648 consume the TAB. */
17649 it
->continuation_lines_width
+= it
->last_visible_x
;
17650 row
->ends_in_middle_of_char_p
= 1;
17651 row
->continued_p
= 1;
17652 glyph
->pixel_width
= it
->last_visible_x
- x
;
17653 it
->starts_in_middle_of_char_p
= 1;
17657 /* Something other than a TAB that draws past
17658 the right edge of the window. Restore
17659 positions to values before the element. */
17660 if (row
->reversed_p
)
17661 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17662 - (n_glyphs_before
+ i
));
17663 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17665 /* Display continuation glyphs. */
17666 if (!FRAME_WINDOW_P (it
->f
))
17667 produce_special_glyphs (it
, IT_CONTINUATION
);
17668 row
->continued_p
= 1;
17670 it
->current_x
= x_before
;
17671 it
->continuation_lines_width
+= x
;
17672 extend_face_to_end_of_line (it
);
17674 if (nglyphs
> 1 && i
> 0)
17676 row
->ends_in_middle_of_char_p
= 1;
17677 it
->starts_in_middle_of_char_p
= 1;
17680 /* Restore the height to what it was before the
17681 element not fitting on the line. */
17682 it
->max_ascent
= ascent
;
17683 it
->max_descent
= descent
;
17684 it
->max_phys_ascent
= phys_ascent
;
17685 it
->max_phys_descent
= phys_descent
;
17690 else if (new_x
> it
->first_visible_x
)
17692 /* Increment number of glyphs actually displayed. */
17695 /* Record the maximum and minimum buffer positions
17696 seen so far in glyphs that will be displayed by
17699 RECORD_MAX_MIN_POS (it
);
17701 if (x
< it
->first_visible_x
)
17702 /* Glyph is partially visible, i.e. row starts at
17703 negative X position. */
17704 row
->x
= x
- it
->first_visible_x
;
17708 /* Glyph is completely off the left margin of the
17709 window. This should not happen because of the
17710 move_it_in_display_line at the start of this
17711 function, unless the text display area of the
17712 window is empty. */
17713 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17717 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17718 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17719 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17720 row
->phys_height
= max (row
->phys_height
,
17721 it
->max_phys_ascent
+ it
->max_phys_descent
);
17722 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17723 it
->max_extra_line_spacing
);
17725 /* End of this display line if row is continued. */
17726 if (row
->continued_p
|| row
->ends_at_zv_p
)
17731 /* Is this a line end? If yes, we're also done, after making
17732 sure that a non-default face is extended up to the right
17733 margin of the window. */
17734 if (ITERATOR_AT_END_OF_LINE_P (it
))
17736 int used_before
= row
->used
[TEXT_AREA
];
17738 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17740 /* Add a space at the end of the line that is used to
17741 display the cursor there. */
17742 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17743 append_space_for_newline (it
, 0);
17745 /* Extend the face to the end of the line. */
17746 extend_face_to_end_of_line (it
);
17748 /* Make sure we have the position. */
17749 if (used_before
== 0)
17750 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17752 /* Record the position of the newline, for use in
17754 it
->eol_pos
= it
->current
.pos
;
17756 /* Consume the line end. This skips over invisible lines. */
17757 set_iterator_to_next (it
, 1);
17758 it
->continuation_lines_width
= 0;
17762 /* Proceed with next display element. Note that this skips
17763 over lines invisible because of selective display. */
17764 set_iterator_to_next (it
, 1);
17766 /* If we truncate lines, we are done when the last displayed
17767 glyphs reach past the right margin of the window. */
17768 if (it
->line_wrap
== TRUNCATE
17769 && (FRAME_WINDOW_P (it
->f
)
17770 ? (it
->current_x
>= it
->last_visible_x
)
17771 : (it
->current_x
> it
->last_visible_x
)))
17773 /* Maybe add truncation glyphs. */
17774 if (!FRAME_WINDOW_P (it
->f
))
17778 if (!row
->reversed_p
)
17780 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17781 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17786 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17787 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17789 /* Remove any padding glyphs at the front of ROW, to
17790 make room for the truncation glyphs we will be
17791 adding below. The loop below always inserts at
17792 least one truncation glyph, so also remove the
17793 last glyph added to ROW. */
17794 unproduce_glyphs (it
, i
+ 1);
17795 /* Adjust i for the loop below. */
17796 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17799 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17801 row
->used
[TEXT_AREA
] = i
;
17802 produce_special_glyphs (it
, IT_TRUNCATION
);
17805 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17807 /* Don't truncate if we can overflow newline into fringe. */
17808 if (!get_next_display_element (it
))
17810 it
->continuation_lines_width
= 0;
17811 row
->ends_at_zv_p
= 1;
17812 row
->exact_window_width_line_p
= 1;
17815 if (ITERATOR_AT_END_OF_LINE_P (it
))
17817 row
->exact_window_width_line_p
= 1;
17818 goto at_end_of_line
;
17822 row
->truncated_on_right_p
= 1;
17823 it
->continuation_lines_width
= 0;
17824 reseat_at_next_visible_line_start (it
, 0);
17825 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17826 it
->hpos
= hpos_before
;
17827 it
->current_x
= x_before
;
17832 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17833 at the left window margin. */
17834 if (it
->first_visible_x
17835 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17837 if (!FRAME_WINDOW_P (it
->f
))
17838 insert_left_trunc_glyphs (it
);
17839 row
->truncated_on_left_p
= 1;
17842 /* Remember the position at which this line ends.
17844 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17845 cannot be before the call to find_row_edges below, since that is
17846 where these positions are determined. */
17847 row
->end
= it
->current
;
17850 row
->minpos
= row
->start
.pos
;
17851 row
->maxpos
= row
->end
.pos
;
17855 /* ROW->minpos and ROW->maxpos must be the smallest and
17856 `1 + the largest' buffer positions in ROW. But if ROW was
17857 bidi-reordered, these two positions can be anywhere in the
17858 row, so we must determine them now. */
17859 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17862 /* If the start of this line is the overlay arrow-position, then
17863 mark this glyph row as the one containing the overlay arrow.
17864 This is clearly a mess with variable size fonts. It would be
17865 better to let it be displayed like cursors under X. */
17866 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17867 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17868 !NILP (overlay_arrow_string
)))
17870 /* Overlay arrow in window redisplay is a fringe bitmap. */
17871 if (STRINGP (overlay_arrow_string
))
17873 struct glyph_row
*arrow_row
17874 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17875 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17876 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17877 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17878 struct glyph
*p2
, *end
;
17880 /* Copy the arrow glyphs. */
17881 while (glyph
< arrow_end
)
17884 /* Throw away padding glyphs. */
17886 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17887 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17893 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17898 xassert (INTEGERP (overlay_arrow_string
));
17899 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17901 overlay_arrow_seen
= 1;
17904 /* Compute pixel dimensions of this line. */
17905 compute_line_metrics (it
);
17907 /* Record whether this row ends inside an ellipsis. */
17908 row
->ends_in_ellipsis_p
17909 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17910 && it
->ellipsis_p
);
17912 /* Save fringe bitmaps in this row. */
17913 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17914 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17915 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17916 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17918 it
->left_user_fringe_bitmap
= 0;
17919 it
->left_user_fringe_face_id
= 0;
17920 it
->right_user_fringe_bitmap
= 0;
17921 it
->right_user_fringe_face_id
= 0;
17923 /* Maybe set the cursor. */
17924 cvpos
= it
->w
->cursor
.vpos
;
17926 /* In bidi-reordered rows, keep checking for proper cursor
17927 position even if one has been found already, because buffer
17928 positions in such rows change non-linearly with ROW->VPOS,
17929 when a line is continued. One exception: when we are at ZV,
17930 display cursor on the first suitable glyph row, since all
17931 the empty rows after that also have their position set to ZV. */
17932 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17933 lines' rows is implemented for bidi-reordered rows. */
17935 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17936 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17937 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17938 && cursor_row_p (row
))
17939 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17941 /* Highlight trailing whitespace. */
17942 if (!NILP (Vshow_trailing_whitespace
))
17943 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17945 /* Prepare for the next line. This line starts horizontally at (X
17946 HPOS) = (0 0). Vertical positions are incremented. As a
17947 convenience for the caller, IT->glyph_row is set to the next
17949 it
->current_x
= it
->hpos
= 0;
17950 it
->current_y
+= row
->height
;
17951 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17954 /* The next row should by default use the same value of the
17955 reversed_p flag as this one. set_iterator_to_next decides when
17956 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17957 the flag accordingly. */
17958 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17959 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17960 it
->start
= row
->end
;
17961 return row
->displays_text_p
;
17963 #undef RECORD_MAX_MIN_POS
17966 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17967 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17968 doc
: /* Return paragraph direction at point in BUFFER.
17969 Value is either `left-to-right' or `right-to-left'.
17970 If BUFFER is omitted or nil, it defaults to the current buffer.
17972 Paragraph direction determines how the text in the paragraph is displayed.
17973 In left-to-right paragraphs, text begins at the left margin of the window
17974 and the reading direction is generally left to right. In right-to-left
17975 paragraphs, text begins at the right margin and is read from right to left.
17977 See also `bidi-paragraph-direction'. */)
17978 (Lisp_Object buffer
)
17980 struct buffer
*buf
= current_buffer
;
17981 struct buffer
*old
= buf
;
17983 if (! NILP (buffer
))
17985 CHECK_BUFFER (buffer
);
17986 buf
= XBUFFER (buffer
);
17989 if (NILP (BVAR (buf
, bidi_display_reordering
)))
17990 return Qleft_to_right
;
17991 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
17992 return BVAR (buf
, bidi_paragraph_direction
);
17995 /* Determine the direction from buffer text. We could try to
17996 use current_matrix if it is up to date, but this seems fast
17997 enough as it is. */
17998 struct bidi_it itb
;
17999 EMACS_INT pos
= BUF_PT (buf
);
18000 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18003 set_buffer_temp (buf
);
18004 /* bidi_paragraph_init finds the base direction of the paragraph
18005 by searching forward from paragraph start. We need the base
18006 direction of the current or _previous_ paragraph, so we need
18007 to make sure we are within that paragraph. To that end, find
18008 the previous non-empty line. */
18009 if (pos
>= ZV
&& pos
> BEGV
)
18012 bytepos
= CHAR_TO_BYTE (pos
);
18014 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18015 || c
== ' ' || c
== '\t' || c
== '\f')
18017 if (bytepos
<= BEGV_BYTE
)
18022 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18025 itb
.bytepos
= bytepos
;
18027 itb
.separator_limit
= -1;
18028 itb
.paragraph_dir
= NEUTRAL_DIR
;
18030 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18031 set_buffer_temp (old
);
18032 switch (itb
.paragraph_dir
)
18035 return Qleft_to_right
;
18038 return Qright_to_left
;
18048 /***********************************************************************
18050 ***********************************************************************/
18052 /* Redisplay the menu bar in the frame for window W.
18054 The menu bar of X frames that don't have X toolkit support is
18055 displayed in a special window W->frame->menu_bar_window.
18057 The menu bar of terminal frames is treated specially as far as
18058 glyph matrices are concerned. Menu bar lines are not part of
18059 windows, so the update is done directly on the frame matrix rows
18060 for the menu bar. */
18063 display_menu_bar (struct window
*w
)
18065 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18070 /* Don't do all this for graphical frames. */
18072 if (FRAME_W32_P (f
))
18075 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18081 if (FRAME_NS_P (f
))
18083 #endif /* HAVE_NS */
18085 #ifdef USE_X_TOOLKIT
18086 xassert (!FRAME_WINDOW_P (f
));
18087 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18088 it
.first_visible_x
= 0;
18089 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18090 #else /* not USE_X_TOOLKIT */
18091 if (FRAME_WINDOW_P (f
))
18093 /* Menu bar lines are displayed in the desired matrix of the
18094 dummy window menu_bar_window. */
18095 struct window
*menu_w
;
18096 xassert (WINDOWP (f
->menu_bar_window
));
18097 menu_w
= XWINDOW (f
->menu_bar_window
);
18098 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18100 it
.first_visible_x
= 0;
18101 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18105 /* This is a TTY frame, i.e. character hpos/vpos are used as
18107 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18109 it
.first_visible_x
= 0;
18110 it
.last_visible_x
= FRAME_COLS (f
);
18112 #endif /* not USE_X_TOOLKIT */
18114 if (! mode_line_inverse_video
)
18115 /* Force the menu-bar to be displayed in the default face. */
18116 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18118 /* Clear all rows of the menu bar. */
18119 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18121 struct glyph_row
*row
= it
.glyph_row
+ i
;
18122 clear_glyph_row (row
);
18123 row
->enabled_p
= 1;
18124 row
->full_width_p
= 1;
18127 /* Display all items of the menu bar. */
18128 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18129 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18131 Lisp_Object string
;
18133 /* Stop at nil string. */
18134 string
= AREF (items
, i
+ 1);
18138 /* Remember where item was displayed. */
18139 ASET (items
, i
+ 3, make_number (it
.hpos
));
18141 /* Display the item, pad with one space. */
18142 if (it
.current_x
< it
.last_visible_x
)
18143 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18144 SCHARS (string
) + 1, 0, 0, -1);
18147 /* Fill out the line with spaces. */
18148 if (it
.current_x
< it
.last_visible_x
)
18149 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18151 /* Compute the total height of the lines. */
18152 compute_line_metrics (&it
);
18157 /***********************************************************************
18159 ***********************************************************************/
18161 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18162 FORCE is non-zero, redisplay mode lines unconditionally.
18163 Otherwise, redisplay only mode lines that are garbaged. Value is
18164 the number of windows whose mode lines were redisplayed. */
18167 redisplay_mode_lines (Lisp_Object window
, int force
)
18171 while (!NILP (window
))
18173 struct window
*w
= XWINDOW (window
);
18175 if (WINDOWP (w
->hchild
))
18176 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18177 else if (WINDOWP (w
->vchild
))
18178 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18180 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18181 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18183 struct text_pos lpoint
;
18184 struct buffer
*old
= current_buffer
;
18186 /* Set the window's buffer for the mode line display. */
18187 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18188 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18190 /* Point refers normally to the selected window. For any
18191 other window, set up appropriate value. */
18192 if (!EQ (window
, selected_window
))
18194 struct text_pos pt
;
18196 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18197 if (CHARPOS (pt
) < BEGV
)
18198 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18199 else if (CHARPOS (pt
) > (ZV
- 1))
18200 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18202 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18205 /* Display mode lines. */
18206 clear_glyph_matrix (w
->desired_matrix
);
18207 if (display_mode_lines (w
))
18210 w
->must_be_updated_p
= 1;
18213 /* Restore old settings. */
18214 set_buffer_internal_1 (old
);
18215 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18225 /* Display the mode and/or header line of window W. Value is the
18226 sum number of mode lines and header lines displayed. */
18229 display_mode_lines (struct window
*w
)
18231 Lisp_Object old_selected_window
, old_selected_frame
;
18234 old_selected_frame
= selected_frame
;
18235 selected_frame
= w
->frame
;
18236 old_selected_window
= selected_window
;
18237 XSETWINDOW (selected_window
, w
);
18239 /* These will be set while the mode line specs are processed. */
18240 line_number_displayed
= 0;
18241 w
->column_number_displayed
= Qnil
;
18243 if (WINDOW_WANTS_MODELINE_P (w
))
18245 struct window
*sel_w
= XWINDOW (old_selected_window
);
18247 /* Select mode line face based on the real selected window. */
18248 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18249 BVAR (current_buffer
, mode_line_format
));
18253 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18255 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18256 BVAR (current_buffer
, header_line_format
));
18260 selected_frame
= old_selected_frame
;
18261 selected_window
= old_selected_window
;
18266 /* Display mode or header line of window W. FACE_ID specifies which
18267 line to display; it is either MODE_LINE_FACE_ID or
18268 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18269 display. Value is the pixel height of the mode/header line
18273 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18277 int count
= SPECPDL_INDEX ();
18279 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18280 /* Don't extend on a previously drawn mode-line.
18281 This may happen if called from pos_visible_p. */
18282 it
.glyph_row
->enabled_p
= 0;
18283 prepare_desired_row (it
.glyph_row
);
18285 it
.glyph_row
->mode_line_p
= 1;
18287 if (! mode_line_inverse_video
)
18288 /* Force the mode-line to be displayed in the default face. */
18289 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18291 record_unwind_protect (unwind_format_mode_line
,
18292 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18294 mode_line_target
= MODE_LINE_DISPLAY
;
18296 /* Temporarily make frame's keyboard the current kboard so that
18297 kboard-local variables in the mode_line_format will get the right
18299 push_kboard (FRAME_KBOARD (it
.f
));
18300 record_unwind_save_match_data ();
18301 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18304 unbind_to (count
, Qnil
);
18306 /* Fill up with spaces. */
18307 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18309 compute_line_metrics (&it
);
18310 it
.glyph_row
->full_width_p
= 1;
18311 it
.glyph_row
->continued_p
= 0;
18312 it
.glyph_row
->truncated_on_left_p
= 0;
18313 it
.glyph_row
->truncated_on_right_p
= 0;
18315 /* Make a 3D mode-line have a shadow at its right end. */
18316 face
= FACE_FROM_ID (it
.f
, face_id
);
18317 extend_face_to_end_of_line (&it
);
18318 if (face
->box
!= FACE_NO_BOX
)
18320 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18321 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18322 last
->right_box_line_p
= 1;
18325 return it
.glyph_row
->height
;
18328 /* Move element ELT in LIST to the front of LIST.
18329 Return the updated list. */
18332 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18334 register Lisp_Object tail
, prev
;
18335 register Lisp_Object tem
;
18339 while (CONSP (tail
))
18345 /* Splice out the link TAIL. */
18347 list
= XCDR (tail
);
18349 Fsetcdr (prev
, XCDR (tail
));
18351 /* Now make it the first. */
18352 Fsetcdr (tail
, list
);
18357 tail
= XCDR (tail
);
18361 /* Not found--return unchanged LIST. */
18365 /* Contribute ELT to the mode line for window IT->w. How it
18366 translates into text depends on its data type.
18368 IT describes the display environment in which we display, as usual.
18370 DEPTH is the depth in recursion. It is used to prevent
18371 infinite recursion here.
18373 FIELD_WIDTH is the number of characters the display of ELT should
18374 occupy in the mode line, and PRECISION is the maximum number of
18375 characters to display from ELT's representation. See
18376 display_string for details.
18378 Returns the hpos of the end of the text generated by ELT.
18380 PROPS is a property list to add to any string we encounter.
18382 If RISKY is nonzero, remove (disregard) any properties in any string
18383 we encounter, and ignore :eval and :propertize.
18385 The global variable `mode_line_target' determines whether the
18386 output is passed to `store_mode_line_noprop',
18387 `store_mode_line_string', or `display_string'. */
18390 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18391 Lisp_Object elt
, Lisp_Object props
, int risky
)
18393 int n
= 0, field
, prec
;
18398 elt
= build_string ("*too-deep*");
18402 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18406 /* A string: output it and check for %-constructs within it. */
18408 EMACS_INT offset
= 0;
18410 if (SCHARS (elt
) > 0
18411 && (!NILP (props
) || risky
))
18413 Lisp_Object oprops
, aelt
;
18414 oprops
= Ftext_properties_at (make_number (0), elt
);
18416 /* If the starting string's properties are not what
18417 we want, translate the string. Also, if the string
18418 is risky, do that anyway. */
18420 if (NILP (Fequal (props
, oprops
)) || risky
)
18422 /* If the starting string has properties,
18423 merge the specified ones onto the existing ones. */
18424 if (! NILP (oprops
) && !risky
)
18428 oprops
= Fcopy_sequence (oprops
);
18430 while (CONSP (tem
))
18432 oprops
= Fplist_put (oprops
, XCAR (tem
),
18433 XCAR (XCDR (tem
)));
18434 tem
= XCDR (XCDR (tem
));
18439 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18440 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18442 /* AELT is what we want. Move it to the front
18443 without consing. */
18445 mode_line_proptrans_alist
18446 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18452 /* If AELT has the wrong props, it is useless.
18453 so get rid of it. */
18455 mode_line_proptrans_alist
18456 = Fdelq (aelt
, mode_line_proptrans_alist
);
18458 elt
= Fcopy_sequence (elt
);
18459 Fset_text_properties (make_number (0), Flength (elt
),
18461 /* Add this item to mode_line_proptrans_alist. */
18462 mode_line_proptrans_alist
18463 = Fcons (Fcons (elt
, props
),
18464 mode_line_proptrans_alist
);
18465 /* Truncate mode_line_proptrans_alist
18466 to at most 50 elements. */
18467 tem
= Fnthcdr (make_number (50),
18468 mode_line_proptrans_alist
);
18470 XSETCDR (tem
, Qnil
);
18479 prec
= precision
- n
;
18480 switch (mode_line_target
)
18482 case MODE_LINE_NOPROP
:
18483 case MODE_LINE_TITLE
:
18484 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18486 case MODE_LINE_STRING
:
18487 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18489 case MODE_LINE_DISPLAY
:
18490 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18491 0, prec
, 0, STRING_MULTIBYTE (elt
));
18498 /* Handle the non-literal case. */
18500 while ((precision
<= 0 || n
< precision
)
18501 && SREF (elt
, offset
) != 0
18502 && (mode_line_target
!= MODE_LINE_DISPLAY
18503 || it
->current_x
< it
->last_visible_x
))
18505 EMACS_INT last_offset
= offset
;
18507 /* Advance to end of string or next format specifier. */
18508 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18511 if (offset
- 1 != last_offset
)
18513 EMACS_INT nchars
, nbytes
;
18515 /* Output to end of string or up to '%'. Field width
18516 is length of string. Don't output more than
18517 PRECISION allows us. */
18520 prec
= c_string_width (SDATA (elt
) + last_offset
,
18521 offset
- last_offset
, precision
- n
,
18524 switch (mode_line_target
)
18526 case MODE_LINE_NOPROP
:
18527 case MODE_LINE_TITLE
:
18528 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18530 case MODE_LINE_STRING
:
18532 EMACS_INT bytepos
= last_offset
;
18533 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18534 EMACS_INT endpos
= (precision
<= 0
18535 ? string_byte_to_char (elt
, offset
)
18536 : charpos
+ nchars
);
18538 n
+= store_mode_line_string (NULL
,
18539 Fsubstring (elt
, make_number (charpos
),
18540 make_number (endpos
)),
18544 case MODE_LINE_DISPLAY
:
18546 EMACS_INT bytepos
= last_offset
;
18547 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18549 if (precision
<= 0)
18550 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18551 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18553 STRING_MULTIBYTE (elt
));
18558 else /* c == '%' */
18560 EMACS_INT percent_position
= offset
;
18562 /* Get the specified minimum width. Zero means
18565 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18566 field
= field
* 10 + c
- '0';
18568 /* Don't pad beyond the total padding allowed. */
18569 if (field_width
- n
> 0 && field
> field_width
- n
)
18570 field
= field_width
- n
;
18572 /* Note that either PRECISION <= 0 or N < PRECISION. */
18573 prec
= precision
- n
;
18576 n
+= display_mode_element (it
, depth
, field
, prec
,
18577 Vglobal_mode_string
, props
,
18582 EMACS_INT bytepos
, charpos
;
18584 Lisp_Object string
;
18586 bytepos
= percent_position
;
18587 charpos
= (STRING_MULTIBYTE (elt
)
18588 ? string_byte_to_char (elt
, bytepos
)
18590 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18591 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18593 switch (mode_line_target
)
18595 case MODE_LINE_NOPROP
:
18596 case MODE_LINE_TITLE
:
18597 n
+= store_mode_line_noprop (spec
, field
, prec
);
18599 case MODE_LINE_STRING
:
18601 int len
= strlen (spec
);
18602 Lisp_Object tem
= make_string (spec
, len
);
18603 props
= Ftext_properties_at (make_number (charpos
), elt
);
18604 /* Should only keep face property in props */
18605 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18608 case MODE_LINE_DISPLAY
:
18610 int nglyphs_before
, nwritten
;
18612 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18613 nwritten
= display_string (spec
, string
, elt
,
18618 /* Assign to the glyphs written above the
18619 string where the `%x' came from, position
18623 struct glyph
*glyph
18624 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18628 for (i
= 0; i
< nwritten
; ++i
)
18630 glyph
[i
].object
= elt
;
18631 glyph
[i
].charpos
= charpos
;
18648 /* A symbol: process the value of the symbol recursively
18649 as if it appeared here directly. Avoid error if symbol void.
18650 Special case: if value of symbol is a string, output the string
18653 register Lisp_Object tem
;
18655 /* If the variable is not marked as risky to set
18656 then its contents are risky to use. */
18657 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18660 tem
= Fboundp (elt
);
18663 tem
= Fsymbol_value (elt
);
18664 /* If value is a string, output that string literally:
18665 don't check for % within it. */
18669 if (!EQ (tem
, elt
))
18671 /* Give up right away for nil or t. */
18681 register Lisp_Object car
, tem
;
18683 /* A cons cell: five distinct cases.
18684 If first element is :eval or :propertize, do something special.
18685 If first element is a string or a cons, process all the elements
18686 and effectively concatenate them.
18687 If first element is a negative number, truncate displaying cdr to
18688 at most that many characters. If positive, pad (with spaces)
18689 to at least that many characters.
18690 If first element is a symbol, process the cadr or caddr recursively
18691 according to whether the symbol's value is non-nil or nil. */
18693 if (EQ (car
, QCeval
))
18695 /* An element of the form (:eval FORM) means evaluate FORM
18696 and use the result as mode line elements. */
18701 if (CONSP (XCDR (elt
)))
18704 spec
= safe_eval (XCAR (XCDR (elt
)));
18705 n
+= display_mode_element (it
, depth
, field_width
- n
,
18706 precision
- n
, spec
, props
,
18710 else if (EQ (car
, QCpropertize
))
18712 /* An element of the form (:propertize ELT PROPS...)
18713 means display ELT but applying properties PROPS. */
18718 if (CONSP (XCDR (elt
)))
18719 n
+= display_mode_element (it
, depth
, field_width
- n
,
18720 precision
- n
, XCAR (XCDR (elt
)),
18721 XCDR (XCDR (elt
)), risky
);
18723 else if (SYMBOLP (car
))
18725 tem
= Fboundp (car
);
18729 /* elt is now the cdr, and we know it is a cons cell.
18730 Use its car if CAR has a non-nil value. */
18733 tem
= Fsymbol_value (car
);
18740 /* Symbol's value is nil (or symbol is unbound)
18741 Get the cddr of the original list
18742 and if possible find the caddr and use that. */
18746 else if (!CONSP (elt
))
18751 else if (INTEGERP (car
))
18753 register int lim
= XINT (car
);
18757 /* Negative int means reduce maximum width. */
18758 if (precision
<= 0)
18761 precision
= min (precision
, -lim
);
18765 /* Padding specified. Don't let it be more than
18766 current maximum. */
18768 lim
= min (precision
, lim
);
18770 /* If that's more padding than already wanted, queue it.
18771 But don't reduce padding already specified even if
18772 that is beyond the current truncation point. */
18773 field_width
= max (lim
, field_width
);
18777 else if (STRINGP (car
) || CONSP (car
))
18779 Lisp_Object halftail
= elt
;
18783 && (precision
<= 0 || n
< precision
))
18785 n
+= display_mode_element (it
, depth
,
18786 /* Do padding only after the last
18787 element in the list. */
18788 (! CONSP (XCDR (elt
))
18791 precision
- n
, XCAR (elt
),
18795 if ((len
& 1) == 0)
18796 halftail
= XCDR (halftail
);
18797 /* Check for cycle. */
18798 if (EQ (halftail
, elt
))
18807 elt
= build_string ("*invalid*");
18811 /* Pad to FIELD_WIDTH. */
18812 if (field_width
> 0 && n
< field_width
)
18814 switch (mode_line_target
)
18816 case MODE_LINE_NOPROP
:
18817 case MODE_LINE_TITLE
:
18818 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18820 case MODE_LINE_STRING
:
18821 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18823 case MODE_LINE_DISPLAY
:
18824 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18833 /* Store a mode-line string element in mode_line_string_list.
18835 If STRING is non-null, display that C string. Otherwise, the Lisp
18836 string LISP_STRING is displayed.
18838 FIELD_WIDTH is the minimum number of output glyphs to produce.
18839 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18840 with spaces. FIELD_WIDTH <= 0 means don't pad.
18842 PRECISION is the maximum number of characters to output from
18843 STRING. PRECISION <= 0 means don't truncate the string.
18845 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18846 properties to the string.
18848 PROPS are the properties to add to the string.
18849 The mode_line_string_face face property is always added to the string.
18853 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18854 int field_width
, int precision
, Lisp_Object props
)
18859 if (string
!= NULL
)
18861 len
= strlen (string
);
18862 if (precision
> 0 && len
> precision
)
18864 lisp_string
= make_string (string
, len
);
18866 props
= mode_line_string_face_prop
;
18867 else if (!NILP (mode_line_string_face
))
18869 Lisp_Object face
= Fplist_get (props
, Qface
);
18870 props
= Fcopy_sequence (props
);
18872 face
= mode_line_string_face
;
18874 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18875 props
= Fplist_put (props
, Qface
, face
);
18877 Fadd_text_properties (make_number (0), make_number (len
),
18878 props
, lisp_string
);
18882 len
= XFASTINT (Flength (lisp_string
));
18883 if (precision
> 0 && len
> precision
)
18886 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18889 if (!NILP (mode_line_string_face
))
18893 props
= Ftext_properties_at (make_number (0), lisp_string
);
18894 face
= Fplist_get (props
, Qface
);
18896 face
= mode_line_string_face
;
18898 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18899 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18901 lisp_string
= Fcopy_sequence (lisp_string
);
18904 Fadd_text_properties (make_number (0), make_number (len
),
18905 props
, lisp_string
);
18910 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18914 if (field_width
> len
)
18916 field_width
-= len
;
18917 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18919 Fadd_text_properties (make_number (0), make_number (field_width
),
18920 props
, lisp_string
);
18921 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18929 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18931 doc
: /* Format a string out of a mode line format specification.
18932 First arg FORMAT specifies the mode line format (see `mode-line-format'
18933 for details) to use.
18935 By default, the format is evaluated for the currently selected window.
18937 Optional second arg FACE specifies the face property to put on all
18938 characters for which no face is specified. The value nil means the
18939 default face. The value t means whatever face the window's mode line
18940 currently uses (either `mode-line' or `mode-line-inactive',
18941 depending on whether the window is the selected window or not).
18942 An integer value means the value string has no text
18945 Optional third and fourth args WINDOW and BUFFER specify the window
18946 and buffer to use as the context for the formatting (defaults
18947 are the selected window and the WINDOW's buffer). */)
18948 (Lisp_Object format
, Lisp_Object face
,
18949 Lisp_Object window
, Lisp_Object buffer
)
18954 struct buffer
*old_buffer
= NULL
;
18956 int no_props
= INTEGERP (face
);
18957 int count
= SPECPDL_INDEX ();
18959 int string_start
= 0;
18962 window
= selected_window
;
18963 CHECK_WINDOW (window
);
18964 w
= XWINDOW (window
);
18967 buffer
= w
->buffer
;
18968 CHECK_BUFFER (buffer
);
18970 /* Make formatting the modeline a non-op when noninteractive, otherwise
18971 there will be problems later caused by a partially initialized frame. */
18972 if (NILP (format
) || noninteractive
)
18973 return empty_unibyte_string
;
18978 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18979 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18980 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18981 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18982 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18983 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18984 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18987 if (XBUFFER (buffer
) != current_buffer
)
18988 old_buffer
= current_buffer
;
18990 /* Save things including mode_line_proptrans_alist,
18991 and set that to nil so that we don't alter the outer value. */
18992 record_unwind_protect (unwind_format_mode_line
,
18993 format_mode_line_unwind_data
18994 (old_buffer
, selected_window
, 1));
18995 mode_line_proptrans_alist
= Qnil
;
18997 Fselect_window (window
, Qt
);
18999 set_buffer_internal_1 (XBUFFER (buffer
));
19001 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19005 mode_line_target
= MODE_LINE_NOPROP
;
19006 mode_line_string_face_prop
= Qnil
;
19007 mode_line_string_list
= Qnil
;
19008 string_start
= MODE_LINE_NOPROP_LEN (0);
19012 mode_line_target
= MODE_LINE_STRING
;
19013 mode_line_string_list
= Qnil
;
19014 mode_line_string_face
= face
;
19015 mode_line_string_face_prop
19016 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19019 push_kboard (FRAME_KBOARD (it
.f
));
19020 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19025 len
= MODE_LINE_NOPROP_LEN (string_start
);
19026 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19030 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19031 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19032 empty_unibyte_string
);
19035 unbind_to (count
, Qnil
);
19039 /* Write a null-terminated, right justified decimal representation of
19040 the positive integer D to BUF using a minimal field width WIDTH. */
19043 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19045 register char *p
= buf
;
19053 *p
++ = d
% 10 + '0';
19058 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19069 /* Write a null-terminated, right justified decimal and "human
19070 readable" representation of the nonnegative integer D to BUF using
19071 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19073 static const char power_letter
[] =
19087 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19089 /* We aim to represent the nonnegative integer D as
19090 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19091 EMACS_INT quotient
= d
;
19093 /* -1 means: do not use TENTHS. */
19097 /* Length of QUOTIENT.TENTHS as a string. */
19103 if (1000 <= quotient
)
19105 /* Scale to the appropriate EXPONENT. */
19108 remainder
= quotient
% 1000;
19112 while (1000 <= quotient
);
19114 /* Round to nearest and decide whether to use TENTHS or not. */
19117 tenths
= remainder
/ 100;
19118 if (50 <= remainder
% 100)
19125 if (quotient
== 10)
19133 if (500 <= remainder
)
19135 if (quotient
< 999)
19146 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19147 if (tenths
== -1 && quotient
<= 99)
19154 p
= psuffix
= buf
+ max (width
, length
);
19156 /* Print EXPONENT. */
19157 *psuffix
++ = power_letter
[exponent
];
19160 /* Print TENTHS. */
19163 *--p
= '0' + tenths
;
19167 /* Print QUOTIENT. */
19170 int digit
= quotient
% 10;
19171 *--p
= '0' + digit
;
19173 while ((quotient
/= 10) != 0);
19175 /* Print leading spaces. */
19180 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19181 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19182 type of CODING_SYSTEM. Return updated pointer into BUF. */
19184 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19187 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19190 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19191 const unsigned char *eol_str
;
19193 /* The EOL conversion we are using. */
19194 Lisp_Object eoltype
;
19196 val
= CODING_SYSTEM_SPEC (coding_system
);
19199 if (!VECTORP (val
)) /* Not yet decided. */
19204 eoltype
= eol_mnemonic_undecided
;
19205 /* Don't mention EOL conversion if it isn't decided. */
19210 Lisp_Object eolvalue
;
19212 attrs
= AREF (val
, 0);
19213 eolvalue
= AREF (val
, 2);
19216 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19220 /* The EOL conversion that is normal on this system. */
19222 if (NILP (eolvalue
)) /* Not yet decided. */
19223 eoltype
= eol_mnemonic_undecided
;
19224 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19225 eoltype
= eol_mnemonic_undecided
;
19226 else /* eolvalue is Qunix, Qdos, or Qmac. */
19227 eoltype
= (EQ (eolvalue
, Qunix
)
19228 ? eol_mnemonic_unix
19229 : (EQ (eolvalue
, Qdos
) == 1
19230 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19236 /* Mention the EOL conversion if it is not the usual one. */
19237 if (STRINGP (eoltype
))
19239 eol_str
= SDATA (eoltype
);
19240 eol_str_len
= SBYTES (eoltype
);
19242 else if (CHARACTERP (eoltype
))
19244 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19245 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19250 eol_str
= invalid_eol_type
;
19251 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19253 memcpy (buf
, eol_str
, eol_str_len
);
19254 buf
+= eol_str_len
;
19260 /* Return a string for the output of a mode line %-spec for window W,
19261 generated by character C. FIELD_WIDTH > 0 means pad the string
19262 returned with spaces to that value. Return a Lisp string in
19263 *STRING if the resulting string is taken from that Lisp string.
19265 Note we operate on the current buffer for most purposes,
19266 the exception being w->base_line_pos. */
19268 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19270 static const char *
19271 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19272 Lisp_Object
*string
)
19275 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19276 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19277 struct buffer
*b
= current_buffer
;
19285 if (!NILP (BVAR (b
, read_only
)))
19287 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19292 /* This differs from %* only for a modified read-only buffer. */
19293 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19295 if (!NILP (BVAR (b
, read_only
)))
19300 /* This differs from %* in ignoring read-only-ness. */
19301 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19313 if (command_loop_level
> 5)
19315 p
= decode_mode_spec_buf
;
19316 for (i
= 0; i
< command_loop_level
; i
++)
19319 return decode_mode_spec_buf
;
19327 if (command_loop_level
> 5)
19329 p
= decode_mode_spec_buf
;
19330 for (i
= 0; i
< command_loop_level
; i
++)
19333 return decode_mode_spec_buf
;
19340 /* Let lots_of_dashes be a string of infinite length. */
19341 if (mode_line_target
== MODE_LINE_NOPROP
||
19342 mode_line_target
== MODE_LINE_STRING
)
19344 if (field_width
<= 0
19345 || field_width
> sizeof (lots_of_dashes
))
19347 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19348 decode_mode_spec_buf
[i
] = '-';
19349 decode_mode_spec_buf
[i
] = '\0';
19350 return decode_mode_spec_buf
;
19353 return lots_of_dashes
;
19357 obj
= BVAR (b
, name
);
19361 /* %c and %l are ignored in `frame-title-format'.
19362 (In redisplay_internal, the frame title is drawn _before_ the
19363 windows are updated, so the stuff which depends on actual
19364 window contents (such as %l) may fail to render properly, or
19365 even crash emacs.) */
19366 if (mode_line_target
== MODE_LINE_TITLE
)
19370 EMACS_INT col
= current_column ();
19371 w
->column_number_displayed
= make_number (col
);
19372 pint2str (decode_mode_spec_buf
, field_width
, col
);
19373 return decode_mode_spec_buf
;
19377 #ifndef SYSTEM_MALLOC
19379 if (NILP (Vmemory_full
))
19382 return "!MEM FULL! ";
19389 /* %F displays the frame name. */
19390 if (!NILP (f
->title
))
19391 return SSDATA (f
->title
);
19392 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19393 return SSDATA (f
->name
);
19397 obj
= BVAR (b
, filename
);
19402 EMACS_INT size
= ZV
- BEGV
;
19403 pint2str (decode_mode_spec_buf
, field_width
, size
);
19404 return decode_mode_spec_buf
;
19409 EMACS_INT size
= ZV
- BEGV
;
19410 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19411 return decode_mode_spec_buf
;
19416 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19417 EMACS_INT topline
, nlines
, height
;
19420 /* %c and %l are ignored in `frame-title-format'. */
19421 if (mode_line_target
== MODE_LINE_TITLE
)
19424 startpos
= XMARKER (w
->start
)->charpos
;
19425 startpos_byte
= marker_byte_position (w
->start
);
19426 height
= WINDOW_TOTAL_LINES (w
);
19428 /* If we decided that this buffer isn't suitable for line numbers,
19429 don't forget that too fast. */
19430 if (EQ (w
->base_line_pos
, w
->buffer
))
19432 /* But do forget it, if the window shows a different buffer now. */
19433 else if (BUFFERP (w
->base_line_pos
))
19434 w
->base_line_pos
= Qnil
;
19436 /* If the buffer is very big, don't waste time. */
19437 if (INTEGERP (Vline_number_display_limit
)
19438 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19440 w
->base_line_pos
= Qnil
;
19441 w
->base_line_number
= Qnil
;
19445 if (INTEGERP (w
->base_line_number
)
19446 && INTEGERP (w
->base_line_pos
)
19447 && XFASTINT (w
->base_line_pos
) <= startpos
)
19449 line
= XFASTINT (w
->base_line_number
);
19450 linepos
= XFASTINT (w
->base_line_pos
);
19451 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19456 linepos
= BUF_BEGV (b
);
19457 linepos_byte
= BUF_BEGV_BYTE (b
);
19460 /* Count lines from base line to window start position. */
19461 nlines
= display_count_lines (linepos_byte
,
19465 topline
= nlines
+ line
;
19467 /* Determine a new base line, if the old one is too close
19468 or too far away, or if we did not have one.
19469 "Too close" means it's plausible a scroll-down would
19470 go back past it. */
19471 if (startpos
== BUF_BEGV (b
))
19473 w
->base_line_number
= make_number (topline
);
19474 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19476 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19477 || linepos
== BUF_BEGV (b
))
19479 EMACS_INT limit
= BUF_BEGV (b
);
19480 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19481 EMACS_INT position
;
19482 EMACS_INT distance
=
19483 (height
* 2 + 30) * line_number_display_limit_width
;
19485 if (startpos
- distance
> limit
)
19487 limit
= startpos
- distance
;
19488 limit_byte
= CHAR_TO_BYTE (limit
);
19491 nlines
= display_count_lines (startpos_byte
,
19493 - (height
* 2 + 30),
19495 /* If we couldn't find the lines we wanted within
19496 line_number_display_limit_width chars per line,
19497 give up on line numbers for this window. */
19498 if (position
== limit_byte
&& limit
== startpos
- distance
)
19500 w
->base_line_pos
= w
->buffer
;
19501 w
->base_line_number
= Qnil
;
19505 w
->base_line_number
= make_number (topline
- nlines
);
19506 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19509 /* Now count lines from the start pos to point. */
19510 nlines
= display_count_lines (startpos_byte
,
19511 PT_BYTE
, PT
, &junk
);
19513 /* Record that we did display the line number. */
19514 line_number_displayed
= 1;
19516 /* Make the string to show. */
19517 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19518 return decode_mode_spec_buf
;
19521 char* p
= decode_mode_spec_buf
;
19522 int pad
= field_width
- 2;
19528 return decode_mode_spec_buf
;
19534 obj
= BVAR (b
, mode_name
);
19538 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19544 EMACS_INT pos
= marker_position (w
->start
);
19545 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19547 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19549 if (pos
<= BUF_BEGV (b
))
19554 else if (pos
<= BUF_BEGV (b
))
19558 if (total
> 1000000)
19559 /* Do it differently for a large value, to avoid overflow. */
19560 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19562 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19563 /* We can't normally display a 3-digit number,
19564 so get us a 2-digit number that is close. */
19567 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19568 return decode_mode_spec_buf
;
19572 /* Display percentage of size above the bottom of the screen. */
19575 EMACS_INT toppos
= marker_position (w
->start
);
19576 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19577 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19579 if (botpos
>= BUF_ZV (b
))
19581 if (toppos
<= BUF_BEGV (b
))
19588 if (total
> 1000000)
19589 /* Do it differently for a large value, to avoid overflow. */
19590 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19592 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19593 /* We can't normally display a 3-digit number,
19594 so get us a 2-digit number that is close. */
19597 if (toppos
<= BUF_BEGV (b
))
19598 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19600 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19601 return decode_mode_spec_buf
;
19606 /* status of process */
19607 obj
= Fget_buffer_process (Fcurrent_buffer ());
19609 return "no process";
19611 obj
= Fsymbol_name (Fprocess_status (obj
));
19617 int count
= inhibit_garbage_collection ();
19618 Lisp_Object val
= call1 (intern ("file-remote-p"),
19619 BVAR (current_buffer
, directory
));
19620 unbind_to (count
, Qnil
);
19628 case 't': /* indicate TEXT or BINARY */
19632 /* coding-system (not including end-of-line format) */
19634 /* coding-system (including end-of-line type) */
19636 int eol_flag
= (c
== 'Z');
19637 char *p
= decode_mode_spec_buf
;
19639 if (! FRAME_WINDOW_P (f
))
19641 /* No need to mention EOL here--the terminal never needs
19642 to do EOL conversion. */
19643 p
= decode_mode_spec_coding (CODING_ID_NAME
19644 (FRAME_KEYBOARD_CODING (f
)->id
),
19646 p
= decode_mode_spec_coding (CODING_ID_NAME
19647 (FRAME_TERMINAL_CODING (f
)->id
),
19650 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19653 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19654 #ifdef subprocesses
19655 obj
= Fget_buffer_process (Fcurrent_buffer ());
19656 if (PROCESSP (obj
))
19658 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19660 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19663 #endif /* subprocesses */
19666 return decode_mode_spec_buf
;
19673 return SSDATA (obj
);
19680 /* Count up to COUNT lines starting from START_BYTE.
19681 But don't go beyond LIMIT_BYTE.
19682 Return the number of lines thus found (always nonnegative).
19684 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19687 display_count_lines (EMACS_INT start_byte
,
19688 EMACS_INT limit_byte
, EMACS_INT count
,
19689 EMACS_INT
*byte_pos_ptr
)
19691 register unsigned char *cursor
;
19692 unsigned char *base
;
19694 register EMACS_INT ceiling
;
19695 register unsigned char *ceiling_addr
;
19696 EMACS_INT orig_count
= count
;
19698 /* If we are not in selective display mode,
19699 check only for newlines. */
19700 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19701 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19705 while (start_byte
< limit_byte
)
19707 ceiling
= BUFFER_CEILING_OF (start_byte
);
19708 ceiling
= min (limit_byte
- 1, ceiling
);
19709 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19710 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19713 if (selective_display
)
19714 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19717 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19720 if (cursor
!= ceiling_addr
)
19724 start_byte
+= cursor
- base
+ 1;
19725 *byte_pos_ptr
= start_byte
;
19729 if (++cursor
== ceiling_addr
)
19735 start_byte
+= cursor
- base
;
19740 while (start_byte
> limit_byte
)
19742 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19743 ceiling
= max (limit_byte
, ceiling
);
19744 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19745 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19748 if (selective_display
)
19749 while (--cursor
!= ceiling_addr
19750 && *cursor
!= '\n' && *cursor
!= 015)
19753 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19756 if (cursor
!= ceiling_addr
)
19760 start_byte
+= cursor
- base
+ 1;
19761 *byte_pos_ptr
= start_byte
;
19762 /* When scanning backwards, we should
19763 not count the newline posterior to which we stop. */
19764 return - orig_count
- 1;
19770 /* Here we add 1 to compensate for the last decrement
19771 of CURSOR, which took it past the valid range. */
19772 start_byte
+= cursor
- base
+ 1;
19776 *byte_pos_ptr
= limit_byte
;
19779 return - orig_count
+ count
;
19780 return orig_count
- count
;
19786 /***********************************************************************
19788 ***********************************************************************/
19790 /* Display a NUL-terminated string, starting with index START.
19792 If STRING is non-null, display that C string. Otherwise, the Lisp
19793 string LISP_STRING is displayed. There's a case that STRING is
19794 non-null and LISP_STRING is not nil. It means STRING is a string
19795 data of LISP_STRING. In that case, we display LISP_STRING while
19796 ignoring its text properties.
19798 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19799 FACE_STRING. Display STRING or LISP_STRING with the face at
19800 FACE_STRING_POS in FACE_STRING:
19802 Display the string in the environment given by IT, but use the
19803 standard display table, temporarily.
19805 FIELD_WIDTH is the minimum number of output glyphs to produce.
19806 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19807 with spaces. If STRING has more characters, more than FIELD_WIDTH
19808 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19810 PRECISION is the maximum number of characters to output from
19811 STRING. PRECISION < 0 means don't truncate the string.
19813 This is roughly equivalent to printf format specifiers:
19815 FIELD_WIDTH PRECISION PRINTF
19816 ----------------------------------------
19822 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19823 display them, and < 0 means obey the current buffer's value of
19824 enable_multibyte_characters.
19826 Value is the number of columns displayed. */
19829 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19830 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19831 int field_width
, int precision
, int max_x
, int multibyte
)
19833 int hpos_at_start
= it
->hpos
;
19834 int saved_face_id
= it
->face_id
;
19835 struct glyph_row
*row
= it
->glyph_row
;
19837 /* Initialize the iterator IT for iteration over STRING beginning
19838 with index START. */
19839 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19840 precision
, field_width
, multibyte
);
19841 if (string
&& STRINGP (lisp_string
))
19842 /* LISP_STRING is the one returned by decode_mode_spec. We should
19843 ignore its text properties. */
19844 it
->stop_charpos
= -1;
19846 /* If displaying STRING, set up the face of the iterator
19847 from LISP_STRING, if that's given. */
19848 if (STRINGP (face_string
))
19854 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19855 0, it
->region_beg_charpos
,
19856 it
->region_end_charpos
,
19857 &endptr
, it
->base_face_id
, 0);
19858 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19859 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19862 /* Set max_x to the maximum allowed X position. Don't let it go
19863 beyond the right edge of the window. */
19865 max_x
= it
->last_visible_x
;
19867 max_x
= min (max_x
, it
->last_visible_x
);
19869 /* Skip over display elements that are not visible. because IT->w is
19871 if (it
->current_x
< it
->first_visible_x
)
19872 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19873 MOVE_TO_POS
| MOVE_TO_X
);
19875 row
->ascent
= it
->max_ascent
;
19876 row
->height
= it
->max_ascent
+ it
->max_descent
;
19877 row
->phys_ascent
= it
->max_phys_ascent
;
19878 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19879 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19881 /* This condition is for the case that we are called with current_x
19882 past last_visible_x. */
19883 while (it
->current_x
< max_x
)
19885 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19887 /* Get the next display element. */
19888 if (!get_next_display_element (it
))
19891 /* Produce glyphs. */
19892 x_before
= it
->current_x
;
19893 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19894 PRODUCE_GLYPHS (it
);
19896 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19899 while (i
< nglyphs
)
19901 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19903 if (it
->line_wrap
!= TRUNCATE
19904 && x
+ glyph
->pixel_width
> max_x
)
19906 /* End of continued line or max_x reached. */
19907 if (CHAR_GLYPH_PADDING_P (*glyph
))
19909 /* A wide character is unbreakable. */
19910 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19911 it
->current_x
= x_before
;
19915 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19920 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19922 /* Glyph is at least partially visible. */
19924 if (x
< it
->first_visible_x
)
19925 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19929 /* Glyph is off the left margin of the display area.
19930 Should not happen. */
19934 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19935 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19936 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19937 row
->phys_height
= max (row
->phys_height
,
19938 it
->max_phys_ascent
+ it
->max_phys_descent
);
19939 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19940 it
->max_extra_line_spacing
);
19941 x
+= glyph
->pixel_width
;
19945 /* Stop if max_x reached. */
19949 /* Stop at line ends. */
19950 if (ITERATOR_AT_END_OF_LINE_P (it
))
19952 it
->continuation_lines_width
= 0;
19956 set_iterator_to_next (it
, 1);
19958 /* Stop if truncating at the right edge. */
19959 if (it
->line_wrap
== TRUNCATE
19960 && it
->current_x
>= it
->last_visible_x
)
19962 /* Add truncation mark, but don't do it if the line is
19963 truncated at a padding space. */
19964 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19966 if (!FRAME_WINDOW_P (it
->f
))
19970 if (it
->current_x
> it
->last_visible_x
)
19972 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19973 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19975 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19977 row
->used
[TEXT_AREA
] = ii
;
19978 produce_special_glyphs (it
, IT_TRUNCATION
);
19981 produce_special_glyphs (it
, IT_TRUNCATION
);
19983 it
->glyph_row
->truncated_on_right_p
= 1;
19989 /* Maybe insert a truncation at the left. */
19990 if (it
->first_visible_x
19991 && IT_CHARPOS (*it
) > 0)
19993 if (!FRAME_WINDOW_P (it
->f
))
19994 insert_left_trunc_glyphs (it
);
19995 it
->glyph_row
->truncated_on_left_p
= 1;
19998 it
->face_id
= saved_face_id
;
20000 /* Value is number of columns displayed. */
20001 return it
->hpos
- hpos_at_start
;
20006 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20007 appears as an element of LIST or as the car of an element of LIST.
20008 If PROPVAL is a list, compare each element against LIST in that
20009 way, and return 1/2 if any element of PROPVAL is found in LIST.
20010 Otherwise return 0. This function cannot quit.
20011 The return value is 2 if the text is invisible but with an ellipsis
20012 and 1 if it's invisible and without an ellipsis. */
20015 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20017 register Lisp_Object tail
, proptail
;
20019 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20021 register Lisp_Object tem
;
20023 if (EQ (propval
, tem
))
20025 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20026 return NILP (XCDR (tem
)) ? 1 : 2;
20029 if (CONSP (propval
))
20031 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20033 Lisp_Object propelt
;
20034 propelt
= XCAR (proptail
);
20035 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20037 register Lisp_Object tem
;
20039 if (EQ (propelt
, tem
))
20041 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20042 return NILP (XCDR (tem
)) ? 1 : 2;
20050 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20051 doc
: /* Non-nil if the property makes the text invisible.
20052 POS-OR-PROP can be a marker or number, in which case it is taken to be
20053 a position in the current buffer and the value of the `invisible' property
20054 is checked; or it can be some other value, which is then presumed to be the
20055 value of the `invisible' property of the text of interest.
20056 The non-nil value returned can be t for truly invisible text or something
20057 else if the text is replaced by an ellipsis. */)
20058 (Lisp_Object pos_or_prop
)
20061 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20062 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20064 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20065 return (invis
== 0 ? Qnil
20067 : make_number (invis
));
20070 /* Calculate a width or height in pixels from a specification using
20071 the following elements:
20074 NUM - a (fractional) multiple of the default font width/height
20075 (NUM) - specifies exactly NUM pixels
20076 UNIT - a fixed number of pixels, see below.
20077 ELEMENT - size of a display element in pixels, see below.
20078 (NUM . SPEC) - equals NUM * SPEC
20079 (+ SPEC SPEC ...) - add pixel values
20080 (- SPEC SPEC ...) - subtract pixel values
20081 (- SPEC) - negate pixel value
20084 INT or FLOAT - a number constant
20085 SYMBOL - use symbol's (buffer local) variable binding.
20088 in - pixels per inch *)
20089 mm - pixels per 1/1000 meter *)
20090 cm - pixels per 1/100 meter *)
20091 width - width of current font in pixels.
20092 height - height of current font in pixels.
20094 *) using the ratio(s) defined in display-pixels-per-inch.
20098 left-fringe - left fringe width in pixels
20099 right-fringe - right fringe width in pixels
20101 left-margin - left margin width in pixels
20102 right-margin - right margin width in pixels
20104 scroll-bar - scroll-bar area width in pixels
20108 Pixels corresponding to 5 inches:
20111 Total width of non-text areas on left side of window (if scroll-bar is on left):
20112 '(space :width (+ left-fringe left-margin scroll-bar))
20114 Align to first text column (in header line):
20115 '(space :align-to 0)
20117 Align to middle of text area minus half the width of variable `my-image'
20118 containing a loaded image:
20119 '(space :align-to (0.5 . (- text my-image)))
20121 Width of left margin minus width of 1 character in the default font:
20122 '(space :width (- left-margin 1))
20124 Width of left margin minus width of 2 characters in the current font:
20125 '(space :width (- left-margin (2 . width)))
20127 Center 1 character over left-margin (in header line):
20128 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20130 Different ways to express width of left fringe plus left margin minus one pixel:
20131 '(space :width (- (+ left-fringe left-margin) (1)))
20132 '(space :width (+ left-fringe left-margin (- (1))))
20133 '(space :width (+ left-fringe left-margin (-1)))
20137 #define NUMVAL(X) \
20138 ((INTEGERP (X) || FLOATP (X)) \
20143 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20144 struct font
*font
, int width_p
, int *align_to
)
20148 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20149 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20152 return OK_PIXELS (0);
20154 xassert (FRAME_LIVE_P (it
->f
));
20156 if (SYMBOLP (prop
))
20158 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20160 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20162 if (unit
[0] == 'i' && unit
[1] == 'n')
20164 else if (unit
[0] == 'm' && unit
[1] == 'm')
20166 else if (unit
[0] == 'c' && unit
[1] == 'm')
20173 #ifdef HAVE_WINDOW_SYSTEM
20174 if (FRAME_WINDOW_P (it
->f
)
20176 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20177 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20179 return OK_PIXELS (ppi
/ pixels
);
20182 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20183 || (CONSP (Vdisplay_pixels_per_inch
)
20185 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20186 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20188 return OK_PIXELS (ppi
/ pixels
);
20194 #ifdef HAVE_WINDOW_SYSTEM
20195 if (EQ (prop
, Qheight
))
20196 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20197 if (EQ (prop
, Qwidth
))
20198 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20200 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20201 return OK_PIXELS (1);
20204 if (EQ (prop
, Qtext
))
20205 return OK_PIXELS (width_p
20206 ? window_box_width (it
->w
, TEXT_AREA
)
20207 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20209 if (align_to
&& *align_to
< 0)
20212 if (EQ (prop
, Qleft
))
20213 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20214 if (EQ (prop
, Qright
))
20215 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20216 if (EQ (prop
, Qcenter
))
20217 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20218 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20219 if (EQ (prop
, Qleft_fringe
))
20220 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20221 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20222 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20223 if (EQ (prop
, Qright_fringe
))
20224 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20225 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20226 : window_box_right_offset (it
->w
, TEXT_AREA
));
20227 if (EQ (prop
, Qleft_margin
))
20228 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20229 if (EQ (prop
, Qright_margin
))
20230 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20231 if (EQ (prop
, Qscroll_bar
))
20232 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20234 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20235 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20236 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20241 if (EQ (prop
, Qleft_fringe
))
20242 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20243 if (EQ (prop
, Qright_fringe
))
20244 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20245 if (EQ (prop
, Qleft_margin
))
20246 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20247 if (EQ (prop
, Qright_margin
))
20248 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20249 if (EQ (prop
, Qscroll_bar
))
20250 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20253 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20256 if (INTEGERP (prop
) || FLOATP (prop
))
20258 int base_unit
= (width_p
20259 ? FRAME_COLUMN_WIDTH (it
->f
)
20260 : FRAME_LINE_HEIGHT (it
->f
));
20261 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20266 Lisp_Object car
= XCAR (prop
);
20267 Lisp_Object cdr
= XCDR (prop
);
20271 #ifdef HAVE_WINDOW_SYSTEM
20272 if (FRAME_WINDOW_P (it
->f
)
20273 && valid_image_p (prop
))
20275 int id
= lookup_image (it
->f
, prop
);
20276 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20278 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20281 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20287 while (CONSP (cdr
))
20289 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20290 font
, width_p
, align_to
))
20293 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20298 if (EQ (car
, Qminus
))
20300 return OK_PIXELS (pixels
);
20303 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20306 if (INTEGERP (car
) || FLOATP (car
))
20309 pixels
= XFLOATINT (car
);
20311 return OK_PIXELS (pixels
);
20312 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20313 font
, width_p
, align_to
))
20314 return OK_PIXELS (pixels
* fact
);
20325 /***********************************************************************
20327 ***********************************************************************/
20329 #ifdef HAVE_WINDOW_SYSTEM
20334 dump_glyph_string (s
)
20335 struct glyph_string
*s
;
20337 fprintf (stderr
, "glyph string\n");
20338 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20339 s
->x
, s
->y
, s
->width
, s
->height
);
20340 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20341 fprintf (stderr
, " hl = %d\n", s
->hl
);
20342 fprintf (stderr
, " left overhang = %d, right = %d\n",
20343 s
->left_overhang
, s
->right_overhang
);
20344 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20345 fprintf (stderr
, " extends to end of line = %d\n",
20346 s
->extends_to_end_of_line_p
);
20347 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20348 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20351 #endif /* GLYPH_DEBUG */
20353 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20354 of XChar2b structures for S; it can't be allocated in
20355 init_glyph_string because it must be allocated via `alloca'. W
20356 is the window on which S is drawn. ROW and AREA are the glyph row
20357 and area within the row from which S is constructed. START is the
20358 index of the first glyph structure covered by S. HL is a
20359 face-override for drawing S. */
20362 #define OPTIONAL_HDC(hdc) HDC hdc,
20363 #define DECLARE_HDC(hdc) HDC hdc;
20364 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20365 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20368 #ifndef OPTIONAL_HDC
20369 #define OPTIONAL_HDC(hdc)
20370 #define DECLARE_HDC(hdc)
20371 #define ALLOCATE_HDC(hdc, f)
20372 #define RELEASE_HDC(hdc, f)
20376 init_glyph_string (struct glyph_string
*s
,
20378 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20379 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20381 memset (s
, 0, sizeof *s
);
20383 s
->f
= XFRAME (w
->frame
);
20387 s
->display
= FRAME_X_DISPLAY (s
->f
);
20388 s
->window
= FRAME_X_WINDOW (s
->f
);
20389 s
->char2b
= char2b
;
20393 s
->first_glyph
= row
->glyphs
[area
] + start
;
20394 s
->height
= row
->height
;
20395 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20396 s
->ybase
= s
->y
+ row
->ascent
;
20400 /* Append the list of glyph strings with head H and tail T to the list
20401 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20404 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20405 struct glyph_string
*h
, struct glyph_string
*t
)
20419 /* Prepend the list of glyph strings with head H and tail T to the
20420 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20424 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20425 struct glyph_string
*h
, struct glyph_string
*t
)
20439 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20440 Set *HEAD and *TAIL to the resulting list. */
20443 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20444 struct glyph_string
*s
)
20446 s
->next
= s
->prev
= NULL
;
20447 append_glyph_string_lists (head
, tail
, s
, s
);
20451 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20452 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20453 make sure that X resources for the face returned are allocated.
20454 Value is a pointer to a realized face that is ready for display if
20455 DISPLAY_P is non-zero. */
20457 static INLINE
struct face
*
20458 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20459 XChar2b
*char2b
, int display_p
)
20461 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20465 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20467 if (code
!= FONT_INVALID_CODE
)
20468 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20470 STORE_XCHAR2B (char2b
, 0, 0);
20473 /* Make sure X resources of the face are allocated. */
20474 #ifdef HAVE_X_WINDOWS
20478 xassert (face
!= NULL
);
20479 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20486 /* Get face and two-byte form of character glyph GLYPH on frame F.
20487 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20488 a pointer to a realized face that is ready for display. */
20490 static INLINE
struct face
*
20491 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20492 XChar2b
*char2b
, int *two_byte_p
)
20496 xassert (glyph
->type
== CHAR_GLYPH
);
20497 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20506 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20507 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20509 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20511 if (code
!= FONT_INVALID_CODE
)
20512 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20514 STORE_XCHAR2B (char2b
, 0, 0);
20517 /* Make sure X resources of the face are allocated. */
20518 xassert (face
!= NULL
);
20519 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20524 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20525 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20528 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20532 if (CHAR_BYTE8_P (c
))
20533 code
= CHAR_TO_BYTE8 (c
);
20535 code
= font
->driver
->encode_char (font
, c
);
20537 if (code
== FONT_INVALID_CODE
)
20539 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20544 /* Fill glyph string S with composition components specified by S->cmp.
20546 BASE_FACE is the base face of the composition.
20547 S->cmp_from is the index of the first component for S.
20549 OVERLAPS non-zero means S should draw the foreground only, and use
20550 its physical height for clipping. See also draw_glyphs.
20552 Value is the index of a component not in S. */
20555 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20559 /* For all glyphs of this composition, starting at the offset
20560 S->cmp_from, until we reach the end of the definition or encounter a
20561 glyph that requires the different face, add it to S. */
20566 s
->for_overlaps
= overlaps
;
20569 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20571 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20575 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20578 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20585 s
->font
= s
->face
->font
;
20587 else if (s
->face
!= face
)
20595 /* All glyph strings for the same composition has the same width,
20596 i.e. the width set for the first component of the composition. */
20597 s
->width
= s
->first_glyph
->pixel_width
;
20599 /* If the specified font could not be loaded, use the frame's
20600 default font, but record the fact that we couldn't load it in
20601 the glyph string so that we can draw rectangles for the
20602 characters of the glyph string. */
20603 if (s
->font
== NULL
)
20605 s
->font_not_found_p
= 1;
20606 s
->font
= FRAME_FONT (s
->f
);
20609 /* Adjust base line for subscript/superscript text. */
20610 s
->ybase
+= s
->first_glyph
->voffset
;
20612 /* This glyph string must always be drawn with 16-bit functions. */
20619 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20620 int start
, int end
, int overlaps
)
20622 struct glyph
*glyph
, *last
;
20623 Lisp_Object lgstring
;
20626 s
->for_overlaps
= overlaps
;
20627 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20628 last
= s
->row
->glyphs
[s
->area
] + end
;
20629 s
->cmp_id
= glyph
->u
.cmp
.id
;
20630 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20631 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20632 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20633 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20634 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20636 while (glyph
< last
20637 && glyph
->u
.cmp
.automatic
20638 && glyph
->u
.cmp
.id
== s
->cmp_id
20639 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20640 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20642 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20644 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20645 unsigned code
= LGLYPH_CODE (lglyph
);
20647 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20649 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20650 return glyph
- s
->row
->glyphs
[s
->area
];
20654 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20655 See the comment of fill_glyph_string for arguments.
20656 Value is the index of the first glyph not in S. */
20660 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20661 int start
, int end
, int overlaps
)
20663 struct glyph
*glyph
, *last
;
20666 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20667 s
->for_overlaps
= overlaps
;
20668 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20669 last
= s
->row
->glyphs
[s
->area
] + end
;
20670 voffset
= glyph
->voffset
;
20671 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20672 s
->font
= s
->face
->font
;
20674 s
->width
= glyph
->pixel_width
;
20676 while (glyph
< last
20677 && glyph
->type
== GLYPHLESS_GLYPH
20678 && glyph
->voffset
== voffset
20679 && glyph
->face_id
== face_id
)
20682 s
->width
+= glyph
->pixel_width
;
20685 s
->ybase
+= voffset
;
20686 return glyph
- s
->row
->glyphs
[s
->area
];
20690 /* Fill glyph string S from a sequence of character glyphs.
20692 FACE_ID is the face id of the string. START is the index of the
20693 first glyph to consider, END is the index of the last + 1.
20694 OVERLAPS non-zero means S should draw the foreground only, and use
20695 its physical height for clipping. See also draw_glyphs.
20697 Value is the index of the first glyph not in S. */
20700 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20701 int start
, int end
, int overlaps
)
20703 struct glyph
*glyph
, *last
;
20705 int glyph_not_available_p
;
20707 xassert (s
->f
== XFRAME (s
->w
->frame
));
20708 xassert (s
->nchars
== 0);
20709 xassert (start
>= 0 && end
> start
);
20711 s
->for_overlaps
= overlaps
;
20712 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20713 last
= s
->row
->glyphs
[s
->area
] + end
;
20714 voffset
= glyph
->voffset
;
20715 s
->padding_p
= glyph
->padding_p
;
20716 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20718 while (glyph
< last
20719 && glyph
->type
== CHAR_GLYPH
20720 && glyph
->voffset
== voffset
20721 /* Same face id implies same font, nowadays. */
20722 && glyph
->face_id
== face_id
20723 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20727 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20728 s
->char2b
+ s
->nchars
,
20730 s
->two_byte_p
= two_byte_p
;
20732 xassert (s
->nchars
<= end
- start
);
20733 s
->width
+= glyph
->pixel_width
;
20734 if (glyph
++->padding_p
!= s
->padding_p
)
20738 s
->font
= s
->face
->font
;
20740 /* If the specified font could not be loaded, use the frame's font,
20741 but record the fact that we couldn't load it in
20742 S->font_not_found_p so that we can draw rectangles for the
20743 characters of the glyph string. */
20744 if (s
->font
== NULL
|| glyph_not_available_p
)
20746 s
->font_not_found_p
= 1;
20747 s
->font
= FRAME_FONT (s
->f
);
20750 /* Adjust base line for subscript/superscript text. */
20751 s
->ybase
+= voffset
;
20753 xassert (s
->face
&& s
->face
->gc
);
20754 return glyph
- s
->row
->glyphs
[s
->area
];
20758 /* Fill glyph string S from image glyph S->first_glyph. */
20761 fill_image_glyph_string (struct glyph_string
*s
)
20763 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20764 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20766 s
->slice
= s
->first_glyph
->slice
.img
;
20767 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20768 s
->font
= s
->face
->font
;
20769 s
->width
= s
->first_glyph
->pixel_width
;
20771 /* Adjust base line for subscript/superscript text. */
20772 s
->ybase
+= s
->first_glyph
->voffset
;
20776 /* Fill glyph string S from a sequence of stretch glyphs.
20778 START is the index of the first glyph to consider,
20779 END is the index of the last + 1.
20781 Value is the index of the first glyph not in S. */
20784 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20786 struct glyph
*glyph
, *last
;
20787 int voffset
, face_id
;
20789 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20791 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20792 last
= s
->row
->glyphs
[s
->area
] + end
;
20793 face_id
= glyph
->face_id
;
20794 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20795 s
->font
= s
->face
->font
;
20796 s
->width
= glyph
->pixel_width
;
20798 voffset
= glyph
->voffset
;
20802 && glyph
->type
== STRETCH_GLYPH
20803 && glyph
->voffset
== voffset
20804 && glyph
->face_id
== face_id
);
20806 s
->width
+= glyph
->pixel_width
;
20808 /* Adjust base line for subscript/superscript text. */
20809 s
->ybase
+= voffset
;
20811 /* The case that face->gc == 0 is handled when drawing the glyph
20812 string by calling PREPARE_FACE_FOR_DISPLAY. */
20814 return glyph
- s
->row
->glyphs
[s
->area
];
20817 static struct font_metrics
*
20818 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20820 static struct font_metrics metrics
;
20821 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20823 if (! font
|| code
== FONT_INVALID_CODE
)
20825 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20830 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20831 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20832 assumed to be zero. */
20835 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20837 *left
= *right
= 0;
20839 if (glyph
->type
== CHAR_GLYPH
)
20843 struct font_metrics
*pcm
;
20845 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20846 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20848 if (pcm
->rbearing
> pcm
->width
)
20849 *right
= pcm
->rbearing
- pcm
->width
;
20850 if (pcm
->lbearing
< 0)
20851 *left
= -pcm
->lbearing
;
20854 else if (glyph
->type
== COMPOSITE_GLYPH
)
20856 if (! glyph
->u
.cmp
.automatic
)
20858 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20860 if (cmp
->rbearing
> cmp
->pixel_width
)
20861 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20862 if (cmp
->lbearing
< 0)
20863 *left
= - cmp
->lbearing
;
20867 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20868 struct font_metrics metrics
;
20870 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20871 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20872 if (metrics
.rbearing
> metrics
.width
)
20873 *right
= metrics
.rbearing
- metrics
.width
;
20874 if (metrics
.lbearing
< 0)
20875 *left
= - metrics
.lbearing
;
20881 /* Return the index of the first glyph preceding glyph string S that
20882 is overwritten by S because of S's left overhang. Value is -1
20883 if no glyphs are overwritten. */
20886 left_overwritten (struct glyph_string
*s
)
20890 if (s
->left_overhang
)
20893 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20894 int first
= s
->first_glyph
- glyphs
;
20896 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20897 x
-= glyphs
[i
].pixel_width
;
20908 /* Return the index of the first glyph preceding glyph string S that
20909 is overwriting S because of its right overhang. Value is -1 if no
20910 glyph in front of S overwrites S. */
20913 left_overwriting (struct glyph_string
*s
)
20916 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20917 int first
= s
->first_glyph
- glyphs
;
20921 for (i
= first
- 1; i
>= 0; --i
)
20924 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20927 x
-= glyphs
[i
].pixel_width
;
20934 /* Return the index of the last glyph following glyph string S that is
20935 overwritten by S because of S's right overhang. Value is -1 if
20936 no such glyph is found. */
20939 right_overwritten (struct glyph_string
*s
)
20943 if (s
->right_overhang
)
20946 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20947 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20948 int end
= s
->row
->used
[s
->area
];
20950 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20951 x
+= glyphs
[i
].pixel_width
;
20960 /* Return the index of the last glyph following glyph string S that
20961 overwrites S because of its left overhang. Value is negative
20962 if no such glyph is found. */
20965 right_overwriting (struct glyph_string
*s
)
20968 int end
= s
->row
->used
[s
->area
];
20969 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20970 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20974 for (i
= first
; i
< end
; ++i
)
20977 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20980 x
+= glyphs
[i
].pixel_width
;
20987 /* Set background width of glyph string S. START is the index of the
20988 first glyph following S. LAST_X is the right-most x-position + 1
20989 in the drawing area. */
20992 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20994 /* If the face of this glyph string has to be drawn to the end of
20995 the drawing area, set S->extends_to_end_of_line_p. */
20997 if (start
== s
->row
->used
[s
->area
]
20998 && s
->area
== TEXT_AREA
20999 && ((s
->row
->fill_line_p
21000 && (s
->hl
== DRAW_NORMAL_TEXT
21001 || s
->hl
== DRAW_IMAGE_RAISED
21002 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21003 || s
->hl
== DRAW_MOUSE_FACE
))
21004 s
->extends_to_end_of_line_p
= 1;
21006 /* If S extends its face to the end of the line, set its
21007 background_width to the distance to the right edge of the drawing
21009 if (s
->extends_to_end_of_line_p
)
21010 s
->background_width
= last_x
- s
->x
+ 1;
21012 s
->background_width
= s
->width
;
21016 /* Compute overhangs and x-positions for glyph string S and its
21017 predecessors, or successors. X is the starting x-position for S.
21018 BACKWARD_P non-zero means process predecessors. */
21021 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21027 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21028 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21038 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21039 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21049 /* The following macros are only called from draw_glyphs below.
21050 They reference the following parameters of that function directly:
21051 `w', `row', `area', and `overlap_p'
21052 as well as the following local variables:
21053 `s', `f', and `hdc' (in W32) */
21056 /* On W32, silently add local `hdc' variable to argument list of
21057 init_glyph_string. */
21058 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21059 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21061 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21062 init_glyph_string (s, char2b, w, row, area, start, hl)
21065 /* Add a glyph string for a stretch glyph to the list of strings
21066 between HEAD and TAIL. START is the index of the stretch glyph in
21067 row area AREA of glyph row ROW. END is the index of the last glyph
21068 in that glyph row area. X is the current output position assigned
21069 to the new glyph string constructed. HL overrides that face of the
21070 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21071 is the right-most x-position of the drawing area. */
21073 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21074 and below -- keep them on one line. */
21075 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21078 s = (struct glyph_string *) alloca (sizeof *s); \
21079 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21080 START = fill_stretch_glyph_string (s, START, END); \
21081 append_glyph_string (&HEAD, &TAIL, s); \
21087 /* Add a glyph string for an image glyph to the list of strings
21088 between HEAD and TAIL. START is the index of the image glyph in
21089 row area AREA of glyph row ROW. END is the index of the last glyph
21090 in that glyph row area. X is the current output position assigned
21091 to the new glyph string constructed. HL overrides that face of the
21092 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21093 is the right-most x-position of the drawing area. */
21095 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21098 s = (struct glyph_string *) alloca (sizeof *s); \
21099 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21100 fill_image_glyph_string (s); \
21101 append_glyph_string (&HEAD, &TAIL, s); \
21108 /* Add a glyph string for a sequence of character glyphs to the list
21109 of strings between HEAD and TAIL. START is the index of the first
21110 glyph in row area AREA of glyph row ROW that is part of the new
21111 glyph string. END is the index of the last glyph in that glyph row
21112 area. X is the current output position assigned to the new glyph
21113 string constructed. HL overrides that face of the glyph; e.g. it
21114 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21115 right-most x-position of the drawing area. */
21117 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21123 face_id = (row)->glyphs[area][START].face_id; \
21125 s = (struct glyph_string *) alloca (sizeof *s); \
21126 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21127 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21128 append_glyph_string (&HEAD, &TAIL, s); \
21130 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21135 /* Add a glyph string for a composite sequence to the list of strings
21136 between HEAD and TAIL. START is the index of the first glyph in
21137 row area AREA of glyph row ROW that is part of the new glyph
21138 string. END is the index of the last glyph in that glyph row area.
21139 X is the current output position assigned to the new glyph string
21140 constructed. HL overrides that face of the glyph; e.g. it is
21141 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21142 x-position of the drawing area. */
21144 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21146 int face_id = (row)->glyphs[area][START].face_id; \
21147 struct face *base_face = FACE_FROM_ID (f, face_id); \
21148 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21149 struct composition *cmp = composition_table[cmp_id]; \
21151 struct glyph_string *first_s IF_LINT (= NULL); \
21154 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21156 /* Make glyph_strings for each glyph sequence that is drawable by \
21157 the same face, and append them to HEAD/TAIL. */ \
21158 for (n = 0; n < cmp->glyph_len;) \
21160 s = (struct glyph_string *) alloca (sizeof *s); \
21161 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21162 append_glyph_string (&(HEAD), &(TAIL), s); \
21168 n = fill_composite_glyph_string (s, base_face, overlaps); \
21176 /* Add a glyph string for a glyph-string sequence to the list of strings
21177 between HEAD and TAIL. */
21179 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21183 Lisp_Object gstring; \
21185 face_id = (row)->glyphs[area][START].face_id; \
21186 gstring = (composition_gstring_from_id \
21187 ((row)->glyphs[area][START].u.cmp.id)); \
21188 s = (struct glyph_string *) alloca (sizeof *s); \
21189 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21190 * LGSTRING_GLYPH_LEN (gstring)); \
21191 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21192 append_glyph_string (&(HEAD), &(TAIL), s); \
21194 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21198 /* Add a glyph string for a sequence of glyphless character's glyphs
21199 to the list of strings between HEAD and TAIL. The meanings of
21200 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21202 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21207 face_id = (row)->glyphs[area][START].face_id; \
21209 s = (struct glyph_string *) alloca (sizeof *s); \
21210 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21211 append_glyph_string (&HEAD, &TAIL, s); \
21213 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21219 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21220 of AREA of glyph row ROW on window W between indices START and END.
21221 HL overrides the face for drawing glyph strings, e.g. it is
21222 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21223 x-positions of the drawing area.
21225 This is an ugly monster macro construct because we must use alloca
21226 to allocate glyph strings (because draw_glyphs can be called
21227 asynchronously). */
21229 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21232 HEAD = TAIL = NULL; \
21233 while (START < END) \
21235 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21236 switch (first_glyph->type) \
21239 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21243 case COMPOSITE_GLYPH: \
21244 if (first_glyph->u.cmp.automatic) \
21245 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21248 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21252 case STRETCH_GLYPH: \
21253 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21257 case IMAGE_GLYPH: \
21258 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21262 case GLYPHLESS_GLYPH: \
21263 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21273 set_glyph_string_background_width (s, START, LAST_X); \
21280 /* Draw glyphs between START and END in AREA of ROW on window W,
21281 starting at x-position X. X is relative to AREA in W. HL is a
21282 face-override with the following meaning:
21284 DRAW_NORMAL_TEXT draw normally
21285 DRAW_CURSOR draw in cursor face
21286 DRAW_MOUSE_FACE draw in mouse face.
21287 DRAW_INVERSE_VIDEO draw in mode line face
21288 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21289 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21291 If OVERLAPS is non-zero, draw only the foreground of characters and
21292 clip to the physical height of ROW. Non-zero value also defines
21293 the overlapping part to be drawn:
21295 OVERLAPS_PRED overlap with preceding rows
21296 OVERLAPS_SUCC overlap with succeeding rows
21297 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21298 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21300 Value is the x-position reached, relative to AREA of W. */
21303 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21304 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21305 enum draw_glyphs_face hl
, int overlaps
)
21307 struct glyph_string
*head
, *tail
;
21308 struct glyph_string
*s
;
21309 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21310 int i
, j
, x_reached
, last_x
, area_left
= 0;
21311 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21314 ALLOCATE_HDC (hdc
, f
);
21316 /* Let's rather be paranoid than getting a SEGV. */
21317 end
= min (end
, row
->used
[area
]);
21318 start
= max (0, start
);
21319 start
= min (end
, start
);
21321 /* Translate X to frame coordinates. Set last_x to the right
21322 end of the drawing area. */
21323 if (row
->full_width_p
)
21325 /* X is relative to the left edge of W, without scroll bars
21327 area_left
= WINDOW_LEFT_EDGE_X (w
);
21328 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21332 area_left
= window_box_left (w
, area
);
21333 last_x
= area_left
+ window_box_width (w
, area
);
21337 /* Build a doubly-linked list of glyph_string structures between
21338 head and tail from what we have to draw. Note that the macro
21339 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21340 the reason we use a separate variable `i'. */
21342 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21344 x_reached
= tail
->x
+ tail
->background_width
;
21348 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21349 the row, redraw some glyphs in front or following the glyph
21350 strings built above. */
21351 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21353 struct glyph_string
*h
, *t
;
21354 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21355 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21356 int check_mouse_face
= 0;
21359 /* If mouse highlighting is on, we may need to draw adjacent
21360 glyphs using mouse-face highlighting. */
21361 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21363 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21365 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21366 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21368 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21370 check_mouse_face
= 1;
21371 mouse_beg_col
= (row
== mouse_beg_row
)
21372 ? hlinfo
->mouse_face_beg_col
: 0;
21373 mouse_end_col
= (row
== mouse_end_row
)
21374 ? hlinfo
->mouse_face_end_col
21375 : row
->used
[TEXT_AREA
];
21379 /* Compute overhangs for all glyph strings. */
21380 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21381 for (s
= head
; s
; s
= s
->next
)
21382 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21384 /* Prepend glyph strings for glyphs in front of the first glyph
21385 string that are overwritten because of the first glyph
21386 string's left overhang. The background of all strings
21387 prepended must be drawn because the first glyph string
21389 i
= left_overwritten (head
);
21392 enum draw_glyphs_face overlap_hl
;
21394 /* If this row contains mouse highlighting, attempt to draw
21395 the overlapped glyphs with the correct highlight. This
21396 code fails if the overlap encompasses more than one glyph
21397 and mouse-highlight spans only some of these glyphs.
21398 However, making it work perfectly involves a lot more
21399 code, and I don't know if the pathological case occurs in
21400 practice, so we'll stick to this for now. --- cyd */
21401 if (check_mouse_face
21402 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21403 overlap_hl
= DRAW_MOUSE_FACE
;
21405 overlap_hl
= DRAW_NORMAL_TEXT
;
21408 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21409 overlap_hl
, dummy_x
, last_x
);
21411 compute_overhangs_and_x (t
, head
->x
, 1);
21412 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21416 /* Prepend glyph strings for glyphs in front of the first glyph
21417 string that overwrite that glyph string because of their
21418 right overhang. For these strings, only the foreground must
21419 be drawn, because it draws over the glyph string at `head'.
21420 The background must not be drawn because this would overwrite
21421 right overhangs of preceding glyphs for which no glyph
21423 i
= left_overwriting (head
);
21426 enum draw_glyphs_face overlap_hl
;
21428 if (check_mouse_face
21429 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21430 overlap_hl
= DRAW_MOUSE_FACE
;
21432 overlap_hl
= DRAW_NORMAL_TEXT
;
21435 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21436 overlap_hl
, dummy_x
, last_x
);
21437 for (s
= h
; s
; s
= s
->next
)
21438 s
->background_filled_p
= 1;
21439 compute_overhangs_and_x (t
, head
->x
, 1);
21440 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21443 /* Append glyphs strings for glyphs following the last glyph
21444 string tail that are overwritten by tail. The background of
21445 these strings has to be drawn because tail's foreground draws
21447 i
= right_overwritten (tail
);
21450 enum draw_glyphs_face overlap_hl
;
21452 if (check_mouse_face
21453 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21454 overlap_hl
= DRAW_MOUSE_FACE
;
21456 overlap_hl
= DRAW_NORMAL_TEXT
;
21458 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21459 overlap_hl
, x
, last_x
);
21460 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21461 we don't have `end = i;' here. */
21462 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21463 append_glyph_string_lists (&head
, &tail
, h
, t
);
21467 /* Append glyph strings for glyphs following the last glyph
21468 string tail that overwrite tail. The foreground of such
21469 glyphs has to be drawn because it writes into the background
21470 of tail. The background must not be drawn because it could
21471 paint over the foreground of following glyphs. */
21472 i
= right_overwriting (tail
);
21475 enum draw_glyphs_face overlap_hl
;
21476 if (check_mouse_face
21477 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21478 overlap_hl
= DRAW_MOUSE_FACE
;
21480 overlap_hl
= DRAW_NORMAL_TEXT
;
21483 i
++; /* We must include the Ith glyph. */
21484 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21485 overlap_hl
, x
, last_x
);
21486 for (s
= h
; s
; s
= s
->next
)
21487 s
->background_filled_p
= 1;
21488 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21489 append_glyph_string_lists (&head
, &tail
, h
, t
);
21491 if (clip_head
|| clip_tail
)
21492 for (s
= head
; s
; s
= s
->next
)
21494 s
->clip_head
= clip_head
;
21495 s
->clip_tail
= clip_tail
;
21499 /* Draw all strings. */
21500 for (s
= head
; s
; s
= s
->next
)
21501 FRAME_RIF (f
)->draw_glyph_string (s
);
21504 /* When focus a sole frame and move horizontally, this sets on_p to 0
21505 causing a failure to erase prev cursor position. */
21506 if (area
== TEXT_AREA
21507 && !row
->full_width_p
21508 /* When drawing overlapping rows, only the glyph strings'
21509 foreground is drawn, which doesn't erase a cursor
21513 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21514 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21515 : (tail
? tail
->x
+ tail
->background_width
: x
));
21519 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21520 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21524 /* Value is the x-position up to which drawn, relative to AREA of W.
21525 This doesn't include parts drawn because of overhangs. */
21526 if (row
->full_width_p
)
21527 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21529 x_reached
-= area_left
;
21531 RELEASE_HDC (hdc
, f
);
21536 /* Expand row matrix if too narrow. Don't expand if area
21539 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21541 if (!fonts_changed_p \
21542 && (it->glyph_row->glyphs[area] \
21543 < it->glyph_row->glyphs[area + 1])) \
21545 it->w->ncols_scale_factor++; \
21546 fonts_changed_p = 1; \
21550 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21551 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21554 append_glyph (struct it
*it
)
21556 struct glyph
*glyph
;
21557 enum glyph_row_area area
= it
->area
;
21559 xassert (it
->glyph_row
);
21560 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21562 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21563 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21565 /* If the glyph row is reversed, we need to prepend the glyph
21566 rather than append it. */
21567 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21571 /* Make room for the additional glyph. */
21572 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21574 glyph
= it
->glyph_row
->glyphs
[area
];
21576 glyph
->charpos
= CHARPOS (it
->position
);
21577 glyph
->object
= it
->object
;
21578 if (it
->pixel_width
> 0)
21580 glyph
->pixel_width
= it
->pixel_width
;
21581 glyph
->padding_p
= 0;
21585 /* Assure at least 1-pixel width. Otherwise, cursor can't
21586 be displayed correctly. */
21587 glyph
->pixel_width
= 1;
21588 glyph
->padding_p
= 1;
21590 glyph
->ascent
= it
->ascent
;
21591 glyph
->descent
= it
->descent
;
21592 glyph
->voffset
= it
->voffset
;
21593 glyph
->type
= CHAR_GLYPH
;
21594 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21595 glyph
->multibyte_p
= it
->multibyte_p
;
21596 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21597 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21598 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21599 || it
->phys_descent
> it
->descent
);
21600 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21601 glyph
->face_id
= it
->face_id
;
21602 glyph
->u
.ch
= it
->char_to_display
;
21603 glyph
->slice
.img
= null_glyph_slice
;
21604 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21607 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21608 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21610 glyph
->bidi_type
= it
->bidi_it
.type
;
21614 glyph
->resolved_level
= 0;
21615 glyph
->bidi_type
= UNKNOWN_BT
;
21617 ++it
->glyph_row
->used
[area
];
21620 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21623 /* Store one glyph for the composition IT->cmp_it.id in
21624 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21628 append_composite_glyph (struct it
*it
)
21630 struct glyph
*glyph
;
21631 enum glyph_row_area area
= it
->area
;
21633 xassert (it
->glyph_row
);
21635 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21636 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21638 /* If the glyph row is reversed, we need to prepend the glyph
21639 rather than append it. */
21640 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21644 /* Make room for the new glyph. */
21645 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21647 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21649 glyph
->charpos
= it
->cmp_it
.charpos
;
21650 glyph
->object
= it
->object
;
21651 glyph
->pixel_width
= it
->pixel_width
;
21652 glyph
->ascent
= it
->ascent
;
21653 glyph
->descent
= it
->descent
;
21654 glyph
->voffset
= it
->voffset
;
21655 glyph
->type
= COMPOSITE_GLYPH
;
21656 if (it
->cmp_it
.ch
< 0)
21658 glyph
->u
.cmp
.automatic
= 0;
21659 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21660 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21664 glyph
->u
.cmp
.automatic
= 1;
21665 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21666 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21667 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21669 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21670 glyph
->multibyte_p
= it
->multibyte_p
;
21671 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21672 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21673 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21674 || it
->phys_descent
> it
->descent
);
21675 glyph
->padding_p
= 0;
21676 glyph
->glyph_not_available_p
= 0;
21677 glyph
->face_id
= it
->face_id
;
21678 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21681 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21682 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21684 glyph
->bidi_type
= it
->bidi_it
.type
;
21686 ++it
->glyph_row
->used
[area
];
21689 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21693 /* Change IT->ascent and IT->height according to the setting of
21697 take_vertical_position_into_account (struct it
*it
)
21701 if (it
->voffset
< 0)
21702 /* Increase the ascent so that we can display the text higher
21704 it
->ascent
-= it
->voffset
;
21706 /* Increase the descent so that we can display the text lower
21708 it
->descent
+= it
->voffset
;
21713 /* Produce glyphs/get display metrics for the image IT is loaded with.
21714 See the description of struct display_iterator in dispextern.h for
21715 an overview of struct display_iterator. */
21718 produce_image_glyph (struct it
*it
)
21722 int glyph_ascent
, crop
;
21723 struct glyph_slice slice
;
21725 xassert (it
->what
== IT_IMAGE
);
21727 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21729 /* Make sure X resources of the face is loaded. */
21730 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21732 if (it
->image_id
< 0)
21734 /* Fringe bitmap. */
21735 it
->ascent
= it
->phys_ascent
= 0;
21736 it
->descent
= it
->phys_descent
= 0;
21737 it
->pixel_width
= 0;
21742 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21744 /* Make sure X resources of the image is loaded. */
21745 prepare_image_for_display (it
->f
, img
);
21747 slice
.x
= slice
.y
= 0;
21748 slice
.width
= img
->width
;
21749 slice
.height
= img
->height
;
21751 if (INTEGERP (it
->slice
.x
))
21752 slice
.x
= XINT (it
->slice
.x
);
21753 else if (FLOATP (it
->slice
.x
))
21754 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21756 if (INTEGERP (it
->slice
.y
))
21757 slice
.y
= XINT (it
->slice
.y
);
21758 else if (FLOATP (it
->slice
.y
))
21759 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21761 if (INTEGERP (it
->slice
.width
))
21762 slice
.width
= XINT (it
->slice
.width
);
21763 else if (FLOATP (it
->slice
.width
))
21764 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21766 if (INTEGERP (it
->slice
.height
))
21767 slice
.height
= XINT (it
->slice
.height
);
21768 else if (FLOATP (it
->slice
.height
))
21769 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21771 if (slice
.x
>= img
->width
)
21772 slice
.x
= img
->width
;
21773 if (slice
.y
>= img
->height
)
21774 slice
.y
= img
->height
;
21775 if (slice
.x
+ slice
.width
>= img
->width
)
21776 slice
.width
= img
->width
- slice
.x
;
21777 if (slice
.y
+ slice
.height
> img
->height
)
21778 slice
.height
= img
->height
- slice
.y
;
21780 if (slice
.width
== 0 || slice
.height
== 0)
21783 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21785 it
->descent
= slice
.height
- glyph_ascent
;
21787 it
->descent
+= img
->vmargin
;
21788 if (slice
.y
+ slice
.height
== img
->height
)
21789 it
->descent
+= img
->vmargin
;
21790 it
->phys_descent
= it
->descent
;
21792 it
->pixel_width
= slice
.width
;
21794 it
->pixel_width
+= img
->hmargin
;
21795 if (slice
.x
+ slice
.width
== img
->width
)
21796 it
->pixel_width
+= img
->hmargin
;
21798 /* It's quite possible for images to have an ascent greater than
21799 their height, so don't get confused in that case. */
21800 if (it
->descent
< 0)
21805 if (face
->box
!= FACE_NO_BOX
)
21807 if (face
->box_line_width
> 0)
21810 it
->ascent
+= face
->box_line_width
;
21811 if (slice
.y
+ slice
.height
== img
->height
)
21812 it
->descent
+= face
->box_line_width
;
21815 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21816 it
->pixel_width
+= eabs (face
->box_line_width
);
21817 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21818 it
->pixel_width
+= eabs (face
->box_line_width
);
21821 take_vertical_position_into_account (it
);
21823 /* Automatically crop wide image glyphs at right edge so we can
21824 draw the cursor on same display row. */
21825 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21826 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21828 it
->pixel_width
-= crop
;
21829 slice
.width
-= crop
;
21834 struct glyph
*glyph
;
21835 enum glyph_row_area area
= it
->area
;
21837 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21838 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21840 glyph
->charpos
= CHARPOS (it
->position
);
21841 glyph
->object
= it
->object
;
21842 glyph
->pixel_width
= it
->pixel_width
;
21843 glyph
->ascent
= glyph_ascent
;
21844 glyph
->descent
= it
->descent
;
21845 glyph
->voffset
= it
->voffset
;
21846 glyph
->type
= IMAGE_GLYPH
;
21847 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21848 glyph
->multibyte_p
= it
->multibyte_p
;
21849 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21850 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21851 glyph
->overlaps_vertically_p
= 0;
21852 glyph
->padding_p
= 0;
21853 glyph
->glyph_not_available_p
= 0;
21854 glyph
->face_id
= it
->face_id
;
21855 glyph
->u
.img_id
= img
->id
;
21856 glyph
->slice
.img
= slice
;
21857 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21860 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21861 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21863 glyph
->bidi_type
= it
->bidi_it
.type
;
21865 ++it
->glyph_row
->used
[area
];
21868 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21873 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21874 of the glyph, WIDTH and HEIGHT are the width and height of the
21875 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21878 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21879 int width
, int height
, int ascent
)
21881 struct glyph
*glyph
;
21882 enum glyph_row_area area
= it
->area
;
21884 xassert (ascent
>= 0 && ascent
<= height
);
21886 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21887 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21889 /* If the glyph row is reversed, we need to prepend the glyph
21890 rather than append it. */
21891 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21895 /* Make room for the additional glyph. */
21896 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21898 glyph
= it
->glyph_row
->glyphs
[area
];
21900 glyph
->charpos
= CHARPOS (it
->position
);
21901 glyph
->object
= object
;
21902 glyph
->pixel_width
= width
;
21903 glyph
->ascent
= ascent
;
21904 glyph
->descent
= height
- ascent
;
21905 glyph
->voffset
= it
->voffset
;
21906 glyph
->type
= STRETCH_GLYPH
;
21907 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21908 glyph
->multibyte_p
= it
->multibyte_p
;
21909 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21910 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21911 glyph
->overlaps_vertically_p
= 0;
21912 glyph
->padding_p
= 0;
21913 glyph
->glyph_not_available_p
= 0;
21914 glyph
->face_id
= it
->face_id
;
21915 glyph
->u
.stretch
.ascent
= ascent
;
21916 glyph
->u
.stretch
.height
= height
;
21917 glyph
->slice
.img
= null_glyph_slice
;
21918 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21921 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21922 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21924 glyph
->bidi_type
= it
->bidi_it
.type
;
21928 glyph
->resolved_level
= 0;
21929 glyph
->bidi_type
= UNKNOWN_BT
;
21931 ++it
->glyph_row
->used
[area
];
21934 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21938 /* Produce a stretch glyph for iterator IT. IT->object is the value
21939 of the glyph property displayed. The value must be a list
21940 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21943 1. `:width WIDTH' specifies that the space should be WIDTH *
21944 canonical char width wide. WIDTH may be an integer or floating
21947 2. `:relative-width FACTOR' specifies that the width of the stretch
21948 should be computed from the width of the first character having the
21949 `glyph' property, and should be FACTOR times that width.
21951 3. `:align-to HPOS' specifies that the space should be wide enough
21952 to reach HPOS, a value in canonical character units.
21954 Exactly one of the above pairs must be present.
21956 4. `:height HEIGHT' specifies that the height of the stretch produced
21957 should be HEIGHT, measured in canonical character units.
21959 5. `:relative-height FACTOR' specifies that the height of the
21960 stretch should be FACTOR times the height of the characters having
21961 the glyph property.
21963 Either none or exactly one of 4 or 5 must be present.
21965 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21966 of the stretch should be used for the ascent of the stretch.
21967 ASCENT must be in the range 0 <= ASCENT <= 100. */
21970 produce_stretch_glyph (struct it
*it
)
21972 /* (space :width WIDTH :height HEIGHT ...) */
21973 Lisp_Object prop
, plist
;
21974 int width
= 0, height
= 0, align_to
= -1;
21975 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21978 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21979 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21981 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21983 /* List should start with `space'. */
21984 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21985 plist
= XCDR (it
->object
);
21987 /* Compute the width of the stretch. */
21988 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21989 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21991 /* Absolute width `:width WIDTH' specified and valid. */
21992 zero_width_ok_p
= 1;
21995 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21998 /* Relative width `:relative-width FACTOR' specified and valid.
21999 Compute the width of the characters having the `glyph'
22002 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22005 if (it
->multibyte_p
)
22006 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22009 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22010 if (! ASCII_CHAR_P (it2
.c
))
22011 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22014 it2
.glyph_row
= NULL
;
22015 it2
.what
= IT_CHARACTER
;
22016 x_produce_glyphs (&it2
);
22017 width
= NUMVAL (prop
) * it2
.pixel_width
;
22019 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22020 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22022 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22023 align_to
= (align_to
< 0
22025 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22026 else if (align_to
< 0)
22027 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22028 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22029 zero_width_ok_p
= 1;
22032 /* Nothing specified -> width defaults to canonical char width. */
22033 width
= FRAME_COLUMN_WIDTH (it
->f
);
22035 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22038 /* Compute height. */
22039 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22040 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22043 zero_height_ok_p
= 1;
22045 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22047 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22049 height
= FONT_HEIGHT (font
);
22051 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22054 /* Compute percentage of height used for ascent. If
22055 `:ascent ASCENT' is present and valid, use that. Otherwise,
22056 derive the ascent from the font in use. */
22057 if (prop
= Fplist_get (plist
, QCascent
),
22058 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22059 ascent
= height
* NUMVAL (prop
) / 100.0;
22060 else if (!NILP (prop
)
22061 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22062 ascent
= min (max (0, (int)tem
), height
);
22064 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22066 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22067 && it
->current_x
+ width
> it
->last_visible_x
)
22068 width
= it
->last_visible_x
- it
->current_x
- 1;
22070 if (width
> 0 && height
> 0 && it
->glyph_row
)
22072 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22073 if (!STRINGP (object
))
22074 object
= it
->w
->buffer
;
22075 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22078 it
->pixel_width
= width
;
22079 it
->ascent
= it
->phys_ascent
= ascent
;
22080 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22081 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22083 take_vertical_position_into_account (it
);
22086 /* Calculate line-height and line-spacing properties.
22087 An integer value specifies explicit pixel value.
22088 A float value specifies relative value to current face height.
22089 A cons (float . face-name) specifies relative value to
22090 height of specified face font.
22092 Returns height in pixels, or nil. */
22096 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22097 int boff
, int override
)
22099 Lisp_Object face_name
= Qnil
;
22100 int ascent
, descent
, height
;
22102 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22107 face_name
= XCAR (val
);
22109 if (!NUMBERP (val
))
22110 val
= make_number (1);
22111 if (NILP (face_name
))
22113 height
= it
->ascent
+ it
->descent
;
22118 if (NILP (face_name
))
22120 font
= FRAME_FONT (it
->f
);
22121 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22123 else if (EQ (face_name
, Qt
))
22132 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22134 return make_number (-1);
22136 face
= FACE_FROM_ID (it
->f
, face_id
);
22139 return make_number (-1);
22140 boff
= font
->baseline_offset
;
22141 if (font
->vertical_centering
)
22142 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22145 ascent
= FONT_BASE (font
) + boff
;
22146 descent
= FONT_DESCENT (font
) - boff
;
22150 it
->override_ascent
= ascent
;
22151 it
->override_descent
= descent
;
22152 it
->override_boff
= boff
;
22155 height
= ascent
+ descent
;
22159 height
= (int)(XFLOAT_DATA (val
) * height
);
22160 else if (INTEGERP (val
))
22161 height
*= XINT (val
);
22163 return make_number (height
);
22167 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22168 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22169 and only if this is for a character for which no font was found.
22171 If the display method (it->glyphless_method) is
22172 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22173 length of the acronym or the hexadecimal string, UPPER_XOFF and
22174 UPPER_YOFF are pixel offsets for the upper part of the string,
22175 LOWER_XOFF and LOWER_YOFF are for the lower part.
22177 For the other display methods, LEN through LOWER_YOFF are zero. */
22180 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22181 short upper_xoff
, short upper_yoff
,
22182 short lower_xoff
, short lower_yoff
)
22184 struct glyph
*glyph
;
22185 enum glyph_row_area area
= it
->area
;
22187 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22188 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22190 /* If the glyph row is reversed, we need to prepend the glyph
22191 rather than append it. */
22192 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22196 /* Make room for the additional glyph. */
22197 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22199 glyph
= it
->glyph_row
->glyphs
[area
];
22201 glyph
->charpos
= CHARPOS (it
->position
);
22202 glyph
->object
= it
->object
;
22203 glyph
->pixel_width
= it
->pixel_width
;
22204 glyph
->ascent
= it
->ascent
;
22205 glyph
->descent
= it
->descent
;
22206 glyph
->voffset
= it
->voffset
;
22207 glyph
->type
= GLYPHLESS_GLYPH
;
22208 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22209 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22210 glyph
->u
.glyphless
.len
= len
;
22211 glyph
->u
.glyphless
.ch
= it
->c
;
22212 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22213 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22214 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22215 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22216 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22217 glyph
->multibyte_p
= it
->multibyte_p
;
22218 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22219 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22220 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22221 || it
->phys_descent
> it
->descent
);
22222 glyph
->padding_p
= 0;
22223 glyph
->glyph_not_available_p
= 0;
22224 glyph
->face_id
= face_id
;
22225 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22228 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22229 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22231 glyph
->bidi_type
= it
->bidi_it
.type
;
22233 ++it
->glyph_row
->used
[area
];
22236 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22240 /* Produce a glyph for a glyphless character for iterator IT.
22241 IT->glyphless_method specifies which method to use for displaying
22242 the character. See the description of enum
22243 glyphless_display_method in dispextern.h for the detail.
22245 FOR_NO_FONT is nonzero if and only if this is for a character for
22246 which no font was found. ACRONYM, if non-nil, is an acronym string
22247 for the character. */
22250 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22255 int base_width
, base_height
, width
, height
;
22256 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22259 /* Get the metrics of the base font. We always refer to the current
22261 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22262 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22263 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22264 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22265 base_height
= it
->ascent
+ it
->descent
;
22266 base_width
= font
->average_width
;
22268 /* Get a face ID for the glyph by utilizing a cache (the same way as
22269 doen for `escape-glyph' in get_next_display_element). */
22270 if (it
->f
== last_glyphless_glyph_frame
22271 && it
->face_id
== last_glyphless_glyph_face_id
)
22273 face_id
= last_glyphless_glyph_merged_face_id
;
22277 /* Merge the `glyphless-char' face into the current face. */
22278 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22279 last_glyphless_glyph_frame
= it
->f
;
22280 last_glyphless_glyph_face_id
= it
->face_id
;
22281 last_glyphless_glyph_merged_face_id
= face_id
;
22284 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22286 it
->pixel_width
= THIN_SPACE_WIDTH
;
22288 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22290 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22292 width
= CHAR_WIDTH (it
->c
);
22295 else if (width
> 4)
22297 it
->pixel_width
= base_width
* width
;
22299 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22305 unsigned int code
[6];
22307 int ascent
, descent
;
22308 struct font_metrics metrics_upper
, metrics_lower
;
22310 face
= FACE_FROM_ID (it
->f
, face_id
);
22311 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22312 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22314 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22316 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22317 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22318 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22322 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22323 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22326 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22327 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22328 upper_len
= (len
+ 1) / 2;
22329 font
->driver
->text_extents (font
, code
, upper_len
,
22331 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22336 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22337 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22338 upper_xoff
= upper_yoff
= 2; /* the typical case */
22339 if (base_width
>= width
)
22341 /* Align the upper to the left, the lower to the right. */
22342 it
->pixel_width
= base_width
;
22343 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22347 /* Center the shorter one. */
22348 it
->pixel_width
= width
;
22349 if (metrics_upper
.width
>= metrics_lower
.width
)
22350 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22353 /* FIXME: This code doesn't look right. It formerly was
22354 missing the "lower_xoff = 0;", which couldn't have
22355 been right since it left lower_xoff uninitialized. */
22357 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22361 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22362 top, bottom, and between upper and lower strings. */
22363 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22364 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22365 /* Center vertically.
22366 H:base_height, D:base_descent
22367 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22369 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22370 descent = D - H/2 + h/2;
22371 lower_yoff = descent - 2 - ld;
22372 upper_yoff = lower_yoff - la - 1 - ud; */
22373 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22374 descent
= it
->descent
- (base_height
- height
) / 2;
22375 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22376 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22377 - metrics_upper
.descent
);
22378 /* Don't make the height shorter than the base height. */
22379 if (height
> base_height
)
22381 it
->ascent
= ascent
;
22382 it
->descent
= descent
;
22386 it
->phys_ascent
= it
->ascent
;
22387 it
->phys_descent
= it
->descent
;
22389 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22390 upper_xoff
, upper_yoff
,
22391 lower_xoff
, lower_yoff
);
22393 take_vertical_position_into_account (it
);
22398 Produce glyphs/get display metrics for the display element IT is
22399 loaded with. See the description of struct it in dispextern.h
22400 for an overview of struct it. */
22403 x_produce_glyphs (struct it
*it
)
22405 int extra_line_spacing
= it
->extra_line_spacing
;
22407 it
->glyph_not_available_p
= 0;
22409 if (it
->what
== IT_CHARACTER
)
22412 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22413 struct font
*font
= face
->font
;
22414 struct font_metrics
*pcm
= NULL
;
22415 int boff
; /* baseline offset */
22419 /* When no suitable font is found, display this character by
22420 the method specified in the first extra slot of
22421 Vglyphless_char_display. */
22422 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22424 xassert (it
->what
== IT_GLYPHLESS
);
22425 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22429 boff
= font
->baseline_offset
;
22430 if (font
->vertical_centering
)
22431 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22433 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22439 if (it
->override_ascent
>= 0)
22441 it
->ascent
= it
->override_ascent
;
22442 it
->descent
= it
->override_descent
;
22443 boff
= it
->override_boff
;
22447 it
->ascent
= FONT_BASE (font
) + boff
;
22448 it
->descent
= FONT_DESCENT (font
) - boff
;
22451 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22453 pcm
= get_per_char_metric (font
, &char2b
);
22454 if (pcm
->width
== 0
22455 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22461 it
->phys_ascent
= pcm
->ascent
+ boff
;
22462 it
->phys_descent
= pcm
->descent
- boff
;
22463 it
->pixel_width
= pcm
->width
;
22467 it
->glyph_not_available_p
= 1;
22468 it
->phys_ascent
= it
->ascent
;
22469 it
->phys_descent
= it
->descent
;
22470 it
->pixel_width
= font
->space_width
;
22473 if (it
->constrain_row_ascent_descent_p
)
22475 if (it
->descent
> it
->max_descent
)
22477 it
->ascent
+= it
->descent
- it
->max_descent
;
22478 it
->descent
= it
->max_descent
;
22480 if (it
->ascent
> it
->max_ascent
)
22482 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22483 it
->ascent
= it
->max_ascent
;
22485 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22486 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22487 extra_line_spacing
= 0;
22490 /* If this is a space inside a region of text with
22491 `space-width' property, change its width. */
22492 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22494 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22496 /* If face has a box, add the box thickness to the character
22497 height. If character has a box line to the left and/or
22498 right, add the box line width to the character's width. */
22499 if (face
->box
!= FACE_NO_BOX
)
22501 int thick
= face
->box_line_width
;
22505 it
->ascent
+= thick
;
22506 it
->descent
+= thick
;
22511 if (it
->start_of_box_run_p
)
22512 it
->pixel_width
+= thick
;
22513 if (it
->end_of_box_run_p
)
22514 it
->pixel_width
+= thick
;
22517 /* If face has an overline, add the height of the overline
22518 (1 pixel) and a 1 pixel margin to the character height. */
22519 if (face
->overline_p
)
22520 it
->ascent
+= overline_margin
;
22522 if (it
->constrain_row_ascent_descent_p
)
22524 if (it
->ascent
> it
->max_ascent
)
22525 it
->ascent
= it
->max_ascent
;
22526 if (it
->descent
> it
->max_descent
)
22527 it
->descent
= it
->max_descent
;
22530 take_vertical_position_into_account (it
);
22532 /* If we have to actually produce glyphs, do it. */
22537 /* Translate a space with a `space-width' property
22538 into a stretch glyph. */
22539 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22540 / FONT_HEIGHT (font
));
22541 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22542 it
->ascent
+ it
->descent
, ascent
);
22547 /* If characters with lbearing or rbearing are displayed
22548 in this line, record that fact in a flag of the
22549 glyph row. This is used to optimize X output code. */
22550 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22551 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22553 if (! stretched_p
&& it
->pixel_width
== 0)
22554 /* We assure that all visible glyphs have at least 1-pixel
22556 it
->pixel_width
= 1;
22558 else if (it
->char_to_display
== '\n')
22560 /* A newline has no width, but we need the height of the
22561 line. But if previous part of the line sets a height,
22562 don't increase that height */
22564 Lisp_Object height
;
22565 Lisp_Object total_height
= Qnil
;
22567 it
->override_ascent
= -1;
22568 it
->pixel_width
= 0;
22571 height
= get_it_property (it
, Qline_height
);
22572 /* Split (line-height total-height) list */
22574 && CONSP (XCDR (height
))
22575 && NILP (XCDR (XCDR (height
))))
22577 total_height
= XCAR (XCDR (height
));
22578 height
= XCAR (height
);
22580 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22582 if (it
->override_ascent
>= 0)
22584 it
->ascent
= it
->override_ascent
;
22585 it
->descent
= it
->override_descent
;
22586 boff
= it
->override_boff
;
22590 it
->ascent
= FONT_BASE (font
) + boff
;
22591 it
->descent
= FONT_DESCENT (font
) - boff
;
22594 if (EQ (height
, Qt
))
22596 if (it
->descent
> it
->max_descent
)
22598 it
->ascent
+= it
->descent
- it
->max_descent
;
22599 it
->descent
= it
->max_descent
;
22601 if (it
->ascent
> it
->max_ascent
)
22603 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22604 it
->ascent
= it
->max_ascent
;
22606 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22607 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22608 it
->constrain_row_ascent_descent_p
= 1;
22609 extra_line_spacing
= 0;
22613 Lisp_Object spacing
;
22615 it
->phys_ascent
= it
->ascent
;
22616 it
->phys_descent
= it
->descent
;
22618 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22619 && face
->box
!= FACE_NO_BOX
22620 && face
->box_line_width
> 0)
22622 it
->ascent
+= face
->box_line_width
;
22623 it
->descent
+= face
->box_line_width
;
22626 && XINT (height
) > it
->ascent
+ it
->descent
)
22627 it
->ascent
= XINT (height
) - it
->descent
;
22629 if (!NILP (total_height
))
22630 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22633 spacing
= get_it_property (it
, Qline_spacing
);
22634 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22636 if (INTEGERP (spacing
))
22638 extra_line_spacing
= XINT (spacing
);
22639 if (!NILP (total_height
))
22640 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22644 else /* i.e. (it->char_to_display == '\t') */
22646 if (font
->space_width
> 0)
22648 int tab_width
= it
->tab_width
* font
->space_width
;
22649 int x
= it
->current_x
+ it
->continuation_lines_width
;
22650 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22652 /* If the distance from the current position to the next tab
22653 stop is less than a space character width, use the
22654 tab stop after that. */
22655 if (next_tab_x
- x
< font
->space_width
)
22656 next_tab_x
+= tab_width
;
22658 it
->pixel_width
= next_tab_x
- x
;
22660 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22661 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22665 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22666 it
->ascent
+ it
->descent
, it
->ascent
);
22671 it
->pixel_width
= 0;
22676 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22678 /* A static composition.
22680 Note: A composition is represented as one glyph in the
22681 glyph matrix. There are no padding glyphs.
22683 Important note: pixel_width, ascent, and descent are the
22684 values of what is drawn by draw_glyphs (i.e. the values of
22685 the overall glyphs composed). */
22686 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22687 int boff
; /* baseline offset */
22688 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22689 int glyph_len
= cmp
->glyph_len
;
22690 struct font
*font
= face
->font
;
22694 /* If we have not yet calculated pixel size data of glyphs of
22695 the composition for the current face font, calculate them
22696 now. Theoretically, we have to check all fonts for the
22697 glyphs, but that requires much time and memory space. So,
22698 here we check only the font of the first glyph. This may
22699 lead to incorrect display, but it's very rare, and C-l
22700 (recenter-top-bottom) can correct the display anyway. */
22701 if (! cmp
->font
|| cmp
->font
!= font
)
22703 /* Ascent and descent of the font of the first character
22704 of this composition (adjusted by baseline offset).
22705 Ascent and descent of overall glyphs should not be less
22706 than these, respectively. */
22707 int font_ascent
, font_descent
, font_height
;
22708 /* Bounding box of the overall glyphs. */
22709 int leftmost
, rightmost
, lowest
, highest
;
22710 int lbearing
, rbearing
;
22711 int i
, width
, ascent
, descent
;
22712 int left_padded
= 0, right_padded
= 0;
22713 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22715 struct font_metrics
*pcm
;
22716 int font_not_found_p
;
22719 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22720 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22722 if (glyph_len
< cmp
->glyph_len
)
22724 for (i
= 0; i
< glyph_len
; i
++)
22726 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22728 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22733 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22734 : IT_CHARPOS (*it
));
22735 /* If no suitable font is found, use the default font. */
22736 font_not_found_p
= font
== NULL
;
22737 if (font_not_found_p
)
22739 face
= face
->ascii_face
;
22742 boff
= font
->baseline_offset
;
22743 if (font
->vertical_centering
)
22744 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22745 font_ascent
= FONT_BASE (font
) + boff
;
22746 font_descent
= FONT_DESCENT (font
) - boff
;
22747 font_height
= FONT_HEIGHT (font
);
22749 cmp
->font
= (void *) font
;
22752 if (! font_not_found_p
)
22754 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22756 pcm
= get_per_char_metric (font
, &char2b
);
22759 /* Initialize the bounding box. */
22762 width
= pcm
->width
;
22763 ascent
= pcm
->ascent
;
22764 descent
= pcm
->descent
;
22765 lbearing
= pcm
->lbearing
;
22766 rbearing
= pcm
->rbearing
;
22770 width
= font
->space_width
;
22771 ascent
= FONT_BASE (font
);
22772 descent
= FONT_DESCENT (font
);
22779 lowest
= - descent
+ boff
;
22780 highest
= ascent
+ boff
;
22782 if (! font_not_found_p
22783 && font
->default_ascent
22784 && CHAR_TABLE_P (Vuse_default_ascent
)
22785 && !NILP (Faref (Vuse_default_ascent
,
22786 make_number (it
->char_to_display
))))
22787 highest
= font
->default_ascent
+ boff
;
22789 /* Draw the first glyph at the normal position. It may be
22790 shifted to right later if some other glyphs are drawn
22792 cmp
->offsets
[i
* 2] = 0;
22793 cmp
->offsets
[i
* 2 + 1] = boff
;
22794 cmp
->lbearing
= lbearing
;
22795 cmp
->rbearing
= rbearing
;
22797 /* Set cmp->offsets for the remaining glyphs. */
22798 for (i
++; i
< glyph_len
; i
++)
22800 int left
, right
, btm
, top
;
22801 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22803 struct face
*this_face
;
22807 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22808 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22809 font
= this_face
->font
;
22815 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22817 pcm
= get_per_char_metric (font
, &char2b
);
22820 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22823 width
= pcm
->width
;
22824 ascent
= pcm
->ascent
;
22825 descent
= pcm
->descent
;
22826 lbearing
= pcm
->lbearing
;
22827 rbearing
= pcm
->rbearing
;
22828 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22830 /* Relative composition with or without
22831 alternate chars. */
22832 left
= (leftmost
+ rightmost
- width
) / 2;
22833 btm
= - descent
+ boff
;
22834 if (font
->relative_compose
22835 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22836 || NILP (Faref (Vignore_relative_composition
,
22837 make_number (ch
)))))
22840 if (- descent
>= font
->relative_compose
)
22841 /* One extra pixel between two glyphs. */
22843 else if (ascent
<= 0)
22844 /* One extra pixel between two glyphs. */
22845 btm
= lowest
- 1 - ascent
- descent
;
22850 /* A composition rule is specified by an integer
22851 value that encodes global and new reference
22852 points (GREF and NREF). GREF and NREF are
22853 specified by numbers as below:
22855 0---1---2 -- ascent
22859 9--10--11 -- center
22861 ---3---4---5--- baseline
22863 6---7---8 -- descent
22865 int rule
= COMPOSITION_RULE (cmp
, i
);
22866 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22868 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22869 grefx
= gref
% 3, nrefx
= nref
% 3;
22870 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22872 xoff
= font_height
* (xoff
- 128) / 256;
22874 yoff
= font_height
* (yoff
- 128) / 256;
22877 + grefx
* (rightmost
- leftmost
) / 2
22878 - nrefx
* width
/ 2
22881 btm
= ((grefy
== 0 ? highest
22883 : grefy
== 2 ? lowest
22884 : (highest
+ lowest
) / 2)
22885 - (nrefy
== 0 ? ascent
+ descent
22886 : nrefy
== 1 ? descent
- boff
22888 : (ascent
+ descent
) / 2)
22892 cmp
->offsets
[i
* 2] = left
;
22893 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22895 /* Update the bounding box of the overall glyphs. */
22898 right
= left
+ width
;
22899 if (left
< leftmost
)
22901 if (right
> rightmost
)
22904 top
= btm
+ descent
+ ascent
;
22910 if (cmp
->lbearing
> left
+ lbearing
)
22911 cmp
->lbearing
= left
+ lbearing
;
22912 if (cmp
->rbearing
< left
+ rbearing
)
22913 cmp
->rbearing
= left
+ rbearing
;
22917 /* If there are glyphs whose x-offsets are negative,
22918 shift all glyphs to the right and make all x-offsets
22922 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22923 cmp
->offsets
[i
* 2] -= leftmost
;
22924 rightmost
-= leftmost
;
22925 cmp
->lbearing
-= leftmost
;
22926 cmp
->rbearing
-= leftmost
;
22929 if (left_padded
&& cmp
->lbearing
< 0)
22931 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22932 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22933 rightmost
-= cmp
->lbearing
;
22934 cmp
->rbearing
-= cmp
->lbearing
;
22937 if (right_padded
&& rightmost
< cmp
->rbearing
)
22939 rightmost
= cmp
->rbearing
;
22942 cmp
->pixel_width
= rightmost
;
22943 cmp
->ascent
= highest
;
22944 cmp
->descent
= - lowest
;
22945 if (cmp
->ascent
< font_ascent
)
22946 cmp
->ascent
= font_ascent
;
22947 if (cmp
->descent
< font_descent
)
22948 cmp
->descent
= font_descent
;
22952 && (cmp
->lbearing
< 0
22953 || cmp
->rbearing
> cmp
->pixel_width
))
22954 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22956 it
->pixel_width
= cmp
->pixel_width
;
22957 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22958 it
->descent
= it
->phys_descent
= cmp
->descent
;
22959 if (face
->box
!= FACE_NO_BOX
)
22961 int thick
= face
->box_line_width
;
22965 it
->ascent
+= thick
;
22966 it
->descent
+= thick
;
22971 if (it
->start_of_box_run_p
)
22972 it
->pixel_width
+= thick
;
22973 if (it
->end_of_box_run_p
)
22974 it
->pixel_width
+= thick
;
22977 /* If face has an overline, add the height of the overline
22978 (1 pixel) and a 1 pixel margin to the character height. */
22979 if (face
->overline_p
)
22980 it
->ascent
+= overline_margin
;
22982 take_vertical_position_into_account (it
);
22983 if (it
->ascent
< 0)
22985 if (it
->descent
< 0)
22989 append_composite_glyph (it
);
22991 else if (it
->what
== IT_COMPOSITION
)
22993 /* A dynamic (automatic) composition. */
22994 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22995 Lisp_Object gstring
;
22996 struct font_metrics metrics
;
22998 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23000 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23003 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23004 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23005 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23006 it
->descent
= it
->phys_descent
= metrics
.descent
;
23007 if (face
->box
!= FACE_NO_BOX
)
23009 int thick
= face
->box_line_width
;
23013 it
->ascent
+= thick
;
23014 it
->descent
+= thick
;
23019 if (it
->start_of_box_run_p
)
23020 it
->pixel_width
+= thick
;
23021 if (it
->end_of_box_run_p
)
23022 it
->pixel_width
+= thick
;
23024 /* If face has an overline, add the height of the overline
23025 (1 pixel) and a 1 pixel margin to the character height. */
23026 if (face
->overline_p
)
23027 it
->ascent
+= overline_margin
;
23028 take_vertical_position_into_account (it
);
23029 if (it
->ascent
< 0)
23031 if (it
->descent
< 0)
23035 append_composite_glyph (it
);
23037 else if (it
->what
== IT_GLYPHLESS
)
23038 produce_glyphless_glyph (it
, 0, Qnil
);
23039 else if (it
->what
== IT_IMAGE
)
23040 produce_image_glyph (it
);
23041 else if (it
->what
== IT_STRETCH
)
23042 produce_stretch_glyph (it
);
23045 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23046 because this isn't true for images with `:ascent 100'. */
23047 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23048 if (it
->area
== TEXT_AREA
)
23049 it
->current_x
+= it
->pixel_width
;
23051 if (extra_line_spacing
> 0)
23053 it
->descent
+= extra_line_spacing
;
23054 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23055 it
->max_extra_line_spacing
= extra_line_spacing
;
23058 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23059 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23060 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23061 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23065 Output LEN glyphs starting at START at the nominal cursor position.
23066 Advance the nominal cursor over the text. The global variable
23067 updated_window contains the window being updated, updated_row is
23068 the glyph row being updated, and updated_area is the area of that
23069 row being updated. */
23072 x_write_glyphs (struct glyph
*start
, int len
)
23076 xassert (updated_window
&& updated_row
);
23079 /* Write glyphs. */
23081 hpos
= start
- updated_row
->glyphs
[updated_area
];
23082 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23083 updated_row
, updated_area
,
23085 DRAW_NORMAL_TEXT
, 0);
23087 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23088 if (updated_area
== TEXT_AREA
23089 && updated_window
->phys_cursor_on_p
23090 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23091 && updated_window
->phys_cursor
.hpos
>= hpos
23092 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23093 updated_window
->phys_cursor_on_p
= 0;
23097 /* Advance the output cursor. */
23098 output_cursor
.hpos
+= len
;
23099 output_cursor
.x
= x
;
23104 Insert LEN glyphs from START at the nominal cursor position. */
23107 x_insert_glyphs (struct glyph
*start
, int len
)
23111 int line_height
, shift_by_width
, shifted_region_width
;
23112 struct glyph_row
*row
;
23113 struct glyph
*glyph
;
23114 int frame_x
, frame_y
;
23117 xassert (updated_window
&& updated_row
);
23119 w
= updated_window
;
23120 f
= XFRAME (WINDOW_FRAME (w
));
23122 /* Get the height of the line we are in. */
23124 line_height
= row
->height
;
23126 /* Get the width of the glyphs to insert. */
23127 shift_by_width
= 0;
23128 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23129 shift_by_width
+= glyph
->pixel_width
;
23131 /* Get the width of the region to shift right. */
23132 shifted_region_width
= (window_box_width (w
, updated_area
)
23137 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23138 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23140 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23141 line_height
, shift_by_width
);
23143 /* Write the glyphs. */
23144 hpos
= start
- row
->glyphs
[updated_area
];
23145 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23147 DRAW_NORMAL_TEXT
, 0);
23149 /* Advance the output cursor. */
23150 output_cursor
.hpos
+= len
;
23151 output_cursor
.x
+= shift_by_width
;
23157 Erase the current text line from the nominal cursor position
23158 (inclusive) to pixel column TO_X (exclusive). The idea is that
23159 everything from TO_X onward is already erased.
23161 TO_X is a pixel position relative to updated_area of
23162 updated_window. TO_X == -1 means clear to the end of this area. */
23165 x_clear_end_of_line (int to_x
)
23168 struct window
*w
= updated_window
;
23169 int max_x
, min_y
, max_y
;
23170 int from_x
, from_y
, to_y
;
23172 xassert (updated_window
&& updated_row
);
23173 f
= XFRAME (w
->frame
);
23175 if (updated_row
->full_width_p
)
23176 max_x
= WINDOW_TOTAL_WIDTH (w
);
23178 max_x
= window_box_width (w
, updated_area
);
23179 max_y
= window_text_bottom_y (w
);
23181 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23182 of window. For TO_X > 0, truncate to end of drawing area. */
23188 to_x
= min (to_x
, max_x
);
23190 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23192 /* Notice if the cursor will be cleared by this operation. */
23193 if (!updated_row
->full_width_p
)
23194 notice_overwritten_cursor (w
, updated_area
,
23195 output_cursor
.x
, -1,
23197 MATRIX_ROW_BOTTOM_Y (updated_row
));
23199 from_x
= output_cursor
.x
;
23201 /* Translate to frame coordinates. */
23202 if (updated_row
->full_width_p
)
23204 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23205 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23209 int area_left
= window_box_left (w
, updated_area
);
23210 from_x
+= area_left
;
23214 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23215 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23216 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23218 /* Prevent inadvertently clearing to end of the X window. */
23219 if (to_x
> from_x
&& to_y
> from_y
)
23222 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23223 to_x
- from_x
, to_y
- from_y
);
23228 #endif /* HAVE_WINDOW_SYSTEM */
23232 /***********************************************************************
23234 ***********************************************************************/
23236 /* Value is the internal representation of the specified cursor type
23237 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23238 of the bar cursor. */
23240 static enum text_cursor_kinds
23241 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23243 enum text_cursor_kinds type
;
23248 if (EQ (arg
, Qbox
))
23249 return FILLED_BOX_CURSOR
;
23251 if (EQ (arg
, Qhollow
))
23252 return HOLLOW_BOX_CURSOR
;
23254 if (EQ (arg
, Qbar
))
23261 && EQ (XCAR (arg
), Qbar
)
23262 && INTEGERP (XCDR (arg
))
23263 && XINT (XCDR (arg
)) >= 0)
23265 *width
= XINT (XCDR (arg
));
23269 if (EQ (arg
, Qhbar
))
23272 return HBAR_CURSOR
;
23276 && EQ (XCAR (arg
), Qhbar
)
23277 && INTEGERP (XCDR (arg
))
23278 && XINT (XCDR (arg
)) >= 0)
23280 *width
= XINT (XCDR (arg
));
23281 return HBAR_CURSOR
;
23284 /* Treat anything unknown as "hollow box cursor".
23285 It was bad to signal an error; people have trouble fixing
23286 .Xdefaults with Emacs, when it has something bad in it. */
23287 type
= HOLLOW_BOX_CURSOR
;
23292 /* Set the default cursor types for specified frame. */
23294 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23299 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23300 FRAME_CURSOR_WIDTH (f
) = width
;
23302 /* By default, set up the blink-off state depending on the on-state. */
23304 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23307 FRAME_BLINK_OFF_CURSOR (f
)
23308 = get_specified_cursor_type (XCDR (tem
), &width
);
23309 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23312 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23316 #ifdef HAVE_WINDOW_SYSTEM
23318 /* Return the cursor we want to be displayed in window W. Return
23319 width of bar/hbar cursor through WIDTH arg. Return with
23320 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23321 (i.e. if the `system caret' should track this cursor).
23323 In a mini-buffer window, we want the cursor only to appear if we
23324 are reading input from this window. For the selected window, we
23325 want the cursor type given by the frame parameter or buffer local
23326 setting of cursor-type. If explicitly marked off, draw no cursor.
23327 In all other cases, we want a hollow box cursor. */
23329 static enum text_cursor_kinds
23330 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23331 int *active_cursor
)
23333 struct frame
*f
= XFRAME (w
->frame
);
23334 struct buffer
*b
= XBUFFER (w
->buffer
);
23335 int cursor_type
= DEFAULT_CURSOR
;
23336 Lisp_Object alt_cursor
;
23337 int non_selected
= 0;
23339 *active_cursor
= 1;
23342 if (cursor_in_echo_area
23343 && FRAME_HAS_MINIBUF_P (f
)
23344 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23346 if (w
== XWINDOW (echo_area_window
))
23348 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23350 *width
= FRAME_CURSOR_WIDTH (f
);
23351 return FRAME_DESIRED_CURSOR (f
);
23354 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23357 *active_cursor
= 0;
23361 /* Detect a nonselected window or nonselected frame. */
23362 else if (w
!= XWINDOW (f
->selected_window
)
23363 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23365 *active_cursor
= 0;
23367 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23373 /* Never display a cursor in a window in which cursor-type is nil. */
23374 if (NILP (BVAR (b
, cursor_type
)))
23377 /* Get the normal cursor type for this window. */
23378 if (EQ (BVAR (b
, cursor_type
), Qt
))
23380 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23381 *width
= FRAME_CURSOR_WIDTH (f
);
23384 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23386 /* Use cursor-in-non-selected-windows instead
23387 for non-selected window or frame. */
23390 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23391 if (!EQ (Qt
, alt_cursor
))
23392 return get_specified_cursor_type (alt_cursor
, width
);
23393 /* t means modify the normal cursor type. */
23394 if (cursor_type
== FILLED_BOX_CURSOR
)
23395 cursor_type
= HOLLOW_BOX_CURSOR
;
23396 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23398 return cursor_type
;
23401 /* Use normal cursor if not blinked off. */
23402 if (!w
->cursor_off_p
)
23404 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23406 if (cursor_type
== FILLED_BOX_CURSOR
)
23408 /* Using a block cursor on large images can be very annoying.
23409 So use a hollow cursor for "large" images.
23410 If image is not transparent (no mask), also use hollow cursor. */
23411 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23412 if (img
!= NULL
&& IMAGEP (img
->spec
))
23414 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23415 where N = size of default frame font size.
23416 This should cover most of the "tiny" icons people may use. */
23418 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23419 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23420 cursor_type
= HOLLOW_BOX_CURSOR
;
23423 else if (cursor_type
!= NO_CURSOR
)
23425 /* Display current only supports BOX and HOLLOW cursors for images.
23426 So for now, unconditionally use a HOLLOW cursor when cursor is
23427 not a solid box cursor. */
23428 cursor_type
= HOLLOW_BOX_CURSOR
;
23431 return cursor_type
;
23434 /* Cursor is blinked off, so determine how to "toggle" it. */
23436 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23437 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23438 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23440 /* Then see if frame has specified a specific blink off cursor type. */
23441 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23443 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23444 return FRAME_BLINK_OFF_CURSOR (f
);
23448 /* Some people liked having a permanently visible blinking cursor,
23449 while others had very strong opinions against it. So it was
23450 decided to remove it. KFS 2003-09-03 */
23452 /* Finally perform built-in cursor blinking:
23453 filled box <-> hollow box
23454 wide [h]bar <-> narrow [h]bar
23455 narrow [h]bar <-> no cursor
23456 other type <-> no cursor */
23458 if (cursor_type
== FILLED_BOX_CURSOR
)
23459 return HOLLOW_BOX_CURSOR
;
23461 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23464 return cursor_type
;
23472 /* Notice when the text cursor of window W has been completely
23473 overwritten by a drawing operation that outputs glyphs in AREA
23474 starting at X0 and ending at X1 in the line starting at Y0 and
23475 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23476 the rest of the line after X0 has been written. Y coordinates
23477 are window-relative. */
23480 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23481 int x0
, int x1
, int y0
, int y1
)
23483 int cx0
, cx1
, cy0
, cy1
;
23484 struct glyph_row
*row
;
23486 if (!w
->phys_cursor_on_p
)
23488 if (area
!= TEXT_AREA
)
23491 if (w
->phys_cursor
.vpos
< 0
23492 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23493 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23494 !(row
->enabled_p
&& row
->displays_text_p
)))
23497 if (row
->cursor_in_fringe_p
)
23499 row
->cursor_in_fringe_p
= 0;
23500 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23501 w
->phys_cursor_on_p
= 0;
23505 cx0
= w
->phys_cursor
.x
;
23506 cx1
= cx0
+ w
->phys_cursor_width
;
23507 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23510 /* The cursor image will be completely removed from the
23511 screen if the output area intersects the cursor area in
23512 y-direction. When we draw in [y0 y1[, and some part of
23513 the cursor is at y < y0, that part must have been drawn
23514 before. When scrolling, the cursor is erased before
23515 actually scrolling, so we don't come here. When not
23516 scrolling, the rows above the old cursor row must have
23517 changed, and in this case these rows must have written
23518 over the cursor image.
23520 Likewise if part of the cursor is below y1, with the
23521 exception of the cursor being in the first blank row at
23522 the buffer and window end because update_text_area
23523 doesn't draw that row. (Except when it does, but
23524 that's handled in update_text_area.) */
23526 cy0
= w
->phys_cursor
.y
;
23527 cy1
= cy0
+ w
->phys_cursor_height
;
23528 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23531 w
->phys_cursor_on_p
= 0;
23534 #endif /* HAVE_WINDOW_SYSTEM */
23537 /************************************************************************
23539 ************************************************************************/
23541 #ifdef HAVE_WINDOW_SYSTEM
23544 Fix the display of area AREA of overlapping row ROW in window W
23545 with respect to the overlapping part OVERLAPS. */
23548 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23549 enum glyph_row_area area
, int overlaps
)
23556 for (i
= 0; i
< row
->used
[area
];)
23558 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23560 int start
= i
, start_x
= x
;
23564 x
+= row
->glyphs
[area
][i
].pixel_width
;
23567 while (i
< row
->used
[area
]
23568 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23570 draw_glyphs (w
, start_x
, row
, area
,
23572 DRAW_NORMAL_TEXT
, overlaps
);
23576 x
+= row
->glyphs
[area
][i
].pixel_width
;
23586 Draw the cursor glyph of window W in glyph row ROW. See the
23587 comment of draw_glyphs for the meaning of HL. */
23590 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23591 enum draw_glyphs_face hl
)
23593 /* If cursor hpos is out of bounds, don't draw garbage. This can
23594 happen in mini-buffer windows when switching between echo area
23595 glyphs and mini-buffer. */
23596 if ((row
->reversed_p
23597 ? (w
->phys_cursor
.hpos
>= 0)
23598 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23600 int on_p
= w
->phys_cursor_on_p
;
23602 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23603 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23605 w
->phys_cursor_on_p
= on_p
;
23607 if (hl
== DRAW_CURSOR
)
23608 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23609 /* When we erase the cursor, and ROW is overlapped by other
23610 rows, make sure that these overlapping parts of other rows
23612 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23614 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23616 if (row
> w
->current_matrix
->rows
23617 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23618 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23619 OVERLAPS_ERASED_CURSOR
);
23621 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23622 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23623 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23624 OVERLAPS_ERASED_CURSOR
);
23631 Erase the image of a cursor of window W from the screen. */
23634 erase_phys_cursor (struct window
*w
)
23636 struct frame
*f
= XFRAME (w
->frame
);
23637 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23638 int hpos
= w
->phys_cursor
.hpos
;
23639 int vpos
= w
->phys_cursor
.vpos
;
23640 int mouse_face_here_p
= 0;
23641 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23642 struct glyph_row
*cursor_row
;
23643 struct glyph
*cursor_glyph
;
23644 enum draw_glyphs_face hl
;
23646 /* No cursor displayed or row invalidated => nothing to do on the
23648 if (w
->phys_cursor_type
== NO_CURSOR
)
23649 goto mark_cursor_off
;
23651 /* VPOS >= active_glyphs->nrows means that window has been resized.
23652 Don't bother to erase the cursor. */
23653 if (vpos
>= active_glyphs
->nrows
)
23654 goto mark_cursor_off
;
23656 /* If row containing cursor is marked invalid, there is nothing we
23658 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23659 if (!cursor_row
->enabled_p
)
23660 goto mark_cursor_off
;
23662 /* If line spacing is > 0, old cursor may only be partially visible in
23663 window after split-window. So adjust visible height. */
23664 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23665 window_text_bottom_y (w
) - cursor_row
->y
);
23667 /* If row is completely invisible, don't attempt to delete a cursor which
23668 isn't there. This can happen if cursor is at top of a window, and
23669 we switch to a buffer with a header line in that window. */
23670 if (cursor_row
->visible_height
<= 0)
23671 goto mark_cursor_off
;
23673 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23674 if (cursor_row
->cursor_in_fringe_p
)
23676 cursor_row
->cursor_in_fringe_p
= 0;
23677 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23678 goto mark_cursor_off
;
23681 /* This can happen when the new row is shorter than the old one.
23682 In this case, either draw_glyphs or clear_end_of_line
23683 should have cleared the cursor. Note that we wouldn't be
23684 able to erase the cursor in this case because we don't have a
23685 cursor glyph at hand. */
23686 if ((cursor_row
->reversed_p
23687 ? (w
->phys_cursor
.hpos
< 0)
23688 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23689 goto mark_cursor_off
;
23691 /* If the cursor is in the mouse face area, redisplay that when
23692 we clear the cursor. */
23693 if (! NILP (hlinfo
->mouse_face_window
)
23694 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23695 /* Don't redraw the cursor's spot in mouse face if it is at the
23696 end of a line (on a newline). The cursor appears there, but
23697 mouse highlighting does not. */
23698 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23699 mouse_face_here_p
= 1;
23701 /* Maybe clear the display under the cursor. */
23702 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23705 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23708 cursor_glyph
= get_phys_cursor_glyph (w
);
23709 if (cursor_glyph
== NULL
)
23710 goto mark_cursor_off
;
23712 width
= cursor_glyph
->pixel_width
;
23713 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23714 x
= w
->phys_cursor
.x
;
23716 width
-= left_x
- x
;
23717 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23718 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23719 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23722 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23725 /* Erase the cursor by redrawing the character underneath it. */
23726 if (mouse_face_here_p
)
23727 hl
= DRAW_MOUSE_FACE
;
23729 hl
= DRAW_NORMAL_TEXT
;
23730 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23733 w
->phys_cursor_on_p
= 0;
23734 w
->phys_cursor_type
= NO_CURSOR
;
23739 Display or clear cursor of window W. If ON is zero, clear the
23740 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23741 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23744 display_and_set_cursor (struct window
*w
, int on
,
23745 int hpos
, int vpos
, int x
, int y
)
23747 struct frame
*f
= XFRAME (w
->frame
);
23748 int new_cursor_type
;
23749 int new_cursor_width
;
23751 struct glyph_row
*glyph_row
;
23752 struct glyph
*glyph
;
23754 /* This is pointless on invisible frames, and dangerous on garbaged
23755 windows and frames; in the latter case, the frame or window may
23756 be in the midst of changing its size, and x and y may be off the
23758 if (! FRAME_VISIBLE_P (f
)
23759 || FRAME_GARBAGED_P (f
)
23760 || vpos
>= w
->current_matrix
->nrows
23761 || hpos
>= w
->current_matrix
->matrix_w
)
23764 /* If cursor is off and we want it off, return quickly. */
23765 if (!on
&& !w
->phys_cursor_on_p
)
23768 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23769 /* If cursor row is not enabled, we don't really know where to
23770 display the cursor. */
23771 if (!glyph_row
->enabled_p
)
23773 w
->phys_cursor_on_p
= 0;
23778 if (!glyph_row
->exact_window_width_line_p
23779 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23780 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23782 xassert (interrupt_input_blocked
);
23784 /* Set new_cursor_type to the cursor we want to be displayed. */
23785 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23786 &new_cursor_width
, &active_cursor
);
23788 /* If cursor is currently being shown and we don't want it to be or
23789 it is in the wrong place, or the cursor type is not what we want,
23791 if (w
->phys_cursor_on_p
23793 || w
->phys_cursor
.x
!= x
23794 || w
->phys_cursor
.y
!= y
23795 || new_cursor_type
!= w
->phys_cursor_type
23796 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23797 && new_cursor_width
!= w
->phys_cursor_width
)))
23798 erase_phys_cursor (w
);
23800 /* Don't check phys_cursor_on_p here because that flag is only set
23801 to zero in some cases where we know that the cursor has been
23802 completely erased, to avoid the extra work of erasing the cursor
23803 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23804 still not be visible, or it has only been partly erased. */
23807 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23808 w
->phys_cursor_height
= glyph_row
->height
;
23810 /* Set phys_cursor_.* before x_draw_.* is called because some
23811 of them may need the information. */
23812 w
->phys_cursor
.x
= x
;
23813 w
->phys_cursor
.y
= glyph_row
->y
;
23814 w
->phys_cursor
.hpos
= hpos
;
23815 w
->phys_cursor
.vpos
= vpos
;
23818 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23819 new_cursor_type
, new_cursor_width
,
23820 on
, active_cursor
);
23824 /* Switch the display of W's cursor on or off, according to the value
23828 update_window_cursor (struct window
*w
, int on
)
23830 /* Don't update cursor in windows whose frame is in the process
23831 of being deleted. */
23832 if (w
->current_matrix
)
23835 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23836 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23842 /* Call update_window_cursor with parameter ON_P on all leaf windows
23843 in the window tree rooted at W. */
23846 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23850 if (!NILP (w
->hchild
))
23851 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23852 else if (!NILP (w
->vchild
))
23853 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23855 update_window_cursor (w
, on_p
);
23857 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23863 Display the cursor on window W, or clear it, according to ON_P.
23864 Don't change the cursor's position. */
23867 x_update_cursor (struct frame
*f
, int on_p
)
23869 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23874 Clear the cursor of window W to background color, and mark the
23875 cursor as not shown. This is used when the text where the cursor
23876 is about to be rewritten. */
23879 x_clear_cursor (struct window
*w
)
23881 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23882 update_window_cursor (w
, 0);
23885 #endif /* HAVE_WINDOW_SYSTEM */
23887 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23890 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23891 int start_hpos
, int end_hpos
,
23892 enum draw_glyphs_face draw
)
23894 #ifdef HAVE_WINDOW_SYSTEM
23895 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23897 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23901 #if defined (HAVE_GPM) || defined (MSDOS)
23902 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23906 /* Display the active region described by mouse_face_* according to DRAW. */
23909 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23911 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23912 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23914 if (/* If window is in the process of being destroyed, don't bother
23916 w
->current_matrix
!= NULL
23917 /* Don't update mouse highlight if hidden */
23918 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23919 /* Recognize when we are called to operate on rows that don't exist
23920 anymore. This can happen when a window is split. */
23921 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23923 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23924 struct glyph_row
*row
, *first
, *last
;
23926 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23927 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23929 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23931 int start_hpos
, end_hpos
, start_x
;
23933 /* For all but the first row, the highlight starts at column 0. */
23936 /* R2L rows have BEG and END in reversed order, but the
23937 screen drawing geometry is always left to right. So
23938 we need to mirror the beginning and end of the
23939 highlighted area in R2L rows. */
23940 if (!row
->reversed_p
)
23942 start_hpos
= hlinfo
->mouse_face_beg_col
;
23943 start_x
= hlinfo
->mouse_face_beg_x
;
23945 else if (row
== last
)
23947 start_hpos
= hlinfo
->mouse_face_end_col
;
23948 start_x
= hlinfo
->mouse_face_end_x
;
23956 else if (row
->reversed_p
&& row
== last
)
23958 start_hpos
= hlinfo
->mouse_face_end_col
;
23959 start_x
= hlinfo
->mouse_face_end_x
;
23969 if (!row
->reversed_p
)
23970 end_hpos
= hlinfo
->mouse_face_end_col
;
23971 else if (row
== first
)
23972 end_hpos
= hlinfo
->mouse_face_beg_col
;
23975 end_hpos
= row
->used
[TEXT_AREA
];
23976 if (draw
== DRAW_NORMAL_TEXT
)
23977 row
->fill_line_p
= 1; /* Clear to end of line */
23980 else if (row
->reversed_p
&& row
== first
)
23981 end_hpos
= hlinfo
->mouse_face_beg_col
;
23984 end_hpos
= row
->used
[TEXT_AREA
];
23985 if (draw
== DRAW_NORMAL_TEXT
)
23986 row
->fill_line_p
= 1; /* Clear to end of line */
23989 if (end_hpos
> start_hpos
)
23991 draw_row_with_mouse_face (w
, start_x
, row
,
23992 start_hpos
, end_hpos
, draw
);
23995 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23999 #ifdef HAVE_WINDOW_SYSTEM
24000 /* When we've written over the cursor, arrange for it to
24001 be displayed again. */
24002 if (FRAME_WINDOW_P (f
)
24003 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24006 display_and_set_cursor (w
, 1,
24007 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24008 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24011 #endif /* HAVE_WINDOW_SYSTEM */
24014 #ifdef HAVE_WINDOW_SYSTEM
24015 /* Change the mouse cursor. */
24016 if (FRAME_WINDOW_P (f
))
24018 if (draw
== DRAW_NORMAL_TEXT
24019 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24020 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24021 else if (draw
== DRAW_MOUSE_FACE
)
24022 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24024 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24026 #endif /* HAVE_WINDOW_SYSTEM */
24030 Clear out the mouse-highlighted active region.
24031 Redraw it un-highlighted first. Value is non-zero if mouse
24032 face was actually drawn unhighlighted. */
24035 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24039 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24041 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24045 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24046 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24047 hlinfo
->mouse_face_window
= Qnil
;
24048 hlinfo
->mouse_face_overlay
= Qnil
;
24052 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24053 within the mouse face on that window. */
24055 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24057 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24059 /* Quickly resolve the easy cases. */
24060 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24061 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24063 if (vpos
< hlinfo
->mouse_face_beg_row
24064 || vpos
> hlinfo
->mouse_face_end_row
)
24066 if (vpos
> hlinfo
->mouse_face_beg_row
24067 && vpos
< hlinfo
->mouse_face_end_row
)
24070 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24072 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24074 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24077 else if ((vpos
== hlinfo
->mouse_face_beg_row
24078 && hpos
>= hlinfo
->mouse_face_beg_col
)
24079 || (vpos
== hlinfo
->mouse_face_end_row
24080 && hpos
< hlinfo
->mouse_face_end_col
))
24085 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24087 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24090 else if ((vpos
== hlinfo
->mouse_face_beg_row
24091 && hpos
<= hlinfo
->mouse_face_beg_col
)
24092 || (vpos
== hlinfo
->mouse_face_end_row
24093 && hpos
> hlinfo
->mouse_face_end_col
))
24101 Non-zero if physical cursor of window W is within mouse face. */
24104 cursor_in_mouse_face_p (struct window
*w
)
24106 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24111 /* Find the glyph rows START_ROW and END_ROW of window W that display
24112 characters between buffer positions START_CHARPOS and END_CHARPOS
24113 (excluding END_CHARPOS). This is similar to row_containing_pos,
24114 but is more accurate when bidi reordering makes buffer positions
24115 change non-linearly with glyph rows. */
24117 rows_from_pos_range (struct window
*w
,
24118 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24119 struct glyph_row
**start
, struct glyph_row
**end
)
24121 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24122 int last_y
= window_text_bottom_y (w
);
24123 struct glyph_row
*row
;
24128 while (!first
->enabled_p
24129 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24132 /* Find the START row. */
24134 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24137 /* A row can potentially be the START row if the range of the
24138 characters it displays intersects the range
24139 [START_CHARPOS..END_CHARPOS). */
24140 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24141 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24142 /* See the commentary in row_containing_pos, for the
24143 explanation of the complicated way to check whether
24144 some position is beyond the end of the characters
24145 displayed by a row. */
24146 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24147 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24148 && !row
->ends_at_zv_p
24149 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24150 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24151 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24152 && !row
->ends_at_zv_p
24153 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24155 /* Found a candidate row. Now make sure at least one of the
24156 glyphs it displays has a charpos from the range
24157 [START_CHARPOS..END_CHARPOS).
24159 This is not obvious because bidi reordering could make
24160 buffer positions of a row be 1,2,3,102,101,100, and if we
24161 want to highlight characters in [50..60), we don't want
24162 this row, even though [50..60) does intersect [1..103),
24163 the range of character positions given by the row's start
24164 and end positions. */
24165 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24166 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24170 if (BUFFERP (g
->object
)
24171 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24180 /* Find the END row. */
24182 /* If the last row is partially visible, start looking for END
24183 from that row, instead of starting from FIRST. */
24184 && !(row
->enabled_p
24185 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24187 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24189 struct glyph_row
*next
= row
+ 1;
24191 if (!next
->enabled_p
24192 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24193 /* The first row >= START whose range of displayed characters
24194 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24195 is the row END + 1. */
24196 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24197 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24198 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24199 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24200 && !next
->ends_at_zv_p
24201 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24202 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24203 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24204 && !next
->ends_at_zv_p
24205 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24212 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24213 but none of the characters it displays are in the range, it is
24215 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24216 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24220 if (BUFFERP (g
->object
)
24221 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24234 /* This function sets the mouse_face_* elements of HLINFO, assuming
24235 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24236 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24237 for the overlay or run of text properties specifying the mouse
24238 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24239 before-string and after-string that must also be highlighted.
24240 COVER_STRING, if non-nil, is a display string that may cover some
24241 or all of the highlighted text. */
24244 mouse_face_from_buffer_pos (Lisp_Object window
,
24245 Mouse_HLInfo
*hlinfo
,
24246 EMACS_INT mouse_charpos
,
24247 EMACS_INT start_charpos
,
24248 EMACS_INT end_charpos
,
24249 Lisp_Object before_string
,
24250 Lisp_Object after_string
,
24251 Lisp_Object cover_string
)
24253 struct window
*w
= XWINDOW (window
);
24254 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24255 struct glyph_row
*r1
, *r2
;
24256 struct glyph
*glyph
, *end
;
24257 EMACS_INT ignore
, pos
;
24260 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24261 xassert (NILP (before_string
) || STRINGP (before_string
));
24262 xassert (NILP (after_string
) || STRINGP (after_string
));
24264 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24265 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24267 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24268 /* If the before-string or display-string contains newlines,
24269 rows_from_pos_range skips to its last row. Move back. */
24270 if (!NILP (before_string
) || !NILP (cover_string
))
24272 struct glyph_row
*prev
;
24273 while ((prev
= r1
- 1, prev
>= first
)
24274 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24275 && prev
->used
[TEXT_AREA
] > 0)
24277 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24278 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24279 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24281 || !(EQ (glyph
->object
, before_string
)
24282 || EQ (glyph
->object
, cover_string
)))
24289 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24290 hlinfo
->mouse_face_past_end
= 1;
24292 else if (!NILP (after_string
))
24294 /* If the after-string has newlines, advance to its last row. */
24295 struct glyph_row
*next
;
24296 struct glyph_row
*last
24297 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24299 for (next
= r2
+ 1;
24301 && next
->used
[TEXT_AREA
] > 0
24302 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24306 /* The rest of the display engine assumes that mouse_face_beg_row is
24307 either above below mouse_face_end_row or identical to it. But
24308 with bidi-reordered continued lines, the row for START_CHARPOS
24309 could be below the row for END_CHARPOS. If so, swap the rows and
24310 store them in correct order. */
24313 struct glyph_row
*tem
= r2
;
24319 hlinfo
->mouse_face_beg_y
= r1
->y
;
24320 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24321 hlinfo
->mouse_face_end_y
= r2
->y
;
24322 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24324 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24325 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24326 could be anywhere in the row and in any order. The strategy
24327 below is to find the leftmost and the rightmost glyph that
24328 belongs to either of these 3 strings, or whose position is
24329 between START_CHARPOS and END_CHARPOS, and highlight all the
24330 glyphs between those two. This may cover more than just the text
24331 between START_CHARPOS and END_CHARPOS if the range of characters
24332 strides the bidi level boundary, e.g. if the beginning is in R2L
24333 text while the end is in L2R text or vice versa. */
24334 if (!r1
->reversed_p
)
24336 /* This row is in a left to right paragraph. Scan it left to
24338 glyph
= r1
->glyphs
[TEXT_AREA
];
24339 end
= glyph
+ r1
->used
[TEXT_AREA
];
24342 /* Skip truncation glyphs at the start of the glyph row. */
24343 if (r1
->displays_text_p
)
24345 && INTEGERP (glyph
->object
)
24346 && glyph
->charpos
< 0;
24348 x
+= glyph
->pixel_width
;
24350 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24351 or COVER_STRING, and the first glyph from buffer whose
24352 position is between START_CHARPOS and END_CHARPOS. */
24354 && !INTEGERP (glyph
->object
)
24355 && !EQ (glyph
->object
, cover_string
)
24356 && !(BUFFERP (glyph
->object
)
24357 && (glyph
->charpos
>= start_charpos
24358 && glyph
->charpos
< end_charpos
));
24361 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24362 are present at buffer positions between START_CHARPOS and
24363 END_CHARPOS, or if they come from an overlay. */
24364 if (EQ (glyph
->object
, before_string
))
24366 pos
= string_buffer_position (before_string
,
24368 /* If pos == 0, it means before_string came from an
24369 overlay, not from a buffer position. */
24370 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24373 else if (EQ (glyph
->object
, after_string
))
24375 pos
= string_buffer_position (after_string
, end_charpos
);
24376 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24379 x
+= glyph
->pixel_width
;
24381 hlinfo
->mouse_face_beg_x
= x
;
24382 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24386 /* This row is in a right to left paragraph. Scan it right to
24390 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24391 glyph
= end
+ r1
->used
[TEXT_AREA
];
24393 /* Skip truncation glyphs at the start of the glyph row. */
24394 if (r1
->displays_text_p
)
24396 && INTEGERP (glyph
->object
)
24397 && glyph
->charpos
< 0;
24401 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24402 or COVER_STRING, and the first glyph from buffer whose
24403 position is between START_CHARPOS and END_CHARPOS. */
24405 && !INTEGERP (glyph
->object
)
24406 && !EQ (glyph
->object
, cover_string
)
24407 && !(BUFFERP (glyph
->object
)
24408 && (glyph
->charpos
>= start_charpos
24409 && glyph
->charpos
< end_charpos
));
24412 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24413 are present at buffer positions between START_CHARPOS and
24414 END_CHARPOS, or if they come from an overlay. */
24415 if (EQ (glyph
->object
, before_string
))
24417 pos
= string_buffer_position (before_string
, start_charpos
);
24418 /* If pos == 0, it means before_string came from an
24419 overlay, not from a buffer position. */
24420 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24423 else if (EQ (glyph
->object
, after_string
))
24425 pos
= string_buffer_position (after_string
, end_charpos
);
24426 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24431 glyph
++; /* first glyph to the right of the highlighted area */
24432 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24433 x
+= g
->pixel_width
;
24434 hlinfo
->mouse_face_beg_x
= x
;
24435 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24438 /* If the highlight ends in a different row, compute GLYPH and END
24439 for the end row. Otherwise, reuse the values computed above for
24440 the row where the highlight begins. */
24443 if (!r2
->reversed_p
)
24445 glyph
= r2
->glyphs
[TEXT_AREA
];
24446 end
= glyph
+ r2
->used
[TEXT_AREA
];
24451 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24452 glyph
= end
+ r2
->used
[TEXT_AREA
];
24456 if (!r2
->reversed_p
)
24458 /* Skip truncation and continuation glyphs near the end of the
24459 row, and also blanks and stretch glyphs inserted by
24460 extend_face_to_end_of_line. */
24462 && INTEGERP ((end
- 1)->object
)
24463 && (end
- 1)->charpos
<= 0)
24465 /* Scan the rest of the glyph row from the end, looking for the
24466 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24467 COVER_STRING, or whose position is between START_CHARPOS
24471 && !INTEGERP (end
->object
)
24472 && !EQ (end
->object
, cover_string
)
24473 && !(BUFFERP (end
->object
)
24474 && (end
->charpos
>= start_charpos
24475 && end
->charpos
< end_charpos
));
24478 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24479 are present at buffer positions between START_CHARPOS and
24480 END_CHARPOS, or if they come from an overlay. */
24481 if (EQ (end
->object
, before_string
))
24483 pos
= string_buffer_position (before_string
, start_charpos
);
24484 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24487 else if (EQ (end
->object
, after_string
))
24489 pos
= string_buffer_position (after_string
, end_charpos
);
24490 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24494 /* Find the X coordinate of the last glyph to be highlighted. */
24495 for (; glyph
<= end
; ++glyph
)
24496 x
+= glyph
->pixel_width
;
24498 hlinfo
->mouse_face_end_x
= x
;
24499 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24503 /* Skip truncation and continuation glyphs near the end of the
24504 row, and also blanks and stretch glyphs inserted by
24505 extend_face_to_end_of_line. */
24509 && INTEGERP (end
->object
)
24510 && end
->charpos
<= 0)
24512 x
+= end
->pixel_width
;
24515 /* Scan the rest of the glyph row from the end, looking for the
24516 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24517 COVER_STRING, or whose position is between START_CHARPOS
24521 && !INTEGERP (end
->object
)
24522 && !EQ (end
->object
, cover_string
)
24523 && !(BUFFERP (end
->object
)
24524 && (end
->charpos
>= start_charpos
24525 && end
->charpos
< end_charpos
));
24528 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24529 are present at buffer positions between START_CHARPOS and
24530 END_CHARPOS, or if they come from an overlay. */
24531 if (EQ (end
->object
, before_string
))
24533 pos
= string_buffer_position (before_string
, start_charpos
);
24534 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24537 else if (EQ (end
->object
, after_string
))
24539 pos
= string_buffer_position (after_string
, end_charpos
);
24540 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24543 x
+= end
->pixel_width
;
24545 hlinfo
->mouse_face_end_x
= x
;
24546 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24549 hlinfo
->mouse_face_window
= window
;
24550 hlinfo
->mouse_face_face_id
24551 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24553 !hlinfo
->mouse_face_hidden
, -1);
24554 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24557 /* The following function is not used anymore (replaced with
24558 mouse_face_from_string_pos), but I leave it here for the time
24559 being, in case someone would. */
24561 #if 0 /* not used */
24563 /* Find the position of the glyph for position POS in OBJECT in
24564 window W's current matrix, and return in *X, *Y the pixel
24565 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24567 RIGHT_P non-zero means return the position of the right edge of the
24568 glyph, RIGHT_P zero means return the left edge position.
24570 If no glyph for POS exists in the matrix, return the position of
24571 the glyph with the next smaller position that is in the matrix, if
24572 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24573 exists in the matrix, return the position of the glyph with the
24574 next larger position in OBJECT.
24576 Value is non-zero if a glyph was found. */
24579 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24580 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24582 int yb
= window_text_bottom_y (w
);
24583 struct glyph_row
*r
;
24584 struct glyph
*best_glyph
= NULL
;
24585 struct glyph_row
*best_row
= NULL
;
24588 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24589 r
->enabled_p
&& r
->y
< yb
;
24592 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24593 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24596 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24597 if (EQ (g
->object
, object
))
24599 if (g
->charpos
== pos
)
24606 else if (best_glyph
== NULL
24607 || ((eabs (g
->charpos
- pos
)
24608 < eabs (best_glyph
->charpos
- pos
))
24611 : g
->charpos
> pos
)))
24625 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24629 *x
+= best_glyph
->pixel_width
;
24634 *vpos
= best_row
- w
->current_matrix
->rows
;
24637 return best_glyph
!= NULL
;
24639 #endif /* not used */
24641 /* Find the positions of the first and the last glyphs in window W's
24642 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24643 (assumed to be a string), and return in HLINFO's mouse_face_*
24644 members the pixel and column/row coordinates of those glyphs. */
24647 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24648 Lisp_Object object
,
24649 EMACS_INT startpos
, EMACS_INT endpos
)
24651 int yb
= window_text_bottom_y (w
);
24652 struct glyph_row
*r
;
24653 struct glyph
*g
, *e
;
24657 /* Find the glyph row with at least one position in the range
24658 [STARTPOS..ENDPOS], and the first glyph in that row whose
24659 position belongs to that range. */
24660 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24661 r
->enabled_p
&& r
->y
< yb
;
24664 if (!r
->reversed_p
)
24666 g
= r
->glyphs
[TEXT_AREA
];
24667 e
= g
+ r
->used
[TEXT_AREA
];
24668 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24669 if (EQ (g
->object
, object
)
24670 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24672 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24673 hlinfo
->mouse_face_beg_y
= r
->y
;
24674 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24675 hlinfo
->mouse_face_beg_x
= gx
;
24684 e
= r
->glyphs
[TEXT_AREA
];
24685 g
= e
+ r
->used
[TEXT_AREA
];
24686 for ( ; g
> e
; --g
)
24687 if (EQ ((g
-1)->object
, object
)
24688 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24690 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24691 hlinfo
->mouse_face_beg_y
= r
->y
;
24692 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24693 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24694 gx
+= g1
->pixel_width
;
24695 hlinfo
->mouse_face_beg_x
= gx
;
24707 /* Starting with the next row, look for the first row which does NOT
24708 include any glyphs whose positions are in the range. */
24709 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24711 g
= r
->glyphs
[TEXT_AREA
];
24712 e
= g
+ r
->used
[TEXT_AREA
];
24714 for ( ; g
< e
; ++g
)
24715 if (EQ (g
->object
, object
)
24716 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24725 /* The highlighted region ends on the previous row. */
24728 /* Set the end row and its vertical pixel coordinate. */
24729 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24730 hlinfo
->mouse_face_end_y
= r
->y
;
24732 /* Compute and set the end column and the end column's horizontal
24733 pixel coordinate. */
24734 if (!r
->reversed_p
)
24736 g
= r
->glyphs
[TEXT_AREA
];
24737 e
= g
+ r
->used
[TEXT_AREA
];
24738 for ( ; e
> g
; --e
)
24739 if (EQ ((e
-1)->object
, object
)
24740 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24742 hlinfo
->mouse_face_end_col
= e
- g
;
24744 for (gx
= r
->x
; g
< e
; ++g
)
24745 gx
+= g
->pixel_width
;
24746 hlinfo
->mouse_face_end_x
= gx
;
24750 e
= r
->glyphs
[TEXT_AREA
];
24751 g
= e
+ r
->used
[TEXT_AREA
];
24752 for (gx
= r
->x
; e
< g
; ++e
)
24754 if (EQ (e
->object
, object
)
24755 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24757 gx
+= e
->pixel_width
;
24759 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24760 hlinfo
->mouse_face_end_x
= gx
;
24764 #ifdef HAVE_WINDOW_SYSTEM
24766 /* See if position X, Y is within a hot-spot of an image. */
24769 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24771 if (!CONSP (hot_spot
))
24774 if (EQ (XCAR (hot_spot
), Qrect
))
24776 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24777 Lisp_Object rect
= XCDR (hot_spot
);
24781 if (!CONSP (XCAR (rect
)))
24783 if (!CONSP (XCDR (rect
)))
24785 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24787 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24789 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24791 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24795 else if (EQ (XCAR (hot_spot
), Qcircle
))
24797 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24798 Lisp_Object circ
= XCDR (hot_spot
);
24799 Lisp_Object lr
, lx0
, ly0
;
24801 && CONSP (XCAR (circ
))
24802 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24803 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24804 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24806 double r
= XFLOATINT (lr
);
24807 double dx
= XINT (lx0
) - x
;
24808 double dy
= XINT (ly0
) - y
;
24809 return (dx
* dx
+ dy
* dy
<= r
* r
);
24812 else if (EQ (XCAR (hot_spot
), Qpoly
))
24814 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24815 if (VECTORP (XCDR (hot_spot
)))
24817 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24818 Lisp_Object
*poly
= v
->contents
;
24822 Lisp_Object lx
, ly
;
24825 /* Need an even number of coordinates, and at least 3 edges. */
24826 if (n
< 6 || n
& 1)
24829 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24830 If count is odd, we are inside polygon. Pixels on edges
24831 may or may not be included depending on actual geometry of the
24833 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24834 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24836 x0
= XINT (lx
), y0
= XINT (ly
);
24837 for (i
= 0; i
< n
; i
+= 2)
24839 int x1
= x0
, y1
= y0
;
24840 if ((lx
= poly
[i
], !INTEGERP (lx
))
24841 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24843 x0
= XINT (lx
), y0
= XINT (ly
);
24845 /* Does this segment cross the X line? */
24853 if (y
> y0
&& y
> y1
)
24855 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24865 find_hot_spot (Lisp_Object map
, int x
, int y
)
24867 while (CONSP (map
))
24869 if (CONSP (XCAR (map
))
24870 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24878 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24880 doc
: /* Lookup in image map MAP coordinates X and Y.
24881 An image map is an alist where each element has the format (AREA ID PLIST).
24882 An AREA is specified as either a rectangle, a circle, or a polygon:
24883 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24884 pixel coordinates of the upper left and bottom right corners.
24885 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24886 and the radius of the circle; r may be a float or integer.
24887 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24888 vector describes one corner in the polygon.
24889 Returns the alist element for the first matching AREA in MAP. */)
24890 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24898 return find_hot_spot (map
, XINT (x
), XINT (y
));
24902 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24904 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24906 /* Do not change cursor shape while dragging mouse. */
24907 if (!NILP (do_mouse_tracking
))
24910 if (!NILP (pointer
))
24912 if (EQ (pointer
, Qarrow
))
24913 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24914 else if (EQ (pointer
, Qhand
))
24915 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24916 else if (EQ (pointer
, Qtext
))
24917 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24918 else if (EQ (pointer
, intern ("hdrag")))
24919 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24920 #ifdef HAVE_X_WINDOWS
24921 else if (EQ (pointer
, intern ("vdrag")))
24922 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24924 else if (EQ (pointer
, intern ("hourglass")))
24925 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24926 else if (EQ (pointer
, Qmodeline
))
24927 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24929 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24932 if (cursor
!= No_Cursor
)
24933 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24936 #endif /* HAVE_WINDOW_SYSTEM */
24938 /* Take proper action when mouse has moved to the mode or header line
24939 or marginal area AREA of window W, x-position X and y-position Y.
24940 X is relative to the start of the text display area of W, so the
24941 width of bitmap areas and scroll bars must be subtracted to get a
24942 position relative to the start of the mode line. */
24945 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24946 enum window_part area
)
24948 struct window
*w
= XWINDOW (window
);
24949 struct frame
*f
= XFRAME (w
->frame
);
24950 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24951 #ifdef HAVE_WINDOW_SYSTEM
24952 Display_Info
*dpyinfo
;
24954 Cursor cursor
= No_Cursor
;
24955 Lisp_Object pointer
= Qnil
;
24956 int dx
, dy
, width
, height
;
24958 Lisp_Object string
, object
= Qnil
;
24959 Lisp_Object pos
, help
;
24961 Lisp_Object mouse_face
;
24962 int original_x_pixel
= x
;
24963 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24964 struct glyph_row
*row
;
24966 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24971 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24972 returns them in row/column units! */
24973 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24974 &object
, &dx
, &dy
, &width
, &height
);
24976 row
= (area
== ON_MODE_LINE
24977 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24978 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24980 /* Find the glyph under the mouse pointer. */
24981 if (row
->mode_line_p
&& row
->enabled_p
)
24983 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24984 end
= glyph
+ row
->used
[TEXT_AREA
];
24986 for (x0
= original_x_pixel
;
24987 glyph
< end
&& x0
>= glyph
->pixel_width
;
24989 x0
-= glyph
->pixel_width
;
24997 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24998 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24999 returns them in row/column units! */
25000 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25001 &object
, &dx
, &dy
, &width
, &height
);
25006 #ifdef HAVE_WINDOW_SYSTEM
25007 if (IMAGEP (object
))
25009 Lisp_Object image_map
, hotspot
;
25010 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25012 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25014 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25018 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25019 If so, we could look for mouse-enter, mouse-leave
25020 properties in PLIST (and do something...). */
25021 hotspot
= XCDR (hotspot
);
25022 if (CONSP (hotspot
)
25023 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25025 pointer
= Fplist_get (plist
, Qpointer
);
25026 if (NILP (pointer
))
25028 help
= Fplist_get (plist
, Qhelp_echo
);
25031 help_echo_string
= help
;
25032 /* Is this correct? ++kfs */
25033 XSETWINDOW (help_echo_window
, w
);
25034 help_echo_object
= w
->buffer
;
25035 help_echo_pos
= charpos
;
25039 if (NILP (pointer
))
25040 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25042 #endif /* HAVE_WINDOW_SYSTEM */
25044 if (STRINGP (string
))
25046 pos
= make_number (charpos
);
25047 /* If we're on a string with `help-echo' text property, arrange
25048 for the help to be displayed. This is done by setting the
25049 global variable help_echo_string to the help string. */
25052 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25055 help_echo_string
= help
;
25056 XSETWINDOW (help_echo_window
, w
);
25057 help_echo_object
= string
;
25058 help_echo_pos
= charpos
;
25062 #ifdef HAVE_WINDOW_SYSTEM
25063 if (FRAME_WINDOW_P (f
))
25065 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25066 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25067 if (NILP (pointer
))
25068 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25070 /* Change the mouse pointer according to what is under X/Y. */
25072 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25075 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25076 if (!KEYMAPP (map
))
25077 map
= Fget_text_property (pos
, Qkeymap
, string
);
25078 if (!KEYMAPP (map
))
25079 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25084 /* Change the mouse face according to what is under X/Y. */
25085 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25086 if (!NILP (mouse_face
)
25087 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25092 struct glyph
* tmp_glyph
;
25096 int total_pixel_width
;
25097 EMACS_INT begpos
, endpos
, ignore
;
25101 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25102 Qmouse_face
, string
, Qnil
);
25108 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25110 endpos
= SCHARS (string
);
25114 /* Calculate the glyph position GPOS of GLYPH in the
25115 displayed string, relative to the beginning of the
25116 highlighted part of the string.
25118 Note: GPOS is different from CHARPOS. CHARPOS is the
25119 position of GLYPH in the internal string object. A mode
25120 line string format has structures which are converted to
25121 a flattened string by the Emacs Lisp interpreter. The
25122 internal string is an element of those structures. The
25123 displayed string is the flattened string. */
25124 tmp_glyph
= row_start_glyph
;
25125 while (tmp_glyph
< glyph
25126 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25127 && begpos
<= tmp_glyph
->charpos
25128 && tmp_glyph
->charpos
< endpos
)))
25130 gpos
= glyph
- tmp_glyph
;
25132 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25133 the highlighted part of the displayed string to which
25134 GLYPH belongs. Note: GSEQ_LENGTH is different from
25135 SCHARS (STRING), because the latter returns the length of
25136 the internal string. */
25137 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25139 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25140 && begpos
<= tmp_glyph
->charpos
25141 && tmp_glyph
->charpos
< endpos
));
25144 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25146 /* Calculate the total pixel width of all the glyphs between
25147 the beginning of the highlighted area and GLYPH. */
25148 total_pixel_width
= 0;
25149 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25150 total_pixel_width
+= tmp_glyph
->pixel_width
;
25152 /* Pre calculation of re-rendering position. Note: X is in
25153 column units here, after the call to mode_line_string or
25154 marginal_area_string. */
25156 vpos
= (area
== ON_MODE_LINE
25157 ? (w
->current_matrix
)->nrows
- 1
25160 /* If GLYPH's position is included in the region that is
25161 already drawn in mouse face, we have nothing to do. */
25162 if ( EQ (window
, hlinfo
->mouse_face_window
)
25163 && (!row
->reversed_p
25164 ? (hlinfo
->mouse_face_beg_col
<= hpos
25165 && hpos
< hlinfo
->mouse_face_end_col
)
25166 /* In R2L rows we swap BEG and END, see below. */
25167 : (hlinfo
->mouse_face_end_col
<= hpos
25168 && hpos
< hlinfo
->mouse_face_beg_col
))
25169 && hlinfo
->mouse_face_beg_row
== vpos
)
25172 if (clear_mouse_face (hlinfo
))
25173 cursor
= No_Cursor
;
25175 if (!row
->reversed_p
)
25177 hlinfo
->mouse_face_beg_col
= hpos
;
25178 hlinfo
->mouse_face_beg_x
= original_x_pixel
25179 - (total_pixel_width
+ dx
);
25180 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25181 hlinfo
->mouse_face_end_x
= 0;
25185 /* In R2L rows, show_mouse_face expects BEG and END
25186 coordinates to be swapped. */
25187 hlinfo
->mouse_face_end_col
= hpos
;
25188 hlinfo
->mouse_face_end_x
= original_x_pixel
25189 - (total_pixel_width
+ dx
);
25190 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25191 hlinfo
->mouse_face_beg_x
= 0;
25194 hlinfo
->mouse_face_beg_row
= vpos
;
25195 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25196 hlinfo
->mouse_face_beg_y
= 0;
25197 hlinfo
->mouse_face_end_y
= 0;
25198 hlinfo
->mouse_face_past_end
= 0;
25199 hlinfo
->mouse_face_window
= window
;
25201 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25207 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25209 if (NILP (pointer
))
25212 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25213 clear_mouse_face (hlinfo
);
25215 #ifdef HAVE_WINDOW_SYSTEM
25216 if (FRAME_WINDOW_P (f
))
25217 define_frame_cursor1 (f
, cursor
, pointer
);
25223 Take proper action when the mouse has moved to position X, Y on
25224 frame F as regards highlighting characters that have mouse-face
25225 properties. Also de-highlighting chars where the mouse was before.
25226 X and Y can be negative or out of range. */
25229 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25231 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25232 enum window_part part
;
25233 Lisp_Object window
;
25235 Cursor cursor
= No_Cursor
;
25236 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25239 /* When a menu is active, don't highlight because this looks odd. */
25240 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25241 if (popup_activated ())
25245 if (NILP (Vmouse_highlight
)
25246 || !f
->glyphs_initialized_p
25247 || f
->pointer_invisible
)
25250 hlinfo
->mouse_face_mouse_x
= x
;
25251 hlinfo
->mouse_face_mouse_y
= y
;
25252 hlinfo
->mouse_face_mouse_frame
= f
;
25254 if (hlinfo
->mouse_face_defer
)
25257 if (gc_in_progress
)
25259 hlinfo
->mouse_face_deferred_gc
= 1;
25263 /* Which window is that in? */
25264 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25266 /* If we were displaying active text in another window, clear that.
25267 Also clear if we move out of text area in same window. */
25268 if (! EQ (window
, hlinfo
->mouse_face_window
)
25269 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25270 && !NILP (hlinfo
->mouse_face_window
)))
25271 clear_mouse_face (hlinfo
);
25273 /* Not on a window -> return. */
25274 if (!WINDOWP (window
))
25277 /* Reset help_echo_string. It will get recomputed below. */
25278 help_echo_string
= Qnil
;
25280 /* Convert to window-relative pixel coordinates. */
25281 w
= XWINDOW (window
);
25282 frame_to_window_pixel_xy (w
, &x
, &y
);
25284 #ifdef HAVE_WINDOW_SYSTEM
25285 /* Handle tool-bar window differently since it doesn't display a
25287 if (EQ (window
, f
->tool_bar_window
))
25289 note_tool_bar_highlight (f
, x
, y
);
25294 /* Mouse is on the mode, header line or margin? */
25295 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25296 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25298 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25302 #ifdef HAVE_WINDOW_SYSTEM
25303 if (part
== ON_VERTICAL_BORDER
)
25305 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25306 help_echo_string
= build_string ("drag-mouse-1: resize");
25308 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25309 || part
== ON_SCROLL_BAR
)
25310 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25312 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25315 /* Are we in a window whose display is up to date?
25316 And verify the buffer's text has not changed. */
25317 b
= XBUFFER (w
->buffer
);
25318 if (part
== ON_TEXT
25319 && EQ (w
->window_end_valid
, w
->buffer
)
25320 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25321 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25323 int hpos
, vpos
, i
, dx
, dy
, area
;
25325 struct glyph
*glyph
;
25326 Lisp_Object object
;
25327 Lisp_Object mouse_face
= Qnil
, position
;
25328 Lisp_Object
*overlay_vec
= NULL
;
25330 struct buffer
*obuf
;
25331 EMACS_INT obegv
, ozv
;
25334 /* Find the glyph under X/Y. */
25335 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25337 #ifdef HAVE_WINDOW_SYSTEM
25338 /* Look for :pointer property on image. */
25339 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25341 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25342 if (img
!= NULL
&& IMAGEP (img
->spec
))
25344 Lisp_Object image_map
, hotspot
;
25345 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25347 && (hotspot
= find_hot_spot (image_map
,
25348 glyph
->slice
.img
.x
+ dx
,
25349 glyph
->slice
.img
.y
+ dy
),
25351 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25355 /* Could check XCAR (hotspot) to see if we enter/leave
25357 If so, we could look for mouse-enter, mouse-leave
25358 properties in PLIST (and do something...). */
25359 hotspot
= XCDR (hotspot
);
25360 if (CONSP (hotspot
)
25361 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25363 pointer
= Fplist_get (plist
, Qpointer
);
25364 if (NILP (pointer
))
25366 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25367 if (!NILP (help_echo_string
))
25369 help_echo_window
= window
;
25370 help_echo_object
= glyph
->object
;
25371 help_echo_pos
= glyph
->charpos
;
25375 if (NILP (pointer
))
25376 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25379 #endif /* HAVE_WINDOW_SYSTEM */
25381 /* Clear mouse face if X/Y not over text. */
25383 || area
!= TEXT_AREA
25384 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25385 /* Glyph's OBJECT is an integer for glyphs inserted by the
25386 display engine for its internal purposes, like truncation
25387 and continuation glyphs and blanks beyond the end of
25388 line's text on text terminals. If we are over such a
25389 glyph, we are not over any text. */
25390 || INTEGERP (glyph
->object
)
25391 /* R2L rows have a stretch glyph at their front, which
25392 stands for no text, whereas L2R rows have no glyphs at
25393 all beyond the end of text. Treat such stretch glyphs
25394 like we do with NULL glyphs in L2R rows. */
25395 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25396 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25397 && glyph
->type
== STRETCH_GLYPH
25398 && glyph
->avoid_cursor_p
))
25400 if (clear_mouse_face (hlinfo
))
25401 cursor
= No_Cursor
;
25402 #ifdef HAVE_WINDOW_SYSTEM
25403 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25405 if (area
!= TEXT_AREA
)
25406 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25408 pointer
= Vvoid_text_area_pointer
;
25414 pos
= glyph
->charpos
;
25415 object
= glyph
->object
;
25416 if (!STRINGP (object
) && !BUFFERP (object
))
25419 /* If we get an out-of-range value, return now; avoid an error. */
25420 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25423 /* Make the window's buffer temporarily current for
25424 overlays_at and compute_char_face. */
25425 obuf
= current_buffer
;
25426 current_buffer
= b
;
25432 /* Is this char mouse-active or does it have help-echo? */
25433 position
= make_number (pos
);
25435 if (BUFFERP (object
))
25437 /* Put all the overlays we want in a vector in overlay_vec. */
25438 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25439 /* Sort overlays into increasing priority order. */
25440 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25445 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25448 cursor
= No_Cursor
;
25450 /* Check mouse-face highlighting. */
25452 /* If there exists an overlay with mouse-face overlapping
25453 the one we are currently highlighting, we have to
25454 check if we enter the overlapping overlay, and then
25455 highlight only that. */
25456 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25457 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25459 /* Find the highest priority overlay with a mouse-face. */
25460 Lisp_Object overlay
= Qnil
;
25461 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25463 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25464 if (!NILP (mouse_face
))
25465 overlay
= overlay_vec
[i
];
25468 /* If we're highlighting the same overlay as before, there's
25469 no need to do that again. */
25470 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25471 goto check_help_echo
;
25472 hlinfo
->mouse_face_overlay
= overlay
;
25474 /* Clear the display of the old active region, if any. */
25475 if (clear_mouse_face (hlinfo
))
25476 cursor
= No_Cursor
;
25478 /* If no overlay applies, get a text property. */
25479 if (NILP (overlay
))
25480 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25482 /* Next, compute the bounds of the mouse highlighting and
25484 if (!NILP (mouse_face
) && STRINGP (object
))
25486 /* The mouse-highlighting comes from a display string
25487 with a mouse-face. */
25491 s
= Fprevious_single_property_change
25492 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25493 e
= Fnext_single_property_change
25494 (position
, Qmouse_face
, object
, Qnil
);
25496 s
= make_number (0);
25498 e
= make_number (SCHARS (object
) - 1);
25499 mouse_face_from_string_pos (w
, hlinfo
, object
,
25500 XINT (s
), XINT (e
));
25501 hlinfo
->mouse_face_past_end
= 0;
25502 hlinfo
->mouse_face_window
= window
;
25503 hlinfo
->mouse_face_face_id
25504 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25505 glyph
->face_id
, 1);
25506 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25507 cursor
= No_Cursor
;
25511 /* The mouse-highlighting, if any, comes from an overlay
25512 or text property in the buffer. */
25513 Lisp_Object buffer
IF_LINT (= Qnil
);
25514 Lisp_Object cover_string
IF_LINT (= Qnil
);
25516 if (STRINGP (object
))
25518 /* If we are on a display string with no mouse-face,
25519 check if the text under it has one. */
25520 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25521 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25522 pos
= string_buffer_position (object
, start
);
25525 mouse_face
= get_char_property_and_overlay
25526 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25527 buffer
= w
->buffer
;
25528 cover_string
= object
;
25534 cover_string
= Qnil
;
25537 if (!NILP (mouse_face
))
25539 Lisp_Object before
, after
;
25540 Lisp_Object before_string
, after_string
;
25541 /* To correctly find the limits of mouse highlight
25542 in a bidi-reordered buffer, we must not use the
25543 optimization of limiting the search in
25544 previous-single-property-change and
25545 next-single-property-change, because
25546 rows_from_pos_range needs the real start and end
25547 positions to DTRT in this case. That's because
25548 the first row visible in a window does not
25549 necessarily display the character whose position
25550 is the smallest. */
25552 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25553 ? Fmarker_position (w
->start
)
25556 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25557 ? make_number (BUF_Z (XBUFFER (buffer
))
25558 - XFASTINT (w
->window_end_pos
))
25561 if (NILP (overlay
))
25563 /* Handle the text property case. */
25564 before
= Fprevious_single_property_change
25565 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25566 after
= Fnext_single_property_change
25567 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25568 before_string
= after_string
= Qnil
;
25572 /* Handle the overlay case. */
25573 before
= Foverlay_start (overlay
);
25574 after
= Foverlay_end (overlay
);
25575 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25576 after_string
= Foverlay_get (overlay
, Qafter_string
);
25578 if (!STRINGP (before_string
)) before_string
= Qnil
;
25579 if (!STRINGP (after_string
)) after_string
= Qnil
;
25582 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25585 before_string
, after_string
,
25587 cursor
= No_Cursor
;
25594 /* Look for a `help-echo' property. */
25595 if (NILP (help_echo_string
)) {
25596 Lisp_Object help
, overlay
;
25598 /* Check overlays first. */
25599 help
= overlay
= Qnil
;
25600 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25602 overlay
= overlay_vec
[i
];
25603 help
= Foverlay_get (overlay
, Qhelp_echo
);
25608 help_echo_string
= help
;
25609 help_echo_window
= window
;
25610 help_echo_object
= overlay
;
25611 help_echo_pos
= pos
;
25615 Lisp_Object obj
= glyph
->object
;
25616 EMACS_INT charpos
= glyph
->charpos
;
25618 /* Try text properties. */
25621 && charpos
< SCHARS (obj
))
25623 help
= Fget_text_property (make_number (charpos
),
25627 /* If the string itself doesn't specify a help-echo,
25628 see if the buffer text ``under'' it does. */
25629 struct glyph_row
*r
25630 = MATRIX_ROW (w
->current_matrix
, vpos
);
25631 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25632 EMACS_INT p
= string_buffer_position (obj
, start
);
25635 help
= Fget_char_property (make_number (p
),
25636 Qhelp_echo
, w
->buffer
);
25645 else if (BUFFERP (obj
)
25648 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25653 help_echo_string
= help
;
25654 help_echo_window
= window
;
25655 help_echo_object
= obj
;
25656 help_echo_pos
= charpos
;
25661 #ifdef HAVE_WINDOW_SYSTEM
25662 /* Look for a `pointer' property. */
25663 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25665 /* Check overlays first. */
25666 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25667 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25669 if (NILP (pointer
))
25671 Lisp_Object obj
= glyph
->object
;
25672 EMACS_INT charpos
= glyph
->charpos
;
25674 /* Try text properties. */
25677 && charpos
< SCHARS (obj
))
25679 pointer
= Fget_text_property (make_number (charpos
),
25681 if (NILP (pointer
))
25683 /* If the string itself doesn't specify a pointer,
25684 see if the buffer text ``under'' it does. */
25685 struct glyph_row
*r
25686 = MATRIX_ROW (w
->current_matrix
, vpos
);
25687 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25688 EMACS_INT p
= string_buffer_position (obj
, start
);
25690 pointer
= Fget_char_property (make_number (p
),
25691 Qpointer
, w
->buffer
);
25694 else if (BUFFERP (obj
)
25697 pointer
= Fget_text_property (make_number (charpos
),
25701 #endif /* HAVE_WINDOW_SYSTEM */
25705 current_buffer
= obuf
;
25710 #ifdef HAVE_WINDOW_SYSTEM
25711 if (FRAME_WINDOW_P (f
))
25712 define_frame_cursor1 (f
, cursor
, pointer
);
25714 /* This is here to prevent a compiler error, about "label at end of
25715 compound statement". */
25722 Clear any mouse-face on window W. This function is part of the
25723 redisplay interface, and is called from try_window_id and similar
25724 functions to ensure the mouse-highlight is off. */
25727 x_clear_window_mouse_face (struct window
*w
)
25729 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25730 Lisp_Object window
;
25733 XSETWINDOW (window
, w
);
25734 if (EQ (window
, hlinfo
->mouse_face_window
))
25735 clear_mouse_face (hlinfo
);
25741 Just discard the mouse face information for frame F, if any.
25742 This is used when the size of F is changed. */
25745 cancel_mouse_face (struct frame
*f
)
25747 Lisp_Object window
;
25748 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25750 window
= hlinfo
->mouse_face_window
;
25751 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25753 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25754 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25755 hlinfo
->mouse_face_window
= Qnil
;
25761 /***********************************************************************
25763 ***********************************************************************/
25765 #ifdef HAVE_WINDOW_SYSTEM
25767 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25768 which intersects rectangle R. R is in window-relative coordinates. */
25771 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25772 enum glyph_row_area area
)
25774 struct glyph
*first
= row
->glyphs
[area
];
25775 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25776 struct glyph
*last
;
25777 int first_x
, start_x
, x
;
25779 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25780 /* If row extends face to end of line write the whole line. */
25781 draw_glyphs (w
, 0, row
, area
,
25782 0, row
->used
[area
],
25783 DRAW_NORMAL_TEXT
, 0);
25786 /* Set START_X to the window-relative start position for drawing glyphs of
25787 AREA. The first glyph of the text area can be partially visible.
25788 The first glyphs of other areas cannot. */
25789 start_x
= window_box_left_offset (w
, area
);
25791 if (area
== TEXT_AREA
)
25794 /* Find the first glyph that must be redrawn. */
25796 && x
+ first
->pixel_width
< r
->x
)
25798 x
+= first
->pixel_width
;
25802 /* Find the last one. */
25806 && x
< r
->x
+ r
->width
)
25808 x
+= last
->pixel_width
;
25814 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25815 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25816 DRAW_NORMAL_TEXT
, 0);
25821 /* Redraw the parts of the glyph row ROW on window W intersecting
25822 rectangle R. R is in window-relative coordinates. Value is
25823 non-zero if mouse-face was overwritten. */
25826 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25828 xassert (row
->enabled_p
);
25830 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25831 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25832 0, row
->used
[TEXT_AREA
],
25833 DRAW_NORMAL_TEXT
, 0);
25836 if (row
->used
[LEFT_MARGIN_AREA
])
25837 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25838 if (row
->used
[TEXT_AREA
])
25839 expose_area (w
, row
, r
, TEXT_AREA
);
25840 if (row
->used
[RIGHT_MARGIN_AREA
])
25841 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25842 draw_row_fringe_bitmaps (w
, row
);
25845 return row
->mouse_face_p
;
25849 /* Redraw those parts of glyphs rows during expose event handling that
25850 overlap other rows. Redrawing of an exposed line writes over parts
25851 of lines overlapping that exposed line; this function fixes that.
25853 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25854 row in W's current matrix that is exposed and overlaps other rows.
25855 LAST_OVERLAPPING_ROW is the last such row. */
25858 expose_overlaps (struct window
*w
,
25859 struct glyph_row
*first_overlapping_row
,
25860 struct glyph_row
*last_overlapping_row
,
25863 struct glyph_row
*row
;
25865 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25866 if (row
->overlapping_p
)
25868 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25871 if (row
->used
[LEFT_MARGIN_AREA
])
25872 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25874 if (row
->used
[TEXT_AREA
])
25875 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25877 if (row
->used
[RIGHT_MARGIN_AREA
])
25878 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25884 /* Return non-zero if W's cursor intersects rectangle R. */
25887 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25889 XRectangle cr
, result
;
25890 struct glyph
*cursor_glyph
;
25891 struct glyph_row
*row
;
25893 if (w
->phys_cursor
.vpos
>= 0
25894 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25895 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25897 && row
->cursor_in_fringe_p
)
25899 /* Cursor is in the fringe. */
25900 cr
.x
= window_box_right_offset (w
,
25901 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25902 ? RIGHT_MARGIN_AREA
25905 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25906 cr
.height
= row
->height
;
25907 return x_intersect_rectangles (&cr
, r
, &result
);
25910 cursor_glyph
= get_phys_cursor_glyph (w
);
25913 /* r is relative to W's box, but w->phys_cursor.x is relative
25914 to left edge of W's TEXT area. Adjust it. */
25915 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25916 cr
.y
= w
->phys_cursor
.y
;
25917 cr
.width
= cursor_glyph
->pixel_width
;
25918 cr
.height
= w
->phys_cursor_height
;
25919 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25920 I assume the effect is the same -- and this is portable. */
25921 return x_intersect_rectangles (&cr
, r
, &result
);
25923 /* If we don't understand the format, pretend we're not in the hot-spot. */
25929 Draw a vertical window border to the right of window W if W doesn't
25930 have vertical scroll bars. */
25933 x_draw_vertical_border (struct window
*w
)
25935 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25937 /* We could do better, if we knew what type of scroll-bar the adjacent
25938 windows (on either side) have... But we don't :-(
25939 However, I think this works ok. ++KFS 2003-04-25 */
25941 /* Redraw borders between horizontally adjacent windows. Don't
25942 do it for frames with vertical scroll bars because either the
25943 right scroll bar of a window, or the left scroll bar of its
25944 neighbor will suffice as a border. */
25945 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25948 if (!WINDOW_RIGHTMOST_P (w
)
25949 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25951 int x0
, x1
, y0
, y1
;
25953 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25956 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25959 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25961 else if (!WINDOW_LEFTMOST_P (w
)
25962 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25964 int x0
, x1
, y0
, y1
;
25966 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25969 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25972 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25977 /* Redraw the part of window W intersection rectangle FR. Pixel
25978 coordinates in FR are frame-relative. Call this function with
25979 input blocked. Value is non-zero if the exposure overwrites
25983 expose_window (struct window
*w
, XRectangle
*fr
)
25985 struct frame
*f
= XFRAME (w
->frame
);
25987 int mouse_face_overwritten_p
= 0;
25989 /* If window is not yet fully initialized, do nothing. This can
25990 happen when toolkit scroll bars are used and a window is split.
25991 Reconfiguring the scroll bar will generate an expose for a newly
25993 if (w
->current_matrix
== NULL
)
25996 /* When we're currently updating the window, display and current
25997 matrix usually don't agree. Arrange for a thorough display
25999 if (w
== updated_window
)
26001 SET_FRAME_GARBAGED (f
);
26005 /* Frame-relative pixel rectangle of W. */
26006 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26007 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26008 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26009 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26011 if (x_intersect_rectangles (fr
, &wr
, &r
))
26013 int yb
= window_text_bottom_y (w
);
26014 struct glyph_row
*row
;
26015 int cursor_cleared_p
;
26016 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26018 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26019 r
.x
, r
.y
, r
.width
, r
.height
));
26021 /* Convert to window coordinates. */
26022 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26023 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26025 /* Turn off the cursor. */
26026 if (!w
->pseudo_window_p
26027 && phys_cursor_in_rect_p (w
, &r
))
26029 x_clear_cursor (w
);
26030 cursor_cleared_p
= 1;
26033 cursor_cleared_p
= 0;
26035 /* Update lines intersecting rectangle R. */
26036 first_overlapping_row
= last_overlapping_row
= NULL
;
26037 for (row
= w
->current_matrix
->rows
;
26042 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26044 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26045 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26046 || (r
.y
>= y0
&& r
.y
< y1
)
26047 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26049 /* A header line may be overlapping, but there is no need
26050 to fix overlapping areas for them. KFS 2005-02-12 */
26051 if (row
->overlapping_p
&& !row
->mode_line_p
)
26053 if (first_overlapping_row
== NULL
)
26054 first_overlapping_row
= row
;
26055 last_overlapping_row
= row
;
26059 if (expose_line (w
, row
, &r
))
26060 mouse_face_overwritten_p
= 1;
26063 else if (row
->overlapping_p
)
26065 /* We must redraw a row overlapping the exposed area. */
26067 ? y0
+ row
->phys_height
> r
.y
26068 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26070 if (first_overlapping_row
== NULL
)
26071 first_overlapping_row
= row
;
26072 last_overlapping_row
= row
;
26080 /* Display the mode line if there is one. */
26081 if (WINDOW_WANTS_MODELINE_P (w
)
26082 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26084 && row
->y
< r
.y
+ r
.height
)
26086 if (expose_line (w
, row
, &r
))
26087 mouse_face_overwritten_p
= 1;
26090 if (!w
->pseudo_window_p
)
26092 /* Fix the display of overlapping rows. */
26093 if (first_overlapping_row
)
26094 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26097 /* Draw border between windows. */
26098 x_draw_vertical_border (w
);
26100 /* Turn the cursor on again. */
26101 if (cursor_cleared_p
)
26102 update_window_cursor (w
, 1);
26106 return mouse_face_overwritten_p
;
26111 /* Redraw (parts) of all windows in the window tree rooted at W that
26112 intersect R. R contains frame pixel coordinates. Value is
26113 non-zero if the exposure overwrites mouse-face. */
26116 expose_window_tree (struct window
*w
, XRectangle
*r
)
26118 struct frame
*f
= XFRAME (w
->frame
);
26119 int mouse_face_overwritten_p
= 0;
26121 while (w
&& !FRAME_GARBAGED_P (f
))
26123 if (!NILP (w
->hchild
))
26124 mouse_face_overwritten_p
26125 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26126 else if (!NILP (w
->vchild
))
26127 mouse_face_overwritten_p
26128 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26130 mouse_face_overwritten_p
|= expose_window (w
, r
);
26132 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26135 return mouse_face_overwritten_p
;
26140 Redisplay an exposed area of frame F. X and Y are the upper-left
26141 corner of the exposed rectangle. W and H are width and height of
26142 the exposed area. All are pixel values. W or H zero means redraw
26143 the entire frame. */
26146 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26149 int mouse_face_overwritten_p
= 0;
26151 TRACE ((stderr
, "expose_frame "));
26153 /* No need to redraw if frame will be redrawn soon. */
26154 if (FRAME_GARBAGED_P (f
))
26156 TRACE ((stderr
, " garbaged\n"));
26160 /* If basic faces haven't been realized yet, there is no point in
26161 trying to redraw anything. This can happen when we get an expose
26162 event while Emacs is starting, e.g. by moving another window. */
26163 if (FRAME_FACE_CACHE (f
) == NULL
26164 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26166 TRACE ((stderr
, " no faces\n"));
26170 if (w
== 0 || h
== 0)
26173 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26174 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26184 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26185 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26187 if (WINDOWP (f
->tool_bar_window
))
26188 mouse_face_overwritten_p
26189 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26191 #ifdef HAVE_X_WINDOWS
26193 #ifndef USE_X_TOOLKIT
26194 if (WINDOWP (f
->menu_bar_window
))
26195 mouse_face_overwritten_p
26196 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26197 #endif /* not USE_X_TOOLKIT */
26201 /* Some window managers support a focus-follows-mouse style with
26202 delayed raising of frames. Imagine a partially obscured frame,
26203 and moving the mouse into partially obscured mouse-face on that
26204 frame. The visible part of the mouse-face will be highlighted,
26205 then the WM raises the obscured frame. With at least one WM, KDE
26206 2.1, Emacs is not getting any event for the raising of the frame
26207 (even tried with SubstructureRedirectMask), only Expose events.
26208 These expose events will draw text normally, i.e. not
26209 highlighted. Which means we must redo the highlight here.
26210 Subsume it under ``we love X''. --gerd 2001-08-15 */
26211 /* Included in Windows version because Windows most likely does not
26212 do the right thing if any third party tool offers
26213 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26214 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26216 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26217 if (f
== hlinfo
->mouse_face_mouse_frame
)
26219 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26220 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26221 clear_mouse_face (hlinfo
);
26222 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26229 Determine the intersection of two rectangles R1 and R2. Return
26230 the intersection in *RESULT. Value is non-zero if RESULT is not
26234 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26236 XRectangle
*left
, *right
;
26237 XRectangle
*upper
, *lower
;
26238 int intersection_p
= 0;
26240 /* Rearrange so that R1 is the left-most rectangle. */
26242 left
= r1
, right
= r2
;
26244 left
= r2
, right
= r1
;
26246 /* X0 of the intersection is right.x0, if this is inside R1,
26247 otherwise there is no intersection. */
26248 if (right
->x
<= left
->x
+ left
->width
)
26250 result
->x
= right
->x
;
26252 /* The right end of the intersection is the minimum of the
26253 the right ends of left and right. */
26254 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26257 /* Same game for Y. */
26259 upper
= r1
, lower
= r2
;
26261 upper
= r2
, lower
= r1
;
26263 /* The upper end of the intersection is lower.y0, if this is inside
26264 of upper. Otherwise, there is no intersection. */
26265 if (lower
->y
<= upper
->y
+ upper
->height
)
26267 result
->y
= lower
->y
;
26269 /* The lower end of the intersection is the minimum of the lower
26270 ends of upper and lower. */
26271 result
->height
= (min (lower
->y
+ lower
->height
,
26272 upper
->y
+ upper
->height
)
26274 intersection_p
= 1;
26278 return intersection_p
;
26281 #endif /* HAVE_WINDOW_SYSTEM */
26284 /***********************************************************************
26286 ***********************************************************************/
26289 syms_of_xdisp (void)
26291 Vwith_echo_area_save_vector
= Qnil
;
26292 staticpro (&Vwith_echo_area_save_vector
);
26294 Vmessage_stack
= Qnil
;
26295 staticpro (&Vmessage_stack
);
26297 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26298 staticpro (&Qinhibit_redisplay
);
26300 message_dolog_marker1
= Fmake_marker ();
26301 staticpro (&message_dolog_marker1
);
26302 message_dolog_marker2
= Fmake_marker ();
26303 staticpro (&message_dolog_marker2
);
26304 message_dolog_marker3
= Fmake_marker ();
26305 staticpro (&message_dolog_marker3
);
26308 defsubr (&Sdump_frame_glyph_matrix
);
26309 defsubr (&Sdump_glyph_matrix
);
26310 defsubr (&Sdump_glyph_row
);
26311 defsubr (&Sdump_tool_bar_row
);
26312 defsubr (&Strace_redisplay
);
26313 defsubr (&Strace_to_stderr
);
26315 #ifdef HAVE_WINDOW_SYSTEM
26316 defsubr (&Stool_bar_lines_needed
);
26317 defsubr (&Slookup_image_map
);
26319 defsubr (&Sformat_mode_line
);
26320 defsubr (&Sinvisible_p
);
26321 defsubr (&Scurrent_bidi_paragraph_direction
);
26323 staticpro (&Qmenu_bar_update_hook
);
26324 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26326 staticpro (&Qoverriding_terminal_local_map
);
26327 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26329 staticpro (&Qoverriding_local_map
);
26330 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26332 staticpro (&Qwindow_scroll_functions
);
26333 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26335 staticpro (&Qwindow_text_change_functions
);
26336 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26338 staticpro (&Qredisplay_end_trigger_functions
);
26339 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26341 staticpro (&Qinhibit_point_motion_hooks
);
26342 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26344 Qeval
= intern_c_string ("eval");
26345 staticpro (&Qeval
);
26347 QCdata
= intern_c_string (":data");
26348 staticpro (&QCdata
);
26349 Qdisplay
= intern_c_string ("display");
26350 staticpro (&Qdisplay
);
26351 Qspace_width
= intern_c_string ("space-width");
26352 staticpro (&Qspace_width
);
26353 Qraise
= intern_c_string ("raise");
26354 staticpro (&Qraise
);
26355 Qslice
= intern_c_string ("slice");
26356 staticpro (&Qslice
);
26357 Qspace
= intern_c_string ("space");
26358 staticpro (&Qspace
);
26359 Qmargin
= intern_c_string ("margin");
26360 staticpro (&Qmargin
);
26361 Qpointer
= intern_c_string ("pointer");
26362 staticpro (&Qpointer
);
26363 Qleft_margin
= intern_c_string ("left-margin");
26364 staticpro (&Qleft_margin
);
26365 Qright_margin
= intern_c_string ("right-margin");
26366 staticpro (&Qright_margin
);
26367 Qcenter
= intern_c_string ("center");
26368 staticpro (&Qcenter
);
26369 Qline_height
= intern_c_string ("line-height");
26370 staticpro (&Qline_height
);
26371 QCalign_to
= intern_c_string (":align-to");
26372 staticpro (&QCalign_to
);
26373 QCrelative_width
= intern_c_string (":relative-width");
26374 staticpro (&QCrelative_width
);
26375 QCrelative_height
= intern_c_string (":relative-height");
26376 staticpro (&QCrelative_height
);
26377 QCeval
= intern_c_string (":eval");
26378 staticpro (&QCeval
);
26379 QCpropertize
= intern_c_string (":propertize");
26380 staticpro (&QCpropertize
);
26381 QCfile
= intern_c_string (":file");
26382 staticpro (&QCfile
);
26383 Qfontified
= intern_c_string ("fontified");
26384 staticpro (&Qfontified
);
26385 Qfontification_functions
= intern_c_string ("fontification-functions");
26386 staticpro (&Qfontification_functions
);
26387 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26388 staticpro (&Qtrailing_whitespace
);
26389 Qescape_glyph
= intern_c_string ("escape-glyph");
26390 staticpro (&Qescape_glyph
);
26391 Qnobreak_space
= intern_c_string ("nobreak-space");
26392 staticpro (&Qnobreak_space
);
26393 Qimage
= intern_c_string ("image");
26394 staticpro (&Qimage
);
26395 Qtext
= intern_c_string ("text");
26396 staticpro (&Qtext
);
26397 Qboth
= intern_c_string ("both");
26398 staticpro (&Qboth
);
26399 Qboth_horiz
= intern_c_string ("both-horiz");
26400 staticpro (&Qboth_horiz
);
26401 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26402 staticpro (&Qtext_image_horiz
);
26403 QCmap
= intern_c_string (":map");
26404 staticpro (&QCmap
);
26405 QCpointer
= intern_c_string (":pointer");
26406 staticpro (&QCpointer
);
26407 Qrect
= intern_c_string ("rect");
26408 staticpro (&Qrect
);
26409 Qcircle
= intern_c_string ("circle");
26410 staticpro (&Qcircle
);
26411 Qpoly
= intern_c_string ("poly");
26412 staticpro (&Qpoly
);
26413 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26414 staticpro (&Qmessage_truncate_lines
);
26415 Qgrow_only
= intern_c_string ("grow-only");
26416 staticpro (&Qgrow_only
);
26417 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26418 staticpro (&Qinhibit_menubar_update
);
26419 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26420 staticpro (&Qinhibit_eval_during_redisplay
);
26421 Qposition
= intern_c_string ("position");
26422 staticpro (&Qposition
);
26423 Qbuffer_position
= intern_c_string ("buffer-position");
26424 staticpro (&Qbuffer_position
);
26425 Qobject
= intern_c_string ("object");
26426 staticpro (&Qobject
);
26427 Qbar
= intern_c_string ("bar");
26429 Qhbar
= intern_c_string ("hbar");
26430 staticpro (&Qhbar
);
26431 Qbox
= intern_c_string ("box");
26433 Qhollow
= intern_c_string ("hollow");
26434 staticpro (&Qhollow
);
26435 Qhand
= intern_c_string ("hand");
26436 staticpro (&Qhand
);
26437 Qarrow
= intern_c_string ("arrow");
26438 staticpro (&Qarrow
);
26439 Qtext
= intern_c_string ("text");
26440 staticpro (&Qtext
);
26441 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26442 staticpro (&Qinhibit_free_realized_faces
);
26444 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26445 Fcons (intern_c_string ("void-variable"), Qnil
)),
26447 staticpro (&list_of_error
);
26449 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26450 staticpro (&Qlast_arrow_position
);
26451 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26452 staticpro (&Qlast_arrow_string
);
26454 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26455 staticpro (&Qoverlay_arrow_string
);
26456 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26457 staticpro (&Qoverlay_arrow_bitmap
);
26459 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26460 staticpro (&echo_buffer
[0]);
26461 staticpro (&echo_buffer
[1]);
26463 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26464 staticpro (&echo_area_buffer
[0]);
26465 staticpro (&echo_area_buffer
[1]);
26467 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26468 staticpro (&Vmessages_buffer_name
);
26470 mode_line_proptrans_alist
= Qnil
;
26471 staticpro (&mode_line_proptrans_alist
);
26472 mode_line_string_list
= Qnil
;
26473 staticpro (&mode_line_string_list
);
26474 mode_line_string_face
= Qnil
;
26475 staticpro (&mode_line_string_face
);
26476 mode_line_string_face_prop
= Qnil
;
26477 staticpro (&mode_line_string_face_prop
);
26478 Vmode_line_unwind_vector
= Qnil
;
26479 staticpro (&Vmode_line_unwind_vector
);
26481 help_echo_string
= Qnil
;
26482 staticpro (&help_echo_string
);
26483 help_echo_object
= Qnil
;
26484 staticpro (&help_echo_object
);
26485 help_echo_window
= Qnil
;
26486 staticpro (&help_echo_window
);
26487 previous_help_echo_string
= Qnil
;
26488 staticpro (&previous_help_echo_string
);
26489 help_echo_pos
= -1;
26491 Qright_to_left
= intern_c_string ("right-to-left");
26492 staticpro (&Qright_to_left
);
26493 Qleft_to_right
= intern_c_string ("left-to-right");
26494 staticpro (&Qleft_to_right
);
26496 #ifdef HAVE_WINDOW_SYSTEM
26497 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26498 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26499 For example, if a block cursor is over a tab, it will be drawn as
26500 wide as that tab on the display. */);
26501 x_stretch_cursor_p
= 0;
26504 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26505 doc
: /* *Non-nil means highlight trailing whitespace.
26506 The face used for trailing whitespace is `trailing-whitespace'. */);
26507 Vshow_trailing_whitespace
= Qnil
;
26509 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26510 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26511 A value of t means highlight the character itself (for nobreak space,
26512 use face `nobreak-space').
26513 A value of nil means no highlighting.
26514 Other values mean display the escape glyph followed by an ordinary
26515 space or ordinary hyphen. */);
26516 Vnobreak_char_display
= Qt
;
26518 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26519 doc
: /* *The pointer shape to show in void text areas.
26520 A value of nil means to show the text pointer. Other options are `arrow',
26521 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26522 Vvoid_text_area_pointer
= Qarrow
;
26524 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26525 doc
: /* Non-nil means don't actually do any redisplay.
26526 This is used for internal purposes. */);
26527 Vinhibit_redisplay
= Qnil
;
26529 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26530 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26531 Vglobal_mode_string
= Qnil
;
26533 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26534 doc
: /* Marker for where to display an arrow on top of the buffer text.
26535 This must be the beginning of a line in order to work.
26536 See also `overlay-arrow-string'. */);
26537 Voverlay_arrow_position
= Qnil
;
26539 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26540 doc
: /* String to display as an arrow in non-window frames.
26541 See also `overlay-arrow-position'. */);
26542 Voverlay_arrow_string
= make_pure_c_string ("=>");
26544 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26545 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26546 The symbols on this list are examined during redisplay to determine
26547 where to display overlay arrows. */);
26548 Voverlay_arrow_variable_list
26549 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26551 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26552 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26553 If that fails to bring point back on frame, point is centered instead.
26554 If this is zero, point is always centered after it moves off frame.
26555 If you want scrolling to always be a line at a time, you should set
26556 `scroll-conservatively' to a large value rather than set this to 1. */);
26558 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26559 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26560 If point moves off-screen, redisplay will scroll by up to
26561 `scroll-conservatively' lines in order to bring point just barely
26562 onto the screen again. If that cannot be done, then redisplay
26563 recenters point as usual.
26565 If the value is greater than 100, redisplay will never recenter point,
26566 but will always scroll just enough text to bring point into view, even
26567 if you move far away.
26569 A value of zero means always recenter point if it moves off screen. */);
26570 scroll_conservatively
= 0;
26572 DEFVAR_INT ("scroll-margin", scroll_margin
,
26573 doc
: /* *Number of lines of margin at the top and bottom of a window.
26574 Recenter the window whenever point gets within this many lines
26575 of the top or bottom of the window. */);
26578 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26579 doc
: /* Pixels per inch value for non-window system displays.
26580 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26581 Vdisplay_pixels_per_inch
= make_float (72.0);
26584 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26587 DEFVAR_LISP ("truncate-partial-width-windows",
26588 Vtruncate_partial_width_windows
,
26589 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26590 For an integer value, truncate lines in each window narrower than the
26591 full frame width, provided the window width is less than that integer;
26592 otherwise, respect the value of `truncate-lines'.
26594 For any other non-nil value, truncate lines in all windows that do
26595 not span the full frame width.
26597 A value of nil means to respect the value of `truncate-lines'.
26599 If `word-wrap' is enabled, you might want to reduce this. */);
26600 Vtruncate_partial_width_windows
= make_number (50);
26602 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26603 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26604 Any other value means to use the appropriate face, `mode-line',
26605 `header-line', or `menu' respectively. */);
26606 mode_line_inverse_video
= 1;
26608 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26609 doc
: /* *Maximum buffer size for which line number should be displayed.
26610 If the buffer is bigger than this, the line number does not appear
26611 in the mode line. A value of nil means no limit. */);
26612 Vline_number_display_limit
= Qnil
;
26614 DEFVAR_INT ("line-number-display-limit-width",
26615 line_number_display_limit_width
,
26616 doc
: /* *Maximum line width (in characters) for line number display.
26617 If the average length of the lines near point is bigger than this, then the
26618 line number may be omitted from the mode line. */);
26619 line_number_display_limit_width
= 200;
26621 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26622 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26623 highlight_nonselected_windows
= 0;
26625 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26626 doc
: /* Non-nil if more than one frame is visible on this display.
26627 Minibuffer-only frames don't count, but iconified frames do.
26628 This variable is not guaranteed to be accurate except while processing
26629 `frame-title-format' and `icon-title-format'. */);
26631 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26632 doc
: /* Template for displaying the title bar of visible frames.
26633 \(Assuming the window manager supports this feature.)
26635 This variable has the same structure as `mode-line-format', except that
26636 the %c and %l constructs are ignored. It is used only on frames for
26637 which no explicit name has been set \(see `modify-frame-parameters'). */);
26639 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26640 doc
: /* Template for displaying the title bar of an iconified frame.
26641 \(Assuming the window manager supports this feature.)
26642 This variable has the same structure as `mode-line-format' (which see),
26643 and is used only on frames for which no explicit name has been set
26644 \(see `modify-frame-parameters'). */);
26646 = Vframe_title_format
26647 = pure_cons (intern_c_string ("multiple-frames"),
26648 pure_cons (make_pure_c_string ("%b"),
26649 pure_cons (pure_cons (empty_unibyte_string
,
26650 pure_cons (intern_c_string ("invocation-name"),
26651 pure_cons (make_pure_c_string ("@"),
26652 pure_cons (intern_c_string ("system-name"),
26656 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26657 doc
: /* Maximum number of lines to keep in the message log buffer.
26658 If nil, disable message logging. If t, log messages but don't truncate
26659 the buffer when it becomes large. */);
26660 Vmessage_log_max
= make_number (100);
26662 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26663 doc
: /* Functions called before redisplay, if window sizes have changed.
26664 The value should be a list of functions that take one argument.
26665 Just before redisplay, for each frame, if any of its windows have changed
26666 size since the last redisplay, or have been split or deleted,
26667 all the functions in the list are called, with the frame as argument. */);
26668 Vwindow_size_change_functions
= Qnil
;
26670 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26671 doc
: /* List of functions to call before redisplaying a window with scrolling.
26672 Each function is called with two arguments, the window and its new
26673 display-start position. Note that these functions are also called by
26674 `set-window-buffer'. Also note that the value of `window-end' is not
26675 valid when these functions are called. */);
26676 Vwindow_scroll_functions
= Qnil
;
26678 DEFVAR_LISP ("window-text-change-functions",
26679 Vwindow_text_change_functions
,
26680 doc
: /* Functions to call in redisplay when text in the window might change. */);
26681 Vwindow_text_change_functions
= Qnil
;
26683 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26684 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26685 Each function is called with two arguments, the window and the end trigger value.
26686 See `set-window-redisplay-end-trigger'. */);
26687 Vredisplay_end_trigger_functions
= Qnil
;
26689 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26690 doc
: /* *Non-nil means autoselect window with mouse pointer.
26691 If nil, do not autoselect windows.
26692 A positive number means delay autoselection by that many seconds: a
26693 window is autoselected only after the mouse has remained in that
26694 window for the duration of the delay.
26695 A negative number has a similar effect, but causes windows to be
26696 autoselected only after the mouse has stopped moving. \(Because of
26697 the way Emacs compares mouse events, you will occasionally wait twice
26698 that time before the window gets selected.\)
26699 Any other value means to autoselect window instantaneously when the
26700 mouse pointer enters it.
26702 Autoselection selects the minibuffer only if it is active, and never
26703 unselects the minibuffer if it is active.
26705 When customizing this variable make sure that the actual value of
26706 `focus-follows-mouse' matches the behavior of your window manager. */);
26707 Vmouse_autoselect_window
= Qnil
;
26709 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26710 doc
: /* *Non-nil means automatically resize tool-bars.
26711 This dynamically changes the tool-bar's height to the minimum height
26712 that is needed to make all tool-bar items visible.
26713 If value is `grow-only', the tool-bar's height is only increased
26714 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26715 Vauto_resize_tool_bars
= Qt
;
26717 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26718 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26719 auto_raise_tool_bar_buttons_p
= 1;
26721 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26722 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26723 make_cursor_line_fully_visible_p
= 1;
26725 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26726 doc
: /* *Border below tool-bar in pixels.
26727 If an integer, use it as the height of the border.
26728 If it is one of `internal-border-width' or `border-width', use the
26729 value of the corresponding frame parameter.
26730 Otherwise, no border is added below the tool-bar. */);
26731 Vtool_bar_border
= Qinternal_border_width
;
26733 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26734 doc
: /* *Margin around tool-bar buttons in pixels.
26735 If an integer, use that for both horizontal and vertical margins.
26736 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26737 HORZ specifying the horizontal margin, and VERT specifying the
26738 vertical margin. */);
26739 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26741 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26742 doc
: /* *Relief thickness of tool-bar buttons. */);
26743 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26745 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26746 doc
: /* Tool bar style to use.
26748 image - show images only
26749 text - show text only
26750 both - show both, text below image
26751 both-horiz - show text to the right of the image
26752 text-image-horiz - show text to the left of the image
26753 any other - use system default or image if no system default. */);
26754 Vtool_bar_style
= Qnil
;
26756 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26757 doc
: /* *Maximum number of characters a label can have to be shown.
26758 The tool bar style must also show labels for this to have any effect, see
26759 `tool-bar-style'. */);
26760 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26762 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26763 doc
: /* List of functions to call to fontify regions of text.
26764 Each function is called with one argument POS. Functions must
26765 fontify a region starting at POS in the current buffer, and give
26766 fontified regions the property `fontified'. */);
26767 Vfontification_functions
= Qnil
;
26768 Fmake_variable_buffer_local (Qfontification_functions
);
26770 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26771 unibyte_display_via_language_environment
,
26772 doc
: /* *Non-nil means display unibyte text according to language environment.
26773 Specifically, this means that raw bytes in the range 160-255 decimal
26774 are displayed by converting them to the equivalent multibyte characters
26775 according to the current language environment. As a result, they are
26776 displayed according to the current fontset.
26778 Note that this variable affects only how these bytes are displayed,
26779 but does not change the fact they are interpreted as raw bytes. */);
26780 unibyte_display_via_language_environment
= 0;
26782 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26783 doc
: /* *Maximum height for resizing mini-windows.
26784 If a float, it specifies a fraction of the mini-window frame's height.
26785 If an integer, it specifies a number of lines. */);
26786 Vmax_mini_window_height
= make_float (0.25);
26788 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26789 doc
: /* *How to resize mini-windows.
26790 A value of nil means don't automatically resize mini-windows.
26791 A value of t means resize them to fit the text displayed in them.
26792 A value of `grow-only', the default, means let mini-windows grow
26793 only, until their display becomes empty, at which point the windows
26794 go back to their normal size. */);
26795 Vresize_mini_windows
= Qgrow_only
;
26797 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26798 doc
: /* Alist specifying how to blink the cursor off.
26799 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26800 `cursor-type' frame-parameter or variable equals ON-STATE,
26801 comparing using `equal', Emacs uses OFF-STATE to specify
26802 how to blink it off. ON-STATE and OFF-STATE are values for
26803 the `cursor-type' frame parameter.
26805 If a frame's ON-STATE has no entry in this list,
26806 the frame's other specifications determine how to blink the cursor off. */);
26807 Vblink_cursor_alist
= Qnil
;
26809 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26810 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26811 If non-nil, windows are automatically scrolled horizontally to make
26812 point visible. */);
26813 automatic_hscrolling_p
= 1;
26814 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26815 staticpro (&Qauto_hscroll_mode
);
26817 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26818 doc
: /* *How many columns away from the window edge point is allowed to get
26819 before automatic hscrolling will horizontally scroll the window. */);
26820 hscroll_margin
= 5;
26822 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26823 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26824 When point is less than `hscroll-margin' columns from the window
26825 edge, automatic hscrolling will scroll the window by the amount of columns
26826 determined by this variable. If its value is a positive integer, scroll that
26827 many columns. If it's a positive floating-point number, it specifies the
26828 fraction of the window's width to scroll. If it's nil or zero, point will be
26829 centered horizontally after the scroll. Any other value, including negative
26830 numbers, are treated as if the value were zero.
26832 Automatic hscrolling always moves point outside the scroll margin, so if
26833 point was more than scroll step columns inside the margin, the window will
26834 scroll more than the value given by the scroll step.
26836 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26837 and `scroll-right' overrides this variable's effect. */);
26838 Vhscroll_step
= make_number (0);
26840 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26841 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26842 Bind this around calls to `message' to let it take effect. */);
26843 message_truncate_lines
= 0;
26845 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26846 doc
: /* Normal hook run to update the menu bar definitions.
26847 Redisplay runs this hook before it redisplays the menu bar.
26848 This is used to update submenus such as Buffers,
26849 whose contents depend on various data. */);
26850 Vmenu_bar_update_hook
= Qnil
;
26852 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26853 doc
: /* Frame for which we are updating a menu.
26854 The enable predicate for a menu binding should check this variable. */);
26855 Vmenu_updating_frame
= Qnil
;
26857 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26858 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26859 inhibit_menubar_update
= 0;
26861 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26862 doc
: /* Prefix prepended to all continuation lines at display time.
26863 The value may be a string, an image, or a stretch-glyph; it is
26864 interpreted in the same way as the value of a `display' text property.
26866 This variable is overridden by any `wrap-prefix' text or overlay
26869 To add a prefix to non-continuation lines, use `line-prefix'. */);
26870 Vwrap_prefix
= Qnil
;
26871 staticpro (&Qwrap_prefix
);
26872 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26873 Fmake_variable_buffer_local (Qwrap_prefix
);
26875 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26876 doc
: /* Prefix prepended to all non-continuation lines at display time.
26877 The value may be a string, an image, or a stretch-glyph; it is
26878 interpreted in the same way as the value of a `display' text property.
26880 This variable is overridden by any `line-prefix' text or overlay
26883 To add a prefix to continuation lines, use `wrap-prefix'. */);
26884 Vline_prefix
= Qnil
;
26885 staticpro (&Qline_prefix
);
26886 Qline_prefix
= intern_c_string ("line-prefix");
26887 Fmake_variable_buffer_local (Qline_prefix
);
26889 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26890 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26891 inhibit_eval_during_redisplay
= 0;
26893 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26894 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26895 inhibit_free_realized_faces
= 0;
26898 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26899 doc
: /* Inhibit try_window_id display optimization. */);
26900 inhibit_try_window_id
= 0;
26902 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26903 doc
: /* Inhibit try_window_reusing display optimization. */);
26904 inhibit_try_window_reusing
= 0;
26906 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26907 doc
: /* Inhibit try_cursor_movement display optimization. */);
26908 inhibit_try_cursor_movement
= 0;
26909 #endif /* GLYPH_DEBUG */
26911 DEFVAR_INT ("overline-margin", overline_margin
,
26912 doc
: /* *Space between overline and text, in pixels.
26913 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26914 margin to the caracter height. */);
26915 overline_margin
= 2;
26917 DEFVAR_INT ("underline-minimum-offset",
26918 underline_minimum_offset
,
26919 doc
: /* Minimum distance between baseline and underline.
26920 This can improve legibility of underlined text at small font sizes,
26921 particularly when using variable `x-use-underline-position-properties'
26922 with fonts that specify an UNDERLINE_POSITION relatively close to the
26923 baseline. The default value is 1. */);
26924 underline_minimum_offset
= 1;
26926 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26927 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26928 This feature only works when on a window system that can change
26929 cursor shapes. */);
26930 display_hourglass_p
= 1;
26932 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26933 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26934 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26936 hourglass_atimer
= NULL
;
26937 hourglass_shown_p
= 0;
26939 DEFSYM (Qglyphless_char
, "glyphless-char");
26940 DEFSYM (Qhex_code
, "hex-code");
26941 DEFSYM (Qempty_box
, "empty-box");
26942 DEFSYM (Qthin_space
, "thin-space");
26943 DEFSYM (Qzero_width
, "zero-width");
26945 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26946 /* Intern this now in case it isn't already done.
26947 Setting this variable twice is harmless.
26948 But don't staticpro it here--that is done in alloc.c. */
26949 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26950 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26952 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26953 doc
: /* Char-table to control displaying of glyphless characters.
26954 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26955 or one of these symbols:
26956 hex-code: display the hexadecimal code of a character in a box
26957 empty-box: display as an empty box
26958 thin-space: display as 1-pixel width space
26959 zero-width: don't display
26961 It has one extra slot to control the display of a character for which
26962 no font is found. The value of the slot is `hex-code' or `empty-box'.
26963 The default is `empty-box'. */);
26964 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26965 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26970 /* Initialize this module when Emacs starts. */
26975 Lisp_Object root_window
;
26976 struct window
*mini_w
;
26978 current_header_line_height
= current_mode_line_height
= -1;
26980 CHARPOS (this_line_start_pos
) = 0;
26982 mini_w
= XWINDOW (minibuf_window
);
26983 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26985 if (!noninteractive
)
26987 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26990 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26991 set_window_height (root_window
,
26992 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26994 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26995 set_window_height (minibuf_window
, 1, 0);
26997 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26998 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27000 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27001 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27002 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27004 /* The default ellipsis glyphs `...'. */
27005 for (i
= 0; i
< 3; ++i
)
27006 default_invis_vector
[i
] = make_number ('.');
27010 /* Allocate the buffer for frame titles.
27011 Also used for `format-mode-line'. */
27013 mode_line_noprop_buf
= (char *) xmalloc (size
);
27014 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27015 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27016 mode_line_target
= MODE_LINE_DISPLAY
;
27019 help_echo_showing_p
= 0;
27022 /* Since w32 does not support atimers, it defines its own implementation of
27023 the following three functions in w32fns.c. */
27026 /* Platform-independent portion of hourglass implementation. */
27028 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27030 hourglass_started (void)
27032 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27035 /* Cancel a currently active hourglass timer, and start a new one. */
27037 start_hourglass (void)
27039 #if defined (HAVE_WINDOW_SYSTEM)
27041 int secs
, usecs
= 0;
27043 cancel_hourglass ();
27045 if (INTEGERP (Vhourglass_delay
)
27046 && XINT (Vhourglass_delay
) > 0)
27047 secs
= XFASTINT (Vhourglass_delay
);
27048 else if (FLOATP (Vhourglass_delay
)
27049 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27052 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27053 secs
= XFASTINT (tem
);
27054 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27057 secs
= DEFAULT_HOURGLASS_DELAY
;
27059 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27060 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27061 show_hourglass
, NULL
);
27066 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27069 cancel_hourglass (void)
27071 #if defined (HAVE_WINDOW_SYSTEM)
27072 if (hourglass_atimer
)
27074 cancel_atimer (hourglass_atimer
);
27075 hourglass_atimer
= NULL
;
27078 if (hourglass_shown_p
)
27082 #endif /* ! WINDOWSNT */