1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code.
37 The following diagram shows how redisplay code is invoked. As you
38 can see, Lisp calls redisplay and vice versa. Under window systems
39 like X, some portions of the redisplay code are also called
40 asynchronously during mouse movement or expose events. It is very
41 important that these code parts do NOT use the C library (malloc,
42 free) because many C libraries under Unix are not reentrant. They
43 may also NOT call functions of the Lisp interpreter which could
44 change the interpreter's state. If you don't follow these rules,
45 you will encounter bugs which are very hard to explain.
47 +--------------+ redisplay +----------------+
48 | Lisp machine |---------------->| Redisplay code |<--+
49 +--------------+ (xdisp.c) +----------------+ |
51 +----------------------------------+ |
52 Don't use this path when called |
55 expose_window (asynchronous) |
57 X expose events -----+
59 What does redisplay do? Obviously, it has to figure out somehow what
60 has been changed since the last time the display has been updated,
61 and to make these changes visible. Preferably it would do that in
62 a moderately intelligent way, i.e. fast.
64 Changes in buffer text can be deduced from window and buffer
65 structures, and from some global variables like `beg_unchanged' and
66 `end_unchanged'. The contents of the display are additionally
67 recorded in a `glyph matrix', a two-dimensional matrix of glyph
68 structures. Each row in such a matrix corresponds to a line on the
69 display, and each glyph in a row corresponds to a column displaying
70 a character, an image, or what else. This matrix is called the
71 `current glyph matrix' or `current matrix' in redisplay
74 For buffer parts that have been changed since the last update, a
75 second glyph matrix is constructed, the so called `desired glyph
76 matrix' or short `desired matrix'. Current and desired matrix are
77 then compared to find a cheap way to update the display, e.g. by
78 reusing part of the display by scrolling lines.
80 You will find a lot of redisplay optimizations when you start
81 looking at the innards of redisplay. The overall goal of all these
82 optimizations is to make redisplay fast because it is done
83 frequently. Some of these optimizations are implemented by the
88 This function tries to update the display if the text in the
89 window did not change and did not scroll, only point moved, and
90 it did not move off the displayed portion of the text.
92 . try_window_reusing_current_matrix
94 This function reuses the current matrix of a window when text
95 has not changed, but the window start changed (e.g., due to
100 This function attempts to redisplay a window by reusing parts of
101 its existing display. It finds and reuses the part that was not
102 changed, and redraws the rest.
106 This function performs the full redisplay of a single window
107 assuming that its fonts were not changed and that the cursor
108 will not end up in the scroll margins. (Loading fonts requires
109 re-adjustment of dimensions of glyph matrices, which makes this
110 method impossible to use.)
112 These optimizations are tried in sequence (some can be skipped if
113 it is known that they are not applicable). If none of the
114 optimizations were successful, redisplay calls redisplay_windows,
115 which performs a full redisplay of all windows.
119 Desired matrices are always built per Emacs window. The function
120 `display_line' is the central function to look at if you are
121 interested. It constructs one row in a desired matrix given an
122 iterator structure containing both a buffer position and a
123 description of the environment in which the text is to be
124 displayed. But this is too early, read on.
126 Characters and pixmaps displayed for a range of buffer text depend
127 on various settings of buffers and windows, on overlays and text
128 properties, on display tables, on selective display. The good news
129 is that all this hairy stuff is hidden behind a small set of
130 interface functions taking an iterator structure (struct it)
133 Iteration over things to be displayed is then simple. It is
134 started by initializing an iterator with a call to init_iterator.
135 Calls to get_next_display_element fill the iterator structure with
136 relevant information about the next thing to display. Calls to
137 set_iterator_to_next move the iterator to the next thing.
139 Besides this, an iterator also contains information about the
140 display environment in which glyphs for display elements are to be
141 produced. It has fields for the width and height of the display,
142 the information whether long lines are truncated or continued, a
143 current X and Y position, and lots of other stuff you can better
146 Glyphs in a desired matrix are normally constructed in a loop
147 calling get_next_display_element and then PRODUCE_GLYPHS. The call
148 to PRODUCE_GLYPHS will fill the iterator structure with pixel
149 information about the element being displayed and at the same time
150 produce glyphs for it. If the display element fits on the line
151 being displayed, set_iterator_to_next is called next, otherwise the
152 glyphs produced are discarded. The function display_line is the
153 workhorse of filling glyph rows in the desired matrix with glyphs.
154 In addition to producing glyphs, it also handles line truncation
155 and continuation, word wrap, and cursor positioning (for the
156 latter, see also set_cursor_from_row).
160 That just couldn't be all, could it? What about terminal types not
161 supporting operations on sub-windows of the screen? To update the
162 display on such a terminal, window-based glyph matrices are not
163 well suited. To be able to reuse part of the display (scrolling
164 lines up and down), we must instead have a view of the whole
165 screen. This is what `frame matrices' are for. They are a trick.
167 Frames on terminals like above have a glyph pool. Windows on such
168 a frame sub-allocate their glyph memory from their frame's glyph
169 pool. The frame itself is given its own glyph matrices. By
170 coincidence---or maybe something else---rows in window glyph
171 matrices are slices of corresponding rows in frame matrices. Thus
172 writing to window matrices implicitly updates a frame matrix which
173 provides us with the view of the whole screen that we originally
174 wanted to have without having to move many bytes around. To be
175 honest, there is a little bit more done, but not much more. If you
176 plan to extend that code, take a look at dispnew.c. The function
177 build_frame_matrix is a good starting point.
179 Bidirectional display.
181 Bidirectional display adds quite some hair to this already complex
182 design. The good news are that a large portion of that hairy stuff
183 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
184 reordering engine which is called by set_iterator_to_next and
185 returns the next character to display in the visual order. See
186 commentary on bidi.c for more details. As far as redisplay is
187 concerned, the effect of calling bidi_move_to_visually_next, the
188 main interface of the reordering engine, is that the iterator gets
189 magically placed on the buffer or string position that is to be
190 displayed next. In other words, a linear iteration through the
191 buffer/string is replaced with a non-linear one. All the rest of
192 the redisplay is oblivious to the bidi reordering.
194 Well, almost oblivious---there are still complications, most of
195 them due to the fact that buffer and string positions no longer
196 change monotonously with glyph indices in a glyph row. Moreover,
197 for continued lines, the buffer positions may not even be
198 monotonously changing with vertical positions. Also, accounting
199 for face changes, overlays, etc. becomes more complex because
200 non-linear iteration could potentially skip many positions with
201 changes, and then cross them again on the way back...
203 One other prominent effect of bidirectional display is that some
204 paragraphs of text need to be displayed starting at the right
205 margin of the window---the so-called right-to-left, or R2L
206 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
207 which have their reversed_p flag set. The bidi reordering engine
208 produces characters in such rows starting from the character which
209 should be the rightmost on display. PRODUCE_GLYPHS then reverses
210 the order, when it fills up the glyph row whose reversed_p flag is
211 set, by prepending each new glyph to what is already there, instead
212 of appending it. When the glyph row is complete, the function
213 extend_face_to_end_of_line fills the empty space to the left of the
214 leftmost character with special glyphs, which will display as,
215 well, empty. On text terminals, these special glyphs are simply
216 blank characters. On graphics terminals, there's a single stretch
217 glyph of a suitably computed width. Both the blanks and the
218 stretch glyph are given the face of the background of the line.
219 This way, the terminal-specific back-end can still draw the glyphs
220 left to right, even for R2L lines.
222 Bidirectional display and character compositions
224 Some scripts cannot be displayed by drawing each character
225 individually, because adjacent characters change each other's shape
226 on display. For example, Arabic and Indic scripts belong to this
229 Emacs display supports this by providing "character compositions",
230 most of which is implemented in composite.c. During the buffer
231 scan that delivers characters to PRODUCE_GLYPHS, if the next
232 character to be delivered is a composed character, the iteration
233 calls composition_reseat_it and next_element_from_composition. If
234 they succeed to compose the character with one or more of the
235 following characters, the whole sequence of characters that where
236 composed is recorded in the `struct composition_it' object that is
237 part of the buffer iterator. The composed sequence could produce
238 one or more font glyphs (called "grapheme clusters") on the screen.
239 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
240 in the direction corresponding to the current bidi scan direction
241 (recorded in the scan_dir member of the `struct bidi_it' object
242 that is part of the buffer iterator). In particular, if the bidi
243 iterator currently scans the buffer backwards, the grapheme
244 clusters are delivered back to front. This reorders the grapheme
245 clusters as appropriate for the current bidi context. Note that
246 this means that the grapheme clusters are always stored in the
247 LGSTRING object (see composite.c) in the logical order.
249 Moving an iterator in bidirectional text
250 without producing glyphs
252 Note one important detail mentioned above: that the bidi reordering
253 engine, driven by the iterator, produces characters in R2L rows
254 starting at the character that will be the rightmost on display.
255 As far as the iterator is concerned, the geometry of such rows is
256 still left to right, i.e. the iterator "thinks" the first character
257 is at the leftmost pixel position. The iterator does not know that
258 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
259 delivers. This is important when functions from the the move_it_*
260 family are used to get to certain screen position or to match
261 screen coordinates with buffer coordinates: these functions use the
262 iterator geometry, which is left to right even in R2L paragraphs.
263 This works well with most callers of move_it_*, because they need
264 to get to a specific column, and columns are still numbered in the
265 reading order, i.e. the rightmost character in a R2L paragraph is
266 still column zero. But some callers do not get well with this; a
267 notable example is mouse clicks that need to find the character
268 that corresponds to certain pixel coordinates. See
269 buffer_posn_from_coords in dispnew.c for how this is handled. */
277 #include "keyboard.h"
280 #include "termchar.h"
281 #include "dispextern.h"
283 #include "character.h"
286 #include "commands.h"
290 #include "termhooks.h"
291 #include "termopts.h"
292 #include "intervals.h"
295 #include "region-cache.h"
298 #include "blockinput.h"
300 #ifdef HAVE_X_WINDOWS
315 #ifndef FRAME_X_OUTPUT
316 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
319 #define INFINITY 10000000
321 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
322 Lisp_Object Qwindow_scroll_functions
;
323 Lisp_Object Qwindow_text_change_functions
;
324 Lisp_Object Qredisplay_end_trigger_functions
;
325 Lisp_Object Qinhibit_point_motion_hooks
;
326 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
327 Lisp_Object Qfontified
;
328 Lisp_Object Qgrow_only
;
329 Lisp_Object Qinhibit_eval_during_redisplay
;
330 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
331 Lisp_Object Qright_to_left
, Qleft_to_right
;
334 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
337 Lisp_Object Qarrow
, Qhand
, Qtext
;
339 /* Holds the list (error). */
340 Lisp_Object list_of_error
;
342 Lisp_Object Qfontification_functions
;
344 Lisp_Object Qwrap_prefix
;
345 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
, QCrelative_width
, QCrelative_height
;
356 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
359 Lisp_Object Qmargin
, Qpointer
;
360 Lisp_Object Qline_height
;
362 #ifdef HAVE_WINDOW_SYSTEM
364 /* Test if overflow newline into fringe. Called with iterator IT
365 at or past right window margin, and with IT->current_x set. */
367 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
368 (!NILP (Voverflow_newline_into_fringe) \
369 && FRAME_WINDOW_P ((IT)->f) \
370 && ((IT)->bidi_it.paragraph_dir == R2L \
371 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
372 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
373 && (IT)->current_x == (IT)->last_visible_x \
374 && (IT)->line_wrap != WORD_WRAP)
376 #else /* !HAVE_WINDOW_SYSTEM */
377 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
378 #endif /* HAVE_WINDOW_SYSTEM */
380 /* Test if the display element loaded in IT is a space or tab
381 character. This is used to determine word wrapping. */
383 #define IT_DISPLAYING_WHITESPACE(it) \
384 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
386 /* Name of the face used to highlight trailing whitespace. */
388 Lisp_Object Qtrailing_whitespace
;
390 /* Name and number of the face used to highlight escape glyphs. */
392 Lisp_Object Qescape_glyph
;
394 /* Name and number of the face used to highlight non-breaking spaces. */
396 Lisp_Object Qnobreak_space
;
398 /* The symbol `image' which is the car of the lists used to represent
399 images in Lisp. Also a tool bar style. */
403 /* The image map types. */
404 Lisp_Object QCmap
, QCpointer
;
405 Lisp_Object Qrect
, Qcircle
, Qpoly
;
407 /* Tool bar styles */
408 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
410 /* Non-zero means print newline to stdout before next mini-buffer
413 int noninteractive_need_newline
;
415 /* Non-zero means print newline to message log before next message. */
417 static int message_log_need_newline
;
419 /* Three markers that message_dolog uses.
420 It could allocate them itself, but that causes trouble
421 in handling memory-full errors. */
422 static Lisp_Object message_dolog_marker1
;
423 static Lisp_Object message_dolog_marker2
;
424 static Lisp_Object message_dolog_marker3
;
426 /* The buffer position of the first character appearing entirely or
427 partially on the line of the selected window which contains the
428 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
429 redisplay optimization in redisplay_internal. */
431 static struct text_pos this_line_start_pos
;
433 /* Number of characters past the end of the line above, including the
434 terminating newline. */
436 static struct text_pos this_line_end_pos
;
438 /* The vertical positions and the height of this line. */
440 static int this_line_vpos
;
441 static int this_line_y
;
442 static int this_line_pixel_height
;
444 /* X position at which this display line starts. Usually zero;
445 negative if first character is partially visible. */
447 static int this_line_start_x
;
449 /* Buffer that this_line_.* variables are referring to. */
451 static struct buffer
*this_line_buffer
;
454 /* Values of those variables at last redisplay are stored as
455 properties on `overlay-arrow-position' symbol. However, if
456 Voverlay_arrow_position is a marker, last-arrow-position is its
457 numerical position. */
459 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
461 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
462 properties on a symbol in overlay-arrow-variable-list. */
464 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
466 Lisp_Object Qmenu_bar_update_hook
;
468 /* Nonzero if an overlay arrow has been displayed in this window. */
470 static int overlay_arrow_seen
;
472 /* Number of windows showing the buffer of the selected window (or
473 another buffer with the same base buffer). keyboard.c refers to
478 /* Vector containing glyphs for an ellipsis `...'. */
480 static Lisp_Object default_invis_vector
[3];
482 /* Prompt to display in front of the mini-buffer contents. */
484 Lisp_Object minibuf_prompt
;
486 /* Width of current mini-buffer prompt. Only set after display_line
487 of the line that contains the prompt. */
489 int minibuf_prompt_width
;
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 Lisp_Object Vmessage_stack
;
504 /* Nonzero means multibyte characters were enabled when the echo area
505 message was specified. */
507 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 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 int message_buf_print
;
554 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556 Lisp_Object Qinhibit_menubar_update
;
557 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 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 Lisp_Object Qauto_hscroll_mode
;
613 /* Buffer being redisplayed -- for redisplay_window_error. */
615 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 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 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 mark_window_display_accurate_1 (struct window
*, int);
760 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
761 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
762 static int cursor_row_p (struct window
*, struct glyph_row
*);
763 static int redisplay_mode_lines (Lisp_Object
, int);
764 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
766 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
768 static void handle_line_prefix (struct it
*);
770 static void pint2str (char *, int, int);
771 static void pint2hrstr (char *, int, int);
772 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
774 static void reconsider_clip_changes (struct window
*, struct buffer
*);
775 static int text_outside_line_unchanged_p (struct window
*,
776 EMACS_INT
, EMACS_INT
);
777 static void store_mode_line_noprop_char (char);
778 static int store_mode_line_noprop (const unsigned char *, int, int);
779 static void handle_stop (struct it
*);
780 static void handle_stop_backwards (struct it
*, EMACS_INT
);
781 static int single_display_spec_intangible_p (Lisp_Object
);
782 static void ensure_echo_area_buffers (void);
783 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
784 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
785 static int with_echo_area_buffer (struct window
*, int,
786 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
787 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
788 static void clear_garbaged_frames (void);
789 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
791 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static int display_echo_area (struct window
*);
793 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
794 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
795 static Lisp_Object
unwind_redisplay (Lisp_Object
);
796 static int string_char_and_length (const unsigned char *, int *);
797 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
799 static int compute_window_start_on_continuation_line (struct window
*);
800 static Lisp_Object
safe_eval_handler (Lisp_Object
);
801 static void insert_left_trunc_glyphs (struct it
*);
802 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
804 static void extend_face_to_end_of_line (struct it
*);
805 static int append_space_for_newline (struct it
*, int);
806 static int cursor_row_fully_visible_p (struct window
*, int, int);
807 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
808 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
809 static int trailing_whitespace_p (EMACS_INT
);
810 static int message_log_check_duplicate (EMACS_INT
, EMACS_INT
,
811 EMACS_INT
, EMACS_INT
);
812 static void push_it (struct it
*);
813 static void pop_it (struct it
*);
814 static void sync_frame_with_window_matrix_rows (struct window
*);
815 static void select_frame_for_redisplay (Lisp_Object
);
816 static void redisplay_internal (int);
817 static int echo_area_display (int);
818 static void redisplay_windows (Lisp_Object
);
819 static void redisplay_window (Lisp_Object
, int);
820 static Lisp_Object
redisplay_window_error (Lisp_Object
);
821 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
822 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
823 static int update_menu_bar (struct frame
*, int, int);
824 static int try_window_reusing_current_matrix (struct window
*);
825 static int try_window_id (struct window
*);
826 static int display_line (struct it
*);
827 static int display_mode_lines (struct window
*);
828 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
829 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
830 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
831 static const char *decode_mode_spec (struct window
*, int, int, int,
833 static void display_menu_bar (struct window
*);
834 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
836 static int display_string (const unsigned char *, Lisp_Object
, Lisp_Object
,
837 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
838 static void compute_line_metrics (struct it
*);
839 static void run_redisplay_end_trigger_hook (struct it
*);
840 static int get_overlay_strings (struct it
*, EMACS_INT
);
841 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
842 static void next_overlay_string (struct it
*);
843 static void reseat (struct it
*, struct text_pos
, int);
844 static void reseat_1 (struct it
*, struct text_pos
, int);
845 static void back_to_previous_visible_line_start (struct it
*);
846 void reseat_at_previous_visible_line_start (struct it
*);
847 static void reseat_at_next_visible_line_start (struct it
*, int);
848 static int next_element_from_ellipsis (struct it
*);
849 static int next_element_from_display_vector (struct it
*);
850 static int next_element_from_string (struct it
*);
851 static int next_element_from_c_string (struct it
*);
852 static int next_element_from_buffer (struct it
*);
853 static int next_element_from_composition (struct it
*);
854 static int next_element_from_image (struct it
*);
855 static int next_element_from_stretch (struct it
*);
856 static void load_overlay_strings (struct it
*, EMACS_INT
);
857 static int init_from_display_pos (struct it
*, struct window
*,
858 struct display_pos
*);
859 static void reseat_to_string (struct it
*, const unsigned char *,
860 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
861 static enum move_it_result
862 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
863 enum move_operation_enum
);
864 void move_it_vertically_backward (struct it
*, int);
865 static void init_to_row_start (struct it
*, struct window
*,
867 static int init_to_row_end (struct it
*, struct window
*,
869 static void back_to_previous_line_start (struct it
*);
870 static int forward_to_next_line_start (struct it
*, int *);
871 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
872 Lisp_Object
, EMACS_INT
);
873 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
874 static struct text_pos
c_string_pos (EMACS_INT
, const unsigned char *, int);
875 static EMACS_INT
number_of_chars (const unsigned char *, int);
876 static void compute_stop_pos (struct it
*);
877 static void compute_string_pos (struct text_pos
*, struct text_pos
,
879 static int face_before_or_after_it_pos (struct it
*, int);
880 static EMACS_INT
next_overlay_change (EMACS_INT
);
881 static int handle_single_display_spec (struct it
*, Lisp_Object
,
882 Lisp_Object
, Lisp_Object
,
883 struct text_pos
*, int);
884 static int underlying_face_id (struct it
*);
885 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
888 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
889 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
891 #ifdef HAVE_WINDOW_SYSTEM
893 static void x_consider_frame_title (Lisp_Object
);
894 static int tool_bar_lines_needed (struct frame
*, int *);
895 static void update_tool_bar (struct frame
*, int);
896 static void build_desired_tool_bar_string (struct frame
*f
);
897 static int redisplay_tool_bar (struct frame
*);
898 static void display_tool_bar_line (struct it
*, int);
899 static void notice_overwritten_cursor (struct window
*,
902 static void append_stretch_glyph (struct it
*, Lisp_Object
,
906 #endif /* HAVE_WINDOW_SYSTEM */
908 static int coords_in_mouse_face_p (struct window
*, int, int);
912 /***********************************************************************
913 Window display dimensions
914 ***********************************************************************/
916 /* Return the bottom boundary y-position for text lines in window W.
917 This is the first y position at which a line cannot start.
918 It is relative to the top of the window.
920 This is the height of W minus the height of a mode line, if any. */
923 window_text_bottom_y (struct window
*w
)
925 int height
= WINDOW_TOTAL_HEIGHT (w
);
927 if (WINDOW_WANTS_MODELINE_P (w
))
928 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
932 /* Return the pixel width of display area AREA of window W. AREA < 0
933 means return the total width of W, not including fringes to
934 the left and right of the window. */
937 window_box_width (struct window
*w
, int area
)
939 int cols
= XFASTINT (w
->total_cols
);
942 if (!w
->pseudo_window_p
)
944 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
946 if (area
== TEXT_AREA
)
948 if (INTEGERP (w
->left_margin_cols
))
949 cols
-= XFASTINT (w
->left_margin_cols
);
950 if (INTEGERP (w
->right_margin_cols
))
951 cols
-= XFASTINT (w
->right_margin_cols
);
952 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
954 else if (area
== LEFT_MARGIN_AREA
)
956 cols
= (INTEGERP (w
->left_margin_cols
)
957 ? XFASTINT (w
->left_margin_cols
) : 0);
960 else if (area
== RIGHT_MARGIN_AREA
)
962 cols
= (INTEGERP (w
->right_margin_cols
)
963 ? XFASTINT (w
->right_margin_cols
) : 0);
968 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
972 /* Return the pixel height of the display area of window W, not
973 including mode lines of W, if any. */
976 window_box_height (struct window
*w
)
978 struct frame
*f
= XFRAME (w
->frame
);
979 int height
= WINDOW_TOTAL_HEIGHT (w
);
981 xassert (height
>= 0);
983 /* Note: the code below that determines the mode-line/header-line
984 height is essentially the same as that contained in the macro
985 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
986 the appropriate glyph row has its `mode_line_p' flag set,
987 and if it doesn't, uses estimate_mode_line_height instead. */
989 if (WINDOW_WANTS_MODELINE_P (w
))
991 struct glyph_row
*ml_row
992 = (w
->current_matrix
&& w
->current_matrix
->rows
993 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
995 if (ml_row
&& ml_row
->mode_line_p
)
996 height
-= ml_row
->height
;
998 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1001 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1003 struct glyph_row
*hl_row
1004 = (w
->current_matrix
&& w
->current_matrix
->rows
1005 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1007 if (hl_row
&& hl_row
->mode_line_p
)
1008 height
-= hl_row
->height
;
1010 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1013 /* With a very small font and a mode-line that's taller than
1014 default, we might end up with a negative height. */
1015 return max (0, height
);
1018 /* Return the window-relative coordinate of the left edge of display
1019 area AREA of window W. AREA < 0 means return the left edge of the
1020 whole window, to the right of the left fringe of W. */
1023 window_box_left_offset (struct window
*w
, int area
)
1027 if (w
->pseudo_window_p
)
1030 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1032 if (area
== TEXT_AREA
)
1033 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1034 + window_box_width (w
, LEFT_MARGIN_AREA
));
1035 else if (area
== RIGHT_MARGIN_AREA
)
1036 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1037 + window_box_width (w
, LEFT_MARGIN_AREA
)
1038 + window_box_width (w
, TEXT_AREA
)
1039 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1041 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1042 else if (area
== LEFT_MARGIN_AREA
1043 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1044 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1050 /* Return the window-relative coordinate of the right edge of display
1051 area AREA of window W. AREA < 0 means return the right edge of the
1052 whole window, to the left of the right fringe of W. */
1055 window_box_right_offset (struct window
*w
, int area
)
1057 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1060 /* Return the frame-relative coordinate of the left edge of display
1061 area AREA of window W. AREA < 0 means return the left edge of the
1062 whole window, to the right of the left fringe of W. */
1065 window_box_left (struct window
*w
, int area
)
1067 struct frame
*f
= XFRAME (w
->frame
);
1070 if (w
->pseudo_window_p
)
1071 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1073 x
= (WINDOW_LEFT_EDGE_X (w
)
1074 + window_box_left_offset (w
, area
));
1080 /* Return the frame-relative coordinate of the right edge of display
1081 area AREA of window W. AREA < 0 means return the right edge of the
1082 whole window, to the left of the right fringe of W. */
1085 window_box_right (struct window
*w
, int area
)
1087 return window_box_left (w
, area
) + window_box_width (w
, area
);
1090 /* Get the bounding box of the display area AREA of window W, without
1091 mode lines, in frame-relative coordinates. AREA < 0 means the
1092 whole window, not including the left and right fringes of
1093 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1094 coordinates of the upper-left corner of the box. Return in
1095 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1098 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1099 int *box_width
, int *box_height
)
1102 *box_width
= window_box_width (w
, area
);
1104 *box_height
= window_box_height (w
);
1106 *box_x
= window_box_left (w
, area
);
1109 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1110 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1111 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1116 /* Get the bounding box of the display area AREA of window W, without
1117 mode lines. AREA < 0 means the whole window, not including the
1118 left and right fringe of the window. Return in *TOP_LEFT_X
1119 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1120 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1121 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1125 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1126 int *bottom_right_x
, int *bottom_right_y
)
1128 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1130 *bottom_right_x
+= *top_left_x
;
1131 *bottom_right_y
+= *top_left_y
;
1136 /***********************************************************************
1138 ***********************************************************************/
1140 /* Return the bottom y-position of the line the iterator IT is in.
1141 This can modify IT's settings. */
1144 line_bottom_y (struct it
*it
)
1146 int line_height
= it
->max_ascent
+ it
->max_descent
;
1147 int line_top_y
= it
->current_y
;
1149 if (line_height
== 0)
1152 line_height
= last_height
;
1153 else if (IT_CHARPOS (*it
) < ZV
)
1155 move_it_by_lines (it
, 1, 1);
1156 line_height
= (it
->max_ascent
|| it
->max_descent
1157 ? it
->max_ascent
+ it
->max_descent
1162 struct glyph_row
*row
= it
->glyph_row
;
1164 /* Use the default character height. */
1165 it
->glyph_row
= NULL
;
1166 it
->what
= IT_CHARACTER
;
1169 PRODUCE_GLYPHS (it
);
1170 line_height
= it
->ascent
+ it
->descent
;
1171 it
->glyph_row
= row
;
1175 return line_top_y
+ line_height
;
1179 /* Return 1 if position CHARPOS is visible in window W.
1180 CHARPOS < 0 means return info about WINDOW_END position.
1181 If visible, set *X and *Y to pixel coordinates of top left corner.
1182 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1183 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1186 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1187 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1190 struct text_pos top
;
1192 struct buffer
*old_buffer
= NULL
;
1194 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1197 if (XBUFFER (w
->buffer
) != current_buffer
)
1199 old_buffer
= current_buffer
;
1200 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1203 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1205 /* Compute exact mode line heights. */
1206 if (WINDOW_WANTS_MODELINE_P (w
))
1207 current_mode_line_height
1208 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1209 current_buffer
->mode_line_format
);
1211 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1212 current_header_line_height
1213 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1214 current_buffer
->header_line_format
);
1216 start_display (&it
, w
, top
);
1217 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1218 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1220 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1222 /* We have reached CHARPOS, or passed it. How the call to
1223 move_it_to can overshoot: (i) If CHARPOS is on invisible
1224 text, move_it_to stops at the end of the invisible text,
1225 after CHARPOS. (ii) If CHARPOS is in a display vector,
1226 move_it_to stops on its last glyph. */
1227 int top_x
= it
.current_x
;
1228 int top_y
= it
.current_y
;
1229 enum it_method it_method
= it
.method
;
1230 /* Calling line_bottom_y may change it.method, it.position, etc. */
1231 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1232 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1234 if (top_y
< window_top_y
)
1235 visible_p
= bottom_y
> window_top_y
;
1236 else if (top_y
< it
.last_visible_y
)
1240 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1242 /* We stopped on the last glyph of a display vector.
1243 Try and recompute. Hack alert! */
1244 if (charpos
< 2 || top
.charpos
>= charpos
)
1245 top_x
= it
.glyph_row
->x
;
1249 start_display (&it2
, w
, top
);
1250 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1251 get_next_display_element (&it2
);
1252 PRODUCE_GLYPHS (&it2
);
1253 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1254 || it2
.current_x
> it2
.last_visible_x
)
1255 top_x
= it
.glyph_row
->x
;
1258 top_x
= it2
.current_x
;
1259 top_y
= it2
.current_y
;
1265 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1266 *rtop
= max (0, window_top_y
- top_y
);
1267 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1268 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1269 - max (top_y
, window_top_y
)));
1278 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1279 move_it_by_lines (&it
, 1, 0);
1280 if (charpos
< IT_CHARPOS (it
)
1281 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1284 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1286 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1287 *rtop
= max (0, -it2
.current_y
);
1288 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1289 - it
.last_visible_y
));
1290 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1292 - max (it2
.current_y
,
1293 WINDOW_HEADER_LINE_HEIGHT (w
))));
1299 set_buffer_internal_1 (old_buffer
);
1301 current_header_line_height
= current_mode_line_height
= -1;
1303 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1304 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1307 /* Debugging code. */
1309 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1310 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1312 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1319 /* Return the next character from STR. Return in *LEN the length of
1320 the character. This is like STRING_CHAR_AND_LENGTH but never
1321 returns an invalid character. If we find one, we return a `?', but
1322 with the length of the invalid character. */
1325 string_char_and_length (const unsigned char *str
, int *len
)
1329 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1330 if (!CHAR_VALID_P (c
, 1))
1331 /* We may not change the length here because other places in Emacs
1332 don't use this function, i.e. they silently accept invalid
1341 /* Given a position POS containing a valid character and byte position
1342 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1344 static struct text_pos
1345 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1347 xassert (STRINGP (string
) && nchars
>= 0);
1349 if (STRING_MULTIBYTE (string
))
1351 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1356 string_char_and_length (p
, &len
);
1359 BYTEPOS (pos
) += len
;
1363 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1369 /* Value is the text position, i.e. character and byte position,
1370 for character position CHARPOS in STRING. */
1372 static INLINE
struct text_pos
1373 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1375 struct text_pos pos
;
1376 xassert (STRINGP (string
));
1377 xassert (charpos
>= 0);
1378 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1383 /* Value is a text position, i.e. character and byte position, for
1384 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1385 means recognize multibyte characters. */
1387 static struct text_pos
1388 c_string_pos (EMACS_INT charpos
, const unsigned char *s
, int multibyte_p
)
1390 struct text_pos pos
;
1392 xassert (s
!= NULL
);
1393 xassert (charpos
>= 0);
1399 SET_TEXT_POS (pos
, 0, 0);
1402 string_char_and_length (s
, &len
);
1405 BYTEPOS (pos
) += len
;
1409 SET_TEXT_POS (pos
, charpos
, charpos
);
1415 /* Value is the number of characters in C string S. MULTIBYTE_P
1416 non-zero means recognize multibyte characters. */
1419 number_of_chars (const unsigned char *s
, int multibyte_p
)
1425 EMACS_INT rest
= strlen (s
);
1427 unsigned char *p
= (unsigned char *) s
;
1429 for (nchars
= 0; rest
> 0; ++nchars
)
1431 string_char_and_length (p
, &len
);
1432 rest
-= len
, p
+= len
;
1436 nchars
= strlen (s
);
1442 /* Compute byte position NEWPOS->bytepos corresponding to
1443 NEWPOS->charpos. POS is a known position in string STRING.
1444 NEWPOS->charpos must be >= POS.charpos. */
1447 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1449 xassert (STRINGP (string
));
1450 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1452 if (STRING_MULTIBYTE (string
))
1453 *newpos
= string_pos_nchars_ahead (pos
, string
,
1454 CHARPOS (*newpos
) - CHARPOS (pos
));
1456 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1460 Return an estimation of the pixel height of mode or header lines on
1461 frame F. FACE_ID specifies what line's height to estimate. */
1464 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1466 #ifdef HAVE_WINDOW_SYSTEM
1467 if (FRAME_WINDOW_P (f
))
1469 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1471 /* This function is called so early when Emacs starts that the face
1472 cache and mode line face are not yet initialized. */
1473 if (FRAME_FACE_CACHE (f
))
1475 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1479 height
= FONT_HEIGHT (face
->font
);
1480 if (face
->box_line_width
> 0)
1481 height
+= 2 * face
->box_line_width
;
1492 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1493 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1494 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1495 not force the value into range. */
1498 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1499 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1502 #ifdef HAVE_WINDOW_SYSTEM
1503 if (FRAME_WINDOW_P (f
))
1505 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1506 even for negative values. */
1508 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1510 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1512 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1513 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1516 STORE_NATIVE_RECT (*bounds
,
1517 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1518 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1519 FRAME_COLUMN_WIDTH (f
) - 1,
1520 FRAME_LINE_HEIGHT (f
) - 1);
1526 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1527 pix_x
= FRAME_TOTAL_COLS (f
);
1531 else if (pix_y
> FRAME_LINES (f
))
1532 pix_y
= FRAME_LINES (f
);
1542 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1543 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1544 can't tell the positions because W's display is not up to date,
1548 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1549 int *frame_x
, int *frame_y
)
1551 #ifdef HAVE_WINDOW_SYSTEM
1552 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1556 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1557 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1559 if (display_completed
)
1561 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1562 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1563 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1569 hpos
+= glyph
->pixel_width
;
1573 /* If first glyph is partially visible, its first visible position is still 0. */
1585 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1586 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1597 /* Find the glyph under window-relative coordinates X/Y in window W.
1598 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1599 strings. Return in *HPOS and *VPOS the row and column number of
1600 the glyph found. Return in *AREA the glyph area containing X.
1601 Value is a pointer to the glyph found or null if X/Y is not on
1602 text, or we can't tell because W's current matrix is not up to
1607 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1608 int *dx
, int *dy
, int *area
)
1610 struct glyph
*glyph
, *end
;
1611 struct glyph_row
*row
= NULL
;
1614 /* Find row containing Y. Give up if some row is not enabled. */
1615 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1617 row
= MATRIX_ROW (w
->current_matrix
, i
);
1618 if (!row
->enabled_p
)
1620 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1627 /* Give up if Y is not in the window. */
1628 if (i
== w
->current_matrix
->nrows
)
1631 /* Get the glyph area containing X. */
1632 if (w
->pseudo_window_p
)
1639 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1641 *area
= LEFT_MARGIN_AREA
;
1642 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1644 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1647 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1651 *area
= RIGHT_MARGIN_AREA
;
1652 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1656 /* Find glyph containing X. */
1657 glyph
= row
->glyphs
[*area
];
1658 end
= glyph
+ row
->used
[*area
];
1660 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1662 x
-= glyph
->pixel_width
;
1672 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1675 *hpos
= glyph
- row
->glyphs
[*area
];
1680 Convert frame-relative x/y to coordinates relative to window W.
1681 Takes pseudo-windows into account. */
1684 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1686 if (w
->pseudo_window_p
)
1688 /* A pseudo-window is always full-width, and starts at the
1689 left edge of the frame, plus a frame border. */
1690 struct frame
*f
= XFRAME (w
->frame
);
1691 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1692 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1696 *x
-= WINDOW_LEFT_EDGE_X (w
);
1697 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1701 #ifdef HAVE_WINDOW_SYSTEM
1704 Return in RECTS[] at most N clipping rectangles for glyph string S.
1705 Return the number of stored rectangles. */
1708 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1715 if (s
->row
->full_width_p
)
1717 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1718 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1719 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1721 /* Unless displaying a mode or menu bar line, which are always
1722 fully visible, clip to the visible part of the row. */
1723 if (s
->w
->pseudo_window_p
)
1724 r
.height
= s
->row
->visible_height
;
1726 r
.height
= s
->height
;
1730 /* This is a text line that may be partially visible. */
1731 r
.x
= window_box_left (s
->w
, s
->area
);
1732 r
.width
= window_box_width (s
->w
, s
->area
);
1733 r
.height
= s
->row
->visible_height
;
1737 if (r
.x
< s
->clip_head
->x
)
1739 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1740 r
.width
-= s
->clip_head
->x
- r
.x
;
1743 r
.x
= s
->clip_head
->x
;
1746 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1748 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1749 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1754 /* If S draws overlapping rows, it's sufficient to use the top and
1755 bottom of the window for clipping because this glyph string
1756 intentionally draws over other lines. */
1757 if (s
->for_overlaps
)
1759 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1760 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1762 /* Alas, the above simple strategy does not work for the
1763 environments with anti-aliased text: if the same text is
1764 drawn onto the same place multiple times, it gets thicker.
1765 If the overlap we are processing is for the erased cursor, we
1766 take the intersection with the rectagle of the cursor. */
1767 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1769 XRectangle rc
, r_save
= r
;
1771 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1772 rc
.y
= s
->w
->phys_cursor
.y
;
1773 rc
.width
= s
->w
->phys_cursor_width
;
1774 rc
.height
= s
->w
->phys_cursor_height
;
1776 x_intersect_rectangles (&r_save
, &rc
, &r
);
1781 /* Don't use S->y for clipping because it doesn't take partially
1782 visible lines into account. For example, it can be negative for
1783 partially visible lines at the top of a window. */
1784 if (!s
->row
->full_width_p
1785 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1786 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1788 r
.y
= max (0, s
->row
->y
);
1791 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1793 /* If drawing the cursor, don't let glyph draw outside its
1794 advertised boundaries. Cleartype does this under some circumstances. */
1795 if (s
->hl
== DRAW_CURSOR
)
1797 struct glyph
*glyph
= s
->first_glyph
;
1802 r
.width
-= s
->x
- r
.x
;
1805 r
.width
= min (r
.width
, glyph
->pixel_width
);
1807 /* If r.y is below window bottom, ensure that we still see a cursor. */
1808 height
= min (glyph
->ascent
+ glyph
->descent
,
1809 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1810 max_y
= window_text_bottom_y (s
->w
) - height
;
1811 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1812 if (s
->ybase
- glyph
->ascent
> max_y
)
1819 /* Don't draw cursor glyph taller than our actual glyph. */
1820 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1821 if (height
< r
.height
)
1823 max_y
= r
.y
+ r
.height
;
1824 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1825 r
.height
= min (max_y
- r
.y
, height
);
1832 XRectangle r_save
= r
;
1834 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1838 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1839 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1841 #ifdef CONVERT_FROM_XRECT
1842 CONVERT_FROM_XRECT (r
, *rects
);
1850 /* If we are processing overlapping and allowed to return
1851 multiple clipping rectangles, we exclude the row of the glyph
1852 string from the clipping rectangle. This is to avoid drawing
1853 the same text on the environment with anti-aliasing. */
1854 #ifdef CONVERT_FROM_XRECT
1857 XRectangle
*rs
= rects
;
1859 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1861 if (s
->for_overlaps
& OVERLAPS_PRED
)
1864 if (r
.y
+ r
.height
> row_y
)
1867 rs
[i
].height
= row_y
- r
.y
;
1873 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1876 if (r
.y
< row_y
+ s
->row
->visible_height
)
1878 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1880 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1881 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1890 #ifdef CONVERT_FROM_XRECT
1891 for (i
= 0; i
< n
; i
++)
1892 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1899 Return in *NR the clipping rectangle for glyph string S. */
1902 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1904 get_glyph_string_clip_rects (s
, nr
, 1);
1909 Return the position and height of the phys cursor in window W.
1910 Set w->phys_cursor_width to width of phys cursor.
1914 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1915 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1917 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1918 int x
, y
, wd
, h
, h0
, y0
;
1920 /* Compute the width of the rectangle to draw. If on a stretch
1921 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1922 rectangle as wide as the glyph, but use a canonical character
1924 wd
= glyph
->pixel_width
- 1;
1925 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1929 x
= w
->phys_cursor
.x
;
1936 if (glyph
->type
== STRETCH_GLYPH
1937 && !x_stretch_cursor_p
)
1938 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1939 w
->phys_cursor_width
= wd
;
1941 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1943 /* If y is below window bottom, ensure that we still see a cursor. */
1944 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1946 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1947 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1949 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1952 h
= max (h
- (y0
- y
) + 1, h0
);
1957 y0
= window_text_bottom_y (w
) - h0
;
1965 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1966 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1971 * Remember which glyph the mouse is over.
1975 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1979 struct glyph_row
*r
, *gr
, *end_row
;
1980 enum window_part part
;
1981 enum glyph_row_area area
;
1982 int x
, y
, width
, height
;
1984 /* Try to determine frame pixel position and size of the glyph under
1985 frame pixel coordinates X/Y on frame F. */
1987 if (!f
->glyphs_initialized_p
1988 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1991 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1992 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1996 w
= XWINDOW (window
);
1997 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1998 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2000 x
= window_relative_x_coord (w
, part
, gx
);
2001 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2003 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2004 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2006 if (w
->pseudo_window_p
)
2009 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2015 case ON_LEFT_MARGIN
:
2016 area
= LEFT_MARGIN_AREA
;
2019 case ON_RIGHT_MARGIN
:
2020 area
= RIGHT_MARGIN_AREA
;
2023 case ON_HEADER_LINE
:
2025 gr
= (part
== ON_HEADER_LINE
2026 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2027 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2030 goto text_glyph_row_found
;
2037 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2038 if (r
->y
+ r
->height
> y
)
2044 text_glyph_row_found
:
2047 struct glyph
*g
= gr
->glyphs
[area
];
2048 struct glyph
*end
= g
+ gr
->used
[area
];
2050 height
= gr
->height
;
2051 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2052 if (gx
+ g
->pixel_width
> x
)
2057 if (g
->type
== IMAGE_GLYPH
)
2059 /* Don't remember when mouse is over image, as
2060 image may have hot-spots. */
2061 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2064 width
= g
->pixel_width
;
2068 /* Use nominal char spacing at end of line. */
2070 gx
+= (x
/ width
) * width
;
2073 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2074 gx
+= window_box_left_offset (w
, area
);
2078 /* Use nominal line height at end of window. */
2079 gx
= (x
/ width
) * width
;
2081 gy
+= (y
/ height
) * height
;
2085 case ON_LEFT_FRINGE
:
2086 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2087 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2088 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2089 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2092 case ON_RIGHT_FRINGE
:
2093 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2094 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2095 : window_box_right_offset (w
, TEXT_AREA
));
2096 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2100 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2102 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2103 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2104 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2106 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2110 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2111 if (r
->y
+ r
->height
> y
)
2118 height
= gr
->height
;
2121 /* Use nominal line height at end of window. */
2123 gy
+= (y
/ height
) * height
;
2130 /* If there is no glyph under the mouse, then we divide the screen
2131 into a grid of the smallest glyph in the frame, and use that
2134 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2135 round down even for negative values. */
2141 gx
= (gx
/ width
) * width
;
2142 gy
= (gy
/ height
) * height
;
2147 gx
+= WINDOW_LEFT_EDGE_X (w
);
2148 gy
+= WINDOW_TOP_EDGE_Y (w
);
2151 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2153 /* Visible feedback for debugging. */
2156 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2157 f
->output_data
.x
->normal_gc
,
2158 gx
, gy
, width
, height
);
2164 #endif /* HAVE_WINDOW_SYSTEM */
2167 /***********************************************************************
2168 Lisp form evaluation
2169 ***********************************************************************/
2171 /* Error handler for safe_eval and safe_call. */
2174 safe_eval_handler (Lisp_Object arg
)
2176 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2181 /* Evaluate SEXPR and return the result, or nil if something went
2182 wrong. Prevent redisplay during the evaluation. */
2184 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2185 Return the result, or nil if something went wrong. Prevent
2186 redisplay during the evaluation. */
2189 safe_call (int nargs
, Lisp_Object
*args
)
2193 if (inhibit_eval_during_redisplay
)
2197 int count
= SPECPDL_INDEX ();
2198 struct gcpro gcpro1
;
2201 gcpro1
.nvars
= nargs
;
2202 specbind (Qinhibit_redisplay
, Qt
);
2203 /* Use Qt to ensure debugger does not run,
2204 so there is no possibility of wanting to redisplay. */
2205 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2208 val
= unbind_to (count
, val
);
2215 /* Call function FN with one argument ARG.
2216 Return the result, or nil if something went wrong. */
2219 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2221 Lisp_Object args
[2];
2224 return safe_call (2, args
);
2227 static Lisp_Object Qeval
;
2230 safe_eval (Lisp_Object sexpr
)
2232 return safe_call1 (Qeval
, sexpr
);
2235 /* Call function FN with one argument ARG.
2236 Return the result, or nil if something went wrong. */
2239 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2241 Lisp_Object args
[3];
2245 return safe_call (3, args
);
2250 /***********************************************************************
2252 ***********************************************************************/
2256 /* Define CHECK_IT to perform sanity checks on iterators.
2257 This is for debugging. It is too slow to do unconditionally. */
2263 if (it
->method
== GET_FROM_STRING
)
2265 xassert (STRINGP (it
->string
));
2266 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2270 xassert (IT_STRING_CHARPOS (*it
) < 0);
2271 if (it
->method
== GET_FROM_BUFFER
)
2273 /* Check that character and byte positions agree. */
2274 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2279 xassert (it
->current
.dpvec_index
>= 0);
2281 xassert (it
->current
.dpvec_index
< 0);
2284 #define CHECK_IT(IT) check_it ((IT))
2288 #define CHECK_IT(IT) (void) 0
2295 /* Check that the window end of window W is what we expect it
2296 to be---the last row in the current matrix displaying text. */
2299 check_window_end (w
)
2302 if (!MINI_WINDOW_P (w
)
2303 && !NILP (w
->window_end_valid
))
2305 struct glyph_row
*row
;
2306 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2307 XFASTINT (w
->window_end_vpos
)),
2309 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2310 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2314 #define CHECK_WINDOW_END(W) check_window_end ((W))
2316 #else /* not GLYPH_DEBUG */
2318 #define CHECK_WINDOW_END(W) (void) 0
2320 #endif /* not GLYPH_DEBUG */
2324 /***********************************************************************
2325 Iterator initialization
2326 ***********************************************************************/
2328 /* Initialize IT for displaying current_buffer in window W, starting
2329 at character position CHARPOS. CHARPOS < 0 means that no buffer
2330 position is specified which is useful when the iterator is assigned
2331 a position later. BYTEPOS is the byte position corresponding to
2332 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2334 If ROW is not null, calls to produce_glyphs with IT as parameter
2335 will produce glyphs in that row.
2337 BASE_FACE_ID is the id of a base face to use. It must be one of
2338 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2339 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2340 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2342 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2343 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2344 will be initialized to use the corresponding mode line glyph row of
2345 the desired matrix of W. */
2348 init_iterator (struct it
*it
, struct window
*w
,
2349 EMACS_INT charpos
, EMACS_INT bytepos
,
2350 struct glyph_row
*row
, enum face_id base_face_id
)
2352 int highlight_region_p
;
2353 enum face_id remapped_base_face_id
= base_face_id
;
2355 /* Some precondition checks. */
2356 xassert (w
!= NULL
&& it
!= NULL
);
2357 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2360 /* If face attributes have been changed since the last redisplay,
2361 free realized faces now because they depend on face definitions
2362 that might have changed. Don't free faces while there might be
2363 desired matrices pending which reference these faces. */
2364 if (face_change_count
&& !inhibit_free_realized_faces
)
2366 face_change_count
= 0;
2367 free_all_realized_faces (Qnil
);
2370 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2371 if (! NILP (Vface_remapping_alist
))
2372 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2374 /* Use one of the mode line rows of W's desired matrix if
2378 if (base_face_id
== MODE_LINE_FACE_ID
2379 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2380 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2381 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2382 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2386 memset (it
, 0, sizeof *it
);
2387 it
->current
.overlay_string_index
= -1;
2388 it
->current
.dpvec_index
= -1;
2389 it
->base_face_id
= remapped_base_face_id
;
2391 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2393 /* The window in which we iterate over current_buffer: */
2394 XSETWINDOW (it
->window
, w
);
2396 it
->f
= XFRAME (w
->frame
);
2400 /* Extra space between lines (on window systems only). */
2401 if (base_face_id
== DEFAULT_FACE_ID
2402 && FRAME_WINDOW_P (it
->f
))
2404 if (NATNUMP (current_buffer
->extra_line_spacing
))
2405 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2406 else if (FLOATP (current_buffer
->extra_line_spacing
))
2407 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2408 * FRAME_LINE_HEIGHT (it
->f
));
2409 else if (it
->f
->extra_line_spacing
> 0)
2410 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2411 it
->max_extra_line_spacing
= 0;
2414 /* If realized faces have been removed, e.g. because of face
2415 attribute changes of named faces, recompute them. When running
2416 in batch mode, the face cache of the initial frame is null. If
2417 we happen to get called, make a dummy face cache. */
2418 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2419 init_frame_faces (it
->f
);
2420 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2421 recompute_basic_faces (it
->f
);
2423 /* Current value of the `slice', `space-width', and 'height' properties. */
2424 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2425 it
->space_width
= Qnil
;
2426 it
->font_height
= Qnil
;
2427 it
->override_ascent
= -1;
2429 /* Are control characters displayed as `^C'? */
2430 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2432 /* -1 means everything between a CR and the following line end
2433 is invisible. >0 means lines indented more than this value are
2435 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2436 ? XFASTINT (current_buffer
->selective_display
)
2437 : (!NILP (current_buffer
->selective_display
)
2439 it
->selective_display_ellipsis_p
2440 = !NILP (current_buffer
->selective_display_ellipses
);
2442 /* Display table to use. */
2443 it
->dp
= window_display_table (w
);
2445 /* Are multibyte characters enabled in current_buffer? */
2446 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2448 /* Do we need to reorder bidirectional text? Not if this is a
2449 unibyte buffer: by definition, none of the single-byte characters
2450 are strong R2L, so no reordering is needed. And bidi.c doesn't
2451 support unibyte buffers anyway. */
2453 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2455 /* Non-zero if we should highlight the region. */
2457 = (!NILP (Vtransient_mark_mode
)
2458 && !NILP (current_buffer
->mark_active
)
2459 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2461 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2462 start and end of a visible region in window IT->w. Set both to
2463 -1 to indicate no region. */
2464 if (highlight_region_p
2465 /* Maybe highlight only in selected window. */
2466 && (/* Either show region everywhere. */
2467 highlight_nonselected_windows
2468 /* Or show region in the selected window. */
2469 || w
== XWINDOW (selected_window
)
2470 /* Or show the region if we are in the mini-buffer and W is
2471 the window the mini-buffer refers to. */
2472 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2473 && WINDOWP (minibuf_selected_window
)
2474 && w
== XWINDOW (minibuf_selected_window
))))
2476 EMACS_INT charpos
= marker_position (current_buffer
->mark
);
2477 it
->region_beg_charpos
= min (PT
, charpos
);
2478 it
->region_end_charpos
= max (PT
, charpos
);
2481 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2483 /* Get the position at which the redisplay_end_trigger hook should
2484 be run, if it is to be run at all. */
2485 if (MARKERP (w
->redisplay_end_trigger
)
2486 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2487 it
->redisplay_end_trigger_charpos
2488 = marker_position (w
->redisplay_end_trigger
);
2489 else if (INTEGERP (w
->redisplay_end_trigger
))
2490 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2492 /* Correct bogus values of tab_width. */
2493 it
->tab_width
= XINT (current_buffer
->tab_width
);
2494 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2497 /* Are lines in the display truncated? */
2498 if (base_face_id
!= DEFAULT_FACE_ID
2499 || XINT (it
->w
->hscroll
)
2500 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2501 && ((!NILP (Vtruncate_partial_width_windows
)
2502 && !INTEGERP (Vtruncate_partial_width_windows
))
2503 || (INTEGERP (Vtruncate_partial_width_windows
)
2504 && (WINDOW_TOTAL_COLS (it
->w
)
2505 < XINT (Vtruncate_partial_width_windows
))))))
2506 it
->line_wrap
= TRUNCATE
;
2507 else if (NILP (current_buffer
->truncate_lines
))
2508 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2509 ? WINDOW_WRAP
: WORD_WRAP
;
2511 it
->line_wrap
= TRUNCATE
;
2513 /* Get dimensions of truncation and continuation glyphs. These are
2514 displayed as fringe bitmaps under X, so we don't need them for such
2516 if (!FRAME_WINDOW_P (it
->f
))
2518 if (it
->line_wrap
== TRUNCATE
)
2520 /* We will need the truncation glyph. */
2521 xassert (it
->glyph_row
== NULL
);
2522 produce_special_glyphs (it
, IT_TRUNCATION
);
2523 it
->truncation_pixel_width
= it
->pixel_width
;
2527 /* We will need the continuation glyph. */
2528 xassert (it
->glyph_row
== NULL
);
2529 produce_special_glyphs (it
, IT_CONTINUATION
);
2530 it
->continuation_pixel_width
= it
->pixel_width
;
2533 /* Reset these values to zero because the produce_special_glyphs
2534 above has changed them. */
2535 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2536 it
->phys_ascent
= it
->phys_descent
= 0;
2539 /* Set this after getting the dimensions of truncation and
2540 continuation glyphs, so that we don't produce glyphs when calling
2541 produce_special_glyphs, above. */
2542 it
->glyph_row
= row
;
2543 it
->area
= TEXT_AREA
;
2545 /* Forget any previous info about this row being reversed. */
2547 it
->glyph_row
->reversed_p
= 0;
2549 /* Get the dimensions of the display area. The display area
2550 consists of the visible window area plus a horizontally scrolled
2551 part to the left of the window. All x-values are relative to the
2552 start of this total display area. */
2553 if (base_face_id
!= DEFAULT_FACE_ID
)
2555 /* Mode lines, menu bar in terminal frames. */
2556 it
->first_visible_x
= 0;
2557 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2562 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2563 it
->last_visible_x
= (it
->first_visible_x
2564 + window_box_width (w
, TEXT_AREA
));
2566 /* If we truncate lines, leave room for the truncator glyph(s) at
2567 the right margin. Otherwise, leave room for the continuation
2568 glyph(s). Truncation and continuation glyphs are not inserted
2569 for window-based redisplay. */
2570 if (!FRAME_WINDOW_P (it
->f
))
2572 if (it
->line_wrap
== TRUNCATE
)
2573 it
->last_visible_x
-= it
->truncation_pixel_width
;
2575 it
->last_visible_x
-= it
->continuation_pixel_width
;
2578 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2579 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2582 /* Leave room for a border glyph. */
2583 if (!FRAME_WINDOW_P (it
->f
)
2584 && !WINDOW_RIGHTMOST_P (it
->w
))
2585 it
->last_visible_x
-= 1;
2587 it
->last_visible_y
= window_text_bottom_y (w
);
2589 /* For mode lines and alike, arrange for the first glyph having a
2590 left box line if the face specifies a box. */
2591 if (base_face_id
!= DEFAULT_FACE_ID
)
2595 it
->face_id
= remapped_base_face_id
;
2597 /* If we have a boxed mode line, make the first character appear
2598 with a left box line. */
2599 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2600 if (face
->box
!= FACE_NO_BOX
)
2601 it
->start_of_box_run_p
= 1;
2604 /* If we are to reorder bidirectional text, init the bidi
2608 /* Note the paragraph direction that this buffer wants to
2610 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2611 it
->paragraph_embedding
= L2R
;
2612 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2613 it
->paragraph_embedding
= R2L
;
2615 it
->paragraph_embedding
= NEUTRAL_DIR
;
2616 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2619 /* If a buffer position was specified, set the iterator there,
2620 getting overlays and face properties from that position. */
2621 if (charpos
>= BUF_BEG (current_buffer
))
2623 it
->end_charpos
= ZV
;
2625 IT_CHARPOS (*it
) = charpos
;
2627 /* Compute byte position if not specified. */
2628 if (bytepos
< charpos
)
2629 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2631 IT_BYTEPOS (*it
) = bytepos
;
2633 it
->start
= it
->current
;
2635 /* Compute faces etc. */
2636 reseat (it
, it
->current
.pos
, 1);
2643 /* Initialize IT for the display of window W with window start POS. */
2646 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2648 struct glyph_row
*row
;
2649 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2651 row
= w
->desired_matrix
->rows
+ first_vpos
;
2652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2653 it
->first_vpos
= first_vpos
;
2655 /* Don't reseat to previous visible line start if current start
2656 position is in a string or image. */
2657 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2659 int start_at_line_beg_p
;
2660 int first_y
= it
->current_y
;
2662 /* If window start is not at a line start, skip forward to POS to
2663 get the correct continuation lines width. */
2664 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2665 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2666 if (!start_at_line_beg_p
)
2670 reseat_at_previous_visible_line_start (it
);
2671 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2673 new_x
= it
->current_x
+ it
->pixel_width
;
2675 /* If lines are continued, this line may end in the middle
2676 of a multi-glyph character (e.g. a control character
2677 displayed as \003, or in the middle of an overlay
2678 string). In this case move_it_to above will not have
2679 taken us to the start of the continuation line but to the
2680 end of the continued line. */
2681 if (it
->current_x
> 0
2682 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2683 && (/* And glyph doesn't fit on the line. */
2684 new_x
> it
->last_visible_x
2685 /* Or it fits exactly and we're on a window
2687 || (new_x
== it
->last_visible_x
2688 && FRAME_WINDOW_P (it
->f
))))
2690 if (it
->current
.dpvec_index
>= 0
2691 || it
->current
.overlay_string_index
>= 0)
2693 set_iterator_to_next (it
, 1);
2694 move_it_in_display_line_to (it
, -1, -1, 0);
2697 it
->continuation_lines_width
+= it
->current_x
;
2700 /* We're starting a new display line, not affected by the
2701 height of the continued line, so clear the appropriate
2702 fields in the iterator structure. */
2703 it
->max_ascent
= it
->max_descent
= 0;
2704 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2706 it
->current_y
= first_y
;
2708 it
->current_x
= it
->hpos
= 0;
2714 /* Return 1 if POS is a position in ellipses displayed for invisible
2715 text. W is the window we display, for text property lookup. */
2718 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2720 Lisp_Object prop
, window
;
2722 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2724 /* If POS specifies a position in a display vector, this might
2725 be for an ellipsis displayed for invisible text. We won't
2726 get the iterator set up for delivering that ellipsis unless
2727 we make sure that it gets aware of the invisible text. */
2728 if (pos
->dpvec_index
>= 0
2729 && pos
->overlay_string_index
< 0
2730 && CHARPOS (pos
->string_pos
) < 0
2732 && (XSETWINDOW (window
, w
),
2733 prop
= Fget_char_property (make_number (charpos
),
2734 Qinvisible
, window
),
2735 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2737 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2739 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2746 /* Initialize IT for stepping through current_buffer in window W,
2747 starting at position POS that includes overlay string and display
2748 vector/ control character translation position information. Value
2749 is zero if there are overlay strings with newlines at POS. */
2752 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2754 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2755 int i
, overlay_strings_with_newlines
= 0;
2757 /* If POS specifies a position in a display vector, this might
2758 be for an ellipsis displayed for invisible text. We won't
2759 get the iterator set up for delivering that ellipsis unless
2760 we make sure that it gets aware of the invisible text. */
2761 if (in_ellipses_for_invisible_text_p (pos
, w
))
2767 /* Keep in mind: the call to reseat in init_iterator skips invisible
2768 text, so we might end up at a position different from POS. This
2769 is only a problem when POS is a row start after a newline and an
2770 overlay starts there with an after-string, and the overlay has an
2771 invisible property. Since we don't skip invisible text in
2772 display_line and elsewhere immediately after consuming the
2773 newline before the row start, such a POS will not be in a string,
2774 but the call to init_iterator below will move us to the
2776 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2778 /* This only scans the current chunk -- it should scan all chunks.
2779 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2780 to 16 in 22.1 to make this a lesser problem. */
2781 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2783 const char *s
= SDATA (it
->overlay_strings
[i
]);
2784 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2786 while (s
< e
&& *s
!= '\n')
2791 overlay_strings_with_newlines
= 1;
2796 /* If position is within an overlay string, set up IT to the right
2798 if (pos
->overlay_string_index
>= 0)
2802 /* If the first overlay string happens to have a `display'
2803 property for an image, the iterator will be set up for that
2804 image, and we have to undo that setup first before we can
2805 correct the overlay string index. */
2806 if (it
->method
== GET_FROM_IMAGE
)
2809 /* We already have the first chunk of overlay strings in
2810 IT->overlay_strings. Load more until the one for
2811 pos->overlay_string_index is in IT->overlay_strings. */
2812 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2814 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2815 it
->current
.overlay_string_index
= 0;
2818 load_overlay_strings (it
, 0);
2819 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2823 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2824 relative_index
= (it
->current
.overlay_string_index
2825 % OVERLAY_STRING_CHUNK_SIZE
);
2826 it
->string
= it
->overlay_strings
[relative_index
];
2827 xassert (STRINGP (it
->string
));
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 it
->method
= GET_FROM_STRING
;
2832 if (CHARPOS (pos
->string_pos
) >= 0)
2834 /* Recorded position is not in an overlay string, but in another
2835 string. This can only be a string from a `display' property.
2836 IT should already be filled with that string. */
2837 it
->current
.string_pos
= pos
->string_pos
;
2838 xassert (STRINGP (it
->string
));
2841 /* Restore position in display vector translations, control
2842 character translations or ellipses. */
2843 if (pos
->dpvec_index
>= 0)
2845 if (it
->dpvec
== NULL
)
2846 get_next_display_element (it
);
2847 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2848 it
->current
.dpvec_index
= pos
->dpvec_index
;
2852 return !overlay_strings_with_newlines
;
2856 /* Initialize IT for stepping through current_buffer in window W
2857 starting at ROW->start. */
2860 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2862 init_from_display_pos (it
, w
, &row
->start
);
2863 it
->start
= row
->start
;
2864 it
->continuation_lines_width
= row
->continuation_lines_width
;
2869 /* Initialize IT for stepping through current_buffer in window W
2870 starting in the line following ROW, i.e. starting at ROW->end.
2871 Value is zero if there are overlay strings with newlines at ROW's
2875 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2879 if (init_from_display_pos (it
, w
, &row
->end
))
2881 if (row
->continued_p
)
2882 it
->continuation_lines_width
2883 = row
->continuation_lines_width
+ row
->pixel_width
;
2894 /***********************************************************************
2896 ***********************************************************************/
2898 /* Called when IT reaches IT->stop_charpos. Handle text property and
2899 overlay changes. Set IT->stop_charpos to the next position where
2903 handle_stop (struct it
*it
)
2905 enum prop_handled handled
;
2906 int handle_overlay_change_p
;
2910 it
->current
.dpvec_index
= -1;
2911 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2912 it
->ignore_overlay_strings_at_pos_p
= 0;
2915 /* Use face of preceding text for ellipsis (if invisible) */
2916 if (it
->selective_display_ellipsis_p
)
2917 it
->saved_face_id
= it
->face_id
;
2921 handled
= HANDLED_NORMALLY
;
2923 /* Call text property handlers. */
2924 for (p
= it_props
; p
->handler
; ++p
)
2926 handled
= p
->handler (it
);
2928 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2930 else if (handled
== HANDLED_RETURN
)
2932 /* We still want to show before and after strings from
2933 overlays even if the actual buffer text is replaced. */
2934 if (!handle_overlay_change_p
2936 || !get_overlay_strings_1 (it
, 0, 0))
2939 setup_for_ellipsis (it
, 0);
2940 /* When handling a display spec, we might load an
2941 empty string. In that case, discard it here. We
2942 used to discard it in handle_single_display_spec,
2943 but that causes get_overlay_strings_1, above, to
2944 ignore overlay strings that we must check. */
2945 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2949 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 it
->ignore_overlay_strings_at_pos_p
= 1;
2954 it
->string_from_display_prop_p
= 0;
2955 handle_overlay_change_p
= 0;
2957 handled
= HANDLED_RECOMPUTE_PROPS
;
2960 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2961 handle_overlay_change_p
= 0;
2964 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2966 /* Don't check for overlay strings below when set to deliver
2967 characters from a display vector. */
2968 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2969 handle_overlay_change_p
= 0;
2971 /* Handle overlay changes.
2972 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2973 if it finds overlays. */
2974 if (handle_overlay_change_p
)
2975 handled
= handle_overlay_change (it
);
2980 setup_for_ellipsis (it
, 0);
2984 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2986 /* Determine where to stop next. */
2987 if (handled
== HANDLED_NORMALLY
)
2988 compute_stop_pos (it
);
2992 /* Compute IT->stop_charpos from text property and overlay change
2993 information for IT's current position. */
2996 compute_stop_pos (struct it
*it
)
2998 register INTERVAL iv
, next_iv
;
2999 Lisp_Object object
, limit
, position
;
3000 EMACS_INT charpos
, bytepos
;
3002 /* If nowhere else, stop at the end. */
3003 it
->stop_charpos
= it
->end_charpos
;
3005 if (STRINGP (it
->string
))
3007 /* Strings are usually short, so don't limit the search for
3009 object
= it
->string
;
3011 charpos
= IT_STRING_CHARPOS (*it
);
3012 bytepos
= IT_STRING_BYTEPOS (*it
);
3018 /* If next overlay change is in front of the current stop pos
3019 (which is IT->end_charpos), stop there. Note: value of
3020 next_overlay_change is point-max if no overlay change
3022 charpos
= IT_CHARPOS (*it
);
3023 bytepos
= IT_BYTEPOS (*it
);
3024 pos
= next_overlay_change (charpos
);
3025 if (pos
< it
->stop_charpos
)
3026 it
->stop_charpos
= pos
;
3028 /* If showing the region, we have to stop at the region
3029 start or end because the face might change there. */
3030 if (it
->region_beg_charpos
> 0)
3032 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3034 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3035 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3038 /* Set up variables for computing the stop position from text
3039 property changes. */
3040 XSETBUFFER (object
, current_buffer
);
3041 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3044 /* Get the interval containing IT's position. Value is a null
3045 interval if there isn't such an interval. */
3046 position
= make_number (charpos
);
3047 iv
= validate_interval_range (object
, &position
, &position
, 0);
3048 if (!NULL_INTERVAL_P (iv
))
3050 Lisp_Object values_here
[LAST_PROP_IDX
];
3053 /* Get properties here. */
3054 for (p
= it_props
; p
->handler
; ++p
)
3055 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3057 /* Look for an interval following iv that has different
3059 for (next_iv
= next_interval (iv
);
3060 (!NULL_INTERVAL_P (next_iv
)
3062 || XFASTINT (limit
) > next_iv
->position
));
3063 next_iv
= next_interval (next_iv
))
3065 for (p
= it_props
; p
->handler
; ++p
)
3067 Lisp_Object new_value
;
3069 new_value
= textget (next_iv
->plist
, *p
->name
);
3070 if (!EQ (values_here
[p
->idx
], new_value
))
3078 if (!NULL_INTERVAL_P (next_iv
))
3080 if (INTEGERP (limit
)
3081 && next_iv
->position
>= XFASTINT (limit
))
3082 /* No text property change up to limit. */
3083 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3085 /* Text properties change in next_iv. */
3086 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3090 if (it
->cmp_it
.id
< 0)
3092 EMACS_INT stoppos
= it
->end_charpos
;
3094 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3096 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3097 stoppos
, it
->string
);
3100 xassert (STRINGP (it
->string
)
3101 || (it
->stop_charpos
>= BEGV
3102 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3106 /* Return the position of the next overlay change after POS in
3107 current_buffer. Value is point-max if no overlay change
3108 follows. This is like `next-overlay-change' but doesn't use
3112 next_overlay_change (EMACS_INT pos
)
3116 Lisp_Object
*overlays
;
3119 /* Get all overlays at the given position. */
3120 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3122 /* If any of these overlays ends before endpos,
3123 use its ending point instead. */
3124 for (i
= 0; i
< noverlays
; ++i
)
3129 oend
= OVERLAY_END (overlays
[i
]);
3130 oendpos
= OVERLAY_POSITION (oend
);
3131 endpos
= min (endpos
, oendpos
);
3139 /***********************************************************************
3141 ***********************************************************************/
3143 /* Handle changes in the `fontified' property of the current buffer by
3144 calling hook functions from Qfontification_functions to fontify
3147 static enum prop_handled
3148 handle_fontified_prop (struct it
*it
)
3150 Lisp_Object prop
, pos
;
3151 enum prop_handled handled
= HANDLED_NORMALLY
;
3153 if (!NILP (Vmemory_full
))
3156 /* Get the value of the `fontified' property at IT's current buffer
3157 position. (The `fontified' property doesn't have a special
3158 meaning in strings.) If the value is nil, call functions from
3159 Qfontification_functions. */
3160 if (!STRINGP (it
->string
)
3162 && !NILP (Vfontification_functions
)
3163 && !NILP (Vrun_hooks
)
3164 && (pos
= make_number (IT_CHARPOS (*it
)),
3165 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3166 /* Ignore the special cased nil value always present at EOB since
3167 no amount of fontifying will be able to change it. */
3168 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3170 int count
= SPECPDL_INDEX ();
3173 val
= Vfontification_functions
;
3174 specbind (Qfontification_functions
, Qnil
);
3176 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3177 safe_call1 (val
, pos
);
3180 Lisp_Object globals
, fn
;
3181 struct gcpro gcpro1
, gcpro2
;
3184 GCPRO2 (val
, globals
);
3186 for (; CONSP (val
); val
= XCDR (val
))
3192 /* A value of t indicates this hook has a local
3193 binding; it means to run the global binding too.
3194 In a global value, t should not occur. If it
3195 does, we must ignore it to avoid an endless
3197 for (globals
= Fdefault_value (Qfontification_functions
);
3199 globals
= XCDR (globals
))
3201 fn
= XCAR (globals
);
3203 safe_call1 (fn
, pos
);
3207 safe_call1 (fn
, pos
);
3213 unbind_to (count
, Qnil
);
3215 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3216 something. This avoids an endless loop if they failed to
3217 fontify the text for which reason ever. */
3218 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3219 handled
= HANDLED_RECOMPUTE_PROPS
;
3227 /***********************************************************************
3229 ***********************************************************************/
3231 /* Set up iterator IT from face properties at its current position.
3232 Called from handle_stop. */
3234 static enum prop_handled
3235 handle_face_prop (struct it
*it
)
3238 EMACS_INT next_stop
;
3240 if (!STRINGP (it
->string
))
3243 = face_at_buffer_position (it
->w
,
3245 it
->region_beg_charpos
,
3246 it
->region_end_charpos
,
3249 + TEXT_PROP_DISTANCE_LIMIT
),
3250 0, it
->base_face_id
);
3252 /* Is this a start of a run of characters with box face?
3253 Caveat: this can be called for a freshly initialized
3254 iterator; face_id is -1 in this case. We know that the new
3255 face will not change until limit, i.e. if the new face has a
3256 box, all characters up to limit will have one. But, as
3257 usual, we don't know whether limit is really the end. */
3258 if (new_face_id
!= it
->face_id
)
3260 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3262 /* If new face has a box but old face has not, this is
3263 the start of a run of characters with box, i.e. it has
3264 a shadow on the left side. The value of face_id of the
3265 iterator will be -1 if this is the initial call that gets
3266 the face. In this case, we have to look in front of IT's
3267 position and see whether there is a face != new_face_id. */
3268 it
->start_of_box_run_p
3269 = (new_face
->box
!= FACE_NO_BOX
3270 && (it
->face_id
>= 0
3271 || IT_CHARPOS (*it
) == BEG
3272 || new_face_id
!= face_before_it_pos (it
)));
3273 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3281 Lisp_Object from_overlay
3282 = (it
->current
.overlay_string_index
>= 0
3283 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3286 /* See if we got to this string directly or indirectly from
3287 an overlay property. That includes the before-string or
3288 after-string of an overlay, strings in display properties
3289 provided by an overlay, their text properties, etc.
3291 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3292 if (! NILP (from_overlay
))
3293 for (i
= it
->sp
- 1; i
>= 0; i
--)
3295 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3297 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3298 else if (! NILP (it
->stack
[i
].from_overlay
))
3299 from_overlay
= it
->stack
[i
].from_overlay
;
3301 if (!NILP (from_overlay
))
3305 if (! NILP (from_overlay
))
3307 bufpos
= IT_CHARPOS (*it
);
3308 /* For a string from an overlay, the base face depends
3309 only on text properties and ignores overlays. */
3311 = face_for_overlay_string (it
->w
,
3313 it
->region_beg_charpos
,
3314 it
->region_end_charpos
,
3317 + TEXT_PROP_DISTANCE_LIMIT
),
3325 /* For strings from a `display' property, use the face at
3326 IT's current buffer position as the base face to merge
3327 with, so that overlay strings appear in the same face as
3328 surrounding text, unless they specify their own
3330 base_face_id
= underlying_face_id (it
);
3333 new_face_id
= face_at_string_position (it
->w
,
3335 IT_STRING_CHARPOS (*it
),
3337 it
->region_beg_charpos
,
3338 it
->region_end_charpos
,
3342 /* Is this a start of a run of characters with box? Caveat:
3343 this can be called for a freshly allocated iterator; face_id
3344 is -1 is this case. We know that the new face will not
3345 change until the next check pos, i.e. if the new face has a
3346 box, all characters up to that position will have a
3347 box. But, as usual, we don't know whether that position
3348 is really the end. */
3349 if (new_face_id
!= it
->face_id
)
3351 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3352 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3354 /* If new face has a box but old face hasn't, this is the
3355 start of a run of characters with box, i.e. it has a
3356 shadow on the left side. */
3357 it
->start_of_box_run_p
3358 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3359 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3363 it
->face_id
= new_face_id
;
3364 return HANDLED_NORMALLY
;
3368 /* Return the ID of the face ``underlying'' IT's current position,
3369 which is in a string. If the iterator is associated with a
3370 buffer, return the face at IT's current buffer position.
3371 Otherwise, use the iterator's base_face_id. */
3374 underlying_face_id (struct it
*it
)
3376 int face_id
= it
->base_face_id
, i
;
3378 xassert (STRINGP (it
->string
));
3380 for (i
= it
->sp
- 1; i
>= 0; --i
)
3381 if (NILP (it
->stack
[i
].string
))
3382 face_id
= it
->stack
[i
].face_id
;
3388 /* Compute the face one character before or after the current position
3389 of IT. BEFORE_P non-zero means get the face in front of IT's
3390 position. Value is the id of the face. */
3393 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3396 EMACS_INT next_check_charpos
;
3397 struct text_pos pos
;
3399 xassert (it
->s
== NULL
);
3401 if (STRINGP (it
->string
))
3406 /* No face change past the end of the string (for the case
3407 we are padding with spaces). No face change before the
3409 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3410 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3413 /* Set pos to the position before or after IT's current position. */
3415 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3417 /* For composition, we must check the character after the
3419 pos
= (it
->what
== IT_COMPOSITION
3420 ? string_pos (IT_STRING_CHARPOS (*it
)
3421 + it
->cmp_it
.nchars
, it
->string
)
3422 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3424 if (it
->current
.overlay_string_index
>= 0)
3425 bufpos
= IT_CHARPOS (*it
);
3429 base_face_id
= underlying_face_id (it
);
3431 /* Get the face for ASCII, or unibyte. */
3432 face_id
= face_at_string_position (it
->w
,
3436 it
->region_beg_charpos
,
3437 it
->region_end_charpos
,
3438 &next_check_charpos
,
3441 /* Correct the face for charsets different from ASCII. Do it
3442 for the multibyte case only. The face returned above is
3443 suitable for unibyte text if IT->string is unibyte. */
3444 if (STRING_MULTIBYTE (it
->string
))
3446 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3448 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3450 c
= string_char_and_length (p
, &len
);
3451 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3456 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3457 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3460 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3461 pos
= it
->current
.pos
;
3464 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3467 if (it
->what
== IT_COMPOSITION
)
3468 /* For composition, we must check the position after the
3470 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3472 INC_TEXT_POS (pos
, it
->multibyte_p
);
3475 /* Determine face for CHARSET_ASCII, or unibyte. */
3476 face_id
= face_at_buffer_position (it
->w
,
3478 it
->region_beg_charpos
,
3479 it
->region_end_charpos
,
3480 &next_check_charpos
,
3483 /* Correct the face for charsets different from ASCII. Do it
3484 for the multibyte case only. The face returned above is
3485 suitable for unibyte text if current_buffer is unibyte. */
3486 if (it
->multibyte_p
)
3488 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3489 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3490 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3499 /***********************************************************************
3501 ***********************************************************************/
3503 /* Set up iterator IT from invisible properties at its current
3504 position. Called from handle_stop. */
3506 static enum prop_handled
3507 handle_invisible_prop (struct it
*it
)
3509 enum prop_handled handled
= HANDLED_NORMALLY
;
3511 if (STRINGP (it
->string
))
3513 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3515 /* Get the value of the invisible text property at the
3516 current position. Value will be nil if there is no such
3518 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3519 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3522 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3524 handled
= HANDLED_RECOMPUTE_PROPS
;
3526 /* Get the position at which the next change of the
3527 invisible text property can be found in IT->string.
3528 Value will be nil if the property value is the same for
3529 all the rest of IT->string. */
3530 XSETINT (limit
, SCHARS (it
->string
));
3531 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3534 /* Text at current position is invisible. The next
3535 change in the property is at position end_charpos.
3536 Move IT's current position to that position. */
3537 if (INTEGERP (end_charpos
)
3538 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3540 struct text_pos old
;
3541 old
= it
->current
.string_pos
;
3542 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3543 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3547 /* The rest of the string is invisible. If this is an
3548 overlay string, proceed with the next overlay string
3549 or whatever comes and return a character from there. */
3550 if (it
->current
.overlay_string_index
>= 0)
3552 next_overlay_string (it
);
3553 /* Don't check for overlay strings when we just
3554 finished processing them. */
3555 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3559 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3560 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3568 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3569 Lisp_Object pos
, prop
, overlay
;
3571 /* First of all, is there invisible text at this position? */
3572 tem
= start_charpos
= IT_CHARPOS (*it
);
3573 pos
= make_number (tem
);
3574 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3576 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3578 /* If we are on invisible text, skip over it. */
3579 if (invis_p
&& start_charpos
< it
->end_charpos
)
3581 /* Record whether we have to display an ellipsis for the
3583 int display_ellipsis_p
= invis_p
== 2;
3585 handled
= HANDLED_RECOMPUTE_PROPS
;
3587 /* Loop skipping over invisible text. The loop is left at
3588 ZV or with IT on the first char being visible again. */
3591 /* Try to skip some invisible text. Return value is the
3592 position reached which can be equal to where we start
3593 if there is nothing invisible there. This skips both
3594 over invisible text properties and overlays with
3595 invisible property. */
3596 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3598 /* If we skipped nothing at all we weren't at invisible
3599 text in the first place. If everything to the end of
3600 the buffer was skipped, end the loop. */
3601 if (newpos
== tem
|| newpos
>= ZV
)
3605 /* We skipped some characters but not necessarily
3606 all there are. Check if we ended up on visible
3607 text. Fget_char_property returns the property of
3608 the char before the given position, i.e. if we
3609 get invis_p = 0, this means that the char at
3610 newpos is visible. */
3611 pos
= make_number (newpos
);
3612 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3613 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3616 /* If we ended up on invisible text, proceed to
3617 skip starting with next_stop. */
3621 /* If there are adjacent invisible texts, don't lose the
3622 second one's ellipsis. */
3624 display_ellipsis_p
= 1;
3628 /* The position newpos is now either ZV or on visible text. */
3629 if (it
->bidi_p
&& newpos
< ZV
)
3631 /* With bidi iteration, the region of invisible text
3632 could start and/or end in the middle of a non-base
3633 embedding level. Therefore, we need to skip
3634 invisible text using the bidi iterator, starting at
3635 IT's current position, until we find ourselves
3636 outside the invisible text. Skipping invisible text
3637 _after_ bidi iteration avoids affecting the visual
3638 order of the displayed text when invisible properties
3639 are added or removed. */
3640 if (it
->bidi_it
.first_elt
)
3642 /* If we were `reseat'ed to a new paragraph,
3643 determine the paragraph base direction. We need
3644 to do it now because next_element_from_buffer may
3645 not have a chance to do it, if we are going to
3646 skip any text at the beginning, which resets the
3648 bidi_paragraph_init (it
->paragraph_embedding
,
3653 bidi_move_to_visually_next (&it
->bidi_it
);
3655 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3656 && it
->bidi_it
.charpos
< newpos
);
3657 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3658 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3659 /* If we overstepped NEWPOS, record its position in the
3660 iterator, so that we skip invisible text if later the
3661 bidi iteration lands us in the invisible region
3663 if (IT_CHARPOS (*it
) >= newpos
)
3664 it
->prev_stop
= newpos
;
3668 IT_CHARPOS (*it
) = newpos
;
3669 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3672 /* If there are before-strings at the start of invisible
3673 text, and the text is invisible because of a text
3674 property, arrange to show before-strings because 20.x did
3675 it that way. (If the text is invisible because of an
3676 overlay property instead of a text property, this is
3677 already handled in the overlay code.) */
3679 && get_overlay_strings (it
, it
->stop_charpos
))
3681 handled
= HANDLED_RECOMPUTE_PROPS
;
3682 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3684 else if (display_ellipsis_p
)
3686 /* Make sure that the glyphs of the ellipsis will get
3687 correct `charpos' values. If we would not update
3688 it->position here, the glyphs would belong to the
3689 last visible character _before_ the invisible
3690 text, which confuses `set_cursor_from_row'.
3692 We use the last invisible position instead of the
3693 first because this way the cursor is always drawn on
3694 the first "." of the ellipsis, whenever PT is inside
3695 the invisible text. Otherwise the cursor would be
3696 placed _after_ the ellipsis when the point is after the
3697 first invisible character. */
3698 if (!STRINGP (it
->object
))
3700 it
->position
.charpos
= newpos
- 1;
3701 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3704 /* Let the ellipsis display before
3705 considering any properties of the following char.
3706 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3707 handled
= HANDLED_RETURN
;
3716 /* Make iterator IT return `...' next.
3717 Replaces LEN characters from buffer. */
3720 setup_for_ellipsis (struct it
*it
, int len
)
3722 /* Use the display table definition for `...'. Invalid glyphs
3723 will be handled by the method returning elements from dpvec. */
3724 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3726 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3727 it
->dpvec
= v
->contents
;
3728 it
->dpend
= v
->contents
+ v
->size
;
3732 /* Default `...'. */
3733 it
->dpvec
= default_invis_vector
;
3734 it
->dpend
= default_invis_vector
+ 3;
3737 it
->dpvec_char_len
= len
;
3738 it
->current
.dpvec_index
= 0;
3739 it
->dpvec_face_id
= -1;
3741 /* Remember the current face id in case glyphs specify faces.
3742 IT's face is restored in set_iterator_to_next.
3743 saved_face_id was set to preceding char's face in handle_stop. */
3744 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3745 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3747 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3753 /***********************************************************************
3755 ***********************************************************************/
3757 /* Set up iterator IT from `display' property at its current position.
3758 Called from handle_stop.
3759 We return HANDLED_RETURN if some part of the display property
3760 overrides the display of the buffer text itself.
3761 Otherwise we return HANDLED_NORMALLY. */
3763 static enum prop_handled
3764 handle_display_prop (struct it
*it
)
3766 Lisp_Object prop
, object
, overlay
;
3767 struct text_pos
*position
;
3768 /* Nonzero if some property replaces the display of the text itself. */
3769 int display_replaced_p
= 0;
3771 if (STRINGP (it
->string
))
3773 object
= it
->string
;
3774 position
= &it
->current
.string_pos
;
3778 XSETWINDOW (object
, it
->w
);
3779 position
= &it
->current
.pos
;
3782 /* Reset those iterator values set from display property values. */
3783 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3784 it
->space_width
= Qnil
;
3785 it
->font_height
= Qnil
;
3788 /* We don't support recursive `display' properties, i.e. string
3789 values that have a string `display' property, that have a string
3790 `display' property etc. */
3791 if (!it
->string_from_display_prop_p
)
3792 it
->area
= TEXT_AREA
;
3794 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3795 Qdisplay
, object
, &overlay
);
3797 return HANDLED_NORMALLY
;
3798 /* Now OVERLAY is the overlay that gave us this property, or nil
3799 if it was a text property. */
3801 if (!STRINGP (it
->string
))
3802 object
= it
->w
->buffer
;
3805 /* Simple properties. */
3806 && !EQ (XCAR (prop
), Qimage
)
3807 && !EQ (XCAR (prop
), Qspace
)
3808 && !EQ (XCAR (prop
), Qwhen
)
3809 && !EQ (XCAR (prop
), Qslice
)
3810 && !EQ (XCAR (prop
), Qspace_width
)
3811 && !EQ (XCAR (prop
), Qheight
)
3812 && !EQ (XCAR (prop
), Qraise
)
3813 /* Marginal area specifications. */
3814 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3815 && !EQ (XCAR (prop
), Qleft_fringe
)
3816 && !EQ (XCAR (prop
), Qright_fringe
)
3817 && !NILP (XCAR (prop
)))
3819 for (; CONSP (prop
); prop
= XCDR (prop
))
3821 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3822 position
, display_replaced_p
))
3824 display_replaced_p
= 1;
3825 /* If some text in a string is replaced, `position' no
3826 longer points to the position of `object'. */
3827 if (STRINGP (object
))
3832 else if (VECTORP (prop
))
3835 for (i
= 0; i
< ASIZE (prop
); ++i
)
3836 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3837 position
, display_replaced_p
))
3839 display_replaced_p
= 1;
3840 /* If some text in a string is replaced, `position' no
3841 longer points to the position of `object'. */
3842 if (STRINGP (object
))
3848 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3850 display_replaced_p
= 1;
3853 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3857 /* Value is the position of the end of the `display' property starting
3858 at START_POS in OBJECT. */
3860 static struct text_pos
3861 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3864 struct text_pos end_pos
;
3866 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3867 Qdisplay
, object
, Qnil
);
3868 CHARPOS (end_pos
) = XFASTINT (end
);
3869 if (STRINGP (object
))
3870 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3872 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3878 /* Set up IT from a single `display' specification PROP. OBJECT
3879 is the object in which the `display' property was found. *POSITION
3880 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3881 means that we previously saw a display specification which already
3882 replaced text display with something else, for example an image;
3883 we ignore such properties after the first one has been processed.
3885 OVERLAY is the overlay this `display' property came from,
3886 or nil if it was a text property.
3888 If PROP is a `space' or `image' specification, and in some other
3889 cases too, set *POSITION to the position where the `display'
3892 Value is non-zero if something was found which replaces the display
3893 of buffer or string text. */
3896 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3897 Lisp_Object overlay
, struct text_pos
*position
,
3898 int display_replaced_before_p
)
3901 Lisp_Object location
, value
;
3902 struct text_pos start_pos
, save_pos
;
3905 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3906 If the result is non-nil, use VALUE instead of SPEC. */
3908 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3917 if (!NILP (form
) && !EQ (form
, Qt
))
3919 int count
= SPECPDL_INDEX ();
3920 struct gcpro gcpro1
;
3922 /* Bind `object' to the object having the `display' property, a
3923 buffer or string. Bind `position' to the position in the
3924 object where the property was found, and `buffer-position'
3925 to the current position in the buffer. */
3926 specbind (Qobject
, object
);
3927 specbind (Qposition
, make_number (CHARPOS (*position
)));
3928 specbind (Qbuffer_position
,
3929 make_number (STRINGP (object
)
3930 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3932 form
= safe_eval (form
);
3934 unbind_to (count
, Qnil
);
3940 /* Handle `(height HEIGHT)' specifications. */
3942 && EQ (XCAR (spec
), Qheight
)
3943 && CONSP (XCDR (spec
)))
3945 if (!FRAME_WINDOW_P (it
->f
))
3948 it
->font_height
= XCAR (XCDR (spec
));
3949 if (!NILP (it
->font_height
))
3951 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3952 int new_height
= -1;
3954 if (CONSP (it
->font_height
)
3955 && (EQ (XCAR (it
->font_height
), Qplus
)
3956 || EQ (XCAR (it
->font_height
), Qminus
))
3957 && CONSP (XCDR (it
->font_height
))
3958 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3960 /* `(+ N)' or `(- N)' where N is an integer. */
3961 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3962 if (EQ (XCAR (it
->font_height
), Qplus
))
3964 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3966 else if (FUNCTIONP (it
->font_height
))
3968 /* Call function with current height as argument.
3969 Value is the new height. */
3971 height
= safe_call1 (it
->font_height
,
3972 face
->lface
[LFACE_HEIGHT_INDEX
]);
3973 if (NUMBERP (height
))
3974 new_height
= XFLOATINT (height
);
3976 else if (NUMBERP (it
->font_height
))
3978 /* Value is a multiple of the canonical char height. */
3981 face
= FACE_FROM_ID (it
->f
,
3982 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3983 new_height
= (XFLOATINT (it
->font_height
)
3984 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
3988 /* Evaluate IT->font_height with `height' bound to the
3989 current specified height to get the new height. */
3990 int count
= SPECPDL_INDEX ();
3992 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3993 value
= safe_eval (it
->font_height
);
3994 unbind_to (count
, Qnil
);
3996 if (NUMBERP (value
))
3997 new_height
= XFLOATINT (value
);
4001 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4007 /* Handle `(space-width WIDTH)'. */
4009 && EQ (XCAR (spec
), Qspace_width
)
4010 && CONSP (XCDR (spec
)))
4012 if (!FRAME_WINDOW_P (it
->f
))
4015 value
= XCAR (XCDR (spec
));
4016 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4017 it
->space_width
= value
;
4022 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4024 && EQ (XCAR (spec
), Qslice
))
4028 if (!FRAME_WINDOW_P (it
->f
))
4031 if (tem
= XCDR (spec
), CONSP (tem
))
4033 it
->slice
.x
= XCAR (tem
);
4034 if (tem
= XCDR (tem
), CONSP (tem
))
4036 it
->slice
.y
= XCAR (tem
);
4037 if (tem
= XCDR (tem
), CONSP (tem
))
4039 it
->slice
.width
= XCAR (tem
);
4040 if (tem
= XCDR (tem
), CONSP (tem
))
4041 it
->slice
.height
= XCAR (tem
);
4049 /* Handle `(raise FACTOR)'. */
4051 && EQ (XCAR (spec
), Qraise
)
4052 && CONSP (XCDR (spec
)))
4054 if (!FRAME_WINDOW_P (it
->f
))
4057 #ifdef HAVE_WINDOW_SYSTEM
4058 value
= XCAR (XCDR (spec
));
4059 if (NUMBERP (value
))
4061 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4062 it
->voffset
= - (XFLOATINT (value
)
4063 * (FONT_HEIGHT (face
->font
)));
4065 #endif /* HAVE_WINDOW_SYSTEM */
4070 /* Don't handle the other kinds of display specifications
4071 inside a string that we got from a `display' property. */
4072 if (it
->string_from_display_prop_p
)
4075 /* Characters having this form of property are not displayed, so
4076 we have to find the end of the property. */
4077 start_pos
= *position
;
4078 *position
= display_prop_end (it
, object
, start_pos
);
4081 /* Stop the scan at that end position--we assume that all
4082 text properties change there. */
4083 it
->stop_charpos
= position
->charpos
;
4085 /* Handle `(left-fringe BITMAP [FACE])'
4086 and `(right-fringe BITMAP [FACE])'. */
4088 && (EQ (XCAR (spec
), Qleft_fringe
)
4089 || EQ (XCAR (spec
), Qright_fringe
))
4090 && CONSP (XCDR (spec
)))
4092 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4095 if (!FRAME_WINDOW_P (it
->f
))
4096 /* If we return here, POSITION has been advanced
4097 across the text with this property. */
4100 #ifdef HAVE_WINDOW_SYSTEM
4101 value
= XCAR (XCDR (spec
));
4102 if (!SYMBOLP (value
)
4103 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4104 /* If we return here, POSITION has been advanced
4105 across the text with this property. */
4108 if (CONSP (XCDR (XCDR (spec
))))
4110 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4111 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4117 /* Save current settings of IT so that we can restore them
4118 when we are finished with the glyph property value. */
4120 save_pos
= it
->position
;
4121 it
->position
= *position
;
4123 it
->position
= save_pos
;
4125 it
->area
= TEXT_AREA
;
4126 it
->what
= IT_IMAGE
;
4127 it
->image_id
= -1; /* no image */
4128 it
->position
= start_pos
;
4129 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4130 it
->method
= GET_FROM_IMAGE
;
4131 it
->from_overlay
= Qnil
;
4132 it
->face_id
= face_id
;
4134 /* Say that we haven't consumed the characters with
4135 `display' property yet. The call to pop_it in
4136 set_iterator_to_next will clean this up. */
4137 *position
= start_pos
;
4139 if (EQ (XCAR (spec
), Qleft_fringe
))
4141 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4142 it
->left_user_fringe_face_id
= face_id
;
4146 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4147 it
->right_user_fringe_face_id
= face_id
;
4149 #endif /* HAVE_WINDOW_SYSTEM */
4153 /* Prepare to handle `((margin left-margin) ...)',
4154 `((margin right-margin) ...)' and `((margin nil) ...)'
4155 prefixes for display specifications. */
4156 location
= Qunbound
;
4157 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4161 value
= XCDR (spec
);
4163 value
= XCAR (value
);
4166 if (EQ (XCAR (tem
), Qmargin
)
4167 && (tem
= XCDR (tem
),
4168 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4170 || EQ (tem
, Qleft_margin
)
4171 || EQ (tem
, Qright_margin
))))
4175 if (EQ (location
, Qunbound
))
4181 /* After this point, VALUE is the property after any
4182 margin prefix has been stripped. It must be a string,
4183 an image specification, or `(space ...)'.
4185 LOCATION specifies where to display: `left-margin',
4186 `right-margin' or nil. */
4188 valid_p
= (STRINGP (value
)
4189 #ifdef HAVE_WINDOW_SYSTEM
4190 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4191 #endif /* not HAVE_WINDOW_SYSTEM */
4192 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4194 if (valid_p
&& !display_replaced_before_p
)
4196 /* Save current settings of IT so that we can restore them
4197 when we are finished with the glyph property value. */
4198 save_pos
= it
->position
;
4199 it
->position
= *position
;
4201 it
->position
= save_pos
;
4202 it
->from_overlay
= overlay
;
4204 if (NILP (location
))
4205 it
->area
= TEXT_AREA
;
4206 else if (EQ (location
, Qleft_margin
))
4207 it
->area
= LEFT_MARGIN_AREA
;
4209 it
->area
= RIGHT_MARGIN_AREA
;
4211 if (STRINGP (value
))
4214 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4215 it
->current
.overlay_string_index
= -1;
4216 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4217 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4218 it
->method
= GET_FROM_STRING
;
4219 it
->stop_charpos
= 0;
4220 it
->string_from_display_prop_p
= 1;
4221 /* Say that we haven't consumed the characters with
4222 `display' property yet. The call to pop_it in
4223 set_iterator_to_next will clean this up. */
4224 if (BUFFERP (object
))
4225 *position
= start_pos
;
4227 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4229 it
->method
= GET_FROM_STRETCH
;
4231 *position
= it
->position
= start_pos
;
4233 #ifdef HAVE_WINDOW_SYSTEM
4236 it
->what
= IT_IMAGE
;
4237 it
->image_id
= lookup_image (it
->f
, value
);
4238 it
->position
= start_pos
;
4239 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4240 it
->method
= GET_FROM_IMAGE
;
4242 /* Say that we haven't consumed the characters with
4243 `display' property yet. The call to pop_it in
4244 set_iterator_to_next will clean this up. */
4245 *position
= start_pos
;
4247 #endif /* HAVE_WINDOW_SYSTEM */
4252 /* Invalid property or property not supported. Restore
4253 POSITION to what it was before. */
4254 *position
= start_pos
;
4259 /* Check if SPEC is a display sub-property value whose text should be
4260 treated as intangible. */
4263 single_display_spec_intangible_p (Lisp_Object prop
)
4265 /* Skip over `when FORM'. */
4266 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4280 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4281 we don't need to treat text as intangible. */
4282 if (EQ (XCAR (prop
), Qmargin
))
4290 || EQ (XCAR (prop
), Qleft_margin
)
4291 || EQ (XCAR (prop
), Qright_margin
))
4295 return (CONSP (prop
)
4296 && (EQ (XCAR (prop
), Qimage
)
4297 || EQ (XCAR (prop
), Qspace
)));
4301 /* Check if PROP is a display property value whose text should be
4302 treated as intangible. */
4305 display_prop_intangible_p (Lisp_Object prop
)
4308 && CONSP (XCAR (prop
))
4309 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4311 /* A list of sub-properties. */
4312 while (CONSP (prop
))
4314 if (single_display_spec_intangible_p (XCAR (prop
)))
4319 else if (VECTORP (prop
))
4321 /* A vector of sub-properties. */
4323 for (i
= 0; i
< ASIZE (prop
); ++i
)
4324 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4328 return single_display_spec_intangible_p (prop
);
4334 /* Return 1 if PROP is a display sub-property value containing STRING. */
4337 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4339 if (EQ (string
, prop
))
4342 /* Skip over `when FORM'. */
4343 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4352 /* Skip over `margin LOCATION'. */
4353 if (EQ (XCAR (prop
), Qmargin
))
4364 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4368 /* Return 1 if STRING appears in the `display' property PROP. */
4371 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4374 && CONSP (XCAR (prop
))
4375 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4377 /* A list of sub-properties. */
4378 while (CONSP (prop
))
4380 if (single_display_spec_string_p (XCAR (prop
), string
))
4385 else if (VECTORP (prop
))
4387 /* A vector of sub-properties. */
4389 for (i
= 0; i
< ASIZE (prop
); ++i
)
4390 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4394 return single_display_spec_string_p (prop
, string
);
4399 /* Look for STRING in overlays and text properties in W's buffer,
4400 between character positions FROM and TO (excluding TO).
4401 BACK_P non-zero means look back (in this case, TO is supposed to be
4403 Value is the first character position where STRING was found, or
4404 zero if it wasn't found before hitting TO.
4406 W's buffer must be current.
4408 This function may only use code that doesn't eval because it is
4409 called asynchronously from note_mouse_highlight. */
4412 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4413 EMACS_INT from
, EMACS_INT to
, int back_p
)
4415 Lisp_Object limit
, prop
, pos
;
4418 pos
= make_number (from
);
4420 if (!back_p
) /* looking forward */
4422 limit
= make_number (min (to
, ZV
));
4423 while (!found
&& !EQ (pos
, limit
))
4425 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4426 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4429 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4433 else /* looking back */
4435 limit
= make_number (max (to
, BEGV
));
4436 while (!found
&& !EQ (pos
, limit
))
4438 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4439 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4442 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4447 return found
? XINT (pos
) : 0;
4450 /* Determine which buffer position in W's buffer STRING comes from.
4451 AROUND_CHARPOS is an approximate position where it could come from.
4452 Value is the buffer position or 0 if it couldn't be determined.
4454 W's buffer must be current.
4456 This function is necessary because we don't record buffer positions
4457 in glyphs generated from strings (to keep struct glyph small).
4458 This function may only use code that doesn't eval because it is
4459 called asynchronously from note_mouse_highlight. */
4462 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4464 const int MAX_DISTANCE
= 1000;
4465 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4466 around_charpos
+ MAX_DISTANCE
,
4470 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4471 around_charpos
- MAX_DISTANCE
, 1);
4477 /***********************************************************************
4478 `composition' property
4479 ***********************************************************************/
4481 /* Set up iterator IT from `composition' property at its current
4482 position. Called from handle_stop. */
4484 static enum prop_handled
4485 handle_composition_prop (struct it
*it
)
4487 Lisp_Object prop
, string
;
4488 EMACS_INT pos
, pos_byte
, start
, end
;
4490 if (STRINGP (it
->string
))
4494 pos
= IT_STRING_CHARPOS (*it
);
4495 pos_byte
= IT_STRING_BYTEPOS (*it
);
4496 string
= it
->string
;
4497 s
= SDATA (string
) + pos_byte
;
4498 it
->c
= STRING_CHAR (s
);
4502 pos
= IT_CHARPOS (*it
);
4503 pos_byte
= IT_BYTEPOS (*it
);
4505 it
->c
= FETCH_CHAR (pos_byte
);
4508 /* If there's a valid composition and point is not inside of the
4509 composition (in the case that the composition is from the current
4510 buffer), draw a glyph composed from the composition components. */
4511 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4512 && COMPOSITION_VALID_P (start
, end
, prop
)
4513 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4517 if (STRINGP (it
->string
))
4518 pos_byte
= string_char_to_byte (it
->string
, start
);
4520 pos_byte
= CHAR_TO_BYTE (start
);
4522 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4525 if (it
->cmp_it
.id
>= 0)
4528 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4529 it
->cmp_it
.nglyphs
= -1;
4533 return HANDLED_NORMALLY
;
4538 /***********************************************************************
4540 ***********************************************************************/
4542 /* The following structure is used to record overlay strings for
4543 later sorting in load_overlay_strings. */
4545 struct overlay_entry
4547 Lisp_Object overlay
;
4554 /* Set up iterator IT from overlay strings at its current position.
4555 Called from handle_stop. */
4557 static enum prop_handled
4558 handle_overlay_change (struct it
*it
)
4560 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4561 return HANDLED_RECOMPUTE_PROPS
;
4563 return HANDLED_NORMALLY
;
4567 /* Set up the next overlay string for delivery by IT, if there is an
4568 overlay string to deliver. Called by set_iterator_to_next when the
4569 end of the current overlay string is reached. If there are more
4570 overlay strings to display, IT->string and
4571 IT->current.overlay_string_index are set appropriately here.
4572 Otherwise IT->string is set to nil. */
4575 next_overlay_string (struct it
*it
)
4577 ++it
->current
.overlay_string_index
;
4578 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4580 /* No more overlay strings. Restore IT's settings to what
4581 they were before overlay strings were processed, and
4582 continue to deliver from current_buffer. */
4584 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4587 || (NILP (it
->string
)
4588 && it
->method
== GET_FROM_BUFFER
4589 && it
->stop_charpos
>= BEGV
4590 && it
->stop_charpos
<= it
->end_charpos
));
4591 it
->current
.overlay_string_index
= -1;
4592 it
->n_overlay_strings
= 0;
4593 it
->overlay_strings_charpos
= -1;
4595 /* If we're at the end of the buffer, record that we have
4596 processed the overlay strings there already, so that
4597 next_element_from_buffer doesn't try it again. */
4598 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4599 it
->overlay_strings_at_end_processed_p
= 1;
4603 /* There are more overlay strings to process. If
4604 IT->current.overlay_string_index has advanced to a position
4605 where we must load IT->overlay_strings with more strings, do
4606 it. We must load at the IT->overlay_strings_charpos where
4607 IT->n_overlay_strings was originally computed; when invisible
4608 text is present, this might not be IT_CHARPOS (Bug#7016). */
4609 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4611 if (it
->current
.overlay_string_index
&& i
== 0)
4612 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4614 /* Initialize IT to deliver display elements from the overlay
4616 it
->string
= it
->overlay_strings
[i
];
4617 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4618 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4619 it
->method
= GET_FROM_STRING
;
4620 it
->stop_charpos
= 0;
4621 if (it
->cmp_it
.stop_pos
>= 0)
4622 it
->cmp_it
.stop_pos
= 0;
4629 /* Compare two overlay_entry structures E1 and E2. Used as a
4630 comparison function for qsort in load_overlay_strings. Overlay
4631 strings for the same position are sorted so that
4633 1. All after-strings come in front of before-strings, except
4634 when they come from the same overlay.
4636 2. Within after-strings, strings are sorted so that overlay strings
4637 from overlays with higher priorities come first.
4639 2. Within before-strings, strings are sorted so that overlay
4640 strings from overlays with higher priorities come last.
4642 Value is analogous to strcmp. */
4646 compare_overlay_entries (const void *e1
, const void *e2
)
4648 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4649 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4652 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4654 /* Let after-strings appear in front of before-strings if
4655 they come from different overlays. */
4656 if (EQ (entry1
->overlay
, entry2
->overlay
))
4657 result
= entry1
->after_string_p
? 1 : -1;
4659 result
= entry1
->after_string_p
? -1 : 1;
4661 else if (entry1
->after_string_p
)
4662 /* After-strings sorted in order of decreasing priority. */
4663 result
= entry2
->priority
- entry1
->priority
;
4665 /* Before-strings sorted in order of increasing priority. */
4666 result
= entry1
->priority
- entry2
->priority
;
4672 /* Load the vector IT->overlay_strings with overlay strings from IT's
4673 current buffer position, or from CHARPOS if that is > 0. Set
4674 IT->n_overlays to the total number of overlay strings found.
4676 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4677 a time. On entry into load_overlay_strings,
4678 IT->current.overlay_string_index gives the number of overlay
4679 strings that have already been loaded by previous calls to this
4682 IT->add_overlay_start contains an additional overlay start
4683 position to consider for taking overlay strings from, if non-zero.
4684 This position comes into play when the overlay has an `invisible'
4685 property, and both before and after-strings. When we've skipped to
4686 the end of the overlay, because of its `invisible' property, we
4687 nevertheless want its before-string to appear.
4688 IT->add_overlay_start will contain the overlay start position
4691 Overlay strings are sorted so that after-string strings come in
4692 front of before-string strings. Within before and after-strings,
4693 strings are sorted by overlay priority. See also function
4694 compare_overlay_entries. */
4697 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4699 Lisp_Object overlay
, window
, str
, invisible
;
4700 struct Lisp_Overlay
*ov
;
4701 EMACS_INT start
, end
;
4703 int n
= 0, i
, j
, invis_p
;
4704 struct overlay_entry
*entries
4705 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4708 charpos
= IT_CHARPOS (*it
);
4710 /* Append the overlay string STRING of overlay OVERLAY to vector
4711 `entries' which has size `size' and currently contains `n'
4712 elements. AFTER_P non-zero means STRING is an after-string of
4714 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4717 Lisp_Object priority; \
4721 int new_size = 2 * size; \
4722 struct overlay_entry *old = entries; \
4724 (struct overlay_entry *) alloca (new_size \
4725 * sizeof *entries); \
4726 memcpy (entries, old, size * sizeof *entries); \
4730 entries[n].string = (STRING); \
4731 entries[n].overlay = (OVERLAY); \
4732 priority = Foverlay_get ((OVERLAY), Qpriority); \
4733 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4734 entries[n].after_string_p = (AFTER_P); \
4739 /* Process overlay before the overlay center. */
4740 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4742 XSETMISC (overlay
, ov
);
4743 xassert (OVERLAYP (overlay
));
4744 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4745 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4750 /* Skip this overlay if it doesn't start or end at IT's current
4752 if (end
!= charpos
&& start
!= charpos
)
4755 /* Skip this overlay if it doesn't apply to IT->w. */
4756 window
= Foverlay_get (overlay
, Qwindow
);
4757 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4760 /* If the text ``under'' the overlay is invisible, both before-
4761 and after-strings from this overlay are visible; start and
4762 end position are indistinguishable. */
4763 invisible
= Foverlay_get (overlay
, Qinvisible
);
4764 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4766 /* If overlay has a non-empty before-string, record it. */
4767 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4768 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4770 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4772 /* If overlay has a non-empty after-string, record it. */
4773 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4774 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4776 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4779 /* Process overlays after the overlay center. */
4780 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4782 XSETMISC (overlay
, ov
);
4783 xassert (OVERLAYP (overlay
));
4784 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4785 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4787 if (start
> charpos
)
4790 /* Skip this overlay if it doesn't start or end at IT's current
4792 if (end
!= charpos
&& start
!= charpos
)
4795 /* Skip this overlay if it doesn't apply to IT->w. */
4796 window
= Foverlay_get (overlay
, Qwindow
);
4797 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4800 /* If the text ``under'' the overlay is invisible, it has a zero
4801 dimension, and both before- and after-strings apply. */
4802 invisible
= Foverlay_get (overlay
, Qinvisible
);
4803 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4805 /* If overlay has a non-empty before-string, record it. */
4806 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4807 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4809 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4811 /* If overlay has a non-empty after-string, record it. */
4812 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4813 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4815 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4818 #undef RECORD_OVERLAY_STRING
4822 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4824 /* Record number of overlay strings, and where we computed it. */
4825 it
->n_overlay_strings
= n
;
4826 it
->overlay_strings_charpos
= charpos
;
4828 /* IT->current.overlay_string_index is the number of overlay strings
4829 that have already been consumed by IT. Copy some of the
4830 remaining overlay strings to IT->overlay_strings. */
4832 j
= it
->current
.overlay_string_index
;
4833 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4835 it
->overlay_strings
[i
] = entries
[j
].string
;
4836 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4843 /* Get the first chunk of overlay strings at IT's current buffer
4844 position, or at CHARPOS if that is > 0. Value is non-zero if at
4845 least one overlay string was found. */
4848 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4850 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4851 process. This fills IT->overlay_strings with strings, and sets
4852 IT->n_overlay_strings to the total number of strings to process.
4853 IT->pos.overlay_string_index has to be set temporarily to zero
4854 because load_overlay_strings needs this; it must be set to -1
4855 when no overlay strings are found because a zero value would
4856 indicate a position in the first overlay string. */
4857 it
->current
.overlay_string_index
= 0;
4858 load_overlay_strings (it
, charpos
);
4860 /* If we found overlay strings, set up IT to deliver display
4861 elements from the first one. Otherwise set up IT to deliver
4862 from current_buffer. */
4863 if (it
->n_overlay_strings
)
4865 /* Make sure we know settings in current_buffer, so that we can
4866 restore meaningful values when we're done with the overlay
4869 compute_stop_pos (it
);
4870 xassert (it
->face_id
>= 0);
4872 /* Save IT's settings. They are restored after all overlay
4873 strings have been processed. */
4874 xassert (!compute_stop_p
|| it
->sp
== 0);
4876 /* When called from handle_stop, there might be an empty display
4877 string loaded. In that case, don't bother saving it. */
4878 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4881 /* Set up IT to deliver display elements from the first overlay
4883 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4884 it
->string
= it
->overlay_strings
[0];
4885 it
->from_overlay
= Qnil
;
4886 it
->stop_charpos
= 0;
4887 xassert (STRINGP (it
->string
));
4888 it
->end_charpos
= SCHARS (it
->string
);
4889 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4890 it
->method
= GET_FROM_STRING
;
4894 it
->current
.overlay_string_index
= -1;
4899 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4902 it
->method
= GET_FROM_BUFFER
;
4904 (void) get_overlay_strings_1 (it
, charpos
, 1);
4908 /* Value is non-zero if we found at least one overlay string. */
4909 return STRINGP (it
->string
);
4914 /***********************************************************************
4915 Saving and restoring state
4916 ***********************************************************************/
4918 /* Save current settings of IT on IT->stack. Called, for example,
4919 before setting up IT for an overlay string, to be able to restore
4920 IT's settings to what they were after the overlay string has been
4924 push_it (struct it
*it
)
4926 struct iterator_stack_entry
*p
;
4928 xassert (it
->sp
< IT_STACK_SIZE
);
4929 p
= it
->stack
+ it
->sp
;
4931 p
->stop_charpos
= it
->stop_charpos
;
4932 p
->prev_stop
= it
->prev_stop
;
4933 p
->base_level_stop
= it
->base_level_stop
;
4934 p
->cmp_it
= it
->cmp_it
;
4935 xassert (it
->face_id
>= 0);
4936 p
->face_id
= it
->face_id
;
4937 p
->string
= it
->string
;
4938 p
->method
= it
->method
;
4939 p
->from_overlay
= it
->from_overlay
;
4942 case GET_FROM_IMAGE
:
4943 p
->u
.image
.object
= it
->object
;
4944 p
->u
.image
.image_id
= it
->image_id
;
4945 p
->u
.image
.slice
= it
->slice
;
4947 case GET_FROM_STRETCH
:
4948 p
->u
.stretch
.object
= it
->object
;
4951 p
->position
= it
->position
;
4952 p
->current
= it
->current
;
4953 p
->end_charpos
= it
->end_charpos
;
4954 p
->string_nchars
= it
->string_nchars
;
4956 p
->multibyte_p
= it
->multibyte_p
;
4957 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4958 p
->space_width
= it
->space_width
;
4959 p
->font_height
= it
->font_height
;
4960 p
->voffset
= it
->voffset
;
4961 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4962 p
->display_ellipsis_p
= 0;
4963 p
->line_wrap
= it
->line_wrap
;
4968 iterate_out_of_display_property (struct it
*it
)
4970 /* Maybe initialize paragraph direction. If we are at the beginning
4971 of a new paragraph, next_element_from_buffer may not have a
4972 chance to do that. */
4973 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4974 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4975 /* prev_stop can be zero, so check against BEGV as well. */
4976 while (it
->bidi_it
.charpos
>= BEGV
4977 && it
->prev_stop
<= it
->bidi_it
.charpos
4978 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4979 bidi_move_to_visually_next (&it
->bidi_it
);
4980 /* Record the stop_pos we just crossed, for when we cross it
4982 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4983 it
->prev_stop
= CHARPOS (it
->position
);
4984 /* If we ended up not where pop_it put us, resync IT's
4985 positional members with the bidi iterator. */
4986 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
4988 SET_TEXT_POS (it
->position
,
4989 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
4990 it
->current
.pos
= it
->position
;
4994 /* Restore IT's settings from IT->stack. Called, for example, when no
4995 more overlay strings must be processed, and we return to delivering
4996 display elements from a buffer, or when the end of a string from a
4997 `display' property is reached and we return to delivering display
4998 elements from an overlay string, or from a buffer. */
5001 pop_it (struct it
*it
)
5003 struct iterator_stack_entry
*p
;
5005 xassert (it
->sp
> 0);
5007 p
= it
->stack
+ it
->sp
;
5008 it
->stop_charpos
= p
->stop_charpos
;
5009 it
->prev_stop
= p
->prev_stop
;
5010 it
->base_level_stop
= p
->base_level_stop
;
5011 it
->cmp_it
= p
->cmp_it
;
5012 it
->face_id
= p
->face_id
;
5013 it
->current
= p
->current
;
5014 it
->position
= p
->position
;
5015 it
->string
= p
->string
;
5016 it
->from_overlay
= p
->from_overlay
;
5017 if (NILP (it
->string
))
5018 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5019 it
->method
= p
->method
;
5022 case GET_FROM_IMAGE
:
5023 it
->image_id
= p
->u
.image
.image_id
;
5024 it
->object
= p
->u
.image
.object
;
5025 it
->slice
= p
->u
.image
.slice
;
5027 case GET_FROM_STRETCH
:
5028 it
->object
= p
->u
.comp
.object
;
5030 case GET_FROM_BUFFER
:
5031 it
->object
= it
->w
->buffer
;
5034 /* Bidi-iterate until we get out of the portion of text, if
5035 any, covered by a `display' text property or an overlay
5036 with `display' property. (We cannot just jump there,
5037 because the internal coherency of the bidi iterator state
5038 can not be preserved across such jumps.) We also must
5039 determine the paragraph base direction if the overlay we
5040 just processed is at the beginning of a new
5042 iterate_out_of_display_property (it
);
5045 case GET_FROM_STRING
:
5046 it
->object
= it
->string
;
5048 case GET_FROM_DISPLAY_VECTOR
:
5050 it
->method
= GET_FROM_C_STRING
;
5051 else if (STRINGP (it
->string
))
5052 it
->method
= GET_FROM_STRING
;
5055 it
->method
= GET_FROM_BUFFER
;
5056 it
->object
= it
->w
->buffer
;
5059 it
->end_charpos
= p
->end_charpos
;
5060 it
->string_nchars
= p
->string_nchars
;
5062 it
->multibyte_p
= p
->multibyte_p
;
5063 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5064 it
->space_width
= p
->space_width
;
5065 it
->font_height
= p
->font_height
;
5066 it
->voffset
= p
->voffset
;
5067 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5068 it
->line_wrap
= p
->line_wrap
;
5073 /***********************************************************************
5075 ***********************************************************************/
5077 /* Set IT's current position to the previous line start. */
5080 back_to_previous_line_start (struct it
*it
)
5082 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5083 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5087 /* Move IT to the next line start.
5089 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5090 we skipped over part of the text (as opposed to moving the iterator
5091 continuously over the text). Otherwise, don't change the value
5094 Newlines may come from buffer text, overlay strings, or strings
5095 displayed via the `display' property. That's the reason we can't
5096 simply use find_next_newline_no_quit.
5098 Note that this function may not skip over invisible text that is so
5099 because of text properties and immediately follows a newline. If
5100 it would, function reseat_at_next_visible_line_start, when called
5101 from set_iterator_to_next, would effectively make invisible
5102 characters following a newline part of the wrong glyph row, which
5103 leads to wrong cursor motion. */
5106 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5108 int old_selective
, newline_found_p
, n
;
5109 const int MAX_NEWLINE_DISTANCE
= 500;
5111 /* If already on a newline, just consume it to avoid unintended
5112 skipping over invisible text below. */
5113 if (it
->what
== IT_CHARACTER
5115 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5117 set_iterator_to_next (it
, 0);
5122 /* Don't handle selective display in the following. It's (a)
5123 unnecessary because it's done by the caller, and (b) leads to an
5124 infinite recursion because next_element_from_ellipsis indirectly
5125 calls this function. */
5126 old_selective
= it
->selective
;
5129 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5130 from buffer text. */
5131 for (n
= newline_found_p
= 0;
5132 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5133 n
+= STRINGP (it
->string
) ? 0 : 1)
5135 if (!get_next_display_element (it
))
5137 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5138 set_iterator_to_next (it
, 0);
5141 /* If we didn't find a newline near enough, see if we can use a
5143 if (!newline_found_p
)
5145 EMACS_INT start
= IT_CHARPOS (*it
);
5146 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5149 xassert (!STRINGP (it
->string
));
5151 /* If there isn't any `display' property in sight, and no
5152 overlays, we can just use the position of the newline in
5154 if (it
->stop_charpos
>= limit
5155 || ((pos
= Fnext_single_property_change (make_number (start
),
5157 Qnil
, make_number (limit
)),
5159 && next_overlay_change (start
) == ZV
))
5161 IT_CHARPOS (*it
) = limit
;
5162 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5163 *skipped_p
= newline_found_p
= 1;
5167 while (get_next_display_element (it
)
5168 && !newline_found_p
)
5170 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5171 set_iterator_to_next (it
, 0);
5176 it
->selective
= old_selective
;
5177 return newline_found_p
;
5181 /* Set IT's current position to the previous visible line start. Skip
5182 invisible text that is so either due to text properties or due to
5183 selective display. Caution: this does not change IT->current_x and
5187 back_to_previous_visible_line_start (struct it
*it
)
5189 while (IT_CHARPOS (*it
) > BEGV
)
5191 back_to_previous_line_start (it
);
5193 if (IT_CHARPOS (*it
) <= BEGV
)
5196 /* If selective > 0, then lines indented more than its value are
5198 if (it
->selective
> 0
5199 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5200 (double) it
->selective
)) /* iftc */
5203 /* Check the newline before point for invisibility. */
5206 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5207 Qinvisible
, it
->window
);
5208 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5212 if (IT_CHARPOS (*it
) <= BEGV
)
5219 Lisp_Object val
, overlay
;
5221 /* If newline is part of a composition, continue from start of composition */
5222 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5223 && beg
< IT_CHARPOS (*it
))
5226 /* If newline is replaced by a display property, find start of overlay
5227 or interval and continue search from that point. */
5229 pos
= --IT_CHARPOS (it2
);
5232 it2
.string_from_display_prop_p
= 0;
5233 if (handle_display_prop (&it2
) == HANDLED_RETURN
5234 && !NILP (val
= get_char_property_and_overlay
5235 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5236 && (OVERLAYP (overlay
)
5237 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5238 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5241 /* Newline is not replaced by anything -- so we are done. */
5247 IT_CHARPOS (*it
) = beg
;
5248 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5252 it
->continuation_lines_width
= 0;
5254 xassert (IT_CHARPOS (*it
) >= BEGV
);
5255 xassert (IT_CHARPOS (*it
) == BEGV
5256 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5261 /* Reseat iterator IT at the previous visible line start. Skip
5262 invisible text that is so either due to text properties or due to
5263 selective display. At the end, update IT's overlay information,
5264 face information etc. */
5267 reseat_at_previous_visible_line_start (struct it
*it
)
5269 back_to_previous_visible_line_start (it
);
5270 reseat (it
, it
->current
.pos
, 1);
5275 /* Reseat iterator IT on the next visible line start in the current
5276 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5277 preceding the line start. Skip over invisible text that is so
5278 because of selective display. Compute faces, overlays etc at the
5279 new position. Note that this function does not skip over text that
5280 is invisible because of text properties. */
5283 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5285 int newline_found_p
, skipped_p
= 0;
5287 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5289 /* Skip over lines that are invisible because they are indented
5290 more than the value of IT->selective. */
5291 if (it
->selective
> 0)
5292 while (IT_CHARPOS (*it
) < ZV
5293 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5294 (double) it
->selective
)) /* iftc */
5296 xassert (IT_BYTEPOS (*it
) == BEGV
5297 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5298 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5301 /* Position on the newline if that's what's requested. */
5302 if (on_newline_p
&& newline_found_p
)
5304 if (STRINGP (it
->string
))
5306 if (IT_STRING_CHARPOS (*it
) > 0)
5308 --IT_STRING_CHARPOS (*it
);
5309 --IT_STRING_BYTEPOS (*it
);
5312 else if (IT_CHARPOS (*it
) > BEGV
)
5316 reseat (it
, it
->current
.pos
, 0);
5320 reseat (it
, it
->current
.pos
, 0);
5327 /***********************************************************************
5328 Changing an iterator's position
5329 ***********************************************************************/
5331 /* Change IT's current position to POS in current_buffer. If FORCE_P
5332 is non-zero, always check for text properties at the new position.
5333 Otherwise, text properties are only looked up if POS >=
5334 IT->check_charpos of a property. */
5337 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5339 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5341 reseat_1 (it
, pos
, 0);
5343 /* Determine where to check text properties. Avoid doing it
5344 where possible because text property lookup is very expensive. */
5346 || CHARPOS (pos
) > it
->stop_charpos
5347 || CHARPOS (pos
) < original_pos
)
5351 /* For bidi iteration, we need to prime prev_stop and
5352 base_level_stop with our best estimations. */
5353 if (CHARPOS (pos
) < it
->prev_stop
)
5355 handle_stop_backwards (it
, BEGV
);
5356 if (CHARPOS (pos
) < it
->base_level_stop
)
5357 it
->base_level_stop
= 0;
5359 else if (CHARPOS (pos
) > it
->stop_charpos
5360 && it
->stop_charpos
>= BEGV
)
5361 handle_stop_backwards (it
, it
->stop_charpos
);
5368 it
->prev_stop
= it
->base_level_stop
= 0;
5377 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5378 IT->stop_pos to POS, also. */
5381 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5383 /* Don't call this function when scanning a C string. */
5384 xassert (it
->s
== NULL
);
5386 /* POS must be a reasonable value. */
5387 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5389 it
->current
.pos
= it
->position
= pos
;
5390 it
->end_charpos
= ZV
;
5392 it
->current
.dpvec_index
= -1;
5393 it
->current
.overlay_string_index
= -1;
5394 IT_STRING_CHARPOS (*it
) = -1;
5395 IT_STRING_BYTEPOS (*it
) = -1;
5397 it
->string_from_display_prop_p
= 0;
5398 it
->method
= GET_FROM_BUFFER
;
5399 it
->object
= it
->w
->buffer
;
5400 it
->area
= TEXT_AREA
;
5401 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5403 it
->string_from_display_prop_p
= 0;
5404 it
->face_before_selective_p
= 0;
5407 it
->bidi_it
.first_elt
= 1;
5408 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5413 it
->stop_charpos
= CHARPOS (pos
);
5414 it
->base_level_stop
= CHARPOS (pos
);
5419 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5420 If S is non-null, it is a C string to iterate over. Otherwise,
5421 STRING gives a Lisp string to iterate over.
5423 If PRECISION > 0, don't return more then PRECISION number of
5424 characters from the string.
5426 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5427 characters have been returned. FIELD_WIDTH < 0 means an infinite
5430 MULTIBYTE = 0 means disable processing of multibyte characters,
5431 MULTIBYTE > 0 means enable it,
5432 MULTIBYTE < 0 means use IT->multibyte_p.
5434 IT must be initialized via a prior call to init_iterator before
5435 calling this function. */
5438 reseat_to_string (struct it
*it
, const unsigned char *s
, Lisp_Object string
,
5439 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5442 /* No region in strings. */
5443 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5445 /* No text property checks performed by default, but see below. */
5446 it
->stop_charpos
= -1;
5448 /* Set iterator position and end position. */
5449 memset (&it
->current
, 0, sizeof it
->current
);
5450 it
->current
.overlay_string_index
= -1;
5451 it
->current
.dpvec_index
= -1;
5452 xassert (charpos
>= 0);
5454 /* If STRING is specified, use its multibyteness, otherwise use the
5455 setting of MULTIBYTE, if specified. */
5457 it
->multibyte_p
= multibyte
> 0;
5461 xassert (STRINGP (string
));
5462 it
->string
= string
;
5464 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5465 it
->method
= GET_FROM_STRING
;
5466 it
->current
.string_pos
= string_pos (charpos
, string
);
5473 /* Note that we use IT->current.pos, not it->current.string_pos,
5474 for displaying C strings. */
5475 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5476 if (it
->multibyte_p
)
5478 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5479 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5483 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5484 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5487 it
->method
= GET_FROM_C_STRING
;
5490 /* PRECISION > 0 means don't return more than PRECISION characters
5492 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5493 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5495 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5496 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5497 FIELD_WIDTH < 0 means infinite field width. This is useful for
5498 padding with `-' at the end of a mode line. */
5499 if (field_width
< 0)
5500 field_width
= INFINITY
;
5501 if (field_width
> it
->end_charpos
- charpos
)
5502 it
->end_charpos
= charpos
+ field_width
;
5504 /* Use the standard display table for displaying strings. */
5505 if (DISP_TABLE_P (Vstandard_display_table
))
5506 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5508 it
->stop_charpos
= charpos
;
5509 if (s
== NULL
&& it
->multibyte_p
)
5511 EMACS_INT endpos
= SCHARS (it
->string
);
5512 if (endpos
> it
->end_charpos
)
5513 endpos
= it
->end_charpos
;
5514 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5522 /***********************************************************************
5524 ***********************************************************************/
5526 /* Map enum it_method value to corresponding next_element_from_* function. */
5528 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5530 next_element_from_buffer
,
5531 next_element_from_display_vector
,
5532 next_element_from_string
,
5533 next_element_from_c_string
,
5534 next_element_from_image
,
5535 next_element_from_stretch
5538 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5541 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5542 (possibly with the following characters). */
5544 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5545 ((IT)->cmp_it.id >= 0 \
5546 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5547 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5548 END_CHARPOS, (IT)->w, \
5549 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5553 /* Lookup the char-table Vglyphless_char_display for character C (-1
5554 if we want information for no-font case), and return the display
5555 method symbol. By side-effect, update it->what and
5556 it->glyphless_method. This function is called from
5557 get_next_display_element for each character element, and from
5558 x_produce_glyphs when no suitable font was found. */
5561 lookup_glyphless_char_display (int c
, struct it
*it
)
5563 Lisp_Object glyphless_method
= Qnil
;
5565 if (CHAR_TABLE_P (Vglyphless_char_display
)
5566 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5567 glyphless_method
= (c
>= 0
5568 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5569 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5571 if (NILP (glyphless_method
))
5574 /* The default is to display the character by a proper font. */
5576 /* The default for the no-font case is to display an empty box. */
5577 glyphless_method
= Qempty_box
;
5579 if (EQ (glyphless_method
, Qzero_width
))
5582 return glyphless_method
;
5583 /* This method can't be used for the no-font case. */
5584 glyphless_method
= Qempty_box
;
5586 if (EQ (glyphless_method
, Qthin_space
))
5587 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5588 else if (EQ (glyphless_method
, Qempty_box
))
5589 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5590 else if (EQ (glyphless_method
, Qhex_code
))
5591 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5592 else if (STRINGP (glyphless_method
))
5593 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5596 /* Invalid value. We use the default method. */
5597 glyphless_method
= Qnil
;
5600 it
->what
= IT_GLYPHLESS
;
5601 return glyphless_method
;
5604 /* Load IT's display element fields with information about the next
5605 display element from the current position of IT. Value is zero if
5606 end of buffer (or C string) is reached. */
5608 static struct frame
*last_escape_glyph_frame
= NULL
;
5609 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5610 static int last_escape_glyph_merged_face_id
= 0;
5612 struct frame
*last_glyphless_glyph_frame
= NULL
;
5613 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5614 int last_glyphless_glyph_merged_face_id
= 0;
5617 get_next_display_element (struct it
*it
)
5619 /* Non-zero means that we found a display element. Zero means that
5620 we hit the end of what we iterate over. Performance note: the
5621 function pointer `method' used here turns out to be faster than
5622 using a sequence of if-statements. */
5626 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5628 if (it
->what
== IT_CHARACTER
)
5630 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5631 and only if (a) the resolved directionality of that character
5633 /* FIXME: Do we need an exception for characters from display
5635 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5636 it
->c
= bidi_mirror_char (it
->c
);
5637 /* Map via display table or translate control characters.
5638 IT->c, IT->len etc. have been set to the next character by
5639 the function call above. If we have a display table, and it
5640 contains an entry for IT->c, translate it. Don't do this if
5641 IT->c itself comes from a display table, otherwise we could
5642 end up in an infinite recursion. (An alternative could be to
5643 count the recursion depth of this function and signal an
5644 error when a certain maximum depth is reached.) Is it worth
5646 if (success_p
&& it
->dpvec
== NULL
)
5649 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5650 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5651 nbsp_or_shy
= char_is_other
;
5652 int c
= it
->c
; /* This is the character to display. */
5654 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5656 xassert (SINGLE_BYTE_CHAR_P (c
));
5657 if (unibyte_display_via_language_environment
)
5659 c
= DECODE_CHAR (unibyte
, c
);
5661 c
= BYTE8_TO_CHAR (it
->c
);
5664 c
= BYTE8_TO_CHAR (it
->c
);
5668 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5671 struct Lisp_Vector
*v
= XVECTOR (dv
);
5673 /* Return the first character from the display table
5674 entry, if not empty. If empty, don't display the
5675 current character. */
5678 it
->dpvec_char_len
= it
->len
;
5679 it
->dpvec
= v
->contents
;
5680 it
->dpend
= v
->contents
+ v
->size
;
5681 it
->current
.dpvec_index
= 0;
5682 it
->dpvec_face_id
= -1;
5683 it
->saved_face_id
= it
->face_id
;
5684 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5689 set_iterator_to_next (it
, 0);
5694 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5696 if (it
->what
== IT_GLYPHLESS
)
5698 /* Don't display this character. */
5699 set_iterator_to_next (it
, 0);
5703 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5704 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5705 : c
== 0xAD ? char_is_soft_hyphen
5708 /* Translate control characters into `\003' or `^C' form.
5709 Control characters coming from a display table entry are
5710 currently not translated because we use IT->dpvec to hold
5711 the translation. This could easily be changed but I
5712 don't believe that it is worth doing.
5714 NBSP and SOFT-HYPEN are property translated too.
5716 Non-printable characters and raw-byte characters are also
5717 translated to octal form. */
5718 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5719 ? (it
->area
!= TEXT_AREA
5720 /* In mode line, treat \n, \t like other crl chars. */
5723 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5724 || (c
!= '\n' && c
!= '\t'))
5727 || ! CHAR_PRINTABLE_P (c
))))
5729 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5730 or a non-printable character which must be displayed
5731 either as '\003' or as `^C' where the '\\' and '^'
5732 can be defined in the display table. Fill
5733 IT->ctl_chars with glyphs for what we have to
5734 display. Then, set IT->dpvec to these glyphs. */
5737 int face_id
, lface_id
= 0 ;
5740 /* Handle control characters with ^. */
5742 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5746 g
= '^'; /* default glyph for Control */
5747 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5749 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5750 && GLYPH_CODE_CHAR_VALID_P (gc
))
5752 g
= GLYPH_CODE_CHAR (gc
);
5753 lface_id
= GLYPH_CODE_FACE (gc
);
5757 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5759 else if (it
->f
== last_escape_glyph_frame
5760 && it
->face_id
== last_escape_glyph_face_id
)
5762 face_id
= last_escape_glyph_merged_face_id
;
5766 /* Merge the escape-glyph face into the current face. */
5767 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5769 last_escape_glyph_frame
= it
->f
;
5770 last_escape_glyph_face_id
= it
->face_id
;
5771 last_escape_glyph_merged_face_id
= face_id
;
5774 XSETINT (it
->ctl_chars
[0], g
);
5775 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5777 goto display_control
;
5780 /* Handle non-break space in the mode where it only gets
5783 if (EQ (Vnobreak_char_display
, Qt
)
5784 && nbsp_or_shy
== char_is_nbsp
)
5786 /* Merge the no-break-space face into the current face. */
5787 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5791 XSETINT (it
->ctl_chars
[0], ' ');
5793 goto display_control
;
5796 /* Handle sequences that start with the "escape glyph". */
5798 /* the default escape glyph is \. */
5799 escape_glyph
= '\\';
5802 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5803 && GLYPH_CODE_CHAR_VALID_P (gc
))
5805 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5806 lface_id
= GLYPH_CODE_FACE (gc
);
5810 /* The display table specified a face.
5811 Merge it into face_id and also into escape_glyph. */
5812 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5815 else if (it
->f
== last_escape_glyph_frame
5816 && it
->face_id
== last_escape_glyph_face_id
)
5818 face_id
= last_escape_glyph_merged_face_id
;
5822 /* Merge the escape-glyph face into the current face. */
5823 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5825 last_escape_glyph_frame
= it
->f
;
5826 last_escape_glyph_face_id
= it
->face_id
;
5827 last_escape_glyph_merged_face_id
= face_id
;
5830 /* Handle soft hyphens in the mode where they only get
5833 if (EQ (Vnobreak_char_display
, Qt
)
5834 && nbsp_or_shy
== char_is_soft_hyphen
)
5836 XSETINT (it
->ctl_chars
[0], '-');
5838 goto display_control
;
5841 /* Handle non-break space and soft hyphen
5842 with the escape glyph. */
5846 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5847 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5848 XSETINT (it
->ctl_chars
[1], c
);
5850 goto display_control
;
5857 if (CHAR_BYTE8_P (c
))
5858 /* Display \200 instead of \17777600. */
5859 c
= CHAR_TO_BYTE8 (c
);
5860 len
= sprintf (str
, "%03o", c
);
5862 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5863 for (i
= 0; i
< len
; i
++)
5864 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5869 /* Set up IT->dpvec and return first character from it. */
5870 it
->dpvec_char_len
= it
->len
;
5871 it
->dpvec
= it
->ctl_chars
;
5872 it
->dpend
= it
->dpvec
+ ctl_len
;
5873 it
->current
.dpvec_index
= 0;
5874 it
->dpvec_face_id
= face_id
;
5875 it
->saved_face_id
= it
->face_id
;
5876 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5880 it
->char_to_display
= c
;
5884 it
->char_to_display
= it
->c
;
5888 #ifdef HAVE_WINDOW_SYSTEM
5889 /* Adjust face id for a multibyte character. There are no multibyte
5890 character in unibyte text. */
5891 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5894 && FRAME_WINDOW_P (it
->f
))
5896 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5898 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5900 /* Automatic composition with glyph-string. */
5901 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5903 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5907 EMACS_INT pos
= (it
->s
? -1
5908 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5909 : IT_CHARPOS (*it
));
5911 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5918 /* Is this character the last one of a run of characters with
5919 box? If yes, set IT->end_of_box_run_p to 1. */
5923 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5925 int face_id
= underlying_face_id (it
);
5926 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5930 if (face
->box
== FACE_NO_BOX
)
5932 /* If the box comes from face properties in a
5933 display string, check faces in that string. */
5934 int string_face_id
= face_after_it_pos (it
);
5935 it
->end_of_box_run_p
5936 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5939 /* Otherwise, the box comes from the underlying face.
5940 If this is the last string character displayed, check
5941 the next buffer location. */
5942 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5943 && (it
->current
.overlay_string_index
5944 == it
->n_overlay_strings
- 1))
5948 struct text_pos pos
= it
->current
.pos
;
5949 INC_TEXT_POS (pos
, it
->multibyte_p
);
5951 next_face_id
= face_at_buffer_position
5952 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5953 it
->region_end_charpos
, &ignore
,
5954 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5956 it
->end_of_box_run_p
5957 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5964 int face_id
= face_after_it_pos (it
);
5965 it
->end_of_box_run_p
5966 = (face_id
!= it
->face_id
5967 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5971 /* Value is 0 if end of buffer or string reached. */
5976 /* Move IT to the next display element.
5978 RESEAT_P non-zero means if called on a newline in buffer text,
5979 skip to the next visible line start.
5981 Functions get_next_display_element and set_iterator_to_next are
5982 separate because I find this arrangement easier to handle than a
5983 get_next_display_element function that also increments IT's
5984 position. The way it is we can first look at an iterator's current
5985 display element, decide whether it fits on a line, and if it does,
5986 increment the iterator position. The other way around we probably
5987 would either need a flag indicating whether the iterator has to be
5988 incremented the next time, or we would have to implement a
5989 decrement position function which would not be easy to write. */
5992 set_iterator_to_next (struct it
*it
, int reseat_p
)
5994 /* Reset flags indicating start and end of a sequence of characters
5995 with box. Reset them at the start of this function because
5996 moving the iterator to a new position might set them. */
5997 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6001 case GET_FROM_BUFFER
:
6002 /* The current display element of IT is a character from
6003 current_buffer. Advance in the buffer, and maybe skip over
6004 invisible lines that are so because of selective display. */
6005 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6006 reseat_at_next_visible_line_start (it
, 0);
6007 else if (it
->cmp_it
.id
>= 0)
6009 /* We are currently getting glyphs from a composition. */
6014 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6015 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6016 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6018 it
->cmp_it
.from
= it
->cmp_it
.to
;
6023 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6025 it
->end_charpos
, Qnil
);
6028 else if (! it
->cmp_it
.reversed_p
)
6030 /* Composition created while scanning forward. */
6031 /* Update IT's char/byte positions to point to the first
6032 character of the next grapheme cluster, or to the
6033 character visually after the current composition. */
6034 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6035 bidi_move_to_visually_next (&it
->bidi_it
);
6036 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6037 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6039 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6041 /* Proceed to the next grapheme cluster. */
6042 it
->cmp_it
.from
= it
->cmp_it
.to
;
6046 /* No more grapheme clusters in this composition.
6047 Find the next stop position. */
6048 EMACS_INT stop
= it
->end_charpos
;
6049 if (it
->bidi_it
.scan_dir
< 0)
6050 /* Now we are scanning backward and don't know
6053 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6054 IT_BYTEPOS (*it
), stop
, Qnil
);
6059 /* Composition created while scanning backward. */
6060 /* Update IT's char/byte positions to point to the last
6061 character of the previous grapheme cluster, or the
6062 character visually after the current composition. */
6063 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6064 bidi_move_to_visually_next (&it
->bidi_it
);
6065 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6066 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6067 if (it
->cmp_it
.from
> 0)
6069 /* Proceed to the previous grapheme cluster. */
6070 it
->cmp_it
.to
= it
->cmp_it
.from
;
6074 /* No more grapheme clusters in this composition.
6075 Find the next stop position. */
6076 EMACS_INT stop
= it
->end_charpos
;
6077 if (it
->bidi_it
.scan_dir
< 0)
6078 /* Now we are scanning backward and don't know
6081 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6082 IT_BYTEPOS (*it
), stop
, Qnil
);
6088 xassert (it
->len
!= 0);
6092 IT_BYTEPOS (*it
) += it
->len
;
6093 IT_CHARPOS (*it
) += 1;
6097 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6098 /* If this is a new paragraph, determine its base
6099 direction (a.k.a. its base embedding level). */
6100 if (it
->bidi_it
.new_paragraph
)
6101 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6102 bidi_move_to_visually_next (&it
->bidi_it
);
6103 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6104 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6105 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6107 /* As the scan direction was changed, we must
6108 re-compute the stop position for composition. */
6109 EMACS_INT stop
= it
->end_charpos
;
6110 if (it
->bidi_it
.scan_dir
< 0)
6112 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6113 IT_BYTEPOS (*it
), stop
, Qnil
);
6116 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6120 case GET_FROM_C_STRING
:
6121 /* Current display element of IT is from a C string. */
6122 IT_BYTEPOS (*it
) += it
->len
;
6123 IT_CHARPOS (*it
) += 1;
6126 case GET_FROM_DISPLAY_VECTOR
:
6127 /* Current display element of IT is from a display table entry.
6128 Advance in the display table definition. Reset it to null if
6129 end reached, and continue with characters from buffers/
6131 ++it
->current
.dpvec_index
;
6133 /* Restore face of the iterator to what they were before the
6134 display vector entry (these entries may contain faces). */
6135 it
->face_id
= it
->saved_face_id
;
6137 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6139 int recheck_faces
= it
->ellipsis_p
;
6142 it
->method
= GET_FROM_C_STRING
;
6143 else if (STRINGP (it
->string
))
6144 it
->method
= GET_FROM_STRING
;
6147 it
->method
= GET_FROM_BUFFER
;
6148 it
->object
= it
->w
->buffer
;
6152 it
->current
.dpvec_index
= -1;
6154 /* Skip over characters which were displayed via IT->dpvec. */
6155 if (it
->dpvec_char_len
< 0)
6156 reseat_at_next_visible_line_start (it
, 1);
6157 else if (it
->dpvec_char_len
> 0)
6159 if (it
->method
== GET_FROM_STRING
6160 && it
->n_overlay_strings
> 0)
6161 it
->ignore_overlay_strings_at_pos_p
= 1;
6162 it
->len
= it
->dpvec_char_len
;
6163 set_iterator_to_next (it
, reseat_p
);
6166 /* Maybe recheck faces after display vector */
6168 it
->stop_charpos
= IT_CHARPOS (*it
);
6172 case GET_FROM_STRING
:
6173 /* Current display element is a character from a Lisp string. */
6174 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6175 if (it
->cmp_it
.id
>= 0)
6177 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6178 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6179 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6180 it
->cmp_it
.from
= it
->cmp_it
.to
;
6184 composition_compute_stop_pos (&it
->cmp_it
,
6185 IT_STRING_CHARPOS (*it
),
6186 IT_STRING_BYTEPOS (*it
),
6187 it
->end_charpos
, it
->string
);
6192 IT_STRING_BYTEPOS (*it
) += it
->len
;
6193 IT_STRING_CHARPOS (*it
) += 1;
6196 consider_string_end
:
6198 if (it
->current
.overlay_string_index
>= 0)
6200 /* IT->string is an overlay string. Advance to the
6201 next, if there is one. */
6202 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6205 next_overlay_string (it
);
6207 setup_for_ellipsis (it
, 0);
6212 /* IT->string is not an overlay string. If we reached
6213 its end, and there is something on IT->stack, proceed
6214 with what is on the stack. This can be either another
6215 string, this time an overlay string, or a buffer. */
6216 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6220 if (it
->method
== GET_FROM_STRING
)
6221 goto consider_string_end
;
6226 case GET_FROM_IMAGE
:
6227 case GET_FROM_STRETCH
:
6228 /* The position etc with which we have to proceed are on
6229 the stack. The position may be at the end of a string,
6230 if the `display' property takes up the whole string. */
6231 xassert (it
->sp
> 0);
6233 if (it
->method
== GET_FROM_STRING
)
6234 goto consider_string_end
;
6238 /* There are no other methods defined, so this should be a bug. */
6242 xassert (it
->method
!= GET_FROM_STRING
6243 || (STRINGP (it
->string
)
6244 && IT_STRING_CHARPOS (*it
) >= 0));
6247 /* Load IT's display element fields with information about the next
6248 display element which comes from a display table entry or from the
6249 result of translating a control character to one of the forms `^C'
6252 IT->dpvec holds the glyphs to return as characters.
6253 IT->saved_face_id holds the face id before the display vector--it
6254 is restored into IT->face_id in set_iterator_to_next. */
6257 next_element_from_display_vector (struct it
*it
)
6262 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6264 it
->face_id
= it
->saved_face_id
;
6266 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6267 That seemed totally bogus - so I changed it... */
6268 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6270 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6272 it
->c
= GLYPH_CODE_CHAR (gc
);
6273 it
->len
= CHAR_BYTES (it
->c
);
6275 /* The entry may contain a face id to use. Such a face id is
6276 the id of a Lisp face, not a realized face. A face id of
6277 zero means no face is specified. */
6278 if (it
->dpvec_face_id
>= 0)
6279 it
->face_id
= it
->dpvec_face_id
;
6282 int lface_id
= GLYPH_CODE_FACE (gc
);
6284 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6289 /* Display table entry is invalid. Return a space. */
6290 it
->c
= ' ', it
->len
= 1;
6292 /* Don't change position and object of the iterator here. They are
6293 still the values of the character that had this display table
6294 entry or was translated, and that's what we want. */
6295 it
->what
= IT_CHARACTER
;
6300 /* Load IT with the next display element from Lisp string IT->string.
6301 IT->current.string_pos is the current position within the string.
6302 If IT->current.overlay_string_index >= 0, the Lisp string is an
6306 next_element_from_string (struct it
*it
)
6308 struct text_pos position
;
6310 xassert (STRINGP (it
->string
));
6311 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6312 position
= it
->current
.string_pos
;
6314 /* Time to check for invisible text? */
6315 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6316 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6320 /* Since a handler may have changed IT->method, we must
6322 return GET_NEXT_DISPLAY_ELEMENT (it
);
6325 if (it
->current
.overlay_string_index
>= 0)
6327 /* Get the next character from an overlay string. In overlay
6328 strings, There is no field width or padding with spaces to
6330 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6335 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6336 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6337 && next_element_from_composition (it
))
6341 else if (STRING_MULTIBYTE (it
->string
))
6343 const unsigned char *s
= (SDATA (it
->string
)
6344 + IT_STRING_BYTEPOS (*it
));
6345 it
->c
= string_char_and_length (s
, &it
->len
);
6349 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6355 /* Get the next character from a Lisp string that is not an
6356 overlay string. Such strings come from the mode line, for
6357 example. We may have to pad with spaces, or truncate the
6358 string. See also next_element_from_c_string. */
6359 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6364 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6366 /* Pad with spaces. */
6367 it
->c
= ' ', it
->len
= 1;
6368 CHARPOS (position
) = BYTEPOS (position
) = -1;
6370 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6371 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6372 && next_element_from_composition (it
))
6376 else if (STRING_MULTIBYTE (it
->string
))
6378 const unsigned char *s
= (SDATA (it
->string
)
6379 + IT_STRING_BYTEPOS (*it
));
6380 it
->c
= string_char_and_length (s
, &it
->len
);
6384 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6389 /* Record what we have and where it came from. */
6390 it
->what
= IT_CHARACTER
;
6391 it
->object
= it
->string
;
6392 it
->position
= position
;
6397 /* Load IT with next display element from C string IT->s.
6398 IT->string_nchars is the maximum number of characters to return
6399 from the string. IT->end_charpos may be greater than
6400 IT->string_nchars when this function is called, in which case we
6401 may have to return padding spaces. Value is zero if end of string
6402 reached, including padding spaces. */
6405 next_element_from_c_string (struct it
*it
)
6410 it
->what
= IT_CHARACTER
;
6411 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6414 /* IT's position can be greater IT->string_nchars in case a field
6415 width or precision has been specified when the iterator was
6417 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6419 /* End of the game. */
6423 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6425 /* Pad with spaces. */
6426 it
->c
= ' ', it
->len
= 1;
6427 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6429 else if (it
->multibyte_p
)
6430 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6432 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6438 /* Set up IT to return characters from an ellipsis, if appropriate.
6439 The definition of the ellipsis glyphs may come from a display table
6440 entry. This function fills IT with the first glyph from the
6441 ellipsis if an ellipsis is to be displayed. */
6444 next_element_from_ellipsis (struct it
*it
)
6446 if (it
->selective_display_ellipsis_p
)
6447 setup_for_ellipsis (it
, it
->len
);
6450 /* The face at the current position may be different from the
6451 face we find after the invisible text. Remember what it
6452 was in IT->saved_face_id, and signal that it's there by
6453 setting face_before_selective_p. */
6454 it
->saved_face_id
= it
->face_id
;
6455 it
->method
= GET_FROM_BUFFER
;
6456 it
->object
= it
->w
->buffer
;
6457 reseat_at_next_visible_line_start (it
, 1);
6458 it
->face_before_selective_p
= 1;
6461 return GET_NEXT_DISPLAY_ELEMENT (it
);
6465 /* Deliver an image display element. The iterator IT is already
6466 filled with image information (done in handle_display_prop). Value
6471 next_element_from_image (struct it
*it
)
6473 it
->what
= IT_IMAGE
;
6474 it
->ignore_overlay_strings_at_pos_p
= 0;
6479 /* Fill iterator IT with next display element from a stretch glyph
6480 property. IT->object is the value of the text property. Value is
6484 next_element_from_stretch (struct it
*it
)
6486 it
->what
= IT_STRETCH
;
6490 /* Scan forward from CHARPOS in the current buffer, until we find a
6491 stop position > current IT's position. Then handle the stop
6492 position before that. This is called when we bump into a stop
6493 position while reordering bidirectional text. CHARPOS should be
6494 the last previously processed stop_pos (or BEGV, if none were
6495 processed yet) whose position is less that IT's current
6499 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6501 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6502 struct display_pos save_current
= it
->current
;
6503 struct text_pos save_position
= it
->position
;
6504 struct text_pos pos1
;
6505 EMACS_INT next_stop
;
6507 /* Scan in strict logical order. */
6511 it
->prev_stop
= charpos
;
6512 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6513 reseat_1 (it
, pos1
, 0);
6514 compute_stop_pos (it
);
6515 /* We must advance forward, right? */
6516 if (it
->stop_charpos
<= it
->prev_stop
)
6518 charpos
= it
->stop_charpos
;
6520 while (charpos
<= where_we_are
);
6522 next_stop
= it
->stop_charpos
;
6523 it
->stop_charpos
= it
->prev_stop
;
6525 it
->current
= save_current
;
6526 it
->position
= save_position
;
6528 it
->stop_charpos
= next_stop
;
6531 /* Load IT with the next display element from current_buffer. Value
6532 is zero if end of buffer reached. IT->stop_charpos is the next
6533 position at which to stop and check for text properties or buffer
6537 next_element_from_buffer (struct it
*it
)
6541 xassert (IT_CHARPOS (*it
) >= BEGV
);
6543 /* With bidi reordering, the character to display might not be the
6544 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6545 we were reseat()ed to a new buffer position, which is potentially
6546 a different paragraph. */
6547 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6549 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6550 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6551 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6553 /* Nothing to do, but reset the FIRST_ELT flag, like
6554 bidi_paragraph_init does, because we are not going to
6556 it
->bidi_it
.first_elt
= 0;
6558 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6559 /* FIXME: Should support all Unicode line separators. */
6560 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6561 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6563 /* If we are at the beginning of a line, we can produce the
6564 next element right away. */
6565 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6566 bidi_move_to_visually_next (&it
->bidi_it
);
6570 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6572 /* We need to prime the bidi iterator starting at the line's
6573 beginning, before we will be able to produce the next
6575 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6576 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6577 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6578 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6579 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6582 /* Now return to buffer position where we were asked to
6583 get the next display element, and produce that. */
6584 bidi_move_to_visually_next (&it
->bidi_it
);
6586 while (it
->bidi_it
.bytepos
!= orig_bytepos
6587 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6590 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6591 /* Adjust IT's position information to where we ended up. */
6592 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6593 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6594 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6596 EMACS_INT stop
= it
->end_charpos
;
6597 if (it
->bidi_it
.scan_dir
< 0)
6599 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6600 IT_BYTEPOS (*it
), stop
, Qnil
);
6604 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6606 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6608 int overlay_strings_follow_p
;
6610 /* End of the game, except when overlay strings follow that
6611 haven't been returned yet. */
6612 if (it
->overlay_strings_at_end_processed_p
)
6613 overlay_strings_follow_p
= 0;
6616 it
->overlay_strings_at_end_processed_p
= 1;
6617 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6620 if (overlay_strings_follow_p
)
6621 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6625 it
->position
= it
->current
.pos
;
6629 else if (!(!it
->bidi_p
6630 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6631 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6633 /* With bidi non-linear iteration, we could find ourselves
6634 far beyond the last computed stop_charpos, with several
6635 other stop positions in between that we missed. Scan
6636 them all now, in buffer's logical order, until we find
6637 and handle the last stop_charpos that precedes our
6638 current position. */
6639 handle_stop_backwards (it
, it
->stop_charpos
);
6640 return GET_NEXT_DISPLAY_ELEMENT (it
);
6646 /* Take note of the stop position we just moved across,
6647 for when we will move back across it. */
6648 it
->prev_stop
= it
->stop_charpos
;
6649 /* If we are at base paragraph embedding level, take
6650 note of the last stop position seen at this
6652 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6653 it
->base_level_stop
= it
->stop_charpos
;
6656 return GET_NEXT_DISPLAY_ELEMENT (it
);
6660 /* We can sometimes back up for reasons that have nothing
6661 to do with bidi reordering. E.g., compositions. The
6662 code below is only needed when we are above the base
6663 embedding level, so test for that explicitly. */
6664 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6665 && IT_CHARPOS (*it
) < it
->prev_stop
)
6667 if (it
->base_level_stop
<= 0)
6668 it
->base_level_stop
= BEGV
;
6669 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6671 handle_stop_backwards (it
, it
->base_level_stop
);
6672 return GET_NEXT_DISPLAY_ELEMENT (it
);
6676 /* No face changes, overlays etc. in sight, so just return a
6677 character from current_buffer. */
6681 /* Maybe run the redisplay end trigger hook. Performance note:
6682 This doesn't seem to cost measurable time. */
6683 if (it
->redisplay_end_trigger_charpos
6685 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6686 run_redisplay_end_trigger_hook (it
);
6688 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6689 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6691 && next_element_from_composition (it
))
6696 /* Get the next character, maybe multibyte. */
6697 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6698 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6699 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6701 it
->c
= *p
, it
->len
= 1;
6703 /* Record what we have and where it came from. */
6704 it
->what
= IT_CHARACTER
;
6705 it
->object
= it
->w
->buffer
;
6706 it
->position
= it
->current
.pos
;
6708 /* Normally we return the character found above, except when we
6709 really want to return an ellipsis for selective display. */
6714 /* A value of selective > 0 means hide lines indented more
6715 than that number of columns. */
6716 if (it
->selective
> 0
6717 && IT_CHARPOS (*it
) + 1 < ZV
6718 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6719 IT_BYTEPOS (*it
) + 1,
6720 (double) it
->selective
)) /* iftc */
6722 success_p
= next_element_from_ellipsis (it
);
6723 it
->dpvec_char_len
= -1;
6726 else if (it
->c
== '\r' && it
->selective
== -1)
6728 /* A value of selective == -1 means that everything from the
6729 CR to the end of the line is invisible, with maybe an
6730 ellipsis displayed for it. */
6731 success_p
= next_element_from_ellipsis (it
);
6732 it
->dpvec_char_len
= -1;
6737 /* Value is zero if end of buffer reached. */
6738 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6743 /* Run the redisplay end trigger hook for IT. */
6746 run_redisplay_end_trigger_hook (struct it
*it
)
6748 Lisp_Object args
[3];
6750 /* IT->glyph_row should be non-null, i.e. we should be actually
6751 displaying something, or otherwise we should not run the hook. */
6752 xassert (it
->glyph_row
);
6754 /* Set up hook arguments. */
6755 args
[0] = Qredisplay_end_trigger_functions
;
6756 args
[1] = it
->window
;
6757 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6758 it
->redisplay_end_trigger_charpos
= 0;
6760 /* Since we are *trying* to run these functions, don't try to run
6761 them again, even if they get an error. */
6762 it
->w
->redisplay_end_trigger
= Qnil
;
6763 Frun_hook_with_args (3, args
);
6765 /* Notice if it changed the face of the character we are on. */
6766 handle_face_prop (it
);
6770 /* Deliver a composition display element. Unlike the other
6771 next_element_from_XXX, this function is not registered in the array
6772 get_next_element[]. It is called from next_element_from_buffer and
6773 next_element_from_string when necessary. */
6776 next_element_from_composition (struct it
*it
)
6778 it
->what
= IT_COMPOSITION
;
6779 it
->len
= it
->cmp_it
.nbytes
;
6780 if (STRINGP (it
->string
))
6784 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6785 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6788 it
->position
= it
->current
.string_pos
;
6789 it
->object
= it
->string
;
6790 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6791 IT_STRING_BYTEPOS (*it
), it
->string
);
6797 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6798 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6801 if (it
->bidi_it
.new_paragraph
)
6802 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6803 /* Resync the bidi iterator with IT's new position.
6804 FIXME: this doesn't support bidirectional text. */
6805 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6806 bidi_move_to_visually_next (&it
->bidi_it
);
6810 it
->position
= it
->current
.pos
;
6811 it
->object
= it
->w
->buffer
;
6812 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6813 IT_BYTEPOS (*it
), Qnil
);
6820 /***********************************************************************
6821 Moving an iterator without producing glyphs
6822 ***********************************************************************/
6824 /* Check if iterator is at a position corresponding to a valid buffer
6825 position after some move_it_ call. */
6827 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6828 ((it)->method == GET_FROM_STRING \
6829 ? IT_STRING_CHARPOS (*it) == 0 \
6833 /* Move iterator IT to a specified buffer or X position within one
6834 line on the display without producing glyphs.
6836 OP should be a bit mask including some or all of these bits:
6837 MOVE_TO_X: Stop upon reaching x-position TO_X.
6838 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6839 Regardless of OP's value, stop upon reaching the end of the display line.
6841 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6842 This means, in particular, that TO_X includes window's horizontal
6845 The return value has several possible values that
6846 say what condition caused the scan to stop:
6848 MOVE_POS_MATCH_OR_ZV
6849 - when TO_POS or ZV was reached.
6852 -when TO_X was reached before TO_POS or ZV were reached.
6855 - when we reached the end of the display area and the line must
6859 - when we reached the end of the display area and the line is
6863 - when we stopped at a line end, i.e. a newline or a CR and selective
6866 static enum move_it_result
6867 move_it_in_display_line_to (struct it
*it
,
6868 EMACS_INT to_charpos
, int to_x
,
6869 enum move_operation_enum op
)
6871 enum move_it_result result
= MOVE_UNDEFINED
;
6872 struct glyph_row
*saved_glyph_row
;
6873 struct it wrap_it
, atpos_it
, atx_it
;
6875 enum it_method prev_method
= it
->method
;
6876 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6878 /* Don't produce glyphs in produce_glyphs. */
6879 saved_glyph_row
= it
->glyph_row
;
6880 it
->glyph_row
= NULL
;
6882 /* Use wrap_it to save a copy of IT wherever a word wrap could
6883 occur. Use atpos_it to save a copy of IT at the desired buffer
6884 position, if found, so that we can scan ahead and check if the
6885 word later overshoots the window edge. Use atx_it similarly, for
6891 #define BUFFER_POS_REACHED_P() \
6892 ((op & MOVE_TO_POS) != 0 \
6893 && BUFFERP (it->object) \
6894 && (IT_CHARPOS (*it) == to_charpos \
6895 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6896 && (it->method == GET_FROM_BUFFER \
6897 || (it->method == GET_FROM_DISPLAY_VECTOR \
6898 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6900 /* If there's a line-/wrap-prefix, handle it. */
6901 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6902 && it
->current_y
< it
->last_visible_y
)
6903 handle_line_prefix (it
);
6907 int x
, i
, ascent
= 0, descent
= 0;
6909 /* Utility macro to reset an iterator with x, ascent, and descent. */
6910 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6911 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6912 (IT)->max_descent = descent)
6914 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6916 if ((op
& MOVE_TO_POS
) != 0
6917 && BUFFERP (it
->object
)
6918 && it
->method
== GET_FROM_BUFFER
6919 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6921 && (prev_method
== GET_FROM_IMAGE
6922 || prev_method
== GET_FROM_STRETCH
)
6923 /* Passed TO_CHARPOS from left to right. */
6924 && ((prev_pos
< to_charpos
6925 && IT_CHARPOS (*it
) > to_charpos
)
6926 /* Passed TO_CHARPOS from right to left. */
6927 || (prev_pos
> to_charpos
6928 && IT_CHARPOS (*it
) < to_charpos
)))))
6930 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6932 result
= MOVE_POS_MATCH_OR_ZV
;
6935 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6936 /* If wrap_it is valid, the current position might be in a
6937 word that is wrapped. So, save the iterator in
6938 atpos_it and continue to see if wrapping happens. */
6942 prev_method
= it
->method
;
6943 if (it
->method
== GET_FROM_BUFFER
)
6944 prev_pos
= IT_CHARPOS (*it
);
6945 /* Stop when ZV reached.
6946 We used to stop here when TO_CHARPOS reached as well, but that is
6947 too soon if this glyph does not fit on this line. So we handle it
6948 explicitly below. */
6949 if (!get_next_display_element (it
))
6951 result
= MOVE_POS_MATCH_OR_ZV
;
6955 if (it
->line_wrap
== TRUNCATE
)
6957 if (BUFFER_POS_REACHED_P ())
6959 result
= MOVE_POS_MATCH_OR_ZV
;
6965 if (it
->line_wrap
== WORD_WRAP
)
6967 if (IT_DISPLAYING_WHITESPACE (it
))
6971 /* We have reached a glyph that follows one or more
6972 whitespace characters. If the position is
6973 already found, we are done. */
6974 if (atpos_it
.sp
>= 0)
6977 result
= MOVE_POS_MATCH_OR_ZV
;
6983 result
= MOVE_X_REACHED
;
6986 /* Otherwise, we can wrap here. */
6993 /* Remember the line height for the current line, in case
6994 the next element doesn't fit on the line. */
6995 ascent
= it
->max_ascent
;
6996 descent
= it
->max_descent
;
6998 /* The call to produce_glyphs will get the metrics of the
6999 display element IT is loaded with. Record the x-position
7000 before this display element, in case it doesn't fit on the
7004 PRODUCE_GLYPHS (it
);
7006 if (it
->area
!= TEXT_AREA
)
7008 set_iterator_to_next (it
, 1);
7012 /* The number of glyphs we get back in IT->nglyphs will normally
7013 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7014 character on a terminal frame, or (iii) a line end. For the
7015 second case, IT->nglyphs - 1 padding glyphs will be present.
7016 (On X frames, there is only one glyph produced for a
7017 composite character.)
7019 The behavior implemented below means, for continuation lines,
7020 that as many spaces of a TAB as fit on the current line are
7021 displayed there. For terminal frames, as many glyphs of a
7022 multi-glyph character are displayed in the current line, too.
7023 This is what the old redisplay code did, and we keep it that
7024 way. Under X, the whole shape of a complex character must
7025 fit on the line or it will be completely displayed in the
7028 Note that both for tabs and padding glyphs, all glyphs have
7032 /* More than one glyph or glyph doesn't fit on line. All
7033 glyphs have the same width. */
7034 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7036 int x_before_this_char
= x
;
7037 int hpos_before_this_char
= it
->hpos
;
7039 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7041 new_x
= x
+ single_glyph_width
;
7043 /* We want to leave anything reaching TO_X to the caller. */
7044 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7046 if (BUFFER_POS_REACHED_P ())
7048 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7049 goto buffer_pos_reached
;
7050 if (atpos_it
.sp
< 0)
7053 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7058 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7061 result
= MOVE_X_REACHED
;
7067 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7072 if (/* Lines are continued. */
7073 it
->line_wrap
!= TRUNCATE
7074 && (/* And glyph doesn't fit on the line. */
7075 new_x
> it
->last_visible_x
7076 /* Or it fits exactly and we're on a window
7078 || (new_x
== it
->last_visible_x
7079 && FRAME_WINDOW_P (it
->f
))))
7081 if (/* IT->hpos == 0 means the very first glyph
7082 doesn't fit on the line, e.g. a wide image. */
7084 || (new_x
== it
->last_visible_x
7085 && FRAME_WINDOW_P (it
->f
)))
7088 it
->current_x
= new_x
;
7090 /* The character's last glyph just barely fits
7092 if (i
== it
->nglyphs
- 1)
7094 /* If this is the destination position,
7095 return a position *before* it in this row,
7096 now that we know it fits in this row. */
7097 if (BUFFER_POS_REACHED_P ())
7099 if (it
->line_wrap
!= WORD_WRAP
7102 it
->hpos
= hpos_before_this_char
;
7103 it
->current_x
= x_before_this_char
;
7104 result
= MOVE_POS_MATCH_OR_ZV
;
7107 if (it
->line_wrap
== WORD_WRAP
7111 atpos_it
.current_x
= x_before_this_char
;
7112 atpos_it
.hpos
= hpos_before_this_char
;
7116 set_iterator_to_next (it
, 1);
7117 /* On graphical terminals, newlines may
7118 "overflow" into the fringe if
7119 overflow-newline-into-fringe is non-nil.
7120 On text-only terminals, newlines may
7121 overflow into the last glyph on the
7123 if (!FRAME_WINDOW_P (it
->f
)
7124 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7126 if (!get_next_display_element (it
))
7128 result
= MOVE_POS_MATCH_OR_ZV
;
7131 if (BUFFER_POS_REACHED_P ())
7133 if (ITERATOR_AT_END_OF_LINE_P (it
))
7134 result
= MOVE_POS_MATCH_OR_ZV
;
7136 result
= MOVE_LINE_CONTINUED
;
7139 if (ITERATOR_AT_END_OF_LINE_P (it
))
7141 result
= MOVE_NEWLINE_OR_CR
;
7148 IT_RESET_X_ASCENT_DESCENT (it
);
7150 if (wrap_it
.sp
>= 0)
7157 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7159 result
= MOVE_LINE_CONTINUED
;
7163 if (BUFFER_POS_REACHED_P ())
7165 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7166 goto buffer_pos_reached
;
7167 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7170 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7174 if (new_x
> it
->first_visible_x
)
7176 /* Glyph is visible. Increment number of glyphs that
7177 would be displayed. */
7182 if (result
!= MOVE_UNDEFINED
)
7185 else if (BUFFER_POS_REACHED_P ())
7188 IT_RESET_X_ASCENT_DESCENT (it
);
7189 result
= MOVE_POS_MATCH_OR_ZV
;
7192 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7194 /* Stop when TO_X specified and reached. This check is
7195 necessary here because of lines consisting of a line end,
7196 only. The line end will not produce any glyphs and we
7197 would never get MOVE_X_REACHED. */
7198 xassert (it
->nglyphs
== 0);
7199 result
= MOVE_X_REACHED
;
7203 /* Is this a line end? If yes, we're done. */
7204 if (ITERATOR_AT_END_OF_LINE_P (it
))
7206 result
= MOVE_NEWLINE_OR_CR
;
7210 if (it
->method
== GET_FROM_BUFFER
)
7211 prev_pos
= IT_CHARPOS (*it
);
7212 /* The current display element has been consumed. Advance
7214 set_iterator_to_next (it
, 1);
7216 /* Stop if lines are truncated and IT's current x-position is
7217 past the right edge of the window now. */
7218 if (it
->line_wrap
== TRUNCATE
7219 && it
->current_x
>= it
->last_visible_x
)
7221 if (!FRAME_WINDOW_P (it
->f
)
7222 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7224 if (!get_next_display_element (it
)
7225 || BUFFER_POS_REACHED_P ())
7227 result
= MOVE_POS_MATCH_OR_ZV
;
7230 if (ITERATOR_AT_END_OF_LINE_P (it
))
7232 result
= MOVE_NEWLINE_OR_CR
;
7236 result
= MOVE_LINE_TRUNCATED
;
7239 #undef IT_RESET_X_ASCENT_DESCENT
7242 #undef BUFFER_POS_REACHED_P
7244 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7245 restore the saved iterator. */
7246 if (atpos_it
.sp
>= 0)
7248 else if (atx_it
.sp
>= 0)
7253 /* Restore the iterator settings altered at the beginning of this
7255 it
->glyph_row
= saved_glyph_row
;
7259 /* For external use. */
7261 move_it_in_display_line (struct it
*it
,
7262 EMACS_INT to_charpos
, int to_x
,
7263 enum move_operation_enum op
)
7265 if (it
->line_wrap
== WORD_WRAP
7266 && (op
& MOVE_TO_X
))
7268 struct it save_it
= *it
;
7269 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7270 /* When word-wrap is on, TO_X may lie past the end
7271 of a wrapped line. Then it->current is the
7272 character on the next line, so backtrack to the
7273 space before the wrap point. */
7274 if (skip
== MOVE_LINE_CONTINUED
)
7276 int prev_x
= max (it
->current_x
- 1, 0);
7278 move_it_in_display_line_to
7279 (it
, -1, prev_x
, MOVE_TO_X
);
7283 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7287 /* Move IT forward until it satisfies one or more of the criteria in
7288 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7290 OP is a bit-mask that specifies where to stop, and in particular,
7291 which of those four position arguments makes a difference. See the
7292 description of enum move_operation_enum.
7294 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7295 screen line, this function will set IT to the next position >
7299 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7301 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7302 int line_height
, line_start_x
= 0, reached
= 0;
7306 if (op
& MOVE_TO_VPOS
)
7308 /* If no TO_CHARPOS and no TO_X specified, stop at the
7309 start of the line TO_VPOS. */
7310 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7312 if (it
->vpos
== to_vpos
)
7318 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7322 /* TO_VPOS >= 0 means stop at TO_X in the line at
7323 TO_VPOS, or at TO_POS, whichever comes first. */
7324 if (it
->vpos
== to_vpos
)
7330 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7332 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7337 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7339 /* We have reached TO_X but not in the line we want. */
7340 skip
= move_it_in_display_line_to (it
, to_charpos
,
7342 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7350 else if (op
& MOVE_TO_Y
)
7352 struct it it_backup
;
7354 if (it
->line_wrap
== WORD_WRAP
)
7357 /* TO_Y specified means stop at TO_X in the line containing
7358 TO_Y---or at TO_CHARPOS if this is reached first. The
7359 problem is that we can't really tell whether the line
7360 contains TO_Y before we have completely scanned it, and
7361 this may skip past TO_X. What we do is to first scan to
7364 If TO_X is not specified, use a TO_X of zero. The reason
7365 is to make the outcome of this function more predictable.
7366 If we didn't use TO_X == 0, we would stop at the end of
7367 the line which is probably not what a caller would expect
7369 skip
= move_it_in_display_line_to
7370 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7371 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7373 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7374 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7376 else if (skip
== MOVE_X_REACHED
)
7378 /* If TO_X was reached, we want to know whether TO_Y is
7379 in the line. We know this is the case if the already
7380 scanned glyphs make the line tall enough. Otherwise,
7381 we must check by scanning the rest of the line. */
7382 line_height
= it
->max_ascent
+ it
->max_descent
;
7383 if (to_y
>= it
->current_y
7384 && to_y
< it
->current_y
+ line_height
)
7390 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7391 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7393 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7394 line_height
= it
->max_ascent
+ it
->max_descent
;
7395 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7397 if (to_y
>= it
->current_y
7398 && to_y
< it
->current_y
+ line_height
)
7400 /* If TO_Y is in this line and TO_X was reached
7401 above, we scanned too far. We have to restore
7402 IT's settings to the ones before skipping. */
7409 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7415 /* Check whether TO_Y is in this line. */
7416 line_height
= it
->max_ascent
+ it
->max_descent
;
7417 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7419 if (to_y
>= it
->current_y
7420 && to_y
< it
->current_y
+ line_height
)
7422 /* When word-wrap is on, TO_X may lie past the end
7423 of a wrapped line. Then it->current is the
7424 character on the next line, so backtrack to the
7425 space before the wrap point. */
7426 if (skip
== MOVE_LINE_CONTINUED
7427 && it
->line_wrap
== WORD_WRAP
)
7429 int prev_x
= max (it
->current_x
- 1, 0);
7431 skip
= move_it_in_display_line_to
7432 (it
, -1, prev_x
, MOVE_TO_X
);
7441 else if (BUFFERP (it
->object
)
7442 && (it
->method
== GET_FROM_BUFFER
7443 || it
->method
== GET_FROM_STRETCH
)
7444 && IT_CHARPOS (*it
) >= to_charpos
)
7445 skip
= MOVE_POS_MATCH_OR_ZV
;
7447 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7451 case MOVE_POS_MATCH_OR_ZV
:
7455 case MOVE_NEWLINE_OR_CR
:
7456 set_iterator_to_next (it
, 1);
7457 it
->continuation_lines_width
= 0;
7460 case MOVE_LINE_TRUNCATED
:
7461 it
->continuation_lines_width
= 0;
7462 reseat_at_next_visible_line_start (it
, 0);
7463 if ((op
& MOVE_TO_POS
) != 0
7464 && IT_CHARPOS (*it
) > to_charpos
)
7471 case MOVE_LINE_CONTINUED
:
7472 /* For continued lines ending in a tab, some of the glyphs
7473 associated with the tab are displayed on the current
7474 line. Since it->current_x does not include these glyphs,
7475 we use it->last_visible_x instead. */
7478 it
->continuation_lines_width
+= it
->last_visible_x
;
7479 /* When moving by vpos, ensure that the iterator really
7480 advances to the next line (bug#847, bug#969). Fixme:
7481 do we need to do this in other circumstances? */
7482 if (it
->current_x
!= it
->last_visible_x
7483 && (op
& MOVE_TO_VPOS
)
7484 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7486 line_start_x
= it
->current_x
+ it
->pixel_width
7487 - it
->last_visible_x
;
7488 set_iterator_to_next (it
, 0);
7492 it
->continuation_lines_width
+= it
->current_x
;
7499 /* Reset/increment for the next run. */
7500 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7501 it
->current_x
= line_start_x
;
7504 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7506 last_height
= it
->max_ascent
+ it
->max_descent
;
7507 last_max_ascent
= it
->max_ascent
;
7508 it
->max_ascent
= it
->max_descent
= 0;
7513 /* On text terminals, we may stop at the end of a line in the middle
7514 of a multi-character glyph. If the glyph itself is continued,
7515 i.e. it is actually displayed on the next line, don't treat this
7516 stopping point as valid; move to the next line instead (unless
7517 that brings us offscreen). */
7518 if (!FRAME_WINDOW_P (it
->f
)
7520 && IT_CHARPOS (*it
) == to_charpos
7521 && it
->what
== IT_CHARACTER
7523 && it
->line_wrap
== WINDOW_WRAP
7524 && it
->current_x
== it
->last_visible_x
- 1
7527 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7529 it
->continuation_lines_width
+= it
->current_x
;
7530 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7531 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7533 last_height
= it
->max_ascent
+ it
->max_descent
;
7534 last_max_ascent
= it
->max_ascent
;
7537 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7541 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7543 If DY > 0, move IT backward at least that many pixels. DY = 0
7544 means move IT backward to the preceding line start or BEGV. This
7545 function may move over more than DY pixels if IT->current_y - DY
7546 ends up in the middle of a line; in this case IT->current_y will be
7547 set to the top of the line moved to. */
7550 move_it_vertically_backward (struct it
*it
, int dy
)
7554 EMACS_INT start_pos
;
7559 start_pos
= IT_CHARPOS (*it
);
7561 /* Estimate how many newlines we must move back. */
7562 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7564 /* Set the iterator's position that many lines back. */
7565 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7566 back_to_previous_visible_line_start (it
);
7568 /* Reseat the iterator here. When moving backward, we don't want
7569 reseat to skip forward over invisible text, set up the iterator
7570 to deliver from overlay strings at the new position etc. So,
7571 use reseat_1 here. */
7572 reseat_1 (it
, it
->current
.pos
, 1);
7574 /* We are now surely at a line start. */
7575 it
->current_x
= it
->hpos
= 0;
7576 it
->continuation_lines_width
= 0;
7578 /* Move forward and see what y-distance we moved. First move to the
7579 start of the next line so that we get its height. We need this
7580 height to be able to tell whether we reached the specified
7583 it2
.max_ascent
= it2
.max_descent
= 0;
7586 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7587 MOVE_TO_POS
| MOVE_TO_VPOS
);
7589 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7590 xassert (IT_CHARPOS (*it
) >= BEGV
);
7593 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7594 xassert (IT_CHARPOS (*it
) >= BEGV
);
7595 /* H is the actual vertical distance from the position in *IT
7596 and the starting position. */
7597 h
= it2
.current_y
- it
->current_y
;
7598 /* NLINES is the distance in number of lines. */
7599 nlines
= it2
.vpos
- it
->vpos
;
7601 /* Correct IT's y and vpos position
7602 so that they are relative to the starting point. */
7608 /* DY == 0 means move to the start of the screen line. The
7609 value of nlines is > 0 if continuation lines were involved. */
7611 move_it_by_lines (it
, nlines
, 1);
7615 /* The y-position we try to reach, relative to *IT.
7616 Note that H has been subtracted in front of the if-statement. */
7617 int target_y
= it
->current_y
+ h
- dy
;
7618 int y0
= it3
.current_y
;
7619 int y1
= line_bottom_y (&it3
);
7620 int line_height
= y1
- y0
;
7622 /* If we did not reach target_y, try to move further backward if
7623 we can. If we moved too far backward, try to move forward. */
7624 if (target_y
< it
->current_y
7625 /* This is heuristic. In a window that's 3 lines high, with
7626 a line height of 13 pixels each, recentering with point
7627 on the bottom line will try to move -39/2 = 19 pixels
7628 backward. Try to avoid moving into the first line. */
7629 && (it
->current_y
- target_y
7630 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7631 && IT_CHARPOS (*it
) > BEGV
)
7633 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7634 target_y
- it
->current_y
));
7635 dy
= it
->current_y
- target_y
;
7636 goto move_further_back
;
7638 else if (target_y
>= it
->current_y
+ line_height
7639 && IT_CHARPOS (*it
) < ZV
)
7641 /* Should move forward by at least one line, maybe more.
7643 Note: Calling move_it_by_lines can be expensive on
7644 terminal frames, where compute_motion is used (via
7645 vmotion) to do the job, when there are very long lines
7646 and truncate-lines is nil. That's the reason for
7647 treating terminal frames specially here. */
7649 if (!FRAME_WINDOW_P (it
->f
))
7650 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7655 move_it_by_lines (it
, 1, 1);
7657 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7664 /* Move IT by a specified amount of pixel lines DY. DY negative means
7665 move backwards. DY = 0 means move to start of screen line. At the
7666 end, IT will be on the start of a screen line. */
7669 move_it_vertically (struct it
*it
, int dy
)
7672 move_it_vertically_backward (it
, -dy
);
7675 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7676 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7677 MOVE_TO_POS
| MOVE_TO_Y
);
7678 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7680 /* If buffer ends in ZV without a newline, move to the start of
7681 the line to satisfy the post-condition. */
7682 if (IT_CHARPOS (*it
) == ZV
7684 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7685 move_it_by_lines (it
, 0, 0);
7690 /* Move iterator IT past the end of the text line it is in. */
7693 move_it_past_eol (struct it
*it
)
7695 enum move_it_result rc
;
7697 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7698 if (rc
== MOVE_NEWLINE_OR_CR
)
7699 set_iterator_to_next (it
, 0);
7703 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7704 negative means move up. DVPOS == 0 means move to the start of the
7705 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7706 NEED_Y_P is zero, IT->current_y will be left unchanged.
7708 Further optimization ideas: If we would know that IT->f doesn't use
7709 a face with proportional font, we could be faster for
7710 truncate-lines nil. */
7713 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7716 /* The commented-out optimization uses vmotion on terminals. This
7717 gives bad results, because elements like it->what, on which
7718 callers such as pos_visible_p rely, aren't updated. */
7719 /* struct position pos;
7720 if (!FRAME_WINDOW_P (it->f))
7722 struct text_pos textpos;
7724 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7725 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7726 reseat (it, textpos, 1);
7727 it->vpos += pos.vpos;
7728 it->current_y += pos.vpos;
7734 /* DVPOS == 0 means move to the start of the screen line. */
7735 move_it_vertically_backward (it
, 0);
7736 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7737 /* Let next call to line_bottom_y calculate real line height */
7742 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7743 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7744 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7749 EMACS_INT start_charpos
, i
;
7751 /* Start at the beginning of the screen line containing IT's
7752 position. This may actually move vertically backwards,
7753 in case of overlays, so adjust dvpos accordingly. */
7755 move_it_vertically_backward (it
, 0);
7758 /* Go back -DVPOS visible lines and reseat the iterator there. */
7759 start_charpos
= IT_CHARPOS (*it
);
7760 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7761 back_to_previous_visible_line_start (it
);
7762 reseat (it
, it
->current
.pos
, 1);
7764 /* Move further back if we end up in a string or an image. */
7765 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7767 /* First try to move to start of display line. */
7769 move_it_vertically_backward (it
, 0);
7771 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7773 /* If start of line is still in string or image,
7774 move further back. */
7775 back_to_previous_visible_line_start (it
);
7776 reseat (it
, it
->current
.pos
, 1);
7780 it
->current_x
= it
->hpos
= 0;
7782 /* Above call may have moved too far if continuation lines
7783 are involved. Scan forward and see if it did. */
7785 it2
.vpos
= it2
.current_y
= 0;
7786 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7787 it
->vpos
-= it2
.vpos
;
7788 it
->current_y
-= it2
.current_y
;
7789 it
->current_x
= it
->hpos
= 0;
7791 /* If we moved too far back, move IT some lines forward. */
7792 if (it2
.vpos
> -dvpos
)
7794 int delta
= it2
.vpos
+ dvpos
;
7796 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7797 /* Move back again if we got too far ahead. */
7798 if (IT_CHARPOS (*it
) >= start_charpos
)
7804 /* Return 1 if IT points into the middle of a display vector. */
7807 in_display_vector_p (struct it
*it
)
7809 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7810 && it
->current
.dpvec_index
> 0
7811 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7815 /***********************************************************************
7817 ***********************************************************************/
7820 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7824 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7826 Lisp_Object args
[3];
7827 Lisp_Object msg
, fmt
;
7830 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7833 /* Do nothing if called asynchronously. Inserting text into
7834 a buffer may call after-change-functions and alike and
7835 that would means running Lisp asynchronously. */
7836 if (handling_signal
)
7840 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7842 args
[0] = fmt
= build_string (format
);
7845 msg
= Fformat (3, args
);
7847 len
= SBYTES (msg
) + 1;
7848 SAFE_ALLOCA (buffer
, char *, len
);
7849 memcpy (buffer
, SDATA (msg
), len
);
7851 message_dolog (buffer
, len
- 1, 1, 0);
7858 /* Output a newline in the *Messages* buffer if "needs" one. */
7861 message_log_maybe_newline (void)
7863 if (message_log_need_newline
)
7864 message_dolog ("", 0, 1, 0);
7868 /* Add a string M of length NBYTES to the message log, optionally
7869 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7870 nonzero, means interpret the contents of M as multibyte. This
7871 function calls low-level routines in order to bypass text property
7872 hooks, etc. which might not be safe to run.
7874 This may GC (insert may run before/after change hooks),
7875 so the buffer M must NOT point to a Lisp string. */
7878 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7880 if (!NILP (Vmemory_full
))
7883 if (!NILP (Vmessage_log_max
))
7885 struct buffer
*oldbuf
;
7886 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7887 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7888 EMACS_INT point_at_end
= 0;
7889 EMACS_INT zv_at_end
= 0;
7890 Lisp_Object old_deactivate_mark
, tem
;
7891 struct gcpro gcpro1
;
7893 old_deactivate_mark
= Vdeactivate_mark
;
7894 oldbuf
= current_buffer
;
7895 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7896 current_buffer
->undo_list
= Qt
;
7898 oldpoint
= message_dolog_marker1
;
7899 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7900 oldbegv
= message_dolog_marker2
;
7901 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7902 oldzv
= message_dolog_marker3
;
7903 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7904 GCPRO1 (old_deactivate_mark
);
7912 BEGV_BYTE
= BEG_BYTE
;
7915 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7917 /* Insert the string--maybe converting multibyte to single byte
7918 or vice versa, so that all the text fits the buffer. */
7920 && NILP (current_buffer
->enable_multibyte_characters
))
7924 unsigned char work
[1];
7926 /* Convert a multibyte string to single-byte
7927 for the *Message* buffer. */
7928 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7930 c
= string_char_and_length (m
+ i
, &char_bytes
);
7931 work
[0] = (ASCII_CHAR_P (c
)
7933 : multibyte_char_to_unibyte (c
, Qnil
));
7934 insert_1_both (work
, 1, 1, 1, 0, 0);
7937 else if (! multibyte
7938 && ! NILP (current_buffer
->enable_multibyte_characters
))
7942 unsigned char *msg
= (unsigned char *) m
;
7943 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7944 /* Convert a single-byte string to multibyte
7945 for the *Message* buffer. */
7946 for (i
= 0; i
< nbytes
; i
++)
7949 MAKE_CHAR_MULTIBYTE (c
);
7950 char_bytes
= CHAR_STRING (c
, str
);
7951 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7955 insert_1 (m
, nbytes
, 1, 0, 0);
7959 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7961 insert_1 ("\n", 1, 1, 0, 0);
7963 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7965 this_bol_byte
= PT_BYTE
;
7967 /* See if this line duplicates the previous one.
7968 If so, combine duplicates. */
7971 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7973 prev_bol_byte
= PT_BYTE
;
7975 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7976 this_bol
, this_bol_byte
);
7979 del_range_both (prev_bol
, prev_bol_byte
,
7980 this_bol
, this_bol_byte
, 0);
7986 /* If you change this format, don't forget to also
7987 change message_log_check_duplicate. */
7988 sprintf (dupstr
, " [%d times]", dup
);
7989 duplen
= strlen (dupstr
);
7990 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7991 insert_1 (dupstr
, duplen
, 1, 0, 1);
7996 /* If we have more than the desired maximum number of lines
7997 in the *Messages* buffer now, delete the oldest ones.
7998 This is safe because we don't have undo in this buffer. */
8000 if (NATNUMP (Vmessage_log_max
))
8002 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8003 -XFASTINT (Vmessage_log_max
) - 1, 0);
8004 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8007 BEGV
= XMARKER (oldbegv
)->charpos
;
8008 BEGV_BYTE
= marker_byte_position (oldbegv
);
8017 ZV
= XMARKER (oldzv
)->charpos
;
8018 ZV_BYTE
= marker_byte_position (oldzv
);
8022 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8024 /* We can't do Fgoto_char (oldpoint) because it will run some
8026 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8027 XMARKER (oldpoint
)->bytepos
);
8030 unchain_marker (XMARKER (oldpoint
));
8031 unchain_marker (XMARKER (oldbegv
));
8032 unchain_marker (XMARKER (oldzv
));
8034 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8035 set_buffer_internal (oldbuf
);
8037 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8038 message_log_need_newline
= !nlflag
;
8039 Vdeactivate_mark
= old_deactivate_mark
;
8044 /* We are at the end of the buffer after just having inserted a newline.
8045 (Note: We depend on the fact we won't be crossing the gap.)
8046 Check to see if the most recent message looks a lot like the previous one.
8047 Return 0 if different, 1 if the new one should just replace it, or a
8048 value N > 1 if we should also append " [N times]". */
8051 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8052 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8055 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8057 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8058 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8060 for (i
= 0; i
< len
; i
++)
8062 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8070 if (*p1
++ == ' ' && *p1
++ == '[')
8073 while (*p1
>= '0' && *p1
<= '9')
8074 n
= n
* 10 + *p1
++ - '0';
8075 if (strncmp (p1
, " times]\n", 8) == 0)
8082 /* Display an echo area message M with a specified length of NBYTES
8083 bytes. The string may include null characters. If M is 0, clear
8084 out any existing message, and let the mini-buffer text show
8087 This may GC, so the buffer M must NOT point to a Lisp string. */
8090 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8092 /* First flush out any partial line written with print. */
8093 message_log_maybe_newline ();
8095 message_dolog (m
, nbytes
, 1, multibyte
);
8096 message2_nolog (m
, nbytes
, multibyte
);
8100 /* The non-logging counterpart of message2. */
8103 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8105 struct frame
*sf
= SELECTED_FRAME ();
8106 message_enable_multibyte
= multibyte
;
8108 if (FRAME_INITIAL_P (sf
))
8110 if (noninteractive_need_newline
)
8111 putc ('\n', stderr
);
8112 noninteractive_need_newline
= 0;
8114 fwrite (m
, nbytes
, 1, stderr
);
8115 if (cursor_in_echo_area
== 0)
8116 fprintf (stderr
, "\n");
8119 /* A null message buffer means that the frame hasn't really been
8120 initialized yet. Error messages get reported properly by
8121 cmd_error, so this must be just an informative message; toss it. */
8122 else if (INTERACTIVE
8123 && sf
->glyphs_initialized_p
8124 && FRAME_MESSAGE_BUF (sf
))
8126 Lisp_Object mini_window
;
8129 /* Get the frame containing the mini-buffer
8130 that the selected frame is using. */
8131 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8132 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8134 FRAME_SAMPLE_VISIBILITY (f
);
8135 if (FRAME_VISIBLE_P (sf
)
8136 && ! FRAME_VISIBLE_P (f
))
8137 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8141 set_message (m
, Qnil
, nbytes
, multibyte
);
8142 if (minibuffer_auto_raise
)
8143 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8146 clear_message (1, 1);
8148 do_pending_window_change (0);
8149 echo_area_display (1);
8150 do_pending_window_change (0);
8151 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8152 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8157 /* Display an echo area message M with a specified length of NBYTES
8158 bytes. The string may include null characters. If M is not a
8159 string, clear out any existing message, and let the mini-buffer
8162 This function cancels echoing. */
8165 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8167 struct gcpro gcpro1
;
8170 clear_message (1,1);
8173 /* First flush out any partial line written with print. */
8174 message_log_maybe_newline ();
8180 SAFE_ALLOCA (buffer
, char *, nbytes
);
8181 memcpy (buffer
, SDATA (m
), nbytes
);
8182 message_dolog (buffer
, nbytes
, 1, multibyte
);
8185 message3_nolog (m
, nbytes
, multibyte
);
8191 /* The non-logging version of message3.
8192 This does not cancel echoing, because it is used for echoing.
8193 Perhaps we need to make a separate function for echoing
8194 and make this cancel echoing. */
8197 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8199 struct frame
*sf
= SELECTED_FRAME ();
8200 message_enable_multibyte
= multibyte
;
8202 if (FRAME_INITIAL_P (sf
))
8204 if (noninteractive_need_newline
)
8205 putc ('\n', stderr
);
8206 noninteractive_need_newline
= 0;
8208 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8209 if (cursor_in_echo_area
== 0)
8210 fprintf (stderr
, "\n");
8213 /* A null message buffer means that the frame hasn't really been
8214 initialized yet. Error messages get reported properly by
8215 cmd_error, so this must be just an informative message; toss it. */
8216 else if (INTERACTIVE
8217 && sf
->glyphs_initialized_p
8218 && FRAME_MESSAGE_BUF (sf
))
8220 Lisp_Object mini_window
;
8224 /* Get the frame containing the mini-buffer
8225 that the selected frame is using. */
8226 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8227 frame
= XWINDOW (mini_window
)->frame
;
8230 FRAME_SAMPLE_VISIBILITY (f
);
8231 if (FRAME_VISIBLE_P (sf
)
8232 && !FRAME_VISIBLE_P (f
))
8233 Fmake_frame_visible (frame
);
8235 if (STRINGP (m
) && SCHARS (m
) > 0)
8237 set_message (NULL
, m
, nbytes
, multibyte
);
8238 if (minibuffer_auto_raise
)
8239 Fraise_frame (frame
);
8240 /* Assume we are not echoing.
8241 (If we are, echo_now will override this.) */
8242 echo_message_buffer
= Qnil
;
8245 clear_message (1, 1);
8247 do_pending_window_change (0);
8248 echo_area_display (1);
8249 do_pending_window_change (0);
8250 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8251 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8256 /* Display a null-terminated echo area message M. If M is 0, clear
8257 out any existing message, and let the mini-buffer text show through.
8259 The buffer M must continue to exist until after the echo area gets
8260 cleared or some other message gets displayed there. Do not pass
8261 text that is stored in a Lisp string. Do not pass text in a buffer
8262 that was alloca'd. */
8265 message1 (const char *m
)
8267 message2 (m
, (m
? strlen (m
) : 0), 0);
8271 /* The non-logging counterpart of message1. */
8274 message1_nolog (const char *m
)
8276 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8279 /* Display a message M which contains a single %s
8280 which gets replaced with STRING. */
8283 message_with_string (const char *m
, Lisp_Object string
, int log
)
8285 CHECK_STRING (string
);
8291 if (noninteractive_need_newline
)
8292 putc ('\n', stderr
);
8293 noninteractive_need_newline
= 0;
8294 fprintf (stderr
, m
, SDATA (string
));
8295 if (!cursor_in_echo_area
)
8296 fprintf (stderr
, "\n");
8300 else if (INTERACTIVE
)
8302 /* The frame whose minibuffer we're going to display the message on.
8303 It may be larger than the selected frame, so we need
8304 to use its buffer, not the selected frame's buffer. */
8305 Lisp_Object mini_window
;
8306 struct frame
*f
, *sf
= SELECTED_FRAME ();
8308 /* Get the frame containing the minibuffer
8309 that the selected frame is using. */
8310 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8311 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8313 /* A null message buffer means that the frame hasn't really been
8314 initialized yet. Error messages get reported properly by
8315 cmd_error, so this must be just an informative message; toss it. */
8316 if (FRAME_MESSAGE_BUF (f
))
8318 Lisp_Object args
[2], message
;
8319 struct gcpro gcpro1
, gcpro2
;
8321 args
[0] = build_string (m
);
8322 args
[1] = message
= string
;
8323 GCPRO2 (args
[0], message
);
8326 message
= Fformat (2, args
);
8329 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8331 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8335 /* Print should start at the beginning of the message
8336 buffer next time. */
8337 message_buf_print
= 0;
8343 /* Dump an informative message to the minibuf. If M is 0, clear out
8344 any existing message, and let the mini-buffer text show through. */
8347 vmessage (const char *m
, va_list ap
)
8353 if (noninteractive_need_newline
)
8354 putc ('\n', stderr
);
8355 noninteractive_need_newline
= 0;
8356 vfprintf (stderr
, m
, ap
);
8357 if (cursor_in_echo_area
== 0)
8358 fprintf (stderr
, "\n");
8362 else if (INTERACTIVE
)
8364 /* The frame whose mini-buffer we're going to display the message
8365 on. It may be larger than the selected frame, so we need to
8366 use its buffer, not the selected frame's buffer. */
8367 Lisp_Object mini_window
;
8368 struct frame
*f
, *sf
= SELECTED_FRAME ();
8370 /* Get the frame containing the mini-buffer
8371 that the selected frame is using. */
8372 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8373 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8375 /* A null message buffer means that the frame hasn't really been
8376 initialized yet. Error messages get reported properly by
8377 cmd_error, so this must be just an informative message; toss
8379 if (FRAME_MESSAGE_BUF (f
))
8385 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8386 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8388 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8393 /* Print should start at the beginning of the message
8394 buffer next time. */
8395 message_buf_print
= 0;
8401 message (const char *m
, ...)
8410 /* The non-logging version of message. */
8413 message_nolog (const char *m
, ...)
8415 Lisp_Object old_log_max
;
8418 old_log_max
= Vmessage_log_max
;
8419 Vmessage_log_max
= Qnil
;
8421 Vmessage_log_max
= old_log_max
;
8426 /* Display the current message in the current mini-buffer. This is
8427 only called from error handlers in process.c, and is not time
8431 update_echo_area (void)
8433 if (!NILP (echo_area_buffer
[0]))
8436 string
= Fcurrent_message ();
8437 message3 (string
, SBYTES (string
),
8438 !NILP (current_buffer
->enable_multibyte_characters
));
8443 /* Make sure echo area buffers in `echo_buffers' are live.
8444 If they aren't, make new ones. */
8447 ensure_echo_area_buffers (void)
8451 for (i
= 0; i
< 2; ++i
)
8452 if (!BUFFERP (echo_buffer
[i
])
8453 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8456 Lisp_Object old_buffer
;
8459 old_buffer
= echo_buffer
[i
];
8460 sprintf (name
, " *Echo Area %d*", i
);
8461 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8462 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8463 /* to force word wrap in echo area -
8464 it was decided to postpone this*/
8465 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8467 for (j
= 0; j
< 2; ++j
)
8468 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8469 echo_area_buffer
[j
] = echo_buffer
[i
];
8474 /* Call FN with args A1..A4 with either the current or last displayed
8475 echo_area_buffer as current buffer.
8477 WHICH zero means use the current message buffer
8478 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8479 from echo_buffer[] and clear it.
8481 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8482 suitable buffer from echo_buffer[] and clear it.
8484 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8485 that the current message becomes the last displayed one, make
8486 choose a suitable buffer for echo_area_buffer[0], and clear it.
8488 Value is what FN returns. */
8491 with_echo_area_buffer (struct window
*w
, int which
,
8492 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8493 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8496 int this_one
, the_other
, clear_buffer_p
, rc
;
8497 int count
= SPECPDL_INDEX ();
8499 /* If buffers aren't live, make new ones. */
8500 ensure_echo_area_buffers ();
8505 this_one
= 0, the_other
= 1;
8507 this_one
= 1, the_other
= 0;
8510 this_one
= 0, the_other
= 1;
8513 /* We need a fresh one in case the current echo buffer equals
8514 the one containing the last displayed echo area message. */
8515 if (!NILP (echo_area_buffer
[this_one
])
8516 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8517 echo_area_buffer
[this_one
] = Qnil
;
8520 /* Choose a suitable buffer from echo_buffer[] is we don't
8522 if (NILP (echo_area_buffer
[this_one
]))
8524 echo_area_buffer
[this_one
]
8525 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8526 ? echo_buffer
[the_other
]
8527 : echo_buffer
[this_one
]);
8531 buffer
= echo_area_buffer
[this_one
];
8533 /* Don't get confused by reusing the buffer used for echoing
8534 for a different purpose. */
8535 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8538 record_unwind_protect (unwind_with_echo_area_buffer
,
8539 with_echo_area_buffer_unwind_data (w
));
8541 /* Make the echo area buffer current. Note that for display
8542 purposes, it is not necessary that the displayed window's buffer
8543 == current_buffer, except for text property lookup. So, let's
8544 only set that buffer temporarily here without doing a full
8545 Fset_window_buffer. We must also change w->pointm, though,
8546 because otherwise an assertions in unshow_buffer fails, and Emacs
8548 set_buffer_internal_1 (XBUFFER (buffer
));
8552 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8555 current_buffer
->undo_list
= Qt
;
8556 current_buffer
->read_only
= Qnil
;
8557 specbind (Qinhibit_read_only
, Qt
);
8558 specbind (Qinhibit_modification_hooks
, Qt
);
8560 if (clear_buffer_p
&& Z
> BEG
)
8563 xassert (BEGV
>= BEG
);
8564 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8566 rc
= fn (a1
, a2
, a3
, a4
);
8568 xassert (BEGV
>= BEG
);
8569 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8571 unbind_to (count
, Qnil
);
8576 /* Save state that should be preserved around the call to the function
8577 FN called in with_echo_area_buffer. */
8580 with_echo_area_buffer_unwind_data (struct window
*w
)
8583 Lisp_Object vector
, tmp
;
8585 /* Reduce consing by keeping one vector in
8586 Vwith_echo_area_save_vector. */
8587 vector
= Vwith_echo_area_save_vector
;
8588 Vwith_echo_area_save_vector
= Qnil
;
8591 vector
= Fmake_vector (make_number (7), Qnil
);
8593 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8594 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8595 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8599 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8600 ASET (vector
, i
, w
->buffer
); ++i
;
8601 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8602 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8607 for (; i
< end
; ++i
)
8608 ASET (vector
, i
, Qnil
);
8611 xassert (i
== ASIZE (vector
));
8616 /* Restore global state from VECTOR which was created by
8617 with_echo_area_buffer_unwind_data. */
8620 unwind_with_echo_area_buffer (Lisp_Object vector
)
8622 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8623 Vdeactivate_mark
= AREF (vector
, 1);
8624 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8626 if (WINDOWP (AREF (vector
, 3)))
8629 Lisp_Object buffer
, charpos
, bytepos
;
8631 w
= XWINDOW (AREF (vector
, 3));
8632 buffer
= AREF (vector
, 4);
8633 charpos
= AREF (vector
, 5);
8634 bytepos
= AREF (vector
, 6);
8637 set_marker_both (w
->pointm
, buffer
,
8638 XFASTINT (charpos
), XFASTINT (bytepos
));
8641 Vwith_echo_area_save_vector
= vector
;
8646 /* Set up the echo area for use by print functions. MULTIBYTE_P
8647 non-zero means we will print multibyte. */
8650 setup_echo_area_for_printing (int multibyte_p
)
8652 /* If we can't find an echo area any more, exit. */
8653 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8656 ensure_echo_area_buffers ();
8658 if (!message_buf_print
)
8660 /* A message has been output since the last time we printed.
8661 Choose a fresh echo area buffer. */
8662 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8663 echo_area_buffer
[0] = echo_buffer
[1];
8665 echo_area_buffer
[0] = echo_buffer
[0];
8667 /* Switch to that buffer and clear it. */
8668 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8669 current_buffer
->truncate_lines
= Qnil
;
8673 int count
= SPECPDL_INDEX ();
8674 specbind (Qinhibit_read_only
, Qt
);
8675 /* Note that undo recording is always disabled. */
8677 unbind_to (count
, Qnil
);
8679 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8681 /* Set up the buffer for the multibyteness we need. */
8683 != !NILP (current_buffer
->enable_multibyte_characters
))
8684 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8686 /* Raise the frame containing the echo area. */
8687 if (minibuffer_auto_raise
)
8689 struct frame
*sf
= SELECTED_FRAME ();
8690 Lisp_Object mini_window
;
8691 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8692 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8695 message_log_maybe_newline ();
8696 message_buf_print
= 1;
8700 if (NILP (echo_area_buffer
[0]))
8702 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8703 echo_area_buffer
[0] = echo_buffer
[1];
8705 echo_area_buffer
[0] = echo_buffer
[0];
8708 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8710 /* Someone switched buffers between print requests. */
8711 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8712 current_buffer
->truncate_lines
= Qnil
;
8718 /* Display an echo area message in window W. Value is non-zero if W's
8719 height is changed. If display_last_displayed_message_p is
8720 non-zero, display the message that was last displayed, otherwise
8721 display the current message. */
8724 display_echo_area (struct window
*w
)
8726 int i
, no_message_p
, window_height_changed_p
, count
;
8728 /* Temporarily disable garbage collections while displaying the echo
8729 area. This is done because a GC can print a message itself.
8730 That message would modify the echo area buffer's contents while a
8731 redisplay of the buffer is going on, and seriously confuse
8733 count
= inhibit_garbage_collection ();
8735 /* If there is no message, we must call display_echo_area_1
8736 nevertheless because it resizes the window. But we will have to
8737 reset the echo_area_buffer in question to nil at the end because
8738 with_echo_area_buffer will sets it to an empty buffer. */
8739 i
= display_last_displayed_message_p
? 1 : 0;
8740 no_message_p
= NILP (echo_area_buffer
[i
]);
8742 window_height_changed_p
8743 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8744 display_echo_area_1
,
8745 (EMACS_INT
) w
, Qnil
, 0, 0);
8748 echo_area_buffer
[i
] = Qnil
;
8750 unbind_to (count
, Qnil
);
8751 return window_height_changed_p
;
8755 /* Helper for display_echo_area. Display the current buffer which
8756 contains the current echo area message in window W, a mini-window,
8757 a pointer to which is passed in A1. A2..A4 are currently not used.
8758 Change the height of W so that all of the message is displayed.
8759 Value is non-zero if height of W was changed. */
8762 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8764 struct window
*w
= (struct window
*) a1
;
8766 struct text_pos start
;
8767 int window_height_changed_p
= 0;
8769 /* Do this before displaying, so that we have a large enough glyph
8770 matrix for the display. If we can't get enough space for the
8771 whole text, display the last N lines. That works by setting w->start. */
8772 window_height_changed_p
= resize_mini_window (w
, 0);
8774 /* Use the starting position chosen by resize_mini_window. */
8775 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8778 clear_glyph_matrix (w
->desired_matrix
);
8779 XSETWINDOW (window
, w
);
8780 try_window (window
, start
, 0);
8782 return window_height_changed_p
;
8786 /* Resize the echo area window to exactly the size needed for the
8787 currently displayed message, if there is one. If a mini-buffer
8788 is active, don't shrink it. */
8791 resize_echo_area_exactly (void)
8793 if (BUFFERP (echo_area_buffer
[0])
8794 && WINDOWP (echo_area_window
))
8796 struct window
*w
= XWINDOW (echo_area_window
);
8798 Lisp_Object resize_exactly
;
8800 if (minibuf_level
== 0)
8801 resize_exactly
= Qt
;
8803 resize_exactly
= Qnil
;
8805 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8806 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8809 ++windows_or_buffers_changed
;
8810 ++update_mode_lines
;
8811 redisplay_internal (0);
8817 /* Callback function for with_echo_area_buffer, when used from
8818 resize_echo_area_exactly. A1 contains a pointer to the window to
8819 resize, EXACTLY non-nil means resize the mini-window exactly to the
8820 size of the text displayed. A3 and A4 are not used. Value is what
8821 resize_mini_window returns. */
8824 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8826 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8830 /* Resize mini-window W to fit the size of its contents. EXACT_P
8831 means size the window exactly to the size needed. Otherwise, it's
8832 only enlarged until W's buffer is empty.
8834 Set W->start to the right place to begin display. If the whole
8835 contents fit, start at the beginning. Otherwise, start so as
8836 to make the end of the contents appear. This is particularly
8837 important for y-or-n-p, but seems desirable generally.
8839 Value is non-zero if the window height has been changed. */
8842 resize_mini_window (struct window
*w
, int exact_p
)
8844 struct frame
*f
= XFRAME (w
->frame
);
8845 int window_height_changed_p
= 0;
8847 xassert (MINI_WINDOW_P (w
));
8849 /* By default, start display at the beginning. */
8850 set_marker_both (w
->start
, w
->buffer
,
8851 BUF_BEGV (XBUFFER (w
->buffer
)),
8852 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8854 /* Don't resize windows while redisplaying a window; it would
8855 confuse redisplay functions when the size of the window they are
8856 displaying changes from under them. Such a resizing can happen,
8857 for instance, when which-func prints a long message while
8858 we are running fontification-functions. We're running these
8859 functions with safe_call which binds inhibit-redisplay to t. */
8860 if (!NILP (Vinhibit_redisplay
))
8863 /* Nil means don't try to resize. */
8864 if (NILP (Vresize_mini_windows
)
8865 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8868 if (!FRAME_MINIBUF_ONLY_P (f
))
8871 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8872 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8873 int height
, max_height
;
8874 int unit
= FRAME_LINE_HEIGHT (f
);
8875 struct text_pos start
;
8876 struct buffer
*old_current_buffer
= NULL
;
8878 if (current_buffer
!= XBUFFER (w
->buffer
))
8880 old_current_buffer
= current_buffer
;
8881 set_buffer_internal (XBUFFER (w
->buffer
));
8884 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8886 /* Compute the max. number of lines specified by the user. */
8887 if (FLOATP (Vmax_mini_window_height
))
8888 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8889 else if (INTEGERP (Vmax_mini_window_height
))
8890 max_height
= XINT (Vmax_mini_window_height
);
8892 max_height
= total_height
/ 4;
8894 /* Correct that max. height if it's bogus. */
8895 max_height
= max (1, max_height
);
8896 max_height
= min (total_height
, max_height
);
8898 /* Find out the height of the text in the window. */
8899 if (it
.line_wrap
== TRUNCATE
)
8904 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8905 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8906 height
= it
.current_y
+ last_height
;
8908 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8909 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8910 height
= (height
+ unit
- 1) / unit
;
8913 /* Compute a suitable window start. */
8914 if (height
> max_height
)
8916 height
= max_height
;
8917 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8918 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8919 start
= it
.current
.pos
;
8922 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8923 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8925 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8927 /* Let it grow only, until we display an empty message, in which
8928 case the window shrinks again. */
8929 if (height
> WINDOW_TOTAL_LINES (w
))
8931 int old_height
= WINDOW_TOTAL_LINES (w
);
8932 freeze_window_starts (f
, 1);
8933 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8934 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8936 else if (height
< WINDOW_TOTAL_LINES (w
)
8937 && (exact_p
|| BEGV
== ZV
))
8939 int old_height
= WINDOW_TOTAL_LINES (w
);
8940 freeze_window_starts (f
, 0);
8941 shrink_mini_window (w
);
8942 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8947 /* Always resize to exact size needed. */
8948 if (height
> WINDOW_TOTAL_LINES (w
))
8950 int old_height
= WINDOW_TOTAL_LINES (w
);
8951 freeze_window_starts (f
, 1);
8952 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8953 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8955 else if (height
< WINDOW_TOTAL_LINES (w
))
8957 int old_height
= WINDOW_TOTAL_LINES (w
);
8958 freeze_window_starts (f
, 0);
8959 shrink_mini_window (w
);
8963 freeze_window_starts (f
, 1);
8964 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8967 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8971 if (old_current_buffer
)
8972 set_buffer_internal (old_current_buffer
);
8975 return window_height_changed_p
;
8979 /* Value is the current message, a string, or nil if there is no
8983 current_message (void)
8987 if (!BUFFERP (echo_area_buffer
[0]))
8991 with_echo_area_buffer (0, 0, current_message_1
,
8992 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8994 echo_area_buffer
[0] = Qnil
;
9002 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9004 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9007 *msg
= make_buffer_string (BEG
, Z
, 1);
9014 /* Push the current message on Vmessage_stack for later restauration
9015 by restore_message. Value is non-zero if the current message isn't
9016 empty. This is a relatively infrequent operation, so it's not
9017 worth optimizing. */
9023 msg
= current_message ();
9024 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9025 return STRINGP (msg
);
9029 /* Restore message display from the top of Vmessage_stack. */
9032 restore_message (void)
9036 xassert (CONSP (Vmessage_stack
));
9037 msg
= XCAR (Vmessage_stack
);
9039 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9041 message3_nolog (msg
, 0, 0);
9045 /* Handler for record_unwind_protect calling pop_message. */
9048 pop_message_unwind (Lisp_Object dummy
)
9054 /* Pop the top-most entry off Vmessage_stack. */
9059 xassert (CONSP (Vmessage_stack
));
9060 Vmessage_stack
= XCDR (Vmessage_stack
);
9064 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9065 exits. If the stack is not empty, we have a missing pop_message
9069 check_message_stack (void)
9071 if (!NILP (Vmessage_stack
))
9076 /* Truncate to NCHARS what will be displayed in the echo area the next
9077 time we display it---but don't redisplay it now. */
9080 truncate_echo_area (EMACS_INT nchars
)
9083 echo_area_buffer
[0] = Qnil
;
9084 /* A null message buffer means that the frame hasn't really been
9085 initialized yet. Error messages get reported properly by
9086 cmd_error, so this must be just an informative message; toss it. */
9087 else if (!noninteractive
9089 && !NILP (echo_area_buffer
[0]))
9091 struct frame
*sf
= SELECTED_FRAME ();
9092 if (FRAME_MESSAGE_BUF (sf
))
9093 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9098 /* Helper function for truncate_echo_area. Truncate the current
9099 message to at most NCHARS characters. */
9102 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9104 if (BEG
+ nchars
< Z
)
9105 del_range (BEG
+ nchars
, Z
);
9107 echo_area_buffer
[0] = Qnil
;
9112 /* Set the current message to a substring of S or STRING.
9114 If STRING is a Lisp string, set the message to the first NBYTES
9115 bytes from STRING. NBYTES zero means use the whole string. If
9116 STRING is multibyte, the message will be displayed multibyte.
9118 If S is not null, set the message to the first LEN bytes of S. LEN
9119 zero means use the whole string. MULTIBYTE_P non-zero means S is
9120 multibyte. Display the message multibyte in that case.
9122 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9123 to t before calling set_message_1 (which calls insert).
9127 set_message (const char *s
, Lisp_Object string
,
9128 EMACS_INT nbytes
, int multibyte_p
)
9130 message_enable_multibyte
9131 = ((s
&& multibyte_p
)
9132 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9134 with_echo_area_buffer (0, -1, set_message_1
,
9135 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9136 message_buf_print
= 0;
9137 help_echo_showing_p
= 0;
9141 /* Helper function for set_message. Arguments have the same meaning
9142 as there, with A1 corresponding to S and A2 corresponding to STRING
9143 This function is called with the echo area buffer being
9147 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9149 const char *s
= (const char *) a1
;
9150 Lisp_Object string
= a2
;
9152 /* Change multibyteness of the echo buffer appropriately. */
9153 if (message_enable_multibyte
9154 != !NILP (current_buffer
->enable_multibyte_characters
))
9155 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9157 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9158 if (!NILP (current_buffer
->bidi_display_reordering
))
9159 current_buffer
->bidi_paragraph_direction
= Qleft_to_right
;
9161 /* Insert new message at BEG. */
9162 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9164 if (STRINGP (string
))
9169 nbytes
= SBYTES (string
);
9170 nchars
= string_byte_to_char (string
, nbytes
);
9172 /* This function takes care of single/multibyte conversion. We
9173 just have to ensure that the echo area buffer has the right
9174 setting of enable_multibyte_characters. */
9175 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9180 nbytes
= strlen (s
);
9182 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9184 /* Convert from multi-byte to single-byte. */
9187 unsigned char work
[1];
9189 /* Convert a multibyte string to single-byte. */
9190 for (i
= 0; i
< nbytes
; i
+= n
)
9192 c
= string_char_and_length (s
+ i
, &n
);
9193 work
[0] = (ASCII_CHAR_P (c
)
9195 : multibyte_char_to_unibyte (c
, Qnil
));
9196 insert_1_both (work
, 1, 1, 1, 0, 0);
9199 else if (!multibyte_p
9200 && !NILP (current_buffer
->enable_multibyte_characters
))
9202 /* Convert from single-byte to multi-byte. */
9205 const unsigned char *msg
= (const unsigned char *) s
;
9206 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9208 /* Convert a single-byte string to multibyte. */
9209 for (i
= 0; i
< nbytes
; i
++)
9212 MAKE_CHAR_MULTIBYTE (c
);
9213 n
= CHAR_STRING (c
, str
);
9214 insert_1_both (str
, 1, n
, 1, 0, 0);
9218 insert_1 (s
, nbytes
, 1, 0, 0);
9225 /* Clear messages. CURRENT_P non-zero means clear the current
9226 message. LAST_DISPLAYED_P non-zero means clear the message
9230 clear_message (int current_p
, int last_displayed_p
)
9234 echo_area_buffer
[0] = Qnil
;
9235 message_cleared_p
= 1;
9238 if (last_displayed_p
)
9239 echo_area_buffer
[1] = Qnil
;
9241 message_buf_print
= 0;
9244 /* Clear garbaged frames.
9246 This function is used where the old redisplay called
9247 redraw_garbaged_frames which in turn called redraw_frame which in
9248 turn called clear_frame. The call to clear_frame was a source of
9249 flickering. I believe a clear_frame is not necessary. It should
9250 suffice in the new redisplay to invalidate all current matrices,
9251 and ensure a complete redisplay of all windows. */
9254 clear_garbaged_frames (void)
9258 Lisp_Object tail
, frame
;
9259 int changed_count
= 0;
9261 FOR_EACH_FRAME (tail
, frame
)
9263 struct frame
*f
= XFRAME (frame
);
9265 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9269 Fredraw_frame (frame
);
9270 f
->force_flush_display_p
= 1;
9272 clear_current_matrices (f
);
9281 ++windows_or_buffers_changed
;
9286 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9287 is non-zero update selected_frame. Value is non-zero if the
9288 mini-windows height has been changed. */
9291 echo_area_display (int update_frame_p
)
9293 Lisp_Object mini_window
;
9296 int window_height_changed_p
= 0;
9297 struct frame
*sf
= SELECTED_FRAME ();
9299 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9300 w
= XWINDOW (mini_window
);
9301 f
= XFRAME (WINDOW_FRAME (w
));
9303 /* Don't display if frame is invisible or not yet initialized. */
9304 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9307 #ifdef HAVE_WINDOW_SYSTEM
9308 /* When Emacs starts, selected_frame may be the initial terminal
9309 frame. If we let this through, a message would be displayed on
9311 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9313 #endif /* HAVE_WINDOW_SYSTEM */
9315 /* Redraw garbaged frames. */
9317 clear_garbaged_frames ();
9319 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9321 echo_area_window
= mini_window
;
9322 window_height_changed_p
= display_echo_area (w
);
9323 w
->must_be_updated_p
= 1;
9325 /* Update the display, unless called from redisplay_internal.
9326 Also don't update the screen during redisplay itself. The
9327 update will happen at the end of redisplay, and an update
9328 here could cause confusion. */
9329 if (update_frame_p
&& !redisplaying_p
)
9333 /* If the display update has been interrupted by pending
9334 input, update mode lines in the frame. Due to the
9335 pending input, it might have been that redisplay hasn't
9336 been called, so that mode lines above the echo area are
9337 garbaged. This looks odd, so we prevent it here. */
9338 if (!display_completed
)
9339 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9341 if (window_height_changed_p
9342 /* Don't do this if Emacs is shutting down. Redisplay
9343 needs to run hooks. */
9344 && !NILP (Vrun_hooks
))
9346 /* Must update other windows. Likewise as in other
9347 cases, don't let this update be interrupted by
9349 int count
= SPECPDL_INDEX ();
9350 specbind (Qredisplay_dont_pause
, Qt
);
9351 windows_or_buffers_changed
= 1;
9352 redisplay_internal (0);
9353 unbind_to (count
, Qnil
);
9355 else if (FRAME_WINDOW_P (f
) && n
== 0)
9357 /* Window configuration is the same as before.
9358 Can do with a display update of the echo area,
9359 unless we displayed some mode lines. */
9360 update_single_window (w
, 1);
9361 FRAME_RIF (f
)->flush_display (f
);
9364 update_frame (f
, 1, 1);
9366 /* If cursor is in the echo area, make sure that the next
9367 redisplay displays the minibuffer, so that the cursor will
9368 be replaced with what the minibuffer wants. */
9369 if (cursor_in_echo_area
)
9370 ++windows_or_buffers_changed
;
9373 else if (!EQ (mini_window
, selected_window
))
9374 windows_or_buffers_changed
++;
9376 /* Last displayed message is now the current message. */
9377 echo_area_buffer
[1] = echo_area_buffer
[0];
9378 /* Inform read_char that we're not echoing. */
9379 echo_message_buffer
= Qnil
;
9381 /* Prevent redisplay optimization in redisplay_internal by resetting
9382 this_line_start_pos. This is done because the mini-buffer now
9383 displays the message instead of its buffer text. */
9384 if (EQ (mini_window
, selected_window
))
9385 CHARPOS (this_line_start_pos
) = 0;
9387 return window_height_changed_p
;
9392 /***********************************************************************
9393 Mode Lines and Frame Titles
9394 ***********************************************************************/
9396 /* A buffer for constructing non-propertized mode-line strings and
9397 frame titles in it; allocated from the heap in init_xdisp and
9398 resized as needed in store_mode_line_noprop_char. */
9400 static char *mode_line_noprop_buf
;
9402 /* The buffer's end, and a current output position in it. */
9404 static char *mode_line_noprop_buf_end
;
9405 static char *mode_line_noprop_ptr
;
9407 #define MODE_LINE_NOPROP_LEN(start) \
9408 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9411 MODE_LINE_DISPLAY
= 0,
9417 /* Alist that caches the results of :propertize.
9418 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9419 static Lisp_Object mode_line_proptrans_alist
;
9421 /* List of strings making up the mode-line. */
9422 static Lisp_Object mode_line_string_list
;
9424 /* Base face property when building propertized mode line string. */
9425 static Lisp_Object mode_line_string_face
;
9426 static Lisp_Object mode_line_string_face_prop
;
9429 /* Unwind data for mode line strings */
9431 static Lisp_Object Vmode_line_unwind_vector
;
9434 format_mode_line_unwind_data (struct buffer
*obuf
,
9438 Lisp_Object vector
, tmp
;
9440 /* Reduce consing by keeping one vector in
9441 Vwith_echo_area_save_vector. */
9442 vector
= Vmode_line_unwind_vector
;
9443 Vmode_line_unwind_vector
= Qnil
;
9446 vector
= Fmake_vector (make_number (8), Qnil
);
9448 ASET (vector
, 0, make_number (mode_line_target
));
9449 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9450 ASET (vector
, 2, mode_line_string_list
);
9451 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9452 ASET (vector
, 4, mode_line_string_face
);
9453 ASET (vector
, 5, mode_line_string_face_prop
);
9456 XSETBUFFER (tmp
, obuf
);
9459 ASET (vector
, 6, tmp
);
9460 ASET (vector
, 7, owin
);
9466 unwind_format_mode_line (Lisp_Object vector
)
9468 mode_line_target
= XINT (AREF (vector
, 0));
9469 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9470 mode_line_string_list
= AREF (vector
, 2);
9471 if (! EQ (AREF (vector
, 3), Qt
))
9472 mode_line_proptrans_alist
= AREF (vector
, 3);
9473 mode_line_string_face
= AREF (vector
, 4);
9474 mode_line_string_face_prop
= AREF (vector
, 5);
9476 if (!NILP (AREF (vector
, 7)))
9477 /* Select window before buffer, since it may change the buffer. */
9478 Fselect_window (AREF (vector
, 7), Qt
);
9480 if (!NILP (AREF (vector
, 6)))
9482 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9483 ASET (vector
, 6, Qnil
);
9486 Vmode_line_unwind_vector
= vector
;
9491 /* Store a single character C for the frame title in mode_line_noprop_buf.
9492 Re-allocate mode_line_noprop_buf if necessary. */
9495 store_mode_line_noprop_char (char c
)
9497 /* If output position has reached the end of the allocated buffer,
9498 double the buffer's size. */
9499 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9501 int len
= MODE_LINE_NOPROP_LEN (0);
9502 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9503 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9504 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9505 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9508 *mode_line_noprop_ptr
++ = c
;
9512 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9513 mode_line_noprop_ptr. STR is the string to store. Do not copy
9514 characters that yield more columns than PRECISION; PRECISION <= 0
9515 means copy the whole string. Pad with spaces until FIELD_WIDTH
9516 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9517 pad. Called from display_mode_element when it is used to build a
9521 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9524 EMACS_INT dummy
, nbytes
;
9526 /* Copy at most PRECISION chars from STR. */
9527 nbytes
= strlen (str
);
9528 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9530 store_mode_line_noprop_char (*str
++);
9532 /* Fill up with spaces until FIELD_WIDTH reached. */
9533 while (field_width
> 0
9536 store_mode_line_noprop_char (' ');
9543 /***********************************************************************
9545 ***********************************************************************/
9547 #ifdef HAVE_WINDOW_SYSTEM
9549 /* Set the title of FRAME, if it has changed. The title format is
9550 Vicon_title_format if FRAME is iconified, otherwise it is
9551 frame_title_format. */
9554 x_consider_frame_title (Lisp_Object frame
)
9556 struct frame
*f
= XFRAME (frame
);
9558 if (FRAME_WINDOW_P (f
)
9559 || FRAME_MINIBUF_ONLY_P (f
)
9560 || f
->explicit_name
)
9562 /* Do we have more than one visible frame on this X display? */
9569 int count
= SPECPDL_INDEX ();
9571 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9573 Lisp_Object other_frame
= XCAR (tail
);
9574 struct frame
*tf
= XFRAME (other_frame
);
9577 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9578 && !FRAME_MINIBUF_ONLY_P (tf
)
9579 && !EQ (other_frame
, tip_frame
)
9580 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9584 /* Set global variable indicating that multiple frames exist. */
9585 multiple_frames
= CONSP (tail
);
9587 /* Switch to the buffer of selected window of the frame. Set up
9588 mode_line_target so that display_mode_element will output into
9589 mode_line_noprop_buf; then display the title. */
9590 record_unwind_protect (unwind_format_mode_line
,
9591 format_mode_line_unwind_data
9592 (current_buffer
, selected_window
, 0));
9594 Fselect_window (f
->selected_window
, Qt
);
9595 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9596 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9598 mode_line_target
= MODE_LINE_TITLE
;
9599 title_start
= MODE_LINE_NOPROP_LEN (0);
9600 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9601 NULL
, DEFAULT_FACE_ID
);
9602 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9603 len
= MODE_LINE_NOPROP_LEN (title_start
);
9604 title
= mode_line_noprop_buf
+ title_start
;
9605 unbind_to (count
, Qnil
);
9607 /* Set the title only if it's changed. This avoids consing in
9608 the common case where it hasn't. (If it turns out that we've
9609 already wasted too much time by walking through the list with
9610 display_mode_element, then we might need to optimize at a
9611 higher level than this.) */
9612 if (! STRINGP (f
->name
)
9613 || SBYTES (f
->name
) != len
9614 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9615 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9619 #endif /* not HAVE_WINDOW_SYSTEM */
9624 /***********************************************************************
9626 ***********************************************************************/
9629 /* Prepare for redisplay by updating menu-bar item lists when
9630 appropriate. This can call eval. */
9633 prepare_menu_bars (void)
9636 struct gcpro gcpro1
, gcpro2
;
9638 Lisp_Object tooltip_frame
;
9640 #ifdef HAVE_WINDOW_SYSTEM
9641 tooltip_frame
= tip_frame
;
9643 tooltip_frame
= Qnil
;
9646 /* Update all frame titles based on their buffer names, etc. We do
9647 this before the menu bars so that the buffer-menu will show the
9648 up-to-date frame titles. */
9649 #ifdef HAVE_WINDOW_SYSTEM
9650 if (windows_or_buffers_changed
|| update_mode_lines
)
9652 Lisp_Object tail
, frame
;
9654 FOR_EACH_FRAME (tail
, frame
)
9657 if (!EQ (frame
, tooltip_frame
)
9658 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9659 x_consider_frame_title (frame
);
9662 #endif /* HAVE_WINDOW_SYSTEM */
9664 /* Update the menu bar item lists, if appropriate. This has to be
9665 done before any actual redisplay or generation of display lines. */
9666 all_windows
= (update_mode_lines
9667 || buffer_shared
> 1
9668 || windows_or_buffers_changed
);
9671 Lisp_Object tail
, frame
;
9672 int count
= SPECPDL_INDEX ();
9673 /* 1 means that update_menu_bar has run its hooks
9674 so any further calls to update_menu_bar shouldn't do so again. */
9675 int menu_bar_hooks_run
= 0;
9677 record_unwind_save_match_data ();
9679 FOR_EACH_FRAME (tail
, frame
)
9683 /* Ignore tooltip frame. */
9684 if (EQ (frame
, tooltip_frame
))
9687 /* If a window on this frame changed size, report that to
9688 the user and clear the size-change flag. */
9689 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9691 Lisp_Object functions
;
9693 /* Clear flag first in case we get an error below. */
9694 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9695 functions
= Vwindow_size_change_functions
;
9696 GCPRO2 (tail
, functions
);
9698 while (CONSP (functions
))
9700 if (!EQ (XCAR (functions
), Qt
))
9701 call1 (XCAR (functions
), frame
);
9702 functions
= XCDR (functions
);
9708 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9709 #ifdef HAVE_WINDOW_SYSTEM
9710 update_tool_bar (f
, 0);
9713 if (windows_or_buffers_changed
9715 ns_set_doc_edited (f
, Fbuffer_modified_p
9716 (XWINDOW (f
->selected_window
)->buffer
));
9721 unbind_to (count
, Qnil
);
9725 struct frame
*sf
= SELECTED_FRAME ();
9726 update_menu_bar (sf
, 1, 0);
9727 #ifdef HAVE_WINDOW_SYSTEM
9728 update_tool_bar (sf
, 1);
9734 /* Update the menu bar item list for frame F. This has to be done
9735 before we start to fill in any display lines, because it can call
9738 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9740 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9741 already ran the menu bar hooks for this redisplay, so there
9742 is no need to run them again. The return value is the
9743 updated value of this flag, to pass to the next call. */
9746 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9749 register struct window
*w
;
9751 /* If called recursively during a menu update, do nothing. This can
9752 happen when, for instance, an activate-menubar-hook causes a
9754 if (inhibit_menubar_update
)
9757 window
= FRAME_SELECTED_WINDOW (f
);
9758 w
= XWINDOW (window
);
9760 if (FRAME_WINDOW_P (f
)
9762 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9763 || defined (HAVE_NS) || defined (USE_GTK)
9764 FRAME_EXTERNAL_MENU_BAR (f
)
9766 FRAME_MENU_BAR_LINES (f
) > 0
9768 : FRAME_MENU_BAR_LINES (f
) > 0)
9770 /* If the user has switched buffers or windows, we need to
9771 recompute to reflect the new bindings. But we'll
9772 recompute when update_mode_lines is set too; that means
9773 that people can use force-mode-line-update to request
9774 that the menu bar be recomputed. The adverse effect on
9775 the rest of the redisplay algorithm is about the same as
9776 windows_or_buffers_changed anyway. */
9777 if (windows_or_buffers_changed
9778 /* This used to test w->update_mode_line, but we believe
9779 there is no need to recompute the menu in that case. */
9780 || update_mode_lines
9781 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9782 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9783 != !NILP (w
->last_had_star
))
9784 || ((!NILP (Vtransient_mark_mode
)
9785 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9786 != !NILP (w
->region_showing
)))
9788 struct buffer
*prev
= current_buffer
;
9789 int count
= SPECPDL_INDEX ();
9791 specbind (Qinhibit_menubar_update
, Qt
);
9793 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9794 if (save_match_data
)
9795 record_unwind_save_match_data ();
9796 if (NILP (Voverriding_local_map_menu_flag
))
9798 specbind (Qoverriding_terminal_local_map
, Qnil
);
9799 specbind (Qoverriding_local_map
, Qnil
);
9804 /* Run the Lucid hook. */
9805 safe_run_hooks (Qactivate_menubar_hook
);
9807 /* If it has changed current-menubar from previous value,
9808 really recompute the menu-bar from the value. */
9809 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9810 call0 (Qrecompute_lucid_menubar
);
9812 safe_run_hooks (Qmenu_bar_update_hook
);
9817 XSETFRAME (Vmenu_updating_frame
, f
);
9818 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9820 /* Redisplay the menu bar in case we changed it. */
9821 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9822 || defined (HAVE_NS) || defined (USE_GTK)
9823 if (FRAME_WINDOW_P (f
))
9825 #if defined (HAVE_NS)
9826 /* All frames on Mac OS share the same menubar. So only
9827 the selected frame should be allowed to set it. */
9828 if (f
== SELECTED_FRAME ())
9830 set_frame_menubar (f
, 0, 0);
9833 /* On a terminal screen, the menu bar is an ordinary screen
9834 line, and this makes it get updated. */
9835 w
->update_mode_line
= Qt
;
9836 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9837 /* In the non-toolkit version, the menu bar is an ordinary screen
9838 line, and this makes it get updated. */
9839 w
->update_mode_line
= Qt
;
9840 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9842 unbind_to (count
, Qnil
);
9843 set_buffer_internal_1 (prev
);
9852 /***********************************************************************
9854 ***********************************************************************/
9856 #ifdef HAVE_WINDOW_SYSTEM
9859 Nominal cursor position -- where to draw output.
9860 HPOS and VPOS are window relative glyph matrix coordinates.
9861 X and Y are window relative pixel coordinates. */
9863 struct cursor_pos output_cursor
;
9867 Set the global variable output_cursor to CURSOR. All cursor
9868 positions are relative to updated_window. */
9871 set_output_cursor (struct cursor_pos
*cursor
)
9873 output_cursor
.hpos
= cursor
->hpos
;
9874 output_cursor
.vpos
= cursor
->vpos
;
9875 output_cursor
.x
= cursor
->x
;
9876 output_cursor
.y
= cursor
->y
;
9881 Set a nominal cursor position.
9883 HPOS and VPOS are column/row positions in a window glyph matrix. X
9884 and Y are window text area relative pixel positions.
9886 If this is done during an update, updated_window will contain the
9887 window that is being updated and the position is the future output
9888 cursor position for that window. If updated_window is null, use
9889 selected_window and display the cursor at the given position. */
9892 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9896 /* If updated_window is not set, work on selected_window. */
9900 w
= XWINDOW (selected_window
);
9902 /* Set the output cursor. */
9903 output_cursor
.hpos
= hpos
;
9904 output_cursor
.vpos
= vpos
;
9905 output_cursor
.x
= x
;
9906 output_cursor
.y
= y
;
9908 /* If not called as part of an update, really display the cursor.
9909 This will also set the cursor position of W. */
9910 if (updated_window
== NULL
)
9913 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9914 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9915 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9920 #endif /* HAVE_WINDOW_SYSTEM */
9923 /***********************************************************************
9925 ***********************************************************************/
9927 #ifdef HAVE_WINDOW_SYSTEM
9929 /* Where the mouse was last time we reported a mouse event. */
9931 FRAME_PTR last_mouse_frame
;
9933 /* Tool-bar item index of the item on which a mouse button was pressed
9936 int last_tool_bar_item
;
9940 update_tool_bar_unwind (Lisp_Object frame
)
9942 selected_frame
= frame
;
9946 /* Update the tool-bar item list for frame F. This has to be done
9947 before we start to fill in any display lines. Called from
9948 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9949 and restore it here. */
9952 update_tool_bar (struct frame
*f
, int save_match_data
)
9954 #if defined (USE_GTK) || defined (HAVE_NS)
9955 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9957 int do_update
= WINDOWP (f
->tool_bar_window
)
9958 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9966 window
= FRAME_SELECTED_WINDOW (f
);
9967 w
= XWINDOW (window
);
9969 /* If the user has switched buffers or windows, we need to
9970 recompute to reflect the new bindings. But we'll
9971 recompute when update_mode_lines is set too; that means
9972 that people can use force-mode-line-update to request
9973 that the menu bar be recomputed. The adverse effect on
9974 the rest of the redisplay algorithm is about the same as
9975 windows_or_buffers_changed anyway. */
9976 if (windows_or_buffers_changed
9977 || !NILP (w
->update_mode_line
)
9978 || update_mode_lines
9979 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9980 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9981 != !NILP (w
->last_had_star
))
9982 || ((!NILP (Vtransient_mark_mode
)
9983 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9984 != !NILP (w
->region_showing
)))
9986 struct buffer
*prev
= current_buffer
;
9987 int count
= SPECPDL_INDEX ();
9988 Lisp_Object frame
, new_tool_bar
;
9990 struct gcpro gcpro1
;
9992 /* Set current_buffer to the buffer of the selected
9993 window of the frame, so that we get the right local
9995 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9997 /* Save match data, if we must. */
9998 if (save_match_data
)
9999 record_unwind_save_match_data ();
10001 /* Make sure that we don't accidentally use bogus keymaps. */
10002 if (NILP (Voverriding_local_map_menu_flag
))
10004 specbind (Qoverriding_terminal_local_map
, Qnil
);
10005 specbind (Qoverriding_local_map
, Qnil
);
10008 GCPRO1 (new_tool_bar
);
10010 /* We must temporarily set the selected frame to this frame
10011 before calling tool_bar_items, because the calculation of
10012 the tool-bar keymap uses the selected frame (see
10013 `tool-bar-make-keymap' in tool-bar.el). */
10014 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10015 XSETFRAME (frame
, f
);
10016 selected_frame
= frame
;
10018 /* Build desired tool-bar items from keymaps. */
10019 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10022 /* Redisplay the tool-bar if we changed it. */
10023 if (new_n_tool_bar
!= f
->n_tool_bar_items
10024 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10026 /* Redisplay that happens asynchronously due to an expose event
10027 may access f->tool_bar_items. Make sure we update both
10028 variables within BLOCK_INPUT so no such event interrupts. */
10030 f
->tool_bar_items
= new_tool_bar
;
10031 f
->n_tool_bar_items
= new_n_tool_bar
;
10032 w
->update_mode_line
= Qt
;
10038 unbind_to (count
, Qnil
);
10039 set_buffer_internal_1 (prev
);
10045 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10046 F's desired tool-bar contents. F->tool_bar_items must have
10047 been set up previously by calling prepare_menu_bars. */
10050 build_desired_tool_bar_string (struct frame
*f
)
10052 int i
, size
, size_needed
;
10053 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10054 Lisp_Object image
, plist
, props
;
10056 image
= plist
= props
= Qnil
;
10057 GCPRO3 (image
, plist
, props
);
10059 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10060 Otherwise, make a new string. */
10062 /* The size of the string we might be able to reuse. */
10063 size
= (STRINGP (f
->desired_tool_bar_string
)
10064 ? SCHARS (f
->desired_tool_bar_string
)
10067 /* We need one space in the string for each image. */
10068 size_needed
= f
->n_tool_bar_items
;
10070 /* Reuse f->desired_tool_bar_string, if possible. */
10071 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10072 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10073 make_number (' '));
10076 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10077 Fremove_text_properties (make_number (0), make_number (size
),
10078 props
, f
->desired_tool_bar_string
);
10081 /* Put a `display' property on the string for the images to display,
10082 put a `menu_item' property on tool-bar items with a value that
10083 is the index of the item in F's tool-bar item vector. */
10084 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10086 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10088 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10089 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10090 int hmargin
, vmargin
, relief
, idx
, end
;
10092 /* If image is a vector, choose the image according to the
10094 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10095 if (VECTORP (image
))
10099 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10100 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10103 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10104 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10106 xassert (ASIZE (image
) >= idx
);
10107 image
= AREF (image
, idx
);
10112 /* Ignore invalid image specifications. */
10113 if (!valid_image_p (image
))
10116 /* Display the tool-bar button pressed, or depressed. */
10117 plist
= Fcopy_sequence (XCDR (image
));
10119 /* Compute margin and relief to draw. */
10120 relief
= (tool_bar_button_relief
>= 0
10121 ? tool_bar_button_relief
10122 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10123 hmargin
= vmargin
= relief
;
10125 if (INTEGERP (Vtool_bar_button_margin
)
10126 && XINT (Vtool_bar_button_margin
) > 0)
10128 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10129 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10131 else if (CONSP (Vtool_bar_button_margin
))
10133 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10134 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10135 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10137 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10138 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10139 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10142 if (auto_raise_tool_bar_buttons_p
)
10144 /* Add a `:relief' property to the image spec if the item is
10148 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10155 /* If image is selected, display it pressed, i.e. with a
10156 negative relief. If it's not selected, display it with a
10158 plist
= Fplist_put (plist
, QCrelief
,
10160 ? make_number (-relief
)
10161 : make_number (relief
)));
10166 /* Put a margin around the image. */
10167 if (hmargin
|| vmargin
)
10169 if (hmargin
== vmargin
)
10170 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10172 plist
= Fplist_put (plist
, QCmargin
,
10173 Fcons (make_number (hmargin
),
10174 make_number (vmargin
)));
10177 /* If button is not enabled, and we don't have special images
10178 for the disabled state, make the image appear disabled by
10179 applying an appropriate algorithm to it. */
10180 if (!enabled_p
&& idx
< 0)
10181 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10183 /* Put a `display' text property on the string for the image to
10184 display. Put a `menu-item' property on the string that gives
10185 the start of this item's properties in the tool-bar items
10187 image
= Fcons (Qimage
, plist
);
10188 props
= list4 (Qdisplay
, image
,
10189 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10191 /* Let the last image hide all remaining spaces in the tool bar
10192 string. The string can be longer than needed when we reuse a
10193 previous string. */
10194 if (i
+ 1 == f
->n_tool_bar_items
)
10195 end
= SCHARS (f
->desired_tool_bar_string
);
10198 Fadd_text_properties (make_number (i
), make_number (end
),
10199 props
, f
->desired_tool_bar_string
);
10207 /* Display one line of the tool-bar of frame IT->f.
10209 HEIGHT specifies the desired height of the tool-bar line.
10210 If the actual height of the glyph row is less than HEIGHT, the
10211 row's height is increased to HEIGHT, and the icons are centered
10212 vertically in the new height.
10214 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10215 count a final empty row in case the tool-bar width exactly matches
10220 display_tool_bar_line (struct it
*it
, int height
)
10222 struct glyph_row
*row
= it
->glyph_row
;
10223 int max_x
= it
->last_visible_x
;
10224 struct glyph
*last
;
10226 prepare_desired_row (row
);
10227 row
->y
= it
->current_y
;
10229 /* Note that this isn't made use of if the face hasn't a box,
10230 so there's no need to check the face here. */
10231 it
->start_of_box_run_p
= 1;
10233 while (it
->current_x
< max_x
)
10235 int x
, n_glyphs_before
, i
, nglyphs
;
10236 struct it it_before
;
10238 /* Get the next display element. */
10239 if (!get_next_display_element (it
))
10241 /* Don't count empty row if we are counting needed tool-bar lines. */
10242 if (height
< 0 && !it
->hpos
)
10247 /* Produce glyphs. */
10248 n_glyphs_before
= row
->used
[TEXT_AREA
];
10251 PRODUCE_GLYPHS (it
);
10253 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10255 x
= it_before
.current_x
;
10256 while (i
< nglyphs
)
10258 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10260 if (x
+ glyph
->pixel_width
> max_x
)
10262 /* Glyph doesn't fit on line. Backtrack. */
10263 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10265 /* If this is the only glyph on this line, it will never fit on the
10266 tool-bar, so skip it. But ensure there is at least one glyph,
10267 so we don't accidentally disable the tool-bar. */
10268 if (n_glyphs_before
== 0
10269 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10275 x
+= glyph
->pixel_width
;
10279 /* Stop at line ends. */
10280 if (ITERATOR_AT_END_OF_LINE_P (it
))
10283 set_iterator_to_next (it
, 1);
10288 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10290 /* Use default face for the border below the tool bar.
10292 FIXME: When auto-resize-tool-bars is grow-only, there is
10293 no additional border below the possibly empty tool-bar lines.
10294 So to make the extra empty lines look "normal", we have to
10295 use the tool-bar face for the border too. */
10296 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10297 it
->face_id
= DEFAULT_FACE_ID
;
10299 extend_face_to_end_of_line (it
);
10300 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10301 last
->right_box_line_p
= 1;
10302 if (last
== row
->glyphs
[TEXT_AREA
])
10303 last
->left_box_line_p
= 1;
10305 /* Make line the desired height and center it vertically. */
10306 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10308 /* Don't add more than one line height. */
10309 height
%= FRAME_LINE_HEIGHT (it
->f
);
10310 it
->max_ascent
+= height
/ 2;
10311 it
->max_descent
+= (height
+ 1) / 2;
10314 compute_line_metrics (it
);
10316 /* If line is empty, make it occupy the rest of the tool-bar. */
10317 if (!row
->displays_text_p
)
10319 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10320 row
->visible_height
= row
->height
;
10321 row
->ascent
= row
->phys_ascent
= 0;
10322 row
->extra_line_spacing
= 0;
10325 row
->full_width_p
= 1;
10326 row
->continued_p
= 0;
10327 row
->truncated_on_left_p
= 0;
10328 row
->truncated_on_right_p
= 0;
10330 it
->current_x
= it
->hpos
= 0;
10331 it
->current_y
+= row
->height
;
10337 /* Max tool-bar height. */
10339 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10340 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10342 /* Value is the number of screen lines needed to make all tool-bar
10343 items of frame F visible. The number of actual rows needed is
10344 returned in *N_ROWS if non-NULL. */
10347 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10349 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10351 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10352 the desired matrix, so use (unused) mode-line row as temporary row to
10353 avoid destroying the first tool-bar row. */
10354 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10356 /* Initialize an iterator for iteration over
10357 F->desired_tool_bar_string in the tool-bar window of frame F. */
10358 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10359 it
.first_visible_x
= 0;
10360 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10361 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10363 while (!ITERATOR_AT_END_P (&it
))
10365 clear_glyph_row (temp_row
);
10366 it
.glyph_row
= temp_row
;
10367 display_tool_bar_line (&it
, -1);
10369 clear_glyph_row (temp_row
);
10371 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10373 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10375 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10379 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10381 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10382 (Lisp_Object frame
)
10389 frame
= selected_frame
;
10391 CHECK_FRAME (frame
);
10392 f
= XFRAME (frame
);
10394 if (WINDOWP (f
->tool_bar_window
)
10395 || (w
= XWINDOW (f
->tool_bar_window
),
10396 WINDOW_TOTAL_LINES (w
) > 0))
10398 update_tool_bar (f
, 1);
10399 if (f
->n_tool_bar_items
)
10401 build_desired_tool_bar_string (f
);
10402 nlines
= tool_bar_lines_needed (f
, NULL
);
10406 return make_number (nlines
);
10410 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10411 height should be changed. */
10414 redisplay_tool_bar (struct frame
*f
)
10418 struct glyph_row
*row
;
10420 #if defined (USE_GTK) || defined (HAVE_NS)
10421 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10422 update_frame_tool_bar (f
);
10426 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10427 do anything. This means you must start with tool-bar-lines
10428 non-zero to get the auto-sizing effect. Or in other words, you
10429 can turn off tool-bars by specifying tool-bar-lines zero. */
10430 if (!WINDOWP (f
->tool_bar_window
)
10431 || (w
= XWINDOW (f
->tool_bar_window
),
10432 WINDOW_TOTAL_LINES (w
) == 0))
10435 /* Set up an iterator for the tool-bar window. */
10436 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10437 it
.first_visible_x
= 0;
10438 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10439 row
= it
.glyph_row
;
10441 /* Build a string that represents the contents of the tool-bar. */
10442 build_desired_tool_bar_string (f
);
10443 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10445 if (f
->n_tool_bar_rows
== 0)
10449 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10450 nlines
!= WINDOW_TOTAL_LINES (w
)))
10453 int old_height
= WINDOW_TOTAL_LINES (w
);
10455 XSETFRAME (frame
, f
);
10456 Fmodify_frame_parameters (frame
,
10457 Fcons (Fcons (Qtool_bar_lines
,
10458 make_number (nlines
)),
10460 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10462 clear_glyph_matrix (w
->desired_matrix
);
10463 fonts_changed_p
= 1;
10469 /* Display as many lines as needed to display all tool-bar items. */
10471 if (f
->n_tool_bar_rows
> 0)
10473 int border
, rows
, height
, extra
;
10475 if (INTEGERP (Vtool_bar_border
))
10476 border
= XINT (Vtool_bar_border
);
10477 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10478 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10479 else if (EQ (Vtool_bar_border
, Qborder_width
))
10480 border
= f
->border_width
;
10486 rows
= f
->n_tool_bar_rows
;
10487 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10488 extra
= it
.last_visible_y
- border
- height
* rows
;
10490 while (it
.current_y
< it
.last_visible_y
)
10493 if (extra
> 0 && rows
-- > 0)
10495 h
= (extra
+ rows
- 1) / rows
;
10498 display_tool_bar_line (&it
, height
+ h
);
10503 while (it
.current_y
< it
.last_visible_y
)
10504 display_tool_bar_line (&it
, 0);
10507 /* It doesn't make much sense to try scrolling in the tool-bar
10508 window, so don't do it. */
10509 w
->desired_matrix
->no_scrolling_p
= 1;
10510 w
->must_be_updated_p
= 1;
10512 if (!NILP (Vauto_resize_tool_bars
))
10514 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10515 int change_height_p
= 0;
10517 /* If we couldn't display everything, change the tool-bar's
10518 height if there is room for more. */
10519 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10520 && it
.current_y
< max_tool_bar_height
)
10521 change_height_p
= 1;
10523 row
= it
.glyph_row
- 1;
10525 /* If there are blank lines at the end, except for a partially
10526 visible blank line at the end that is smaller than
10527 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10528 if (!row
->displays_text_p
10529 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10530 change_height_p
= 1;
10532 /* If row displays tool-bar items, but is partially visible,
10533 change the tool-bar's height. */
10534 if (row
->displays_text_p
10535 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10536 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10537 change_height_p
= 1;
10539 /* Resize windows as needed by changing the `tool-bar-lines'
10540 frame parameter. */
10541 if (change_height_p
)
10544 int old_height
= WINDOW_TOTAL_LINES (w
);
10546 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10548 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10549 && !f
->minimize_tool_bar_window_p
)
10550 ? (nlines
> old_height
)
10551 : (nlines
!= old_height
));
10552 f
->minimize_tool_bar_window_p
= 0;
10554 if (change_height_p
)
10556 XSETFRAME (frame
, f
);
10557 Fmodify_frame_parameters (frame
,
10558 Fcons (Fcons (Qtool_bar_lines
,
10559 make_number (nlines
)),
10561 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10563 clear_glyph_matrix (w
->desired_matrix
);
10564 f
->n_tool_bar_rows
= nrows
;
10565 fonts_changed_p
= 1;
10572 f
->minimize_tool_bar_window_p
= 0;
10577 /* Get information about the tool-bar item which is displayed in GLYPH
10578 on frame F. Return in *PROP_IDX the index where tool-bar item
10579 properties start in F->tool_bar_items. Value is zero if
10580 GLYPH doesn't display a tool-bar item. */
10583 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10589 /* This function can be called asynchronously, which means we must
10590 exclude any possibility that Fget_text_property signals an
10592 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10593 charpos
= max (0, charpos
);
10595 /* Get the text property `menu-item' at pos. The value of that
10596 property is the start index of this item's properties in
10597 F->tool_bar_items. */
10598 prop
= Fget_text_property (make_number (charpos
),
10599 Qmenu_item
, f
->current_tool_bar_string
);
10600 if (INTEGERP (prop
))
10602 *prop_idx
= XINT (prop
);
10612 /* Get information about the tool-bar item at position X/Y on frame F.
10613 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10614 the current matrix of the tool-bar window of F, or NULL if not
10615 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10616 item in F->tool_bar_items. Value is
10618 -1 if X/Y is not on a tool-bar item
10619 0 if X/Y is on the same item that was highlighted before.
10623 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10624 int *hpos
, int *vpos
, int *prop_idx
)
10626 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10627 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10630 /* Find the glyph under X/Y. */
10631 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10632 if (*glyph
== NULL
)
10635 /* Get the start of this tool-bar item's properties in
10636 f->tool_bar_items. */
10637 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10640 /* Is mouse on the highlighted item? */
10641 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10642 && *vpos
>= hlinfo
->mouse_face_beg_row
10643 && *vpos
<= hlinfo
->mouse_face_end_row
10644 && (*vpos
> hlinfo
->mouse_face_beg_row
10645 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10646 && (*vpos
< hlinfo
->mouse_face_end_row
10647 || *hpos
< hlinfo
->mouse_face_end_col
10648 || hlinfo
->mouse_face_past_end
))
10656 Handle mouse button event on the tool-bar of frame F, at
10657 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10658 0 for button release. MODIFIERS is event modifiers for button
10662 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10663 unsigned int modifiers
)
10665 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10666 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10667 int hpos
, vpos
, prop_idx
;
10668 struct glyph
*glyph
;
10669 Lisp_Object enabled_p
;
10671 /* If not on the highlighted tool-bar item, return. */
10672 frame_to_window_pixel_xy (w
, &x
, &y
);
10673 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10676 /* If item is disabled, do nothing. */
10677 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10678 if (NILP (enabled_p
))
10683 /* Show item in pressed state. */
10684 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10685 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10686 last_tool_bar_item
= prop_idx
;
10690 Lisp_Object key
, frame
;
10691 struct input_event event
;
10692 EVENT_INIT (event
);
10694 /* Show item in released state. */
10695 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10696 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10698 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10700 XSETFRAME (frame
, f
);
10701 event
.kind
= TOOL_BAR_EVENT
;
10702 event
.frame_or_window
= frame
;
10704 kbd_buffer_store_event (&event
);
10706 event
.kind
= TOOL_BAR_EVENT
;
10707 event
.frame_or_window
= frame
;
10709 event
.modifiers
= modifiers
;
10710 kbd_buffer_store_event (&event
);
10711 last_tool_bar_item
= -1;
10716 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10717 tool-bar window-relative coordinates X/Y. Called from
10718 note_mouse_highlight. */
10721 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10723 Lisp_Object window
= f
->tool_bar_window
;
10724 struct window
*w
= XWINDOW (window
);
10725 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10726 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10728 struct glyph
*glyph
;
10729 struct glyph_row
*row
;
10731 Lisp_Object enabled_p
;
10733 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10734 int mouse_down_p
, rc
;
10736 /* Function note_mouse_highlight is called with negative X/Y
10737 values when mouse moves outside of the frame. */
10738 if (x
<= 0 || y
<= 0)
10740 clear_mouse_face (hlinfo
);
10744 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10747 /* Not on tool-bar item. */
10748 clear_mouse_face (hlinfo
);
10752 /* On same tool-bar item as before. */
10753 goto set_help_echo
;
10755 clear_mouse_face (hlinfo
);
10757 /* Mouse is down, but on different tool-bar item? */
10758 mouse_down_p
= (dpyinfo
->grabbed
10759 && f
== last_mouse_frame
10760 && FRAME_LIVE_P (f
));
10762 && last_tool_bar_item
!= prop_idx
)
10765 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10766 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10768 /* If tool-bar item is not enabled, don't highlight it. */
10769 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10770 if (!NILP (enabled_p
))
10772 /* Compute the x-position of the glyph. In front and past the
10773 image is a space. We include this in the highlighted area. */
10774 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10775 for (i
= x
= 0; i
< hpos
; ++i
)
10776 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10778 /* Record this as the current active region. */
10779 hlinfo
->mouse_face_beg_col
= hpos
;
10780 hlinfo
->mouse_face_beg_row
= vpos
;
10781 hlinfo
->mouse_face_beg_x
= x
;
10782 hlinfo
->mouse_face_beg_y
= row
->y
;
10783 hlinfo
->mouse_face_past_end
= 0;
10785 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10786 hlinfo
->mouse_face_end_row
= vpos
;
10787 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10788 hlinfo
->mouse_face_end_y
= row
->y
;
10789 hlinfo
->mouse_face_window
= window
;
10790 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10792 /* Display it as active. */
10793 show_mouse_face (hlinfo
, draw
);
10794 hlinfo
->mouse_face_image_state
= draw
;
10799 /* Set help_echo_string to a help string to display for this tool-bar item.
10800 XTread_socket does the rest. */
10801 help_echo_object
= help_echo_window
= Qnil
;
10802 help_echo_pos
= -1;
10803 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10804 if (NILP (help_echo_string
))
10805 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10808 #endif /* HAVE_WINDOW_SYSTEM */
10812 /************************************************************************
10813 Horizontal scrolling
10814 ************************************************************************/
10816 static int hscroll_window_tree (Lisp_Object
);
10817 static int hscroll_windows (Lisp_Object
);
10819 /* For all leaf windows in the window tree rooted at WINDOW, set their
10820 hscroll value so that PT is (i) visible in the window, and (ii) so
10821 that it is not within a certain margin at the window's left and
10822 right border. Value is non-zero if any window's hscroll has been
10826 hscroll_window_tree (Lisp_Object window
)
10828 int hscrolled_p
= 0;
10829 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10830 int hscroll_step_abs
= 0;
10831 double hscroll_step_rel
= 0;
10833 if (hscroll_relative_p
)
10835 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10836 if (hscroll_step_rel
< 0)
10838 hscroll_relative_p
= 0;
10839 hscroll_step_abs
= 0;
10842 else if (INTEGERP (Vhscroll_step
))
10844 hscroll_step_abs
= XINT (Vhscroll_step
);
10845 if (hscroll_step_abs
< 0)
10846 hscroll_step_abs
= 0;
10849 hscroll_step_abs
= 0;
10851 while (WINDOWP (window
))
10853 struct window
*w
= XWINDOW (window
);
10855 if (WINDOWP (w
->hchild
))
10856 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10857 else if (WINDOWP (w
->vchild
))
10858 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10859 else if (w
->cursor
.vpos
>= 0)
10862 int text_area_width
;
10863 struct glyph_row
*current_cursor_row
10864 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10865 struct glyph_row
*desired_cursor_row
10866 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10867 struct glyph_row
*cursor_row
10868 = (desired_cursor_row
->enabled_p
10869 ? desired_cursor_row
10870 : current_cursor_row
);
10872 text_area_width
= window_box_width (w
, TEXT_AREA
);
10874 /* Scroll when cursor is inside this scroll margin. */
10875 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10877 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10878 && ((XFASTINT (w
->hscroll
)
10879 && w
->cursor
.x
<= h_margin
)
10880 || (cursor_row
->enabled_p
10881 && cursor_row
->truncated_on_right_p
10882 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10886 struct buffer
*saved_current_buffer
;
10890 /* Find point in a display of infinite width. */
10891 saved_current_buffer
= current_buffer
;
10892 current_buffer
= XBUFFER (w
->buffer
);
10894 if (w
== XWINDOW (selected_window
))
10895 pt
= BUF_PT (current_buffer
);
10898 pt
= marker_position (w
->pointm
);
10899 pt
= max (BEGV
, pt
);
10903 /* Move iterator to pt starting at cursor_row->start in
10904 a line with infinite width. */
10905 init_to_row_start (&it
, w
, cursor_row
);
10906 it
.last_visible_x
= INFINITY
;
10907 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10908 current_buffer
= saved_current_buffer
;
10910 /* Position cursor in window. */
10911 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10912 hscroll
= max (0, (it
.current_x
10913 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10914 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10915 : (text_area_width
/ 2))))
10916 / FRAME_COLUMN_WIDTH (it
.f
);
10917 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10919 if (hscroll_relative_p
)
10920 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10923 wanted_x
= text_area_width
10924 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10927 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10931 if (hscroll_relative_p
)
10932 wanted_x
= text_area_width
* hscroll_step_rel
10935 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10938 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10940 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10942 /* Don't call Fset_window_hscroll if value hasn't
10943 changed because it will prevent redisplay
10945 if (XFASTINT (w
->hscroll
) != hscroll
)
10947 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10948 w
->hscroll
= make_number (hscroll
);
10957 /* Value is non-zero if hscroll of any leaf window has been changed. */
10958 return hscrolled_p
;
10962 /* Set hscroll so that cursor is visible and not inside horizontal
10963 scroll margins for all windows in the tree rooted at WINDOW. See
10964 also hscroll_window_tree above. Value is non-zero if any window's
10965 hscroll has been changed. If it has, desired matrices on the frame
10966 of WINDOW are cleared. */
10969 hscroll_windows (Lisp_Object window
)
10971 int hscrolled_p
= hscroll_window_tree (window
);
10973 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10974 return hscrolled_p
;
10979 /************************************************************************
10981 ************************************************************************/
10983 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10984 to a non-zero value. This is sometimes handy to have in a debugger
10989 /* First and last unchanged row for try_window_id. */
10991 int debug_first_unchanged_at_end_vpos
;
10992 int debug_last_unchanged_at_beg_vpos
;
10994 /* Delta vpos and y. */
10996 int debug_dvpos
, debug_dy
;
10998 /* Delta in characters and bytes for try_window_id. */
11000 EMACS_INT debug_delta
, debug_delta_bytes
;
11002 /* Values of window_end_pos and window_end_vpos at the end of
11005 EMACS_INT debug_end_vpos
;
11007 /* Append a string to W->desired_matrix->method. FMT is a printf
11008 format string. A1...A9 are a supplement for a variable-length
11009 argument list. If trace_redisplay_p is non-zero also printf the
11010 resulting string to stderr. */
11013 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11016 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11019 char *method
= w
->desired_matrix
->method
;
11020 int len
= strlen (method
);
11021 int size
= sizeof w
->desired_matrix
->method
;
11022 int remaining
= size
- len
- 1;
11024 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11025 if (len
&& remaining
)
11028 --remaining
, ++len
;
11031 strncpy (method
+ len
, buffer
, remaining
);
11033 if (trace_redisplay_p
)
11034 fprintf (stderr
, "%p (%s): %s\n",
11036 ((BUFFERP (w
->buffer
)
11037 && STRINGP (XBUFFER (w
->buffer
)->name
))
11038 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11043 #endif /* GLYPH_DEBUG */
11046 /* Value is non-zero if all changes in window W, which displays
11047 current_buffer, are in the text between START and END. START is a
11048 buffer position, END is given as a distance from Z. Used in
11049 redisplay_internal for display optimization. */
11052 text_outside_line_unchanged_p (struct window
*w
,
11053 EMACS_INT start
, EMACS_INT end
)
11055 int unchanged_p
= 1;
11057 /* If text or overlays have changed, see where. */
11058 if (XFASTINT (w
->last_modified
) < MODIFF
11059 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11061 /* Gap in the line? */
11062 if (GPT
< start
|| Z
- GPT
< end
)
11065 /* Changes start in front of the line, or end after it? */
11067 && (BEG_UNCHANGED
< start
- 1
11068 || END_UNCHANGED
< end
))
11071 /* If selective display, can't optimize if changes start at the
11072 beginning of the line. */
11074 && INTEGERP (current_buffer
->selective_display
)
11075 && XINT (current_buffer
->selective_display
) > 0
11076 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11079 /* If there are overlays at the start or end of the line, these
11080 may have overlay strings with newlines in them. A change at
11081 START, for instance, may actually concern the display of such
11082 overlay strings as well, and they are displayed on different
11083 lines. So, quickly rule out this case. (For the future, it
11084 might be desirable to implement something more telling than
11085 just BEG/END_UNCHANGED.) */
11088 if (BEG
+ BEG_UNCHANGED
== start
11089 && overlay_touches_p (start
))
11091 if (END_UNCHANGED
== end
11092 && overlay_touches_p (Z
- end
))
11096 /* Under bidi reordering, adding or deleting a character in the
11097 beginning of a paragraph, before the first strong directional
11098 character, can change the base direction of the paragraph (unless
11099 the buffer specifies a fixed paragraph direction), which will
11100 require to redisplay the whole paragraph. It might be worthwhile
11101 to find the paragraph limits and widen the range of redisplayed
11102 lines to that, but for now just give up this optimization. */
11103 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11104 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11108 return unchanged_p
;
11112 /* Do a frame update, taking possible shortcuts into account. This is
11113 the main external entry point for redisplay.
11115 If the last redisplay displayed an echo area message and that message
11116 is no longer requested, we clear the echo area or bring back the
11117 mini-buffer if that is in use. */
11122 redisplay_internal (0);
11127 overlay_arrow_string_or_property (Lisp_Object var
)
11131 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11134 return Voverlay_arrow_string
;
11137 /* Return 1 if there are any overlay-arrows in current_buffer. */
11139 overlay_arrow_in_current_buffer_p (void)
11143 for (vlist
= Voverlay_arrow_variable_list
;
11145 vlist
= XCDR (vlist
))
11147 Lisp_Object var
= XCAR (vlist
);
11150 if (!SYMBOLP (var
))
11152 val
= find_symbol_value (var
);
11154 && current_buffer
== XMARKER (val
)->buffer
)
11161 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11165 overlay_arrows_changed_p (void)
11169 for (vlist
= Voverlay_arrow_variable_list
;
11171 vlist
= XCDR (vlist
))
11173 Lisp_Object var
= XCAR (vlist
);
11174 Lisp_Object val
, pstr
;
11176 if (!SYMBOLP (var
))
11178 val
= find_symbol_value (var
);
11179 if (!MARKERP (val
))
11181 if (! EQ (COERCE_MARKER (val
),
11182 Fget (var
, Qlast_arrow_position
))
11183 || ! (pstr
= overlay_arrow_string_or_property (var
),
11184 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11190 /* Mark overlay arrows to be updated on next redisplay. */
11193 update_overlay_arrows (int up_to_date
)
11197 for (vlist
= Voverlay_arrow_variable_list
;
11199 vlist
= XCDR (vlist
))
11201 Lisp_Object var
= XCAR (vlist
);
11203 if (!SYMBOLP (var
))
11206 if (up_to_date
> 0)
11208 Lisp_Object val
= find_symbol_value (var
);
11209 Fput (var
, Qlast_arrow_position
,
11210 COERCE_MARKER (val
));
11211 Fput (var
, Qlast_arrow_string
,
11212 overlay_arrow_string_or_property (var
));
11214 else if (up_to_date
< 0
11215 || !NILP (Fget (var
, Qlast_arrow_position
)))
11217 Fput (var
, Qlast_arrow_position
, Qt
);
11218 Fput (var
, Qlast_arrow_string
, Qt
);
11224 /* Return overlay arrow string to display at row.
11225 Return integer (bitmap number) for arrow bitmap in left fringe.
11226 Return nil if no overlay arrow. */
11229 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11233 for (vlist
= Voverlay_arrow_variable_list
;
11235 vlist
= XCDR (vlist
))
11237 Lisp_Object var
= XCAR (vlist
);
11240 if (!SYMBOLP (var
))
11243 val
= find_symbol_value (var
);
11246 && current_buffer
== XMARKER (val
)->buffer
11247 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11249 if (FRAME_WINDOW_P (it
->f
)
11250 /* FIXME: if ROW->reversed_p is set, this should test
11251 the right fringe, not the left one. */
11252 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11254 #ifdef HAVE_WINDOW_SYSTEM
11255 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11258 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11259 return make_number (fringe_bitmap
);
11262 return make_number (-1); /* Use default arrow bitmap */
11264 return overlay_arrow_string_or_property (var
);
11271 /* Return 1 if point moved out of or into a composition. Otherwise
11272 return 0. PREV_BUF and PREV_PT are the last point buffer and
11273 position. BUF and PT are the current point buffer and position. */
11276 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11277 struct buffer
*buf
, EMACS_INT pt
)
11279 EMACS_INT start
, end
;
11281 Lisp_Object buffer
;
11283 XSETBUFFER (buffer
, buf
);
11284 /* Check a composition at the last point if point moved within the
11286 if (prev_buf
== buf
)
11289 /* Point didn't move. */
11292 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11293 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11294 && COMPOSITION_VALID_P (start
, end
, prop
)
11295 && start
< prev_pt
&& end
> prev_pt
)
11296 /* The last point was within the composition. Return 1 iff
11297 point moved out of the composition. */
11298 return (pt
<= start
|| pt
>= end
);
11301 /* Check a composition at the current point. */
11302 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11303 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11304 && COMPOSITION_VALID_P (start
, end
, prop
)
11305 && start
< pt
&& end
> pt
);
11309 /* Reconsider the setting of B->clip_changed which is displayed
11313 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11315 if (b
->clip_changed
11316 && !NILP (w
->window_end_valid
)
11317 && w
->current_matrix
->buffer
== b
11318 && w
->current_matrix
->zv
== BUF_ZV (b
)
11319 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11320 b
->clip_changed
= 0;
11322 /* If display wasn't paused, and W is not a tool bar window, see if
11323 point has been moved into or out of a composition. In that case,
11324 we set b->clip_changed to 1 to force updating the screen. If
11325 b->clip_changed has already been set to 1, we can skip this
11327 if (!b
->clip_changed
11328 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11332 if (w
== XWINDOW (selected_window
))
11333 pt
= BUF_PT (current_buffer
);
11335 pt
= marker_position (w
->pointm
);
11337 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11338 || pt
!= XINT (w
->last_point
))
11339 && check_point_in_composition (w
->current_matrix
->buffer
,
11340 XINT (w
->last_point
),
11341 XBUFFER (w
->buffer
), pt
))
11342 b
->clip_changed
= 1;
11347 /* Select FRAME to forward the values of frame-local variables into C
11348 variables so that the redisplay routines can access those values
11352 select_frame_for_redisplay (Lisp_Object frame
)
11354 Lisp_Object tail
, tem
;
11355 Lisp_Object old
= selected_frame
;
11356 struct Lisp_Symbol
*sym
;
11358 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11360 selected_frame
= frame
;
11363 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11364 if (CONSP (XCAR (tail
))
11365 && (tem
= XCAR (XCAR (tail
)),
11367 && (sym
= indirect_variable (XSYMBOL (tem
)),
11368 sym
->redirect
== SYMBOL_LOCALIZED
)
11369 && sym
->val
.blv
->frame_local
)
11370 /* Use find_symbol_value rather than Fsymbol_value
11371 to avoid an error if it is void. */
11372 find_symbol_value (tem
);
11373 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11377 #define STOP_POLLING \
11378 do { if (! polling_stopped_here) stop_polling (); \
11379 polling_stopped_here = 1; } while (0)
11381 #define RESUME_POLLING \
11382 do { if (polling_stopped_here) start_polling (); \
11383 polling_stopped_here = 0; } while (0)
11386 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11387 response to any user action; therefore, we should preserve the echo
11388 area. (Actually, our caller does that job.) Perhaps in the future
11389 avoid recentering windows if it is not necessary; currently that
11390 causes some problems. */
11393 redisplay_internal (int preserve_echo_area
)
11395 struct window
*w
= XWINDOW (selected_window
);
11398 int must_finish
= 0;
11399 struct text_pos tlbufpos
, tlendpos
;
11400 int number_of_visible_frames
;
11403 int polling_stopped_here
= 0;
11404 Lisp_Object old_frame
= selected_frame
;
11406 /* Non-zero means redisplay has to consider all windows on all
11407 frames. Zero means, only selected_window is considered. */
11408 int consider_all_windows_p
;
11410 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11412 /* No redisplay if running in batch mode or frame is not yet fully
11413 initialized, or redisplay is explicitly turned off by setting
11414 Vinhibit_redisplay. */
11415 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11416 || !NILP (Vinhibit_redisplay
))
11419 /* Don't examine these until after testing Vinhibit_redisplay.
11420 When Emacs is shutting down, perhaps because its connection to
11421 X has dropped, we should not look at them at all. */
11422 f
= XFRAME (w
->frame
);
11423 sf
= SELECTED_FRAME ();
11425 if (!f
->glyphs_initialized_p
)
11428 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11429 if (popup_activated ())
11433 /* I don't think this happens but let's be paranoid. */
11434 if (redisplaying_p
)
11437 /* Record a function that resets redisplaying_p to its old value
11438 when we leave this function. */
11439 count
= SPECPDL_INDEX ();
11440 record_unwind_protect (unwind_redisplay
,
11441 Fcons (make_number (redisplaying_p
), selected_frame
));
11443 specbind (Qinhibit_free_realized_faces
, Qnil
);
11446 Lisp_Object tail
, frame
;
11448 FOR_EACH_FRAME (tail
, frame
)
11450 struct frame
*f
= XFRAME (frame
);
11451 f
->already_hscrolled_p
= 0;
11456 if (!EQ (old_frame
, selected_frame
)
11457 && FRAME_LIVE_P (XFRAME (old_frame
)))
11458 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11459 selected_frame and selected_window to be temporarily out-of-sync so
11460 when we come back here via `goto retry', we need to resync because we
11461 may need to run Elisp code (via prepare_menu_bars). */
11462 select_frame_for_redisplay (old_frame
);
11465 reconsider_clip_changes (w
, current_buffer
);
11466 last_escape_glyph_frame
= NULL
;
11467 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11468 last_glyphless_glyph_frame
= NULL
;
11469 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11471 /* If new fonts have been loaded that make a glyph matrix adjustment
11472 necessary, do it. */
11473 if (fonts_changed_p
)
11475 adjust_glyphs (NULL
);
11476 ++windows_or_buffers_changed
;
11477 fonts_changed_p
= 0;
11480 /* If face_change_count is non-zero, init_iterator will free all
11481 realized faces, which includes the faces referenced from current
11482 matrices. So, we can't reuse current matrices in this case. */
11483 if (face_change_count
)
11484 ++windows_or_buffers_changed
;
11486 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11487 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11489 /* Since frames on a single ASCII terminal share the same
11490 display area, displaying a different frame means redisplay
11491 the whole thing. */
11492 windows_or_buffers_changed
++;
11493 SET_FRAME_GARBAGED (sf
);
11495 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11497 FRAME_TTY (sf
)->previous_frame
= sf
;
11500 /* Set the visible flags for all frames. Do this before checking
11501 for resized or garbaged frames; they want to know if their frames
11502 are visible. See the comment in frame.h for
11503 FRAME_SAMPLE_VISIBILITY. */
11505 Lisp_Object tail
, frame
;
11507 number_of_visible_frames
= 0;
11509 FOR_EACH_FRAME (tail
, frame
)
11511 struct frame
*f
= XFRAME (frame
);
11513 FRAME_SAMPLE_VISIBILITY (f
);
11514 if (FRAME_VISIBLE_P (f
))
11515 ++number_of_visible_frames
;
11516 clear_desired_matrices (f
);
11520 /* Notice any pending interrupt request to change frame size. */
11521 do_pending_window_change (1);
11523 /* Clear frames marked as garbaged. */
11524 if (frame_garbaged
)
11525 clear_garbaged_frames ();
11527 /* Build menubar and tool-bar items. */
11528 if (NILP (Vmemory_full
))
11529 prepare_menu_bars ();
11531 if (windows_or_buffers_changed
)
11532 update_mode_lines
++;
11534 /* Detect case that we need to write or remove a star in the mode line. */
11535 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11537 w
->update_mode_line
= Qt
;
11538 if (buffer_shared
> 1)
11539 update_mode_lines
++;
11542 /* Avoid invocation of point motion hooks by `current_column' below. */
11543 count1
= SPECPDL_INDEX ();
11544 specbind (Qinhibit_point_motion_hooks
, Qt
);
11546 /* If %c is in the mode line, update it if needed. */
11547 if (!NILP (w
->column_number_displayed
)
11548 /* This alternative quickly identifies a common case
11549 where no change is needed. */
11550 && !(PT
== XFASTINT (w
->last_point
)
11551 && XFASTINT (w
->last_modified
) >= MODIFF
11552 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11553 && (XFASTINT (w
->column_number_displayed
)
11554 != (int) current_column ())) /* iftc */
11555 w
->update_mode_line
= Qt
;
11557 unbind_to (count1
, Qnil
);
11559 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11561 /* The variable buffer_shared is set in redisplay_window and
11562 indicates that we redisplay a buffer in different windows. See
11564 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11565 || cursor_type_changed
);
11567 /* If specs for an arrow have changed, do thorough redisplay
11568 to ensure we remove any arrow that should no longer exist. */
11569 if (overlay_arrows_changed_p ())
11570 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11572 /* Normally the message* functions will have already displayed and
11573 updated the echo area, but the frame may have been trashed, or
11574 the update may have been preempted, so display the echo area
11575 again here. Checking message_cleared_p captures the case that
11576 the echo area should be cleared. */
11577 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11578 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11579 || (message_cleared_p
11580 && minibuf_level
== 0
11581 /* If the mini-window is currently selected, this means the
11582 echo-area doesn't show through. */
11583 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11585 int window_height_changed_p
= echo_area_display (0);
11588 /* If we don't display the current message, don't clear the
11589 message_cleared_p flag, because, if we did, we wouldn't clear
11590 the echo area in the next redisplay which doesn't preserve
11592 if (!display_last_displayed_message_p
)
11593 message_cleared_p
= 0;
11595 if (fonts_changed_p
)
11597 else if (window_height_changed_p
)
11599 consider_all_windows_p
= 1;
11600 ++update_mode_lines
;
11601 ++windows_or_buffers_changed
;
11603 /* If window configuration was changed, frames may have been
11604 marked garbaged. Clear them or we will experience
11605 surprises wrt scrolling. */
11606 if (frame_garbaged
)
11607 clear_garbaged_frames ();
11610 else if (EQ (selected_window
, minibuf_window
)
11611 && (current_buffer
->clip_changed
11612 || XFASTINT (w
->last_modified
) < MODIFF
11613 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11614 && resize_mini_window (w
, 0))
11616 /* Resized active mini-window to fit the size of what it is
11617 showing if its contents might have changed. */
11619 /* FIXME: this causes all frames to be updated, which seems unnecessary
11620 since only the current frame needs to be considered. This function needs
11621 to be rewritten with two variables, consider_all_windows and
11622 consider_all_frames. */
11623 consider_all_windows_p
= 1;
11624 ++windows_or_buffers_changed
;
11625 ++update_mode_lines
;
11627 /* If window configuration was changed, frames may have been
11628 marked garbaged. Clear them or we will experience
11629 surprises wrt scrolling. */
11630 if (frame_garbaged
)
11631 clear_garbaged_frames ();
11635 /* If showing the region, and mark has changed, we must redisplay
11636 the whole window. The assignment to this_line_start_pos prevents
11637 the optimization directly below this if-statement. */
11638 if (((!NILP (Vtransient_mark_mode
)
11639 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11640 != !NILP (w
->region_showing
))
11641 || (!NILP (w
->region_showing
)
11642 && !EQ (w
->region_showing
,
11643 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11644 CHARPOS (this_line_start_pos
) = 0;
11646 /* Optimize the case that only the line containing the cursor in the
11647 selected window has changed. Variables starting with this_ are
11648 set in display_line and record information about the line
11649 containing the cursor. */
11650 tlbufpos
= this_line_start_pos
;
11651 tlendpos
= this_line_end_pos
;
11652 if (!consider_all_windows_p
11653 && CHARPOS (tlbufpos
) > 0
11654 && NILP (w
->update_mode_line
)
11655 && !current_buffer
->clip_changed
11656 && !current_buffer
->prevent_redisplay_optimizations_p
11657 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11658 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11659 /* Make sure recorded data applies to current buffer, etc. */
11660 && this_line_buffer
== current_buffer
11661 && current_buffer
== XBUFFER (w
->buffer
)
11662 && NILP (w
->force_start
)
11663 && NILP (w
->optional_new_start
)
11664 /* Point must be on the line that we have info recorded about. */
11665 && PT
>= CHARPOS (tlbufpos
)
11666 && PT
<= Z
- CHARPOS (tlendpos
)
11667 /* All text outside that line, including its final newline,
11668 must be unchanged. */
11669 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11670 CHARPOS (tlendpos
)))
11672 if (CHARPOS (tlbufpos
) > BEGV
11673 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11674 && (CHARPOS (tlbufpos
) == ZV
11675 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11676 /* Former continuation line has disappeared by becoming empty. */
11678 else if (XFASTINT (w
->last_modified
) < MODIFF
11679 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11680 || MINI_WINDOW_P (w
))
11682 /* We have to handle the case of continuation around a
11683 wide-column character (see the comment in indent.c around
11686 For instance, in the following case:
11688 -------- Insert --------
11689 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11690 J_I_ ==> J_I_ `^^' are cursors.
11694 As we have to redraw the line above, we cannot use this
11698 int line_height_before
= this_line_pixel_height
;
11700 /* Note that start_display will handle the case that the
11701 line starting at tlbufpos is a continuation line. */
11702 start_display (&it
, w
, tlbufpos
);
11704 /* Implementation note: It this still necessary? */
11705 if (it
.current_x
!= this_line_start_x
)
11708 TRACE ((stderr
, "trying display optimization 1\n"));
11709 w
->cursor
.vpos
= -1;
11710 overlay_arrow_seen
= 0;
11711 it
.vpos
= this_line_vpos
;
11712 it
.current_y
= this_line_y
;
11713 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11714 display_line (&it
);
11716 /* If line contains point, is not continued,
11717 and ends at same distance from eob as before, we win. */
11718 if (w
->cursor
.vpos
>= 0
11719 /* Line is not continued, otherwise this_line_start_pos
11720 would have been set to 0 in display_line. */
11721 && CHARPOS (this_line_start_pos
)
11722 /* Line ends as before. */
11723 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11724 /* Line has same height as before. Otherwise other lines
11725 would have to be shifted up or down. */
11726 && this_line_pixel_height
== line_height_before
)
11728 /* If this is not the window's last line, we must adjust
11729 the charstarts of the lines below. */
11730 if (it
.current_y
< it
.last_visible_y
)
11732 struct glyph_row
*row
11733 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11734 EMACS_INT delta
, delta_bytes
;
11736 /* We used to distinguish between two cases here,
11737 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11738 when the line ends in a newline or the end of the
11739 buffer's accessible portion. But both cases did
11740 the same, so they were collapsed. */
11742 - CHARPOS (tlendpos
)
11743 - MATRIX_ROW_START_CHARPOS (row
));
11744 delta_bytes
= (Z_BYTE
11745 - BYTEPOS (tlendpos
)
11746 - MATRIX_ROW_START_BYTEPOS (row
));
11748 increment_matrix_positions (w
->current_matrix
,
11749 this_line_vpos
+ 1,
11750 w
->current_matrix
->nrows
,
11751 delta
, delta_bytes
);
11754 /* If this row displays text now but previously didn't,
11755 or vice versa, w->window_end_vpos may have to be
11757 if ((it
.glyph_row
- 1)->displays_text_p
)
11759 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11760 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11762 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11763 && this_line_vpos
> 0)
11764 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11765 w
->window_end_valid
= Qnil
;
11767 /* Update hint: No need to try to scroll in update_window. */
11768 w
->desired_matrix
->no_scrolling_p
= 1;
11771 *w
->desired_matrix
->method
= 0;
11772 debug_method_add (w
, "optimization 1");
11774 #ifdef HAVE_WINDOW_SYSTEM
11775 update_window_fringes (w
, 0);
11782 else if (/* Cursor position hasn't changed. */
11783 PT
== XFASTINT (w
->last_point
)
11784 /* Make sure the cursor was last displayed
11785 in this window. Otherwise we have to reposition it. */
11786 && 0 <= w
->cursor
.vpos
11787 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11791 do_pending_window_change (1);
11793 /* We used to always goto end_of_redisplay here, but this
11794 isn't enough if we have a blinking cursor. */
11795 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11796 goto end_of_redisplay
;
11800 /* If highlighting the region, or if the cursor is in the echo area,
11801 then we can't just move the cursor. */
11802 else if (! (!NILP (Vtransient_mark_mode
)
11803 && !NILP (current_buffer
->mark_active
))
11804 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11805 || highlight_nonselected_windows
)
11806 && NILP (w
->region_showing
)
11807 && NILP (Vshow_trailing_whitespace
)
11808 && !cursor_in_echo_area
)
11811 struct glyph_row
*row
;
11813 /* Skip from tlbufpos to PT and see where it is. Note that
11814 PT may be in invisible text. If so, we will end at the
11815 next visible position. */
11816 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11817 NULL
, DEFAULT_FACE_ID
);
11818 it
.current_x
= this_line_start_x
;
11819 it
.current_y
= this_line_y
;
11820 it
.vpos
= this_line_vpos
;
11822 /* The call to move_it_to stops in front of PT, but
11823 moves over before-strings. */
11824 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11826 if (it
.vpos
== this_line_vpos
11827 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11830 xassert (this_line_vpos
== it
.vpos
);
11831 xassert (this_line_y
== it
.current_y
);
11832 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11834 *w
->desired_matrix
->method
= 0;
11835 debug_method_add (w
, "optimization 3");
11844 /* Text changed drastically or point moved off of line. */
11845 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11848 CHARPOS (this_line_start_pos
) = 0;
11849 consider_all_windows_p
|= buffer_shared
> 1;
11850 ++clear_face_cache_count
;
11851 #ifdef HAVE_WINDOW_SYSTEM
11852 ++clear_image_cache_count
;
11855 /* Build desired matrices, and update the display. If
11856 consider_all_windows_p is non-zero, do it for all windows on all
11857 frames. Otherwise do it for selected_window, only. */
11859 if (consider_all_windows_p
)
11861 Lisp_Object tail
, frame
;
11863 FOR_EACH_FRAME (tail
, frame
)
11864 XFRAME (frame
)->updated_p
= 0;
11866 /* Recompute # windows showing selected buffer. This will be
11867 incremented each time such a window is displayed. */
11870 FOR_EACH_FRAME (tail
, frame
)
11872 struct frame
*f
= XFRAME (frame
);
11874 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11876 if (! EQ (frame
, selected_frame
))
11877 /* Select the frame, for the sake of frame-local
11879 select_frame_for_redisplay (frame
);
11881 /* Mark all the scroll bars to be removed; we'll redeem
11882 the ones we want when we redisplay their windows. */
11883 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11884 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11886 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11887 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11889 /* The X error handler may have deleted that frame. */
11890 if (!FRAME_LIVE_P (f
))
11893 /* Any scroll bars which redisplay_windows should have
11894 nuked should now go away. */
11895 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11896 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11898 /* If fonts changed, display again. */
11899 /* ??? rms: I suspect it is a mistake to jump all the way
11900 back to retry here. It should just retry this frame. */
11901 if (fonts_changed_p
)
11904 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11906 /* See if we have to hscroll. */
11907 if (!f
->already_hscrolled_p
)
11909 f
->already_hscrolled_p
= 1;
11910 if (hscroll_windows (f
->root_window
))
11914 /* Prevent various kinds of signals during display
11915 update. stdio is not robust about handling
11916 signals, which can cause an apparent I/O
11918 if (interrupt_input
)
11919 unrequest_sigio ();
11922 /* Update the display. */
11923 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11924 pause
|= update_frame (f
, 0, 0);
11930 if (!EQ (old_frame
, selected_frame
)
11931 && FRAME_LIVE_P (XFRAME (old_frame
)))
11932 /* We played a bit fast-and-loose above and allowed selected_frame
11933 and selected_window to be temporarily out-of-sync but let's make
11934 sure this stays contained. */
11935 select_frame_for_redisplay (old_frame
);
11936 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11940 /* Do the mark_window_display_accurate after all windows have
11941 been redisplayed because this call resets flags in buffers
11942 which are needed for proper redisplay. */
11943 FOR_EACH_FRAME (tail
, frame
)
11945 struct frame
*f
= XFRAME (frame
);
11948 mark_window_display_accurate (f
->root_window
, 1);
11949 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11950 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11955 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11957 Lisp_Object mini_window
;
11958 struct frame
*mini_frame
;
11960 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11961 /* Use list_of_error, not Qerror, so that
11962 we catch only errors and don't run the debugger. */
11963 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11965 redisplay_window_error
);
11967 /* Compare desired and current matrices, perform output. */
11970 /* If fonts changed, display again. */
11971 if (fonts_changed_p
)
11974 /* Prevent various kinds of signals during display update.
11975 stdio is not robust about handling signals,
11976 which can cause an apparent I/O error. */
11977 if (interrupt_input
)
11978 unrequest_sigio ();
11981 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11983 if (hscroll_windows (selected_window
))
11986 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11987 pause
= update_frame (sf
, 0, 0);
11990 /* We may have called echo_area_display at the top of this
11991 function. If the echo area is on another frame, that may
11992 have put text on a frame other than the selected one, so the
11993 above call to update_frame would not have caught it. Catch
11995 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11996 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11998 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12000 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12001 pause
|= update_frame (mini_frame
, 0, 0);
12002 if (!pause
&& hscroll_windows (mini_window
))
12007 /* If display was paused because of pending input, make sure we do a
12008 thorough update the next time. */
12011 /* Prevent the optimization at the beginning of
12012 redisplay_internal that tries a single-line update of the
12013 line containing the cursor in the selected window. */
12014 CHARPOS (this_line_start_pos
) = 0;
12016 /* Let the overlay arrow be updated the next time. */
12017 update_overlay_arrows (0);
12019 /* If we pause after scrolling, some rows in the current
12020 matrices of some windows are not valid. */
12021 if (!WINDOW_FULL_WIDTH_P (w
)
12022 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12023 update_mode_lines
= 1;
12027 if (!consider_all_windows_p
)
12029 /* This has already been done above if
12030 consider_all_windows_p is set. */
12031 mark_window_display_accurate_1 (w
, 1);
12033 /* Say overlay arrows are up to date. */
12034 update_overlay_arrows (1);
12036 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12037 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12040 update_mode_lines
= 0;
12041 windows_or_buffers_changed
= 0;
12042 cursor_type_changed
= 0;
12045 /* Start SIGIO interrupts coming again. Having them off during the
12046 code above makes it less likely one will discard output, but not
12047 impossible, since there might be stuff in the system buffer here.
12048 But it is much hairier to try to do anything about that. */
12049 if (interrupt_input
)
12053 /* If a frame has become visible which was not before, redisplay
12054 again, so that we display it. Expose events for such a frame
12055 (which it gets when becoming visible) don't call the parts of
12056 redisplay constructing glyphs, so simply exposing a frame won't
12057 display anything in this case. So, we have to display these
12058 frames here explicitly. */
12061 Lisp_Object tail
, frame
;
12064 FOR_EACH_FRAME (tail
, frame
)
12066 int this_is_visible
= 0;
12068 if (XFRAME (frame
)->visible
)
12069 this_is_visible
= 1;
12070 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12071 if (XFRAME (frame
)->visible
)
12072 this_is_visible
= 1;
12074 if (this_is_visible
)
12078 if (new_count
!= number_of_visible_frames
)
12079 windows_or_buffers_changed
++;
12082 /* Change frame size now if a change is pending. */
12083 do_pending_window_change (1);
12085 /* If we just did a pending size change, or have additional
12086 visible frames, redisplay again. */
12087 if (windows_or_buffers_changed
&& !pause
)
12090 /* Clear the face and image caches.
12092 We used to do this only if consider_all_windows_p. But the cache
12093 needs to be cleared if a timer creates images in the current
12094 buffer (e.g. the test case in Bug#6230). */
12096 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12098 clear_face_cache (0);
12099 clear_face_cache_count
= 0;
12102 #ifdef HAVE_WINDOW_SYSTEM
12103 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12105 clear_image_caches (Qnil
);
12106 clear_image_cache_count
= 0;
12108 #endif /* HAVE_WINDOW_SYSTEM */
12111 unbind_to (count
, Qnil
);
12116 /* Redisplay, but leave alone any recent echo area message unless
12117 another message has been requested in its place.
12119 This is useful in situations where you need to redisplay but no
12120 user action has occurred, making it inappropriate for the message
12121 area to be cleared. See tracking_off and
12122 wait_reading_process_output for examples of these situations.
12124 FROM_WHERE is an integer saying from where this function was
12125 called. This is useful for debugging. */
12128 redisplay_preserve_echo_area (int from_where
)
12130 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12132 if (!NILP (echo_area_buffer
[1]))
12134 /* We have a previously displayed message, but no current
12135 message. Redisplay the previous message. */
12136 display_last_displayed_message_p
= 1;
12137 redisplay_internal (1);
12138 display_last_displayed_message_p
= 0;
12141 redisplay_internal (1);
12143 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12144 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12145 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12149 /* Function registered with record_unwind_protect in
12150 redisplay_internal. Reset redisplaying_p to the value it had
12151 before redisplay_internal was called, and clear
12152 prevent_freeing_realized_faces_p. It also selects the previously
12153 selected frame, unless it has been deleted (by an X connection
12154 failure during redisplay, for example). */
12157 unwind_redisplay (Lisp_Object val
)
12159 Lisp_Object old_redisplaying_p
, old_frame
;
12161 old_redisplaying_p
= XCAR (val
);
12162 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12163 old_frame
= XCDR (val
);
12164 if (! EQ (old_frame
, selected_frame
)
12165 && FRAME_LIVE_P (XFRAME (old_frame
)))
12166 select_frame_for_redisplay (old_frame
);
12171 /* Mark the display of window W as accurate or inaccurate. If
12172 ACCURATE_P is non-zero mark display of W as accurate. If
12173 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12174 redisplay_internal is called. */
12177 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12179 if (BUFFERP (w
->buffer
))
12181 struct buffer
*b
= XBUFFER (w
->buffer
);
12184 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12185 w
->last_overlay_modified
12186 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12188 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12192 b
->clip_changed
= 0;
12193 b
->prevent_redisplay_optimizations_p
= 0;
12195 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12196 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12197 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12198 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12200 w
->current_matrix
->buffer
= b
;
12201 w
->current_matrix
->begv
= BUF_BEGV (b
);
12202 w
->current_matrix
->zv
= BUF_ZV (b
);
12204 w
->last_cursor
= w
->cursor
;
12205 w
->last_cursor_off_p
= w
->cursor_off_p
;
12207 if (w
== XWINDOW (selected_window
))
12208 w
->last_point
= make_number (BUF_PT (b
));
12210 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12216 w
->window_end_valid
= w
->buffer
;
12217 w
->update_mode_line
= Qnil
;
12222 /* Mark the display of windows in the window tree rooted at WINDOW as
12223 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12224 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12225 be redisplayed the next time redisplay_internal is called. */
12228 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12232 for (; !NILP (window
); window
= w
->next
)
12234 w
= XWINDOW (window
);
12235 mark_window_display_accurate_1 (w
, accurate_p
);
12237 if (!NILP (w
->vchild
))
12238 mark_window_display_accurate (w
->vchild
, accurate_p
);
12239 if (!NILP (w
->hchild
))
12240 mark_window_display_accurate (w
->hchild
, accurate_p
);
12245 update_overlay_arrows (1);
12249 /* Force a thorough redisplay the next time by setting
12250 last_arrow_position and last_arrow_string to t, which is
12251 unequal to any useful value of Voverlay_arrow_... */
12252 update_overlay_arrows (-1);
12257 /* Return value in display table DP (Lisp_Char_Table *) for character
12258 C. Since a display table doesn't have any parent, we don't have to
12259 follow parent. Do not call this function directly but use the
12260 macro DISP_CHAR_VECTOR. */
12263 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12267 if (ASCII_CHAR_P (c
))
12270 if (SUB_CHAR_TABLE_P (val
))
12271 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12277 XSETCHAR_TABLE (table
, dp
);
12278 val
= char_table_ref (table
, c
);
12287 /***********************************************************************
12289 ***********************************************************************/
12291 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12294 redisplay_windows (Lisp_Object window
)
12296 while (!NILP (window
))
12298 struct window
*w
= XWINDOW (window
);
12300 if (!NILP (w
->hchild
))
12301 redisplay_windows (w
->hchild
);
12302 else if (!NILP (w
->vchild
))
12303 redisplay_windows (w
->vchild
);
12304 else if (!NILP (w
->buffer
))
12306 displayed_buffer
= XBUFFER (w
->buffer
);
12307 /* Use list_of_error, not Qerror, so that
12308 we catch only errors and don't run the debugger. */
12309 internal_condition_case_1 (redisplay_window_0
, window
,
12311 redisplay_window_error
);
12319 redisplay_window_error (Lisp_Object ignore
)
12321 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12326 redisplay_window_0 (Lisp_Object window
)
12328 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12329 redisplay_window (window
, 0);
12334 redisplay_window_1 (Lisp_Object window
)
12336 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12337 redisplay_window (window
, 1);
12342 /* Increment GLYPH until it reaches END or CONDITION fails while
12343 adding (GLYPH)->pixel_width to X. */
12345 #define SKIP_GLYPHS(glyph, end, x, condition) \
12348 (x) += (glyph)->pixel_width; \
12351 while ((glyph) < (end) && (condition))
12354 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12355 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12356 which positions recorded in ROW differ from current buffer
12359 Return 0 if cursor is not on this row, 1 otherwise. */
12362 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12363 struct glyph_matrix
*matrix
,
12364 EMACS_INT delta
, EMACS_INT delta_bytes
,
12367 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12368 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12369 struct glyph
*cursor
= NULL
;
12370 /* The last known character position in row. */
12371 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12373 EMACS_INT pt_old
= PT
- delta
;
12374 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12375 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12376 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12377 /* A glyph beyond the edge of TEXT_AREA which we should never
12379 struct glyph
*glyphs_end
= end
;
12380 /* Non-zero means we've found a match for cursor position, but that
12381 glyph has the avoid_cursor_p flag set. */
12382 int match_with_avoid_cursor
= 0;
12383 /* Non-zero means we've seen at least one glyph that came from a
12385 int string_seen
= 0;
12386 /* Largest and smalles buffer positions seen so far during scan of
12388 EMACS_INT bpos_max
= pos_before
;
12389 EMACS_INT bpos_min
= pos_after
;
12390 /* Last buffer position covered by an overlay string with an integer
12391 `cursor' property. */
12392 EMACS_INT bpos_covered
= 0;
12394 /* Skip over glyphs not having an object at the start and the end of
12395 the row. These are special glyphs like truncation marks on
12396 terminal frames. */
12397 if (row
->displays_text_p
)
12399 if (!row
->reversed_p
)
12402 && INTEGERP (glyph
->object
)
12403 && glyph
->charpos
< 0)
12405 x
+= glyph
->pixel_width
;
12409 && INTEGERP ((end
- 1)->object
)
12410 /* CHARPOS is zero for blanks and stretch glyphs
12411 inserted by extend_face_to_end_of_line. */
12412 && (end
- 1)->charpos
<= 0)
12414 glyph_before
= glyph
- 1;
12421 /* If the glyph row is reversed, we need to process it from back
12422 to front, so swap the edge pointers. */
12423 glyphs_end
= end
= glyph
- 1;
12424 glyph
+= row
->used
[TEXT_AREA
] - 1;
12426 while (glyph
> end
+ 1
12427 && INTEGERP (glyph
->object
)
12428 && glyph
->charpos
< 0)
12431 x
-= glyph
->pixel_width
;
12433 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12435 /* By default, in reversed rows we put the cursor on the
12436 rightmost (first in the reading order) glyph. */
12437 for (g
= end
+ 1; g
< glyph
; g
++)
12438 x
+= g
->pixel_width
;
12440 && INTEGERP ((end
+ 1)->object
)
12441 && (end
+ 1)->charpos
<= 0)
12443 glyph_before
= glyph
+ 1;
12447 else if (row
->reversed_p
)
12449 /* In R2L rows that don't display text, put the cursor on the
12450 rightmost glyph. Case in point: an empty last line that is
12451 part of an R2L paragraph. */
12453 /* Avoid placing the cursor on the last glyph of the row, where
12454 on terminal frames we hold the vertical border between
12455 adjacent windows. */
12456 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12457 && !WINDOW_RIGHTMOST_P (w
)
12458 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12460 x
= -1; /* will be computed below, at label compute_x */
12463 /* Step 1: Try to find the glyph whose character position
12464 corresponds to point. If that's not possible, find 2 glyphs
12465 whose character positions are the closest to point, one before
12466 point, the other after it. */
12467 if (!row
->reversed_p
)
12468 while (/* not marched to end of glyph row */
12470 /* glyph was not inserted by redisplay for internal purposes */
12471 && !INTEGERP (glyph
->object
))
12473 if (BUFFERP (glyph
->object
))
12475 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12477 if (glyph
->charpos
> bpos_max
)
12478 bpos_max
= glyph
->charpos
;
12479 if (glyph
->charpos
< bpos_min
)
12480 bpos_min
= glyph
->charpos
;
12481 if (!glyph
->avoid_cursor_p
)
12483 /* If we hit point, we've found the glyph on which to
12484 display the cursor. */
12487 match_with_avoid_cursor
= 0;
12490 /* See if we've found a better approximation to
12491 POS_BEFORE or to POS_AFTER. Note that we want the
12492 first (leftmost) glyph of all those that are the
12493 closest from below, and the last (rightmost) of all
12494 those from above. */
12495 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12497 pos_before
= glyph
->charpos
;
12498 glyph_before
= glyph
;
12500 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12502 pos_after
= glyph
->charpos
;
12503 glyph_after
= glyph
;
12506 else if (dpos
== 0)
12507 match_with_avoid_cursor
= 1;
12509 else if (STRINGP (glyph
->object
))
12511 Lisp_Object chprop
;
12512 EMACS_INT glyph_pos
= glyph
->charpos
;
12514 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12516 if (INTEGERP (chprop
))
12518 bpos_covered
= bpos_max
+ XINT (chprop
);
12519 /* If the `cursor' property covers buffer positions up
12520 to and including point, we should display cursor on
12521 this glyph. Note that overlays and text properties
12522 with string values stop bidi reordering, so every
12523 buffer position to the left of the string is always
12524 smaller than any position to the right of the
12525 string. Therefore, if a `cursor' property on one
12526 of the string's characters has an integer value, we
12527 will break out of the loop below _before_ we get to
12528 the position match above. IOW, integer values of
12529 the `cursor' property override the "exact match for
12530 point" strategy of positioning the cursor. */
12531 /* Implementation note: bpos_max == pt_old when, e.g.,
12532 we are in an empty line, where bpos_max is set to
12533 MATRIX_ROW_START_CHARPOS, see above. */
12534 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12543 x
+= glyph
->pixel_width
;
12546 else if (glyph
> end
) /* row is reversed */
12547 while (!INTEGERP (glyph
->object
))
12549 if (BUFFERP (glyph
->object
))
12551 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12553 if (glyph
->charpos
> bpos_max
)
12554 bpos_max
= glyph
->charpos
;
12555 if (glyph
->charpos
< bpos_min
)
12556 bpos_min
= glyph
->charpos
;
12557 if (!glyph
->avoid_cursor_p
)
12561 match_with_avoid_cursor
= 0;
12564 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12566 pos_before
= glyph
->charpos
;
12567 glyph_before
= glyph
;
12569 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12571 pos_after
= glyph
->charpos
;
12572 glyph_after
= glyph
;
12575 else if (dpos
== 0)
12576 match_with_avoid_cursor
= 1;
12578 else if (STRINGP (glyph
->object
))
12580 Lisp_Object chprop
;
12581 EMACS_INT glyph_pos
= glyph
->charpos
;
12583 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12585 if (INTEGERP (chprop
))
12587 bpos_covered
= bpos_max
+ XINT (chprop
);
12588 /* If the `cursor' property covers buffer positions up
12589 to and including point, we should display cursor on
12591 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12600 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12602 x
--; /* can't use any pixel_width */
12605 x
-= glyph
->pixel_width
;
12608 /* Step 2: If we didn't find an exact match for point, we need to
12609 look for a proper place to put the cursor among glyphs between
12610 GLYPH_BEFORE and GLYPH_AFTER. */
12611 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12612 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12613 && bpos_covered
< pt_old
)
12615 /* An empty line has a single glyph whose OBJECT is zero and
12616 whose CHARPOS is the position of a newline on that line.
12617 Note that on a TTY, there are more glyphs after that, which
12618 were produced by extend_face_to_end_of_line, but their
12619 CHARPOS is zero or negative. */
12621 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12622 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12624 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12626 EMACS_INT ellipsis_pos
;
12628 /* Scan back over the ellipsis glyphs. */
12629 if (!row
->reversed_p
)
12631 ellipsis_pos
= (glyph
- 1)->charpos
;
12632 while (glyph
> row
->glyphs
[TEXT_AREA
]
12633 && (glyph
- 1)->charpos
== ellipsis_pos
)
12634 glyph
--, x
-= glyph
->pixel_width
;
12635 /* That loop always goes one position too far, including
12636 the glyph before the ellipsis. So scan forward over
12638 x
+= glyph
->pixel_width
;
12641 else /* row is reversed */
12643 ellipsis_pos
= (glyph
+ 1)->charpos
;
12644 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12645 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12646 glyph
++, x
+= glyph
->pixel_width
;
12647 x
-= glyph
->pixel_width
;
12651 else if (match_with_avoid_cursor
12652 /* A truncated row may not include PT among its
12653 character positions. Setting the cursor inside the
12654 scroll margin will trigger recalculation of hscroll
12655 in hscroll_window_tree. */
12656 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12657 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12658 /* Zero-width characters produce no glyphs. */
12661 && (row
->reversed_p
12662 ? glyph_after
> glyphs_end
12663 : glyph_after
< glyphs_end
)))
12665 cursor
= glyph_after
;
12668 else if (string_seen
)
12670 int incr
= row
->reversed_p
? -1 : +1;
12672 /* Need to find the glyph that came out of a string which is
12673 present at point. That glyph is somewhere between
12674 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12675 positioned between POS_BEFORE and POS_AFTER in the
12677 struct glyph
*stop
= glyph_after
;
12678 EMACS_INT pos
= pos_before
;
12681 for (glyph
= glyph_before
+ incr
;
12682 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12685 /* Any glyphs that come from the buffer are here because
12686 of bidi reordering. Skip them, and only pay
12687 attention to glyphs that came from some string. */
12688 if (STRINGP (glyph
->object
))
12693 str
= glyph
->object
;
12694 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12695 if (tem
== 0 /* from overlay */
12698 /* If the string from which this glyph came is
12699 found in the buffer at point, then we've
12700 found the glyph we've been looking for. If
12701 it comes from an overlay (tem == 0), and it
12702 has the `cursor' property on one of its
12703 glyphs, record that glyph as a candidate for
12704 displaying the cursor. (As in the
12705 unidirectional version, we will display the
12706 cursor on the last candidate we find.) */
12707 if (tem
== 0 || tem
== pt_old
)
12709 /* The glyphs from this string could have
12710 been reordered. Find the one with the
12711 smallest string position. Or there could
12712 be a character in the string with the
12713 `cursor' property, which means display
12714 cursor on that character's glyph. */
12715 EMACS_INT strpos
= glyph
->charpos
;
12720 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12721 && EQ (glyph
->object
, str
);
12725 EMACS_INT gpos
= glyph
->charpos
;
12727 cprop
= Fget_char_property (make_number (gpos
),
12735 if (tem
&& glyph
->charpos
< strpos
)
12737 strpos
= glyph
->charpos
;
12746 pos
= tem
+ 1; /* don't find previous instances */
12748 /* This string is not what we want; skip all of the
12749 glyphs that came from it. */
12750 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12751 && EQ (glyph
->object
, str
))
12758 /* If we reached the end of the line, and END was from a string,
12759 the cursor is not on this line. */
12761 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12762 && STRINGP (end
->object
)
12763 && row
->continued_p
)
12769 if (cursor
!= NULL
)
12775 /* Need to compute x that corresponds to GLYPH. */
12776 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12778 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12780 x
+= g
->pixel_width
;
12784 /* ROW could be part of a continued line, which, under bidi
12785 reordering, might have other rows whose start and end charpos
12786 occlude point. Only set w->cursor if we found a better
12787 approximation to the cursor position than we have from previously
12788 examined candidate rows belonging to the same continued line. */
12789 if (/* we already have a candidate row */
12790 w
->cursor
.vpos
>= 0
12791 /* that candidate is not the row we are processing */
12792 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12793 /* the row we are processing is part of a continued line */
12794 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12795 /* Make sure cursor.vpos specifies a row whose start and end
12796 charpos occlude point. This is because some callers of this
12797 function leave cursor.vpos at the row where the cursor was
12798 displayed during the last redisplay cycle. */
12799 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12800 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12803 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12805 /* Don't consider glyphs that are outside TEXT_AREA. */
12806 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12808 /* Keep the candidate whose buffer position is the closest to
12810 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12811 w
->cursor
.hpos
>= 0
12812 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12813 && BUFFERP (g1
->object
)
12814 && (g1
->charpos
== pt_old
/* an exact match always wins */
12815 || (BUFFERP (glyph
->object
)
12816 && eabs (g1
->charpos
- pt_old
)
12817 < eabs (glyph
->charpos
- pt_old
))))
12819 /* If this candidate gives an exact match, use that. */
12820 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12821 /* Otherwise, keep the candidate that comes from a row
12822 spanning less buffer positions. This may win when one or
12823 both candidate positions are on glyphs that came from
12824 display strings, for which we cannot compare buffer
12826 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12827 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12828 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12831 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12833 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12834 w
->cursor
.y
= row
->y
+ dy
;
12836 if (w
== XWINDOW (selected_window
))
12838 if (!row
->continued_p
12839 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12842 this_line_buffer
= XBUFFER (w
->buffer
);
12844 CHARPOS (this_line_start_pos
)
12845 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12846 BYTEPOS (this_line_start_pos
)
12847 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12849 CHARPOS (this_line_end_pos
)
12850 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12851 BYTEPOS (this_line_end_pos
)
12852 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12854 this_line_y
= w
->cursor
.y
;
12855 this_line_pixel_height
= row
->height
;
12856 this_line_vpos
= w
->cursor
.vpos
;
12857 this_line_start_x
= row
->x
;
12860 CHARPOS (this_line_start_pos
) = 0;
12867 /* Run window scroll functions, if any, for WINDOW with new window
12868 start STARTP. Sets the window start of WINDOW to that position.
12870 We assume that the window's buffer is really current. */
12872 static INLINE
struct text_pos
12873 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12875 struct window
*w
= XWINDOW (window
);
12876 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12878 if (current_buffer
!= XBUFFER (w
->buffer
))
12881 if (!NILP (Vwindow_scroll_functions
))
12883 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12884 make_number (CHARPOS (startp
)));
12885 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12886 /* In case the hook functions switch buffers. */
12887 if (current_buffer
!= XBUFFER (w
->buffer
))
12888 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12895 /* Make sure the line containing the cursor is fully visible.
12896 A value of 1 means there is nothing to be done.
12897 (Either the line is fully visible, or it cannot be made so,
12898 or we cannot tell.)
12900 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12901 is higher than window.
12903 A value of 0 means the caller should do scrolling
12904 as if point had gone off the screen. */
12907 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12909 struct glyph_matrix
*matrix
;
12910 struct glyph_row
*row
;
12913 if (!make_cursor_line_fully_visible_p
)
12916 /* It's not always possible to find the cursor, e.g, when a window
12917 is full of overlay strings. Don't do anything in that case. */
12918 if (w
->cursor
.vpos
< 0)
12921 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12922 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12924 /* If the cursor row is not partially visible, there's nothing to do. */
12925 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12928 /* If the row the cursor is in is taller than the window's height,
12929 it's not clear what to do, so do nothing. */
12930 window_height
= window_box_height (w
);
12931 if (row
->height
>= window_height
)
12933 if (!force_p
|| MINI_WINDOW_P (w
)
12934 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12941 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12942 non-zero means only WINDOW is redisplayed in redisplay_internal.
12943 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12944 in redisplay_window to bring a partially visible line into view in
12945 the case that only the cursor has moved.
12947 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12948 last screen line's vertical height extends past the end of the screen.
12952 1 if scrolling succeeded
12954 0 if scrolling didn't find point.
12956 -1 if new fonts have been loaded so that we must interrupt
12957 redisplay, adjust glyph matrices, and try again. */
12963 SCROLLING_NEED_LARGER_MATRICES
12967 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12968 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12969 int temp_scroll_step
, int last_line_misfit
)
12971 struct window
*w
= XWINDOW (window
);
12972 struct frame
*f
= XFRAME (w
->frame
);
12973 struct text_pos pos
, startp
;
12975 int this_scroll_margin
, scroll_max
, rc
, height
;
12976 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12977 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12978 Lisp_Object aggressive
;
12979 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12982 debug_method_add (w
, "try_scrolling");
12985 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12987 /* Compute scroll margin height in pixels. We scroll when point is
12988 within this distance from the top or bottom of the window. */
12989 if (scroll_margin
> 0)
12990 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12991 * FRAME_LINE_HEIGHT (f
);
12993 this_scroll_margin
= 0;
12995 /* Force arg_scroll_conservatively to have a reasonable value, to avoid
12996 overflow while computing how much to scroll. Note that the user
12997 can supply scroll-conservatively equal to `most-positive-fixnum',
12998 which can be larger than INT_MAX. */
12999 if (arg_scroll_conservatively
> scroll_limit
)
13001 arg_scroll_conservatively
= scroll_limit
;
13002 scroll_max
= INT_MAX
;
13004 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13005 /* Compute how much we should try to scroll maximally to bring
13006 point into view. */
13007 scroll_max
= (max (scroll_step
,
13008 max (arg_scroll_conservatively
, temp_scroll_step
))
13009 * FRAME_LINE_HEIGHT (f
));
13010 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13011 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13012 /* We're trying to scroll because of aggressive scrolling but no
13013 scroll_step is set. Choose an arbitrary one. */
13014 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13020 /* Decide whether to scroll down. */
13021 if (PT
> CHARPOS (startp
))
13023 int scroll_margin_y
;
13025 /* Compute the pixel ypos of the scroll margin, then move it to
13026 either that ypos or PT, whichever comes first. */
13027 start_display (&it
, w
, startp
);
13028 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13029 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13030 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13031 (MOVE_TO_POS
| MOVE_TO_Y
));
13033 if (PT
> CHARPOS (it
.current
.pos
))
13035 int y0
= line_bottom_y (&it
);
13036 /* Compute how many pixels below window bottom to stop searching
13037 for PT. This avoids costly search for PT that is far away if
13038 the user limited scrolling by a small number of lines, but
13039 always finds PT if arg_scroll_conservatively is set to a large
13040 number, such as most-positive-fixnum. */
13041 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13043 slack
>= INT_MAX
- it
.last_visible_y
13045 : it
.last_visible_y
+ slack
;
13047 /* Compute the distance from the scroll margin to PT or to
13048 the scroll limit, whichever comes first. This should
13049 include the height of the cursor line, to make that line
13051 move_it_to (&it
, PT
, -1, y_to_move
,
13052 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13053 dy
= line_bottom_y (&it
) - y0
;
13055 if (dy
> scroll_max
)
13056 return SCROLLING_FAILED
;
13064 /* Point is in or below the bottom scroll margin, so move the
13065 window start down. If scrolling conservatively, move it just
13066 enough down to make point visible. If scroll_step is set,
13067 move it down by scroll_step. */
13068 if (arg_scroll_conservatively
)
13070 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13071 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13072 else if (scroll_step
|| temp_scroll_step
)
13073 amount_to_scroll
= scroll_max
;
13076 aggressive
= current_buffer
->scroll_up_aggressively
;
13077 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13078 if (NUMBERP (aggressive
))
13080 double float_amount
= XFLOATINT (aggressive
) * height
;
13081 amount_to_scroll
= float_amount
;
13082 if (amount_to_scroll
== 0 && float_amount
> 0)
13083 amount_to_scroll
= 1;
13087 if (amount_to_scroll
<= 0)
13088 return SCROLLING_FAILED
;
13090 start_display (&it
, w
, startp
);
13091 if (scroll_max
< INT_MAX
)
13092 move_it_vertically (&it
, amount_to_scroll
);
13095 /* Extra precision for users who set scroll-conservatively
13096 to most-positive-fixnum: make sure the amount we scroll
13097 the window start is never less than amount_to_scroll,
13098 which was computed as distance from window bottom to
13099 point. This matters when lines at window top and lines
13100 below window bottom have different height. */
13101 struct it it1
= it
;
13102 /* We use a temporary it1 because line_bottom_y can modify
13103 its argument, if it moves one line down; see there. */
13104 int start_y
= line_bottom_y (&it1
);
13107 move_it_by_lines (&it
, 1, 1);
13109 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13112 /* If STARTP is unchanged, move it down another screen line. */
13113 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13114 move_it_by_lines (&it
, 1, 1);
13115 startp
= it
.current
.pos
;
13119 struct text_pos scroll_margin_pos
= startp
;
13121 /* See if point is inside the scroll margin at the top of the
13123 if (this_scroll_margin
)
13125 start_display (&it
, w
, startp
);
13126 move_it_vertically (&it
, this_scroll_margin
);
13127 scroll_margin_pos
= it
.current
.pos
;
13130 if (PT
< CHARPOS (scroll_margin_pos
))
13132 /* Point is in the scroll margin at the top of the window or
13133 above what is displayed in the window. */
13136 /* Compute the vertical distance from PT to the scroll
13137 margin position. Give up if distance is greater than
13139 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13140 start_display (&it
, w
, pos
);
13142 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13143 it
.last_visible_y
, -1,
13144 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13145 dy
= it
.current_y
- y0
;
13146 if (dy
> scroll_max
)
13147 return SCROLLING_FAILED
;
13149 /* Compute new window start. */
13150 start_display (&it
, w
, startp
);
13152 if (arg_scroll_conservatively
)
13154 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13155 else if (scroll_step
|| temp_scroll_step
)
13156 amount_to_scroll
= scroll_max
;
13159 aggressive
= current_buffer
->scroll_down_aggressively
;
13160 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13161 if (NUMBERP (aggressive
))
13163 double float_amount
= XFLOATINT (aggressive
) * height
;
13164 amount_to_scroll
= float_amount
;
13165 if (amount_to_scroll
== 0 && float_amount
> 0)
13166 amount_to_scroll
= 1;
13170 if (amount_to_scroll
<= 0)
13171 return SCROLLING_FAILED
;
13173 move_it_vertically_backward (&it
, amount_to_scroll
);
13174 startp
= it
.current
.pos
;
13178 /* Run window scroll functions. */
13179 startp
= run_window_scroll_functions (window
, startp
);
13181 /* Display the window. Give up if new fonts are loaded, or if point
13183 if (!try_window (window
, startp
, 0))
13184 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13185 else if (w
->cursor
.vpos
< 0)
13187 clear_glyph_matrix (w
->desired_matrix
);
13188 rc
= SCROLLING_FAILED
;
13192 /* Maybe forget recorded base line for line number display. */
13193 if (!just_this_one_p
13194 || current_buffer
->clip_changed
13195 || BEG_UNCHANGED
< CHARPOS (startp
))
13196 w
->base_line_number
= Qnil
;
13198 /* If cursor ends up on a partially visible line,
13199 treat that as being off the bottom of the screen. */
13200 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13201 /* It's possible that the cursor is on the first line of the
13202 buffer, which is partially obscured due to a vscroll
13203 (Bug#7537). In that case, avoid looping forever . */
13204 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13206 clear_glyph_matrix (w
->desired_matrix
);
13207 ++extra_scroll_margin_lines
;
13210 rc
= SCROLLING_SUCCESS
;
13217 /* Compute a suitable window start for window W if display of W starts
13218 on a continuation line. Value is non-zero if a new window start
13221 The new window start will be computed, based on W's width, starting
13222 from the start of the continued line. It is the start of the
13223 screen line with the minimum distance from the old start W->start. */
13226 compute_window_start_on_continuation_line (struct window
*w
)
13228 struct text_pos pos
, start_pos
;
13229 int window_start_changed_p
= 0;
13231 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13233 /* If window start is on a continuation line... Window start may be
13234 < BEGV in case there's invisible text at the start of the
13235 buffer (M-x rmail, for example). */
13236 if (CHARPOS (start_pos
) > BEGV
13237 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13240 struct glyph_row
*row
;
13242 /* Handle the case that the window start is out of range. */
13243 if (CHARPOS (start_pos
) < BEGV
)
13244 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13245 else if (CHARPOS (start_pos
) > ZV
)
13246 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13248 /* Find the start of the continued line. This should be fast
13249 because scan_buffer is fast (newline cache). */
13250 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13251 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13252 row
, DEFAULT_FACE_ID
);
13253 reseat_at_previous_visible_line_start (&it
);
13255 /* If the line start is "too far" away from the window start,
13256 say it takes too much time to compute a new window start. */
13257 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13258 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13260 int min_distance
, distance
;
13262 /* Move forward by display lines to find the new window
13263 start. If window width was enlarged, the new start can
13264 be expected to be > the old start. If window width was
13265 decreased, the new window start will be < the old start.
13266 So, we're looking for the display line start with the
13267 minimum distance from the old window start. */
13268 pos
= it
.current
.pos
;
13269 min_distance
= INFINITY
;
13270 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13271 distance
< min_distance
)
13273 min_distance
= distance
;
13274 pos
= it
.current
.pos
;
13275 move_it_by_lines (&it
, 1, 0);
13278 /* Set the window start there. */
13279 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13280 window_start_changed_p
= 1;
13284 return window_start_changed_p
;
13288 /* Try cursor movement in case text has not changed in window WINDOW,
13289 with window start STARTP. Value is
13291 CURSOR_MOVEMENT_SUCCESS if successful
13293 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13295 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13296 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13297 we want to scroll as if scroll-step were set to 1. See the code.
13299 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13300 which case we have to abort this redisplay, and adjust matrices
13305 CURSOR_MOVEMENT_SUCCESS
,
13306 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13307 CURSOR_MOVEMENT_MUST_SCROLL
,
13308 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13312 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13314 struct window
*w
= XWINDOW (window
);
13315 struct frame
*f
= XFRAME (w
->frame
);
13316 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13319 if (inhibit_try_cursor_movement
)
13323 /* Handle case where text has not changed, only point, and it has
13324 not moved off the frame. */
13325 if (/* Point may be in this window. */
13326 PT
>= CHARPOS (startp
)
13327 /* Selective display hasn't changed. */
13328 && !current_buffer
->clip_changed
13329 /* Function force-mode-line-update is used to force a thorough
13330 redisplay. It sets either windows_or_buffers_changed or
13331 update_mode_lines. So don't take a shortcut here for these
13333 && !update_mode_lines
13334 && !windows_or_buffers_changed
13335 && !cursor_type_changed
13336 /* Can't use this case if highlighting a region. When a
13337 region exists, cursor movement has to do more than just
13339 && !(!NILP (Vtransient_mark_mode
)
13340 && !NILP (current_buffer
->mark_active
))
13341 && NILP (w
->region_showing
)
13342 && NILP (Vshow_trailing_whitespace
)
13343 /* Right after splitting windows, last_point may be nil. */
13344 && INTEGERP (w
->last_point
)
13345 /* This code is not used for mini-buffer for the sake of the case
13346 of redisplaying to replace an echo area message; since in
13347 that case the mini-buffer contents per se are usually
13348 unchanged. This code is of no real use in the mini-buffer
13349 since the handling of this_line_start_pos, etc., in redisplay
13350 handles the same cases. */
13351 && !EQ (window
, minibuf_window
)
13352 /* When splitting windows or for new windows, it happens that
13353 redisplay is called with a nil window_end_vpos or one being
13354 larger than the window. This should really be fixed in
13355 window.c. I don't have this on my list, now, so we do
13356 approximately the same as the old redisplay code. --gerd. */
13357 && INTEGERP (w
->window_end_vpos
)
13358 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13359 && (FRAME_WINDOW_P (f
)
13360 || !overlay_arrow_in_current_buffer_p ()))
13362 int this_scroll_margin
, top_scroll_margin
;
13363 struct glyph_row
*row
= NULL
;
13366 debug_method_add (w
, "cursor movement");
13369 /* Scroll if point within this distance from the top or bottom
13370 of the window. This is a pixel value. */
13371 if (scroll_margin
> 0)
13373 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13374 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13377 this_scroll_margin
= 0;
13379 top_scroll_margin
= this_scroll_margin
;
13380 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13381 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13383 /* Start with the row the cursor was displayed during the last
13384 not paused redisplay. Give up if that row is not valid. */
13385 if (w
->last_cursor
.vpos
< 0
13386 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13387 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13390 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13391 if (row
->mode_line_p
)
13393 if (!row
->enabled_p
)
13394 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13397 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13399 int scroll_p
= 0, must_scroll
= 0;
13400 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13402 if (PT
> XFASTINT (w
->last_point
))
13404 /* Point has moved forward. */
13405 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13406 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13408 xassert (row
->enabled_p
);
13412 /* If the end position of a row equals the start
13413 position of the next row, and PT is at that position,
13414 we would rather display cursor in the next line. */
13415 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13416 && MATRIX_ROW_END_CHARPOS (row
) == PT
13417 && row
< w
->current_matrix
->rows
13418 + w
->current_matrix
->nrows
- 1
13419 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13420 && !cursor_row_p (w
, row
))
13423 /* If within the scroll margin, scroll. Note that
13424 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13425 the next line would be drawn, and that
13426 this_scroll_margin can be zero. */
13427 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13428 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13429 /* Line is completely visible last line in window
13430 and PT is to be set in the next line. */
13431 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13432 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13433 && !row
->ends_at_zv_p
13434 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13437 else if (PT
< XFASTINT (w
->last_point
))
13439 /* Cursor has to be moved backward. Note that PT >=
13440 CHARPOS (startp) because of the outer if-statement. */
13441 while (!row
->mode_line_p
13442 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13443 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13444 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13445 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13446 row
> w
->current_matrix
->rows
13447 && (row
-1)->ends_in_newline_from_string_p
))))
13448 && (row
->y
> top_scroll_margin
13449 || CHARPOS (startp
) == BEGV
))
13451 xassert (row
->enabled_p
);
13455 /* Consider the following case: Window starts at BEGV,
13456 there is invisible, intangible text at BEGV, so that
13457 display starts at some point START > BEGV. It can
13458 happen that we are called with PT somewhere between
13459 BEGV and START. Try to handle that case. */
13460 if (row
< w
->current_matrix
->rows
13461 || row
->mode_line_p
)
13463 row
= w
->current_matrix
->rows
;
13464 if (row
->mode_line_p
)
13468 /* Due to newlines in overlay strings, we may have to
13469 skip forward over overlay strings. */
13470 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13471 && MATRIX_ROW_END_CHARPOS (row
) == PT
13472 && !cursor_row_p (w
, row
))
13475 /* If within the scroll margin, scroll. */
13476 if (row
->y
< top_scroll_margin
13477 && CHARPOS (startp
) != BEGV
)
13482 /* Cursor did not move. So don't scroll even if cursor line
13483 is partially visible, as it was so before. */
13484 rc
= CURSOR_MOVEMENT_SUCCESS
;
13487 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13488 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13490 /* if PT is not in the glyph row, give up. */
13491 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13494 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13495 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13497 /* If rows are bidi-reordered and point moved, back up
13498 until we find a row that does not belong to a
13499 continuation line. This is because we must consider
13500 all rows of a continued line as candidates for the
13501 new cursor positioning, since row start and end
13502 positions change non-linearly with vertical position
13504 /* FIXME: Revisit this when glyph ``spilling'' in
13505 continuation lines' rows is implemented for
13506 bidi-reordered rows. */
13507 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13509 xassert (row
->enabled_p
);
13511 /* If we hit the beginning of the displayed portion
13512 without finding the first row of a continued
13514 if (row
<= w
->current_matrix
->rows
)
13516 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13524 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13525 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13526 && make_cursor_line_fully_visible_p
)
13528 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13529 && !row
->ends_at_zv_p
13530 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13531 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13532 else if (row
->height
> window_box_height (w
))
13534 /* If we end up in a partially visible line, let's
13535 make it fully visible, except when it's taller
13536 than the window, in which case we can't do much
13539 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13543 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13544 if (!cursor_row_fully_visible_p (w
, 0, 1))
13545 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13547 rc
= CURSOR_MOVEMENT_SUCCESS
;
13551 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13552 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13553 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13555 /* With bidi-reordered rows, there could be more than
13556 one candidate row whose start and end positions
13557 occlude point. We need to let set_cursor_from_row
13558 find the best candidate. */
13559 /* FIXME: Revisit this when glyph ``spilling'' in
13560 continuation lines' rows is implemented for
13561 bidi-reordered rows. */
13566 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13567 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13568 && cursor_row_p (w
, row
))
13569 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13571 /* As soon as we've found the first suitable row
13572 whose ends_at_zv_p flag is set, we are done. */
13574 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13576 rc
= CURSOR_MOVEMENT_SUCCESS
;
13581 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13582 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13583 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13584 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13585 /* If we didn't find any candidate rows, or exited the
13586 loop before all the candidates were examined, signal
13587 to the caller that this method failed. */
13588 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13589 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13590 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13592 rc
= CURSOR_MOVEMENT_SUCCESS
;
13598 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13600 rc
= CURSOR_MOVEMENT_SUCCESS
;
13605 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13606 && MATRIX_ROW_START_CHARPOS (row
) == PT
13607 && cursor_row_p (w
, row
));
13616 set_vertical_scroll_bar (struct window
*w
)
13618 EMACS_INT start
, end
, whole
;
13620 /* Calculate the start and end positions for the current window.
13621 At some point, it would be nice to choose between scrollbars
13622 which reflect the whole buffer size, with special markers
13623 indicating narrowing, and scrollbars which reflect only the
13626 Note that mini-buffers sometimes aren't displaying any text. */
13627 if (!MINI_WINDOW_P (w
)
13628 || (w
== XWINDOW (minibuf_window
)
13629 && NILP (echo_area_buffer
[0])))
13631 struct buffer
*buf
= XBUFFER (w
->buffer
);
13632 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13633 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13634 /* I don't think this is guaranteed to be right. For the
13635 moment, we'll pretend it is. */
13636 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13640 if (whole
< (end
- start
))
13641 whole
= end
- start
;
13644 start
= end
= whole
= 0;
13646 /* Indicate what this scroll bar ought to be displaying now. */
13647 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13648 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13649 (w
, end
- start
, whole
, start
);
13653 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13654 selected_window is redisplayed.
13656 We can return without actually redisplaying the window if
13657 fonts_changed_p is nonzero. In that case, redisplay_internal will
13661 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13663 struct window
*w
= XWINDOW (window
);
13664 struct frame
*f
= XFRAME (w
->frame
);
13665 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13666 struct buffer
*old
= current_buffer
;
13667 struct text_pos lpoint
, opoint
, startp
;
13668 int update_mode_line
;
13671 /* Record it now because it's overwritten. */
13672 int current_matrix_up_to_date_p
= 0;
13673 int used_current_matrix_p
= 0;
13674 /* This is less strict than current_matrix_up_to_date_p.
13675 It indictes that the buffer contents and narrowing are unchanged. */
13676 int buffer_unchanged_p
= 0;
13677 int temp_scroll_step
= 0;
13678 int count
= SPECPDL_INDEX ();
13680 int centering_position
= -1;
13681 int last_line_misfit
= 0;
13682 EMACS_INT beg_unchanged
, end_unchanged
;
13684 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13687 /* W must be a leaf window here. */
13688 xassert (!NILP (w
->buffer
));
13690 *w
->desired_matrix
->method
= 0;
13694 reconsider_clip_changes (w
, buffer
);
13696 /* Has the mode line to be updated? */
13697 update_mode_line
= (!NILP (w
->update_mode_line
)
13698 || update_mode_lines
13699 || buffer
->clip_changed
13700 || buffer
->prevent_redisplay_optimizations_p
);
13702 if (MINI_WINDOW_P (w
))
13704 if (w
== XWINDOW (echo_area_window
)
13705 && !NILP (echo_area_buffer
[0]))
13707 if (update_mode_line
)
13708 /* We may have to update a tty frame's menu bar or a
13709 tool-bar. Example `M-x C-h C-h C-g'. */
13710 goto finish_menu_bars
;
13712 /* We've already displayed the echo area glyphs in this window. */
13713 goto finish_scroll_bars
;
13715 else if ((w
!= XWINDOW (minibuf_window
)
13716 || minibuf_level
== 0)
13717 /* When buffer is nonempty, redisplay window normally. */
13718 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13719 /* Quail displays non-mini buffers in minibuffer window.
13720 In that case, redisplay the window normally. */
13721 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13723 /* W is a mini-buffer window, but it's not active, so clear
13725 int yb
= window_text_bottom_y (w
);
13726 struct glyph_row
*row
;
13729 for (y
= 0, row
= w
->desired_matrix
->rows
;
13731 y
+= row
->height
, ++row
)
13732 blank_row (w
, row
, y
);
13733 goto finish_scroll_bars
;
13736 clear_glyph_matrix (w
->desired_matrix
);
13739 /* Otherwise set up data on this window; select its buffer and point
13741 /* Really select the buffer, for the sake of buffer-local
13743 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13745 current_matrix_up_to_date_p
13746 = (!NILP (w
->window_end_valid
)
13747 && !current_buffer
->clip_changed
13748 && !current_buffer
->prevent_redisplay_optimizations_p
13749 && XFASTINT (w
->last_modified
) >= MODIFF
13750 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13752 /* Run the window-bottom-change-functions
13753 if it is possible that the text on the screen has changed
13754 (either due to modification of the text, or any other reason). */
13755 if (!current_matrix_up_to_date_p
13756 && !NILP (Vwindow_text_change_functions
))
13758 safe_run_hooks (Qwindow_text_change_functions
);
13762 beg_unchanged
= BEG_UNCHANGED
;
13763 end_unchanged
= END_UNCHANGED
;
13765 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13767 specbind (Qinhibit_point_motion_hooks
, Qt
);
13770 = (!NILP (w
->window_end_valid
)
13771 && !current_buffer
->clip_changed
13772 && XFASTINT (w
->last_modified
) >= MODIFF
13773 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13775 /* When windows_or_buffers_changed is non-zero, we can't rely on
13776 the window end being valid, so set it to nil there. */
13777 if (windows_or_buffers_changed
)
13779 /* If window starts on a continuation line, maybe adjust the
13780 window start in case the window's width changed. */
13781 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13782 compute_window_start_on_continuation_line (w
);
13784 w
->window_end_valid
= Qnil
;
13787 /* Some sanity checks. */
13788 CHECK_WINDOW_END (w
);
13789 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13791 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13794 /* If %c is in mode line, update it if needed. */
13795 if (!NILP (w
->column_number_displayed
)
13796 /* This alternative quickly identifies a common case
13797 where no change is needed. */
13798 && !(PT
== XFASTINT (w
->last_point
)
13799 && XFASTINT (w
->last_modified
) >= MODIFF
13800 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13801 && (XFASTINT (w
->column_number_displayed
)
13802 != (int) current_column ())) /* iftc */
13803 update_mode_line
= 1;
13805 /* Count number of windows showing the selected buffer. An indirect
13806 buffer counts as its base buffer. */
13807 if (!just_this_one_p
)
13809 struct buffer
*current_base
, *window_base
;
13810 current_base
= current_buffer
;
13811 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13812 if (current_base
->base_buffer
)
13813 current_base
= current_base
->base_buffer
;
13814 if (window_base
->base_buffer
)
13815 window_base
= window_base
->base_buffer
;
13816 if (current_base
== window_base
)
13820 /* Point refers normally to the selected window. For any other
13821 window, set up appropriate value. */
13822 if (!EQ (window
, selected_window
))
13824 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13825 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13829 new_pt_byte
= BEGV_BYTE
;
13830 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13832 else if (new_pt
> (ZV
- 1))
13835 new_pt_byte
= ZV_BYTE
;
13836 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13839 /* We don't use SET_PT so that the point-motion hooks don't run. */
13840 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13843 /* If any of the character widths specified in the display table
13844 have changed, invalidate the width run cache. It's true that
13845 this may be a bit late to catch such changes, but the rest of
13846 redisplay goes (non-fatally) haywire when the display table is
13847 changed, so why should we worry about doing any better? */
13848 if (current_buffer
->width_run_cache
)
13850 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13852 if (! disptab_matches_widthtab (disptab
,
13853 XVECTOR (current_buffer
->width_table
)))
13855 invalidate_region_cache (current_buffer
,
13856 current_buffer
->width_run_cache
,
13858 recompute_width_table (current_buffer
, disptab
);
13862 /* If window-start is screwed up, choose a new one. */
13863 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13866 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13868 /* If someone specified a new starting point but did not insist,
13869 check whether it can be used. */
13870 if (!NILP (w
->optional_new_start
)
13871 && CHARPOS (startp
) >= BEGV
13872 && CHARPOS (startp
) <= ZV
)
13874 w
->optional_new_start
= Qnil
;
13875 start_display (&it
, w
, startp
);
13876 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13877 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13878 if (IT_CHARPOS (it
) == PT
)
13879 w
->force_start
= Qt
;
13880 /* IT may overshoot PT if text at PT is invisible. */
13881 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13882 w
->force_start
= Qt
;
13887 /* Handle case where place to start displaying has been specified,
13888 unless the specified location is outside the accessible range. */
13889 if (!NILP (w
->force_start
)
13890 || w
->frozen_window_start_p
)
13892 /* We set this later on if we have to adjust point. */
13895 w
->force_start
= Qnil
;
13897 w
->window_end_valid
= Qnil
;
13899 /* Forget any recorded base line for line number display. */
13900 if (!buffer_unchanged_p
)
13901 w
->base_line_number
= Qnil
;
13903 /* Redisplay the mode line. Select the buffer properly for that.
13904 Also, run the hook window-scroll-functions
13905 because we have scrolled. */
13906 /* Note, we do this after clearing force_start because
13907 if there's an error, it is better to forget about force_start
13908 than to get into an infinite loop calling the hook functions
13909 and having them get more errors. */
13910 if (!update_mode_line
13911 || ! NILP (Vwindow_scroll_functions
))
13913 update_mode_line
= 1;
13914 w
->update_mode_line
= Qt
;
13915 startp
= run_window_scroll_functions (window
, startp
);
13918 w
->last_modified
= make_number (0);
13919 w
->last_overlay_modified
= make_number (0);
13920 if (CHARPOS (startp
) < BEGV
)
13921 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13922 else if (CHARPOS (startp
) > ZV
)
13923 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13925 /* Redisplay, then check if cursor has been set during the
13926 redisplay. Give up if new fonts were loaded. */
13927 /* We used to issue a CHECK_MARGINS argument to try_window here,
13928 but this causes scrolling to fail when point begins inside
13929 the scroll margin (bug#148) -- cyd */
13930 if (!try_window (window
, startp
, 0))
13932 w
->force_start
= Qt
;
13933 clear_glyph_matrix (w
->desired_matrix
);
13934 goto need_larger_matrices
;
13937 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13939 /* If point does not appear, try to move point so it does
13940 appear. The desired matrix has been built above, so we
13941 can use it here. */
13942 new_vpos
= window_box_height (w
) / 2;
13945 if (!cursor_row_fully_visible_p (w
, 0, 0))
13947 /* Point does appear, but on a line partly visible at end of window.
13948 Move it back to a fully-visible line. */
13949 new_vpos
= window_box_height (w
);
13952 /* If we need to move point for either of the above reasons,
13953 now actually do it. */
13956 struct glyph_row
*row
;
13958 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13959 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13962 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13963 MATRIX_ROW_START_BYTEPOS (row
));
13965 if (w
!= XWINDOW (selected_window
))
13966 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13967 else if (current_buffer
== old
)
13968 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13970 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13972 /* If we are highlighting the region, then we just changed
13973 the region, so redisplay to show it. */
13974 if (!NILP (Vtransient_mark_mode
)
13975 && !NILP (current_buffer
->mark_active
))
13977 clear_glyph_matrix (w
->desired_matrix
);
13978 if (!try_window (window
, startp
, 0))
13979 goto need_larger_matrices
;
13984 debug_method_add (w
, "forced window start");
13989 /* Handle case where text has not changed, only point, and it has
13990 not moved off the frame, and we are not retrying after hscroll.
13991 (current_matrix_up_to_date_p is nonzero when retrying.) */
13992 if (current_matrix_up_to_date_p
13993 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13994 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13998 case CURSOR_MOVEMENT_SUCCESS
:
13999 used_current_matrix_p
= 1;
14002 case CURSOR_MOVEMENT_MUST_SCROLL
:
14003 goto try_to_scroll
;
14009 /* If current starting point was originally the beginning of a line
14010 but no longer is, find a new starting point. */
14011 else if (!NILP (w
->start_at_line_beg
)
14012 && !(CHARPOS (startp
) <= BEGV
14013 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14016 debug_method_add (w
, "recenter 1");
14021 /* Try scrolling with try_window_id. Value is > 0 if update has
14022 been done, it is -1 if we know that the same window start will
14023 not work. It is 0 if unsuccessful for some other reason. */
14024 else if ((tem
= try_window_id (w
)) != 0)
14027 debug_method_add (w
, "try_window_id %d", tem
);
14030 if (fonts_changed_p
)
14031 goto need_larger_matrices
;
14035 /* Otherwise try_window_id has returned -1 which means that we
14036 don't want the alternative below this comment to execute. */
14038 else if (CHARPOS (startp
) >= BEGV
14039 && CHARPOS (startp
) <= ZV
14040 && PT
>= CHARPOS (startp
)
14041 && (CHARPOS (startp
) < ZV
14042 /* Avoid starting at end of buffer. */
14043 || CHARPOS (startp
) == BEGV
14044 || (XFASTINT (w
->last_modified
) >= MODIFF
14045 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14048 /* If first window line is a continuation line, and window start
14049 is inside the modified region, but the first change is before
14050 current window start, we must select a new window start.
14052 However, if this is the result of a down-mouse event (e.g. by
14053 extending the mouse-drag-overlay), we don't want to select a
14054 new window start, since that would change the position under
14055 the mouse, resulting in an unwanted mouse-movement rather
14056 than a simple mouse-click. */
14057 if (NILP (w
->start_at_line_beg
)
14058 && NILP (do_mouse_tracking
)
14059 && CHARPOS (startp
) > BEGV
14060 && CHARPOS (startp
) > BEG
+ beg_unchanged
14061 && CHARPOS (startp
) <= Z
- end_unchanged
14062 /* Even if w->start_at_line_beg is nil, a new window may
14063 start at a line_beg, since that's how set_buffer_window
14064 sets it. So, we need to check the return value of
14065 compute_window_start_on_continuation_line. (See also
14067 && XMARKER (w
->start
)->buffer
== current_buffer
14068 && compute_window_start_on_continuation_line (w
))
14070 w
->force_start
= Qt
;
14071 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14076 debug_method_add (w
, "same window start");
14079 /* Try to redisplay starting at same place as before.
14080 If point has not moved off frame, accept the results. */
14081 if (!current_matrix_up_to_date_p
14082 /* Don't use try_window_reusing_current_matrix in this case
14083 because a window scroll function can have changed the
14085 || !NILP (Vwindow_scroll_functions
)
14086 || MINI_WINDOW_P (w
)
14087 || !(used_current_matrix_p
14088 = try_window_reusing_current_matrix (w
)))
14090 IF_DEBUG (debug_method_add (w
, "1"));
14091 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14092 /* -1 means we need to scroll.
14093 0 means we need new matrices, but fonts_changed_p
14094 is set in that case, so we will detect it below. */
14095 goto try_to_scroll
;
14098 if (fonts_changed_p
)
14099 goto need_larger_matrices
;
14101 if (w
->cursor
.vpos
>= 0)
14103 if (!just_this_one_p
14104 || current_buffer
->clip_changed
14105 || BEG_UNCHANGED
< CHARPOS (startp
))
14106 /* Forget any recorded base line for line number display. */
14107 w
->base_line_number
= Qnil
;
14109 if (!cursor_row_fully_visible_p (w
, 1, 0))
14111 clear_glyph_matrix (w
->desired_matrix
);
14112 last_line_misfit
= 1;
14114 /* Drop through and scroll. */
14119 clear_glyph_matrix (w
->desired_matrix
);
14124 w
->last_modified
= make_number (0);
14125 w
->last_overlay_modified
= make_number (0);
14127 /* Redisplay the mode line. Select the buffer properly for that. */
14128 if (!update_mode_line
)
14130 update_mode_line
= 1;
14131 w
->update_mode_line
= Qt
;
14134 /* Try to scroll by specified few lines. */
14135 if ((scroll_conservatively
14136 || emacs_scroll_step
14137 || temp_scroll_step
14138 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14139 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14140 && !current_buffer
->clip_changed
14141 && CHARPOS (startp
) >= BEGV
14142 && CHARPOS (startp
) <= ZV
)
14144 /* The function returns -1 if new fonts were loaded, 1 if
14145 successful, 0 if not successful. */
14146 int rc
= try_scrolling (window
, just_this_one_p
,
14147 scroll_conservatively
,
14149 temp_scroll_step
, last_line_misfit
);
14152 case SCROLLING_SUCCESS
:
14155 case SCROLLING_NEED_LARGER_MATRICES
:
14156 goto need_larger_matrices
;
14158 case SCROLLING_FAILED
:
14166 /* Finally, just choose place to start which centers point */
14169 if (centering_position
< 0)
14170 centering_position
= window_box_height (w
) / 2;
14173 debug_method_add (w
, "recenter");
14176 /* w->vscroll = 0; */
14178 /* Forget any previously recorded base line for line number display. */
14179 if (!buffer_unchanged_p
)
14180 w
->base_line_number
= Qnil
;
14182 /* Move backward half the height of the window. */
14183 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14184 it
.current_y
= it
.last_visible_y
;
14185 move_it_vertically_backward (&it
, centering_position
);
14186 xassert (IT_CHARPOS (it
) >= BEGV
);
14188 /* The function move_it_vertically_backward may move over more
14189 than the specified y-distance. If it->w is small, e.g. a
14190 mini-buffer window, we may end up in front of the window's
14191 display area. Start displaying at the start of the line
14192 containing PT in this case. */
14193 if (it
.current_y
<= 0)
14195 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14196 move_it_vertically_backward (&it
, 0);
14200 it
.current_x
= it
.hpos
= 0;
14202 /* Set startp here explicitly in case that helps avoid an infinite loop
14203 in case the window-scroll-functions functions get errors. */
14204 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14206 /* Run scroll hooks. */
14207 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14209 /* Redisplay the window. */
14210 if (!current_matrix_up_to_date_p
14211 || windows_or_buffers_changed
14212 || cursor_type_changed
14213 /* Don't use try_window_reusing_current_matrix in this case
14214 because it can have changed the buffer. */
14215 || !NILP (Vwindow_scroll_functions
)
14216 || !just_this_one_p
14217 || MINI_WINDOW_P (w
)
14218 || !(used_current_matrix_p
14219 = try_window_reusing_current_matrix (w
)))
14220 try_window (window
, startp
, 0);
14222 /* If new fonts have been loaded (due to fontsets), give up. We
14223 have to start a new redisplay since we need to re-adjust glyph
14225 if (fonts_changed_p
)
14226 goto need_larger_matrices
;
14228 /* If cursor did not appear assume that the middle of the window is
14229 in the first line of the window. Do it again with the next line.
14230 (Imagine a window of height 100, displaying two lines of height
14231 60. Moving back 50 from it->last_visible_y will end in the first
14233 if (w
->cursor
.vpos
< 0)
14235 if (!NILP (w
->window_end_valid
)
14236 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14238 clear_glyph_matrix (w
->desired_matrix
);
14239 move_it_by_lines (&it
, 1, 0);
14240 try_window (window
, it
.current
.pos
, 0);
14242 else if (PT
< IT_CHARPOS (it
))
14244 clear_glyph_matrix (w
->desired_matrix
);
14245 move_it_by_lines (&it
, -1, 0);
14246 try_window (window
, it
.current
.pos
, 0);
14250 /* Not much we can do about it. */
14254 /* Consider the following case: Window starts at BEGV, there is
14255 invisible, intangible text at BEGV, so that display starts at
14256 some point START > BEGV. It can happen that we are called with
14257 PT somewhere between BEGV and START. Try to handle that case. */
14258 if (w
->cursor
.vpos
< 0)
14260 struct glyph_row
*row
= w
->current_matrix
->rows
;
14261 if (row
->mode_line_p
)
14263 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14266 if (!cursor_row_fully_visible_p (w
, 0, 0))
14268 /* If vscroll is enabled, disable it and try again. */
14272 clear_glyph_matrix (w
->desired_matrix
);
14276 /* If centering point failed to make the whole line visible,
14277 put point at the top instead. That has to make the whole line
14278 visible, if it can be done. */
14279 if (centering_position
== 0)
14282 clear_glyph_matrix (w
->desired_matrix
);
14283 centering_position
= 0;
14289 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14290 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14291 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14294 /* Display the mode line, if we must. */
14295 if ((update_mode_line
14296 /* If window not full width, must redo its mode line
14297 if (a) the window to its side is being redone and
14298 (b) we do a frame-based redisplay. This is a consequence
14299 of how inverted lines are drawn in frame-based redisplay. */
14300 || (!just_this_one_p
14301 && !FRAME_WINDOW_P (f
)
14302 && !WINDOW_FULL_WIDTH_P (w
))
14303 /* Line number to display. */
14304 || INTEGERP (w
->base_line_pos
)
14305 /* Column number is displayed and different from the one displayed. */
14306 || (!NILP (w
->column_number_displayed
)
14307 && (XFASTINT (w
->column_number_displayed
)
14308 != (int) current_column ()))) /* iftc */
14309 /* This means that the window has a mode line. */
14310 && (WINDOW_WANTS_MODELINE_P (w
)
14311 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14313 display_mode_lines (w
);
14315 /* If mode line height has changed, arrange for a thorough
14316 immediate redisplay using the correct mode line height. */
14317 if (WINDOW_WANTS_MODELINE_P (w
)
14318 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14320 fonts_changed_p
= 1;
14321 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14322 = DESIRED_MODE_LINE_HEIGHT (w
);
14325 /* If header line height has changed, arrange for a thorough
14326 immediate redisplay using the correct header line height. */
14327 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14328 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14330 fonts_changed_p
= 1;
14331 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14332 = DESIRED_HEADER_LINE_HEIGHT (w
);
14335 if (fonts_changed_p
)
14336 goto need_larger_matrices
;
14339 if (!line_number_displayed
14340 && !BUFFERP (w
->base_line_pos
))
14342 w
->base_line_pos
= Qnil
;
14343 w
->base_line_number
= Qnil
;
14348 /* When we reach a frame's selected window, redo the frame's menu bar. */
14349 if (update_mode_line
14350 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14352 int redisplay_menu_p
= 0;
14353 int redisplay_tool_bar_p
= 0;
14355 if (FRAME_WINDOW_P (f
))
14357 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14358 || defined (HAVE_NS) || defined (USE_GTK)
14359 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14361 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14365 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14367 if (redisplay_menu_p
)
14368 display_menu_bar (w
);
14370 #ifdef HAVE_WINDOW_SYSTEM
14371 if (FRAME_WINDOW_P (f
))
14373 #if defined (USE_GTK) || defined (HAVE_NS)
14374 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14376 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14377 && (FRAME_TOOL_BAR_LINES (f
) > 0
14378 || !NILP (Vauto_resize_tool_bars
));
14381 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14383 ignore_mouse_drag_p
= 1;
14389 #ifdef HAVE_WINDOW_SYSTEM
14390 if (FRAME_WINDOW_P (f
)
14391 && update_window_fringes (w
, (just_this_one_p
14392 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14393 || w
->pseudo_window_p
)))
14397 if (draw_window_fringes (w
, 1))
14398 x_draw_vertical_border (w
);
14402 #endif /* HAVE_WINDOW_SYSTEM */
14404 /* We go to this label, with fonts_changed_p nonzero,
14405 if it is necessary to try again using larger glyph matrices.
14406 We have to redeem the scroll bar even in this case,
14407 because the loop in redisplay_internal expects that. */
14408 need_larger_matrices
:
14410 finish_scroll_bars
:
14412 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14414 /* Set the thumb's position and size. */
14415 set_vertical_scroll_bar (w
);
14417 /* Note that we actually used the scroll bar attached to this
14418 window, so it shouldn't be deleted at the end of redisplay. */
14419 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14420 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14423 /* Restore current_buffer and value of point in it. The window
14424 update may have changed the buffer, so first make sure `opoint'
14425 is still valid (Bug#6177). */
14426 if (CHARPOS (opoint
) < BEGV
)
14427 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14428 else if (CHARPOS (opoint
) > ZV
)
14429 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14431 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14433 set_buffer_internal_1 (old
);
14434 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14435 shorter. This can be caused by log truncation in *Messages*. */
14436 if (CHARPOS (lpoint
) <= ZV
)
14437 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14439 unbind_to (count
, Qnil
);
14443 /* Build the complete desired matrix of WINDOW with a window start
14444 buffer position POS.
14446 Value is 1 if successful. It is zero if fonts were loaded during
14447 redisplay which makes re-adjusting glyph matrices necessary, and -1
14448 if point would appear in the scroll margins.
14449 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14450 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14454 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14456 struct window
*w
= XWINDOW (window
);
14458 struct glyph_row
*last_text_row
= NULL
;
14459 struct frame
*f
= XFRAME (w
->frame
);
14461 /* Make POS the new window start. */
14462 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14464 /* Mark cursor position as unknown. No overlay arrow seen. */
14465 w
->cursor
.vpos
= -1;
14466 overlay_arrow_seen
= 0;
14468 /* Initialize iterator and info to start at POS. */
14469 start_display (&it
, w
, pos
);
14471 /* Display all lines of W. */
14472 while (it
.current_y
< it
.last_visible_y
)
14474 if (display_line (&it
))
14475 last_text_row
= it
.glyph_row
- 1;
14476 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14480 /* Don't let the cursor end in the scroll margins. */
14481 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14482 && !MINI_WINDOW_P (w
))
14484 int this_scroll_margin
;
14486 if (scroll_margin
> 0)
14488 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14489 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14492 this_scroll_margin
= 0;
14494 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14495 && w
->cursor
.y
< this_scroll_margin
14496 && CHARPOS (pos
) > BEGV
14497 && IT_CHARPOS (it
) < ZV
)
14498 /* rms: considering make_cursor_line_fully_visible_p here
14499 seems to give wrong results. We don't want to recenter
14500 when the last line is partly visible, we want to allow
14501 that case to be handled in the usual way. */
14502 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14504 w
->cursor
.vpos
= -1;
14505 clear_glyph_matrix (w
->desired_matrix
);
14510 /* If bottom moved off end of frame, change mode line percentage. */
14511 if (XFASTINT (w
->window_end_pos
) <= 0
14512 && Z
!= IT_CHARPOS (it
))
14513 w
->update_mode_line
= Qt
;
14515 /* Set window_end_pos to the offset of the last character displayed
14516 on the window from the end of current_buffer. Set
14517 window_end_vpos to its row number. */
14520 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14521 w
->window_end_bytepos
14522 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14524 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14526 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14527 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14528 ->displays_text_p
);
14532 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14533 w
->window_end_pos
= make_number (Z
- ZV
);
14534 w
->window_end_vpos
= make_number (0);
14537 /* But that is not valid info until redisplay finishes. */
14538 w
->window_end_valid
= Qnil
;
14544 /************************************************************************
14545 Window redisplay reusing current matrix when buffer has not changed
14546 ************************************************************************/
14548 /* Try redisplay of window W showing an unchanged buffer with a
14549 different window start than the last time it was displayed by
14550 reusing its current matrix. Value is non-zero if successful.
14551 W->start is the new window start. */
14554 try_window_reusing_current_matrix (struct window
*w
)
14556 struct frame
*f
= XFRAME (w
->frame
);
14557 struct glyph_row
*row
, *bottom_row
;
14560 struct text_pos start
, new_start
;
14561 int nrows_scrolled
, i
;
14562 struct glyph_row
*last_text_row
;
14563 struct glyph_row
*last_reused_text_row
;
14564 struct glyph_row
*start_row
;
14565 int start_vpos
, min_y
, max_y
;
14568 if (inhibit_try_window_reusing
)
14572 if (/* This function doesn't handle terminal frames. */
14573 !FRAME_WINDOW_P (f
)
14574 /* Don't try to reuse the display if windows have been split
14576 || windows_or_buffers_changed
14577 || cursor_type_changed
)
14580 /* Can't do this if region may have changed. */
14581 if ((!NILP (Vtransient_mark_mode
)
14582 && !NILP (current_buffer
->mark_active
))
14583 || !NILP (w
->region_showing
)
14584 || !NILP (Vshow_trailing_whitespace
))
14587 /* If top-line visibility has changed, give up. */
14588 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14589 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14592 /* Give up if old or new display is scrolled vertically. We could
14593 make this function handle this, but right now it doesn't. */
14594 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14595 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14598 /* The variable new_start now holds the new window start. The old
14599 start `start' can be determined from the current matrix. */
14600 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14601 start
= start_row
->minpos
;
14602 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14604 /* Clear the desired matrix for the display below. */
14605 clear_glyph_matrix (w
->desired_matrix
);
14607 if (CHARPOS (new_start
) <= CHARPOS (start
))
14611 /* Don't use this method if the display starts with an ellipsis
14612 displayed for invisible text. It's not easy to handle that case
14613 below, and it's certainly not worth the effort since this is
14614 not a frequent case. */
14615 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14618 IF_DEBUG (debug_method_add (w
, "twu1"));
14620 /* Display up to a row that can be reused. The variable
14621 last_text_row is set to the last row displayed that displays
14622 text. Note that it.vpos == 0 if or if not there is a
14623 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14624 start_display (&it
, w
, new_start
);
14625 first_row_y
= it
.current_y
;
14626 w
->cursor
.vpos
= -1;
14627 last_text_row
= last_reused_text_row
= NULL
;
14629 while (it
.current_y
< it
.last_visible_y
14630 && !fonts_changed_p
)
14632 /* If we have reached into the characters in the START row,
14633 that means the line boundaries have changed. So we
14634 can't start copying with the row START. Maybe it will
14635 work to start copying with the following row. */
14636 while (IT_CHARPOS (it
) > CHARPOS (start
))
14638 /* Advance to the next row as the "start". */
14640 start
= start_row
->minpos
;
14641 /* If there are no more rows to try, or just one, give up. */
14642 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14643 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14644 || CHARPOS (start
) == ZV
)
14646 clear_glyph_matrix (w
->desired_matrix
);
14650 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14652 /* If we have reached alignment,
14653 we can copy the rest of the rows. */
14654 if (IT_CHARPOS (it
) == CHARPOS (start
))
14657 if (display_line (&it
))
14658 last_text_row
= it
.glyph_row
- 1;
14661 /* A value of current_y < last_visible_y means that we stopped
14662 at the previous window start, which in turn means that we
14663 have at least one reusable row. */
14664 if (it
.current_y
< it
.last_visible_y
)
14666 /* IT.vpos always starts from 0; it counts text lines. */
14667 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14669 /* Find PT if not already found in the lines displayed. */
14670 if (w
->cursor
.vpos
< 0)
14672 int dy
= it
.current_y
- start_row
->y
;
14674 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14675 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14677 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14678 dy
, nrows_scrolled
);
14681 clear_glyph_matrix (w
->desired_matrix
);
14686 /* Scroll the display. Do it before the current matrix is
14687 changed. The problem here is that update has not yet
14688 run, i.e. part of the current matrix is not up to date.
14689 scroll_run_hook will clear the cursor, and use the
14690 current matrix to get the height of the row the cursor is
14692 run
.current_y
= start_row
->y
;
14693 run
.desired_y
= it
.current_y
;
14694 run
.height
= it
.last_visible_y
- it
.current_y
;
14696 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14699 FRAME_RIF (f
)->update_window_begin_hook (w
);
14700 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14701 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14702 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14706 /* Shift current matrix down by nrows_scrolled lines. */
14707 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14708 rotate_matrix (w
->current_matrix
,
14710 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14713 /* Disable lines that must be updated. */
14714 for (i
= 0; i
< nrows_scrolled
; ++i
)
14715 (start_row
+ i
)->enabled_p
= 0;
14717 /* Re-compute Y positions. */
14718 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14719 max_y
= it
.last_visible_y
;
14720 for (row
= start_row
+ nrows_scrolled
;
14724 row
->y
= it
.current_y
;
14725 row
->visible_height
= row
->height
;
14727 if (row
->y
< min_y
)
14728 row
->visible_height
-= min_y
- row
->y
;
14729 if (row
->y
+ row
->height
> max_y
)
14730 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14731 row
->redraw_fringe_bitmaps_p
= 1;
14733 it
.current_y
+= row
->height
;
14735 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14736 last_reused_text_row
= row
;
14737 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14741 /* Disable lines in the current matrix which are now
14742 below the window. */
14743 for (++row
; row
< bottom_row
; ++row
)
14744 row
->enabled_p
= row
->mode_line_p
= 0;
14747 /* Update window_end_pos etc.; last_reused_text_row is the last
14748 reused row from the current matrix containing text, if any.
14749 The value of last_text_row is the last displayed line
14750 containing text. */
14751 if (last_reused_text_row
)
14753 w
->window_end_bytepos
14754 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14756 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14758 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14759 w
->current_matrix
));
14761 else if (last_text_row
)
14763 w
->window_end_bytepos
14764 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14766 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14768 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14772 /* This window must be completely empty. */
14773 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14774 w
->window_end_pos
= make_number (Z
- ZV
);
14775 w
->window_end_vpos
= make_number (0);
14777 w
->window_end_valid
= Qnil
;
14779 /* Update hint: don't try scrolling again in update_window. */
14780 w
->desired_matrix
->no_scrolling_p
= 1;
14783 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14787 else if (CHARPOS (new_start
) > CHARPOS (start
))
14789 struct glyph_row
*pt_row
, *row
;
14790 struct glyph_row
*first_reusable_row
;
14791 struct glyph_row
*first_row_to_display
;
14793 int yb
= window_text_bottom_y (w
);
14795 /* Find the row starting at new_start, if there is one. Don't
14796 reuse a partially visible line at the end. */
14797 first_reusable_row
= start_row
;
14798 while (first_reusable_row
->enabled_p
14799 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14800 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14801 < CHARPOS (new_start
)))
14802 ++first_reusable_row
;
14804 /* Give up if there is no row to reuse. */
14805 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14806 || !first_reusable_row
->enabled_p
14807 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14808 != CHARPOS (new_start
)))
14811 /* We can reuse fully visible rows beginning with
14812 first_reusable_row to the end of the window. Set
14813 first_row_to_display to the first row that cannot be reused.
14814 Set pt_row to the row containing point, if there is any. */
14816 for (first_row_to_display
= first_reusable_row
;
14817 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14818 ++first_row_to_display
)
14820 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14821 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14822 pt_row
= first_row_to_display
;
14825 /* Start displaying at the start of first_row_to_display. */
14826 xassert (first_row_to_display
->y
< yb
);
14827 init_to_row_start (&it
, w
, first_row_to_display
);
14829 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14831 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14833 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14834 + WINDOW_HEADER_LINE_HEIGHT (w
));
14836 /* Display lines beginning with first_row_to_display in the
14837 desired matrix. Set last_text_row to the last row displayed
14838 that displays text. */
14839 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14840 if (pt_row
== NULL
)
14841 w
->cursor
.vpos
= -1;
14842 last_text_row
= NULL
;
14843 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14844 if (display_line (&it
))
14845 last_text_row
= it
.glyph_row
- 1;
14847 /* If point is in a reused row, adjust y and vpos of the cursor
14851 w
->cursor
.vpos
-= nrows_scrolled
;
14852 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14855 /* Give up if point isn't in a row displayed or reused. (This
14856 also handles the case where w->cursor.vpos < nrows_scrolled
14857 after the calls to display_line, which can happen with scroll
14858 margins. See bug#1295.) */
14859 if (w
->cursor
.vpos
< 0)
14861 clear_glyph_matrix (w
->desired_matrix
);
14865 /* Scroll the display. */
14866 run
.current_y
= first_reusable_row
->y
;
14867 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14868 run
.height
= it
.last_visible_y
- run
.current_y
;
14869 dy
= run
.current_y
- run
.desired_y
;
14874 FRAME_RIF (f
)->update_window_begin_hook (w
);
14875 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14876 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14877 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14881 /* Adjust Y positions of reused rows. */
14882 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14883 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14884 max_y
= it
.last_visible_y
;
14885 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14888 row
->visible_height
= row
->height
;
14889 if (row
->y
< min_y
)
14890 row
->visible_height
-= min_y
- row
->y
;
14891 if (row
->y
+ row
->height
> max_y
)
14892 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14893 row
->redraw_fringe_bitmaps_p
= 1;
14896 /* Scroll the current matrix. */
14897 xassert (nrows_scrolled
> 0);
14898 rotate_matrix (w
->current_matrix
,
14900 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14903 /* Disable rows not reused. */
14904 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14905 row
->enabled_p
= 0;
14907 /* Point may have moved to a different line, so we cannot assume that
14908 the previous cursor position is valid; locate the correct row. */
14911 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14912 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14916 w
->cursor
.y
= row
->y
;
14918 if (row
< bottom_row
)
14920 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14921 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14923 /* Can't use this optimization with bidi-reordered glyph
14924 rows, unless cursor is already at point. */
14925 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
14927 if (!(w
->cursor
.hpos
>= 0
14928 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
14929 && BUFFERP (glyph
->object
)
14930 && glyph
->charpos
== PT
))
14935 && (!BUFFERP (glyph
->object
)
14936 || glyph
->charpos
< PT
);
14940 w
->cursor
.x
+= glyph
->pixel_width
;
14945 /* Adjust window end. A null value of last_text_row means that
14946 the window end is in reused rows which in turn means that
14947 only its vpos can have changed. */
14950 w
->window_end_bytepos
14951 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14953 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14955 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14960 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14963 w
->window_end_valid
= Qnil
;
14964 w
->desired_matrix
->no_scrolling_p
= 1;
14967 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14977 /************************************************************************
14978 Window redisplay reusing current matrix when buffer has changed
14979 ************************************************************************/
14981 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
14982 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
14983 EMACS_INT
*, EMACS_INT
*);
14984 static struct glyph_row
*
14985 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
14986 struct glyph_row
*);
14989 /* Return the last row in MATRIX displaying text. If row START is
14990 non-null, start searching with that row. IT gives the dimensions
14991 of the display. Value is null if matrix is empty; otherwise it is
14992 a pointer to the row found. */
14994 static struct glyph_row
*
14995 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
14996 struct glyph_row
*start
)
14998 struct glyph_row
*row
, *row_found
;
15000 /* Set row_found to the last row in IT->w's current matrix
15001 displaying text. The loop looks funny but think of partially
15004 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15005 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15007 xassert (row
->enabled_p
);
15009 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15018 /* Return the last row in the current matrix of W that is not affected
15019 by changes at the start of current_buffer that occurred since W's
15020 current matrix was built. Value is null if no such row exists.
15022 BEG_UNCHANGED us the number of characters unchanged at the start of
15023 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15024 first changed character in current_buffer. Characters at positions <
15025 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15026 when the current matrix was built. */
15028 static struct glyph_row
*
15029 find_last_unchanged_at_beg_row (struct window
*w
)
15031 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15032 struct glyph_row
*row
;
15033 struct glyph_row
*row_found
= NULL
;
15034 int yb
= window_text_bottom_y (w
);
15036 /* Find the last row displaying unchanged text. */
15037 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15038 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15039 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15042 if (/* If row ends before first_changed_pos, it is unchanged,
15043 except in some case. */
15044 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15045 /* When row ends in ZV and we write at ZV it is not
15047 && !row
->ends_at_zv_p
15048 /* When first_changed_pos is the end of a continued line,
15049 row is not unchanged because it may be no longer
15051 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15052 && (row
->continued_p
15053 || row
->exact_window_width_line_p
)))
15056 /* Stop if last visible row. */
15057 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15065 /* Find the first glyph row in the current matrix of W that is not
15066 affected by changes at the end of current_buffer since the
15067 time W's current matrix was built.
15069 Return in *DELTA the number of chars by which buffer positions in
15070 unchanged text at the end of current_buffer must be adjusted.
15072 Return in *DELTA_BYTES the corresponding number of bytes.
15074 Value is null if no such row exists, i.e. all rows are affected by
15077 static struct glyph_row
*
15078 find_first_unchanged_at_end_row (struct window
*w
,
15079 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15081 struct glyph_row
*row
;
15082 struct glyph_row
*row_found
= NULL
;
15084 *delta
= *delta_bytes
= 0;
15086 /* Display must not have been paused, otherwise the current matrix
15087 is not up to date. */
15088 eassert (!NILP (w
->window_end_valid
));
15090 /* A value of window_end_pos >= END_UNCHANGED means that the window
15091 end is in the range of changed text. If so, there is no
15092 unchanged row at the end of W's current matrix. */
15093 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15096 /* Set row to the last row in W's current matrix displaying text. */
15097 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15099 /* If matrix is entirely empty, no unchanged row exists. */
15100 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15102 /* The value of row is the last glyph row in the matrix having a
15103 meaningful buffer position in it. The end position of row
15104 corresponds to window_end_pos. This allows us to translate
15105 buffer positions in the current matrix to current buffer
15106 positions for characters not in changed text. */
15108 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15109 EMACS_INT Z_BYTE_old
=
15110 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15111 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15112 struct glyph_row
*first_text_row
15113 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15115 *delta
= Z
- Z_old
;
15116 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15118 /* Set last_unchanged_pos to the buffer position of the last
15119 character in the buffer that has not been changed. Z is the
15120 index + 1 of the last character in current_buffer, i.e. by
15121 subtracting END_UNCHANGED we get the index of the last
15122 unchanged character, and we have to add BEG to get its buffer
15124 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15125 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15127 /* Search backward from ROW for a row displaying a line that
15128 starts at a minimum position >= last_unchanged_pos_old. */
15129 for (; row
> first_text_row
; --row
)
15131 /* This used to abort, but it can happen.
15132 It is ok to just stop the search instead here. KFS. */
15133 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15136 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15141 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15147 /* Make sure that glyph rows in the current matrix of window W
15148 reference the same glyph memory as corresponding rows in the
15149 frame's frame matrix. This function is called after scrolling W's
15150 current matrix on a terminal frame in try_window_id and
15151 try_window_reusing_current_matrix. */
15154 sync_frame_with_window_matrix_rows (struct window
*w
)
15156 struct frame
*f
= XFRAME (w
->frame
);
15157 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15159 /* Preconditions: W must be a leaf window and full-width. Its frame
15160 must have a frame matrix. */
15161 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15162 xassert (WINDOW_FULL_WIDTH_P (w
));
15163 xassert (!FRAME_WINDOW_P (f
));
15165 /* If W is a full-width window, glyph pointers in W's current matrix
15166 have, by definition, to be the same as glyph pointers in the
15167 corresponding frame matrix. Note that frame matrices have no
15168 marginal areas (see build_frame_matrix). */
15169 window_row
= w
->current_matrix
->rows
;
15170 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15171 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15172 while (window_row
< window_row_end
)
15174 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15175 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15177 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15178 frame_row
->glyphs
[TEXT_AREA
] = start
;
15179 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15180 frame_row
->glyphs
[LAST_AREA
] = end
;
15182 /* Disable frame rows whose corresponding window rows have
15183 been disabled in try_window_id. */
15184 if (!window_row
->enabled_p
)
15185 frame_row
->enabled_p
= 0;
15187 ++window_row
, ++frame_row
;
15192 /* Find the glyph row in window W containing CHARPOS. Consider all
15193 rows between START and END (not inclusive). END null means search
15194 all rows to the end of the display area of W. Value is the row
15195 containing CHARPOS or null. */
15198 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15199 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15201 struct glyph_row
*row
= start
;
15202 struct glyph_row
*best_row
= NULL
;
15203 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15206 /* If we happen to start on a header-line, skip that. */
15207 if (row
->mode_line_p
)
15210 if ((end
&& row
>= end
) || !row
->enabled_p
)
15213 last_y
= window_text_bottom_y (w
) - dy
;
15217 /* Give up if we have gone too far. */
15218 if (end
&& row
>= end
)
15220 /* This formerly returned if they were equal.
15221 I think that both quantities are of a "last plus one" type;
15222 if so, when they are equal, the row is within the screen. -- rms. */
15223 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15226 /* If it is in this row, return this row. */
15227 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15228 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15229 /* The end position of a row equals the start
15230 position of the next row. If CHARPOS is there, we
15231 would rather display it in the next line, except
15232 when this line ends in ZV. */
15233 && !row
->ends_at_zv_p
15234 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15235 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15239 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15240 || (!best_row
&& !row
->continued_p
))
15242 /* In bidi-reordered rows, there could be several rows
15243 occluding point, all of them belonging to the same
15244 continued line. We need to find the row which fits
15245 CHARPOS the best. */
15246 for (g
= row
->glyphs
[TEXT_AREA
];
15247 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15250 if (!STRINGP (g
->object
))
15252 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15254 mindif
= eabs (g
->charpos
- charpos
);
15256 /* Exact match always wins. */
15263 else if (best_row
&& !row
->continued_p
)
15270 /* Try to redisplay window W by reusing its existing display. W's
15271 current matrix must be up to date when this function is called,
15272 i.e. window_end_valid must not be nil.
15276 1 if display has been updated
15277 0 if otherwise unsuccessful
15278 -1 if redisplay with same window start is known not to succeed
15280 The following steps are performed:
15282 1. Find the last row in the current matrix of W that is not
15283 affected by changes at the start of current_buffer. If no such row
15286 2. Find the first row in W's current matrix that is not affected by
15287 changes at the end of current_buffer. Maybe there is no such row.
15289 3. Display lines beginning with the row + 1 found in step 1 to the
15290 row found in step 2 or, if step 2 didn't find a row, to the end of
15293 4. If cursor is not known to appear on the window, give up.
15295 5. If display stopped at the row found in step 2, scroll the
15296 display and current matrix as needed.
15298 6. Maybe display some lines at the end of W, if we must. This can
15299 happen under various circumstances, like a partially visible line
15300 becoming fully visible, or because newly displayed lines are displayed
15301 in smaller font sizes.
15303 7. Update W's window end information. */
15306 try_window_id (struct window
*w
)
15308 struct frame
*f
= XFRAME (w
->frame
);
15309 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15310 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15311 struct glyph_row
*last_unchanged_at_beg_row
;
15312 struct glyph_row
*first_unchanged_at_end_row
;
15313 struct glyph_row
*row
;
15314 struct glyph_row
*bottom_row
;
15317 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15319 struct text_pos start_pos
;
15321 int first_unchanged_at_end_vpos
= 0;
15322 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15323 struct text_pos start
;
15324 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15327 if (inhibit_try_window_id
)
15331 /* This is handy for debugging. */
15333 #define GIVE_UP(X) \
15335 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15339 #define GIVE_UP(X) return 0
15342 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15344 /* Don't use this for mini-windows because these can show
15345 messages and mini-buffers, and we don't handle that here. */
15346 if (MINI_WINDOW_P (w
))
15349 /* This flag is used to prevent redisplay optimizations. */
15350 if (windows_or_buffers_changed
|| cursor_type_changed
)
15353 /* Verify that narrowing has not changed.
15354 Also verify that we were not told to prevent redisplay optimizations.
15355 It would be nice to further
15356 reduce the number of cases where this prevents try_window_id. */
15357 if (current_buffer
->clip_changed
15358 || current_buffer
->prevent_redisplay_optimizations_p
)
15361 /* Window must either use window-based redisplay or be full width. */
15362 if (!FRAME_WINDOW_P (f
)
15363 && (!FRAME_LINE_INS_DEL_OK (f
)
15364 || !WINDOW_FULL_WIDTH_P (w
)))
15367 /* Give up if point is known NOT to appear in W. */
15368 if (PT
< CHARPOS (start
))
15371 /* Another way to prevent redisplay optimizations. */
15372 if (XFASTINT (w
->last_modified
) == 0)
15375 /* Verify that window is not hscrolled. */
15376 if (XFASTINT (w
->hscroll
) != 0)
15379 /* Verify that display wasn't paused. */
15380 if (NILP (w
->window_end_valid
))
15383 /* Can't use this if highlighting a region because a cursor movement
15384 will do more than just set the cursor. */
15385 if (!NILP (Vtransient_mark_mode
)
15386 && !NILP (current_buffer
->mark_active
))
15389 /* Likewise if highlighting trailing whitespace. */
15390 if (!NILP (Vshow_trailing_whitespace
))
15393 /* Likewise if showing a region. */
15394 if (!NILP (w
->region_showing
))
15397 /* Can't use this if overlay arrow position and/or string have
15399 if (overlay_arrows_changed_p ())
15402 /* When word-wrap is on, adding a space to the first word of a
15403 wrapped line can change the wrap position, altering the line
15404 above it. It might be worthwhile to handle this more
15405 intelligently, but for now just redisplay from scratch. */
15406 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15409 /* Under bidi reordering, adding or deleting a character in the
15410 beginning of a paragraph, before the first strong directional
15411 character, can change the base direction of the paragraph (unless
15412 the buffer specifies a fixed paragraph direction), which will
15413 require to redisplay the whole paragraph. It might be worthwhile
15414 to find the paragraph limits and widen the range of redisplayed
15415 lines to that, but for now just give up this optimization and
15416 redisplay from scratch. */
15417 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15418 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15421 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15422 only if buffer has really changed. The reason is that the gap is
15423 initially at Z for freshly visited files. The code below would
15424 set end_unchanged to 0 in that case. */
15425 if (MODIFF
> SAVE_MODIFF
15426 /* This seems to happen sometimes after saving a buffer. */
15427 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15429 if (GPT
- BEG
< BEG_UNCHANGED
)
15430 BEG_UNCHANGED
= GPT
- BEG
;
15431 if (Z
- GPT
< END_UNCHANGED
)
15432 END_UNCHANGED
= Z
- GPT
;
15435 /* The position of the first and last character that has been changed. */
15436 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15437 last_changed_charpos
= Z
- END_UNCHANGED
;
15439 /* If window starts after a line end, and the last change is in
15440 front of that newline, then changes don't affect the display.
15441 This case happens with stealth-fontification. Note that although
15442 the display is unchanged, glyph positions in the matrix have to
15443 be adjusted, of course. */
15444 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15445 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15446 && ((last_changed_charpos
< CHARPOS (start
)
15447 && CHARPOS (start
) == BEGV
)
15448 || (last_changed_charpos
< CHARPOS (start
) - 1
15449 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15451 EMACS_INT Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15452 struct glyph_row
*r0
;
15454 /* Compute how many chars/bytes have been added to or removed
15455 from the buffer. */
15456 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15457 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15459 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15461 /* Give up if PT is not in the window. Note that it already has
15462 been checked at the start of try_window_id that PT is not in
15463 front of the window start. */
15464 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15467 /* If window start is unchanged, we can reuse the whole matrix
15468 as is, after adjusting glyph positions. No need to compute
15469 the window end again, since its offset from Z hasn't changed. */
15470 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15471 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15472 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15473 /* PT must not be in a partially visible line. */
15474 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15475 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15477 /* Adjust positions in the glyph matrix. */
15478 if (delta
|| delta_bytes
)
15480 struct glyph_row
*r1
15481 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15482 increment_matrix_positions (w
->current_matrix
,
15483 MATRIX_ROW_VPOS (r0
, current_matrix
),
15484 MATRIX_ROW_VPOS (r1
, current_matrix
),
15485 delta
, delta_bytes
);
15488 /* Set the cursor. */
15489 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15491 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15498 /* Handle the case that changes are all below what is displayed in
15499 the window, and that PT is in the window. This shortcut cannot
15500 be taken if ZV is visible in the window, and text has been added
15501 there that is visible in the window. */
15502 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15503 /* ZV is not visible in the window, or there are no
15504 changes at ZV, actually. */
15505 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15506 || first_changed_charpos
== last_changed_charpos
))
15508 struct glyph_row
*r0
;
15510 /* Give up if PT is not in the window. Note that it already has
15511 been checked at the start of try_window_id that PT is not in
15512 front of the window start. */
15513 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15516 /* If window start is unchanged, we can reuse the whole matrix
15517 as is, without changing glyph positions since no text has
15518 been added/removed in front of the window end. */
15519 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15520 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15521 /* PT must not be in a partially visible line. */
15522 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15523 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15525 /* We have to compute the window end anew since text
15526 could have been added/removed after it. */
15528 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15529 w
->window_end_bytepos
15530 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15532 /* Set the cursor. */
15533 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15535 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15542 /* Give up if window start is in the changed area.
15544 The condition used to read
15546 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15548 but why that was tested escapes me at the moment. */
15549 if (CHARPOS (start
) >= first_changed_charpos
15550 && CHARPOS (start
) <= last_changed_charpos
)
15553 /* Check that window start agrees with the start of the first glyph
15554 row in its current matrix. Check this after we know the window
15555 start is not in changed text, otherwise positions would not be
15557 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15558 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15561 /* Give up if the window ends in strings. Overlay strings
15562 at the end are difficult to handle, so don't try. */
15563 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15564 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15567 /* Compute the position at which we have to start displaying new
15568 lines. Some of the lines at the top of the window might be
15569 reusable because they are not displaying changed text. Find the
15570 last row in W's current matrix not affected by changes at the
15571 start of current_buffer. Value is null if changes start in the
15572 first line of window. */
15573 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15574 if (last_unchanged_at_beg_row
)
15576 /* Avoid starting to display in the moddle of a character, a TAB
15577 for instance. This is easier than to set up the iterator
15578 exactly, and it's not a frequent case, so the additional
15579 effort wouldn't really pay off. */
15580 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15581 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15582 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15583 --last_unchanged_at_beg_row
;
15585 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15588 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15590 start_pos
= it
.current
.pos
;
15592 /* Start displaying new lines in the desired matrix at the same
15593 vpos we would use in the current matrix, i.e. below
15594 last_unchanged_at_beg_row. */
15595 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15597 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15598 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15600 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15604 /* There are no reusable lines at the start of the window.
15605 Start displaying in the first text line. */
15606 start_display (&it
, w
, start
);
15607 it
.vpos
= it
.first_vpos
;
15608 start_pos
= it
.current
.pos
;
15611 /* Find the first row that is not affected by changes at the end of
15612 the buffer. Value will be null if there is no unchanged row, in
15613 which case we must redisplay to the end of the window. delta
15614 will be set to the value by which buffer positions beginning with
15615 first_unchanged_at_end_row have to be adjusted due to text
15617 first_unchanged_at_end_row
15618 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15619 IF_DEBUG (debug_delta
= delta
);
15620 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15622 /* Set stop_pos to the buffer position up to which we will have to
15623 display new lines. If first_unchanged_at_end_row != NULL, this
15624 is the buffer position of the start of the line displayed in that
15625 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15626 that we don't stop at a buffer position. */
15628 if (first_unchanged_at_end_row
)
15630 xassert (last_unchanged_at_beg_row
== NULL
15631 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15633 /* If this is a continuation line, move forward to the next one
15634 that isn't. Changes in lines above affect this line.
15635 Caution: this may move first_unchanged_at_end_row to a row
15636 not displaying text. */
15637 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15638 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15639 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15640 < it
.last_visible_y
))
15641 ++first_unchanged_at_end_row
;
15643 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15644 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15645 >= it
.last_visible_y
))
15646 first_unchanged_at_end_row
= NULL
;
15649 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15651 first_unchanged_at_end_vpos
15652 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15653 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15656 else if (last_unchanged_at_beg_row
== NULL
)
15662 /* Either there is no unchanged row at the end, or the one we have
15663 now displays text. This is a necessary condition for the window
15664 end pos calculation at the end of this function. */
15665 xassert (first_unchanged_at_end_row
== NULL
15666 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15668 debug_last_unchanged_at_beg_vpos
15669 = (last_unchanged_at_beg_row
15670 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15672 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15674 #endif /* GLYPH_DEBUG != 0 */
15677 /* Display new lines. Set last_text_row to the last new line
15678 displayed which has text on it, i.e. might end up as being the
15679 line where the window_end_vpos is. */
15680 w
->cursor
.vpos
= -1;
15681 last_text_row
= NULL
;
15682 overlay_arrow_seen
= 0;
15683 while (it
.current_y
< it
.last_visible_y
15684 && !fonts_changed_p
15685 && (first_unchanged_at_end_row
== NULL
15686 || IT_CHARPOS (it
) < stop_pos
))
15688 if (display_line (&it
))
15689 last_text_row
= it
.glyph_row
- 1;
15692 if (fonts_changed_p
)
15696 /* Compute differences in buffer positions, y-positions etc. for
15697 lines reused at the bottom of the window. Compute what we can
15699 if (first_unchanged_at_end_row
15700 /* No lines reused because we displayed everything up to the
15701 bottom of the window. */
15702 && it
.current_y
< it
.last_visible_y
)
15705 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15707 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15708 run
.current_y
= first_unchanged_at_end_row
->y
;
15709 run
.desired_y
= run
.current_y
+ dy
;
15710 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15714 delta
= delta_bytes
= dvpos
= dy
15715 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15716 first_unchanged_at_end_row
= NULL
;
15718 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15721 /* Find the cursor if not already found. We have to decide whether
15722 PT will appear on this window (it sometimes doesn't, but this is
15723 not a very frequent case.) This decision has to be made before
15724 the current matrix is altered. A value of cursor.vpos < 0 means
15725 that PT is either in one of the lines beginning at
15726 first_unchanged_at_end_row or below the window. Don't care for
15727 lines that might be displayed later at the window end; as
15728 mentioned, this is not a frequent case. */
15729 if (w
->cursor
.vpos
< 0)
15731 /* Cursor in unchanged rows at the top? */
15732 if (PT
< CHARPOS (start_pos
)
15733 && last_unchanged_at_beg_row
)
15735 row
= row_containing_pos (w
, PT
,
15736 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15737 last_unchanged_at_beg_row
+ 1, 0);
15739 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15742 /* Start from first_unchanged_at_end_row looking for PT. */
15743 else if (first_unchanged_at_end_row
)
15745 row
= row_containing_pos (w
, PT
- delta
,
15746 first_unchanged_at_end_row
, NULL
, 0);
15748 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15749 delta_bytes
, dy
, dvpos
);
15752 /* Give up if cursor was not found. */
15753 if (w
->cursor
.vpos
< 0)
15755 clear_glyph_matrix (w
->desired_matrix
);
15760 /* Don't let the cursor end in the scroll margins. */
15762 int this_scroll_margin
, cursor_height
;
15764 this_scroll_margin
= max (0, scroll_margin
);
15765 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15766 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15767 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15769 if ((w
->cursor
.y
< this_scroll_margin
15770 && CHARPOS (start
) > BEGV
)
15771 /* Old redisplay didn't take scroll margin into account at the bottom,
15772 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15773 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15774 ? cursor_height
+ this_scroll_margin
15775 : 1)) > it
.last_visible_y
)
15777 w
->cursor
.vpos
= -1;
15778 clear_glyph_matrix (w
->desired_matrix
);
15783 /* Scroll the display. Do it before changing the current matrix so
15784 that xterm.c doesn't get confused about where the cursor glyph is
15786 if (dy
&& run
.height
)
15790 if (FRAME_WINDOW_P (f
))
15792 FRAME_RIF (f
)->update_window_begin_hook (w
);
15793 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15794 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15795 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15799 /* Terminal frame. In this case, dvpos gives the number of
15800 lines to scroll by; dvpos < 0 means scroll up. */
15801 int first_unchanged_at_end_vpos
15802 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15803 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15804 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15805 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15806 + window_internal_height (w
));
15808 #if defined (HAVE_GPM) || defined (MSDOS)
15809 x_clear_window_mouse_face (w
);
15811 /* Perform the operation on the screen. */
15814 /* Scroll last_unchanged_at_beg_row to the end of the
15815 window down dvpos lines. */
15816 set_terminal_window (f
, end
);
15818 /* On dumb terminals delete dvpos lines at the end
15819 before inserting dvpos empty lines. */
15820 if (!FRAME_SCROLL_REGION_OK (f
))
15821 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15823 /* Insert dvpos empty lines in front of
15824 last_unchanged_at_beg_row. */
15825 ins_del_lines (f
, from
, dvpos
);
15827 else if (dvpos
< 0)
15829 /* Scroll up last_unchanged_at_beg_vpos to the end of
15830 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15831 set_terminal_window (f
, end
);
15833 /* Delete dvpos lines in front of
15834 last_unchanged_at_beg_vpos. ins_del_lines will set
15835 the cursor to the given vpos and emit |dvpos| delete
15837 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15839 /* On a dumb terminal insert dvpos empty lines at the
15841 if (!FRAME_SCROLL_REGION_OK (f
))
15842 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15845 set_terminal_window (f
, 0);
15851 /* Shift reused rows of the current matrix to the right position.
15852 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15854 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15855 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15858 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15859 bottom_vpos
, dvpos
);
15860 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15863 else if (dvpos
> 0)
15865 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15866 bottom_vpos
, dvpos
);
15867 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15868 first_unchanged_at_end_vpos
+ dvpos
, 0);
15871 /* For frame-based redisplay, make sure that current frame and window
15872 matrix are in sync with respect to glyph memory. */
15873 if (!FRAME_WINDOW_P (f
))
15874 sync_frame_with_window_matrix_rows (w
);
15876 /* Adjust buffer positions in reused rows. */
15877 if (delta
|| delta_bytes
)
15878 increment_matrix_positions (current_matrix
,
15879 first_unchanged_at_end_vpos
+ dvpos
,
15880 bottom_vpos
, delta
, delta_bytes
);
15882 /* Adjust Y positions. */
15884 shift_glyph_matrix (w
, current_matrix
,
15885 first_unchanged_at_end_vpos
+ dvpos
,
15888 if (first_unchanged_at_end_row
)
15890 first_unchanged_at_end_row
+= dvpos
;
15891 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15892 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15893 first_unchanged_at_end_row
= NULL
;
15896 /* If scrolling up, there may be some lines to display at the end of
15898 last_text_row_at_end
= NULL
;
15901 /* Scrolling up can leave for example a partially visible line
15902 at the end of the window to be redisplayed. */
15903 /* Set last_row to the glyph row in the current matrix where the
15904 window end line is found. It has been moved up or down in
15905 the matrix by dvpos. */
15906 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15907 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15909 /* If last_row is the window end line, it should display text. */
15910 xassert (last_row
->displays_text_p
);
15912 /* If window end line was partially visible before, begin
15913 displaying at that line. Otherwise begin displaying with the
15914 line following it. */
15915 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15917 init_to_row_start (&it
, w
, last_row
);
15918 it
.vpos
= last_vpos
;
15919 it
.current_y
= last_row
->y
;
15923 init_to_row_end (&it
, w
, last_row
);
15924 it
.vpos
= 1 + last_vpos
;
15925 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15929 /* We may start in a continuation line. If so, we have to
15930 get the right continuation_lines_width and current_x. */
15931 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15932 it
.hpos
= it
.current_x
= 0;
15934 /* Display the rest of the lines at the window end. */
15935 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15936 while (it
.current_y
< it
.last_visible_y
15937 && !fonts_changed_p
)
15939 /* Is it always sure that the display agrees with lines in
15940 the current matrix? I don't think so, so we mark rows
15941 displayed invalid in the current matrix by setting their
15942 enabled_p flag to zero. */
15943 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15944 if (display_line (&it
))
15945 last_text_row_at_end
= it
.glyph_row
- 1;
15949 /* Update window_end_pos and window_end_vpos. */
15950 if (first_unchanged_at_end_row
15951 && !last_text_row_at_end
)
15953 /* Window end line if one of the preserved rows from the current
15954 matrix. Set row to the last row displaying text in current
15955 matrix starting at first_unchanged_at_end_row, after
15957 xassert (first_unchanged_at_end_row
->displays_text_p
);
15958 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15959 first_unchanged_at_end_row
);
15960 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15962 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15963 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15965 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15966 xassert (w
->window_end_bytepos
>= 0);
15967 IF_DEBUG (debug_method_add (w
, "A"));
15969 else if (last_text_row_at_end
)
15972 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15973 w
->window_end_bytepos
15974 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15976 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15977 xassert (w
->window_end_bytepos
>= 0);
15978 IF_DEBUG (debug_method_add (w
, "B"));
15980 else if (last_text_row
)
15982 /* We have displayed either to the end of the window or at the
15983 end of the window, i.e. the last row with text is to be found
15984 in the desired matrix. */
15986 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15987 w
->window_end_bytepos
15988 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15990 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15991 xassert (w
->window_end_bytepos
>= 0);
15993 else if (first_unchanged_at_end_row
== NULL
15994 && last_text_row
== NULL
15995 && last_text_row_at_end
== NULL
)
15997 /* Displayed to end of window, but no line containing text was
15998 displayed. Lines were deleted at the end of the window. */
15999 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16000 int vpos
= XFASTINT (w
->window_end_vpos
);
16001 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16002 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16005 row
== NULL
&& vpos
>= first_vpos
;
16006 --vpos
, --current_row
, --desired_row
)
16008 if (desired_row
->enabled_p
)
16010 if (desired_row
->displays_text_p
)
16013 else if (current_row
->displays_text_p
)
16017 xassert (row
!= NULL
);
16018 w
->window_end_vpos
= make_number (vpos
+ 1);
16019 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16020 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16021 xassert (w
->window_end_bytepos
>= 0);
16022 IF_DEBUG (debug_method_add (w
, "C"));
16027 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16028 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16030 /* Record that display has not been completed. */
16031 w
->window_end_valid
= Qnil
;
16032 w
->desired_matrix
->no_scrolling_p
= 1;
16040 /***********************************************************************
16041 More debugging support
16042 ***********************************************************************/
16046 void dump_glyph_row (struct glyph_row
*, int, int);
16047 void dump_glyph_matrix (struct glyph_matrix
*, int);
16048 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16051 /* Dump the contents of glyph matrix MATRIX on stderr.
16053 GLYPHS 0 means don't show glyph contents.
16054 GLYPHS 1 means show glyphs in short form
16055 GLYPHS > 1 means show glyphs in long form. */
16058 dump_glyph_matrix (matrix
, glyphs
)
16059 struct glyph_matrix
*matrix
;
16063 for (i
= 0; i
< matrix
->nrows
; ++i
)
16064 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16068 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16069 the glyph row and area where the glyph comes from. */
16072 dump_glyph (row
, glyph
, area
)
16073 struct glyph_row
*row
;
16074 struct glyph
*glyph
;
16077 if (glyph
->type
== CHAR_GLYPH
)
16080 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16081 glyph
- row
->glyphs
[TEXT_AREA
],
16084 (BUFFERP (glyph
->object
)
16086 : (STRINGP (glyph
->object
)
16089 glyph
->pixel_width
,
16091 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16095 glyph
->left_box_line_p
,
16096 glyph
->right_box_line_p
);
16098 else if (glyph
->type
== STRETCH_GLYPH
)
16101 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16102 glyph
- row
->glyphs
[TEXT_AREA
],
16105 (BUFFERP (glyph
->object
)
16107 : (STRINGP (glyph
->object
)
16110 glyph
->pixel_width
,
16114 glyph
->left_box_line_p
,
16115 glyph
->right_box_line_p
);
16117 else if (glyph
->type
== IMAGE_GLYPH
)
16120 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16121 glyph
- row
->glyphs
[TEXT_AREA
],
16124 (BUFFERP (glyph
->object
)
16126 : (STRINGP (glyph
->object
)
16129 glyph
->pixel_width
,
16133 glyph
->left_box_line_p
,
16134 glyph
->right_box_line_p
);
16136 else if (glyph
->type
== COMPOSITE_GLYPH
)
16139 " %5d %4c %6d %c %3d 0x%05x",
16140 glyph
- row
->glyphs
[TEXT_AREA
],
16143 (BUFFERP (glyph
->object
)
16145 : (STRINGP (glyph
->object
)
16148 glyph
->pixel_width
,
16150 if (glyph
->u
.cmp
.automatic
)
16153 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16154 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16156 glyph
->left_box_line_p
,
16157 glyph
->right_box_line_p
);
16162 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16163 GLYPHS 0 means don't show glyph contents.
16164 GLYPHS 1 means show glyphs in short form
16165 GLYPHS > 1 means show glyphs in long form. */
16168 dump_glyph_row (row
, vpos
, glyphs
)
16169 struct glyph_row
*row
;
16174 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16175 fprintf (stderr
, "======================================================================\n");
16177 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16178 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16180 MATRIX_ROW_START_CHARPOS (row
),
16181 MATRIX_ROW_END_CHARPOS (row
),
16182 row
->used
[TEXT_AREA
],
16183 row
->contains_overlapping_glyphs_p
,
16185 row
->truncated_on_left_p
,
16186 row
->truncated_on_right_p
,
16188 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16189 row
->displays_text_p
,
16192 row
->ends_in_middle_of_char_p
,
16193 row
->starts_in_middle_of_char_p
,
16199 row
->visible_height
,
16202 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16203 row
->end
.overlay_string_index
,
16204 row
->continuation_lines_width
);
16205 fprintf (stderr
, "%9d %5d\n",
16206 CHARPOS (row
->start
.string_pos
),
16207 CHARPOS (row
->end
.string_pos
));
16208 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16209 row
->end
.dpvec_index
);
16216 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16218 struct glyph
*glyph
= row
->glyphs
[area
];
16219 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16221 /* Glyph for a line end in text. */
16222 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16225 if (glyph
< glyph_end
)
16226 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16228 for (; glyph
< glyph_end
; ++glyph
)
16229 dump_glyph (row
, glyph
, area
);
16232 else if (glyphs
== 1)
16236 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16238 char *s
= (char *) alloca (row
->used
[area
] + 1);
16241 for (i
= 0; i
< row
->used
[area
]; ++i
)
16243 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16244 if (glyph
->type
== CHAR_GLYPH
16245 && glyph
->u
.ch
< 0x80
16246 && glyph
->u
.ch
>= ' ')
16247 s
[i
] = glyph
->u
.ch
;
16253 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16259 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16260 Sdump_glyph_matrix
, 0, 1, "p",
16261 doc
: /* Dump the current matrix of the selected window to stderr.
16262 Shows contents of glyph row structures. With non-nil
16263 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16264 glyphs in short form, otherwise show glyphs in long form. */)
16265 (Lisp_Object glyphs
)
16267 struct window
*w
= XWINDOW (selected_window
);
16268 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16270 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16271 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16272 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16273 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16274 fprintf (stderr
, "=============================================\n");
16275 dump_glyph_matrix (w
->current_matrix
,
16276 NILP (glyphs
) ? 0 : XINT (glyphs
));
16281 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16282 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16285 struct frame
*f
= XFRAME (selected_frame
);
16286 dump_glyph_matrix (f
->current_matrix
, 1);
16291 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16292 doc
: /* Dump glyph row ROW to stderr.
16293 GLYPH 0 means don't dump glyphs.
16294 GLYPH 1 means dump glyphs in short form.
16295 GLYPH > 1 or omitted means dump glyphs in long form. */)
16296 (Lisp_Object row
, Lisp_Object glyphs
)
16298 struct glyph_matrix
*matrix
;
16301 CHECK_NUMBER (row
);
16302 matrix
= XWINDOW (selected_window
)->current_matrix
;
16304 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16305 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16307 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16312 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16313 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16314 GLYPH 0 means don't dump glyphs.
16315 GLYPH 1 means dump glyphs in short form.
16316 GLYPH > 1 or omitted means dump glyphs in long form. */)
16317 (Lisp_Object row
, Lisp_Object glyphs
)
16319 struct frame
*sf
= SELECTED_FRAME ();
16320 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16323 CHECK_NUMBER (row
);
16325 if (vpos
>= 0 && vpos
< m
->nrows
)
16326 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16327 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16332 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16333 doc
: /* Toggle tracing of redisplay.
16334 With ARG, turn tracing on if and only if ARG is positive. */)
16338 trace_redisplay_p
= !trace_redisplay_p
;
16341 arg
= Fprefix_numeric_value (arg
);
16342 trace_redisplay_p
= XINT (arg
) > 0;
16349 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16350 doc
: /* Like `format', but print result to stderr.
16351 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16352 (int nargs
, Lisp_Object
*args
)
16354 Lisp_Object s
= Fformat (nargs
, args
);
16355 fprintf (stderr
, "%s", SDATA (s
));
16359 #endif /* GLYPH_DEBUG */
16363 /***********************************************************************
16364 Building Desired Matrix Rows
16365 ***********************************************************************/
16367 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16368 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16370 static struct glyph_row
*
16371 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16373 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16374 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16375 struct buffer
*old
= current_buffer
;
16376 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16377 int arrow_len
= SCHARS (overlay_arrow_string
);
16378 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16379 const unsigned char *p
;
16382 int n_glyphs_before
;
16384 set_buffer_temp (buffer
);
16385 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16386 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16387 SET_TEXT_POS (it
.position
, 0, 0);
16389 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16391 while (p
< arrow_end
)
16393 Lisp_Object face
, ilisp
;
16395 /* Get the next character. */
16397 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16400 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16401 if (! ASCII_CHAR_P (it
.c
))
16402 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16406 /* Get its face. */
16407 ilisp
= make_number (p
- arrow_string
);
16408 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16409 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16411 /* Compute its width, get its glyphs. */
16412 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16413 SET_TEXT_POS (it
.position
, -1, -1);
16414 PRODUCE_GLYPHS (&it
);
16416 /* If this character doesn't fit any more in the line, we have
16417 to remove some glyphs. */
16418 if (it
.current_x
> it
.last_visible_x
)
16420 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16425 set_buffer_temp (old
);
16426 return it
.glyph_row
;
16430 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16431 glyphs are only inserted for terminal frames since we can't really
16432 win with truncation glyphs when partially visible glyphs are
16433 involved. Which glyphs to insert is determined by
16434 produce_special_glyphs. */
16437 insert_left_trunc_glyphs (struct it
*it
)
16439 struct it truncate_it
;
16440 struct glyph
*from
, *end
, *to
, *toend
;
16442 xassert (!FRAME_WINDOW_P (it
->f
));
16444 /* Get the truncation glyphs. */
16446 truncate_it
.current_x
= 0;
16447 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16448 truncate_it
.glyph_row
= &scratch_glyph_row
;
16449 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16450 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16451 truncate_it
.object
= make_number (0);
16452 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16454 /* Overwrite glyphs from IT with truncation glyphs. */
16455 if (!it
->glyph_row
->reversed_p
)
16457 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16458 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16459 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16460 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16465 /* There may be padding glyphs left over. Overwrite them too. */
16466 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16468 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16474 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16478 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16479 that back to front. */
16480 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16481 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16482 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16483 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16485 while (from
>= end
&& to
>= toend
)
16487 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16490 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16491 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16492 while (from
>= end
&& to
>= toend
)
16497 /* Need to free some room before prepending additional
16499 int move_by
= from
- end
+ 1;
16500 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16501 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16503 for ( ; g
>= g0
; g
--)
16505 while (from
>= end
)
16507 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16513 /* Compute the pixel height and width of IT->glyph_row.
16515 Most of the time, ascent and height of a display line will be equal
16516 to the max_ascent and max_height values of the display iterator
16517 structure. This is not the case if
16519 1. We hit ZV without displaying anything. In this case, max_ascent
16520 and max_height will be zero.
16522 2. We have some glyphs that don't contribute to the line height.
16523 (The glyph row flag contributes_to_line_height_p is for future
16524 pixmap extensions).
16526 The first case is easily covered by using default values because in
16527 these cases, the line height does not really matter, except that it
16528 must not be zero. */
16531 compute_line_metrics (struct it
*it
)
16533 struct glyph_row
*row
= it
->glyph_row
;
16536 if (FRAME_WINDOW_P (it
->f
))
16538 int i
, min_y
, max_y
;
16540 /* The line may consist of one space only, that was added to
16541 place the cursor on it. If so, the row's height hasn't been
16543 if (row
->height
== 0)
16545 if (it
->max_ascent
+ it
->max_descent
== 0)
16546 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16547 row
->ascent
= it
->max_ascent
;
16548 row
->height
= it
->max_ascent
+ it
->max_descent
;
16549 row
->phys_ascent
= it
->max_phys_ascent
;
16550 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16551 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16554 /* Compute the width of this line. */
16555 row
->pixel_width
= row
->x
;
16556 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16557 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16559 xassert (row
->pixel_width
>= 0);
16560 xassert (row
->ascent
>= 0 && row
->height
> 0);
16562 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16563 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16565 /* If first line's physical ascent is larger than its logical
16566 ascent, use the physical ascent, and make the row taller.
16567 This makes accented characters fully visible. */
16568 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16569 && row
->phys_ascent
> row
->ascent
)
16571 row
->height
+= row
->phys_ascent
- row
->ascent
;
16572 row
->ascent
= row
->phys_ascent
;
16575 /* Compute how much of the line is visible. */
16576 row
->visible_height
= row
->height
;
16578 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16579 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16581 if (row
->y
< min_y
)
16582 row
->visible_height
-= min_y
- row
->y
;
16583 if (row
->y
+ row
->height
> max_y
)
16584 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16588 row
->pixel_width
= row
->used
[TEXT_AREA
];
16589 if (row
->continued_p
)
16590 row
->pixel_width
-= it
->continuation_pixel_width
;
16591 else if (row
->truncated_on_right_p
)
16592 row
->pixel_width
-= it
->truncation_pixel_width
;
16593 row
->ascent
= row
->phys_ascent
= 0;
16594 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16595 row
->extra_line_spacing
= 0;
16598 /* Compute a hash code for this row. */
16600 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16601 for (i
= 0; i
< row
->used
[area
]; ++i
)
16602 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16603 + row
->glyphs
[area
][i
].u
.val
16604 + row
->glyphs
[area
][i
].face_id
16605 + row
->glyphs
[area
][i
].padding_p
16606 + (row
->glyphs
[area
][i
].type
<< 2));
16608 it
->max_ascent
= it
->max_descent
= 0;
16609 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16613 /* Append one space to the glyph row of iterator IT if doing a
16614 window-based redisplay. The space has the same face as
16615 IT->face_id. Value is non-zero if a space was added.
16617 This function is called to make sure that there is always one glyph
16618 at the end of a glyph row that the cursor can be set on under
16619 window-systems. (If there weren't such a glyph we would not know
16620 how wide and tall a box cursor should be displayed).
16622 At the same time this space let's a nicely handle clearing to the
16623 end of the line if the row ends in italic text. */
16626 append_space_for_newline (struct it
*it
, int default_face_p
)
16628 if (FRAME_WINDOW_P (it
->f
))
16630 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16632 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16633 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16635 /* Save some values that must not be changed.
16636 Must save IT->c and IT->len because otherwise
16637 ITERATOR_AT_END_P wouldn't work anymore after
16638 append_space_for_newline has been called. */
16639 enum display_element_type saved_what
= it
->what
;
16640 int saved_c
= it
->c
, saved_len
= it
->len
;
16641 int saved_char_to_display
= it
->char_to_display
;
16642 int saved_x
= it
->current_x
;
16643 int saved_face_id
= it
->face_id
;
16644 struct text_pos saved_pos
;
16645 Lisp_Object saved_object
;
16648 saved_object
= it
->object
;
16649 saved_pos
= it
->position
;
16651 it
->what
= IT_CHARACTER
;
16652 memset (&it
->position
, 0, sizeof it
->position
);
16653 it
->object
= make_number (0);
16654 it
->c
= it
->char_to_display
= ' ';
16657 if (default_face_p
)
16658 it
->face_id
= DEFAULT_FACE_ID
;
16659 else if (it
->face_before_selective_p
)
16660 it
->face_id
= it
->saved_face_id
;
16661 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16662 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16664 PRODUCE_GLYPHS (it
);
16666 it
->override_ascent
= -1;
16667 it
->constrain_row_ascent_descent_p
= 0;
16668 it
->current_x
= saved_x
;
16669 it
->object
= saved_object
;
16670 it
->position
= saved_pos
;
16671 it
->what
= saved_what
;
16672 it
->face_id
= saved_face_id
;
16673 it
->len
= saved_len
;
16675 it
->char_to_display
= saved_char_to_display
;
16684 /* Extend the face of the last glyph in the text area of IT->glyph_row
16685 to the end of the display line. Called from display_line. If the
16686 glyph row is empty, add a space glyph to it so that we know the
16687 face to draw. Set the glyph row flag fill_line_p. If the glyph
16688 row is R2L, prepend a stretch glyph to cover the empty space to the
16689 left of the leftmost glyph. */
16692 extend_face_to_end_of_line (struct it
*it
)
16695 struct frame
*f
= it
->f
;
16697 /* If line is already filled, do nothing. Non window-system frames
16698 get a grace of one more ``pixel'' because their characters are
16699 1-``pixel'' wide, so they hit the equality too early. This grace
16700 is needed only for R2L rows that are not continued, to produce
16701 one extra blank where we could display the cursor. */
16702 if (it
->current_x
>= it
->last_visible_x
16703 + (!FRAME_WINDOW_P (f
)
16704 && it
->glyph_row
->reversed_p
16705 && !it
->glyph_row
->continued_p
))
16708 /* Face extension extends the background and box of IT->face_id
16709 to the end of the line. If the background equals the background
16710 of the frame, we don't have to do anything. */
16711 if (it
->face_before_selective_p
)
16712 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16714 face
= FACE_FROM_ID (f
, it
->face_id
);
16716 if (FRAME_WINDOW_P (f
)
16717 && it
->glyph_row
->displays_text_p
16718 && face
->box
== FACE_NO_BOX
16719 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16721 && !it
->glyph_row
->reversed_p
)
16724 /* Set the glyph row flag indicating that the face of the last glyph
16725 in the text area has to be drawn to the end of the text area. */
16726 it
->glyph_row
->fill_line_p
= 1;
16728 /* If current character of IT is not ASCII, make sure we have the
16729 ASCII face. This will be automatically undone the next time
16730 get_next_display_element returns a multibyte character. Note
16731 that the character will always be single byte in unibyte
16733 if (!ASCII_CHAR_P (it
->c
))
16735 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16738 if (FRAME_WINDOW_P (f
))
16740 /* If the row is empty, add a space with the current face of IT,
16741 so that we know which face to draw. */
16742 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16744 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16745 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16746 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16748 #ifdef HAVE_WINDOW_SYSTEM
16749 if (it
->glyph_row
->reversed_p
)
16751 /* Prepend a stretch glyph to the row, such that the
16752 rightmost glyph will be drawn flushed all the way to the
16753 right margin of the window. The stretch glyph that will
16754 occupy the empty space, if any, to the left of the
16756 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16757 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16758 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16760 int row_width
, stretch_ascent
, stretch_width
;
16761 struct text_pos saved_pos
;
16762 int saved_face_id
, saved_avoid_cursor
;
16764 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16765 row_width
+= g
->pixel_width
;
16766 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16767 if (stretch_width
> 0)
16770 (((it
->ascent
+ it
->descent
)
16771 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16772 saved_pos
= it
->position
;
16773 memset (&it
->position
, 0, sizeof it
->position
);
16774 saved_avoid_cursor
= it
->avoid_cursor_p
;
16775 it
->avoid_cursor_p
= 1;
16776 saved_face_id
= it
->face_id
;
16777 /* The last row's stretch glyph should get the default
16778 face, to avoid painting the rest of the window with
16779 the region face, if the region ends at ZV. */
16780 if (it
->glyph_row
->ends_at_zv_p
)
16781 it
->face_id
= DEFAULT_FACE_ID
;
16783 it
->face_id
= face
->id
;
16784 append_stretch_glyph (it
, make_number (0), stretch_width
,
16785 it
->ascent
+ it
->descent
, stretch_ascent
);
16786 it
->position
= saved_pos
;
16787 it
->avoid_cursor_p
= saved_avoid_cursor
;
16788 it
->face_id
= saved_face_id
;
16791 #endif /* HAVE_WINDOW_SYSTEM */
16795 /* Save some values that must not be changed. */
16796 int saved_x
= it
->current_x
;
16797 struct text_pos saved_pos
;
16798 Lisp_Object saved_object
;
16799 enum display_element_type saved_what
= it
->what
;
16800 int saved_face_id
= it
->face_id
;
16802 saved_object
= it
->object
;
16803 saved_pos
= it
->position
;
16805 it
->what
= IT_CHARACTER
;
16806 memset (&it
->position
, 0, sizeof it
->position
);
16807 it
->object
= make_number (0);
16808 it
->c
= it
->char_to_display
= ' ';
16810 /* The last row's blank glyphs should get the default face, to
16811 avoid painting the rest of the window with the region face,
16812 if the region ends at ZV. */
16813 if (it
->glyph_row
->ends_at_zv_p
)
16814 it
->face_id
= DEFAULT_FACE_ID
;
16816 it
->face_id
= face
->id
;
16818 PRODUCE_GLYPHS (it
);
16820 while (it
->current_x
<= it
->last_visible_x
)
16821 PRODUCE_GLYPHS (it
);
16823 /* Don't count these blanks really. It would let us insert a left
16824 truncation glyph below and make us set the cursor on them, maybe. */
16825 it
->current_x
= saved_x
;
16826 it
->object
= saved_object
;
16827 it
->position
= saved_pos
;
16828 it
->what
= saved_what
;
16829 it
->face_id
= saved_face_id
;
16834 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16835 trailing whitespace. */
16838 trailing_whitespace_p (EMACS_INT charpos
)
16840 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16843 while (bytepos
< ZV_BYTE
16844 && (c
= FETCH_CHAR (bytepos
),
16845 c
== ' ' || c
== '\t'))
16848 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16850 if (bytepos
!= PT_BYTE
)
16857 /* Highlight trailing whitespace, if any, in ROW. */
16860 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16862 int used
= row
->used
[TEXT_AREA
];
16866 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16867 struct glyph
*glyph
= start
+ used
- 1;
16869 if (row
->reversed_p
)
16871 /* Right-to-left rows need to be processed in the opposite
16872 direction, so swap the edge pointers. */
16874 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16877 /* Skip over glyphs inserted to display the cursor at the
16878 end of a line, for extending the face of the last glyph
16879 to the end of the line on terminals, and for truncation
16880 and continuation glyphs. */
16881 if (!row
->reversed_p
)
16883 while (glyph
>= start
16884 && glyph
->type
== CHAR_GLYPH
16885 && INTEGERP (glyph
->object
))
16890 while (glyph
<= start
16891 && glyph
->type
== CHAR_GLYPH
16892 && INTEGERP (glyph
->object
))
16896 /* If last glyph is a space or stretch, and it's trailing
16897 whitespace, set the face of all trailing whitespace glyphs in
16898 IT->glyph_row to `trailing-whitespace'. */
16899 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16900 && BUFFERP (glyph
->object
)
16901 && (glyph
->type
== STRETCH_GLYPH
16902 || (glyph
->type
== CHAR_GLYPH
16903 && glyph
->u
.ch
== ' '))
16904 && trailing_whitespace_p (glyph
->charpos
))
16906 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16910 if (!row
->reversed_p
)
16912 while (glyph
>= start
16913 && BUFFERP (glyph
->object
)
16914 && (glyph
->type
== STRETCH_GLYPH
16915 || (glyph
->type
== CHAR_GLYPH
16916 && glyph
->u
.ch
== ' ')))
16917 (glyph
--)->face_id
= face_id
;
16921 while (glyph
<= start
16922 && BUFFERP (glyph
->object
)
16923 && (glyph
->type
== STRETCH_GLYPH
16924 || (glyph
->type
== CHAR_GLYPH
16925 && glyph
->u
.ch
== ' ')))
16926 (glyph
++)->face_id
= face_id
;
16933 /* Value is non-zero if glyph row ROW in window W should be
16934 used to hold the cursor. */
16937 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
16939 int cursor_row_p
= 1;
16941 if (PT
== CHARPOS (row
->end
.pos
))
16943 /* Suppose the row ends on a string.
16944 Unless the row is continued, that means it ends on a newline
16945 in the string. If it's anything other than a display string
16946 (e.g. a before-string from an overlay), we don't want the
16947 cursor there. (This heuristic seems to give the optimal
16948 behavior for the various types of multi-line strings.) */
16949 if (CHARPOS (row
->end
.string_pos
) >= 0)
16951 if (row
->continued_p
)
16955 /* Check for `display' property. */
16956 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16957 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16958 struct glyph
*glyph
;
16961 for (glyph
= end
; glyph
>= beg
; --glyph
)
16962 if (STRINGP (glyph
->object
))
16965 = Fget_char_property (make_number (PT
),
16969 && display_prop_string_p (prop
, glyph
->object
));
16974 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16976 /* If the row ends in middle of a real character,
16977 and the line is continued, we want the cursor here.
16978 That's because CHARPOS (ROW->end.pos) would equal
16979 PT if PT is before the character. */
16980 if (!row
->ends_in_ellipsis_p
)
16981 cursor_row_p
= row
->continued_p
;
16983 /* If the row ends in an ellipsis, then
16984 CHARPOS (ROW->end.pos) will equal point after the
16985 invisible text. We want that position to be displayed
16986 after the ellipsis. */
16989 /* If the row ends at ZV, display the cursor at the end of that
16990 row instead of at the start of the row below. */
16991 else if (row
->ends_at_zv_p
)
16997 return cursor_row_p
;
17002 /* Push the display property PROP so that it will be rendered at the
17003 current position in IT. Return 1 if PROP was successfully pushed,
17007 push_display_prop (struct it
*it
, Lisp_Object prop
)
17011 if (STRINGP (prop
))
17013 if (SCHARS (prop
) == 0)
17020 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17021 it
->current
.overlay_string_index
= -1;
17022 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17023 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17024 it
->method
= GET_FROM_STRING
;
17025 it
->stop_charpos
= 0;
17027 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17029 it
->method
= GET_FROM_STRETCH
;
17032 #ifdef HAVE_WINDOW_SYSTEM
17033 else if (IMAGEP (prop
))
17035 it
->what
= IT_IMAGE
;
17036 it
->image_id
= lookup_image (it
->f
, prop
);
17037 it
->method
= GET_FROM_IMAGE
;
17039 #endif /* HAVE_WINDOW_SYSTEM */
17042 pop_it (it
); /* bogus display property, give up */
17049 /* Return the character-property PROP at the current position in IT. */
17052 get_it_property (struct it
*it
, Lisp_Object prop
)
17054 Lisp_Object position
;
17056 if (STRINGP (it
->object
))
17057 position
= make_number (IT_STRING_CHARPOS (*it
));
17058 else if (BUFFERP (it
->object
))
17059 position
= make_number (IT_CHARPOS (*it
));
17063 return Fget_char_property (position
, prop
, it
->object
);
17066 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17069 handle_line_prefix (struct it
*it
)
17071 Lisp_Object prefix
;
17072 if (it
->continuation_lines_width
> 0)
17074 prefix
= get_it_property (it
, Qwrap_prefix
);
17076 prefix
= Vwrap_prefix
;
17080 prefix
= get_it_property (it
, Qline_prefix
);
17082 prefix
= Vline_prefix
;
17084 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17086 /* If the prefix is wider than the window, and we try to wrap
17087 it, it would acquire its own wrap prefix, and so on till the
17088 iterator stack overflows. So, don't wrap the prefix. */
17089 it
->line_wrap
= TRUNCATE
;
17090 it
->avoid_cursor_p
= 1;
17096 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17097 only for R2L lines from display_line, when it decides that too many
17098 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17101 unproduce_glyphs (struct it
*it
, int n
)
17103 struct glyph
*glyph
, *end
;
17105 xassert (it
->glyph_row
);
17106 xassert (it
->glyph_row
->reversed_p
);
17107 xassert (it
->area
== TEXT_AREA
);
17108 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17110 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17111 n
= it
->glyph_row
->used
[TEXT_AREA
];
17112 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17113 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17114 for ( ; glyph
< end
; glyph
++)
17115 glyph
[-n
] = *glyph
;
17118 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17119 and ROW->maxpos. */
17121 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17122 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17123 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17125 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17126 lines' rows is implemented for bidi-reordered rows. */
17128 /* ROW->minpos is the value of min_pos, the minimal buffer position
17131 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17134 /* We didn't find _any_ valid buffer positions in any of the
17135 glyphs, so we must trust the iterator's computed
17137 row
->minpos
= row
->start
.pos
;
17138 max_pos
= CHARPOS (it
->current
.pos
);
17139 max_bpos
= BYTEPOS (it
->current
.pos
);
17145 /* Here are the various use-cases for ending the row, and the
17146 corresponding values for ROW->maxpos:
17148 Line ends in a newline from buffer eol_pos + 1
17149 Line is continued from buffer max_pos + 1
17150 Line is truncated on right it->current.pos
17151 Line ends in a newline from string max_pos
17152 Line is continued from string max_pos
17153 Line is continued from display vector max_pos
17154 Line is entirely from a string min_pos == max_pos
17155 Line is entirely from a display vector min_pos == max_pos
17156 Line that ends at ZV ZV
17158 If you discover other use-cases, please add them here as
17160 if (row
->ends_at_zv_p
)
17161 row
->maxpos
= it
->current
.pos
;
17162 else if (row
->used
[TEXT_AREA
])
17164 if (row
->ends_in_newline_from_string_p
)
17165 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17166 else if (CHARPOS (it
->eol_pos
) > 0)
17167 SET_TEXT_POS (row
->maxpos
,
17168 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17169 else if (row
->continued_p
)
17171 /* If max_pos is different from IT's current position, it
17172 means IT->method does not belong to the display element
17173 at max_pos. However, it also means that the display
17174 element at max_pos was displayed in its entirety on this
17175 line, which is equivalent to saying that the next line
17176 starts at the next buffer position. */
17177 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17178 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17181 INC_BOTH (max_pos
, max_bpos
);
17182 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17185 else if (row
->truncated_on_right_p
)
17186 /* display_line already called reseat_at_next_visible_line_start,
17187 which puts the iterator at the beginning of the next line, in
17188 the logical order. */
17189 row
->maxpos
= it
->current
.pos
;
17190 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17191 /* A line that is entirely from a string/image/stretch... */
17192 row
->maxpos
= row
->minpos
;
17197 row
->maxpos
= it
->current
.pos
;
17200 /* Construct the glyph row IT->glyph_row in the desired matrix of
17201 IT->w from text at the current position of IT. See dispextern.h
17202 for an overview of struct it. Value is non-zero if
17203 IT->glyph_row displays text, as opposed to a line displaying ZV
17207 display_line (struct it
*it
)
17209 struct glyph_row
*row
= it
->glyph_row
;
17210 Lisp_Object overlay_arrow_string
;
17212 int may_wrap
= 0, wrap_x
;
17213 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17214 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17215 int wrap_row_extra_line_spacing
;
17216 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17217 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17219 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17221 /* We always start displaying at hpos zero even if hscrolled. */
17222 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17224 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17225 >= it
->w
->desired_matrix
->nrows
)
17227 it
->w
->nrows_scale_factor
++;
17228 fonts_changed_p
= 1;
17232 /* Is IT->w showing the region? */
17233 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17235 /* Clear the result glyph row and enable it. */
17236 prepare_desired_row (row
);
17238 row
->y
= it
->current_y
;
17239 row
->start
= it
->start
;
17240 row
->continuation_lines_width
= it
->continuation_lines_width
;
17241 row
->displays_text_p
= 1;
17242 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17243 it
->starts_in_middle_of_char_p
= 0;
17245 /* Arrange the overlays nicely for our purposes. Usually, we call
17246 display_line on only one line at a time, in which case this
17247 can't really hurt too much, or we call it on lines which appear
17248 one after another in the buffer, in which case all calls to
17249 recenter_overlay_lists but the first will be pretty cheap. */
17250 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17252 /* Move over display elements that are not visible because we are
17253 hscrolled. This may stop at an x-position < IT->first_visible_x
17254 if the first glyph is partially visible or if we hit a line end. */
17255 if (it
->current_x
< it
->first_visible_x
)
17257 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17258 MOVE_TO_POS
| MOVE_TO_X
);
17262 /* We only do this when not calling `move_it_in_display_line_to'
17263 above, because move_it_in_display_line_to calls
17264 handle_line_prefix itself. */
17265 handle_line_prefix (it
);
17268 /* Get the initial row height. This is either the height of the
17269 text hscrolled, if there is any, or zero. */
17270 row
->ascent
= it
->max_ascent
;
17271 row
->height
= it
->max_ascent
+ it
->max_descent
;
17272 row
->phys_ascent
= it
->max_phys_ascent
;
17273 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17274 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17276 /* Utility macro to record max and min buffer positions seen until now. */
17277 #define RECORD_MAX_MIN_POS(IT) \
17280 if (IT_CHARPOS (*(IT)) < min_pos) \
17282 min_pos = IT_CHARPOS (*(IT)); \
17283 min_bpos = IT_BYTEPOS (*(IT)); \
17285 if (IT_CHARPOS (*(IT)) > max_pos) \
17287 max_pos = IT_CHARPOS (*(IT)); \
17288 max_bpos = IT_BYTEPOS (*(IT)); \
17293 /* Loop generating characters. The loop is left with IT on the next
17294 character to display. */
17297 int n_glyphs_before
, hpos_before
, x_before
;
17299 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17301 /* Retrieve the next thing to display. Value is zero if end of
17303 if (!get_next_display_element (it
))
17305 /* Maybe add a space at the end of this line that is used to
17306 display the cursor there under X. Set the charpos of the
17307 first glyph of blank lines not corresponding to any text
17309 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17310 row
->exact_window_width_line_p
= 1;
17311 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17312 || row
->used
[TEXT_AREA
] == 0)
17314 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17315 row
->displays_text_p
= 0;
17317 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17318 && (!MINI_WINDOW_P (it
->w
)
17319 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17320 row
->indicate_empty_line_p
= 1;
17323 it
->continuation_lines_width
= 0;
17324 row
->ends_at_zv_p
= 1;
17325 /* A row that displays right-to-left text must always have
17326 its last face extended all the way to the end of line,
17327 even if this row ends in ZV, because we still write to
17328 the screen left to right. */
17329 if (row
->reversed_p
)
17330 extend_face_to_end_of_line (it
);
17334 /* Now, get the metrics of what we want to display. This also
17335 generates glyphs in `row' (which is IT->glyph_row). */
17336 n_glyphs_before
= row
->used
[TEXT_AREA
];
17339 /* Remember the line height so far in case the next element doesn't
17340 fit on the line. */
17341 if (it
->line_wrap
!= TRUNCATE
)
17343 ascent
= it
->max_ascent
;
17344 descent
= it
->max_descent
;
17345 phys_ascent
= it
->max_phys_ascent
;
17346 phys_descent
= it
->max_phys_descent
;
17348 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17350 if (IT_DISPLAYING_WHITESPACE (it
))
17356 wrap_row_used
= row
->used
[TEXT_AREA
];
17357 wrap_row_ascent
= row
->ascent
;
17358 wrap_row_height
= row
->height
;
17359 wrap_row_phys_ascent
= row
->phys_ascent
;
17360 wrap_row_phys_height
= row
->phys_height
;
17361 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17362 wrap_row_min_pos
= min_pos
;
17363 wrap_row_min_bpos
= min_bpos
;
17364 wrap_row_max_pos
= max_pos
;
17365 wrap_row_max_bpos
= max_bpos
;
17371 PRODUCE_GLYPHS (it
);
17373 /* If this display element was in marginal areas, continue with
17375 if (it
->area
!= TEXT_AREA
)
17377 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17378 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17379 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17380 row
->phys_height
= max (row
->phys_height
,
17381 it
->max_phys_ascent
+ it
->max_phys_descent
);
17382 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17383 it
->max_extra_line_spacing
);
17384 set_iterator_to_next (it
, 1);
17388 /* Does the display element fit on the line? If we truncate
17389 lines, we should draw past the right edge of the window. If
17390 we don't truncate, we want to stop so that we can display the
17391 continuation glyph before the right margin. If lines are
17392 continued, there are two possible strategies for characters
17393 resulting in more than 1 glyph (e.g. tabs): Display as many
17394 glyphs as possible in this line and leave the rest for the
17395 continuation line, or display the whole element in the next
17396 line. Original redisplay did the former, so we do it also. */
17397 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17398 hpos_before
= it
->hpos
;
17401 if (/* Not a newline. */
17403 /* Glyphs produced fit entirely in the line. */
17404 && it
->current_x
< it
->last_visible_x
)
17406 it
->hpos
+= nglyphs
;
17407 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17408 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17409 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17410 row
->phys_height
= max (row
->phys_height
,
17411 it
->max_phys_ascent
+ it
->max_phys_descent
);
17412 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17413 it
->max_extra_line_spacing
);
17414 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17415 row
->x
= x
- it
->first_visible_x
;
17416 /* Record the maximum and minimum buffer positions seen so
17417 far in glyphs that will be displayed by this row. */
17419 RECORD_MAX_MIN_POS (it
);
17424 struct glyph
*glyph
;
17426 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17428 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17429 new_x
= x
+ glyph
->pixel_width
;
17431 if (/* Lines are continued. */
17432 it
->line_wrap
!= TRUNCATE
17433 && (/* Glyph doesn't fit on the line. */
17434 new_x
> it
->last_visible_x
17435 /* Or it fits exactly on a window system frame. */
17436 || (new_x
== it
->last_visible_x
17437 && FRAME_WINDOW_P (it
->f
))))
17439 /* End of a continued line. */
17442 || (new_x
== it
->last_visible_x
17443 && FRAME_WINDOW_P (it
->f
)))
17445 /* Current glyph is the only one on the line or
17446 fits exactly on the line. We must continue
17447 the line because we can't draw the cursor
17448 after the glyph. */
17449 row
->continued_p
= 1;
17450 it
->current_x
= new_x
;
17451 it
->continuation_lines_width
+= new_x
;
17453 /* Record the maximum and minimum buffer
17454 positions seen so far in glyphs that will be
17455 displayed by this row. */
17457 RECORD_MAX_MIN_POS (it
);
17458 if (i
== nglyphs
- 1)
17460 /* If line-wrap is on, check if a previous
17461 wrap point was found. */
17462 if (wrap_row_used
> 0
17463 /* Even if there is a previous wrap
17464 point, continue the line here as
17465 usual, if (i) the previous character
17466 was a space or tab AND (ii) the
17467 current character is not. */
17469 || IT_DISPLAYING_WHITESPACE (it
)))
17472 set_iterator_to_next (it
, 1);
17473 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17475 if (!get_next_display_element (it
))
17477 row
->exact_window_width_line_p
= 1;
17478 it
->continuation_lines_width
= 0;
17479 row
->continued_p
= 0;
17480 row
->ends_at_zv_p
= 1;
17482 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17484 row
->continued_p
= 0;
17485 row
->exact_window_width_line_p
= 1;
17490 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17491 && !FRAME_WINDOW_P (it
->f
))
17493 /* A padding glyph that doesn't fit on this line.
17494 This means the whole character doesn't fit
17496 if (row
->reversed_p
)
17497 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17498 - n_glyphs_before
);
17499 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17501 /* Fill the rest of the row with continuation
17502 glyphs like in 20.x. */
17503 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17504 < row
->glyphs
[1 + TEXT_AREA
])
17505 produce_special_glyphs (it
, IT_CONTINUATION
);
17507 row
->continued_p
= 1;
17508 it
->current_x
= x_before
;
17509 it
->continuation_lines_width
+= x_before
;
17511 /* Restore the height to what it was before the
17512 element not fitting on the line. */
17513 it
->max_ascent
= ascent
;
17514 it
->max_descent
= descent
;
17515 it
->max_phys_ascent
= phys_ascent
;
17516 it
->max_phys_descent
= phys_descent
;
17518 else if (wrap_row_used
> 0)
17521 if (row
->reversed_p
)
17522 unproduce_glyphs (it
,
17523 row
->used
[TEXT_AREA
] - wrap_row_used
);
17525 it
->continuation_lines_width
+= wrap_x
;
17526 row
->used
[TEXT_AREA
] = wrap_row_used
;
17527 row
->ascent
= wrap_row_ascent
;
17528 row
->height
= wrap_row_height
;
17529 row
->phys_ascent
= wrap_row_phys_ascent
;
17530 row
->phys_height
= wrap_row_phys_height
;
17531 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17532 min_pos
= wrap_row_min_pos
;
17533 min_bpos
= wrap_row_min_bpos
;
17534 max_pos
= wrap_row_max_pos
;
17535 max_bpos
= wrap_row_max_bpos
;
17536 row
->continued_p
= 1;
17537 row
->ends_at_zv_p
= 0;
17538 row
->exact_window_width_line_p
= 0;
17539 it
->continuation_lines_width
+= x
;
17541 /* Make sure that a non-default face is extended
17542 up to the right margin of the window. */
17543 extend_face_to_end_of_line (it
);
17545 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17547 /* A TAB that extends past the right edge of the
17548 window. This produces a single glyph on
17549 window system frames. We leave the glyph in
17550 this row and let it fill the row, but don't
17551 consume the TAB. */
17552 it
->continuation_lines_width
+= it
->last_visible_x
;
17553 row
->ends_in_middle_of_char_p
= 1;
17554 row
->continued_p
= 1;
17555 glyph
->pixel_width
= it
->last_visible_x
- x
;
17556 it
->starts_in_middle_of_char_p
= 1;
17560 /* Something other than a TAB that draws past
17561 the right edge of the window. Restore
17562 positions to values before the element. */
17563 if (row
->reversed_p
)
17564 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17565 - (n_glyphs_before
+ i
));
17566 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17568 /* Display continuation glyphs. */
17569 if (!FRAME_WINDOW_P (it
->f
))
17570 produce_special_glyphs (it
, IT_CONTINUATION
);
17571 row
->continued_p
= 1;
17573 it
->current_x
= x_before
;
17574 it
->continuation_lines_width
+= x
;
17575 extend_face_to_end_of_line (it
);
17577 if (nglyphs
> 1 && i
> 0)
17579 row
->ends_in_middle_of_char_p
= 1;
17580 it
->starts_in_middle_of_char_p
= 1;
17583 /* Restore the height to what it was before the
17584 element not fitting on the line. */
17585 it
->max_ascent
= ascent
;
17586 it
->max_descent
= descent
;
17587 it
->max_phys_ascent
= phys_ascent
;
17588 it
->max_phys_descent
= phys_descent
;
17593 else if (new_x
> it
->first_visible_x
)
17595 /* Increment number of glyphs actually displayed. */
17598 /* Record the maximum and minimum buffer positions
17599 seen so far in glyphs that will be displayed by
17602 RECORD_MAX_MIN_POS (it
);
17604 if (x
< it
->first_visible_x
)
17605 /* Glyph is partially visible, i.e. row starts at
17606 negative X position. */
17607 row
->x
= x
- it
->first_visible_x
;
17611 /* Glyph is completely off the left margin of the
17612 window. This should not happen because of the
17613 move_it_in_display_line at the start of this
17614 function, unless the text display area of the
17615 window is empty. */
17616 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17620 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17621 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17622 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17623 row
->phys_height
= max (row
->phys_height
,
17624 it
->max_phys_ascent
+ it
->max_phys_descent
);
17625 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17626 it
->max_extra_line_spacing
);
17628 /* End of this display line if row is continued. */
17629 if (row
->continued_p
|| row
->ends_at_zv_p
)
17634 /* Is this a line end? If yes, we're also done, after making
17635 sure that a non-default face is extended up to the right
17636 margin of the window. */
17637 if (ITERATOR_AT_END_OF_LINE_P (it
))
17639 int used_before
= row
->used
[TEXT_AREA
];
17641 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17643 /* Add a space at the end of the line that is used to
17644 display the cursor there. */
17645 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17646 append_space_for_newline (it
, 0);
17648 /* Extend the face to the end of the line. */
17649 extend_face_to_end_of_line (it
);
17651 /* Make sure we have the position. */
17652 if (used_before
== 0)
17653 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17655 /* Record the position of the newline, for use in
17657 it
->eol_pos
= it
->current
.pos
;
17659 /* Consume the line end. This skips over invisible lines. */
17660 set_iterator_to_next (it
, 1);
17661 it
->continuation_lines_width
= 0;
17665 /* Proceed with next display element. Note that this skips
17666 over lines invisible because of selective display. */
17667 set_iterator_to_next (it
, 1);
17669 /* If we truncate lines, we are done when the last displayed
17670 glyphs reach past the right margin of the window. */
17671 if (it
->line_wrap
== TRUNCATE
17672 && (FRAME_WINDOW_P (it
->f
)
17673 ? (it
->current_x
>= it
->last_visible_x
)
17674 : (it
->current_x
> it
->last_visible_x
)))
17676 /* Maybe add truncation glyphs. */
17677 if (!FRAME_WINDOW_P (it
->f
))
17681 if (!row
->reversed_p
)
17683 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17684 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17689 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17690 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17692 /* Remove any padding glyphs at the front of ROW, to
17693 make room for the truncation glyphs we will be
17694 adding below. The loop below always inserts at
17695 least one truncation glyph, so also remove the
17696 last glyph added to ROW. */
17697 unproduce_glyphs (it
, i
+ 1);
17698 /* Adjust i for the loop below. */
17699 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17702 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17704 row
->used
[TEXT_AREA
] = i
;
17705 produce_special_glyphs (it
, IT_TRUNCATION
);
17708 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17710 /* Don't truncate if we can overflow newline into fringe. */
17711 if (!get_next_display_element (it
))
17713 it
->continuation_lines_width
= 0;
17714 row
->ends_at_zv_p
= 1;
17715 row
->exact_window_width_line_p
= 1;
17718 if (ITERATOR_AT_END_OF_LINE_P (it
))
17720 row
->exact_window_width_line_p
= 1;
17721 goto at_end_of_line
;
17725 row
->truncated_on_right_p
= 1;
17726 it
->continuation_lines_width
= 0;
17727 reseat_at_next_visible_line_start (it
, 0);
17728 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17729 it
->hpos
= hpos_before
;
17730 it
->current_x
= x_before
;
17735 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17736 at the left window margin. */
17737 if (it
->first_visible_x
17738 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17740 if (!FRAME_WINDOW_P (it
->f
))
17741 insert_left_trunc_glyphs (it
);
17742 row
->truncated_on_left_p
= 1;
17745 /* Remember the position at which this line ends.
17747 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17748 cannot be before the call to find_row_edges below, since that is
17749 where these positions are determined. */
17750 row
->end
= it
->current
;
17753 row
->minpos
= row
->start
.pos
;
17754 row
->maxpos
= row
->end
.pos
;
17758 /* ROW->minpos and ROW->maxpos must be the smallest and
17759 `1 + the largest' buffer positions in ROW. But if ROW was
17760 bidi-reordered, these two positions can be anywhere in the
17761 row, so we must determine them now. */
17762 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17765 /* If the start of this line is the overlay arrow-position, then
17766 mark this glyph row as the one containing the overlay arrow.
17767 This is clearly a mess with variable size fonts. It would be
17768 better to let it be displayed like cursors under X. */
17769 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17770 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17771 !NILP (overlay_arrow_string
)))
17773 /* Overlay arrow in window redisplay is a fringe bitmap. */
17774 if (STRINGP (overlay_arrow_string
))
17776 struct glyph_row
*arrow_row
17777 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17778 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17779 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17780 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17781 struct glyph
*p2
, *end
;
17783 /* Copy the arrow glyphs. */
17784 while (glyph
< arrow_end
)
17787 /* Throw away padding glyphs. */
17789 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17790 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17796 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17801 xassert (INTEGERP (overlay_arrow_string
));
17802 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17804 overlay_arrow_seen
= 1;
17807 /* Compute pixel dimensions of this line. */
17808 compute_line_metrics (it
);
17810 /* Record whether this row ends inside an ellipsis. */
17811 row
->ends_in_ellipsis_p
17812 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17813 && it
->ellipsis_p
);
17815 /* Save fringe bitmaps in this row. */
17816 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17817 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17818 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17819 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17821 it
->left_user_fringe_bitmap
= 0;
17822 it
->left_user_fringe_face_id
= 0;
17823 it
->right_user_fringe_bitmap
= 0;
17824 it
->right_user_fringe_face_id
= 0;
17826 /* Maybe set the cursor. */
17827 cvpos
= it
->w
->cursor
.vpos
;
17829 /* In bidi-reordered rows, keep checking for proper cursor
17830 position even if one has been found already, because buffer
17831 positions in such rows change non-linearly with ROW->VPOS,
17832 when a line is continued. One exception: when we are at ZV,
17833 display cursor on the first suitable glyph row, since all
17834 the empty rows after that also have their position set to ZV. */
17835 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17836 lines' rows is implemented for bidi-reordered rows. */
17838 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17839 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17840 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17841 && cursor_row_p (it
->w
, row
))
17842 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17844 /* Highlight trailing whitespace. */
17845 if (!NILP (Vshow_trailing_whitespace
))
17846 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17848 /* Prepare for the next line. This line starts horizontally at (X
17849 HPOS) = (0 0). Vertical positions are incremented. As a
17850 convenience for the caller, IT->glyph_row is set to the next
17852 it
->current_x
= it
->hpos
= 0;
17853 it
->current_y
+= row
->height
;
17854 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17857 /* The next row should by default use the same value of the
17858 reversed_p flag as this one. set_iterator_to_next decides when
17859 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17860 the flag accordingly. */
17861 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17862 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17863 it
->start
= row
->end
;
17864 return row
->displays_text_p
;
17866 #undef RECORD_MAX_MIN_POS
17869 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17870 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17871 doc
: /* Return paragraph direction at point in BUFFER.
17872 Value is either `left-to-right' or `right-to-left'.
17873 If BUFFER is omitted or nil, it defaults to the current buffer.
17875 Paragraph direction determines how the text in the paragraph is displayed.
17876 In left-to-right paragraphs, text begins at the left margin of the window
17877 and the reading direction is generally left to right. In right-to-left
17878 paragraphs, text begins at the right margin and is read from right to left.
17880 See also `bidi-paragraph-direction'. */)
17881 (Lisp_Object buffer
)
17883 struct buffer
*buf
;
17884 struct buffer
*old
;
17887 buf
= current_buffer
;
17890 CHECK_BUFFER (buffer
);
17891 buf
= XBUFFER (buffer
);
17892 old
= current_buffer
;
17895 if (NILP (buf
->bidi_display_reordering
))
17896 return Qleft_to_right
;
17897 else if (!NILP (buf
->bidi_paragraph_direction
))
17898 return buf
->bidi_paragraph_direction
;
17901 /* Determine the direction from buffer text. We could try to
17902 use current_matrix if it is up to date, but this seems fast
17903 enough as it is. */
17904 struct bidi_it itb
;
17905 EMACS_INT pos
= BUF_PT (buf
);
17906 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17909 if (buf
!= current_buffer
)
17910 set_buffer_temp (buf
);
17911 /* bidi_paragraph_init finds the base direction of the paragraph
17912 by searching forward from paragraph start. We need the base
17913 direction of the current or _previous_ paragraph, so we need
17914 to make sure we are within that paragraph. To that end, find
17915 the previous non-empty line. */
17916 if (pos
>= ZV
&& pos
> BEGV
)
17919 bytepos
= CHAR_TO_BYTE (pos
);
17921 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17922 || c
== ' ' || c
== '\t' || c
== '\f')
17924 if (bytepos
<= BEGV_BYTE
)
17929 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17932 itb
.bytepos
= bytepos
;
17934 itb
.separator_limit
= -1;
17935 itb
.paragraph_dir
= NEUTRAL_DIR
;
17937 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
17938 if (buf
!= current_buffer
)
17939 set_buffer_temp (old
);
17940 switch (itb
.paragraph_dir
)
17943 return Qleft_to_right
;
17946 return Qright_to_left
;
17956 /***********************************************************************
17958 ***********************************************************************/
17960 /* Redisplay the menu bar in the frame for window W.
17962 The menu bar of X frames that don't have X toolkit support is
17963 displayed in a special window W->frame->menu_bar_window.
17965 The menu bar of terminal frames is treated specially as far as
17966 glyph matrices are concerned. Menu bar lines are not part of
17967 windows, so the update is done directly on the frame matrix rows
17968 for the menu bar. */
17971 display_menu_bar (struct window
*w
)
17973 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17978 /* Don't do all this for graphical frames. */
17980 if (FRAME_W32_P (f
))
17983 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17989 if (FRAME_NS_P (f
))
17991 #endif /* HAVE_NS */
17993 #ifdef USE_X_TOOLKIT
17994 xassert (!FRAME_WINDOW_P (f
));
17995 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17996 it
.first_visible_x
= 0;
17997 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17998 #else /* not USE_X_TOOLKIT */
17999 if (FRAME_WINDOW_P (f
))
18001 /* Menu bar lines are displayed in the desired matrix of the
18002 dummy window menu_bar_window. */
18003 struct window
*menu_w
;
18004 xassert (WINDOWP (f
->menu_bar_window
));
18005 menu_w
= XWINDOW (f
->menu_bar_window
);
18006 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18008 it
.first_visible_x
= 0;
18009 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18013 /* This is a TTY frame, i.e. character hpos/vpos are used as
18015 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18017 it
.first_visible_x
= 0;
18018 it
.last_visible_x
= FRAME_COLS (f
);
18020 #endif /* not USE_X_TOOLKIT */
18022 if (! mode_line_inverse_video
)
18023 /* Force the menu-bar to be displayed in the default face. */
18024 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18026 /* Clear all rows of the menu bar. */
18027 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18029 struct glyph_row
*row
= it
.glyph_row
+ i
;
18030 clear_glyph_row (row
);
18031 row
->enabled_p
= 1;
18032 row
->full_width_p
= 1;
18035 /* Display all items of the menu bar. */
18036 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18037 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18039 Lisp_Object string
;
18041 /* Stop at nil string. */
18042 string
= AREF (items
, i
+ 1);
18046 /* Remember where item was displayed. */
18047 ASET (items
, i
+ 3, make_number (it
.hpos
));
18049 /* Display the item, pad with one space. */
18050 if (it
.current_x
< it
.last_visible_x
)
18051 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18052 SCHARS (string
) + 1, 0, 0, -1);
18055 /* Fill out the line with spaces. */
18056 if (it
.current_x
< it
.last_visible_x
)
18057 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18059 /* Compute the total height of the lines. */
18060 compute_line_metrics (&it
);
18065 /***********************************************************************
18067 ***********************************************************************/
18069 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18070 FORCE is non-zero, redisplay mode lines unconditionally.
18071 Otherwise, redisplay only mode lines that are garbaged. Value is
18072 the number of windows whose mode lines were redisplayed. */
18075 redisplay_mode_lines (Lisp_Object window
, int force
)
18079 while (!NILP (window
))
18081 struct window
*w
= XWINDOW (window
);
18083 if (WINDOWP (w
->hchild
))
18084 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18085 else if (WINDOWP (w
->vchild
))
18086 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18088 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18089 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18091 struct text_pos lpoint
;
18092 struct buffer
*old
= current_buffer
;
18094 /* Set the window's buffer for the mode line display. */
18095 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18096 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18098 /* Point refers normally to the selected window. For any
18099 other window, set up appropriate value. */
18100 if (!EQ (window
, selected_window
))
18102 struct text_pos pt
;
18104 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18105 if (CHARPOS (pt
) < BEGV
)
18106 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18107 else if (CHARPOS (pt
) > (ZV
- 1))
18108 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18110 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18113 /* Display mode lines. */
18114 clear_glyph_matrix (w
->desired_matrix
);
18115 if (display_mode_lines (w
))
18118 w
->must_be_updated_p
= 1;
18121 /* Restore old settings. */
18122 set_buffer_internal_1 (old
);
18123 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18133 /* Display the mode and/or header line of window W. Value is the
18134 sum number of mode lines and header lines displayed. */
18137 display_mode_lines (struct window
*w
)
18139 Lisp_Object old_selected_window
, old_selected_frame
;
18142 old_selected_frame
= selected_frame
;
18143 selected_frame
= w
->frame
;
18144 old_selected_window
= selected_window
;
18145 XSETWINDOW (selected_window
, w
);
18147 /* These will be set while the mode line specs are processed. */
18148 line_number_displayed
= 0;
18149 w
->column_number_displayed
= Qnil
;
18151 if (WINDOW_WANTS_MODELINE_P (w
))
18153 struct window
*sel_w
= XWINDOW (old_selected_window
);
18155 /* Select mode line face based on the real selected window. */
18156 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18157 current_buffer
->mode_line_format
);
18161 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18163 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18164 current_buffer
->header_line_format
);
18168 selected_frame
= old_selected_frame
;
18169 selected_window
= old_selected_window
;
18174 /* Display mode or header line of window W. FACE_ID specifies which
18175 line to display; it is either MODE_LINE_FACE_ID or
18176 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18177 display. Value is the pixel height of the mode/header line
18181 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18185 int count
= SPECPDL_INDEX ();
18187 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18188 /* Don't extend on a previously drawn mode-line.
18189 This may happen if called from pos_visible_p. */
18190 it
.glyph_row
->enabled_p
= 0;
18191 prepare_desired_row (it
.glyph_row
);
18193 it
.glyph_row
->mode_line_p
= 1;
18195 if (! mode_line_inverse_video
)
18196 /* Force the mode-line to be displayed in the default face. */
18197 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18199 record_unwind_protect (unwind_format_mode_line
,
18200 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18202 mode_line_target
= MODE_LINE_DISPLAY
;
18204 /* Temporarily make frame's keyboard the current kboard so that
18205 kboard-local variables in the mode_line_format will get the right
18207 push_kboard (FRAME_KBOARD (it
.f
));
18208 record_unwind_save_match_data ();
18209 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18212 unbind_to (count
, Qnil
);
18214 /* Fill up with spaces. */
18215 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18217 compute_line_metrics (&it
);
18218 it
.glyph_row
->full_width_p
= 1;
18219 it
.glyph_row
->continued_p
= 0;
18220 it
.glyph_row
->truncated_on_left_p
= 0;
18221 it
.glyph_row
->truncated_on_right_p
= 0;
18223 /* Make a 3D mode-line have a shadow at its right end. */
18224 face
= FACE_FROM_ID (it
.f
, face_id
);
18225 extend_face_to_end_of_line (&it
);
18226 if (face
->box
!= FACE_NO_BOX
)
18228 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18229 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18230 last
->right_box_line_p
= 1;
18233 return it
.glyph_row
->height
;
18236 /* Move element ELT in LIST to the front of LIST.
18237 Return the updated list. */
18240 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18242 register Lisp_Object tail
, prev
;
18243 register Lisp_Object tem
;
18247 while (CONSP (tail
))
18253 /* Splice out the link TAIL. */
18255 list
= XCDR (tail
);
18257 Fsetcdr (prev
, XCDR (tail
));
18259 /* Now make it the first. */
18260 Fsetcdr (tail
, list
);
18265 tail
= XCDR (tail
);
18269 /* Not found--return unchanged LIST. */
18273 /* Contribute ELT to the mode line for window IT->w. How it
18274 translates into text depends on its data type.
18276 IT describes the display environment in which we display, as usual.
18278 DEPTH is the depth in recursion. It is used to prevent
18279 infinite recursion here.
18281 FIELD_WIDTH is the number of characters the display of ELT should
18282 occupy in the mode line, and PRECISION is the maximum number of
18283 characters to display from ELT's representation. See
18284 display_string for details.
18286 Returns the hpos of the end of the text generated by ELT.
18288 PROPS is a property list to add to any string we encounter.
18290 If RISKY is nonzero, remove (disregard) any properties in any string
18291 we encounter, and ignore :eval and :propertize.
18293 The global variable `mode_line_target' determines whether the
18294 output is passed to `store_mode_line_noprop',
18295 `store_mode_line_string', or `display_string'. */
18298 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18299 Lisp_Object elt
, Lisp_Object props
, int risky
)
18301 int n
= 0, field
, prec
;
18306 elt
= build_string ("*too-deep*");
18310 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18314 /* A string: output it and check for %-constructs within it. */
18316 EMACS_INT offset
= 0;
18318 if (SCHARS (elt
) > 0
18319 && (!NILP (props
) || risky
))
18321 Lisp_Object oprops
, aelt
;
18322 oprops
= Ftext_properties_at (make_number (0), elt
);
18324 /* If the starting string's properties are not what
18325 we want, translate the string. Also, if the string
18326 is risky, do that anyway. */
18328 if (NILP (Fequal (props
, oprops
)) || risky
)
18330 /* If the starting string has properties,
18331 merge the specified ones onto the existing ones. */
18332 if (! NILP (oprops
) && !risky
)
18336 oprops
= Fcopy_sequence (oprops
);
18338 while (CONSP (tem
))
18340 oprops
= Fplist_put (oprops
, XCAR (tem
),
18341 XCAR (XCDR (tem
)));
18342 tem
= XCDR (XCDR (tem
));
18347 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18348 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18350 /* AELT is what we want. Move it to the front
18351 without consing. */
18353 mode_line_proptrans_alist
18354 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18360 /* If AELT has the wrong props, it is useless.
18361 so get rid of it. */
18363 mode_line_proptrans_alist
18364 = Fdelq (aelt
, mode_line_proptrans_alist
);
18366 elt
= Fcopy_sequence (elt
);
18367 Fset_text_properties (make_number (0), Flength (elt
),
18369 /* Add this item to mode_line_proptrans_alist. */
18370 mode_line_proptrans_alist
18371 = Fcons (Fcons (elt
, props
),
18372 mode_line_proptrans_alist
);
18373 /* Truncate mode_line_proptrans_alist
18374 to at most 50 elements. */
18375 tem
= Fnthcdr (make_number (50),
18376 mode_line_proptrans_alist
);
18378 XSETCDR (tem
, Qnil
);
18387 prec
= precision
- n
;
18388 switch (mode_line_target
)
18390 case MODE_LINE_NOPROP
:
18391 case MODE_LINE_TITLE
:
18392 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18394 case MODE_LINE_STRING
:
18395 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18397 case MODE_LINE_DISPLAY
:
18398 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18399 0, prec
, 0, STRING_MULTIBYTE (elt
));
18406 /* Handle the non-literal case. */
18408 while ((precision
<= 0 || n
< precision
)
18409 && SREF (elt
, offset
) != 0
18410 && (mode_line_target
!= MODE_LINE_DISPLAY
18411 || it
->current_x
< it
->last_visible_x
))
18413 EMACS_INT last_offset
= offset
;
18415 /* Advance to end of string or next format specifier. */
18416 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18419 if (offset
- 1 != last_offset
)
18421 EMACS_INT nchars
, nbytes
;
18423 /* Output to end of string or up to '%'. Field width
18424 is length of string. Don't output more than
18425 PRECISION allows us. */
18428 prec
= c_string_width (SDATA (elt
) + last_offset
,
18429 offset
- last_offset
, precision
- n
,
18432 switch (mode_line_target
)
18434 case MODE_LINE_NOPROP
:
18435 case MODE_LINE_TITLE
:
18436 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18438 case MODE_LINE_STRING
:
18440 EMACS_INT bytepos
= last_offset
;
18441 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18442 EMACS_INT endpos
= (precision
<= 0
18443 ? string_byte_to_char (elt
, offset
)
18444 : charpos
+ nchars
);
18446 n
+= store_mode_line_string (NULL
,
18447 Fsubstring (elt
, make_number (charpos
),
18448 make_number (endpos
)),
18452 case MODE_LINE_DISPLAY
:
18454 EMACS_INT bytepos
= last_offset
;
18455 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18457 if (precision
<= 0)
18458 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18459 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18461 STRING_MULTIBYTE (elt
));
18466 else /* c == '%' */
18468 EMACS_INT percent_position
= offset
;
18470 /* Get the specified minimum width. Zero means
18473 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18474 field
= field
* 10 + c
- '0';
18476 /* Don't pad beyond the total padding allowed. */
18477 if (field_width
- n
> 0 && field
> field_width
- n
)
18478 field
= field_width
- n
;
18480 /* Note that either PRECISION <= 0 or N < PRECISION. */
18481 prec
= precision
- n
;
18484 n
+= display_mode_element (it
, depth
, field
, prec
,
18485 Vglobal_mode_string
, props
,
18490 EMACS_INT bytepos
, charpos
;
18491 const unsigned char *spec
;
18492 Lisp_Object string
;
18494 bytepos
= percent_position
;
18495 charpos
= (STRING_MULTIBYTE (elt
)
18496 ? string_byte_to_char (elt
, bytepos
)
18498 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18499 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18501 switch (mode_line_target
)
18503 case MODE_LINE_NOPROP
:
18504 case MODE_LINE_TITLE
:
18505 n
+= store_mode_line_noprop (spec
, field
, prec
);
18507 case MODE_LINE_STRING
:
18509 int len
= strlen (spec
);
18510 Lisp_Object tem
= make_string (spec
, len
);
18511 props
= Ftext_properties_at (make_number (charpos
), elt
);
18512 /* Should only keep face property in props */
18513 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18516 case MODE_LINE_DISPLAY
:
18518 int nglyphs_before
, nwritten
;
18520 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18521 nwritten
= display_string (spec
, string
, elt
,
18526 /* Assign to the glyphs written above the
18527 string where the `%x' came from, position
18531 struct glyph
*glyph
18532 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18536 for (i
= 0; i
< nwritten
; ++i
)
18538 glyph
[i
].object
= elt
;
18539 glyph
[i
].charpos
= charpos
;
18556 /* A symbol: process the value of the symbol recursively
18557 as if it appeared here directly. Avoid error if symbol void.
18558 Special case: if value of symbol is a string, output the string
18561 register Lisp_Object tem
;
18563 /* If the variable is not marked as risky to set
18564 then its contents are risky to use. */
18565 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18568 tem
= Fboundp (elt
);
18571 tem
= Fsymbol_value (elt
);
18572 /* If value is a string, output that string literally:
18573 don't check for % within it. */
18577 if (!EQ (tem
, elt
))
18579 /* Give up right away for nil or t. */
18589 register Lisp_Object car
, tem
;
18591 /* A cons cell: five distinct cases.
18592 If first element is :eval or :propertize, do something special.
18593 If first element is a string or a cons, process all the elements
18594 and effectively concatenate them.
18595 If first element is a negative number, truncate displaying cdr to
18596 at most that many characters. If positive, pad (with spaces)
18597 to at least that many characters.
18598 If first element is a symbol, process the cadr or caddr recursively
18599 according to whether the symbol's value is non-nil or nil. */
18601 if (EQ (car
, QCeval
))
18603 /* An element of the form (:eval FORM) means evaluate FORM
18604 and use the result as mode line elements. */
18609 if (CONSP (XCDR (elt
)))
18612 spec
= safe_eval (XCAR (XCDR (elt
)));
18613 n
+= display_mode_element (it
, depth
, field_width
- n
,
18614 precision
- n
, spec
, props
,
18618 else if (EQ (car
, QCpropertize
))
18620 /* An element of the form (:propertize ELT PROPS...)
18621 means display ELT but applying properties PROPS. */
18626 if (CONSP (XCDR (elt
)))
18627 n
+= display_mode_element (it
, depth
, field_width
- n
,
18628 precision
- n
, XCAR (XCDR (elt
)),
18629 XCDR (XCDR (elt
)), risky
);
18631 else if (SYMBOLP (car
))
18633 tem
= Fboundp (car
);
18637 /* elt is now the cdr, and we know it is a cons cell.
18638 Use its car if CAR has a non-nil value. */
18641 tem
= Fsymbol_value (car
);
18648 /* Symbol's value is nil (or symbol is unbound)
18649 Get the cddr of the original list
18650 and if possible find the caddr and use that. */
18654 else if (!CONSP (elt
))
18659 else if (INTEGERP (car
))
18661 register int lim
= XINT (car
);
18665 /* Negative int means reduce maximum width. */
18666 if (precision
<= 0)
18669 precision
= min (precision
, -lim
);
18673 /* Padding specified. Don't let it be more than
18674 current maximum. */
18676 lim
= min (precision
, lim
);
18678 /* If that's more padding than already wanted, queue it.
18679 But don't reduce padding already specified even if
18680 that is beyond the current truncation point. */
18681 field_width
= max (lim
, field_width
);
18685 else if (STRINGP (car
) || CONSP (car
))
18687 Lisp_Object halftail
= elt
;
18691 && (precision
<= 0 || n
< precision
))
18693 n
+= display_mode_element (it
, depth
,
18694 /* Do padding only after the last
18695 element in the list. */
18696 (! CONSP (XCDR (elt
))
18699 precision
- n
, XCAR (elt
),
18703 if ((len
& 1) == 0)
18704 halftail
= XCDR (halftail
);
18705 /* Check for cycle. */
18706 if (EQ (halftail
, elt
))
18715 elt
= build_string ("*invalid*");
18719 /* Pad to FIELD_WIDTH. */
18720 if (field_width
> 0 && n
< field_width
)
18722 switch (mode_line_target
)
18724 case MODE_LINE_NOPROP
:
18725 case MODE_LINE_TITLE
:
18726 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18728 case MODE_LINE_STRING
:
18729 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18731 case MODE_LINE_DISPLAY
:
18732 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18741 /* Store a mode-line string element in mode_line_string_list.
18743 If STRING is non-null, display that C string. Otherwise, the Lisp
18744 string LISP_STRING is displayed.
18746 FIELD_WIDTH is the minimum number of output glyphs to produce.
18747 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18748 with spaces. FIELD_WIDTH <= 0 means don't pad.
18750 PRECISION is the maximum number of characters to output from
18751 STRING. PRECISION <= 0 means don't truncate the string.
18753 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18754 properties to the string.
18756 PROPS are the properties to add to the string.
18757 The mode_line_string_face face property is always added to the string.
18761 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18762 int field_width
, int precision
, Lisp_Object props
)
18767 if (string
!= NULL
)
18769 len
= strlen (string
);
18770 if (precision
> 0 && len
> precision
)
18772 lisp_string
= make_string (string
, len
);
18774 props
= mode_line_string_face_prop
;
18775 else if (!NILP (mode_line_string_face
))
18777 Lisp_Object face
= Fplist_get (props
, Qface
);
18778 props
= Fcopy_sequence (props
);
18780 face
= mode_line_string_face
;
18782 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18783 props
= Fplist_put (props
, Qface
, face
);
18785 Fadd_text_properties (make_number (0), make_number (len
),
18786 props
, lisp_string
);
18790 len
= XFASTINT (Flength (lisp_string
));
18791 if (precision
> 0 && len
> precision
)
18794 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18797 if (!NILP (mode_line_string_face
))
18801 props
= Ftext_properties_at (make_number (0), lisp_string
);
18802 face
= Fplist_get (props
, Qface
);
18804 face
= mode_line_string_face
;
18806 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18807 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18809 lisp_string
= Fcopy_sequence (lisp_string
);
18812 Fadd_text_properties (make_number (0), make_number (len
),
18813 props
, lisp_string
);
18818 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18822 if (field_width
> len
)
18824 field_width
-= len
;
18825 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18827 Fadd_text_properties (make_number (0), make_number (field_width
),
18828 props
, lisp_string
);
18829 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18837 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18839 doc
: /* Format a string out of a mode line format specification.
18840 First arg FORMAT specifies the mode line format (see `mode-line-format'
18841 for details) to use.
18843 By default, the format is evaluated for the currently selected window.
18845 Optional second arg FACE specifies the face property to put on all
18846 characters for which no face is specified. The value nil means the
18847 default face. The value t means whatever face the window's mode line
18848 currently uses (either `mode-line' or `mode-line-inactive',
18849 depending on whether the window is the selected window or not).
18850 An integer value means the value string has no text
18853 Optional third and fourth args WINDOW and BUFFER specify the window
18854 and buffer to use as the context for the formatting (defaults
18855 are the selected window and the WINDOW's buffer). */)
18856 (Lisp_Object format
, Lisp_Object face
,
18857 Lisp_Object window
, Lisp_Object buffer
)
18862 struct buffer
*old_buffer
= NULL
;
18864 int no_props
= INTEGERP (face
);
18865 int count
= SPECPDL_INDEX ();
18867 int string_start
= 0;
18870 window
= selected_window
;
18871 CHECK_WINDOW (window
);
18872 w
= XWINDOW (window
);
18875 buffer
= w
->buffer
;
18876 CHECK_BUFFER (buffer
);
18878 /* Make formatting the modeline a non-op when noninteractive, otherwise
18879 there will be problems later caused by a partially initialized frame. */
18880 if (NILP (format
) || noninteractive
)
18881 return empty_unibyte_string
;
18886 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18887 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18888 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18889 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18890 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18891 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18892 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18895 if (XBUFFER (buffer
) != current_buffer
)
18896 old_buffer
= current_buffer
;
18898 /* Save things including mode_line_proptrans_alist,
18899 and set that to nil so that we don't alter the outer value. */
18900 record_unwind_protect (unwind_format_mode_line
,
18901 format_mode_line_unwind_data
18902 (old_buffer
, selected_window
, 1));
18903 mode_line_proptrans_alist
= Qnil
;
18905 Fselect_window (window
, Qt
);
18907 set_buffer_internal_1 (XBUFFER (buffer
));
18909 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18913 mode_line_target
= MODE_LINE_NOPROP
;
18914 mode_line_string_face_prop
= Qnil
;
18915 mode_line_string_list
= Qnil
;
18916 string_start
= MODE_LINE_NOPROP_LEN (0);
18920 mode_line_target
= MODE_LINE_STRING
;
18921 mode_line_string_list
= Qnil
;
18922 mode_line_string_face
= face
;
18923 mode_line_string_face_prop
18924 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18927 push_kboard (FRAME_KBOARD (it
.f
));
18928 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18933 len
= MODE_LINE_NOPROP_LEN (string_start
);
18934 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18938 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18939 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18940 empty_unibyte_string
);
18943 unbind_to (count
, Qnil
);
18947 /* Write a null-terminated, right justified decimal representation of
18948 the positive integer D to BUF using a minimal field width WIDTH. */
18951 pint2str (register char *buf
, register int width
, register int d
)
18953 register char *p
= buf
;
18961 *p
++ = d
% 10 + '0';
18966 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18977 /* Write a null-terminated, right justified decimal and "human
18978 readable" representation of the nonnegative integer D to BUF using
18979 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18981 static const char power_letter
[] =
18995 pint2hrstr (char *buf
, int width
, int d
)
18997 /* We aim to represent the nonnegative integer D as
18998 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19001 /* -1 means: do not use TENTHS. */
19005 /* Length of QUOTIENT.TENTHS as a string. */
19011 if (1000 <= quotient
)
19013 /* Scale to the appropriate EXPONENT. */
19016 remainder
= quotient
% 1000;
19020 while (1000 <= quotient
);
19022 /* Round to nearest and decide whether to use TENTHS or not. */
19025 tenths
= remainder
/ 100;
19026 if (50 <= remainder
% 100)
19033 if (quotient
== 10)
19041 if (500 <= remainder
)
19043 if (quotient
< 999)
19054 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19055 if (tenths
== -1 && quotient
<= 99)
19062 p
= psuffix
= buf
+ max (width
, length
);
19064 /* Print EXPONENT. */
19066 *psuffix
++ = power_letter
[exponent
];
19069 /* Print TENTHS. */
19072 *--p
= '0' + tenths
;
19076 /* Print QUOTIENT. */
19079 int digit
= quotient
% 10;
19080 *--p
= '0' + digit
;
19082 while ((quotient
/= 10) != 0);
19084 /* Print leading spaces. */
19089 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19090 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19091 type of CODING_SYSTEM. Return updated pointer into BUF. */
19093 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19096 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19099 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19100 const unsigned char *eol_str
;
19102 /* The EOL conversion we are using. */
19103 Lisp_Object eoltype
;
19105 val
= CODING_SYSTEM_SPEC (coding_system
);
19108 if (!VECTORP (val
)) /* Not yet decided. */
19113 eoltype
= eol_mnemonic_undecided
;
19114 /* Don't mention EOL conversion if it isn't decided. */
19119 Lisp_Object eolvalue
;
19121 attrs
= AREF (val
, 0);
19122 eolvalue
= AREF (val
, 2);
19125 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19129 /* The EOL conversion that is normal on this system. */
19131 if (NILP (eolvalue
)) /* Not yet decided. */
19132 eoltype
= eol_mnemonic_undecided
;
19133 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19134 eoltype
= eol_mnemonic_undecided
;
19135 else /* eolvalue is Qunix, Qdos, or Qmac. */
19136 eoltype
= (EQ (eolvalue
, Qunix
)
19137 ? eol_mnemonic_unix
19138 : (EQ (eolvalue
, Qdos
) == 1
19139 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19145 /* Mention the EOL conversion if it is not the usual one. */
19146 if (STRINGP (eoltype
))
19148 eol_str
= SDATA (eoltype
);
19149 eol_str_len
= SBYTES (eoltype
);
19151 else if (CHARACTERP (eoltype
))
19153 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19154 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19159 eol_str
= invalid_eol_type
;
19160 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19162 memcpy (buf
, eol_str
, eol_str_len
);
19163 buf
+= eol_str_len
;
19169 /* Return a string for the output of a mode line %-spec for window W,
19170 generated by character C. PRECISION >= 0 means don't return a
19171 string longer than that value. FIELD_WIDTH > 0 means pad the
19172 string returned with spaces to that value. Return a Lisp string in
19173 *STRING if the resulting string is taken from that Lisp string.
19175 Note we operate on the current buffer for most purposes,
19176 the exception being w->base_line_pos. */
19178 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19180 static const char *
19181 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19182 int precision
, Lisp_Object
*string
)
19185 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19186 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19187 struct buffer
*b
= current_buffer
;
19195 if (!NILP (b
->read_only
))
19197 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19202 /* This differs from %* only for a modified read-only buffer. */
19203 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19205 if (!NILP (b
->read_only
))
19210 /* This differs from %* in ignoring read-only-ness. */
19211 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19223 if (command_loop_level
> 5)
19225 p
= decode_mode_spec_buf
;
19226 for (i
= 0; i
< command_loop_level
; i
++)
19229 return decode_mode_spec_buf
;
19237 if (command_loop_level
> 5)
19239 p
= decode_mode_spec_buf
;
19240 for (i
= 0; i
< command_loop_level
; i
++)
19243 return decode_mode_spec_buf
;
19250 /* Let lots_of_dashes be a string of infinite length. */
19251 if (mode_line_target
== MODE_LINE_NOPROP
||
19252 mode_line_target
== MODE_LINE_STRING
)
19254 if (field_width
<= 0
19255 || field_width
> sizeof (lots_of_dashes
))
19257 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19258 decode_mode_spec_buf
[i
] = '-';
19259 decode_mode_spec_buf
[i
] = '\0';
19260 return decode_mode_spec_buf
;
19263 return lots_of_dashes
;
19271 /* %c and %l are ignored in `frame-title-format'.
19272 (In redisplay_internal, the frame title is drawn _before_ the
19273 windows are updated, so the stuff which depends on actual
19274 window contents (such as %l) may fail to render properly, or
19275 even crash emacs.) */
19276 if (mode_line_target
== MODE_LINE_TITLE
)
19280 int col
= (int) current_column (); /* iftc */
19281 w
->column_number_displayed
= make_number (col
);
19282 pint2str (decode_mode_spec_buf
, field_width
, col
);
19283 return decode_mode_spec_buf
;
19287 #ifndef SYSTEM_MALLOC
19289 if (NILP (Vmemory_full
))
19292 return "!MEM FULL! ";
19299 /* %F displays the frame name. */
19300 if (!NILP (f
->title
))
19301 return SSDATA (f
->title
);
19302 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19303 return SSDATA (f
->name
);
19312 EMACS_INT size
= ZV
- BEGV
;
19313 pint2str (decode_mode_spec_buf
, field_width
, size
);
19314 return decode_mode_spec_buf
;
19319 EMACS_INT size
= ZV
- BEGV
;
19320 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19321 return decode_mode_spec_buf
;
19326 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19327 int topline
, nlines
, height
;
19330 /* %c and %l are ignored in `frame-title-format'. */
19331 if (mode_line_target
== MODE_LINE_TITLE
)
19334 startpos
= XMARKER (w
->start
)->charpos
;
19335 startpos_byte
= marker_byte_position (w
->start
);
19336 height
= WINDOW_TOTAL_LINES (w
);
19338 /* If we decided that this buffer isn't suitable for line numbers,
19339 don't forget that too fast. */
19340 if (EQ (w
->base_line_pos
, w
->buffer
))
19342 /* But do forget it, if the window shows a different buffer now. */
19343 else if (BUFFERP (w
->base_line_pos
))
19344 w
->base_line_pos
= Qnil
;
19346 /* If the buffer is very big, don't waste time. */
19347 if (INTEGERP (Vline_number_display_limit
)
19348 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19350 w
->base_line_pos
= Qnil
;
19351 w
->base_line_number
= Qnil
;
19355 if (INTEGERP (w
->base_line_number
)
19356 && INTEGERP (w
->base_line_pos
)
19357 && XFASTINT (w
->base_line_pos
) <= startpos
)
19359 line
= XFASTINT (w
->base_line_number
);
19360 linepos
= XFASTINT (w
->base_line_pos
);
19361 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19366 linepos
= BUF_BEGV (b
);
19367 linepos_byte
= BUF_BEGV_BYTE (b
);
19370 /* Count lines from base line to window start position. */
19371 nlines
= display_count_lines (linepos
, linepos_byte
,
19375 topline
= nlines
+ line
;
19377 /* Determine a new base line, if the old one is too close
19378 or too far away, or if we did not have one.
19379 "Too close" means it's plausible a scroll-down would
19380 go back past it. */
19381 if (startpos
== BUF_BEGV (b
))
19383 w
->base_line_number
= make_number (topline
);
19384 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19386 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19387 || linepos
== BUF_BEGV (b
))
19389 EMACS_INT limit
= BUF_BEGV (b
);
19390 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19391 EMACS_INT position
;
19392 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19394 if (startpos
- distance
> limit
)
19396 limit
= startpos
- distance
;
19397 limit_byte
= CHAR_TO_BYTE (limit
);
19400 nlines
= display_count_lines (startpos
, startpos_byte
,
19402 - (height
* 2 + 30),
19404 /* If we couldn't find the lines we wanted within
19405 line_number_display_limit_width chars per line,
19406 give up on line numbers for this window. */
19407 if (position
== limit_byte
&& limit
== startpos
- distance
)
19409 w
->base_line_pos
= w
->buffer
;
19410 w
->base_line_number
= Qnil
;
19414 w
->base_line_number
= make_number (topline
- nlines
);
19415 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19418 /* Now count lines from the start pos to point. */
19419 nlines
= display_count_lines (startpos
, startpos_byte
,
19420 PT_BYTE
, PT
, &junk
);
19422 /* Record that we did display the line number. */
19423 line_number_displayed
= 1;
19425 /* Make the string to show. */
19426 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19427 return decode_mode_spec_buf
;
19430 char* p
= decode_mode_spec_buf
;
19431 int pad
= field_width
- 2;
19437 return decode_mode_spec_buf
;
19443 obj
= b
->mode_name
;
19447 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19453 EMACS_INT pos
= marker_position (w
->start
);
19454 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19456 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19458 if (pos
<= BUF_BEGV (b
))
19463 else if (pos
<= BUF_BEGV (b
))
19467 if (total
> 1000000)
19468 /* Do it differently for a large value, to avoid overflow. */
19469 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19471 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19472 /* We can't normally display a 3-digit number,
19473 so get us a 2-digit number that is close. */
19476 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19477 return decode_mode_spec_buf
;
19481 /* Display percentage of size above the bottom of the screen. */
19484 EMACS_INT toppos
= marker_position (w
->start
);
19485 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19486 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19488 if (botpos
>= BUF_ZV (b
))
19490 if (toppos
<= BUF_BEGV (b
))
19497 if (total
> 1000000)
19498 /* Do it differently for a large value, to avoid overflow. */
19499 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19501 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19502 /* We can't normally display a 3-digit number,
19503 so get us a 2-digit number that is close. */
19506 if (toppos
<= BUF_BEGV (b
))
19507 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19509 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19510 return decode_mode_spec_buf
;
19515 /* status of process */
19516 obj
= Fget_buffer_process (Fcurrent_buffer ());
19518 return "no process";
19520 obj
= Fsymbol_name (Fprocess_status (obj
));
19526 int count
= inhibit_garbage_collection ();
19527 Lisp_Object val
= call1 (intern ("file-remote-p"),
19528 current_buffer
->directory
);
19529 unbind_to (count
, Qnil
);
19537 case 't': /* indicate TEXT or BINARY */
19538 #ifdef MODE_LINE_BINARY_TEXT
19539 return MODE_LINE_BINARY_TEXT (b
);
19545 /* coding-system (not including end-of-line format) */
19547 /* coding-system (including end-of-line type) */
19549 int eol_flag
= (c
== 'Z');
19550 char *p
= decode_mode_spec_buf
;
19552 if (! FRAME_WINDOW_P (f
))
19554 /* No need to mention EOL here--the terminal never needs
19555 to do EOL conversion. */
19556 p
= decode_mode_spec_coding (CODING_ID_NAME
19557 (FRAME_KEYBOARD_CODING (f
)->id
),
19559 p
= decode_mode_spec_coding (CODING_ID_NAME
19560 (FRAME_TERMINAL_CODING (f
)->id
),
19563 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19566 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19567 #ifdef subprocesses
19568 obj
= Fget_buffer_process (Fcurrent_buffer ());
19569 if (PROCESSP (obj
))
19571 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19573 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19576 #endif /* subprocesses */
19579 return decode_mode_spec_buf
;
19586 return SSDATA (obj
);
19593 /* Count up to COUNT lines starting from START / START_BYTE.
19594 But don't go beyond LIMIT_BYTE.
19595 Return the number of lines thus found (always nonnegative).
19597 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19600 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19601 EMACS_INT limit_byte
, int count
,
19602 EMACS_INT
*byte_pos_ptr
)
19604 register unsigned char *cursor
;
19605 unsigned char *base
;
19607 register int ceiling
;
19608 register unsigned char *ceiling_addr
;
19609 int orig_count
= count
;
19611 /* If we are not in selective display mode,
19612 check only for newlines. */
19613 int selective_display
= (!NILP (current_buffer
->selective_display
)
19614 && !INTEGERP (current_buffer
->selective_display
));
19618 while (start_byte
< limit_byte
)
19620 ceiling
= BUFFER_CEILING_OF (start_byte
);
19621 ceiling
= min (limit_byte
- 1, ceiling
);
19622 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19623 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19626 if (selective_display
)
19627 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19630 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19633 if (cursor
!= ceiling_addr
)
19637 start_byte
+= cursor
- base
+ 1;
19638 *byte_pos_ptr
= start_byte
;
19642 if (++cursor
== ceiling_addr
)
19648 start_byte
+= cursor
- base
;
19653 while (start_byte
> limit_byte
)
19655 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19656 ceiling
= max (limit_byte
, ceiling
);
19657 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19658 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19661 if (selective_display
)
19662 while (--cursor
!= ceiling_addr
19663 && *cursor
!= '\n' && *cursor
!= 015)
19666 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19669 if (cursor
!= ceiling_addr
)
19673 start_byte
+= cursor
- base
+ 1;
19674 *byte_pos_ptr
= start_byte
;
19675 /* When scanning backwards, we should
19676 not count the newline posterior to which we stop. */
19677 return - orig_count
- 1;
19683 /* Here we add 1 to compensate for the last decrement
19684 of CURSOR, which took it past the valid range. */
19685 start_byte
+= cursor
- base
+ 1;
19689 *byte_pos_ptr
= limit_byte
;
19692 return - orig_count
+ count
;
19693 return orig_count
- count
;
19699 /***********************************************************************
19701 ***********************************************************************/
19703 /* Display a NUL-terminated string, starting with index START.
19705 If STRING is non-null, display that C string. Otherwise, the Lisp
19706 string LISP_STRING is displayed. There's a case that STRING is
19707 non-null and LISP_STRING is not nil. It means STRING is a string
19708 data of LISP_STRING. In that case, we display LISP_STRING while
19709 ignoring its text properties.
19711 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19712 FACE_STRING. Display STRING or LISP_STRING with the face at
19713 FACE_STRING_POS in FACE_STRING:
19715 Display the string in the environment given by IT, but use the
19716 standard display table, temporarily.
19718 FIELD_WIDTH is the minimum number of output glyphs to produce.
19719 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19720 with spaces. If STRING has more characters, more than FIELD_WIDTH
19721 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19723 PRECISION is the maximum number of characters to output from
19724 STRING. PRECISION < 0 means don't truncate the string.
19726 This is roughly equivalent to printf format specifiers:
19728 FIELD_WIDTH PRECISION PRINTF
19729 ----------------------------------------
19735 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19736 display them, and < 0 means obey the current buffer's value of
19737 enable_multibyte_characters.
19739 Value is the number of columns displayed. */
19742 display_string (const unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19743 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19744 int field_width
, int precision
, int max_x
, int multibyte
)
19746 int hpos_at_start
= it
->hpos
;
19747 int saved_face_id
= it
->face_id
;
19748 struct glyph_row
*row
= it
->glyph_row
;
19750 /* Initialize the iterator IT for iteration over STRING beginning
19751 with index START. */
19752 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19753 precision
, field_width
, multibyte
);
19754 if (string
&& STRINGP (lisp_string
))
19755 /* LISP_STRING is the one returned by decode_mode_spec. We should
19756 ignore its text properties. */
19757 it
->stop_charpos
= -1;
19759 /* If displaying STRING, set up the face of the iterator
19760 from LISP_STRING, if that's given. */
19761 if (STRINGP (face_string
))
19767 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19768 0, it
->region_beg_charpos
,
19769 it
->region_end_charpos
,
19770 &endptr
, it
->base_face_id
, 0);
19771 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19772 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19775 /* Set max_x to the maximum allowed X position. Don't let it go
19776 beyond the right edge of the window. */
19778 max_x
= it
->last_visible_x
;
19780 max_x
= min (max_x
, it
->last_visible_x
);
19782 /* Skip over display elements that are not visible. because IT->w is
19784 if (it
->current_x
< it
->first_visible_x
)
19785 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19786 MOVE_TO_POS
| MOVE_TO_X
);
19788 row
->ascent
= it
->max_ascent
;
19789 row
->height
= it
->max_ascent
+ it
->max_descent
;
19790 row
->phys_ascent
= it
->max_phys_ascent
;
19791 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19792 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19794 /* This condition is for the case that we are called with current_x
19795 past last_visible_x. */
19796 while (it
->current_x
< max_x
)
19798 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19800 /* Get the next display element. */
19801 if (!get_next_display_element (it
))
19804 /* Produce glyphs. */
19805 x_before
= it
->current_x
;
19806 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19807 PRODUCE_GLYPHS (it
);
19809 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19812 while (i
< nglyphs
)
19814 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19816 if (it
->line_wrap
!= TRUNCATE
19817 && x
+ glyph
->pixel_width
> max_x
)
19819 /* End of continued line or max_x reached. */
19820 if (CHAR_GLYPH_PADDING_P (*glyph
))
19822 /* A wide character is unbreakable. */
19823 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19824 it
->current_x
= x_before
;
19828 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19833 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19835 /* Glyph is at least partially visible. */
19837 if (x
< it
->first_visible_x
)
19838 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19842 /* Glyph is off the left margin of the display area.
19843 Should not happen. */
19847 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19848 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19849 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19850 row
->phys_height
= max (row
->phys_height
,
19851 it
->max_phys_ascent
+ it
->max_phys_descent
);
19852 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19853 it
->max_extra_line_spacing
);
19854 x
+= glyph
->pixel_width
;
19858 /* Stop if max_x reached. */
19862 /* Stop at line ends. */
19863 if (ITERATOR_AT_END_OF_LINE_P (it
))
19865 it
->continuation_lines_width
= 0;
19869 set_iterator_to_next (it
, 1);
19871 /* Stop if truncating at the right edge. */
19872 if (it
->line_wrap
== TRUNCATE
19873 && it
->current_x
>= it
->last_visible_x
)
19875 /* Add truncation mark, but don't do it if the line is
19876 truncated at a padding space. */
19877 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19879 if (!FRAME_WINDOW_P (it
->f
))
19883 if (it
->current_x
> it
->last_visible_x
)
19885 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19886 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19888 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19890 row
->used
[TEXT_AREA
] = i
;
19891 produce_special_glyphs (it
, IT_TRUNCATION
);
19894 produce_special_glyphs (it
, IT_TRUNCATION
);
19896 it
->glyph_row
->truncated_on_right_p
= 1;
19902 /* Maybe insert a truncation at the left. */
19903 if (it
->first_visible_x
19904 && IT_CHARPOS (*it
) > 0)
19906 if (!FRAME_WINDOW_P (it
->f
))
19907 insert_left_trunc_glyphs (it
);
19908 it
->glyph_row
->truncated_on_left_p
= 1;
19911 it
->face_id
= saved_face_id
;
19913 /* Value is number of columns displayed. */
19914 return it
->hpos
- hpos_at_start
;
19919 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19920 appears as an element of LIST or as the car of an element of LIST.
19921 If PROPVAL is a list, compare each element against LIST in that
19922 way, and return 1/2 if any element of PROPVAL is found in LIST.
19923 Otherwise return 0. This function cannot quit.
19924 The return value is 2 if the text is invisible but with an ellipsis
19925 and 1 if it's invisible and without an ellipsis. */
19928 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19930 register Lisp_Object tail
, proptail
;
19932 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19934 register Lisp_Object tem
;
19936 if (EQ (propval
, tem
))
19938 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19939 return NILP (XCDR (tem
)) ? 1 : 2;
19942 if (CONSP (propval
))
19944 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19946 Lisp_Object propelt
;
19947 propelt
= XCAR (proptail
);
19948 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19950 register Lisp_Object tem
;
19952 if (EQ (propelt
, tem
))
19954 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19955 return NILP (XCDR (tem
)) ? 1 : 2;
19963 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19964 doc
: /* Non-nil if the property makes the text invisible.
19965 POS-OR-PROP can be a marker or number, in which case it is taken to be
19966 a position in the current buffer and the value of the `invisible' property
19967 is checked; or it can be some other value, which is then presumed to be the
19968 value of the `invisible' property of the text of interest.
19969 The non-nil value returned can be t for truly invisible text or something
19970 else if the text is replaced by an ellipsis. */)
19971 (Lisp_Object pos_or_prop
)
19974 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19975 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19977 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19978 return (invis
== 0 ? Qnil
19980 : make_number (invis
));
19983 /* Calculate a width or height in pixels from a specification using
19984 the following elements:
19987 NUM - a (fractional) multiple of the default font width/height
19988 (NUM) - specifies exactly NUM pixels
19989 UNIT - a fixed number of pixels, see below.
19990 ELEMENT - size of a display element in pixels, see below.
19991 (NUM . SPEC) - equals NUM * SPEC
19992 (+ SPEC SPEC ...) - add pixel values
19993 (- SPEC SPEC ...) - subtract pixel values
19994 (- SPEC) - negate pixel value
19997 INT or FLOAT - a number constant
19998 SYMBOL - use symbol's (buffer local) variable binding.
20001 in - pixels per inch *)
20002 mm - pixels per 1/1000 meter *)
20003 cm - pixels per 1/100 meter *)
20004 width - width of current font in pixels.
20005 height - height of current font in pixels.
20007 *) using the ratio(s) defined in display-pixels-per-inch.
20011 left-fringe - left fringe width in pixels
20012 right-fringe - right fringe width in pixels
20014 left-margin - left margin width in pixels
20015 right-margin - right margin width in pixels
20017 scroll-bar - scroll-bar area width in pixels
20021 Pixels corresponding to 5 inches:
20024 Total width of non-text areas on left side of window (if scroll-bar is on left):
20025 '(space :width (+ left-fringe left-margin scroll-bar))
20027 Align to first text column (in header line):
20028 '(space :align-to 0)
20030 Align to middle of text area minus half the width of variable `my-image'
20031 containing a loaded image:
20032 '(space :align-to (0.5 . (- text my-image)))
20034 Width of left margin minus width of 1 character in the default font:
20035 '(space :width (- left-margin 1))
20037 Width of left margin minus width of 2 characters in the current font:
20038 '(space :width (- left-margin (2 . width)))
20040 Center 1 character over left-margin (in header line):
20041 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20043 Different ways to express width of left fringe plus left margin minus one pixel:
20044 '(space :width (- (+ left-fringe left-margin) (1)))
20045 '(space :width (+ left-fringe left-margin (- (1))))
20046 '(space :width (+ left-fringe left-margin (-1)))
20050 #define NUMVAL(X) \
20051 ((INTEGERP (X) || FLOATP (X)) \
20056 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20057 struct font
*font
, int width_p
, int *align_to
)
20061 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20062 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20065 return OK_PIXELS (0);
20067 xassert (FRAME_LIVE_P (it
->f
));
20069 if (SYMBOLP (prop
))
20071 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20073 char *unit
= SDATA (SYMBOL_NAME (prop
));
20075 if (unit
[0] == 'i' && unit
[1] == 'n')
20077 else if (unit
[0] == 'm' && unit
[1] == 'm')
20079 else if (unit
[0] == 'c' && unit
[1] == 'm')
20086 #ifdef HAVE_WINDOW_SYSTEM
20087 if (FRAME_WINDOW_P (it
->f
)
20089 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20090 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20092 return OK_PIXELS (ppi
/ pixels
);
20095 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20096 || (CONSP (Vdisplay_pixels_per_inch
)
20098 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20099 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20101 return OK_PIXELS (ppi
/ pixels
);
20107 #ifdef HAVE_WINDOW_SYSTEM
20108 if (EQ (prop
, Qheight
))
20109 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20110 if (EQ (prop
, Qwidth
))
20111 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20113 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20114 return OK_PIXELS (1);
20117 if (EQ (prop
, Qtext
))
20118 return OK_PIXELS (width_p
20119 ? window_box_width (it
->w
, TEXT_AREA
)
20120 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20122 if (align_to
&& *align_to
< 0)
20125 if (EQ (prop
, Qleft
))
20126 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20127 if (EQ (prop
, Qright
))
20128 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20129 if (EQ (prop
, Qcenter
))
20130 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20131 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20132 if (EQ (prop
, Qleft_fringe
))
20133 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20134 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20135 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20136 if (EQ (prop
, Qright_fringe
))
20137 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20138 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20139 : window_box_right_offset (it
->w
, TEXT_AREA
));
20140 if (EQ (prop
, Qleft_margin
))
20141 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20142 if (EQ (prop
, Qright_margin
))
20143 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20144 if (EQ (prop
, Qscroll_bar
))
20145 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20147 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20148 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20149 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20154 if (EQ (prop
, Qleft_fringe
))
20155 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20156 if (EQ (prop
, Qright_fringe
))
20157 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20158 if (EQ (prop
, Qleft_margin
))
20159 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20160 if (EQ (prop
, Qright_margin
))
20161 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20162 if (EQ (prop
, Qscroll_bar
))
20163 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20166 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20169 if (INTEGERP (prop
) || FLOATP (prop
))
20171 int base_unit
= (width_p
20172 ? FRAME_COLUMN_WIDTH (it
->f
)
20173 : FRAME_LINE_HEIGHT (it
->f
));
20174 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20179 Lisp_Object car
= XCAR (prop
);
20180 Lisp_Object cdr
= XCDR (prop
);
20184 #ifdef HAVE_WINDOW_SYSTEM
20185 if (FRAME_WINDOW_P (it
->f
)
20186 && valid_image_p (prop
))
20188 int id
= lookup_image (it
->f
, prop
);
20189 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20191 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20194 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20200 while (CONSP (cdr
))
20202 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20203 font
, width_p
, align_to
))
20206 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20211 if (EQ (car
, Qminus
))
20213 return OK_PIXELS (pixels
);
20216 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20219 if (INTEGERP (car
) || FLOATP (car
))
20222 pixels
= XFLOATINT (car
);
20224 return OK_PIXELS (pixels
);
20225 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20226 font
, width_p
, align_to
))
20227 return OK_PIXELS (pixels
* fact
);
20238 /***********************************************************************
20240 ***********************************************************************/
20242 #ifdef HAVE_WINDOW_SYSTEM
20247 dump_glyph_string (s
)
20248 struct glyph_string
*s
;
20250 fprintf (stderr
, "glyph string\n");
20251 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20252 s
->x
, s
->y
, s
->width
, s
->height
);
20253 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20254 fprintf (stderr
, " hl = %d\n", s
->hl
);
20255 fprintf (stderr
, " left overhang = %d, right = %d\n",
20256 s
->left_overhang
, s
->right_overhang
);
20257 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20258 fprintf (stderr
, " extends to end of line = %d\n",
20259 s
->extends_to_end_of_line_p
);
20260 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20261 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20264 #endif /* GLYPH_DEBUG */
20266 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20267 of XChar2b structures for S; it can't be allocated in
20268 init_glyph_string because it must be allocated via `alloca'. W
20269 is the window on which S is drawn. ROW and AREA are the glyph row
20270 and area within the row from which S is constructed. START is the
20271 index of the first glyph structure covered by S. HL is a
20272 face-override for drawing S. */
20275 #define OPTIONAL_HDC(hdc) HDC hdc,
20276 #define DECLARE_HDC(hdc) HDC hdc;
20277 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20278 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20281 #ifndef OPTIONAL_HDC
20282 #define OPTIONAL_HDC(hdc)
20283 #define DECLARE_HDC(hdc)
20284 #define ALLOCATE_HDC(hdc, f)
20285 #define RELEASE_HDC(hdc, f)
20289 init_glyph_string (struct glyph_string
*s
,
20291 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20292 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20294 memset (s
, 0, sizeof *s
);
20296 s
->f
= XFRAME (w
->frame
);
20300 s
->display
= FRAME_X_DISPLAY (s
->f
);
20301 s
->window
= FRAME_X_WINDOW (s
->f
);
20302 s
->char2b
= char2b
;
20306 s
->first_glyph
= row
->glyphs
[area
] + start
;
20307 s
->height
= row
->height
;
20308 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20309 s
->ybase
= s
->y
+ row
->ascent
;
20313 /* Append the list of glyph strings with head H and tail T to the list
20314 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20317 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20318 struct glyph_string
*h
, struct glyph_string
*t
)
20332 /* Prepend the list of glyph strings with head H and tail T to the
20333 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20337 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20338 struct glyph_string
*h
, struct glyph_string
*t
)
20352 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20353 Set *HEAD and *TAIL to the resulting list. */
20356 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20357 struct glyph_string
*s
)
20359 s
->next
= s
->prev
= NULL
;
20360 append_glyph_string_lists (head
, tail
, s
, s
);
20364 /* Get face and two-byte form of character C in face FACE_ID on frame
20365 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20366 means we want to display multibyte text. DISPLAY_P non-zero means
20367 make sure that X resources for the face returned are allocated.
20368 Value is a pointer to a realized face that is ready for display if
20369 DISPLAY_P is non-zero. */
20371 static INLINE
struct face
*
20372 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20373 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20375 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20379 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20381 if (code
!= FONT_INVALID_CODE
)
20382 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20384 STORE_XCHAR2B (char2b
, 0, 0);
20387 /* Make sure X resources of the face are allocated. */
20388 #ifdef HAVE_X_WINDOWS
20392 xassert (face
!= NULL
);
20393 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20400 /* Get face and two-byte form of character glyph GLYPH on frame F.
20401 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20402 a pointer to a realized face that is ready for display. */
20404 static INLINE
struct face
*
20405 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20406 XChar2b
*char2b
, int *two_byte_p
)
20410 xassert (glyph
->type
== CHAR_GLYPH
);
20411 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20420 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20421 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20423 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20425 if (code
!= FONT_INVALID_CODE
)
20426 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20428 STORE_XCHAR2B (char2b
, 0, 0);
20431 /* Make sure X resources of the face are allocated. */
20432 xassert (face
!= NULL
);
20433 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20438 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20439 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20442 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20446 if (CHAR_BYTE8_P (c
))
20447 code
= CHAR_TO_BYTE8 (c
);
20449 code
= font
->driver
->encode_char (font
, c
);
20451 if (code
== FONT_INVALID_CODE
)
20453 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20458 /* Fill glyph string S with composition components specified by S->cmp.
20460 BASE_FACE is the base face of the composition.
20461 S->cmp_from is the index of the first component for S.
20463 OVERLAPS non-zero means S should draw the foreground only, and use
20464 its physical height for clipping. See also draw_glyphs.
20466 Value is the index of a component not in S. */
20469 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20473 /* For all glyphs of this composition, starting at the offset
20474 S->cmp_from, until we reach the end of the definition or encounter a
20475 glyph that requires the different face, add it to S. */
20480 s
->for_overlaps
= overlaps
;
20483 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20485 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20489 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20492 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20493 s
->char2b
+ i
, 1, 1);
20499 s
->font
= s
->face
->font
;
20501 else if (s
->face
!= face
)
20509 /* All glyph strings for the same composition has the same width,
20510 i.e. the width set for the first component of the composition. */
20511 s
->width
= s
->first_glyph
->pixel_width
;
20513 /* If the specified font could not be loaded, use the frame's
20514 default font, but record the fact that we couldn't load it in
20515 the glyph string so that we can draw rectangles for the
20516 characters of the glyph string. */
20517 if (s
->font
== NULL
)
20519 s
->font_not_found_p
= 1;
20520 s
->font
= FRAME_FONT (s
->f
);
20523 /* Adjust base line for subscript/superscript text. */
20524 s
->ybase
+= s
->first_glyph
->voffset
;
20526 /* This glyph string must always be drawn with 16-bit functions. */
20533 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20534 int start
, int end
, int overlaps
)
20536 struct glyph
*glyph
, *last
;
20537 Lisp_Object lgstring
;
20540 s
->for_overlaps
= overlaps
;
20541 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20542 last
= s
->row
->glyphs
[s
->area
] + end
;
20543 s
->cmp_id
= glyph
->u
.cmp
.id
;
20544 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20545 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20546 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20547 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20548 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20550 while (glyph
< last
20551 && glyph
->u
.cmp
.automatic
20552 && glyph
->u
.cmp
.id
== s
->cmp_id
20553 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20554 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20556 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20558 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20559 unsigned code
= LGLYPH_CODE (lglyph
);
20561 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20563 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20564 return glyph
- s
->row
->glyphs
[s
->area
];
20568 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20569 See the comment of fill_glyph_string for arguments.
20570 Value is the index of the first glyph not in S. */
20574 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20575 int start
, int end
, int overlaps
)
20577 struct glyph
*glyph
, *last
;
20580 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20581 s
->for_overlaps
= overlaps
;
20582 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20583 last
= s
->row
->glyphs
[s
->area
] + end
;
20584 voffset
= glyph
->voffset
;
20585 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20586 s
->font
= s
->face
->font
;
20588 s
->width
= glyph
->pixel_width
;
20590 while (glyph
< last
20591 && glyph
->type
== GLYPHLESS_GLYPH
20592 && glyph
->voffset
== voffset
20593 && glyph
->face_id
== face_id
)
20596 s
->width
+= glyph
->pixel_width
;
20599 s
->ybase
+= voffset
;
20600 return glyph
- s
->row
->glyphs
[s
->area
];
20604 /* Fill glyph string S from a sequence of character glyphs.
20606 FACE_ID is the face id of the string. START is the index of the
20607 first glyph to consider, END is the index of the last + 1.
20608 OVERLAPS non-zero means S should draw the foreground only, and use
20609 its physical height for clipping. See also draw_glyphs.
20611 Value is the index of the first glyph not in S. */
20614 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20615 int start
, int end
, int overlaps
)
20617 struct glyph
*glyph
, *last
;
20619 int glyph_not_available_p
;
20621 xassert (s
->f
== XFRAME (s
->w
->frame
));
20622 xassert (s
->nchars
== 0);
20623 xassert (start
>= 0 && end
> start
);
20625 s
->for_overlaps
= overlaps
;
20626 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20627 last
= s
->row
->glyphs
[s
->area
] + end
;
20628 voffset
= glyph
->voffset
;
20629 s
->padding_p
= glyph
->padding_p
;
20630 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20632 while (glyph
< last
20633 && glyph
->type
== CHAR_GLYPH
20634 && glyph
->voffset
== voffset
20635 /* Same face id implies same font, nowadays. */
20636 && glyph
->face_id
== face_id
20637 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20641 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20642 s
->char2b
+ s
->nchars
,
20644 s
->two_byte_p
= two_byte_p
;
20646 xassert (s
->nchars
<= end
- start
);
20647 s
->width
+= glyph
->pixel_width
;
20648 if (glyph
++->padding_p
!= s
->padding_p
)
20652 s
->font
= s
->face
->font
;
20654 /* If the specified font could not be loaded, use the frame's font,
20655 but record the fact that we couldn't load it in
20656 S->font_not_found_p so that we can draw rectangles for the
20657 characters of the glyph string. */
20658 if (s
->font
== NULL
|| glyph_not_available_p
)
20660 s
->font_not_found_p
= 1;
20661 s
->font
= FRAME_FONT (s
->f
);
20664 /* Adjust base line for subscript/superscript text. */
20665 s
->ybase
+= voffset
;
20667 xassert (s
->face
&& s
->face
->gc
);
20668 return glyph
- s
->row
->glyphs
[s
->area
];
20672 /* Fill glyph string S from image glyph S->first_glyph. */
20675 fill_image_glyph_string (struct glyph_string
*s
)
20677 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20678 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20680 s
->slice
= s
->first_glyph
->slice
.img
;
20681 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20682 s
->font
= s
->face
->font
;
20683 s
->width
= s
->first_glyph
->pixel_width
;
20685 /* Adjust base line for subscript/superscript text. */
20686 s
->ybase
+= s
->first_glyph
->voffset
;
20690 /* Fill glyph string S from a sequence of stretch glyphs.
20692 ROW is the glyph row in which the glyphs are found, AREA is the
20693 area within the row. START is the index of the first glyph to
20694 consider, END is the index of the last + 1.
20696 Value is the index of the first glyph not in S. */
20699 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20700 enum glyph_row_area area
, int start
, int end
)
20702 struct glyph
*glyph
, *last
;
20703 int voffset
, face_id
;
20705 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20707 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20708 last
= s
->row
->glyphs
[s
->area
] + end
;
20709 face_id
= glyph
->face_id
;
20710 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20711 s
->font
= s
->face
->font
;
20712 s
->width
= glyph
->pixel_width
;
20714 voffset
= glyph
->voffset
;
20718 && glyph
->type
== STRETCH_GLYPH
20719 && glyph
->voffset
== voffset
20720 && glyph
->face_id
== face_id
);
20722 s
->width
+= glyph
->pixel_width
;
20724 /* Adjust base line for subscript/superscript text. */
20725 s
->ybase
+= voffset
;
20727 /* The case that face->gc == 0 is handled when drawing the glyph
20728 string by calling PREPARE_FACE_FOR_DISPLAY. */
20730 return glyph
- s
->row
->glyphs
[s
->area
];
20733 static struct font_metrics
*
20734 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20736 static struct font_metrics metrics
;
20737 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20739 if (! font
|| code
== FONT_INVALID_CODE
)
20741 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20746 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20747 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20748 assumed to be zero. */
20751 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20753 *left
= *right
= 0;
20755 if (glyph
->type
== CHAR_GLYPH
)
20759 struct font_metrics
*pcm
;
20761 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20762 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20764 if (pcm
->rbearing
> pcm
->width
)
20765 *right
= pcm
->rbearing
- pcm
->width
;
20766 if (pcm
->lbearing
< 0)
20767 *left
= -pcm
->lbearing
;
20770 else if (glyph
->type
== COMPOSITE_GLYPH
)
20772 if (! glyph
->u
.cmp
.automatic
)
20774 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20776 if (cmp
->rbearing
> cmp
->pixel_width
)
20777 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20778 if (cmp
->lbearing
< 0)
20779 *left
= - cmp
->lbearing
;
20783 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20784 struct font_metrics metrics
;
20786 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20787 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20788 if (metrics
.rbearing
> metrics
.width
)
20789 *right
= metrics
.rbearing
- metrics
.width
;
20790 if (metrics
.lbearing
< 0)
20791 *left
= - metrics
.lbearing
;
20797 /* Return the index of the first glyph preceding glyph string S that
20798 is overwritten by S because of S's left overhang. Value is -1
20799 if no glyphs are overwritten. */
20802 left_overwritten (struct glyph_string
*s
)
20806 if (s
->left_overhang
)
20809 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20810 int first
= s
->first_glyph
- glyphs
;
20812 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20813 x
-= glyphs
[i
].pixel_width
;
20824 /* Return the index of the first glyph preceding glyph string S that
20825 is overwriting S because of its right overhang. Value is -1 if no
20826 glyph in front of S overwrites S. */
20829 left_overwriting (struct glyph_string
*s
)
20832 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20833 int first
= s
->first_glyph
- glyphs
;
20837 for (i
= first
- 1; i
>= 0; --i
)
20840 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20843 x
-= glyphs
[i
].pixel_width
;
20850 /* Return the index of the last glyph following glyph string S that is
20851 overwritten by S because of S's right overhang. Value is -1 if
20852 no such glyph is found. */
20855 right_overwritten (struct glyph_string
*s
)
20859 if (s
->right_overhang
)
20862 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20863 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20864 int end
= s
->row
->used
[s
->area
];
20866 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20867 x
+= glyphs
[i
].pixel_width
;
20876 /* Return the index of the last glyph following glyph string S that
20877 overwrites S because of its left overhang. Value is negative
20878 if no such glyph is found. */
20881 right_overwriting (struct glyph_string
*s
)
20884 int end
= s
->row
->used
[s
->area
];
20885 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20886 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20890 for (i
= first
; i
< end
; ++i
)
20893 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20896 x
+= glyphs
[i
].pixel_width
;
20903 /* Set background width of glyph string S. START is the index of the
20904 first glyph following S. LAST_X is the right-most x-position + 1
20905 in the drawing area. */
20908 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20910 /* If the face of this glyph string has to be drawn to the end of
20911 the drawing area, set S->extends_to_end_of_line_p. */
20913 if (start
== s
->row
->used
[s
->area
]
20914 && s
->area
== TEXT_AREA
20915 && ((s
->row
->fill_line_p
20916 && (s
->hl
== DRAW_NORMAL_TEXT
20917 || s
->hl
== DRAW_IMAGE_RAISED
20918 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20919 || s
->hl
== DRAW_MOUSE_FACE
))
20920 s
->extends_to_end_of_line_p
= 1;
20922 /* If S extends its face to the end of the line, set its
20923 background_width to the distance to the right edge of the drawing
20925 if (s
->extends_to_end_of_line_p
)
20926 s
->background_width
= last_x
- s
->x
+ 1;
20928 s
->background_width
= s
->width
;
20932 /* Compute overhangs and x-positions for glyph string S and its
20933 predecessors, or successors. X is the starting x-position for S.
20934 BACKWARD_P non-zero means process predecessors. */
20937 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20943 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20944 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20954 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20955 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20965 /* The following macros are only called from draw_glyphs below.
20966 They reference the following parameters of that function directly:
20967 `w', `row', `area', and `overlap_p'
20968 as well as the following local variables:
20969 `s', `f', and `hdc' (in W32) */
20972 /* On W32, silently add local `hdc' variable to argument list of
20973 init_glyph_string. */
20974 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20975 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20977 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20978 init_glyph_string (s, char2b, w, row, area, start, hl)
20981 /* Add a glyph string for a stretch glyph to the list of strings
20982 between HEAD and TAIL. START is the index of the stretch glyph in
20983 row area AREA of glyph row ROW. END is the index of the last glyph
20984 in that glyph row area. X is the current output position assigned
20985 to the new glyph string constructed. HL overrides that face of the
20986 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20987 is the right-most x-position of the drawing area. */
20989 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20990 and below -- keep them on one line. */
20991 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20994 s = (struct glyph_string *) alloca (sizeof *s); \
20995 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20996 START = fill_stretch_glyph_string (s, row, area, START, END); \
20997 append_glyph_string (&HEAD, &TAIL, s); \
21003 /* Add a glyph string for an image glyph to the list of strings
21004 between HEAD and TAIL. START is the index of the image glyph in
21005 row area AREA of glyph row ROW. END is the index of the last glyph
21006 in that glyph row area. X is the current output position assigned
21007 to the new glyph string constructed. HL overrides that face of the
21008 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21009 is the right-most x-position of the drawing area. */
21011 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21014 s = (struct glyph_string *) alloca (sizeof *s); \
21015 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21016 fill_image_glyph_string (s); \
21017 append_glyph_string (&HEAD, &TAIL, s); \
21024 /* Add a glyph string for a sequence of character glyphs to the list
21025 of strings between HEAD and TAIL. START is the index of the first
21026 glyph in row area AREA of glyph row ROW that is part of the new
21027 glyph string. END is the index of the last glyph in that glyph row
21028 area. X is the current output position assigned to the new glyph
21029 string constructed. HL overrides that face of the glyph; e.g. it
21030 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21031 right-most x-position of the drawing area. */
21033 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21039 face_id = (row)->glyphs[area][START].face_id; \
21041 s = (struct glyph_string *) alloca (sizeof *s); \
21042 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21043 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21044 append_glyph_string (&HEAD, &TAIL, s); \
21046 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21051 /* Add a glyph string for a composite sequence to the list of strings
21052 between HEAD and TAIL. START is the index of the first glyph in
21053 row area AREA of glyph row ROW that is part of the new glyph
21054 string. END is the index of the last glyph in that glyph row area.
21055 X is the current output position assigned to the new glyph string
21056 constructed. HL overrides that face of the glyph; e.g. it is
21057 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21058 x-position of the drawing area. */
21060 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21062 int face_id = (row)->glyphs[area][START].face_id; \
21063 struct face *base_face = FACE_FROM_ID (f, face_id); \
21064 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21065 struct composition *cmp = composition_table[cmp_id]; \
21067 struct glyph_string *first_s; \
21070 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21072 /* Make glyph_strings for each glyph sequence that is drawable by \
21073 the same face, and append them to HEAD/TAIL. */ \
21074 for (n = 0; n < cmp->glyph_len;) \
21076 s = (struct glyph_string *) alloca (sizeof *s); \
21077 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21078 append_glyph_string (&(HEAD), &(TAIL), s); \
21084 n = fill_composite_glyph_string (s, base_face, overlaps); \
21092 /* Add a glyph string for a glyph-string sequence to the list of strings
21093 between HEAD and TAIL. */
21095 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21099 Lisp_Object gstring; \
21101 face_id = (row)->glyphs[area][START].face_id; \
21102 gstring = (composition_gstring_from_id \
21103 ((row)->glyphs[area][START].u.cmp.id)); \
21104 s = (struct glyph_string *) alloca (sizeof *s); \
21105 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21106 * LGSTRING_GLYPH_LEN (gstring)); \
21107 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21108 append_glyph_string (&(HEAD), &(TAIL), s); \
21110 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21114 /* Add a glyph string for a sequence of glyphless character's glyphs
21115 to the list of strings between HEAD and TAIL. The meanings of
21116 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21118 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21124 face_id = (row)->glyphs[area][START].face_id; \
21126 s = (struct glyph_string *) alloca (sizeof *s); \
21127 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21128 append_glyph_string (&HEAD, &TAIL, s); \
21130 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21136 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21137 of AREA of glyph row ROW on window W between indices START and END.
21138 HL overrides the face for drawing glyph strings, e.g. it is
21139 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21140 x-positions of the drawing area.
21142 This is an ugly monster macro construct because we must use alloca
21143 to allocate glyph strings (because draw_glyphs can be called
21144 asynchronously). */
21146 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21149 HEAD = TAIL = NULL; \
21150 while (START < END) \
21152 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21153 switch (first_glyph->type) \
21156 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21160 case COMPOSITE_GLYPH: \
21161 if (first_glyph->u.cmp.automatic) \
21162 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21165 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21169 case STRETCH_GLYPH: \
21170 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21174 case IMAGE_GLYPH: \
21175 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21179 case GLYPHLESS_GLYPH: \
21180 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21190 set_glyph_string_background_width (s, START, LAST_X); \
21197 /* Draw glyphs between START and END in AREA of ROW on window W,
21198 starting at x-position X. X is relative to AREA in W. HL is a
21199 face-override with the following meaning:
21201 DRAW_NORMAL_TEXT draw normally
21202 DRAW_CURSOR draw in cursor face
21203 DRAW_MOUSE_FACE draw in mouse face.
21204 DRAW_INVERSE_VIDEO draw in mode line face
21205 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21206 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21208 If OVERLAPS is non-zero, draw only the foreground of characters and
21209 clip to the physical height of ROW. Non-zero value also defines
21210 the overlapping part to be drawn:
21212 OVERLAPS_PRED overlap with preceding rows
21213 OVERLAPS_SUCC overlap with succeeding rows
21214 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21215 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21217 Value is the x-position reached, relative to AREA of W. */
21220 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21221 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21222 enum draw_glyphs_face hl
, int overlaps
)
21224 struct glyph_string
*head
, *tail
;
21225 struct glyph_string
*s
;
21226 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21227 int i
, j
, x_reached
, last_x
, area_left
= 0;
21228 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21231 ALLOCATE_HDC (hdc
, f
);
21233 /* Let's rather be paranoid than getting a SEGV. */
21234 end
= min (end
, row
->used
[area
]);
21235 start
= max (0, start
);
21236 start
= min (end
, start
);
21238 /* Translate X to frame coordinates. Set last_x to the right
21239 end of the drawing area. */
21240 if (row
->full_width_p
)
21242 /* X is relative to the left edge of W, without scroll bars
21244 area_left
= WINDOW_LEFT_EDGE_X (w
);
21245 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21249 area_left
= window_box_left (w
, area
);
21250 last_x
= area_left
+ window_box_width (w
, area
);
21254 /* Build a doubly-linked list of glyph_string structures between
21255 head and tail from what we have to draw. Note that the macro
21256 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21257 the reason we use a separate variable `i'. */
21259 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21261 x_reached
= tail
->x
+ tail
->background_width
;
21265 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21266 the row, redraw some glyphs in front or following the glyph
21267 strings built above. */
21268 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21270 struct glyph_string
*h
, *t
;
21271 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21272 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21275 /* If mouse highlighting is on, we may need to draw adjacent
21276 glyphs using mouse-face highlighting. */
21277 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21279 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21281 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21282 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21284 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21286 check_mouse_face
= 1;
21287 mouse_beg_col
= (row
== mouse_beg_row
)
21288 ? hlinfo
->mouse_face_beg_col
: 0;
21289 mouse_end_col
= (row
== mouse_end_row
)
21290 ? hlinfo
->mouse_face_end_col
21291 : row
->used
[TEXT_AREA
];
21295 /* Compute overhangs for all glyph strings. */
21296 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21297 for (s
= head
; s
; s
= s
->next
)
21298 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21300 /* Prepend glyph strings for glyphs in front of the first glyph
21301 string that are overwritten because of the first glyph
21302 string's left overhang. The background of all strings
21303 prepended must be drawn because the first glyph string
21305 i
= left_overwritten (head
);
21308 enum draw_glyphs_face overlap_hl
;
21310 /* If this row contains mouse highlighting, attempt to draw
21311 the overlapped glyphs with the correct highlight. This
21312 code fails if the overlap encompasses more than one glyph
21313 and mouse-highlight spans only some of these glyphs.
21314 However, making it work perfectly involves a lot more
21315 code, and I don't know if the pathological case occurs in
21316 practice, so we'll stick to this for now. --- cyd */
21317 if (check_mouse_face
21318 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21319 overlap_hl
= DRAW_MOUSE_FACE
;
21321 overlap_hl
= DRAW_NORMAL_TEXT
;
21324 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21325 overlap_hl
, dummy_x
, last_x
);
21327 compute_overhangs_and_x (t
, head
->x
, 1);
21328 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21332 /* Prepend glyph strings for glyphs in front of the first glyph
21333 string that overwrite that glyph string because of their
21334 right overhang. For these strings, only the foreground must
21335 be drawn, because it draws over the glyph string at `head'.
21336 The background must not be drawn because this would overwrite
21337 right overhangs of preceding glyphs for which no glyph
21339 i
= left_overwriting (head
);
21342 enum draw_glyphs_face overlap_hl
;
21344 if (check_mouse_face
21345 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21346 overlap_hl
= DRAW_MOUSE_FACE
;
21348 overlap_hl
= DRAW_NORMAL_TEXT
;
21351 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21352 overlap_hl
, dummy_x
, last_x
);
21353 for (s
= h
; s
; s
= s
->next
)
21354 s
->background_filled_p
= 1;
21355 compute_overhangs_and_x (t
, head
->x
, 1);
21356 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21359 /* Append glyphs strings for glyphs following the last glyph
21360 string tail that are overwritten by tail. The background of
21361 these strings has to be drawn because tail's foreground draws
21363 i
= right_overwritten (tail
);
21366 enum draw_glyphs_face overlap_hl
;
21368 if (check_mouse_face
21369 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21370 overlap_hl
= DRAW_MOUSE_FACE
;
21372 overlap_hl
= DRAW_NORMAL_TEXT
;
21374 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21375 overlap_hl
, x
, last_x
);
21376 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21377 we don't have `end = i;' here. */
21378 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21379 append_glyph_string_lists (&head
, &tail
, h
, t
);
21383 /* Append glyph strings for glyphs following the last glyph
21384 string tail that overwrite tail. The foreground of such
21385 glyphs has to be drawn because it writes into the background
21386 of tail. The background must not be drawn because it could
21387 paint over the foreground of following glyphs. */
21388 i
= right_overwriting (tail
);
21391 enum draw_glyphs_face overlap_hl
;
21392 if (check_mouse_face
21393 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21394 overlap_hl
= DRAW_MOUSE_FACE
;
21396 overlap_hl
= DRAW_NORMAL_TEXT
;
21399 i
++; /* We must include the Ith glyph. */
21400 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21401 overlap_hl
, x
, last_x
);
21402 for (s
= h
; s
; s
= s
->next
)
21403 s
->background_filled_p
= 1;
21404 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21405 append_glyph_string_lists (&head
, &tail
, h
, t
);
21407 if (clip_head
|| clip_tail
)
21408 for (s
= head
; s
; s
= s
->next
)
21410 s
->clip_head
= clip_head
;
21411 s
->clip_tail
= clip_tail
;
21415 /* Draw all strings. */
21416 for (s
= head
; s
; s
= s
->next
)
21417 FRAME_RIF (f
)->draw_glyph_string (s
);
21420 /* When focus a sole frame and move horizontally, this sets on_p to 0
21421 causing a failure to erase prev cursor position. */
21422 if (area
== TEXT_AREA
21423 && !row
->full_width_p
21424 /* When drawing overlapping rows, only the glyph strings'
21425 foreground is drawn, which doesn't erase a cursor
21429 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21430 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21431 : (tail
? tail
->x
+ tail
->background_width
: x
));
21435 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21436 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21440 /* Value is the x-position up to which drawn, relative to AREA of W.
21441 This doesn't include parts drawn because of overhangs. */
21442 if (row
->full_width_p
)
21443 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21445 x_reached
-= area_left
;
21447 RELEASE_HDC (hdc
, f
);
21452 /* Expand row matrix if too narrow. Don't expand if area
21455 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21457 if (!fonts_changed_p \
21458 && (it->glyph_row->glyphs[area] \
21459 < it->glyph_row->glyphs[area + 1])) \
21461 it->w->ncols_scale_factor++; \
21462 fonts_changed_p = 1; \
21466 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21467 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21470 append_glyph (struct it
*it
)
21472 struct glyph
*glyph
;
21473 enum glyph_row_area area
= it
->area
;
21475 xassert (it
->glyph_row
);
21476 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21478 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21479 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21481 /* If the glyph row is reversed, we need to prepend the glyph
21482 rather than append it. */
21483 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21487 /* Make room for the additional glyph. */
21488 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21490 glyph
= it
->glyph_row
->glyphs
[area
];
21492 glyph
->charpos
= CHARPOS (it
->position
);
21493 glyph
->object
= it
->object
;
21494 if (it
->pixel_width
> 0)
21496 glyph
->pixel_width
= it
->pixel_width
;
21497 glyph
->padding_p
= 0;
21501 /* Assure at least 1-pixel width. Otherwise, cursor can't
21502 be displayed correctly. */
21503 glyph
->pixel_width
= 1;
21504 glyph
->padding_p
= 1;
21506 glyph
->ascent
= it
->ascent
;
21507 glyph
->descent
= it
->descent
;
21508 glyph
->voffset
= it
->voffset
;
21509 glyph
->type
= CHAR_GLYPH
;
21510 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21511 glyph
->multibyte_p
= it
->multibyte_p
;
21512 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21513 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21514 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21515 || it
->phys_descent
> it
->descent
);
21516 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21517 glyph
->face_id
= it
->face_id
;
21518 glyph
->u
.ch
= it
->char_to_display
;
21519 glyph
->slice
.img
= null_glyph_slice
;
21520 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21523 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21524 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21526 glyph
->bidi_type
= it
->bidi_it
.type
;
21530 glyph
->resolved_level
= 0;
21531 glyph
->bidi_type
= UNKNOWN_BT
;
21533 ++it
->glyph_row
->used
[area
];
21536 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21539 /* Store one glyph for the composition IT->cmp_it.id in
21540 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21544 append_composite_glyph (struct it
*it
)
21546 struct glyph
*glyph
;
21547 enum glyph_row_area area
= it
->area
;
21549 xassert (it
->glyph_row
);
21551 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21552 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21554 /* If the glyph row is reversed, we need to prepend the glyph
21555 rather than append it. */
21556 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21560 /* Make room for the new glyph. */
21561 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21563 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21565 glyph
->charpos
= it
->cmp_it
.charpos
;
21566 glyph
->object
= it
->object
;
21567 glyph
->pixel_width
= it
->pixel_width
;
21568 glyph
->ascent
= it
->ascent
;
21569 glyph
->descent
= it
->descent
;
21570 glyph
->voffset
= it
->voffset
;
21571 glyph
->type
= COMPOSITE_GLYPH
;
21572 if (it
->cmp_it
.ch
< 0)
21574 glyph
->u
.cmp
.automatic
= 0;
21575 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21576 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21580 glyph
->u
.cmp
.automatic
= 1;
21581 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21582 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21583 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21585 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21586 glyph
->multibyte_p
= it
->multibyte_p
;
21587 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21588 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21589 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21590 || it
->phys_descent
> it
->descent
);
21591 glyph
->padding_p
= 0;
21592 glyph
->glyph_not_available_p
= 0;
21593 glyph
->face_id
= it
->face_id
;
21594 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21597 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21598 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21600 glyph
->bidi_type
= it
->bidi_it
.type
;
21602 ++it
->glyph_row
->used
[area
];
21605 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21609 /* Change IT->ascent and IT->height according to the setting of
21613 take_vertical_position_into_account (struct it
*it
)
21617 if (it
->voffset
< 0)
21618 /* Increase the ascent so that we can display the text higher
21620 it
->ascent
-= it
->voffset
;
21622 /* Increase the descent so that we can display the text lower
21624 it
->descent
+= it
->voffset
;
21629 /* Produce glyphs/get display metrics for the image IT is loaded with.
21630 See the description of struct display_iterator in dispextern.h for
21631 an overview of struct display_iterator. */
21634 produce_image_glyph (struct it
*it
)
21638 int glyph_ascent
, crop
;
21639 struct glyph_slice slice
;
21641 xassert (it
->what
== IT_IMAGE
);
21643 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21645 /* Make sure X resources of the face is loaded. */
21646 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21648 if (it
->image_id
< 0)
21650 /* Fringe bitmap. */
21651 it
->ascent
= it
->phys_ascent
= 0;
21652 it
->descent
= it
->phys_descent
= 0;
21653 it
->pixel_width
= 0;
21658 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21660 /* Make sure X resources of the image is loaded. */
21661 prepare_image_for_display (it
->f
, img
);
21663 slice
.x
= slice
.y
= 0;
21664 slice
.width
= img
->width
;
21665 slice
.height
= img
->height
;
21667 if (INTEGERP (it
->slice
.x
))
21668 slice
.x
= XINT (it
->slice
.x
);
21669 else if (FLOATP (it
->slice
.x
))
21670 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21672 if (INTEGERP (it
->slice
.y
))
21673 slice
.y
= XINT (it
->slice
.y
);
21674 else if (FLOATP (it
->slice
.y
))
21675 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21677 if (INTEGERP (it
->slice
.width
))
21678 slice
.width
= XINT (it
->slice
.width
);
21679 else if (FLOATP (it
->slice
.width
))
21680 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21682 if (INTEGERP (it
->slice
.height
))
21683 slice
.height
= XINT (it
->slice
.height
);
21684 else if (FLOATP (it
->slice
.height
))
21685 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21687 if (slice
.x
>= img
->width
)
21688 slice
.x
= img
->width
;
21689 if (slice
.y
>= img
->height
)
21690 slice
.y
= img
->height
;
21691 if (slice
.x
+ slice
.width
>= img
->width
)
21692 slice
.width
= img
->width
- slice
.x
;
21693 if (slice
.y
+ slice
.height
> img
->height
)
21694 slice
.height
= img
->height
- slice
.y
;
21696 if (slice
.width
== 0 || slice
.height
== 0)
21699 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21701 it
->descent
= slice
.height
- glyph_ascent
;
21703 it
->descent
+= img
->vmargin
;
21704 if (slice
.y
+ slice
.height
== img
->height
)
21705 it
->descent
+= img
->vmargin
;
21706 it
->phys_descent
= it
->descent
;
21708 it
->pixel_width
= slice
.width
;
21710 it
->pixel_width
+= img
->hmargin
;
21711 if (slice
.x
+ slice
.width
== img
->width
)
21712 it
->pixel_width
+= img
->hmargin
;
21714 /* It's quite possible for images to have an ascent greater than
21715 their height, so don't get confused in that case. */
21716 if (it
->descent
< 0)
21721 if (face
->box
!= FACE_NO_BOX
)
21723 if (face
->box_line_width
> 0)
21726 it
->ascent
+= face
->box_line_width
;
21727 if (slice
.y
+ slice
.height
== img
->height
)
21728 it
->descent
+= face
->box_line_width
;
21731 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21732 it
->pixel_width
+= eabs (face
->box_line_width
);
21733 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21734 it
->pixel_width
+= eabs (face
->box_line_width
);
21737 take_vertical_position_into_account (it
);
21739 /* Automatically crop wide image glyphs at right edge so we can
21740 draw the cursor on same display row. */
21741 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21742 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21744 it
->pixel_width
-= crop
;
21745 slice
.width
-= crop
;
21750 struct glyph
*glyph
;
21751 enum glyph_row_area area
= it
->area
;
21753 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21754 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21756 glyph
->charpos
= CHARPOS (it
->position
);
21757 glyph
->object
= it
->object
;
21758 glyph
->pixel_width
= it
->pixel_width
;
21759 glyph
->ascent
= glyph_ascent
;
21760 glyph
->descent
= it
->descent
;
21761 glyph
->voffset
= it
->voffset
;
21762 glyph
->type
= IMAGE_GLYPH
;
21763 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21764 glyph
->multibyte_p
= it
->multibyte_p
;
21765 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21766 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21767 glyph
->overlaps_vertically_p
= 0;
21768 glyph
->padding_p
= 0;
21769 glyph
->glyph_not_available_p
= 0;
21770 glyph
->face_id
= it
->face_id
;
21771 glyph
->u
.img_id
= img
->id
;
21772 glyph
->slice
.img
= slice
;
21773 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21776 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21777 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21779 glyph
->bidi_type
= it
->bidi_it
.type
;
21781 ++it
->glyph_row
->used
[area
];
21784 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21789 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21790 of the glyph, WIDTH and HEIGHT are the width and height of the
21791 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21794 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21795 int width
, int height
, int ascent
)
21797 struct glyph
*glyph
;
21798 enum glyph_row_area area
= it
->area
;
21800 xassert (ascent
>= 0 && ascent
<= height
);
21802 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21803 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21805 /* If the glyph row is reversed, we need to prepend the glyph
21806 rather than append it. */
21807 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21811 /* Make room for the additional glyph. */
21812 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21814 glyph
= it
->glyph_row
->glyphs
[area
];
21816 glyph
->charpos
= CHARPOS (it
->position
);
21817 glyph
->object
= object
;
21818 glyph
->pixel_width
= width
;
21819 glyph
->ascent
= ascent
;
21820 glyph
->descent
= height
- ascent
;
21821 glyph
->voffset
= it
->voffset
;
21822 glyph
->type
= STRETCH_GLYPH
;
21823 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21824 glyph
->multibyte_p
= it
->multibyte_p
;
21825 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21826 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21827 glyph
->overlaps_vertically_p
= 0;
21828 glyph
->padding_p
= 0;
21829 glyph
->glyph_not_available_p
= 0;
21830 glyph
->face_id
= it
->face_id
;
21831 glyph
->u
.stretch
.ascent
= ascent
;
21832 glyph
->u
.stretch
.height
= height
;
21833 glyph
->slice
.img
= null_glyph_slice
;
21834 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21837 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21838 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21840 glyph
->bidi_type
= it
->bidi_it
.type
;
21844 glyph
->resolved_level
= 0;
21845 glyph
->bidi_type
= UNKNOWN_BT
;
21847 ++it
->glyph_row
->used
[area
];
21850 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21854 /* Produce a stretch glyph for iterator IT. IT->object is the value
21855 of the glyph property displayed. The value must be a list
21856 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21859 1. `:width WIDTH' specifies that the space should be WIDTH *
21860 canonical char width wide. WIDTH may be an integer or floating
21863 2. `:relative-width FACTOR' specifies that the width of the stretch
21864 should be computed from the width of the first character having the
21865 `glyph' property, and should be FACTOR times that width.
21867 3. `:align-to HPOS' specifies that the space should be wide enough
21868 to reach HPOS, a value in canonical character units.
21870 Exactly one of the above pairs must be present.
21872 4. `:height HEIGHT' specifies that the height of the stretch produced
21873 should be HEIGHT, measured in canonical character units.
21875 5. `:relative-height FACTOR' specifies that the height of the
21876 stretch should be FACTOR times the height of the characters having
21877 the glyph property.
21879 Either none or exactly one of 4 or 5 must be present.
21881 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21882 of the stretch should be used for the ascent of the stretch.
21883 ASCENT must be in the range 0 <= ASCENT <= 100. */
21886 produce_stretch_glyph (struct it
*it
)
21888 /* (space :width WIDTH :height HEIGHT ...) */
21889 Lisp_Object prop
, plist
;
21890 int width
= 0, height
= 0, align_to
= -1;
21891 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21894 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21895 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21897 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21899 /* List should start with `space'. */
21900 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21901 plist
= XCDR (it
->object
);
21903 /* Compute the width of the stretch. */
21904 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21905 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21907 /* Absolute width `:width WIDTH' specified and valid. */
21908 zero_width_ok_p
= 1;
21911 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21914 /* Relative width `:relative-width FACTOR' specified and valid.
21915 Compute the width of the characters having the `glyph'
21918 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21921 if (it
->multibyte_p
)
21922 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21925 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21926 if (! ASCII_CHAR_P (it2
.c
))
21927 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21930 it2
.glyph_row
= NULL
;
21931 it2
.what
= IT_CHARACTER
;
21932 x_produce_glyphs (&it2
);
21933 width
= NUMVAL (prop
) * it2
.pixel_width
;
21935 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21936 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21938 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21939 align_to
= (align_to
< 0
21941 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21942 else if (align_to
< 0)
21943 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21944 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21945 zero_width_ok_p
= 1;
21948 /* Nothing specified -> width defaults to canonical char width. */
21949 width
= FRAME_COLUMN_WIDTH (it
->f
);
21951 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21954 /* Compute height. */
21955 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21956 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21959 zero_height_ok_p
= 1;
21961 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21963 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21965 height
= FONT_HEIGHT (font
);
21967 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21970 /* Compute percentage of height used for ascent. If
21971 `:ascent ASCENT' is present and valid, use that. Otherwise,
21972 derive the ascent from the font in use. */
21973 if (prop
= Fplist_get (plist
, QCascent
),
21974 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21975 ascent
= height
* NUMVAL (prop
) / 100.0;
21976 else if (!NILP (prop
)
21977 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21978 ascent
= min (max (0, (int)tem
), height
);
21980 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21982 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21983 && it
->current_x
+ width
> it
->last_visible_x
)
21984 width
= it
->last_visible_x
- it
->current_x
- 1;
21986 if (width
> 0 && height
> 0 && it
->glyph_row
)
21988 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21989 if (!STRINGP (object
))
21990 object
= it
->w
->buffer
;
21991 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21994 it
->pixel_width
= width
;
21995 it
->ascent
= it
->phys_ascent
= ascent
;
21996 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21997 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21999 take_vertical_position_into_account (it
);
22002 /* Calculate line-height and line-spacing properties.
22003 An integer value specifies explicit pixel value.
22004 A float value specifies relative value to current face height.
22005 A cons (float . face-name) specifies relative value to
22006 height of specified face font.
22008 Returns height in pixels, or nil. */
22012 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22013 int boff
, int override
)
22015 Lisp_Object face_name
= Qnil
;
22016 int ascent
, descent
, height
;
22018 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22023 face_name
= XCAR (val
);
22025 if (!NUMBERP (val
))
22026 val
= make_number (1);
22027 if (NILP (face_name
))
22029 height
= it
->ascent
+ it
->descent
;
22034 if (NILP (face_name
))
22036 font
= FRAME_FONT (it
->f
);
22037 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22039 else if (EQ (face_name
, Qt
))
22048 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22050 return make_number (-1);
22052 face
= FACE_FROM_ID (it
->f
, face_id
);
22055 return make_number (-1);
22056 boff
= font
->baseline_offset
;
22057 if (font
->vertical_centering
)
22058 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22061 ascent
= FONT_BASE (font
) + boff
;
22062 descent
= FONT_DESCENT (font
) - boff
;
22066 it
->override_ascent
= ascent
;
22067 it
->override_descent
= descent
;
22068 it
->override_boff
= boff
;
22071 height
= ascent
+ descent
;
22075 height
= (int)(XFLOAT_DATA (val
) * height
);
22076 else if (INTEGERP (val
))
22077 height
*= XINT (val
);
22079 return make_number (height
);
22083 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22084 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22085 and only if this is for a character for which no font was found.
22087 If the display method (it->glyphless_method) is
22088 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22089 length of the acronym or the hexadecimal string, UPPER_XOFF and
22090 UPPER_YOFF are pixel offsets for the upper part of the string,
22091 LOWER_XOFF and LOWER_YOFF are for the lower part.
22093 For the other display methods, LEN through LOWER_YOFF are zero. */
22096 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22097 short upper_xoff
, short upper_yoff
,
22098 short lower_xoff
, short lower_yoff
)
22100 struct glyph
*glyph
;
22101 enum glyph_row_area area
= it
->area
;
22103 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22104 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22106 /* If the glyph row is reversed, we need to prepend the glyph
22107 rather than append it. */
22108 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22112 /* Make room for the additional glyph. */
22113 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22115 glyph
= it
->glyph_row
->glyphs
[area
];
22117 glyph
->charpos
= CHARPOS (it
->position
);
22118 glyph
->object
= it
->object
;
22119 glyph
->pixel_width
= it
->pixel_width
;
22120 glyph
->ascent
= it
->ascent
;
22121 glyph
->descent
= it
->descent
;
22122 glyph
->voffset
= it
->voffset
;
22123 glyph
->type
= GLYPHLESS_GLYPH
;
22124 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22125 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22126 glyph
->u
.glyphless
.len
= len
;
22127 glyph
->u
.glyphless
.ch
= it
->c
;
22128 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22129 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22130 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22131 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22132 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22133 glyph
->multibyte_p
= it
->multibyte_p
;
22134 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22135 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22136 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22137 || it
->phys_descent
> it
->descent
);
22138 glyph
->padding_p
= 0;
22139 glyph
->glyph_not_available_p
= 0;
22140 glyph
->face_id
= face_id
;
22141 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22144 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22145 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22147 glyph
->bidi_type
= it
->bidi_it
.type
;
22149 ++it
->glyph_row
->used
[area
];
22152 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22156 /* Produce a glyph for a glyphless character for iterator IT.
22157 IT->glyphless_method specifies which method to use for displaying
22158 the character. See the description of enum
22159 glyphless_display_method in dispextern.h for the detail.
22161 FOR_NO_FONT is nonzero if and only if this is for a character for
22162 which no font was found. ACRONYM, if non-nil, is an acronym string
22163 for the character. */
22166 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22171 int base_width
, base_height
, width
, height
;
22172 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22175 /* Get the metrics of the base font. We always refer to the current
22177 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22178 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22179 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22180 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22181 base_height
= it
->ascent
+ it
->descent
;
22182 base_width
= font
->average_width
;
22184 /* Get a face ID for the glyph by utilizing a cache (the same way as
22185 doen for `escape-glyph' in get_next_display_element). */
22186 if (it
->f
== last_glyphless_glyph_frame
22187 && it
->face_id
== last_glyphless_glyph_face_id
)
22189 face_id
= last_glyphless_glyph_merged_face_id
;
22193 /* Merge the `glyphless-char' face into the current face. */
22194 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22195 last_glyphless_glyph_frame
= it
->f
;
22196 last_glyphless_glyph_face_id
= it
->face_id
;
22197 last_glyphless_glyph_merged_face_id
= face_id
;
22200 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22202 it
->pixel_width
= THIN_SPACE_WIDTH
;
22204 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22206 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22208 width
= CHAR_WIDTH (it
->c
);
22211 else if (width
> 4)
22213 it
->pixel_width
= base_width
* width
;
22215 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22220 unsigned int code
[6];
22222 int ascent
, descent
;
22223 struct font_metrics metrics_upper
, metrics_lower
;
22225 face
= FACE_FROM_ID (it
->f
, face_id
);
22226 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22227 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22229 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22231 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22232 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22233 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22237 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22238 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22241 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22242 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22243 upper_len
= (len
+ 1) / 2;
22244 font
->driver
->text_extents (font
, code
, upper_len
,
22246 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22251 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22252 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22253 upper_xoff
= upper_yoff
= 2; /* the typical case */
22254 if (base_width
>= width
)
22256 /* Align the upper to the left, the lower to the right. */
22257 it
->pixel_width
= base_width
;
22258 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22262 /* Center the shorter one. */
22263 it
->pixel_width
= width
;
22264 if (metrics_upper
.width
>= metrics_lower
.width
)
22265 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22267 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22270 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22271 top, bottom, and between upper and lower strings. */
22272 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22273 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22274 /* Center vertically.
22275 H:base_height, D:base_descent
22276 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22278 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22279 descent = D - H/2 + h/2;
22280 lower_yoff = descent - 2 - ld;
22281 upper_yoff = lower_yoff - la - 1 - ud; */
22282 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22283 descent
= it
->descent
- (base_height
- height
) / 2;
22284 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22285 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22286 - metrics_upper
.descent
);
22287 /* Don't make the height shorter than the base height. */
22288 if (height
> base_height
)
22290 it
->ascent
= ascent
;
22291 it
->descent
= descent
;
22295 it
->phys_ascent
= it
->ascent
;
22296 it
->phys_descent
= it
->descent
;
22298 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22299 upper_xoff
, upper_yoff
,
22300 lower_xoff
, lower_yoff
);
22302 take_vertical_position_into_account (it
);
22307 Produce glyphs/get display metrics for the display element IT is
22308 loaded with. See the description of struct it in dispextern.h
22309 for an overview of struct it. */
22312 x_produce_glyphs (struct it
*it
)
22314 int extra_line_spacing
= it
->extra_line_spacing
;
22316 it
->glyph_not_available_p
= 0;
22318 if (it
->what
== IT_CHARACTER
)
22321 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22322 struct font
*font
= face
->font
;
22323 struct font_metrics
*pcm
= NULL
;
22324 int boff
; /* baseline offset */
22328 /* When no suitable font is found, display this character by
22329 the method specified in the first extra slot of
22330 Vglyphless_char_display. */
22331 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22333 xassert (it
->what
== IT_GLYPHLESS
);
22334 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22338 boff
= font
->baseline_offset
;
22339 if (font
->vertical_centering
)
22340 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22342 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22348 if (it
->override_ascent
>= 0)
22350 it
->ascent
= it
->override_ascent
;
22351 it
->descent
= it
->override_descent
;
22352 boff
= it
->override_boff
;
22356 it
->ascent
= FONT_BASE (font
) + boff
;
22357 it
->descent
= FONT_DESCENT (font
) - boff
;
22360 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22362 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22363 if (pcm
->width
== 0
22364 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22370 it
->phys_ascent
= pcm
->ascent
+ boff
;
22371 it
->phys_descent
= pcm
->descent
- boff
;
22372 it
->pixel_width
= pcm
->width
;
22376 it
->glyph_not_available_p
= 1;
22377 it
->phys_ascent
= it
->ascent
;
22378 it
->phys_descent
= it
->descent
;
22379 it
->pixel_width
= font
->space_width
;
22382 if (it
->constrain_row_ascent_descent_p
)
22384 if (it
->descent
> it
->max_descent
)
22386 it
->ascent
+= it
->descent
- it
->max_descent
;
22387 it
->descent
= it
->max_descent
;
22389 if (it
->ascent
> it
->max_ascent
)
22391 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22392 it
->ascent
= it
->max_ascent
;
22394 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22395 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22396 extra_line_spacing
= 0;
22399 /* If this is a space inside a region of text with
22400 `space-width' property, change its width. */
22401 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22403 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22405 /* If face has a box, add the box thickness to the character
22406 height. If character has a box line to the left and/or
22407 right, add the box line width to the character's width. */
22408 if (face
->box
!= FACE_NO_BOX
)
22410 int thick
= face
->box_line_width
;
22414 it
->ascent
+= thick
;
22415 it
->descent
+= thick
;
22420 if (it
->start_of_box_run_p
)
22421 it
->pixel_width
+= thick
;
22422 if (it
->end_of_box_run_p
)
22423 it
->pixel_width
+= thick
;
22426 /* If face has an overline, add the height of the overline
22427 (1 pixel) and a 1 pixel margin to the character height. */
22428 if (face
->overline_p
)
22429 it
->ascent
+= overline_margin
;
22431 if (it
->constrain_row_ascent_descent_p
)
22433 if (it
->ascent
> it
->max_ascent
)
22434 it
->ascent
= it
->max_ascent
;
22435 if (it
->descent
> it
->max_descent
)
22436 it
->descent
= it
->max_descent
;
22439 take_vertical_position_into_account (it
);
22441 /* If we have to actually produce glyphs, do it. */
22446 /* Translate a space with a `space-width' property
22447 into a stretch glyph. */
22448 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22449 / FONT_HEIGHT (font
));
22450 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22451 it
->ascent
+ it
->descent
, ascent
);
22456 /* If characters with lbearing or rbearing are displayed
22457 in this line, record that fact in a flag of the
22458 glyph row. This is used to optimize X output code. */
22459 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22460 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22462 if (! stretched_p
&& it
->pixel_width
== 0)
22463 /* We assure that all visible glyphs have at least 1-pixel
22465 it
->pixel_width
= 1;
22467 else if (it
->char_to_display
== '\n')
22469 /* A newline has no width, but we need the height of the
22470 line. But if previous part of the line sets a height,
22471 don't increase that height */
22473 Lisp_Object height
;
22474 Lisp_Object total_height
= Qnil
;
22476 it
->override_ascent
= -1;
22477 it
->pixel_width
= 0;
22480 height
= get_it_property (it
, Qline_height
);
22481 /* Split (line-height total-height) list */
22483 && CONSP (XCDR (height
))
22484 && NILP (XCDR (XCDR (height
))))
22486 total_height
= XCAR (XCDR (height
));
22487 height
= XCAR (height
);
22489 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22491 if (it
->override_ascent
>= 0)
22493 it
->ascent
= it
->override_ascent
;
22494 it
->descent
= it
->override_descent
;
22495 boff
= it
->override_boff
;
22499 it
->ascent
= FONT_BASE (font
) + boff
;
22500 it
->descent
= FONT_DESCENT (font
) - boff
;
22503 if (EQ (height
, Qt
))
22505 if (it
->descent
> it
->max_descent
)
22507 it
->ascent
+= it
->descent
- it
->max_descent
;
22508 it
->descent
= it
->max_descent
;
22510 if (it
->ascent
> it
->max_ascent
)
22512 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22513 it
->ascent
= it
->max_ascent
;
22515 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22516 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22517 it
->constrain_row_ascent_descent_p
= 1;
22518 extra_line_spacing
= 0;
22522 Lisp_Object spacing
;
22524 it
->phys_ascent
= it
->ascent
;
22525 it
->phys_descent
= it
->descent
;
22527 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22528 && face
->box
!= FACE_NO_BOX
22529 && face
->box_line_width
> 0)
22531 it
->ascent
+= face
->box_line_width
;
22532 it
->descent
+= face
->box_line_width
;
22535 && XINT (height
) > it
->ascent
+ it
->descent
)
22536 it
->ascent
= XINT (height
) - it
->descent
;
22538 if (!NILP (total_height
))
22539 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22542 spacing
= get_it_property (it
, Qline_spacing
);
22543 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22545 if (INTEGERP (spacing
))
22547 extra_line_spacing
= XINT (spacing
);
22548 if (!NILP (total_height
))
22549 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22553 else /* i.e. (it->char_to_display == '\t') */
22555 if (font
->space_width
> 0)
22557 int tab_width
= it
->tab_width
* font
->space_width
;
22558 int x
= it
->current_x
+ it
->continuation_lines_width
;
22559 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22561 /* If the distance from the current position to the next tab
22562 stop is less than a space character width, use the
22563 tab stop after that. */
22564 if (next_tab_x
- x
< font
->space_width
)
22565 next_tab_x
+= tab_width
;
22567 it
->pixel_width
= next_tab_x
- x
;
22569 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22570 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22574 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22575 it
->ascent
+ it
->descent
, it
->ascent
);
22580 it
->pixel_width
= 0;
22585 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22587 /* A static composition.
22589 Note: A composition is represented as one glyph in the
22590 glyph matrix. There are no padding glyphs.
22592 Important note: pixel_width, ascent, and descent are the
22593 values of what is drawn by draw_glyphs (i.e. the values of
22594 the overall glyphs composed). */
22595 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22596 int boff
; /* baseline offset */
22597 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22598 int glyph_len
= cmp
->glyph_len
;
22599 struct font
*font
= face
->font
;
22603 /* If we have not yet calculated pixel size data of glyphs of
22604 the composition for the current face font, calculate them
22605 now. Theoretically, we have to check all fonts for the
22606 glyphs, but that requires much time and memory space. So,
22607 here we check only the font of the first glyph. This may
22608 lead to incorrect display, but it's very rare, and C-l
22609 (recenter-top-bottom) can correct the display anyway. */
22610 if (! cmp
->font
|| cmp
->font
!= font
)
22612 /* Ascent and descent of the font of the first character
22613 of this composition (adjusted by baseline offset).
22614 Ascent and descent of overall glyphs should not be less
22615 than these, respectively. */
22616 int font_ascent
, font_descent
, font_height
;
22617 /* Bounding box of the overall glyphs. */
22618 int leftmost
, rightmost
, lowest
, highest
;
22619 int lbearing
, rbearing
;
22620 int i
, width
, ascent
, descent
;
22621 int left_padded
= 0, right_padded
= 0;
22624 struct font_metrics
*pcm
;
22625 int font_not_found_p
;
22628 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22629 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22631 if (glyph_len
< cmp
->glyph_len
)
22633 for (i
= 0; i
< glyph_len
; i
++)
22635 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22637 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22642 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22643 : IT_CHARPOS (*it
));
22644 /* If no suitable font is found, use the default font. */
22645 font_not_found_p
= font
== NULL
;
22646 if (font_not_found_p
)
22648 face
= face
->ascii_face
;
22651 boff
= font
->baseline_offset
;
22652 if (font
->vertical_centering
)
22653 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22654 font_ascent
= FONT_BASE (font
) + boff
;
22655 font_descent
= FONT_DESCENT (font
) - boff
;
22656 font_height
= FONT_HEIGHT (font
);
22658 cmp
->font
= (void *) font
;
22661 if (! font_not_found_p
)
22663 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22664 &char2b
, it
->multibyte_p
, 0);
22665 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22668 /* Initialize the bounding box. */
22671 width
= pcm
->width
;
22672 ascent
= pcm
->ascent
;
22673 descent
= pcm
->descent
;
22674 lbearing
= pcm
->lbearing
;
22675 rbearing
= pcm
->rbearing
;
22679 width
= font
->space_width
;
22680 ascent
= FONT_BASE (font
);
22681 descent
= FONT_DESCENT (font
);
22688 lowest
= - descent
+ boff
;
22689 highest
= ascent
+ boff
;
22691 if (! font_not_found_p
22692 && font
->default_ascent
22693 && CHAR_TABLE_P (Vuse_default_ascent
)
22694 && !NILP (Faref (Vuse_default_ascent
,
22695 make_number (it
->char_to_display
))))
22696 highest
= font
->default_ascent
+ boff
;
22698 /* Draw the first glyph at the normal position. It may be
22699 shifted to right later if some other glyphs are drawn
22701 cmp
->offsets
[i
* 2] = 0;
22702 cmp
->offsets
[i
* 2 + 1] = boff
;
22703 cmp
->lbearing
= lbearing
;
22704 cmp
->rbearing
= rbearing
;
22706 /* Set cmp->offsets for the remaining glyphs. */
22707 for (i
++; i
< glyph_len
; i
++)
22709 int left
, right
, btm
, top
;
22710 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22712 struct face
*this_face
;
22717 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22718 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22719 font
= this_face
->font
;
22725 this_boff
= font
->baseline_offset
;
22726 if (font
->vertical_centering
)
22727 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22728 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22729 &char2b
, it
->multibyte_p
, 0);
22730 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22733 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22736 width
= pcm
->width
;
22737 ascent
= pcm
->ascent
;
22738 descent
= pcm
->descent
;
22739 lbearing
= pcm
->lbearing
;
22740 rbearing
= pcm
->rbearing
;
22741 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22743 /* Relative composition with or without
22744 alternate chars. */
22745 left
= (leftmost
+ rightmost
- width
) / 2;
22746 btm
= - descent
+ boff
;
22747 if (font
->relative_compose
22748 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22749 || NILP (Faref (Vignore_relative_composition
,
22750 make_number (ch
)))))
22753 if (- descent
>= font
->relative_compose
)
22754 /* One extra pixel between two glyphs. */
22756 else if (ascent
<= 0)
22757 /* One extra pixel between two glyphs. */
22758 btm
= lowest
- 1 - ascent
- descent
;
22763 /* A composition rule is specified by an integer
22764 value that encodes global and new reference
22765 points (GREF and NREF). GREF and NREF are
22766 specified by numbers as below:
22768 0---1---2 -- ascent
22772 9--10--11 -- center
22774 ---3---4---5--- baseline
22776 6---7---8 -- descent
22778 int rule
= COMPOSITION_RULE (cmp
, i
);
22779 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22781 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22782 grefx
= gref
% 3, nrefx
= nref
% 3;
22783 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22785 xoff
= font_height
* (xoff
- 128) / 256;
22787 yoff
= font_height
* (yoff
- 128) / 256;
22790 + grefx
* (rightmost
- leftmost
) / 2
22791 - nrefx
* width
/ 2
22794 btm
= ((grefy
== 0 ? highest
22796 : grefy
== 2 ? lowest
22797 : (highest
+ lowest
) / 2)
22798 - (nrefy
== 0 ? ascent
+ descent
22799 : nrefy
== 1 ? descent
- boff
22801 : (ascent
+ descent
) / 2)
22805 cmp
->offsets
[i
* 2] = left
;
22806 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22808 /* Update the bounding box of the overall glyphs. */
22811 right
= left
+ width
;
22812 if (left
< leftmost
)
22814 if (right
> rightmost
)
22817 top
= btm
+ descent
+ ascent
;
22823 if (cmp
->lbearing
> left
+ lbearing
)
22824 cmp
->lbearing
= left
+ lbearing
;
22825 if (cmp
->rbearing
< left
+ rbearing
)
22826 cmp
->rbearing
= left
+ rbearing
;
22830 /* If there are glyphs whose x-offsets are negative,
22831 shift all glyphs to the right and make all x-offsets
22835 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22836 cmp
->offsets
[i
* 2] -= leftmost
;
22837 rightmost
-= leftmost
;
22838 cmp
->lbearing
-= leftmost
;
22839 cmp
->rbearing
-= leftmost
;
22842 if (left_padded
&& cmp
->lbearing
< 0)
22844 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22845 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22846 rightmost
-= cmp
->lbearing
;
22847 cmp
->rbearing
-= cmp
->lbearing
;
22850 if (right_padded
&& rightmost
< cmp
->rbearing
)
22852 rightmost
= cmp
->rbearing
;
22855 cmp
->pixel_width
= rightmost
;
22856 cmp
->ascent
= highest
;
22857 cmp
->descent
= - lowest
;
22858 if (cmp
->ascent
< font_ascent
)
22859 cmp
->ascent
= font_ascent
;
22860 if (cmp
->descent
< font_descent
)
22861 cmp
->descent
= font_descent
;
22865 && (cmp
->lbearing
< 0
22866 || cmp
->rbearing
> cmp
->pixel_width
))
22867 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22869 it
->pixel_width
= cmp
->pixel_width
;
22870 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22871 it
->descent
= it
->phys_descent
= cmp
->descent
;
22872 if (face
->box
!= FACE_NO_BOX
)
22874 int thick
= face
->box_line_width
;
22878 it
->ascent
+= thick
;
22879 it
->descent
+= thick
;
22884 if (it
->start_of_box_run_p
)
22885 it
->pixel_width
+= thick
;
22886 if (it
->end_of_box_run_p
)
22887 it
->pixel_width
+= thick
;
22890 /* If face has an overline, add the height of the overline
22891 (1 pixel) and a 1 pixel margin to the character height. */
22892 if (face
->overline_p
)
22893 it
->ascent
+= overline_margin
;
22895 take_vertical_position_into_account (it
);
22896 if (it
->ascent
< 0)
22898 if (it
->descent
< 0)
22902 append_composite_glyph (it
);
22904 else if (it
->what
== IT_COMPOSITION
)
22906 /* A dynamic (automatic) composition. */
22907 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22908 Lisp_Object gstring
;
22909 struct font_metrics metrics
;
22911 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22913 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22916 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22917 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22918 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22919 it
->descent
= it
->phys_descent
= metrics
.descent
;
22920 if (face
->box
!= FACE_NO_BOX
)
22922 int thick
= face
->box_line_width
;
22926 it
->ascent
+= thick
;
22927 it
->descent
+= thick
;
22932 if (it
->start_of_box_run_p
)
22933 it
->pixel_width
+= thick
;
22934 if (it
->end_of_box_run_p
)
22935 it
->pixel_width
+= thick
;
22937 /* If face has an overline, add the height of the overline
22938 (1 pixel) and a 1 pixel margin to the character height. */
22939 if (face
->overline_p
)
22940 it
->ascent
+= overline_margin
;
22941 take_vertical_position_into_account (it
);
22942 if (it
->ascent
< 0)
22944 if (it
->descent
< 0)
22948 append_composite_glyph (it
);
22950 else if (it
->what
== IT_GLYPHLESS
)
22951 produce_glyphless_glyph (it
, 0, Qnil
);
22952 else if (it
->what
== IT_IMAGE
)
22953 produce_image_glyph (it
);
22954 else if (it
->what
== IT_STRETCH
)
22955 produce_stretch_glyph (it
);
22958 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22959 because this isn't true for images with `:ascent 100'. */
22960 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22961 if (it
->area
== TEXT_AREA
)
22962 it
->current_x
+= it
->pixel_width
;
22964 if (extra_line_spacing
> 0)
22966 it
->descent
+= extra_line_spacing
;
22967 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22968 it
->max_extra_line_spacing
= extra_line_spacing
;
22971 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22972 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22973 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22974 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22978 Output LEN glyphs starting at START at the nominal cursor position.
22979 Advance the nominal cursor over the text. The global variable
22980 updated_window contains the window being updated, updated_row is
22981 the glyph row being updated, and updated_area is the area of that
22982 row being updated. */
22985 x_write_glyphs (struct glyph
*start
, int len
)
22989 xassert (updated_window
&& updated_row
);
22992 /* Write glyphs. */
22994 hpos
= start
- updated_row
->glyphs
[updated_area
];
22995 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22996 updated_row
, updated_area
,
22998 DRAW_NORMAL_TEXT
, 0);
23000 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23001 if (updated_area
== TEXT_AREA
23002 && updated_window
->phys_cursor_on_p
23003 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23004 && updated_window
->phys_cursor
.hpos
>= hpos
23005 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23006 updated_window
->phys_cursor_on_p
= 0;
23010 /* Advance the output cursor. */
23011 output_cursor
.hpos
+= len
;
23012 output_cursor
.x
= x
;
23017 Insert LEN glyphs from START at the nominal cursor position. */
23020 x_insert_glyphs (struct glyph
*start
, int len
)
23024 int line_height
, shift_by_width
, shifted_region_width
;
23025 struct glyph_row
*row
;
23026 struct glyph
*glyph
;
23027 int frame_x
, frame_y
;
23030 xassert (updated_window
&& updated_row
);
23032 w
= updated_window
;
23033 f
= XFRAME (WINDOW_FRAME (w
));
23035 /* Get the height of the line we are in. */
23037 line_height
= row
->height
;
23039 /* Get the width of the glyphs to insert. */
23040 shift_by_width
= 0;
23041 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23042 shift_by_width
+= glyph
->pixel_width
;
23044 /* Get the width of the region to shift right. */
23045 shifted_region_width
= (window_box_width (w
, updated_area
)
23050 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23051 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23053 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23054 line_height
, shift_by_width
);
23056 /* Write the glyphs. */
23057 hpos
= start
- row
->glyphs
[updated_area
];
23058 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23060 DRAW_NORMAL_TEXT
, 0);
23062 /* Advance the output cursor. */
23063 output_cursor
.hpos
+= len
;
23064 output_cursor
.x
+= shift_by_width
;
23070 Erase the current text line from the nominal cursor position
23071 (inclusive) to pixel column TO_X (exclusive). The idea is that
23072 everything from TO_X onward is already erased.
23074 TO_X is a pixel position relative to updated_area of
23075 updated_window. TO_X == -1 means clear to the end of this area. */
23078 x_clear_end_of_line (int to_x
)
23081 struct window
*w
= updated_window
;
23082 int max_x
, min_y
, max_y
;
23083 int from_x
, from_y
, to_y
;
23085 xassert (updated_window
&& updated_row
);
23086 f
= XFRAME (w
->frame
);
23088 if (updated_row
->full_width_p
)
23089 max_x
= WINDOW_TOTAL_WIDTH (w
);
23091 max_x
= window_box_width (w
, updated_area
);
23092 max_y
= window_text_bottom_y (w
);
23094 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23095 of window. For TO_X > 0, truncate to end of drawing area. */
23101 to_x
= min (to_x
, max_x
);
23103 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23105 /* Notice if the cursor will be cleared by this operation. */
23106 if (!updated_row
->full_width_p
)
23107 notice_overwritten_cursor (w
, updated_area
,
23108 output_cursor
.x
, -1,
23110 MATRIX_ROW_BOTTOM_Y (updated_row
));
23112 from_x
= output_cursor
.x
;
23114 /* Translate to frame coordinates. */
23115 if (updated_row
->full_width_p
)
23117 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23118 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23122 int area_left
= window_box_left (w
, updated_area
);
23123 from_x
+= area_left
;
23127 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23128 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23129 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23131 /* Prevent inadvertently clearing to end of the X window. */
23132 if (to_x
> from_x
&& to_y
> from_y
)
23135 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23136 to_x
- from_x
, to_y
- from_y
);
23141 #endif /* HAVE_WINDOW_SYSTEM */
23145 /***********************************************************************
23147 ***********************************************************************/
23149 /* Value is the internal representation of the specified cursor type
23150 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23151 of the bar cursor. */
23153 static enum text_cursor_kinds
23154 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23156 enum text_cursor_kinds type
;
23161 if (EQ (arg
, Qbox
))
23162 return FILLED_BOX_CURSOR
;
23164 if (EQ (arg
, Qhollow
))
23165 return HOLLOW_BOX_CURSOR
;
23167 if (EQ (arg
, Qbar
))
23174 && EQ (XCAR (arg
), Qbar
)
23175 && INTEGERP (XCDR (arg
))
23176 && XINT (XCDR (arg
)) >= 0)
23178 *width
= XINT (XCDR (arg
));
23182 if (EQ (arg
, Qhbar
))
23185 return HBAR_CURSOR
;
23189 && EQ (XCAR (arg
), Qhbar
)
23190 && INTEGERP (XCDR (arg
))
23191 && XINT (XCDR (arg
)) >= 0)
23193 *width
= XINT (XCDR (arg
));
23194 return HBAR_CURSOR
;
23197 /* Treat anything unknown as "hollow box cursor".
23198 It was bad to signal an error; people have trouble fixing
23199 .Xdefaults with Emacs, when it has something bad in it. */
23200 type
= HOLLOW_BOX_CURSOR
;
23205 /* Set the default cursor types for specified frame. */
23207 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23212 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23213 FRAME_CURSOR_WIDTH (f
) = width
;
23215 /* By default, set up the blink-off state depending on the on-state. */
23217 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23220 FRAME_BLINK_OFF_CURSOR (f
)
23221 = get_specified_cursor_type (XCDR (tem
), &width
);
23222 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23225 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23229 #ifdef HAVE_WINDOW_SYSTEM
23231 /* Return the cursor we want to be displayed in window W. Return
23232 width of bar/hbar cursor through WIDTH arg. Return with
23233 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23234 (i.e. if the `system caret' should track this cursor).
23236 In a mini-buffer window, we want the cursor only to appear if we
23237 are reading input from this window. For the selected window, we
23238 want the cursor type given by the frame parameter or buffer local
23239 setting of cursor-type. If explicitly marked off, draw no cursor.
23240 In all other cases, we want a hollow box cursor. */
23242 static enum text_cursor_kinds
23243 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23244 int *active_cursor
)
23246 struct frame
*f
= XFRAME (w
->frame
);
23247 struct buffer
*b
= XBUFFER (w
->buffer
);
23248 int cursor_type
= DEFAULT_CURSOR
;
23249 Lisp_Object alt_cursor
;
23250 int non_selected
= 0;
23252 *active_cursor
= 1;
23255 if (cursor_in_echo_area
23256 && FRAME_HAS_MINIBUF_P (f
)
23257 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23259 if (w
== XWINDOW (echo_area_window
))
23261 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23263 *width
= FRAME_CURSOR_WIDTH (f
);
23264 return FRAME_DESIRED_CURSOR (f
);
23267 return get_specified_cursor_type (b
->cursor_type
, width
);
23270 *active_cursor
= 0;
23274 /* Detect a nonselected window or nonselected frame. */
23275 else if (w
!= XWINDOW (f
->selected_window
)
23276 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23278 *active_cursor
= 0;
23280 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23286 /* Never display a cursor in a window in which cursor-type is nil. */
23287 if (NILP (b
->cursor_type
))
23290 /* Get the normal cursor type for this window. */
23291 if (EQ (b
->cursor_type
, Qt
))
23293 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23294 *width
= FRAME_CURSOR_WIDTH (f
);
23297 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23299 /* Use cursor-in-non-selected-windows instead
23300 for non-selected window or frame. */
23303 alt_cursor
= b
->cursor_in_non_selected_windows
;
23304 if (!EQ (Qt
, alt_cursor
))
23305 return get_specified_cursor_type (alt_cursor
, width
);
23306 /* t means modify the normal cursor type. */
23307 if (cursor_type
== FILLED_BOX_CURSOR
)
23308 cursor_type
= HOLLOW_BOX_CURSOR
;
23309 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23311 return cursor_type
;
23314 /* Use normal cursor if not blinked off. */
23315 if (!w
->cursor_off_p
)
23317 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23319 if (cursor_type
== FILLED_BOX_CURSOR
)
23321 /* Using a block cursor on large images can be very annoying.
23322 So use a hollow cursor for "large" images.
23323 If image is not transparent (no mask), also use hollow cursor. */
23324 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23325 if (img
!= NULL
&& IMAGEP (img
->spec
))
23327 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23328 where N = size of default frame font size.
23329 This should cover most of the "tiny" icons people may use. */
23331 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23332 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23333 cursor_type
= HOLLOW_BOX_CURSOR
;
23336 else if (cursor_type
!= NO_CURSOR
)
23338 /* Display current only supports BOX and HOLLOW cursors for images.
23339 So for now, unconditionally use a HOLLOW cursor when cursor is
23340 not a solid box cursor. */
23341 cursor_type
= HOLLOW_BOX_CURSOR
;
23344 return cursor_type
;
23347 /* Cursor is blinked off, so determine how to "toggle" it. */
23349 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23350 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23351 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23353 /* Then see if frame has specified a specific blink off cursor type. */
23354 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23356 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23357 return FRAME_BLINK_OFF_CURSOR (f
);
23361 /* Some people liked having a permanently visible blinking cursor,
23362 while others had very strong opinions against it. So it was
23363 decided to remove it. KFS 2003-09-03 */
23365 /* Finally perform built-in cursor blinking:
23366 filled box <-> hollow box
23367 wide [h]bar <-> narrow [h]bar
23368 narrow [h]bar <-> no cursor
23369 other type <-> no cursor */
23371 if (cursor_type
== FILLED_BOX_CURSOR
)
23372 return HOLLOW_BOX_CURSOR
;
23374 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23377 return cursor_type
;
23385 /* Notice when the text cursor of window W has been completely
23386 overwritten by a drawing operation that outputs glyphs in AREA
23387 starting at X0 and ending at X1 in the line starting at Y0 and
23388 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23389 the rest of the line after X0 has been written. Y coordinates
23390 are window-relative. */
23393 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23394 int x0
, int x1
, int y0
, int y1
)
23396 int cx0
, cx1
, cy0
, cy1
;
23397 struct glyph_row
*row
;
23399 if (!w
->phys_cursor_on_p
)
23401 if (area
!= TEXT_AREA
)
23404 if (w
->phys_cursor
.vpos
< 0
23405 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23406 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23407 !(row
->enabled_p
&& row
->displays_text_p
)))
23410 if (row
->cursor_in_fringe_p
)
23412 row
->cursor_in_fringe_p
= 0;
23413 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23414 w
->phys_cursor_on_p
= 0;
23418 cx0
= w
->phys_cursor
.x
;
23419 cx1
= cx0
+ w
->phys_cursor_width
;
23420 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23423 /* The cursor image will be completely removed from the
23424 screen if the output area intersects the cursor area in
23425 y-direction. When we draw in [y0 y1[, and some part of
23426 the cursor is at y < y0, that part must have been drawn
23427 before. When scrolling, the cursor is erased before
23428 actually scrolling, so we don't come here. When not
23429 scrolling, the rows above the old cursor row must have
23430 changed, and in this case these rows must have written
23431 over the cursor image.
23433 Likewise if part of the cursor is below y1, with the
23434 exception of the cursor being in the first blank row at
23435 the buffer and window end because update_text_area
23436 doesn't draw that row. (Except when it does, but
23437 that's handled in update_text_area.) */
23439 cy0
= w
->phys_cursor
.y
;
23440 cy1
= cy0
+ w
->phys_cursor_height
;
23441 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23444 w
->phys_cursor_on_p
= 0;
23447 #endif /* HAVE_WINDOW_SYSTEM */
23450 /************************************************************************
23452 ************************************************************************/
23454 #ifdef HAVE_WINDOW_SYSTEM
23457 Fix the display of area AREA of overlapping row ROW in window W
23458 with respect to the overlapping part OVERLAPS. */
23461 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23462 enum glyph_row_area area
, int overlaps
)
23469 for (i
= 0; i
< row
->used
[area
];)
23471 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23473 int start
= i
, start_x
= x
;
23477 x
+= row
->glyphs
[area
][i
].pixel_width
;
23480 while (i
< row
->used
[area
]
23481 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23483 draw_glyphs (w
, start_x
, row
, area
,
23485 DRAW_NORMAL_TEXT
, overlaps
);
23489 x
+= row
->glyphs
[area
][i
].pixel_width
;
23499 Draw the cursor glyph of window W in glyph row ROW. See the
23500 comment of draw_glyphs for the meaning of HL. */
23503 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23504 enum draw_glyphs_face hl
)
23506 /* If cursor hpos is out of bounds, don't draw garbage. This can
23507 happen in mini-buffer windows when switching between echo area
23508 glyphs and mini-buffer. */
23509 if ((row
->reversed_p
23510 ? (w
->phys_cursor
.hpos
>= 0)
23511 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23513 int on_p
= w
->phys_cursor_on_p
;
23515 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23516 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23518 w
->phys_cursor_on_p
= on_p
;
23520 if (hl
== DRAW_CURSOR
)
23521 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23522 /* When we erase the cursor, and ROW is overlapped by other
23523 rows, make sure that these overlapping parts of other rows
23525 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23527 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23529 if (row
> w
->current_matrix
->rows
23530 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23531 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23532 OVERLAPS_ERASED_CURSOR
);
23534 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23535 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23536 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23537 OVERLAPS_ERASED_CURSOR
);
23544 Erase the image of a cursor of window W from the screen. */
23547 erase_phys_cursor (struct window
*w
)
23549 struct frame
*f
= XFRAME (w
->frame
);
23550 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23551 int hpos
= w
->phys_cursor
.hpos
;
23552 int vpos
= w
->phys_cursor
.vpos
;
23553 int mouse_face_here_p
= 0;
23554 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23555 struct glyph_row
*cursor_row
;
23556 struct glyph
*cursor_glyph
;
23557 enum draw_glyphs_face hl
;
23559 /* No cursor displayed or row invalidated => nothing to do on the
23561 if (w
->phys_cursor_type
== NO_CURSOR
)
23562 goto mark_cursor_off
;
23564 /* VPOS >= active_glyphs->nrows means that window has been resized.
23565 Don't bother to erase the cursor. */
23566 if (vpos
>= active_glyphs
->nrows
)
23567 goto mark_cursor_off
;
23569 /* If row containing cursor is marked invalid, there is nothing we
23571 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23572 if (!cursor_row
->enabled_p
)
23573 goto mark_cursor_off
;
23575 /* If line spacing is > 0, old cursor may only be partially visible in
23576 window after split-window. So adjust visible height. */
23577 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23578 window_text_bottom_y (w
) - cursor_row
->y
);
23580 /* If row is completely invisible, don't attempt to delete a cursor which
23581 isn't there. This can happen if cursor is at top of a window, and
23582 we switch to a buffer with a header line in that window. */
23583 if (cursor_row
->visible_height
<= 0)
23584 goto mark_cursor_off
;
23586 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23587 if (cursor_row
->cursor_in_fringe_p
)
23589 cursor_row
->cursor_in_fringe_p
= 0;
23590 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23591 goto mark_cursor_off
;
23594 /* This can happen when the new row is shorter than the old one.
23595 In this case, either draw_glyphs or clear_end_of_line
23596 should have cleared the cursor. Note that we wouldn't be
23597 able to erase the cursor in this case because we don't have a
23598 cursor glyph at hand. */
23599 if ((cursor_row
->reversed_p
23600 ? (w
->phys_cursor
.hpos
< 0)
23601 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23602 goto mark_cursor_off
;
23604 /* If the cursor is in the mouse face area, redisplay that when
23605 we clear the cursor. */
23606 if (! NILP (hlinfo
->mouse_face_window
)
23607 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23608 /* Don't redraw the cursor's spot in mouse face if it is at the
23609 end of a line (on a newline). The cursor appears there, but
23610 mouse highlighting does not. */
23611 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23612 mouse_face_here_p
= 1;
23614 /* Maybe clear the display under the cursor. */
23615 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23618 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23621 cursor_glyph
= get_phys_cursor_glyph (w
);
23622 if (cursor_glyph
== NULL
)
23623 goto mark_cursor_off
;
23625 width
= cursor_glyph
->pixel_width
;
23626 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23627 x
= w
->phys_cursor
.x
;
23629 width
-= left_x
- x
;
23630 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23631 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23632 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23635 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23638 /* Erase the cursor by redrawing the character underneath it. */
23639 if (mouse_face_here_p
)
23640 hl
= DRAW_MOUSE_FACE
;
23642 hl
= DRAW_NORMAL_TEXT
;
23643 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23646 w
->phys_cursor_on_p
= 0;
23647 w
->phys_cursor_type
= NO_CURSOR
;
23652 Display or clear cursor of window W. If ON is zero, clear the
23653 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23654 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23657 display_and_set_cursor (struct window
*w
, int on
,
23658 int hpos
, int vpos
, int x
, int y
)
23660 struct frame
*f
= XFRAME (w
->frame
);
23661 int new_cursor_type
;
23662 int new_cursor_width
;
23664 struct glyph_row
*glyph_row
;
23665 struct glyph
*glyph
;
23667 /* This is pointless on invisible frames, and dangerous on garbaged
23668 windows and frames; in the latter case, the frame or window may
23669 be in the midst of changing its size, and x and y may be off the
23671 if (! FRAME_VISIBLE_P (f
)
23672 || FRAME_GARBAGED_P (f
)
23673 || vpos
>= w
->current_matrix
->nrows
23674 || hpos
>= w
->current_matrix
->matrix_w
)
23677 /* If cursor is off and we want it off, return quickly. */
23678 if (!on
&& !w
->phys_cursor_on_p
)
23681 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23682 /* If cursor row is not enabled, we don't really know where to
23683 display the cursor. */
23684 if (!glyph_row
->enabled_p
)
23686 w
->phys_cursor_on_p
= 0;
23691 if (!glyph_row
->exact_window_width_line_p
23692 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23693 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23695 xassert (interrupt_input_blocked
);
23697 /* Set new_cursor_type to the cursor we want to be displayed. */
23698 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23699 &new_cursor_width
, &active_cursor
);
23701 /* If cursor is currently being shown and we don't want it to be or
23702 it is in the wrong place, or the cursor type is not what we want,
23704 if (w
->phys_cursor_on_p
23706 || w
->phys_cursor
.x
!= x
23707 || w
->phys_cursor
.y
!= y
23708 || new_cursor_type
!= w
->phys_cursor_type
23709 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23710 && new_cursor_width
!= w
->phys_cursor_width
)))
23711 erase_phys_cursor (w
);
23713 /* Don't check phys_cursor_on_p here because that flag is only set
23714 to zero in some cases where we know that the cursor has been
23715 completely erased, to avoid the extra work of erasing the cursor
23716 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23717 still not be visible, or it has only been partly erased. */
23720 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23721 w
->phys_cursor_height
= glyph_row
->height
;
23723 /* Set phys_cursor_.* before x_draw_.* is called because some
23724 of them may need the information. */
23725 w
->phys_cursor
.x
= x
;
23726 w
->phys_cursor
.y
= glyph_row
->y
;
23727 w
->phys_cursor
.hpos
= hpos
;
23728 w
->phys_cursor
.vpos
= vpos
;
23731 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23732 new_cursor_type
, new_cursor_width
,
23733 on
, active_cursor
);
23737 /* Switch the display of W's cursor on or off, according to the value
23741 update_window_cursor (struct window
*w
, int on
)
23743 /* Don't update cursor in windows whose frame is in the process
23744 of being deleted. */
23745 if (w
->current_matrix
)
23748 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23749 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23755 /* Call update_window_cursor with parameter ON_P on all leaf windows
23756 in the window tree rooted at W. */
23759 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23763 if (!NILP (w
->hchild
))
23764 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23765 else if (!NILP (w
->vchild
))
23766 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23768 update_window_cursor (w
, on_p
);
23770 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23776 Display the cursor on window W, or clear it, according to ON_P.
23777 Don't change the cursor's position. */
23780 x_update_cursor (struct frame
*f
, int on_p
)
23782 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23787 Clear the cursor of window W to background color, and mark the
23788 cursor as not shown. This is used when the text where the cursor
23789 is about to be rewritten. */
23792 x_clear_cursor (struct window
*w
)
23794 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23795 update_window_cursor (w
, 0);
23798 #endif /* HAVE_WINDOW_SYSTEM */
23800 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23803 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23804 int start_hpos
, int end_hpos
,
23805 enum draw_glyphs_face draw
)
23807 #ifdef HAVE_WINDOW_SYSTEM
23808 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23810 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23814 #if defined (HAVE_GPM) || defined (MSDOS)
23815 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23820 Display the active region described by mouse_face_* according to DRAW. */
23823 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23825 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23826 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23828 if (/* If window is in the process of being destroyed, don't bother
23830 w
->current_matrix
!= NULL
23831 /* Don't update mouse highlight if hidden */
23832 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23833 /* Recognize when we are called to operate on rows that don't exist
23834 anymore. This can happen when a window is split. */
23835 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23837 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23838 struct glyph_row
*row
, *first
, *last
;
23840 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23841 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23843 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23845 int start_hpos
, end_hpos
, start_x
;
23847 /* For all but the first row, the highlight starts at column 0. */
23850 /* R2L rows have BEG and END in reversed order, but the
23851 screen drawing geometry is always left to right. So
23852 we need to mirror the beginning and end of the
23853 highlighted area in R2L rows. */
23854 if (!row
->reversed_p
)
23856 start_hpos
= hlinfo
->mouse_face_beg_col
;
23857 start_x
= hlinfo
->mouse_face_beg_x
;
23859 else if (row
== last
)
23861 start_hpos
= hlinfo
->mouse_face_end_col
;
23862 start_x
= hlinfo
->mouse_face_end_x
;
23870 else if (row
->reversed_p
&& row
== last
)
23872 start_hpos
= hlinfo
->mouse_face_end_col
;
23873 start_x
= hlinfo
->mouse_face_end_x
;
23883 if (!row
->reversed_p
)
23884 end_hpos
= hlinfo
->mouse_face_end_col
;
23885 else if (row
== first
)
23886 end_hpos
= hlinfo
->mouse_face_beg_col
;
23889 end_hpos
= row
->used
[TEXT_AREA
];
23890 if (draw
== DRAW_NORMAL_TEXT
)
23891 row
->fill_line_p
= 1; /* Clear to end of line */
23894 else if (row
->reversed_p
&& row
== first
)
23895 end_hpos
= hlinfo
->mouse_face_beg_col
;
23898 end_hpos
= row
->used
[TEXT_AREA
];
23899 if (draw
== DRAW_NORMAL_TEXT
)
23900 row
->fill_line_p
= 1; /* Clear to end of line */
23903 if (end_hpos
> start_hpos
)
23905 draw_row_with_mouse_face (w
, start_x
, row
,
23906 start_hpos
, end_hpos
, draw
);
23909 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23913 #ifdef HAVE_WINDOW_SYSTEM
23914 /* When we've written over the cursor, arrange for it to
23915 be displayed again. */
23916 if (FRAME_WINDOW_P (f
)
23917 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23920 display_and_set_cursor (w
, 1,
23921 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23922 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23925 #endif /* HAVE_WINDOW_SYSTEM */
23928 #ifdef HAVE_WINDOW_SYSTEM
23929 /* Change the mouse cursor. */
23930 if (FRAME_WINDOW_P (f
))
23932 if (draw
== DRAW_NORMAL_TEXT
23933 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
23934 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23935 else if (draw
== DRAW_MOUSE_FACE
)
23936 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23938 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23940 #endif /* HAVE_WINDOW_SYSTEM */
23944 Clear out the mouse-highlighted active region.
23945 Redraw it un-highlighted first. Value is non-zero if mouse
23946 face was actually drawn unhighlighted. */
23949 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
23953 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
23955 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
23959 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
23960 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
23961 hlinfo
->mouse_face_window
= Qnil
;
23962 hlinfo
->mouse_face_overlay
= Qnil
;
23966 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
23967 within the mouse face on that window. */
23969 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
23971 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
23973 /* Quickly resolve the easy cases. */
23974 if (!(WINDOWP (hlinfo
->mouse_face_window
)
23975 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
23977 if (vpos
< hlinfo
->mouse_face_beg_row
23978 || vpos
> hlinfo
->mouse_face_end_row
)
23980 if (vpos
> hlinfo
->mouse_face_beg_row
23981 && vpos
< hlinfo
->mouse_face_end_row
)
23984 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
23986 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
23988 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
23991 else if ((vpos
== hlinfo
->mouse_face_beg_row
23992 && hpos
>= hlinfo
->mouse_face_beg_col
)
23993 || (vpos
== hlinfo
->mouse_face_end_row
23994 && hpos
< hlinfo
->mouse_face_end_col
))
23999 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24001 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24004 else if ((vpos
== hlinfo
->mouse_face_beg_row
24005 && hpos
<= hlinfo
->mouse_face_beg_col
)
24006 || (vpos
== hlinfo
->mouse_face_end_row
24007 && hpos
> hlinfo
->mouse_face_end_col
))
24015 Non-zero if physical cursor of window W is within mouse face. */
24018 cursor_in_mouse_face_p (struct window
*w
)
24020 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24025 /* Find the glyph rows START_ROW and END_ROW of window W that display
24026 characters between buffer positions START_CHARPOS and END_CHARPOS
24027 (excluding END_CHARPOS). This is similar to row_containing_pos,
24028 but is more accurate when bidi reordering makes buffer positions
24029 change non-linearly with glyph rows. */
24031 rows_from_pos_range (struct window
*w
,
24032 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24033 struct glyph_row
**start
, struct glyph_row
**end
)
24035 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24036 int last_y
= window_text_bottom_y (w
);
24037 struct glyph_row
*row
;
24042 while (!first
->enabled_p
24043 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24046 /* Find the START row. */
24048 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24051 /* A row can potentially be the START row if the range of the
24052 characters it displays intersects the range
24053 [START_CHARPOS..END_CHARPOS). */
24054 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24055 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24056 /* See the commentary in row_containing_pos, for the
24057 explanation of the complicated way to check whether
24058 some position is beyond the end of the characters
24059 displayed by a row. */
24060 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24061 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24062 && !row
->ends_at_zv_p
24063 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24064 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24065 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24066 && !row
->ends_at_zv_p
24067 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24069 /* Found a candidate row. Now make sure at least one of the
24070 glyphs it displays has a charpos from the range
24071 [START_CHARPOS..END_CHARPOS).
24073 This is not obvious because bidi reordering could make
24074 buffer positions of a row be 1,2,3,102,101,100, and if we
24075 want to highlight characters in [50..60), we don't want
24076 this row, even though [50..60) does intersect [1..103),
24077 the range of character positions given by the row's start
24078 and end positions. */
24079 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24080 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24084 if (BUFFERP (g
->object
)
24085 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24094 /* Find the END row. */
24096 /* If the last row is partially visible, start looking for END
24097 from that row, instead of starting from FIRST. */
24098 && !(row
->enabled_p
24099 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24101 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24103 struct glyph_row
*next
= row
+ 1;
24105 if (!next
->enabled_p
24106 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24107 /* The first row >= START whose range of displayed characters
24108 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24109 is the row END + 1. */
24110 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24111 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24112 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24113 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24114 && !next
->ends_at_zv_p
24115 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24116 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24117 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24118 && !next
->ends_at_zv_p
24119 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24126 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24127 but none of the characters it displays are in the range, it is
24129 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24130 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24134 if (BUFFERP (g
->object
)
24135 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24148 /* This function sets the mouse_face_* elements of HLINFO, assuming
24149 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24150 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24151 for the overlay or run of text properties specifying the mouse
24152 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24153 before-string and after-string that must also be highlighted.
24154 DISPLAY_STRING, if non-nil, is a display string that may cover some
24155 or all of the highlighted text. */
24158 mouse_face_from_buffer_pos (Lisp_Object window
,
24159 Mouse_HLInfo
*hlinfo
,
24160 EMACS_INT mouse_charpos
,
24161 EMACS_INT start_charpos
,
24162 EMACS_INT end_charpos
,
24163 Lisp_Object before_string
,
24164 Lisp_Object after_string
,
24165 Lisp_Object display_string
)
24167 struct window
*w
= XWINDOW (window
);
24168 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24169 struct glyph_row
*r1
, *r2
;
24170 struct glyph
*glyph
, *end
;
24171 EMACS_INT ignore
, pos
;
24174 xassert (NILP (display_string
) || STRINGP (display_string
));
24175 xassert (NILP (before_string
) || STRINGP (before_string
));
24176 xassert (NILP (after_string
) || STRINGP (after_string
));
24178 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24179 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24181 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24182 /* If the before-string or display-string contains newlines,
24183 rows_from_pos_range skips to its last row. Move back. */
24184 if (!NILP (before_string
) || !NILP (display_string
))
24186 struct glyph_row
*prev
;
24187 while ((prev
= r1
- 1, prev
>= first
)
24188 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24189 && prev
->used
[TEXT_AREA
] > 0)
24191 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24192 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24193 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24195 || !(EQ (glyph
->object
, before_string
)
24196 || EQ (glyph
->object
, display_string
)))
24203 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24204 hlinfo
->mouse_face_past_end
= 1;
24206 else if (!NILP (after_string
))
24208 /* If the after-string has newlines, advance to its last row. */
24209 struct glyph_row
*next
;
24210 struct glyph_row
*last
24211 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24213 for (next
= r2
+ 1;
24215 && next
->used
[TEXT_AREA
] > 0
24216 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24220 /* The rest of the display engine assumes that mouse_face_beg_row is
24221 either above below mouse_face_end_row or identical to it. But
24222 with bidi-reordered continued lines, the row for START_CHARPOS
24223 could be below the row for END_CHARPOS. If so, swap the rows and
24224 store them in correct order. */
24227 struct glyph_row
*tem
= r2
;
24233 hlinfo
->mouse_face_beg_y
= r1
->y
;
24234 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24235 hlinfo
->mouse_face_end_y
= r2
->y
;
24236 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24238 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24239 AFTER_STRING, DISPLAY_STRING, START_CHARPOS, and END_CHARPOS
24240 could be anywhere in the row and in any order. The strategy
24241 below is to find the leftmost and the rightmost glyph that
24242 belongs to either of these 3 strings, or whose position is
24243 between START_CHARPOS and END_CHARPOS, and highlight all the
24244 glyphs between those two. This may cover more than just the text
24245 between START_CHARPOS and END_CHARPOS if the range of characters
24246 strides the bidi level boundary, e.g. if the beginning is in R2L
24247 text while the end is in L2R text or vice versa. */
24248 if (!r1
->reversed_p
)
24250 /* This row is in a left to right paragraph. Scan it left to
24252 glyph
= r1
->glyphs
[TEXT_AREA
];
24253 end
= glyph
+ r1
->used
[TEXT_AREA
];
24256 /* Skip truncation glyphs at the start of the glyph row. */
24257 if (r1
->displays_text_p
)
24259 && INTEGERP (glyph
->object
)
24260 && glyph
->charpos
< 0;
24262 x
+= glyph
->pixel_width
;
24264 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24265 or DISPLAY_STRING, and the first glyph from buffer whose
24266 position is between START_CHARPOS and END_CHARPOS. */
24268 && !INTEGERP (glyph
->object
)
24269 && !EQ (glyph
->object
, display_string
)
24270 && !(BUFFERP (glyph
->object
)
24271 && (glyph
->charpos
>= start_charpos
24272 && glyph
->charpos
< end_charpos
));
24275 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24276 are present at buffer positions between START_CHARPOS and
24277 END_CHARPOS, or if they come from an overlay. */
24278 if (EQ (glyph
->object
, before_string
))
24280 pos
= string_buffer_position (w
, before_string
,
24282 /* If pos == 0, it means before_string came from an
24283 overlay, not from a buffer position. */
24284 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24287 else if (EQ (glyph
->object
, after_string
))
24289 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24290 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24293 x
+= glyph
->pixel_width
;
24295 hlinfo
->mouse_face_beg_x
= x
;
24296 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24300 /* This row is in a right to left paragraph. Scan it right to
24304 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24305 glyph
= end
+ r1
->used
[TEXT_AREA
];
24307 /* Skip truncation glyphs at the start of the glyph row. */
24308 if (r1
->displays_text_p
)
24310 && INTEGERP (glyph
->object
)
24311 && glyph
->charpos
< 0;
24315 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24316 or DISPLAY_STRING, and the first glyph from buffer whose
24317 position is between START_CHARPOS and END_CHARPOS. */
24319 && !INTEGERP (glyph
->object
)
24320 && !EQ (glyph
->object
, display_string
)
24321 && !(BUFFERP (glyph
->object
)
24322 && (glyph
->charpos
>= start_charpos
24323 && glyph
->charpos
< end_charpos
));
24326 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24327 are present at buffer positions between START_CHARPOS and
24328 END_CHARPOS, or if they come from an overlay. */
24329 if (EQ (glyph
->object
, before_string
))
24331 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24332 /* If pos == 0, it means before_string came from an
24333 overlay, not from a buffer position. */
24334 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24337 else if (EQ (glyph
->object
, after_string
))
24339 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24340 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24345 glyph
++; /* first glyph to the right of the highlighted area */
24346 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24347 x
+= g
->pixel_width
;
24348 hlinfo
->mouse_face_beg_x
= x
;
24349 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24352 /* If the highlight ends in a different row, compute GLYPH and END
24353 for the end row. Otherwise, reuse the values computed above for
24354 the row where the highlight begins. */
24357 if (!r2
->reversed_p
)
24359 glyph
= r2
->glyphs
[TEXT_AREA
];
24360 end
= glyph
+ r2
->used
[TEXT_AREA
];
24365 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24366 glyph
= end
+ r2
->used
[TEXT_AREA
];
24370 if (!r2
->reversed_p
)
24372 /* Skip truncation and continuation glyphs near the end of the
24373 row, and also blanks and stretch glyphs inserted by
24374 extend_face_to_end_of_line. */
24376 && INTEGERP ((end
- 1)->object
)
24377 && (end
- 1)->charpos
<= 0)
24379 /* Scan the rest of the glyph row from the end, looking for the
24380 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24381 DISPLAY_STRING, or whose position is between START_CHARPOS
24385 && !INTEGERP (end
->object
)
24386 && !EQ (end
->object
, display_string
)
24387 && !(BUFFERP (end
->object
)
24388 && (end
->charpos
>= start_charpos
24389 && end
->charpos
< end_charpos
));
24392 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24393 are present at buffer positions between START_CHARPOS and
24394 END_CHARPOS, or if they come from an overlay. */
24395 if (EQ (end
->object
, before_string
))
24397 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24398 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24401 else if (EQ (end
->object
, after_string
))
24403 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24404 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24408 /* Find the X coordinate of the last glyph to be highlighted. */
24409 for (; glyph
<= end
; ++glyph
)
24410 x
+= glyph
->pixel_width
;
24412 hlinfo
->mouse_face_end_x
= x
;
24413 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24417 /* Skip truncation and continuation glyphs near the end of the
24418 row, and also blanks and stretch glyphs inserted by
24419 extend_face_to_end_of_line. */
24423 && INTEGERP (end
->object
)
24424 && end
->charpos
<= 0)
24426 x
+= end
->pixel_width
;
24429 /* Scan the rest of the glyph row from the end, looking for the
24430 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24431 DISPLAY_STRING, or whose position is between START_CHARPOS
24435 && !INTEGERP (end
->object
)
24436 && !EQ (end
->object
, display_string
)
24437 && !(BUFFERP (end
->object
)
24438 && (end
->charpos
>= start_charpos
24439 && end
->charpos
< end_charpos
));
24442 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24443 are present at buffer positions between START_CHARPOS and
24444 END_CHARPOS, or if they come from an overlay. */
24445 if (EQ (end
->object
, before_string
))
24447 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24448 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24451 else if (EQ (end
->object
, after_string
))
24453 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24454 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24457 x
+= end
->pixel_width
;
24459 hlinfo
->mouse_face_end_x
= x
;
24460 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24463 hlinfo
->mouse_face_window
= window
;
24464 hlinfo
->mouse_face_face_id
24465 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24467 !hlinfo
->mouse_face_hidden
, -1);
24468 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24471 /* The following function is not used anymore (replaced with
24472 mouse_face_from_string_pos), but I leave it here for the time
24473 being, in case someone would. */
24475 #if 0 /* not used */
24477 /* Find the position of the glyph for position POS in OBJECT in
24478 window W's current matrix, and return in *X, *Y the pixel
24479 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24481 RIGHT_P non-zero means return the position of the right edge of the
24482 glyph, RIGHT_P zero means return the left edge position.
24484 If no glyph for POS exists in the matrix, return the position of
24485 the glyph with the next smaller position that is in the matrix, if
24486 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24487 exists in the matrix, return the position of the glyph with the
24488 next larger position in OBJECT.
24490 Value is non-zero if a glyph was found. */
24493 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24494 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24496 int yb
= window_text_bottom_y (w
);
24497 struct glyph_row
*r
;
24498 struct glyph
*best_glyph
= NULL
;
24499 struct glyph_row
*best_row
= NULL
;
24502 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24503 r
->enabled_p
&& r
->y
< yb
;
24506 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24507 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24510 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24511 if (EQ (g
->object
, object
))
24513 if (g
->charpos
== pos
)
24520 else if (best_glyph
== NULL
24521 || ((eabs (g
->charpos
- pos
)
24522 < eabs (best_glyph
->charpos
- pos
))
24525 : g
->charpos
> pos
)))
24539 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24543 *x
+= best_glyph
->pixel_width
;
24548 *vpos
= best_row
- w
->current_matrix
->rows
;
24551 return best_glyph
!= NULL
;
24553 #endif /* not used */
24555 /* Find the positions of the first and the last glyphs in window W's
24556 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24557 (assumed to be a string), and return in HLINFO's mouse_face_*
24558 members the pixel and column/row coordinates of those glyphs. */
24561 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24562 Lisp_Object object
,
24563 EMACS_INT startpos
, EMACS_INT endpos
)
24565 int yb
= window_text_bottom_y (w
);
24566 struct glyph_row
*r
;
24567 struct glyph
*g
, *e
;
24571 /* Find the glyph row with at least one position in the range
24572 [STARTPOS..ENDPOS], and the first glyph in that row whose
24573 position belongs to that range. */
24574 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24575 r
->enabled_p
&& r
->y
< yb
;
24578 if (!r
->reversed_p
)
24580 g
= r
->glyphs
[TEXT_AREA
];
24581 e
= g
+ r
->used
[TEXT_AREA
];
24582 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24583 if (EQ (g
->object
, object
)
24584 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24586 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24587 hlinfo
->mouse_face_beg_y
= r
->y
;
24588 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24589 hlinfo
->mouse_face_beg_x
= gx
;
24598 e
= r
->glyphs
[TEXT_AREA
];
24599 g
= e
+ r
->used
[TEXT_AREA
];
24600 for ( ; g
> e
; --g
)
24601 if (EQ ((g
-1)->object
, object
)
24602 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24604 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24605 hlinfo
->mouse_face_beg_y
= r
->y
;
24606 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24607 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24608 gx
+= g1
->pixel_width
;
24609 hlinfo
->mouse_face_beg_x
= gx
;
24621 /* Starting with the next row, look for the first row which does NOT
24622 include any glyphs whose positions are in the range. */
24623 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24625 g
= r
->glyphs
[TEXT_AREA
];
24626 e
= g
+ r
->used
[TEXT_AREA
];
24628 for ( ; g
< e
; ++g
)
24629 if (EQ (g
->object
, object
)
24630 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24639 /* The highlighted region ends on the previous row. */
24642 /* Set the end row and its vertical pixel coordinate. */
24643 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24644 hlinfo
->mouse_face_end_y
= r
->y
;
24646 /* Compute and set the end column and the end column's horizontal
24647 pixel coordinate. */
24648 if (!r
->reversed_p
)
24650 g
= r
->glyphs
[TEXT_AREA
];
24651 e
= g
+ r
->used
[TEXT_AREA
];
24652 for ( ; e
> g
; --e
)
24653 if (EQ ((e
-1)->object
, object
)
24654 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24656 hlinfo
->mouse_face_end_col
= e
- g
;
24658 for (gx
= r
->x
; g
< e
; ++g
)
24659 gx
+= g
->pixel_width
;
24660 hlinfo
->mouse_face_end_x
= gx
;
24664 e
= r
->glyphs
[TEXT_AREA
];
24665 g
= e
+ r
->used
[TEXT_AREA
];
24666 for (gx
= r
->x
; e
< g
; ++e
)
24668 if (EQ (e
->object
, object
)
24669 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24671 gx
+= e
->pixel_width
;
24673 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24674 hlinfo
->mouse_face_end_x
= gx
;
24678 #ifdef HAVE_WINDOW_SYSTEM
24680 /* See if position X, Y is within a hot-spot of an image. */
24683 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24685 if (!CONSP (hot_spot
))
24688 if (EQ (XCAR (hot_spot
), Qrect
))
24690 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24691 Lisp_Object rect
= XCDR (hot_spot
);
24695 if (!CONSP (XCAR (rect
)))
24697 if (!CONSP (XCDR (rect
)))
24699 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24701 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24703 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24705 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24709 else if (EQ (XCAR (hot_spot
), Qcircle
))
24711 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24712 Lisp_Object circ
= XCDR (hot_spot
);
24713 Lisp_Object lr
, lx0
, ly0
;
24715 && CONSP (XCAR (circ
))
24716 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24717 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24718 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24720 double r
= XFLOATINT (lr
);
24721 double dx
= XINT (lx0
) - x
;
24722 double dy
= XINT (ly0
) - y
;
24723 return (dx
* dx
+ dy
* dy
<= r
* r
);
24726 else if (EQ (XCAR (hot_spot
), Qpoly
))
24728 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24729 if (VECTORP (XCDR (hot_spot
)))
24731 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24732 Lisp_Object
*poly
= v
->contents
;
24736 Lisp_Object lx
, ly
;
24739 /* Need an even number of coordinates, and at least 3 edges. */
24740 if (n
< 6 || n
& 1)
24743 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24744 If count is odd, we are inside polygon. Pixels on edges
24745 may or may not be included depending on actual geometry of the
24747 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24748 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24750 x0
= XINT (lx
), y0
= XINT (ly
);
24751 for (i
= 0; i
< n
; i
+= 2)
24753 int x1
= x0
, y1
= y0
;
24754 if ((lx
= poly
[i
], !INTEGERP (lx
))
24755 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24757 x0
= XINT (lx
), y0
= XINT (ly
);
24759 /* Does this segment cross the X line? */
24767 if (y
> y0
&& y
> y1
)
24769 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24779 find_hot_spot (Lisp_Object map
, int x
, int y
)
24781 while (CONSP (map
))
24783 if (CONSP (XCAR (map
))
24784 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24792 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24794 doc
: /* Lookup in image map MAP coordinates X and Y.
24795 An image map is an alist where each element has the format (AREA ID PLIST).
24796 An AREA is specified as either a rectangle, a circle, or a polygon:
24797 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24798 pixel coordinates of the upper left and bottom right corners.
24799 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24800 and the radius of the circle; r may be a float or integer.
24801 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24802 vector describes one corner in the polygon.
24803 Returns the alist element for the first matching AREA in MAP. */)
24804 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24812 return find_hot_spot (map
, XINT (x
), XINT (y
));
24816 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24818 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24820 /* Do not change cursor shape while dragging mouse. */
24821 if (!NILP (do_mouse_tracking
))
24824 if (!NILP (pointer
))
24826 if (EQ (pointer
, Qarrow
))
24827 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24828 else if (EQ (pointer
, Qhand
))
24829 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24830 else if (EQ (pointer
, Qtext
))
24831 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24832 else if (EQ (pointer
, intern ("hdrag")))
24833 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24834 #ifdef HAVE_X_WINDOWS
24835 else if (EQ (pointer
, intern ("vdrag")))
24836 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24838 else if (EQ (pointer
, intern ("hourglass")))
24839 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24840 else if (EQ (pointer
, Qmodeline
))
24841 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24843 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24846 if (cursor
!= No_Cursor
)
24847 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24850 #endif /* HAVE_WINDOW_SYSTEM */
24852 /* Take proper action when mouse has moved to the mode or header line
24853 or marginal area AREA of window W, x-position X and y-position Y.
24854 X is relative to the start of the text display area of W, so the
24855 width of bitmap areas and scroll bars must be subtracted to get a
24856 position relative to the start of the mode line. */
24859 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24860 enum window_part area
)
24862 struct window
*w
= XWINDOW (window
);
24863 struct frame
*f
= XFRAME (w
->frame
);
24864 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24865 #ifdef HAVE_WINDOW_SYSTEM
24866 Display_Info
*dpyinfo
;
24868 Cursor cursor
= No_Cursor
;
24869 Lisp_Object pointer
= Qnil
;
24870 int dx
, dy
, width
, height
;
24872 Lisp_Object string
, object
= Qnil
;
24873 Lisp_Object pos
, help
;
24875 Lisp_Object mouse_face
;
24876 int original_x_pixel
= x
;
24877 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24878 struct glyph_row
*row
;
24880 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24885 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24886 returns them in row/column units! */
24887 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24888 &object
, &dx
, &dy
, &width
, &height
);
24890 row
= (area
== ON_MODE_LINE
24891 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24892 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24894 /* Find the glyph under the mouse pointer. */
24895 if (row
->mode_line_p
&& row
->enabled_p
)
24897 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24898 end
= glyph
+ row
->used
[TEXT_AREA
];
24900 for (x0
= original_x_pixel
;
24901 glyph
< end
&& x0
>= glyph
->pixel_width
;
24903 x0
-= glyph
->pixel_width
;
24911 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24912 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24913 returns them in row/column units! */
24914 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24915 &object
, &dx
, &dy
, &width
, &height
);
24920 #ifdef HAVE_WINDOW_SYSTEM
24921 if (IMAGEP (object
))
24923 Lisp_Object image_map
, hotspot
;
24924 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24926 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24928 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24930 Lisp_Object area_id
, plist
;
24932 area_id
= XCAR (hotspot
);
24933 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24934 If so, we could look for mouse-enter, mouse-leave
24935 properties in PLIST (and do something...). */
24936 hotspot
= XCDR (hotspot
);
24937 if (CONSP (hotspot
)
24938 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24940 pointer
= Fplist_get (plist
, Qpointer
);
24941 if (NILP (pointer
))
24943 help
= Fplist_get (plist
, Qhelp_echo
);
24946 help_echo_string
= help
;
24947 /* Is this correct? ++kfs */
24948 XSETWINDOW (help_echo_window
, w
);
24949 help_echo_object
= w
->buffer
;
24950 help_echo_pos
= charpos
;
24954 if (NILP (pointer
))
24955 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24957 #endif /* HAVE_WINDOW_SYSTEM */
24959 if (STRINGP (string
))
24961 pos
= make_number (charpos
);
24962 /* If we're on a string with `help-echo' text property, arrange
24963 for the help to be displayed. This is done by setting the
24964 global variable help_echo_string to the help string. */
24967 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24970 help_echo_string
= help
;
24971 XSETWINDOW (help_echo_window
, w
);
24972 help_echo_object
= string
;
24973 help_echo_pos
= charpos
;
24977 #ifdef HAVE_WINDOW_SYSTEM
24978 if (FRAME_WINDOW_P (f
))
24980 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24981 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24982 if (NILP (pointer
))
24983 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24985 /* Change the mouse pointer according to what is under X/Y. */
24987 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24990 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24991 if (!KEYMAPP (map
))
24992 map
= Fget_text_property (pos
, Qkeymap
, string
);
24993 if (!KEYMAPP (map
))
24994 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24999 /* Change the mouse face according to what is under X/Y. */
25000 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25001 if (!NILP (mouse_face
)
25002 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25007 struct glyph
* tmp_glyph
;
25011 int total_pixel_width
;
25012 EMACS_INT begpos
, endpos
, ignore
;
25016 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25017 Qmouse_face
, string
, Qnil
);
25023 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25025 endpos
= SCHARS (string
);
25029 /* Calculate the glyph position GPOS of GLYPH in the
25030 displayed string, relative to the beginning of the
25031 highlighted part of the string.
25033 Note: GPOS is different from CHARPOS. CHARPOS is the
25034 position of GLYPH in the internal string object. A mode
25035 line string format has structures which are converted to
25036 a flattened string by the Emacs Lisp interpreter. The
25037 internal string is an element of those structures. The
25038 displayed string is the flattened string. */
25039 tmp_glyph
= row_start_glyph
;
25040 while (tmp_glyph
< glyph
25041 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25042 && begpos
<= tmp_glyph
->charpos
25043 && tmp_glyph
->charpos
< endpos
)))
25045 gpos
= glyph
- tmp_glyph
;
25047 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25048 the highlighted part of the displayed string to which
25049 GLYPH belongs. Note: GSEQ_LENGTH is different from
25050 SCHARS (STRING), because the latter returns the length of
25051 the internal string. */
25052 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25054 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25055 && begpos
<= tmp_glyph
->charpos
25056 && tmp_glyph
->charpos
< endpos
));
25059 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25061 /* Calculate the total pixel width of all the glyphs between
25062 the beginning of the highlighted area and GLYPH. */
25063 total_pixel_width
= 0;
25064 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25065 total_pixel_width
+= tmp_glyph
->pixel_width
;
25067 /* Pre calculation of re-rendering position. Note: X is in
25068 column units here, after the call to mode_line_string or
25069 marginal_area_string. */
25071 vpos
= (area
== ON_MODE_LINE
25072 ? (w
->current_matrix
)->nrows
- 1
25075 /* If GLYPH's position is included in the region that is
25076 already drawn in mouse face, we have nothing to do. */
25077 if ( EQ (window
, hlinfo
->mouse_face_window
)
25078 && (!row
->reversed_p
25079 ? (hlinfo
->mouse_face_beg_col
<= hpos
25080 && hpos
< hlinfo
->mouse_face_end_col
)
25081 /* In R2L rows we swap BEG and END, see below. */
25082 : (hlinfo
->mouse_face_end_col
<= hpos
25083 && hpos
< hlinfo
->mouse_face_beg_col
))
25084 && hlinfo
->mouse_face_beg_row
== vpos
)
25087 if (clear_mouse_face (hlinfo
))
25088 cursor
= No_Cursor
;
25090 if (!row
->reversed_p
)
25092 hlinfo
->mouse_face_beg_col
= hpos
;
25093 hlinfo
->mouse_face_beg_x
= original_x_pixel
25094 - (total_pixel_width
+ dx
);
25095 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25096 hlinfo
->mouse_face_end_x
= 0;
25100 /* In R2L rows, show_mouse_face expects BEG and END
25101 coordinates to be swapped. */
25102 hlinfo
->mouse_face_end_col
= hpos
;
25103 hlinfo
->mouse_face_end_x
= original_x_pixel
25104 - (total_pixel_width
+ dx
);
25105 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25106 hlinfo
->mouse_face_beg_x
= 0;
25109 hlinfo
->mouse_face_beg_row
= vpos
;
25110 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25111 hlinfo
->mouse_face_beg_y
= 0;
25112 hlinfo
->mouse_face_end_y
= 0;
25113 hlinfo
->mouse_face_past_end
= 0;
25114 hlinfo
->mouse_face_window
= window
;
25116 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25122 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25124 if (NILP (pointer
))
25127 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25128 clear_mouse_face (hlinfo
);
25130 #ifdef HAVE_WINDOW_SYSTEM
25131 if (FRAME_WINDOW_P (f
))
25132 define_frame_cursor1 (f
, cursor
, pointer
);
25138 Take proper action when the mouse has moved to position X, Y on
25139 frame F as regards highlighting characters that have mouse-face
25140 properties. Also de-highlighting chars where the mouse was before.
25141 X and Y can be negative or out of range. */
25144 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25146 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25147 enum window_part part
;
25148 Lisp_Object window
;
25150 Cursor cursor
= No_Cursor
;
25151 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25154 /* When a menu is active, don't highlight because this looks odd. */
25155 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25156 if (popup_activated ())
25160 if (NILP (Vmouse_highlight
)
25161 || !f
->glyphs_initialized_p
25162 || f
->pointer_invisible
)
25165 hlinfo
->mouse_face_mouse_x
= x
;
25166 hlinfo
->mouse_face_mouse_y
= y
;
25167 hlinfo
->mouse_face_mouse_frame
= f
;
25169 if (hlinfo
->mouse_face_defer
)
25172 if (gc_in_progress
)
25174 hlinfo
->mouse_face_deferred_gc
= 1;
25178 /* Which window is that in? */
25179 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25181 /* If we were displaying active text in another window, clear that.
25182 Also clear if we move out of text area in same window. */
25183 if (! EQ (window
, hlinfo
->mouse_face_window
)
25184 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25185 && !NILP (hlinfo
->mouse_face_window
)))
25186 clear_mouse_face (hlinfo
);
25188 /* Not on a window -> return. */
25189 if (!WINDOWP (window
))
25192 /* Reset help_echo_string. It will get recomputed below. */
25193 help_echo_string
= Qnil
;
25195 /* Convert to window-relative pixel coordinates. */
25196 w
= XWINDOW (window
);
25197 frame_to_window_pixel_xy (w
, &x
, &y
);
25199 #ifdef HAVE_WINDOW_SYSTEM
25200 /* Handle tool-bar window differently since it doesn't display a
25202 if (EQ (window
, f
->tool_bar_window
))
25204 note_tool_bar_highlight (f
, x
, y
);
25209 /* Mouse is on the mode, header line or margin? */
25210 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25211 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25213 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25217 #ifdef HAVE_WINDOW_SYSTEM
25218 if (part
== ON_VERTICAL_BORDER
)
25220 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25221 help_echo_string
= build_string ("drag-mouse-1: resize");
25223 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25224 || part
== ON_SCROLL_BAR
)
25225 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25227 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25230 /* Are we in a window whose display is up to date?
25231 And verify the buffer's text has not changed. */
25232 b
= XBUFFER (w
->buffer
);
25233 if (part
== ON_TEXT
25234 && EQ (w
->window_end_valid
, w
->buffer
)
25235 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25236 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25238 int hpos
, vpos
, i
, dx
, dy
, area
;
25240 struct glyph
*glyph
;
25241 Lisp_Object object
;
25242 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
25243 Lisp_Object
*overlay_vec
= NULL
;
25245 struct buffer
*obuf
;
25246 EMACS_INT obegv
, ozv
;
25249 /* Find the glyph under X/Y. */
25250 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25252 #ifdef HAVE_WINDOW_SYSTEM
25253 /* Look for :pointer property on image. */
25254 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25256 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25257 if (img
!= NULL
&& IMAGEP (img
->spec
))
25259 Lisp_Object image_map
, hotspot
;
25260 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25262 && (hotspot
= find_hot_spot (image_map
,
25263 glyph
->slice
.img
.x
+ dx
,
25264 glyph
->slice
.img
.y
+ dy
),
25266 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25268 Lisp_Object area_id
, plist
;
25270 area_id
= XCAR (hotspot
);
25271 /* Could check AREA_ID to see if we enter/leave this hot-spot.
25272 If so, we could look for mouse-enter, mouse-leave
25273 properties in PLIST (and do something...). */
25274 hotspot
= XCDR (hotspot
);
25275 if (CONSP (hotspot
)
25276 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25278 pointer
= Fplist_get (plist
, Qpointer
);
25279 if (NILP (pointer
))
25281 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25282 if (!NILP (help_echo_string
))
25284 help_echo_window
= window
;
25285 help_echo_object
= glyph
->object
;
25286 help_echo_pos
= glyph
->charpos
;
25290 if (NILP (pointer
))
25291 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25294 #endif /* HAVE_WINDOW_SYSTEM */
25296 /* Clear mouse face if X/Y not over text. */
25298 || area
!= TEXT_AREA
25299 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25300 /* Glyph's OBJECT is an integer for glyphs inserted by the
25301 display engine for its internal purposes, like truncation
25302 and continuation glyphs and blanks beyond the end of
25303 line's text on text terminals. If we are over such a
25304 glyph, we are not over any text. */
25305 || INTEGERP (glyph
->object
)
25306 /* R2L rows have a stretch glyph at their front, which
25307 stands for no text, whereas L2R rows have no glyphs at
25308 all beyond the end of text. Treat such stretch glyphs
25309 like we do with NULL glyphs in L2R rows. */
25310 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25311 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25312 && glyph
->type
== STRETCH_GLYPH
25313 && glyph
->avoid_cursor_p
))
25315 if (clear_mouse_face (hlinfo
))
25316 cursor
= No_Cursor
;
25317 #ifdef HAVE_WINDOW_SYSTEM
25318 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25320 if (area
!= TEXT_AREA
)
25321 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25323 pointer
= Vvoid_text_area_pointer
;
25329 pos
= glyph
->charpos
;
25330 object
= glyph
->object
;
25331 if (!STRINGP (object
) && !BUFFERP (object
))
25334 /* If we get an out-of-range value, return now; avoid an error. */
25335 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25338 /* Make the window's buffer temporarily current for
25339 overlays_at and compute_char_face. */
25340 obuf
= current_buffer
;
25341 current_buffer
= b
;
25347 /* Is this char mouse-active or does it have help-echo? */
25348 position
= make_number (pos
);
25350 if (BUFFERP (object
))
25352 /* Put all the overlays we want in a vector in overlay_vec. */
25353 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25354 /* Sort overlays into increasing priority order. */
25355 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25360 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25363 cursor
= No_Cursor
;
25365 /* Check mouse-face highlighting. */
25367 /* If there exists an overlay with mouse-face overlapping
25368 the one we are currently highlighting, we have to
25369 check if we enter the overlapping overlay, and then
25370 highlight only that. */
25371 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25372 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25374 /* Find the highest priority overlay with a mouse-face. */
25376 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25378 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25379 if (!NILP (mouse_face
))
25380 overlay
= overlay_vec
[i
];
25383 /* If we're highlighting the same overlay as before, there's
25384 no need to do that again. */
25385 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25386 goto check_help_echo
;
25387 hlinfo
->mouse_face_overlay
= overlay
;
25389 /* Clear the display of the old active region, if any. */
25390 if (clear_mouse_face (hlinfo
))
25391 cursor
= No_Cursor
;
25393 /* If no overlay applies, get a text property. */
25394 if (NILP (overlay
))
25395 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25397 /* Next, compute the bounds of the mouse highlighting and
25399 if (!NILP (mouse_face
) && STRINGP (object
))
25401 /* The mouse-highlighting comes from a display string
25402 with a mouse-face. */
25406 b
= Fprevious_single_property_change
25407 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25408 e
= Fnext_single_property_change
25409 (position
, Qmouse_face
, object
, Qnil
);
25411 b
= make_number (0);
25413 e
= make_number (SCHARS (object
) - 1);
25414 mouse_face_from_string_pos (w
, hlinfo
, object
,
25415 XINT (b
), XINT (e
));
25416 hlinfo
->mouse_face_past_end
= 0;
25417 hlinfo
->mouse_face_window
= window
;
25418 hlinfo
->mouse_face_face_id
25419 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25420 glyph
->face_id
, 1);
25421 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25422 cursor
= No_Cursor
;
25426 /* The mouse-highlighting, if any, comes from an overlay
25427 or text property in the buffer. */
25428 Lisp_Object buffer
, display_string
;
25430 if (STRINGP (object
))
25432 /* If we are on a display string with no mouse-face,
25433 check if the text under it has one. */
25434 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25435 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25436 pos
= string_buffer_position (w
, object
, start
);
25439 mouse_face
= get_char_property_and_overlay
25440 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25441 buffer
= w
->buffer
;
25442 display_string
= object
;
25448 display_string
= Qnil
;
25451 if (!NILP (mouse_face
))
25453 Lisp_Object before
, after
;
25454 Lisp_Object before_string
, after_string
;
25455 /* To correctly find the limits of mouse highlight
25456 in a bidi-reordered buffer, we must not use the
25457 optimization of limiting the search in
25458 previous-single-property-change and
25459 next-single-property-change, because
25460 rows_from_pos_range needs the real start and end
25461 positions to DTRT in this case. That's because
25462 the first row visible in a window does not
25463 necessarily display the character whose position
25464 is the smallest. */
25466 NILP (XBUFFER (buffer
)->bidi_display_reordering
)
25467 ? Fmarker_position (w
->start
)
25470 NILP (XBUFFER (buffer
)->bidi_display_reordering
)
25471 ? make_number (BUF_Z (XBUFFER (buffer
))
25472 - XFASTINT (w
->window_end_pos
))
25475 if (NILP (overlay
))
25477 /* Handle the text property case. */
25478 before
= Fprevious_single_property_change
25479 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25480 after
= Fnext_single_property_change
25481 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25482 before_string
= after_string
= Qnil
;
25486 /* Handle the overlay case. */
25487 before
= Foverlay_start (overlay
);
25488 after
= Foverlay_end (overlay
);
25489 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25490 after_string
= Foverlay_get (overlay
, Qafter_string
);
25492 if (!STRINGP (before_string
)) before_string
= Qnil
;
25493 if (!STRINGP (after_string
)) after_string
= Qnil
;
25496 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25499 before_string
, after_string
,
25501 cursor
= No_Cursor
;
25508 /* Look for a `help-echo' property. */
25509 if (NILP (help_echo_string
)) {
25510 Lisp_Object help
, overlay
;
25512 /* Check overlays first. */
25513 help
= overlay
= Qnil
;
25514 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25516 overlay
= overlay_vec
[i
];
25517 help
= Foverlay_get (overlay
, Qhelp_echo
);
25522 help_echo_string
= help
;
25523 help_echo_window
= window
;
25524 help_echo_object
= overlay
;
25525 help_echo_pos
= pos
;
25529 Lisp_Object object
= glyph
->object
;
25530 EMACS_INT charpos
= glyph
->charpos
;
25532 /* Try text properties. */
25533 if (STRINGP (object
)
25535 && charpos
< SCHARS (object
))
25537 help
= Fget_text_property (make_number (charpos
),
25538 Qhelp_echo
, object
);
25541 /* If the string itself doesn't specify a help-echo,
25542 see if the buffer text ``under'' it does. */
25543 struct glyph_row
*r
25544 = MATRIX_ROW (w
->current_matrix
, vpos
);
25545 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25546 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
25549 help
= Fget_char_property (make_number (pos
),
25550 Qhelp_echo
, w
->buffer
);
25554 object
= w
->buffer
;
25559 else if (BUFFERP (object
)
25562 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25567 help_echo_string
= help
;
25568 help_echo_window
= window
;
25569 help_echo_object
= object
;
25570 help_echo_pos
= charpos
;
25575 #ifdef HAVE_WINDOW_SYSTEM
25576 /* Look for a `pointer' property. */
25577 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25579 /* Check overlays first. */
25580 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25581 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25583 if (NILP (pointer
))
25585 Lisp_Object object
= glyph
->object
;
25586 EMACS_INT charpos
= glyph
->charpos
;
25588 /* Try text properties. */
25589 if (STRINGP (object
)
25591 && charpos
< SCHARS (object
))
25593 pointer
= Fget_text_property (make_number (charpos
),
25595 if (NILP (pointer
))
25597 /* If the string itself doesn't specify a pointer,
25598 see if the buffer text ``under'' it does. */
25599 struct glyph_row
*r
25600 = MATRIX_ROW (w
->current_matrix
, vpos
);
25601 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25602 EMACS_INT pos
= string_buffer_position (w
, object
,
25605 pointer
= Fget_char_property (make_number (pos
),
25606 Qpointer
, w
->buffer
);
25609 else if (BUFFERP (object
)
25612 pointer
= Fget_text_property (make_number (charpos
),
25616 #endif /* HAVE_WINDOW_SYSTEM */
25620 current_buffer
= obuf
;
25625 #ifdef HAVE_WINDOW_SYSTEM
25626 if (FRAME_WINDOW_P (f
))
25627 define_frame_cursor1 (f
, cursor
, pointer
);
25629 /* This is here to prevent a compiler error, about "label at end of
25630 compound statement". */
25637 Clear any mouse-face on window W. This function is part of the
25638 redisplay interface, and is called from try_window_id and similar
25639 functions to ensure the mouse-highlight is off. */
25642 x_clear_window_mouse_face (struct window
*w
)
25644 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25645 Lisp_Object window
;
25648 XSETWINDOW (window
, w
);
25649 if (EQ (window
, hlinfo
->mouse_face_window
))
25650 clear_mouse_face (hlinfo
);
25656 Just discard the mouse face information for frame F, if any.
25657 This is used when the size of F is changed. */
25660 cancel_mouse_face (struct frame
*f
)
25662 Lisp_Object window
;
25663 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25665 window
= hlinfo
->mouse_face_window
;
25666 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25668 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25669 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25670 hlinfo
->mouse_face_window
= Qnil
;
25676 /***********************************************************************
25678 ***********************************************************************/
25680 #ifdef HAVE_WINDOW_SYSTEM
25682 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25683 which intersects rectangle R. R is in window-relative coordinates. */
25686 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25687 enum glyph_row_area area
)
25689 struct glyph
*first
= row
->glyphs
[area
];
25690 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25691 struct glyph
*last
;
25692 int first_x
, start_x
, x
;
25694 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25695 /* If row extends face to end of line write the whole line. */
25696 draw_glyphs (w
, 0, row
, area
,
25697 0, row
->used
[area
],
25698 DRAW_NORMAL_TEXT
, 0);
25701 /* Set START_X to the window-relative start position for drawing glyphs of
25702 AREA. The first glyph of the text area can be partially visible.
25703 The first glyphs of other areas cannot. */
25704 start_x
= window_box_left_offset (w
, area
);
25706 if (area
== TEXT_AREA
)
25709 /* Find the first glyph that must be redrawn. */
25711 && x
+ first
->pixel_width
< r
->x
)
25713 x
+= first
->pixel_width
;
25717 /* Find the last one. */
25721 && x
< r
->x
+ r
->width
)
25723 x
+= last
->pixel_width
;
25729 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25730 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25731 DRAW_NORMAL_TEXT
, 0);
25736 /* Redraw the parts of the glyph row ROW on window W intersecting
25737 rectangle R. R is in window-relative coordinates. Value is
25738 non-zero if mouse-face was overwritten. */
25741 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25743 xassert (row
->enabled_p
);
25745 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25746 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25747 0, row
->used
[TEXT_AREA
],
25748 DRAW_NORMAL_TEXT
, 0);
25751 if (row
->used
[LEFT_MARGIN_AREA
])
25752 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25753 if (row
->used
[TEXT_AREA
])
25754 expose_area (w
, row
, r
, TEXT_AREA
);
25755 if (row
->used
[RIGHT_MARGIN_AREA
])
25756 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25757 draw_row_fringe_bitmaps (w
, row
);
25760 return row
->mouse_face_p
;
25764 /* Redraw those parts of glyphs rows during expose event handling that
25765 overlap other rows. Redrawing of an exposed line writes over parts
25766 of lines overlapping that exposed line; this function fixes that.
25768 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25769 row in W's current matrix that is exposed and overlaps other rows.
25770 LAST_OVERLAPPING_ROW is the last such row. */
25773 expose_overlaps (struct window
*w
,
25774 struct glyph_row
*first_overlapping_row
,
25775 struct glyph_row
*last_overlapping_row
,
25778 struct glyph_row
*row
;
25780 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25781 if (row
->overlapping_p
)
25783 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25786 if (row
->used
[LEFT_MARGIN_AREA
])
25787 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25789 if (row
->used
[TEXT_AREA
])
25790 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25792 if (row
->used
[RIGHT_MARGIN_AREA
])
25793 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25799 /* Return non-zero if W's cursor intersects rectangle R. */
25802 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25804 XRectangle cr
, result
;
25805 struct glyph
*cursor_glyph
;
25806 struct glyph_row
*row
;
25808 if (w
->phys_cursor
.vpos
>= 0
25809 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25810 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25812 && row
->cursor_in_fringe_p
)
25814 /* Cursor is in the fringe. */
25815 cr
.x
= window_box_right_offset (w
,
25816 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25817 ? RIGHT_MARGIN_AREA
25820 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25821 cr
.height
= row
->height
;
25822 return x_intersect_rectangles (&cr
, r
, &result
);
25825 cursor_glyph
= get_phys_cursor_glyph (w
);
25828 /* r is relative to W's box, but w->phys_cursor.x is relative
25829 to left edge of W's TEXT area. Adjust it. */
25830 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25831 cr
.y
= w
->phys_cursor
.y
;
25832 cr
.width
= cursor_glyph
->pixel_width
;
25833 cr
.height
= w
->phys_cursor_height
;
25834 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25835 I assume the effect is the same -- and this is portable. */
25836 return x_intersect_rectangles (&cr
, r
, &result
);
25838 /* If we don't understand the format, pretend we're not in the hot-spot. */
25844 Draw a vertical window border to the right of window W if W doesn't
25845 have vertical scroll bars. */
25848 x_draw_vertical_border (struct window
*w
)
25850 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25852 /* We could do better, if we knew what type of scroll-bar the adjacent
25853 windows (on either side) have... But we don't :-(
25854 However, I think this works ok. ++KFS 2003-04-25 */
25856 /* Redraw borders between horizontally adjacent windows. Don't
25857 do it for frames with vertical scroll bars because either the
25858 right scroll bar of a window, or the left scroll bar of its
25859 neighbor will suffice as a border. */
25860 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25863 if (!WINDOW_RIGHTMOST_P (w
)
25864 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25866 int x0
, x1
, y0
, y1
;
25868 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25871 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25874 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25876 else if (!WINDOW_LEFTMOST_P (w
)
25877 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25879 int x0
, x1
, y0
, y1
;
25881 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25884 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25887 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25892 /* Redraw the part of window W intersection rectangle FR. Pixel
25893 coordinates in FR are frame-relative. Call this function with
25894 input blocked. Value is non-zero if the exposure overwrites
25898 expose_window (struct window
*w
, XRectangle
*fr
)
25900 struct frame
*f
= XFRAME (w
->frame
);
25902 int mouse_face_overwritten_p
= 0;
25904 /* If window is not yet fully initialized, do nothing. This can
25905 happen when toolkit scroll bars are used and a window is split.
25906 Reconfiguring the scroll bar will generate an expose for a newly
25908 if (w
->current_matrix
== NULL
)
25911 /* When we're currently updating the window, display and current
25912 matrix usually don't agree. Arrange for a thorough display
25914 if (w
== updated_window
)
25916 SET_FRAME_GARBAGED (f
);
25920 /* Frame-relative pixel rectangle of W. */
25921 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25922 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25923 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25924 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25926 if (x_intersect_rectangles (fr
, &wr
, &r
))
25928 int yb
= window_text_bottom_y (w
);
25929 struct glyph_row
*row
;
25930 int cursor_cleared_p
;
25931 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25933 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25934 r
.x
, r
.y
, r
.width
, r
.height
));
25936 /* Convert to window coordinates. */
25937 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25938 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25940 /* Turn off the cursor. */
25941 if (!w
->pseudo_window_p
25942 && phys_cursor_in_rect_p (w
, &r
))
25944 x_clear_cursor (w
);
25945 cursor_cleared_p
= 1;
25948 cursor_cleared_p
= 0;
25950 /* Update lines intersecting rectangle R. */
25951 first_overlapping_row
= last_overlapping_row
= NULL
;
25952 for (row
= w
->current_matrix
->rows
;
25957 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25959 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25960 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25961 || (r
.y
>= y0
&& r
.y
< y1
)
25962 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25964 /* A header line may be overlapping, but there is no need
25965 to fix overlapping areas for them. KFS 2005-02-12 */
25966 if (row
->overlapping_p
&& !row
->mode_line_p
)
25968 if (first_overlapping_row
== NULL
)
25969 first_overlapping_row
= row
;
25970 last_overlapping_row
= row
;
25974 if (expose_line (w
, row
, &r
))
25975 mouse_face_overwritten_p
= 1;
25978 else if (row
->overlapping_p
)
25980 /* We must redraw a row overlapping the exposed area. */
25982 ? y0
+ row
->phys_height
> r
.y
25983 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25985 if (first_overlapping_row
== NULL
)
25986 first_overlapping_row
= row
;
25987 last_overlapping_row
= row
;
25995 /* Display the mode line if there is one. */
25996 if (WINDOW_WANTS_MODELINE_P (w
)
25997 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25999 && row
->y
< r
.y
+ r
.height
)
26001 if (expose_line (w
, row
, &r
))
26002 mouse_face_overwritten_p
= 1;
26005 if (!w
->pseudo_window_p
)
26007 /* Fix the display of overlapping rows. */
26008 if (first_overlapping_row
)
26009 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26012 /* Draw border between windows. */
26013 x_draw_vertical_border (w
);
26015 /* Turn the cursor on again. */
26016 if (cursor_cleared_p
)
26017 update_window_cursor (w
, 1);
26021 return mouse_face_overwritten_p
;
26026 /* Redraw (parts) of all windows in the window tree rooted at W that
26027 intersect R. R contains frame pixel coordinates. Value is
26028 non-zero if the exposure overwrites mouse-face. */
26031 expose_window_tree (struct window
*w
, XRectangle
*r
)
26033 struct frame
*f
= XFRAME (w
->frame
);
26034 int mouse_face_overwritten_p
= 0;
26036 while (w
&& !FRAME_GARBAGED_P (f
))
26038 if (!NILP (w
->hchild
))
26039 mouse_face_overwritten_p
26040 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26041 else if (!NILP (w
->vchild
))
26042 mouse_face_overwritten_p
26043 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26045 mouse_face_overwritten_p
|= expose_window (w
, r
);
26047 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26050 return mouse_face_overwritten_p
;
26055 Redisplay an exposed area of frame F. X and Y are the upper-left
26056 corner of the exposed rectangle. W and H are width and height of
26057 the exposed area. All are pixel values. W or H zero means redraw
26058 the entire frame. */
26061 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26064 int mouse_face_overwritten_p
= 0;
26066 TRACE ((stderr
, "expose_frame "));
26068 /* No need to redraw if frame will be redrawn soon. */
26069 if (FRAME_GARBAGED_P (f
))
26071 TRACE ((stderr
, " garbaged\n"));
26075 /* If basic faces haven't been realized yet, there is no point in
26076 trying to redraw anything. This can happen when we get an expose
26077 event while Emacs is starting, e.g. by moving another window. */
26078 if (FRAME_FACE_CACHE (f
) == NULL
26079 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26081 TRACE ((stderr
, " no faces\n"));
26085 if (w
== 0 || h
== 0)
26088 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26089 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26099 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26100 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26102 if (WINDOWP (f
->tool_bar_window
))
26103 mouse_face_overwritten_p
26104 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26106 #ifdef HAVE_X_WINDOWS
26108 #ifndef USE_X_TOOLKIT
26109 if (WINDOWP (f
->menu_bar_window
))
26110 mouse_face_overwritten_p
26111 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26112 #endif /* not USE_X_TOOLKIT */
26116 /* Some window managers support a focus-follows-mouse style with
26117 delayed raising of frames. Imagine a partially obscured frame,
26118 and moving the mouse into partially obscured mouse-face on that
26119 frame. The visible part of the mouse-face will be highlighted,
26120 then the WM raises the obscured frame. With at least one WM, KDE
26121 2.1, Emacs is not getting any event for the raising of the frame
26122 (even tried with SubstructureRedirectMask), only Expose events.
26123 These expose events will draw text normally, i.e. not
26124 highlighted. Which means we must redo the highlight here.
26125 Subsume it under ``we love X''. --gerd 2001-08-15 */
26126 /* Included in Windows version because Windows most likely does not
26127 do the right thing if any third party tool offers
26128 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26129 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26131 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26132 if (f
== hlinfo
->mouse_face_mouse_frame
)
26134 int x
= hlinfo
->mouse_face_mouse_x
;
26135 int y
= hlinfo
->mouse_face_mouse_y
;
26136 clear_mouse_face (hlinfo
);
26137 note_mouse_highlight (f
, x
, y
);
26144 Determine the intersection of two rectangles R1 and R2. Return
26145 the intersection in *RESULT. Value is non-zero if RESULT is not
26149 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26151 XRectangle
*left
, *right
;
26152 XRectangle
*upper
, *lower
;
26153 int intersection_p
= 0;
26155 /* Rearrange so that R1 is the left-most rectangle. */
26157 left
= r1
, right
= r2
;
26159 left
= r2
, right
= r1
;
26161 /* X0 of the intersection is right.x0, if this is inside R1,
26162 otherwise there is no intersection. */
26163 if (right
->x
<= left
->x
+ left
->width
)
26165 result
->x
= right
->x
;
26167 /* The right end of the intersection is the minimum of the
26168 the right ends of left and right. */
26169 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26172 /* Same game for Y. */
26174 upper
= r1
, lower
= r2
;
26176 upper
= r2
, lower
= r1
;
26178 /* The upper end of the intersection is lower.y0, if this is inside
26179 of upper. Otherwise, there is no intersection. */
26180 if (lower
->y
<= upper
->y
+ upper
->height
)
26182 result
->y
= lower
->y
;
26184 /* The lower end of the intersection is the minimum of the lower
26185 ends of upper and lower. */
26186 result
->height
= (min (lower
->y
+ lower
->height
,
26187 upper
->y
+ upper
->height
)
26189 intersection_p
= 1;
26193 return intersection_p
;
26196 #endif /* HAVE_WINDOW_SYSTEM */
26199 /***********************************************************************
26201 ***********************************************************************/
26204 syms_of_xdisp (void)
26206 Vwith_echo_area_save_vector
= Qnil
;
26207 staticpro (&Vwith_echo_area_save_vector
);
26209 Vmessage_stack
= Qnil
;
26210 staticpro (&Vmessage_stack
);
26212 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26213 staticpro (&Qinhibit_redisplay
);
26215 message_dolog_marker1
= Fmake_marker ();
26216 staticpro (&message_dolog_marker1
);
26217 message_dolog_marker2
= Fmake_marker ();
26218 staticpro (&message_dolog_marker2
);
26219 message_dolog_marker3
= Fmake_marker ();
26220 staticpro (&message_dolog_marker3
);
26223 defsubr (&Sdump_frame_glyph_matrix
);
26224 defsubr (&Sdump_glyph_matrix
);
26225 defsubr (&Sdump_glyph_row
);
26226 defsubr (&Sdump_tool_bar_row
);
26227 defsubr (&Strace_redisplay
);
26228 defsubr (&Strace_to_stderr
);
26230 #ifdef HAVE_WINDOW_SYSTEM
26231 defsubr (&Stool_bar_lines_needed
);
26232 defsubr (&Slookup_image_map
);
26234 defsubr (&Sformat_mode_line
);
26235 defsubr (&Sinvisible_p
);
26236 defsubr (&Scurrent_bidi_paragraph_direction
);
26238 staticpro (&Qmenu_bar_update_hook
);
26239 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26241 staticpro (&Qoverriding_terminal_local_map
);
26242 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26244 staticpro (&Qoverriding_local_map
);
26245 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26247 staticpro (&Qwindow_scroll_functions
);
26248 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26250 staticpro (&Qwindow_text_change_functions
);
26251 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26253 staticpro (&Qredisplay_end_trigger_functions
);
26254 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26256 staticpro (&Qinhibit_point_motion_hooks
);
26257 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26259 Qeval
= intern_c_string ("eval");
26260 staticpro (&Qeval
);
26262 QCdata
= intern_c_string (":data");
26263 staticpro (&QCdata
);
26264 Qdisplay
= intern_c_string ("display");
26265 staticpro (&Qdisplay
);
26266 Qspace_width
= intern_c_string ("space-width");
26267 staticpro (&Qspace_width
);
26268 Qraise
= intern_c_string ("raise");
26269 staticpro (&Qraise
);
26270 Qslice
= intern_c_string ("slice");
26271 staticpro (&Qslice
);
26272 Qspace
= intern_c_string ("space");
26273 staticpro (&Qspace
);
26274 Qmargin
= intern_c_string ("margin");
26275 staticpro (&Qmargin
);
26276 Qpointer
= intern_c_string ("pointer");
26277 staticpro (&Qpointer
);
26278 Qleft_margin
= intern_c_string ("left-margin");
26279 staticpro (&Qleft_margin
);
26280 Qright_margin
= intern_c_string ("right-margin");
26281 staticpro (&Qright_margin
);
26282 Qcenter
= intern_c_string ("center");
26283 staticpro (&Qcenter
);
26284 Qline_height
= intern_c_string ("line-height");
26285 staticpro (&Qline_height
);
26286 QCalign_to
= intern_c_string (":align-to");
26287 staticpro (&QCalign_to
);
26288 QCrelative_width
= intern_c_string (":relative-width");
26289 staticpro (&QCrelative_width
);
26290 QCrelative_height
= intern_c_string (":relative-height");
26291 staticpro (&QCrelative_height
);
26292 QCeval
= intern_c_string (":eval");
26293 staticpro (&QCeval
);
26294 QCpropertize
= intern_c_string (":propertize");
26295 staticpro (&QCpropertize
);
26296 QCfile
= intern_c_string (":file");
26297 staticpro (&QCfile
);
26298 Qfontified
= intern_c_string ("fontified");
26299 staticpro (&Qfontified
);
26300 Qfontification_functions
= intern_c_string ("fontification-functions");
26301 staticpro (&Qfontification_functions
);
26302 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26303 staticpro (&Qtrailing_whitespace
);
26304 Qescape_glyph
= intern_c_string ("escape-glyph");
26305 staticpro (&Qescape_glyph
);
26306 Qnobreak_space
= intern_c_string ("nobreak-space");
26307 staticpro (&Qnobreak_space
);
26308 Qimage
= intern_c_string ("image");
26309 staticpro (&Qimage
);
26310 Qtext
= intern_c_string ("text");
26311 staticpro (&Qtext
);
26312 Qboth
= intern_c_string ("both");
26313 staticpro (&Qboth
);
26314 Qboth_horiz
= intern_c_string ("both-horiz");
26315 staticpro (&Qboth_horiz
);
26316 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26317 staticpro (&Qtext_image_horiz
);
26318 QCmap
= intern_c_string (":map");
26319 staticpro (&QCmap
);
26320 QCpointer
= intern_c_string (":pointer");
26321 staticpro (&QCpointer
);
26322 Qrect
= intern_c_string ("rect");
26323 staticpro (&Qrect
);
26324 Qcircle
= intern_c_string ("circle");
26325 staticpro (&Qcircle
);
26326 Qpoly
= intern_c_string ("poly");
26327 staticpro (&Qpoly
);
26328 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26329 staticpro (&Qmessage_truncate_lines
);
26330 Qgrow_only
= intern_c_string ("grow-only");
26331 staticpro (&Qgrow_only
);
26332 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26333 staticpro (&Qinhibit_menubar_update
);
26334 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26335 staticpro (&Qinhibit_eval_during_redisplay
);
26336 Qposition
= intern_c_string ("position");
26337 staticpro (&Qposition
);
26338 Qbuffer_position
= intern_c_string ("buffer-position");
26339 staticpro (&Qbuffer_position
);
26340 Qobject
= intern_c_string ("object");
26341 staticpro (&Qobject
);
26342 Qbar
= intern_c_string ("bar");
26344 Qhbar
= intern_c_string ("hbar");
26345 staticpro (&Qhbar
);
26346 Qbox
= intern_c_string ("box");
26348 Qhollow
= intern_c_string ("hollow");
26349 staticpro (&Qhollow
);
26350 Qhand
= intern_c_string ("hand");
26351 staticpro (&Qhand
);
26352 Qarrow
= intern_c_string ("arrow");
26353 staticpro (&Qarrow
);
26354 Qtext
= intern_c_string ("text");
26355 staticpro (&Qtext
);
26356 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26357 staticpro (&Qinhibit_free_realized_faces
);
26359 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26360 Fcons (intern_c_string ("void-variable"), Qnil
)),
26362 staticpro (&list_of_error
);
26364 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26365 staticpro (&Qlast_arrow_position
);
26366 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26367 staticpro (&Qlast_arrow_string
);
26369 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26370 staticpro (&Qoverlay_arrow_string
);
26371 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26372 staticpro (&Qoverlay_arrow_bitmap
);
26374 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26375 staticpro (&echo_buffer
[0]);
26376 staticpro (&echo_buffer
[1]);
26378 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26379 staticpro (&echo_area_buffer
[0]);
26380 staticpro (&echo_area_buffer
[1]);
26382 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26383 staticpro (&Vmessages_buffer_name
);
26385 mode_line_proptrans_alist
= Qnil
;
26386 staticpro (&mode_line_proptrans_alist
);
26387 mode_line_string_list
= Qnil
;
26388 staticpro (&mode_line_string_list
);
26389 mode_line_string_face
= Qnil
;
26390 staticpro (&mode_line_string_face
);
26391 mode_line_string_face_prop
= Qnil
;
26392 staticpro (&mode_line_string_face_prop
);
26393 Vmode_line_unwind_vector
= Qnil
;
26394 staticpro (&Vmode_line_unwind_vector
);
26396 help_echo_string
= Qnil
;
26397 staticpro (&help_echo_string
);
26398 help_echo_object
= Qnil
;
26399 staticpro (&help_echo_object
);
26400 help_echo_window
= Qnil
;
26401 staticpro (&help_echo_window
);
26402 previous_help_echo_string
= Qnil
;
26403 staticpro (&previous_help_echo_string
);
26404 help_echo_pos
= -1;
26406 Qright_to_left
= intern_c_string ("right-to-left");
26407 staticpro (&Qright_to_left
);
26408 Qleft_to_right
= intern_c_string ("left-to-right");
26409 staticpro (&Qleft_to_right
);
26411 #ifdef HAVE_WINDOW_SYSTEM
26412 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26413 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26414 For example, if a block cursor is over a tab, it will be drawn as
26415 wide as that tab on the display. */);
26416 x_stretch_cursor_p
= 0;
26419 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26420 doc
: /* *Non-nil means highlight trailing whitespace.
26421 The face used for trailing whitespace is `trailing-whitespace'. */);
26422 Vshow_trailing_whitespace
= Qnil
;
26424 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26425 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26426 A value of t means highlight the character itself (for nobreak space,
26427 use face `nobreak-space').
26428 A value of nil means no highlighting.
26429 Other values mean display the escape glyph followed by an ordinary
26430 space or ordinary hyphen. */);
26431 Vnobreak_char_display
= Qt
;
26433 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26434 doc
: /* *The pointer shape to show in void text areas.
26435 A value of nil means to show the text pointer. Other options are `arrow',
26436 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26437 Vvoid_text_area_pointer
= Qarrow
;
26439 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26440 doc
: /* Non-nil means don't actually do any redisplay.
26441 This is used for internal purposes. */);
26442 Vinhibit_redisplay
= Qnil
;
26444 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26445 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26446 Vglobal_mode_string
= Qnil
;
26448 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26449 doc
: /* Marker for where to display an arrow on top of the buffer text.
26450 This must be the beginning of a line in order to work.
26451 See also `overlay-arrow-string'. */);
26452 Voverlay_arrow_position
= Qnil
;
26454 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26455 doc
: /* String to display as an arrow in non-window frames.
26456 See also `overlay-arrow-position'. */);
26457 Voverlay_arrow_string
= make_pure_c_string ("=>");
26459 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26460 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26461 The symbols on this list are examined during redisplay to determine
26462 where to display overlay arrows. */);
26463 Voverlay_arrow_variable_list
26464 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26466 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26467 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26468 If that fails to bring point back on frame, point is centered instead.
26469 If this is zero, point is always centered after it moves off frame.
26470 If you want scrolling to always be a line at a time, you should set
26471 `scroll-conservatively' to a large value rather than set this to 1. */);
26473 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26474 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26475 If point moves off-screen, redisplay will scroll by up to
26476 `scroll-conservatively' lines in order to bring point just barely
26477 onto the screen again. If that cannot be done, then redisplay
26478 recenters point as usual.
26480 A value of zero means always recenter point if it moves off screen. */);
26481 scroll_conservatively
= 0;
26483 DEFVAR_INT ("scroll-margin", scroll_margin
,
26484 doc
: /* *Number of lines of margin at the top and bottom of a window.
26485 Recenter the window whenever point gets within this many lines
26486 of the top or bottom of the window. */);
26489 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26490 doc
: /* Pixels per inch value for non-window system displays.
26491 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26492 Vdisplay_pixels_per_inch
= make_float (72.0);
26495 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26498 DEFVAR_LISP ("truncate-partial-width-windows",
26499 Vtruncate_partial_width_windows
,
26500 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26501 For an integer value, truncate lines in each window narrower than the
26502 full frame width, provided the window width is less than that integer;
26503 otherwise, respect the value of `truncate-lines'.
26505 For any other non-nil value, truncate lines in all windows that do
26506 not span the full frame width.
26508 A value of nil means to respect the value of `truncate-lines'.
26510 If `word-wrap' is enabled, you might want to reduce this. */);
26511 Vtruncate_partial_width_windows
= make_number (50);
26513 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26514 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26515 Any other value means to use the appropriate face, `mode-line',
26516 `header-line', or `menu' respectively. */);
26517 mode_line_inverse_video
= 1;
26519 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26520 doc
: /* *Maximum buffer size for which line number should be displayed.
26521 If the buffer is bigger than this, the line number does not appear
26522 in the mode line. A value of nil means no limit. */);
26523 Vline_number_display_limit
= Qnil
;
26525 DEFVAR_INT ("line-number-display-limit-width",
26526 line_number_display_limit_width
,
26527 doc
: /* *Maximum line width (in characters) for line number display.
26528 If the average length of the lines near point is bigger than this, then the
26529 line number may be omitted from the mode line. */);
26530 line_number_display_limit_width
= 200;
26532 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26533 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26534 highlight_nonselected_windows
= 0;
26536 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26537 doc
: /* Non-nil if more than one frame is visible on this display.
26538 Minibuffer-only frames don't count, but iconified frames do.
26539 This variable is not guaranteed to be accurate except while processing
26540 `frame-title-format' and `icon-title-format'. */);
26542 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26543 doc
: /* Template for displaying the title bar of visible frames.
26544 \(Assuming the window manager supports this feature.)
26546 This variable has the same structure as `mode-line-format', except that
26547 the %c and %l constructs are ignored. It is used only on frames for
26548 which no explicit name has been set \(see `modify-frame-parameters'). */);
26550 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26551 doc
: /* Template for displaying the title bar of an iconified frame.
26552 \(Assuming the window manager supports this feature.)
26553 This variable has the same structure as `mode-line-format' (which see),
26554 and is used only on frames for which no explicit name has been set
26555 \(see `modify-frame-parameters'). */);
26557 = Vframe_title_format
26558 = pure_cons (intern_c_string ("multiple-frames"),
26559 pure_cons (make_pure_c_string ("%b"),
26560 pure_cons (pure_cons (empty_unibyte_string
,
26561 pure_cons (intern_c_string ("invocation-name"),
26562 pure_cons (make_pure_c_string ("@"),
26563 pure_cons (intern_c_string ("system-name"),
26567 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26568 doc
: /* Maximum number of lines to keep in the message log buffer.
26569 If nil, disable message logging. If t, log messages but don't truncate
26570 the buffer when it becomes large. */);
26571 Vmessage_log_max
= make_number (100);
26573 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26574 doc
: /* Functions called before redisplay, if window sizes have changed.
26575 The value should be a list of functions that take one argument.
26576 Just before redisplay, for each frame, if any of its windows have changed
26577 size since the last redisplay, or have been split or deleted,
26578 all the functions in the list are called, with the frame as argument. */);
26579 Vwindow_size_change_functions
= Qnil
;
26581 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26582 doc
: /* List of functions to call before redisplaying a window with scrolling.
26583 Each function is called with two arguments, the window and its new
26584 display-start position. Note that these functions are also called by
26585 `set-window-buffer'. Also note that the value of `window-end' is not
26586 valid when these functions are called. */);
26587 Vwindow_scroll_functions
= Qnil
;
26589 DEFVAR_LISP ("window-text-change-functions",
26590 Vwindow_text_change_functions
,
26591 doc
: /* Functions to call in redisplay when text in the window might change. */);
26592 Vwindow_text_change_functions
= Qnil
;
26594 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26595 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26596 Each function is called with two arguments, the window and the end trigger value.
26597 See `set-window-redisplay-end-trigger'. */);
26598 Vredisplay_end_trigger_functions
= Qnil
;
26600 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26601 doc
: /* *Non-nil means autoselect window with mouse pointer.
26602 If nil, do not autoselect windows.
26603 A positive number means delay autoselection by that many seconds: a
26604 window is autoselected only after the mouse has remained in that
26605 window for the duration of the delay.
26606 A negative number has a similar effect, but causes windows to be
26607 autoselected only after the mouse has stopped moving. \(Because of
26608 the way Emacs compares mouse events, you will occasionally wait twice
26609 that time before the window gets selected.\)
26610 Any other value means to autoselect window instantaneously when the
26611 mouse pointer enters it.
26613 Autoselection selects the minibuffer only if it is active, and never
26614 unselects the minibuffer if it is active.
26616 When customizing this variable make sure that the actual value of
26617 `focus-follows-mouse' matches the behavior of your window manager. */);
26618 Vmouse_autoselect_window
= Qnil
;
26620 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26621 doc
: /* *Non-nil means automatically resize tool-bars.
26622 This dynamically changes the tool-bar's height to the minimum height
26623 that is needed to make all tool-bar items visible.
26624 If value is `grow-only', the tool-bar's height is only increased
26625 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26626 Vauto_resize_tool_bars
= Qt
;
26628 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26629 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26630 auto_raise_tool_bar_buttons_p
= 1;
26632 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26633 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26634 make_cursor_line_fully_visible_p
= 1;
26636 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26637 doc
: /* *Border below tool-bar in pixels.
26638 If an integer, use it as the height of the border.
26639 If it is one of `internal-border-width' or `border-width', use the
26640 value of the corresponding frame parameter.
26641 Otherwise, no border is added below the tool-bar. */);
26642 Vtool_bar_border
= Qinternal_border_width
;
26644 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26645 doc
: /* *Margin around tool-bar buttons in pixels.
26646 If an integer, use that for both horizontal and vertical margins.
26647 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26648 HORZ specifying the horizontal margin, and VERT specifying the
26649 vertical margin. */);
26650 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26652 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26653 doc
: /* *Relief thickness of tool-bar buttons. */);
26654 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26656 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26657 doc
: /* Tool bar style to use.
26659 image - show images only
26660 text - show text only
26661 both - show both, text below image
26662 both-horiz - show text to the right of the image
26663 text-image-horiz - show text to the left of the image
26664 any other - use system default or image if no system default. */);
26665 Vtool_bar_style
= Qnil
;
26667 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26668 doc
: /* *Maximum number of characters a label can have to be shown.
26669 The tool bar style must also show labels for this to have any effect, see
26670 `tool-bar-style'. */);
26671 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26673 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26674 doc
: /* List of functions to call to fontify regions of text.
26675 Each function is called with one argument POS. Functions must
26676 fontify a region starting at POS in the current buffer, and give
26677 fontified regions the property `fontified'. */);
26678 Vfontification_functions
= Qnil
;
26679 Fmake_variable_buffer_local (Qfontification_functions
);
26681 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26682 unibyte_display_via_language_environment
,
26683 doc
: /* *Non-nil means display unibyte text according to language environment.
26684 Specifically, this means that raw bytes in the range 160-255 decimal
26685 are displayed by converting them to the equivalent multibyte characters
26686 according to the current language environment. As a result, they are
26687 displayed according to the current fontset.
26689 Note that this variable affects only how these bytes are displayed,
26690 but does not change the fact they are interpreted as raw bytes. */);
26691 unibyte_display_via_language_environment
= 0;
26693 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26694 doc
: /* *Maximum height for resizing mini-windows.
26695 If a float, it specifies a fraction of the mini-window frame's height.
26696 If an integer, it specifies a number of lines. */);
26697 Vmax_mini_window_height
= make_float (0.25);
26699 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26700 doc
: /* *How to resize mini-windows.
26701 A value of nil means don't automatically resize mini-windows.
26702 A value of t means resize them to fit the text displayed in them.
26703 A value of `grow-only', the default, means let mini-windows grow
26704 only, until their display becomes empty, at which point the windows
26705 go back to their normal size. */);
26706 Vresize_mini_windows
= Qgrow_only
;
26708 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26709 doc
: /* Alist specifying how to blink the cursor off.
26710 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26711 `cursor-type' frame-parameter or variable equals ON-STATE,
26712 comparing using `equal', Emacs uses OFF-STATE to specify
26713 how to blink it off. ON-STATE and OFF-STATE are values for
26714 the `cursor-type' frame parameter.
26716 If a frame's ON-STATE has no entry in this list,
26717 the frame's other specifications determine how to blink the cursor off. */);
26718 Vblink_cursor_alist
= Qnil
;
26720 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26721 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26722 If non-nil, windows are automatically scrolled horizontally to make
26723 point visible. */);
26724 automatic_hscrolling_p
= 1;
26725 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26726 staticpro (&Qauto_hscroll_mode
);
26728 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26729 doc
: /* *How many columns away from the window edge point is allowed to get
26730 before automatic hscrolling will horizontally scroll the window. */);
26731 hscroll_margin
= 5;
26733 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26734 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26735 When point is less than `hscroll-margin' columns from the window
26736 edge, automatic hscrolling will scroll the window by the amount of columns
26737 determined by this variable. If its value is a positive integer, scroll that
26738 many columns. If it's a positive floating-point number, it specifies the
26739 fraction of the window's width to scroll. If it's nil or zero, point will be
26740 centered horizontally after the scroll. Any other value, including negative
26741 numbers, are treated as if the value were zero.
26743 Automatic hscrolling always moves point outside the scroll margin, so if
26744 point was more than scroll step columns inside the margin, the window will
26745 scroll more than the value given by the scroll step.
26747 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26748 and `scroll-right' overrides this variable's effect. */);
26749 Vhscroll_step
= make_number (0);
26751 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26752 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26753 Bind this around calls to `message' to let it take effect. */);
26754 message_truncate_lines
= 0;
26756 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26757 doc
: /* Normal hook run to update the menu bar definitions.
26758 Redisplay runs this hook before it redisplays the menu bar.
26759 This is used to update submenus such as Buffers,
26760 whose contents depend on various data. */);
26761 Vmenu_bar_update_hook
= Qnil
;
26763 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26764 doc
: /* Frame for which we are updating a menu.
26765 The enable predicate for a menu binding should check this variable. */);
26766 Vmenu_updating_frame
= Qnil
;
26768 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26769 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26770 inhibit_menubar_update
= 0;
26772 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26773 doc
: /* Prefix prepended to all continuation lines at display time.
26774 The value may be a string, an image, or a stretch-glyph; it is
26775 interpreted in the same way as the value of a `display' text property.
26777 This variable is overridden by any `wrap-prefix' text or overlay
26780 To add a prefix to non-continuation lines, use `line-prefix'. */);
26781 Vwrap_prefix
= Qnil
;
26782 staticpro (&Qwrap_prefix
);
26783 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26784 Fmake_variable_buffer_local (Qwrap_prefix
);
26786 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26787 doc
: /* Prefix prepended to all non-continuation lines at display time.
26788 The value may be a string, an image, or a stretch-glyph; it is
26789 interpreted in the same way as the value of a `display' text property.
26791 This variable is overridden by any `line-prefix' text or overlay
26794 To add a prefix to continuation lines, use `wrap-prefix'. */);
26795 Vline_prefix
= Qnil
;
26796 staticpro (&Qline_prefix
);
26797 Qline_prefix
= intern_c_string ("line-prefix");
26798 Fmake_variable_buffer_local (Qline_prefix
);
26800 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26801 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26802 inhibit_eval_during_redisplay
= 0;
26804 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26805 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26806 inhibit_free_realized_faces
= 0;
26809 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26810 doc
: /* Inhibit try_window_id display optimization. */);
26811 inhibit_try_window_id
= 0;
26813 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26814 doc
: /* Inhibit try_window_reusing display optimization. */);
26815 inhibit_try_window_reusing
= 0;
26817 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26818 doc
: /* Inhibit try_cursor_movement display optimization. */);
26819 inhibit_try_cursor_movement
= 0;
26820 #endif /* GLYPH_DEBUG */
26822 DEFVAR_INT ("overline-margin", overline_margin
,
26823 doc
: /* *Space between overline and text, in pixels.
26824 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26825 margin to the caracter height. */);
26826 overline_margin
= 2;
26828 DEFVAR_INT ("underline-minimum-offset",
26829 underline_minimum_offset
,
26830 doc
: /* Minimum distance between baseline and underline.
26831 This can improve legibility of underlined text at small font sizes,
26832 particularly when using variable `x-use-underline-position-properties'
26833 with fonts that specify an UNDERLINE_POSITION relatively close to the
26834 baseline. The default value is 1. */);
26835 underline_minimum_offset
= 1;
26837 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26838 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26839 This feature only works when on a window system that can change
26840 cursor shapes. */);
26841 display_hourglass_p
= 1;
26843 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26844 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26845 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26847 hourglass_atimer
= NULL
;
26848 hourglass_shown_p
= 0;
26850 DEFSYM (Qglyphless_char
, "glyphless-char");
26851 DEFSYM (Qhex_code
, "hex-code");
26852 DEFSYM (Qempty_box
, "empty-box");
26853 DEFSYM (Qthin_space
, "thin-space");
26854 DEFSYM (Qzero_width
, "zero-width");
26856 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26857 /* Intern this now in case it isn't already done.
26858 Setting this variable twice is harmless.
26859 But don't staticpro it here--that is done in alloc.c. */
26860 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26861 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26863 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26864 doc
: /* Char-table to control displaying of glyphless characters.
26865 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26866 or one of these symbols:
26867 hex-code: display the hexadecimal code of a character in a box
26868 empty-box: display as an empty box
26869 thin-space: display as 1-pixel width space
26870 zero-width: don't display
26872 It has one extra slot to control the display of a character for which
26873 no font is found. The value of the slot is `hex-code' or `empty-box'.
26874 The default is `empty-box'. */);
26875 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26876 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26881 /* Initialize this module when Emacs starts. */
26886 Lisp_Object root_window
;
26887 struct window
*mini_w
;
26889 current_header_line_height
= current_mode_line_height
= -1;
26891 CHARPOS (this_line_start_pos
) = 0;
26893 mini_w
= XWINDOW (minibuf_window
);
26894 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26896 if (!noninteractive
)
26898 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26901 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26902 set_window_height (root_window
,
26903 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26905 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26906 set_window_height (minibuf_window
, 1, 0);
26908 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26909 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26911 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26912 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26913 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26915 /* The default ellipsis glyphs `...'. */
26916 for (i
= 0; i
< 3; ++i
)
26917 default_invis_vector
[i
] = make_number ('.');
26921 /* Allocate the buffer for frame titles.
26922 Also used for `format-mode-line'. */
26924 mode_line_noprop_buf
= (char *) xmalloc (size
);
26925 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26926 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26927 mode_line_target
= MODE_LINE_DISPLAY
;
26930 help_echo_showing_p
= 0;
26933 /* Since w32 does not support atimers, it defines its own implementation of
26934 the following three functions in w32fns.c. */
26937 /* Platform-independent portion of hourglass implementation. */
26939 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26941 hourglass_started (void)
26943 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26946 /* Cancel a currently active hourglass timer, and start a new one. */
26948 start_hourglass (void)
26950 #if defined (HAVE_WINDOW_SYSTEM)
26952 int secs
, usecs
= 0;
26954 cancel_hourglass ();
26956 if (INTEGERP (Vhourglass_delay
)
26957 && XINT (Vhourglass_delay
) > 0)
26958 secs
= XFASTINT (Vhourglass_delay
);
26959 else if (FLOATP (Vhourglass_delay
)
26960 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26963 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26964 secs
= XFASTINT (tem
);
26965 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26968 secs
= DEFAULT_HOURGLASS_DELAY
;
26970 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26971 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26972 show_hourglass
, NULL
);
26977 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26980 cancel_hourglass (void)
26982 #if defined (HAVE_WINDOW_SYSTEM)
26983 if (hourglass_atimer
)
26985 cancel_atimer (hourglass_atimer
);
26986 hourglass_atimer
= NULL
;
26989 if (hourglass_shown_p
)
26993 #endif /* ! WINDOWSNT */