1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator.
133 Calls to get_next_display_element fill the iterator structure with
134 relevant information about the next thing to display. Calls to
135 set_iterator_to_next move the iterator to the next thing.
137 Besides this, an iterator also contains information about the
138 display environment in which glyphs for display elements are to be
139 produced. It has fields for the width and height of the display,
140 the information whether long lines are truncated or continued, a
141 current X and Y position, and lots of other stuff you can better
144 Glyphs in a desired matrix are normally constructed in a loop
145 calling get_next_display_element and then PRODUCE_GLYPHS. The call
146 to PRODUCE_GLYPHS will fill the iterator structure with pixel
147 information about the element being displayed and at the same time
148 produce glyphs for it. If the display element fits on the line
149 being displayed, set_iterator_to_next is called next, otherwise the
150 glyphs produced are discarded. The function display_line is the
151 workhorse of filling glyph rows in the desired matrix with glyphs.
152 In addition to producing glyphs, it also handles line truncation
153 and continuation, word wrap, and cursor positioning (for the
154 latter, see also set_cursor_from_row).
158 That just couldn't be all, could it? What about terminal types not
159 supporting operations on sub-windows of the screen? To update the
160 display on such a terminal, window-based glyph matrices are not
161 well suited. To be able to reuse part of the display (scrolling
162 lines up and down), we must instead have a view of the whole
163 screen. This is what `frame matrices' are for. They are a trick.
165 Frames on terminals like above have a glyph pool. Windows on such
166 a frame sub-allocate their glyph memory from their frame's glyph
167 pool. The frame itself is given its own glyph matrices. By
168 coincidence---or maybe something else---rows in window glyph
169 matrices are slices of corresponding rows in frame matrices. Thus
170 writing to window matrices implicitly updates a frame matrix which
171 provides us with the view of the whole screen that we originally
172 wanted to have without having to move many bytes around. To be
173 honest, there is a little bit more done, but not much more. If you
174 plan to extend that code, take a look at dispnew.c. The function
175 build_frame_matrix is a good starting point.
177 Bidirectional display.
179 Bidirectional display adds quite some hair to this already complex
180 design. The good news are that a large portion of that hairy stuff
181 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
182 reordering engine which is called by set_iterator_to_next and
183 returns the next character to display in the visual order. See
184 commentary on bidi.c for more details. As far as redisplay is
185 concerned, the effect of calling bidi_move_to_visually_next, the
186 main interface of the reordering engine, is that the iterator gets
187 magically placed on the buffer or string position that is to be
188 displayed next. In other words, a linear iteration through the
189 buffer/string is replaced with a non-linear one. All the rest of
190 the redisplay is oblivious to the bidi reordering.
192 Well, almost oblivious---there are still complications, most of
193 them due to the fact that buffer and string positions no longer
194 change monotonously with glyph indices in a glyph row. Moreover,
195 for continued lines, the buffer positions may not even be
196 monotonously changing with vertical positions. Also, accounting
197 for face changes, overlays, etc. becomes more complex because
198 non-linear iteration could potentially skip many positions with
199 changes, and then cross them again on the way back...
201 One other prominent effect of bidirectional display is that some
202 paragraphs of text need to be displayed starting at the right
203 margin of the window---the so-called right-to-left, or R2L
204 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
205 which have their reversed_p flag set. The bidi reordering engine
206 produces characters in such rows starting from the character which
207 should be the rightmost on display. PRODUCE_GLYPHS then reverses
208 the order, when it fills up the glyph row whose reversed_p flag is
209 set, by prepending each new glyph to what is already there, instead
210 of appending it. When the glyph row is complete, the function
211 extend_face_to_end_of_line fills the empty space to the left of the
212 leftmost character with special glyphs, which will display as,
213 well, empty. On text terminals, these special glyphs are simply
214 blank characters. On graphics terminals, there's a single stretch
215 glyph of a suitably computed width. Both the blanks and the
216 stretch glyph are given the face of the background of the line.
217 This way, the terminal-specific back-end can still draw the glyphs
218 left to right, even for R2L lines.
220 Bidirectional display and character compositions
222 Some scripts cannot be displayed by drawing each character
223 individually, because adjacent characters change each other's shape
224 on display. For example, Arabic and Indic scripts belong to this
227 Emacs display supports this by providing "character compositions",
228 most of which is implemented in composite.c. During the buffer
229 scan that delivers characters to PRODUCE_GLYPHS, if the next
230 character to be delivered is a composed character, the iteration
231 calls composition_reseat_it and next_element_from_composition. If
232 they succeed to compose the character with one or more of the
233 following characters, the whole sequence of characters that where
234 composed is recorded in the `struct composition_it' object that is
235 part of the buffer iterator. The composed sequence could produce
236 one or more font glyphs (called "grapheme clusters") on the screen.
237 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
238 in the direction corresponding to the current bidi scan direction
239 (recorded in the scan_dir member of the `struct bidi_it' object
240 that is part of the buffer iterator). In particular, if the bidi
241 iterator currently scans the buffer backwards, the grapheme
242 clusters are delivered back to front. This reorders the grapheme
243 clusters as appropriate for the current bidi context. Note that
244 this means that the grapheme clusters are always stored in the
245 LGSTRING object (see composite.c) in the logical order.
247 Moving an iterator in bidirectional text
248 without producing glyphs
250 Note one important detail mentioned above: that the bidi reordering
251 engine, driven by the iterator, produces characters in R2L rows
252 starting at the character that will be the rightmost on display.
253 As far as the iterator is concerned, the geometry of such rows is
254 still left to right, i.e. the iterator "thinks" the first character
255 is at the leftmost pixel position. The iterator does not know that
256 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
257 delivers. This is important when functions from the the move_it_*
258 family are used to get to certain screen position or to match
259 screen coordinates with buffer coordinates: these functions use the
260 iterator geometry, which is left to right even in R2L paragraphs.
261 This works well with most callers of move_it_*, because they need
262 to get to a specific column, and columns are still numbered in the
263 reading order, i.e. the rightmost character in a R2L paragraph is
264 still column zero. But some callers do not get well with this; a
265 notable example is mouse clicks that need to find the character
266 that corresponds to certain pixel coordinates. See
267 buffer_posn_from_coords in dispnew.c for how this is handled. */
275 #include "keyboard.h"
278 #include "termchar.h"
279 #include "dispextern.h"
281 #include "character.h"
284 #include "commands.h"
288 #include "termhooks.h"
289 #include "termopts.h"
290 #include "intervals.h"
293 #include "region-cache.h"
296 #include "blockinput.h"
298 #ifdef HAVE_X_WINDOWS
313 #ifndef FRAME_X_OUTPUT
314 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
317 #define INFINITY 10000000
319 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
320 Lisp_Object Qwindow_scroll_functions
;
321 Lisp_Object Qwindow_text_change_functions
;
322 Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
325 Lisp_Object Qfontified
;
326 Lisp_Object Qgrow_only
;
327 Lisp_Object Qinhibit_eval_during_redisplay
;
328 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
329 Lisp_Object Qright_to_left
, Qleft_to_right
;
332 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
335 Lisp_Object Qarrow
, Qhand
, Qtext
;
337 /* Holds the list (error). */
338 Lisp_Object list_of_error
;
340 Lisp_Object Qfontification_functions
;
342 Lisp_Object Qwrap_prefix
;
343 Lisp_Object Qline_prefix
;
345 /* Non-nil means don't actually do any redisplay. */
347 Lisp_Object Qinhibit_redisplay
;
349 /* Names of text properties relevant for redisplay. */
351 Lisp_Object Qdisplay
;
353 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
354 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
357 Lisp_Object Qmargin
, Qpointer
;
358 Lisp_Object Qline_height
;
360 #ifdef HAVE_WINDOW_SYSTEM
362 /* Test if overflow newline into fringe. Called with iterator IT
363 at or past right window margin, and with IT->current_x set. */
365 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
366 (!NILP (Voverflow_newline_into_fringe) \
367 && FRAME_WINDOW_P ((IT)->f) \
368 && ((IT)->bidi_it.paragraph_dir == R2L \
369 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
370 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
371 && (IT)->current_x == (IT)->last_visible_x \
372 && (IT)->line_wrap != WORD_WRAP)
374 #else /* !HAVE_WINDOW_SYSTEM */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
376 #endif /* HAVE_WINDOW_SYSTEM */
378 /* Test if the display element loaded in IT is a space or tab
379 character. This is used to determine word wrapping. */
381 #define IT_DISPLAYING_WHITESPACE(it) \
382 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
384 /* Name of the face used to highlight trailing whitespace. */
386 Lisp_Object Qtrailing_whitespace
;
388 /* Name and number of the face used to highlight escape glyphs. */
390 Lisp_Object Qescape_glyph
;
392 /* Name and number of the face used to highlight non-breaking spaces. */
394 Lisp_Object Qnobreak_space
;
396 /* The symbol `image' which is the car of the lists used to represent
397 images in Lisp. Also a tool bar style. */
401 /* The image map types. */
402 Lisp_Object QCmap
, QCpointer
;
403 Lisp_Object Qrect
, Qcircle
, Qpoly
;
405 /* Tool bar styles */
406 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
408 /* Non-zero means print newline to stdout before next mini-buffer
411 int noninteractive_need_newline
;
413 /* Non-zero means print newline to message log before next message. */
415 static int message_log_need_newline
;
417 /* Three markers that message_dolog uses.
418 It could allocate them itself, but that causes trouble
419 in handling memory-full errors. */
420 static Lisp_Object message_dolog_marker1
;
421 static Lisp_Object message_dolog_marker2
;
422 static Lisp_Object message_dolog_marker3
;
424 /* The buffer position of the first character appearing entirely or
425 partially on the line of the selected window which contains the
426 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
427 redisplay optimization in redisplay_internal. */
429 static struct text_pos this_line_start_pos
;
431 /* Number of characters past the end of the line above, including the
432 terminating newline. */
434 static struct text_pos this_line_end_pos
;
436 /* The vertical positions and the height of this line. */
438 static int this_line_vpos
;
439 static int this_line_y
;
440 static int this_line_pixel_height
;
442 /* X position at which this display line starts. Usually zero;
443 negative if first character is partially visible. */
445 static int this_line_start_x
;
447 /* The smallest character position seen by move_it_* functions as they
448 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
449 hscrolled lines, see display_line. */
451 static struct text_pos this_line_min_pos
;
453 /* Buffer that this_line_.* variables are referring to. */
455 static struct buffer
*this_line_buffer
;
458 /* Values of those variables at last redisplay are stored as
459 properties on `overlay-arrow-position' symbol. However, if
460 Voverlay_arrow_position is a marker, last-arrow-position is its
461 numerical position. */
463 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
465 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
466 properties on a symbol in overlay-arrow-variable-list. */
468 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
470 Lisp_Object Qmenu_bar_update_hook
;
472 /* Nonzero if an overlay arrow has been displayed in this window. */
474 static int overlay_arrow_seen
;
476 /* Number of windows showing the buffer of the selected window (or
477 another buffer with the same base buffer). keyboard.c refers to
482 /* Vector containing glyphs for an ellipsis `...'. */
484 static Lisp_Object default_invis_vector
[3];
486 /* This is the window where the echo area message was displayed. It
487 is always a mini-buffer window, but it may not be the same window
488 currently active as a mini-buffer. */
490 Lisp_Object echo_area_window
;
492 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
493 pushes the current message and the value of
494 message_enable_multibyte on the stack, the function restore_message
495 pops the stack and displays MESSAGE again. */
497 Lisp_Object Vmessage_stack
;
499 /* Nonzero means multibyte characters were enabled when the echo area
500 message was specified. */
502 int message_enable_multibyte
;
504 /* Nonzero if we should redraw the mode lines on the next redisplay. */
506 int update_mode_lines
;
508 /* Nonzero if window sizes or contents have changed since last
509 redisplay that finished. */
511 int windows_or_buffers_changed
;
513 /* Nonzero means a frame's cursor type has been changed. */
515 int cursor_type_changed
;
517 /* Nonzero after display_mode_line if %l was used and it displayed a
520 int line_number_displayed
;
522 /* The name of the *Messages* buffer, a string. */
524 static Lisp_Object Vmessages_buffer_name
;
526 /* Current, index 0, and last displayed echo area message. Either
527 buffers from echo_buffers, or nil to indicate no message. */
529 Lisp_Object echo_area_buffer
[2];
531 /* The buffers referenced from echo_area_buffer. */
533 static Lisp_Object echo_buffer
[2];
535 /* A vector saved used in with_area_buffer to reduce consing. */
537 static Lisp_Object Vwith_echo_area_save_vector
;
539 /* Non-zero means display_echo_area should display the last echo area
540 message again. Set by redisplay_preserve_echo_area. */
542 static int display_last_displayed_message_p
;
544 /* Nonzero if echo area is being used by print; zero if being used by
547 int message_buf_print
;
549 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
551 Lisp_Object Qinhibit_menubar_update
;
552 Lisp_Object Qmessage_truncate_lines
;
554 /* Set to 1 in clear_message to make redisplay_internal aware
555 of an emptied echo area. */
557 static int message_cleared_p
;
559 /* A scratch glyph row with contents used for generating truncation
560 glyphs. Also used in direct_output_for_insert. */
562 #define MAX_SCRATCH_GLYPHS 100
563 struct glyph_row scratch_glyph_row
;
564 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
566 /* Ascent and height of the last line processed by move_it_to. */
568 static int last_max_ascent
, last_height
;
570 /* Non-zero if there's a help-echo in the echo area. */
572 int help_echo_showing_p
;
574 /* If >= 0, computed, exact values of mode-line and header-line height
575 to use in the macros CURRENT_MODE_LINE_HEIGHT and
576 CURRENT_HEADER_LINE_HEIGHT. */
578 int current_mode_line_height
, current_header_line_height
;
580 /* The maximum distance to look ahead for text properties. Values
581 that are too small let us call compute_char_face and similar
582 functions too often which is expensive. Values that are too large
583 let us call compute_char_face and alike too often because we
584 might not be interested in text properties that far away. */
586 #define TEXT_PROP_DISTANCE_LIMIT 100
590 /* Non-zero means print traces of redisplay if compiled with
593 int trace_redisplay_p
;
595 #endif /* GLYPH_DEBUG */
597 #ifdef DEBUG_TRACE_MOVE
598 /* Non-zero means trace with TRACE_MOVE to stderr. */
601 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
603 #define TRACE_MOVE(x) (void) 0
606 Lisp_Object Qauto_hscroll_mode
;
608 /* Buffer being redisplayed -- for redisplay_window_error. */
610 struct buffer
*displayed_buffer
;
612 /* Value returned from text property handlers (see below). */
617 HANDLED_RECOMPUTE_PROPS
,
618 HANDLED_OVERLAY_STRING_CONSUMED
,
622 /* A description of text properties that redisplay is interested
627 /* The name of the property. */
630 /* A unique index for the property. */
633 /* A handler function called to set up iterator IT from the property
634 at IT's current position. Value is used to steer handle_stop. */
635 enum prop_handled (*handler
) (struct it
*it
);
638 static enum prop_handled
handle_face_prop (struct it
*);
639 static enum prop_handled
handle_invisible_prop (struct it
*);
640 static enum prop_handled
handle_display_prop (struct it
*);
641 static enum prop_handled
handle_composition_prop (struct it
*);
642 static enum prop_handled
handle_overlay_change (struct it
*);
643 static enum prop_handled
handle_fontified_prop (struct it
*);
645 /* Properties handled by iterators. */
647 static struct props it_props
[] =
649 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
650 /* Handle `face' before `display' because some sub-properties of
651 `display' need to know the face. */
652 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
653 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
654 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
655 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
659 /* Value is the position described by X. If X is a marker, value is
660 the marker_position of X. Otherwise, value is X. */
662 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
664 /* Enumeration returned by some move_it_.* functions internally. */
668 /* Not used. Undefined value. */
671 /* Move ended at the requested buffer position or ZV. */
672 MOVE_POS_MATCH_OR_ZV
,
674 /* Move ended at the requested X pixel position. */
677 /* Move within a line ended at the end of a line that must be
681 /* Move within a line ended at the end of a line that would
682 be displayed truncated. */
685 /* Move within a line ended at a line end. */
689 /* This counter is used to clear the face cache every once in a while
690 in redisplay_internal. It is incremented for each redisplay.
691 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
694 #define CLEAR_FACE_CACHE_COUNT 500
695 static int clear_face_cache_count
;
697 /* Similarly for the image cache. */
699 #ifdef HAVE_WINDOW_SYSTEM
700 #define CLEAR_IMAGE_CACHE_COUNT 101
701 static int clear_image_cache_count
;
703 /* Null glyph slice */
704 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
707 /* Non-zero while redisplay_internal is in progress. */
711 Lisp_Object Qinhibit_free_realized_faces
;
713 /* If a string, XTread_socket generates an event to display that string.
714 (The display is done in read_char.) */
716 Lisp_Object help_echo_string
;
717 Lisp_Object help_echo_window
;
718 Lisp_Object help_echo_object
;
719 EMACS_INT help_echo_pos
;
721 /* Temporary variable for XTread_socket. */
723 Lisp_Object previous_help_echo_string
;
725 /* Platform-independent portion of hourglass implementation. */
727 /* Non-zero means an hourglass cursor is currently shown. */
728 int hourglass_shown_p
;
730 /* If non-null, an asynchronous timer that, when it expires, displays
731 an hourglass cursor on all frames. */
732 struct atimer
*hourglass_atimer
;
734 /* Name of the face used to display glyphless characters. */
735 Lisp_Object Qglyphless_char
;
737 /* Symbol for the purpose of Vglyphless_char_display. */
738 Lisp_Object Qglyphless_char_display
;
740 /* Method symbols for Vglyphless_char_display. */
741 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
743 /* Default pixel width of `thin-space' display method. */
744 #define THIN_SPACE_WIDTH 1
746 /* Default number of seconds to wait before displaying an hourglass
748 #define DEFAULT_HOURGLASS_DELAY 1
751 /* Function prototypes. */
753 static void setup_for_ellipsis (struct it
*, int);
754 static void mark_window_display_accurate_1 (struct window
*, int);
755 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
756 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
757 static int cursor_row_p (struct window
*, struct glyph_row
*);
758 static int redisplay_mode_lines (Lisp_Object
, int);
759 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
761 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
763 static void handle_line_prefix (struct it
*);
765 static void pint2str (char *, int, EMACS_INT
);
766 static void pint2hrstr (char *, int, int);
767 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
769 static void reconsider_clip_changes (struct window
*, struct buffer
*);
770 static int text_outside_line_unchanged_p (struct window
*,
771 EMACS_INT
, EMACS_INT
);
772 static void store_mode_line_noprop_char (char);
773 static int store_mode_line_noprop (const char *, int, int);
774 static void handle_stop (struct it
*);
775 static void handle_stop_backwards (struct it
*, EMACS_INT
);
776 static int single_display_spec_intangible_p (Lisp_Object
);
777 static void ensure_echo_area_buffers (void);
778 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
779 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
780 static int with_echo_area_buffer (struct window
*, int,
781 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
782 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
783 static void clear_garbaged_frames (void);
784 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
785 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
786 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
787 static int display_echo_area (struct window
*);
788 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
789 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static Lisp_Object
unwind_redisplay (Lisp_Object
);
791 static int string_char_and_length (const unsigned char *, int *);
792 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
794 static int compute_window_start_on_continuation_line (struct window
*);
795 static Lisp_Object
safe_eval_handler (Lisp_Object
);
796 static void insert_left_trunc_glyphs (struct it
*);
797 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
799 static void extend_face_to_end_of_line (struct it
*);
800 static int append_space_for_newline (struct it
*, int);
801 static int cursor_row_fully_visible_p (struct window
*, int, int);
802 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
803 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
804 static int trailing_whitespace_p (EMACS_INT
);
805 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
,
806 EMACS_INT
, EMACS_INT
);
807 static void push_it (struct it
*);
808 static void pop_it (struct it
*);
809 static void sync_frame_with_window_matrix_rows (struct window
*);
810 static void select_frame_for_redisplay (Lisp_Object
);
811 static void redisplay_internal (int);
812 static int echo_area_display (int);
813 static void redisplay_windows (Lisp_Object
);
814 static void redisplay_window (Lisp_Object
, int);
815 static Lisp_Object
redisplay_window_error (Lisp_Object
);
816 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
817 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
818 static int update_menu_bar (struct frame
*, int, int);
819 static int try_window_reusing_current_matrix (struct window
*);
820 static int try_window_id (struct window
*);
821 static int display_line (struct it
*);
822 static int display_mode_lines (struct window
*);
823 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
824 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
825 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
826 static const char *decode_mode_spec (struct window
*, int, int, int,
828 static void display_menu_bar (struct window
*);
829 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
831 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
832 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
833 static void compute_line_metrics (struct it
*);
834 static void run_redisplay_end_trigger_hook (struct it
*);
835 static int get_overlay_strings (struct it
*, EMACS_INT
);
836 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
837 static void next_overlay_string (struct it
*);
838 static void reseat (struct it
*, struct text_pos
, int);
839 static void reseat_1 (struct it
*, struct text_pos
, int);
840 static void back_to_previous_visible_line_start (struct it
*);
841 void reseat_at_previous_visible_line_start (struct it
*);
842 static void reseat_at_next_visible_line_start (struct it
*, int);
843 static int next_element_from_ellipsis (struct it
*);
844 static int next_element_from_display_vector (struct it
*);
845 static int next_element_from_string (struct it
*);
846 static int next_element_from_c_string (struct it
*);
847 static int next_element_from_buffer (struct it
*);
848 static int next_element_from_composition (struct it
*);
849 static int next_element_from_image (struct it
*);
850 static int next_element_from_stretch (struct it
*);
851 static void load_overlay_strings (struct it
*, EMACS_INT
);
852 static int init_from_display_pos (struct it
*, struct window
*,
853 struct display_pos
*);
854 static void reseat_to_string (struct it
*, const char *,
855 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
856 static enum move_it_result
857 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
858 enum move_operation_enum
);
859 void move_it_vertically_backward (struct it
*, int);
860 static void init_to_row_start (struct it
*, struct window
*,
862 static int init_to_row_end (struct it
*, struct window
*,
864 static void back_to_previous_line_start (struct it
*);
865 static int forward_to_next_line_start (struct it
*, int *);
866 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
867 Lisp_Object
, EMACS_INT
);
868 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
869 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
870 static EMACS_INT
number_of_chars (const char *, int);
871 static void compute_stop_pos (struct it
*);
872 static void compute_string_pos (struct text_pos
*, struct text_pos
,
874 static int face_before_or_after_it_pos (struct it
*, int);
875 static EMACS_INT
next_overlay_change (EMACS_INT
);
876 static int handle_single_display_spec (struct it
*, Lisp_Object
,
877 Lisp_Object
, Lisp_Object
,
878 struct text_pos
*, int);
879 static int underlying_face_id (struct it
*);
880 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
883 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
884 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
886 #ifdef HAVE_WINDOW_SYSTEM
888 static void x_consider_frame_title (Lisp_Object
);
889 static int tool_bar_lines_needed (struct frame
*, int *);
890 static void update_tool_bar (struct frame
*, int);
891 static void build_desired_tool_bar_string (struct frame
*f
);
892 static int redisplay_tool_bar (struct frame
*);
893 static void display_tool_bar_line (struct it
*, int);
894 static void notice_overwritten_cursor (struct window
*,
897 static void append_stretch_glyph (struct it
*, Lisp_Object
,
901 #endif /* HAVE_WINDOW_SYSTEM */
903 static int coords_in_mouse_face_p (struct window
*, int, int);
907 /***********************************************************************
908 Window display dimensions
909 ***********************************************************************/
911 /* Return the bottom boundary y-position for text lines in window W.
912 This is the first y position at which a line cannot start.
913 It is relative to the top of the window.
915 This is the height of W minus the height of a mode line, if any. */
918 window_text_bottom_y (struct window
*w
)
920 int height
= WINDOW_TOTAL_HEIGHT (w
);
922 if (WINDOW_WANTS_MODELINE_P (w
))
923 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
927 /* Return the pixel width of display area AREA of window W. AREA < 0
928 means return the total width of W, not including fringes to
929 the left and right of the window. */
932 window_box_width (struct window
*w
, int area
)
934 int cols
= XFASTINT (w
->total_cols
);
937 if (!w
->pseudo_window_p
)
939 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
941 if (area
== TEXT_AREA
)
943 if (INTEGERP (w
->left_margin_cols
))
944 cols
-= XFASTINT (w
->left_margin_cols
);
945 if (INTEGERP (w
->right_margin_cols
))
946 cols
-= XFASTINT (w
->right_margin_cols
);
947 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
949 else if (area
== LEFT_MARGIN_AREA
)
951 cols
= (INTEGERP (w
->left_margin_cols
)
952 ? XFASTINT (w
->left_margin_cols
) : 0);
955 else if (area
== RIGHT_MARGIN_AREA
)
957 cols
= (INTEGERP (w
->right_margin_cols
)
958 ? XFASTINT (w
->right_margin_cols
) : 0);
963 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
967 /* Return the pixel height of the display area of window W, not
968 including mode lines of W, if any. */
971 window_box_height (struct window
*w
)
973 struct frame
*f
= XFRAME (w
->frame
);
974 int height
= WINDOW_TOTAL_HEIGHT (w
);
976 xassert (height
>= 0);
978 /* Note: the code below that determines the mode-line/header-line
979 height is essentially the same as that contained in the macro
980 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
981 the appropriate glyph row has its `mode_line_p' flag set,
982 and if it doesn't, uses estimate_mode_line_height instead. */
984 if (WINDOW_WANTS_MODELINE_P (w
))
986 struct glyph_row
*ml_row
987 = (w
->current_matrix
&& w
->current_matrix
->rows
988 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
990 if (ml_row
&& ml_row
->mode_line_p
)
991 height
-= ml_row
->height
;
993 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
996 if (WINDOW_WANTS_HEADER_LINE_P (w
))
998 struct glyph_row
*hl_row
999 = (w
->current_matrix
&& w
->current_matrix
->rows
1000 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1002 if (hl_row
&& hl_row
->mode_line_p
)
1003 height
-= hl_row
->height
;
1005 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1008 /* With a very small font and a mode-line that's taller than
1009 default, we might end up with a negative height. */
1010 return max (0, height
);
1013 /* Return the window-relative coordinate of the left edge of display
1014 area AREA of window W. AREA < 0 means return the left edge of the
1015 whole window, to the right of the left fringe of W. */
1018 window_box_left_offset (struct window
*w
, int area
)
1022 if (w
->pseudo_window_p
)
1025 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1027 if (area
== TEXT_AREA
)
1028 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1029 + window_box_width (w
, LEFT_MARGIN_AREA
));
1030 else if (area
== RIGHT_MARGIN_AREA
)
1031 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1032 + window_box_width (w
, LEFT_MARGIN_AREA
)
1033 + window_box_width (w
, TEXT_AREA
)
1034 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1036 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1037 else if (area
== LEFT_MARGIN_AREA
1038 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1039 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1045 /* Return the window-relative coordinate of the right edge of display
1046 area AREA of window W. AREA < 0 means return the right edge of the
1047 whole window, to the left of the right fringe of W. */
1050 window_box_right_offset (struct window
*w
, int area
)
1052 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1055 /* Return the frame-relative coordinate of the left edge of display
1056 area AREA of window W. AREA < 0 means return the left edge of the
1057 whole window, to the right of the left fringe of W. */
1060 window_box_left (struct window
*w
, int area
)
1062 struct frame
*f
= XFRAME (w
->frame
);
1065 if (w
->pseudo_window_p
)
1066 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1068 x
= (WINDOW_LEFT_EDGE_X (w
)
1069 + window_box_left_offset (w
, area
));
1075 /* Return the frame-relative coordinate of the right edge of display
1076 area AREA of window W. AREA < 0 means return the right edge of the
1077 whole window, to the left of the right fringe of W. */
1080 window_box_right (struct window
*w
, int area
)
1082 return window_box_left (w
, area
) + window_box_width (w
, area
);
1085 /* Get the bounding box of the display area AREA of window W, without
1086 mode lines, in frame-relative coordinates. AREA < 0 means the
1087 whole window, not including the left and right fringes of
1088 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1089 coordinates of the upper-left corner of the box. Return in
1090 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1093 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1094 int *box_width
, int *box_height
)
1097 *box_width
= window_box_width (w
, area
);
1099 *box_height
= window_box_height (w
);
1101 *box_x
= window_box_left (w
, area
);
1104 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1105 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1106 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1111 /* Get the bounding box of the display area AREA of window W, without
1112 mode lines. AREA < 0 means the whole window, not including the
1113 left and right fringe of the window. Return in *TOP_LEFT_X
1114 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1115 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1116 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1120 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1121 int *bottom_right_x
, int *bottom_right_y
)
1123 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1125 *bottom_right_x
+= *top_left_x
;
1126 *bottom_right_y
+= *top_left_y
;
1131 /***********************************************************************
1133 ***********************************************************************/
1135 /* Return the bottom y-position of the line the iterator IT is in.
1136 This can modify IT's settings. */
1139 line_bottom_y (struct it
*it
)
1141 int line_height
= it
->max_ascent
+ it
->max_descent
;
1142 int line_top_y
= it
->current_y
;
1144 if (line_height
== 0)
1147 line_height
= last_height
;
1148 else if (IT_CHARPOS (*it
) < ZV
)
1150 move_it_by_lines (it
, 1, 1);
1151 line_height
= (it
->max_ascent
|| it
->max_descent
1152 ? it
->max_ascent
+ it
->max_descent
1157 struct glyph_row
*row
= it
->glyph_row
;
1159 /* Use the default character height. */
1160 it
->glyph_row
= NULL
;
1161 it
->what
= IT_CHARACTER
;
1164 PRODUCE_GLYPHS (it
);
1165 line_height
= it
->ascent
+ it
->descent
;
1166 it
->glyph_row
= row
;
1170 return line_top_y
+ line_height
;
1174 /* Return 1 if position CHARPOS is visible in window W.
1175 CHARPOS < 0 means return info about WINDOW_END position.
1176 If visible, set *X and *Y to pixel coordinates of top left corner.
1177 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1178 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1181 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1182 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1185 struct text_pos top
;
1187 struct buffer
*old_buffer
= NULL
;
1189 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1192 if (XBUFFER (w
->buffer
) != current_buffer
)
1194 old_buffer
= current_buffer
;
1195 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1198 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1200 /* Compute exact mode line heights. */
1201 if (WINDOW_WANTS_MODELINE_P (w
))
1202 current_mode_line_height
1203 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1204 BVAR (current_buffer
, mode_line_format
));
1206 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1207 current_header_line_height
1208 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1209 BVAR (current_buffer
, header_line_format
));
1211 start_display (&it
, w
, top
);
1212 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1213 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1215 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1217 /* We have reached CHARPOS, or passed it. How the call to
1218 move_it_to can overshoot: (i) If CHARPOS is on invisible
1219 text, move_it_to stops at the end of the invisible text,
1220 after CHARPOS. (ii) If CHARPOS is in a display vector,
1221 move_it_to stops on its last glyph. */
1222 int top_x
= it
.current_x
;
1223 int top_y
= it
.current_y
;
1224 enum it_method it_method
= it
.method
;
1225 /* Calling line_bottom_y may change it.method, it.position, etc. */
1226 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1227 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1229 if (top_y
< window_top_y
)
1230 visible_p
= bottom_y
> window_top_y
;
1231 else if (top_y
< it
.last_visible_y
)
1235 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1237 /* We stopped on the last glyph of a display vector.
1238 Try and recompute. Hack alert! */
1239 if (charpos
< 2 || top
.charpos
>= charpos
)
1240 top_x
= it
.glyph_row
->x
;
1244 start_display (&it2
, w
, top
);
1245 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1246 get_next_display_element (&it2
);
1247 PRODUCE_GLYPHS (&it2
);
1248 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1249 || it2
.current_x
> it2
.last_visible_x
)
1250 top_x
= it
.glyph_row
->x
;
1253 top_x
= it2
.current_x
;
1254 top_y
= it2
.current_y
;
1260 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1261 *rtop
= max (0, window_top_y
- top_y
);
1262 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1263 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1264 - max (top_y
, window_top_y
)));
1273 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1274 move_it_by_lines (&it
, 1, 0);
1275 if (charpos
< IT_CHARPOS (it
)
1276 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1279 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1281 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1282 *rtop
= max (0, -it2
.current_y
);
1283 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1284 - it
.last_visible_y
));
1285 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1287 - max (it2
.current_y
,
1288 WINDOW_HEADER_LINE_HEIGHT (w
))));
1294 set_buffer_internal_1 (old_buffer
);
1296 current_header_line_height
= current_mode_line_height
= -1;
1298 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1299 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1302 /* Debugging code. */
1304 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1305 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1307 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1314 /* Return the next character from STR. Return in *LEN the length of
1315 the character. This is like STRING_CHAR_AND_LENGTH but never
1316 returns an invalid character. If we find one, we return a `?', but
1317 with the length of the invalid character. */
1320 string_char_and_length (const unsigned char *str
, int *len
)
1324 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1325 if (!CHAR_VALID_P (c
, 1))
1326 /* We may not change the length here because other places in Emacs
1327 don't use this function, i.e. they silently accept invalid
1336 /* Given a position POS containing a valid character and byte position
1337 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1339 static struct text_pos
1340 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1342 xassert (STRINGP (string
) && nchars
>= 0);
1344 if (STRING_MULTIBYTE (string
))
1346 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1351 string_char_and_length (p
, &len
);
1354 BYTEPOS (pos
) += len
;
1358 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1364 /* Value is the text position, i.e. character and byte position,
1365 for character position CHARPOS in STRING. */
1367 static INLINE
struct text_pos
1368 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1370 struct text_pos pos
;
1371 xassert (STRINGP (string
));
1372 xassert (charpos
>= 0);
1373 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1378 /* Value is a text position, i.e. character and byte position, for
1379 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1380 means recognize multibyte characters. */
1382 static struct text_pos
1383 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1385 struct text_pos pos
;
1387 xassert (s
!= NULL
);
1388 xassert (charpos
>= 0);
1394 SET_TEXT_POS (pos
, 0, 0);
1397 string_char_and_length ((const unsigned char *) s
, &len
);
1400 BYTEPOS (pos
) += len
;
1404 SET_TEXT_POS (pos
, charpos
, charpos
);
1410 /* Value is the number of characters in C string S. MULTIBYTE_P
1411 non-zero means recognize multibyte characters. */
1414 number_of_chars (const char *s
, int multibyte_p
)
1420 EMACS_INT rest
= strlen (s
);
1422 const unsigned char *p
= (const unsigned char *) s
;
1424 for (nchars
= 0; rest
> 0; ++nchars
)
1426 string_char_and_length (p
, &len
);
1427 rest
-= len
, p
+= len
;
1431 nchars
= strlen (s
);
1437 /* Compute byte position NEWPOS->bytepos corresponding to
1438 NEWPOS->charpos. POS is a known position in string STRING.
1439 NEWPOS->charpos must be >= POS.charpos. */
1442 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1444 xassert (STRINGP (string
));
1445 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1447 if (STRING_MULTIBYTE (string
))
1448 *newpos
= string_pos_nchars_ahead (pos
, string
,
1449 CHARPOS (*newpos
) - CHARPOS (pos
));
1451 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1455 Return an estimation of the pixel height of mode or header lines on
1456 frame F. FACE_ID specifies what line's height to estimate. */
1459 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1461 #ifdef HAVE_WINDOW_SYSTEM
1462 if (FRAME_WINDOW_P (f
))
1464 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1466 /* This function is called so early when Emacs starts that the face
1467 cache and mode line face are not yet initialized. */
1468 if (FRAME_FACE_CACHE (f
))
1470 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1474 height
= FONT_HEIGHT (face
->font
);
1475 if (face
->box_line_width
> 0)
1476 height
+= 2 * face
->box_line_width
;
1487 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1488 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1489 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1490 not force the value into range. */
1493 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1494 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1497 #ifdef HAVE_WINDOW_SYSTEM
1498 if (FRAME_WINDOW_P (f
))
1500 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1501 even for negative values. */
1503 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1505 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1507 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1508 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1511 STORE_NATIVE_RECT (*bounds
,
1512 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1513 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1514 FRAME_COLUMN_WIDTH (f
) - 1,
1515 FRAME_LINE_HEIGHT (f
) - 1);
1521 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1522 pix_x
= FRAME_TOTAL_COLS (f
);
1526 else if (pix_y
> FRAME_LINES (f
))
1527 pix_y
= FRAME_LINES (f
);
1537 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1538 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1539 can't tell the positions because W's display is not up to date,
1543 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1544 int *frame_x
, int *frame_y
)
1546 #ifdef HAVE_WINDOW_SYSTEM
1547 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1551 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1552 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1554 if (display_completed
)
1556 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1557 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1558 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1564 hpos
+= glyph
->pixel_width
;
1568 /* If first glyph is partially visible, its first visible position is still 0. */
1580 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1581 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1675 Convert frame-relative x/y to coordinates relative to window W.
1676 Takes pseudo-windows into account. */
1679 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1681 if (w
->pseudo_window_p
)
1683 /* A pseudo-window is always full-width, and starts at the
1684 left edge of the frame, plus a frame border. */
1685 struct frame
*f
= XFRAME (w
->frame
);
1686 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1687 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1691 *x
-= WINDOW_LEFT_EDGE_X (w
);
1692 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1696 #ifdef HAVE_WINDOW_SYSTEM
1699 Return in RECTS[] at most N clipping rectangles for glyph string S.
1700 Return the number of stored rectangles. */
1703 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1710 if (s
->row
->full_width_p
)
1712 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1713 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1714 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1716 /* Unless displaying a mode or menu bar line, which are always
1717 fully visible, clip to the visible part of the row. */
1718 if (s
->w
->pseudo_window_p
)
1719 r
.height
= s
->row
->visible_height
;
1721 r
.height
= s
->height
;
1725 /* This is a text line that may be partially visible. */
1726 r
.x
= window_box_left (s
->w
, s
->area
);
1727 r
.width
= window_box_width (s
->w
, s
->area
);
1728 r
.height
= s
->row
->visible_height
;
1732 if (r
.x
< s
->clip_head
->x
)
1734 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1735 r
.width
-= s
->clip_head
->x
- r
.x
;
1738 r
.x
= s
->clip_head
->x
;
1741 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1743 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1744 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1749 /* If S draws overlapping rows, it's sufficient to use the top and
1750 bottom of the window for clipping because this glyph string
1751 intentionally draws over other lines. */
1752 if (s
->for_overlaps
)
1754 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1755 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1757 /* Alas, the above simple strategy does not work for the
1758 environments with anti-aliased text: if the same text is
1759 drawn onto the same place multiple times, it gets thicker.
1760 If the overlap we are processing is for the erased cursor, we
1761 take the intersection with the rectagle of the cursor. */
1762 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1764 XRectangle rc
, r_save
= r
;
1766 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1767 rc
.y
= s
->w
->phys_cursor
.y
;
1768 rc
.width
= s
->w
->phys_cursor_width
;
1769 rc
.height
= s
->w
->phys_cursor_height
;
1771 x_intersect_rectangles (&r_save
, &rc
, &r
);
1776 /* Don't use S->y for clipping because it doesn't take partially
1777 visible lines into account. For example, it can be negative for
1778 partially visible lines at the top of a window. */
1779 if (!s
->row
->full_width_p
1780 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1781 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1783 r
.y
= max (0, s
->row
->y
);
1786 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1788 /* If drawing the cursor, don't let glyph draw outside its
1789 advertised boundaries. Cleartype does this under some circumstances. */
1790 if (s
->hl
== DRAW_CURSOR
)
1792 struct glyph
*glyph
= s
->first_glyph
;
1797 r
.width
-= s
->x
- r
.x
;
1800 r
.width
= min (r
.width
, glyph
->pixel_width
);
1802 /* If r.y is below window bottom, ensure that we still see a cursor. */
1803 height
= min (glyph
->ascent
+ glyph
->descent
,
1804 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1805 max_y
= window_text_bottom_y (s
->w
) - height
;
1806 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1807 if (s
->ybase
- glyph
->ascent
> max_y
)
1814 /* Don't draw cursor glyph taller than our actual glyph. */
1815 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1816 if (height
< r
.height
)
1818 max_y
= r
.y
+ r
.height
;
1819 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1820 r
.height
= min (max_y
- r
.y
, height
);
1827 XRectangle r_save
= r
;
1829 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1833 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1834 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1836 #ifdef CONVERT_FROM_XRECT
1837 CONVERT_FROM_XRECT (r
, *rects
);
1845 /* If we are processing overlapping and allowed to return
1846 multiple clipping rectangles, we exclude the row of the glyph
1847 string from the clipping rectangle. This is to avoid drawing
1848 the same text on the environment with anti-aliasing. */
1849 #ifdef CONVERT_FROM_XRECT
1852 XRectangle
*rs
= rects
;
1854 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1856 if (s
->for_overlaps
& OVERLAPS_PRED
)
1859 if (r
.y
+ r
.height
> row_y
)
1862 rs
[i
].height
= row_y
- r
.y
;
1868 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1871 if (r
.y
< row_y
+ s
->row
->visible_height
)
1873 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1875 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1876 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1885 #ifdef CONVERT_FROM_XRECT
1886 for (i
= 0; i
< n
; i
++)
1887 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1894 Return in *NR the clipping rectangle for glyph string S. */
1897 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1899 get_glyph_string_clip_rects (s
, nr
, 1);
1904 Return the position and height of the phys cursor in window W.
1905 Set w->phys_cursor_width to width of phys cursor.
1909 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1910 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1912 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1913 int x
, y
, wd
, h
, h0
, y0
;
1915 /* Compute the width of the rectangle to draw. If on a stretch
1916 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1917 rectangle as wide as the glyph, but use a canonical character
1919 wd
= glyph
->pixel_width
- 1;
1920 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1924 x
= w
->phys_cursor
.x
;
1931 if (glyph
->type
== STRETCH_GLYPH
1932 && !x_stretch_cursor_p
)
1933 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1934 w
->phys_cursor_width
= wd
;
1936 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1938 /* If y is below window bottom, ensure that we still see a cursor. */
1939 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1941 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1942 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1944 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1947 h
= max (h
- (y0
- y
) + 1, h0
);
1952 y0
= window_text_bottom_y (w
) - h0
;
1960 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1961 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1966 * Remember which glyph the mouse is over.
1970 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1974 struct glyph_row
*r
, *gr
, *end_row
;
1975 enum window_part part
;
1976 enum glyph_row_area area
;
1977 int x
, y
, width
, height
;
1979 /* Try to determine frame pixel position and size of the glyph under
1980 frame pixel coordinates X/Y on frame F. */
1982 if (!f
->glyphs_initialized_p
1983 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1986 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1987 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1991 w
= XWINDOW (window
);
1992 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1993 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1995 x
= window_relative_x_coord (w
, part
, gx
);
1996 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1998 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1999 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2001 if (w
->pseudo_window_p
)
2004 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2010 case ON_LEFT_MARGIN
:
2011 area
= LEFT_MARGIN_AREA
;
2014 case ON_RIGHT_MARGIN
:
2015 area
= RIGHT_MARGIN_AREA
;
2018 case ON_HEADER_LINE
:
2020 gr
= (part
== ON_HEADER_LINE
2021 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2022 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2025 goto text_glyph_row_found
;
2032 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2033 if (r
->y
+ r
->height
> y
)
2039 text_glyph_row_found
:
2042 struct glyph
*g
= gr
->glyphs
[area
];
2043 struct glyph
*end
= g
+ gr
->used
[area
];
2045 height
= gr
->height
;
2046 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2047 if (gx
+ g
->pixel_width
> x
)
2052 if (g
->type
== IMAGE_GLYPH
)
2054 /* Don't remember when mouse is over image, as
2055 image may have hot-spots. */
2056 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2059 width
= g
->pixel_width
;
2063 /* Use nominal char spacing at end of line. */
2065 gx
+= (x
/ width
) * width
;
2068 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2069 gx
+= window_box_left_offset (w
, area
);
2073 /* Use nominal line height at end of window. */
2074 gx
= (x
/ width
) * width
;
2076 gy
+= (y
/ height
) * height
;
2080 case ON_LEFT_FRINGE
:
2081 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2082 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2083 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2084 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2087 case ON_RIGHT_FRINGE
:
2088 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2089 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2090 : window_box_right_offset (w
, TEXT_AREA
));
2091 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2095 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2097 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2098 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2099 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2101 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2105 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2106 if (r
->y
+ r
->height
> y
)
2113 height
= gr
->height
;
2116 /* Use nominal line height at end of window. */
2118 gy
+= (y
/ height
) * height
;
2125 /* If there is no glyph under the mouse, then we divide the screen
2126 into a grid of the smallest glyph in the frame, and use that
2129 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2130 round down even for negative values. */
2136 gx
= (gx
/ width
) * width
;
2137 gy
= (gy
/ height
) * height
;
2142 gx
+= WINDOW_LEFT_EDGE_X (w
);
2143 gy
+= WINDOW_TOP_EDGE_Y (w
);
2146 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2148 /* Visible feedback for debugging. */
2151 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2152 f
->output_data
.x
->normal_gc
,
2153 gx
, gy
, width
, height
);
2159 #endif /* HAVE_WINDOW_SYSTEM */
2162 /***********************************************************************
2163 Lisp form evaluation
2164 ***********************************************************************/
2166 /* Error handler for safe_eval and safe_call. */
2169 safe_eval_handler (Lisp_Object arg
)
2171 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2176 /* Evaluate SEXPR and return the result, or nil if something went
2177 wrong. Prevent redisplay during the evaluation. */
2179 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2180 Return the result, or nil if something went wrong. Prevent
2181 redisplay during the evaluation. */
2184 safe_call (int nargs
, Lisp_Object
*args
)
2188 if (inhibit_eval_during_redisplay
)
2192 int count
= SPECPDL_INDEX ();
2193 struct gcpro gcpro1
;
2196 gcpro1
.nvars
= nargs
;
2197 specbind (Qinhibit_redisplay
, Qt
);
2198 /* Use Qt to ensure debugger does not run,
2199 so there is no possibility of wanting to redisplay. */
2200 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2203 val
= unbind_to (count
, val
);
2210 /* Call function FN with one argument ARG.
2211 Return the result, or nil if something went wrong. */
2214 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2216 Lisp_Object args
[2];
2219 return safe_call (2, args
);
2222 static Lisp_Object Qeval
;
2225 safe_eval (Lisp_Object sexpr
)
2227 return safe_call1 (Qeval
, sexpr
);
2230 /* Call function FN with one argument ARG.
2231 Return the result, or nil if something went wrong. */
2234 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2236 Lisp_Object args
[3];
2240 return safe_call (3, args
);
2245 /***********************************************************************
2247 ***********************************************************************/
2251 /* Define CHECK_IT to perform sanity checks on iterators.
2252 This is for debugging. It is too slow to do unconditionally. */
2258 if (it
->method
== GET_FROM_STRING
)
2260 xassert (STRINGP (it
->string
));
2261 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2265 xassert (IT_STRING_CHARPOS (*it
) < 0);
2266 if (it
->method
== GET_FROM_BUFFER
)
2268 /* Check that character and byte positions agree. */
2269 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2274 xassert (it
->current
.dpvec_index
>= 0);
2276 xassert (it
->current
.dpvec_index
< 0);
2279 #define CHECK_IT(IT) check_it ((IT))
2283 #define CHECK_IT(IT) (void) 0
2290 /* Check that the window end of window W is what we expect it
2291 to be---the last row in the current matrix displaying text. */
2294 check_window_end (w
)
2297 if (!MINI_WINDOW_P (w
)
2298 && !NILP (w
->window_end_valid
))
2300 struct glyph_row
*row
;
2301 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2302 XFASTINT (w
->window_end_vpos
)),
2304 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2305 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2309 #define CHECK_WINDOW_END(W) check_window_end ((W))
2311 #else /* not GLYPH_DEBUG */
2313 #define CHECK_WINDOW_END(W) (void) 0
2315 #endif /* not GLYPH_DEBUG */
2319 /***********************************************************************
2320 Iterator initialization
2321 ***********************************************************************/
2323 /* Initialize IT for displaying current_buffer in window W, starting
2324 at character position CHARPOS. CHARPOS < 0 means that no buffer
2325 position is specified which is useful when the iterator is assigned
2326 a position later. BYTEPOS is the byte position corresponding to
2327 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2329 If ROW is not null, calls to produce_glyphs with IT as parameter
2330 will produce glyphs in that row.
2332 BASE_FACE_ID is the id of a base face to use. It must be one of
2333 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2334 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2335 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2337 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2338 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2339 will be initialized to use the corresponding mode line glyph row of
2340 the desired matrix of W. */
2343 init_iterator (struct it
*it
, struct window
*w
,
2344 EMACS_INT charpos
, EMACS_INT bytepos
,
2345 struct glyph_row
*row
, enum face_id base_face_id
)
2347 int highlight_region_p
;
2348 enum face_id remapped_base_face_id
= base_face_id
;
2350 /* Some precondition checks. */
2351 xassert (w
!= NULL
&& it
!= NULL
);
2352 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2355 /* If face attributes have been changed since the last redisplay,
2356 free realized faces now because they depend on face definitions
2357 that might have changed. Don't free faces while there might be
2358 desired matrices pending which reference these faces. */
2359 if (face_change_count
&& !inhibit_free_realized_faces
)
2361 face_change_count
= 0;
2362 free_all_realized_faces (Qnil
);
2365 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2366 if (! NILP (Vface_remapping_alist
))
2367 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2369 /* Use one of the mode line rows of W's desired matrix if
2373 if (base_face_id
== MODE_LINE_FACE_ID
2374 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2375 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2376 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2377 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2381 memset (it
, 0, sizeof *it
);
2382 it
->current
.overlay_string_index
= -1;
2383 it
->current
.dpvec_index
= -1;
2384 it
->base_face_id
= remapped_base_face_id
;
2386 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2388 /* The window in which we iterate over current_buffer: */
2389 XSETWINDOW (it
->window
, w
);
2391 it
->f
= XFRAME (w
->frame
);
2395 /* Extra space between lines (on window systems only). */
2396 if (base_face_id
== DEFAULT_FACE_ID
2397 && FRAME_WINDOW_P (it
->f
))
2399 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2400 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2401 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2402 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2403 * FRAME_LINE_HEIGHT (it
->f
));
2404 else if (it
->f
->extra_line_spacing
> 0)
2405 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2406 it
->max_extra_line_spacing
= 0;
2409 /* If realized faces have been removed, e.g. because of face
2410 attribute changes of named faces, recompute them. When running
2411 in batch mode, the face cache of the initial frame is null. If
2412 we happen to get called, make a dummy face cache. */
2413 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2414 init_frame_faces (it
->f
);
2415 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2416 recompute_basic_faces (it
->f
);
2418 /* Current value of the `slice', `space-width', and 'height' properties. */
2419 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2420 it
->space_width
= Qnil
;
2421 it
->font_height
= Qnil
;
2422 it
->override_ascent
= -1;
2424 /* Are control characters displayed as `^C'? */
2425 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2427 /* -1 means everything between a CR and the following line end
2428 is invisible. >0 means lines indented more than this value are
2430 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2431 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2432 : (!NILP (BVAR (current_buffer
, selective_display
))
2434 it
->selective_display_ellipsis_p
2435 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2437 /* Display table to use. */
2438 it
->dp
= window_display_table (w
);
2440 /* Are multibyte characters enabled in current_buffer? */
2441 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2443 /* Do we need to reorder bidirectional text? Not if this is a
2444 unibyte buffer: by definition, none of the single-byte characters
2445 are strong R2L, so no reordering is needed. And bidi.c doesn't
2446 support unibyte buffers anyway. */
2448 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2450 /* Non-zero if we should highlight the region. */
2452 = (!NILP (Vtransient_mark_mode
)
2453 && !NILP (BVAR (current_buffer
, mark_active
))
2454 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2456 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2457 start and end of a visible region in window IT->w. Set both to
2458 -1 to indicate no region. */
2459 if (highlight_region_p
2460 /* Maybe highlight only in selected window. */
2461 && (/* Either show region everywhere. */
2462 highlight_nonselected_windows
2463 /* Or show region in the selected window. */
2464 || w
== XWINDOW (selected_window
)
2465 /* Or show the region if we are in the mini-buffer and W is
2466 the window the mini-buffer refers to. */
2467 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2468 && WINDOWP (minibuf_selected_window
)
2469 && w
== XWINDOW (minibuf_selected_window
))))
2471 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2472 it
->region_beg_charpos
= min (PT
, markpos
);
2473 it
->region_end_charpos
= max (PT
, markpos
);
2476 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2478 /* Get the position at which the redisplay_end_trigger hook should
2479 be run, if it is to be run at all. */
2480 if (MARKERP (w
->redisplay_end_trigger
)
2481 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2482 it
->redisplay_end_trigger_charpos
2483 = marker_position (w
->redisplay_end_trigger
);
2484 else if (INTEGERP (w
->redisplay_end_trigger
))
2485 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2487 /* Correct bogus values of tab_width. */
2488 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2489 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2492 /* Are lines in the display truncated? */
2493 if (base_face_id
!= DEFAULT_FACE_ID
2494 || XINT (it
->w
->hscroll
)
2495 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2496 && ((!NILP (Vtruncate_partial_width_windows
)
2497 && !INTEGERP (Vtruncate_partial_width_windows
))
2498 || (INTEGERP (Vtruncate_partial_width_windows
)
2499 && (WINDOW_TOTAL_COLS (it
->w
)
2500 < XINT (Vtruncate_partial_width_windows
))))))
2501 it
->line_wrap
= TRUNCATE
;
2502 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2503 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2504 ? WINDOW_WRAP
: WORD_WRAP
;
2506 it
->line_wrap
= TRUNCATE
;
2508 /* Get dimensions of truncation and continuation glyphs. These are
2509 displayed as fringe bitmaps under X, so we don't need them for such
2511 if (!FRAME_WINDOW_P (it
->f
))
2513 if (it
->line_wrap
== TRUNCATE
)
2515 /* We will need the truncation glyph. */
2516 xassert (it
->glyph_row
== NULL
);
2517 produce_special_glyphs (it
, IT_TRUNCATION
);
2518 it
->truncation_pixel_width
= it
->pixel_width
;
2522 /* We will need the continuation glyph. */
2523 xassert (it
->glyph_row
== NULL
);
2524 produce_special_glyphs (it
, IT_CONTINUATION
);
2525 it
->continuation_pixel_width
= it
->pixel_width
;
2528 /* Reset these values to zero because the produce_special_glyphs
2529 above has changed them. */
2530 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2531 it
->phys_ascent
= it
->phys_descent
= 0;
2534 /* Set this after getting the dimensions of truncation and
2535 continuation glyphs, so that we don't produce glyphs when calling
2536 produce_special_glyphs, above. */
2537 it
->glyph_row
= row
;
2538 it
->area
= TEXT_AREA
;
2540 /* Forget any previous info about this row being reversed. */
2542 it
->glyph_row
->reversed_p
= 0;
2544 /* Get the dimensions of the display area. The display area
2545 consists of the visible window area plus a horizontally scrolled
2546 part to the left of the window. All x-values are relative to the
2547 start of this total display area. */
2548 if (base_face_id
!= DEFAULT_FACE_ID
)
2550 /* Mode lines, menu bar in terminal frames. */
2551 it
->first_visible_x
= 0;
2552 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2557 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2558 it
->last_visible_x
= (it
->first_visible_x
2559 + window_box_width (w
, TEXT_AREA
));
2561 /* If we truncate lines, leave room for the truncator glyph(s) at
2562 the right margin. Otherwise, leave room for the continuation
2563 glyph(s). Truncation and continuation glyphs are not inserted
2564 for window-based redisplay. */
2565 if (!FRAME_WINDOW_P (it
->f
))
2567 if (it
->line_wrap
== TRUNCATE
)
2568 it
->last_visible_x
-= it
->truncation_pixel_width
;
2570 it
->last_visible_x
-= it
->continuation_pixel_width
;
2573 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2574 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2577 /* Leave room for a border glyph. */
2578 if (!FRAME_WINDOW_P (it
->f
)
2579 && !WINDOW_RIGHTMOST_P (it
->w
))
2580 it
->last_visible_x
-= 1;
2582 it
->last_visible_y
= window_text_bottom_y (w
);
2584 /* For mode lines and alike, arrange for the first glyph having a
2585 left box line if the face specifies a box. */
2586 if (base_face_id
!= DEFAULT_FACE_ID
)
2590 it
->face_id
= remapped_base_face_id
;
2592 /* If we have a boxed mode line, make the first character appear
2593 with a left box line. */
2594 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2595 if (face
->box
!= FACE_NO_BOX
)
2596 it
->start_of_box_run_p
= 1;
2599 /* If we are to reorder bidirectional text, init the bidi
2603 /* Note the paragraph direction that this buffer wants to
2605 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2606 it
->paragraph_embedding
= L2R
;
2607 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2608 it
->paragraph_embedding
= R2L
;
2610 it
->paragraph_embedding
= NEUTRAL_DIR
;
2611 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2614 /* If a buffer position was specified, set the iterator there,
2615 getting overlays and face properties from that position. */
2616 if (charpos
>= BUF_BEG (current_buffer
))
2618 it
->end_charpos
= ZV
;
2620 IT_CHARPOS (*it
) = charpos
;
2622 /* Compute byte position if not specified. */
2623 if (bytepos
< charpos
)
2624 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2626 IT_BYTEPOS (*it
) = bytepos
;
2628 it
->start
= it
->current
;
2630 /* Compute faces etc. */
2631 reseat (it
, it
->current
.pos
, 1);
2638 /* Initialize IT for the display of window W with window start POS. */
2641 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2643 struct glyph_row
*row
;
2644 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2646 row
= w
->desired_matrix
->rows
+ first_vpos
;
2647 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2648 it
->first_vpos
= first_vpos
;
2650 /* Don't reseat to previous visible line start if current start
2651 position is in a string or image. */
2652 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2654 int start_at_line_beg_p
;
2655 int first_y
= it
->current_y
;
2657 /* If window start is not at a line start, skip forward to POS to
2658 get the correct continuation lines width. */
2659 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2660 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2661 if (!start_at_line_beg_p
)
2665 reseat_at_previous_visible_line_start (it
);
2666 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2668 new_x
= it
->current_x
+ it
->pixel_width
;
2670 /* If lines are continued, this line may end in the middle
2671 of a multi-glyph character (e.g. a control character
2672 displayed as \003, or in the middle of an overlay
2673 string). In this case move_it_to above will not have
2674 taken us to the start of the continuation line but to the
2675 end of the continued line. */
2676 if (it
->current_x
> 0
2677 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2678 && (/* And glyph doesn't fit on the line. */
2679 new_x
> it
->last_visible_x
2680 /* Or it fits exactly and we're on a window
2682 || (new_x
== it
->last_visible_x
2683 && FRAME_WINDOW_P (it
->f
))))
2685 if (it
->current
.dpvec_index
>= 0
2686 || it
->current
.overlay_string_index
>= 0)
2688 set_iterator_to_next (it
, 1);
2689 move_it_in_display_line_to (it
, -1, -1, 0);
2692 it
->continuation_lines_width
+= it
->current_x
;
2695 /* We're starting a new display line, not affected by the
2696 height of the continued line, so clear the appropriate
2697 fields in the iterator structure. */
2698 it
->max_ascent
= it
->max_descent
= 0;
2699 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2701 it
->current_y
= first_y
;
2703 it
->current_x
= it
->hpos
= 0;
2709 /* Return 1 if POS is a position in ellipses displayed for invisible
2710 text. W is the window we display, for text property lookup. */
2713 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2715 Lisp_Object prop
, window
;
2717 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2719 /* If POS specifies a position in a display vector, this might
2720 be for an ellipsis displayed for invisible text. We won't
2721 get the iterator set up for delivering that ellipsis unless
2722 we make sure that it gets aware of the invisible text. */
2723 if (pos
->dpvec_index
>= 0
2724 && pos
->overlay_string_index
< 0
2725 && CHARPOS (pos
->string_pos
) < 0
2727 && (XSETWINDOW (window
, w
),
2728 prop
= Fget_char_property (make_number (charpos
),
2729 Qinvisible
, window
),
2730 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2732 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2734 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2741 /* Initialize IT for stepping through current_buffer in window W,
2742 starting at position POS that includes overlay string and display
2743 vector/ control character translation position information. Value
2744 is zero if there are overlay strings with newlines at POS. */
2747 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2749 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2750 int i
, overlay_strings_with_newlines
= 0;
2752 /* If POS specifies a position in a display vector, this might
2753 be for an ellipsis displayed for invisible text. We won't
2754 get the iterator set up for delivering that ellipsis unless
2755 we make sure that it gets aware of the invisible text. */
2756 if (in_ellipses_for_invisible_text_p (pos
, w
))
2762 /* Keep in mind: the call to reseat in init_iterator skips invisible
2763 text, so we might end up at a position different from POS. This
2764 is only a problem when POS is a row start after a newline and an
2765 overlay starts there with an after-string, and the overlay has an
2766 invisible property. Since we don't skip invisible text in
2767 display_line and elsewhere immediately after consuming the
2768 newline before the row start, such a POS will not be in a string,
2769 but the call to init_iterator below will move us to the
2771 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2773 /* This only scans the current chunk -- it should scan all chunks.
2774 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2775 to 16 in 22.1 to make this a lesser problem. */
2776 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2778 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2779 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2781 while (s
< e
&& *s
!= '\n')
2786 overlay_strings_with_newlines
= 1;
2791 /* If position is within an overlay string, set up IT to the right
2793 if (pos
->overlay_string_index
>= 0)
2797 /* If the first overlay string happens to have a `display'
2798 property for an image, the iterator will be set up for that
2799 image, and we have to undo that setup first before we can
2800 correct the overlay string index. */
2801 if (it
->method
== GET_FROM_IMAGE
)
2804 /* We already have the first chunk of overlay strings in
2805 IT->overlay_strings. Load more until the one for
2806 pos->overlay_string_index is in IT->overlay_strings. */
2807 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2809 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2810 it
->current
.overlay_string_index
= 0;
2813 load_overlay_strings (it
, 0);
2814 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2818 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2819 relative_index
= (it
->current
.overlay_string_index
2820 % OVERLAY_STRING_CHUNK_SIZE
);
2821 it
->string
= it
->overlay_strings
[relative_index
];
2822 xassert (STRINGP (it
->string
));
2823 it
->current
.string_pos
= pos
->string_pos
;
2824 it
->method
= GET_FROM_STRING
;
2827 if (CHARPOS (pos
->string_pos
) >= 0)
2829 /* Recorded position is not in an overlay string, but in another
2830 string. This can only be a string from a `display' property.
2831 IT should already be filled with that string. */
2832 it
->current
.string_pos
= pos
->string_pos
;
2833 xassert (STRINGP (it
->string
));
2836 /* Restore position in display vector translations, control
2837 character translations or ellipses. */
2838 if (pos
->dpvec_index
>= 0)
2840 if (it
->dpvec
== NULL
)
2841 get_next_display_element (it
);
2842 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2843 it
->current
.dpvec_index
= pos
->dpvec_index
;
2847 return !overlay_strings_with_newlines
;
2851 /* Initialize IT for stepping through current_buffer in window W
2852 starting at ROW->start. */
2855 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2857 init_from_display_pos (it
, w
, &row
->start
);
2858 it
->start
= row
->start
;
2859 it
->continuation_lines_width
= row
->continuation_lines_width
;
2864 /* Initialize IT for stepping through current_buffer in window W
2865 starting in the line following ROW, i.e. starting at ROW->end.
2866 Value is zero if there are overlay strings with newlines at ROW's
2870 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2874 if (init_from_display_pos (it
, w
, &row
->end
))
2876 if (row
->continued_p
)
2877 it
->continuation_lines_width
2878 = row
->continuation_lines_width
+ row
->pixel_width
;
2889 /***********************************************************************
2891 ***********************************************************************/
2893 /* Called when IT reaches IT->stop_charpos. Handle text property and
2894 overlay changes. Set IT->stop_charpos to the next position where
2898 handle_stop (struct it
*it
)
2900 enum prop_handled handled
;
2901 int handle_overlay_change_p
;
2905 it
->current
.dpvec_index
= -1;
2906 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2907 it
->ignore_overlay_strings_at_pos_p
= 0;
2910 /* Use face of preceding text for ellipsis (if invisible) */
2911 if (it
->selective_display_ellipsis_p
)
2912 it
->saved_face_id
= it
->face_id
;
2916 handled
= HANDLED_NORMALLY
;
2918 /* Call text property handlers. */
2919 for (p
= it_props
; p
->handler
; ++p
)
2921 handled
= p
->handler (it
);
2923 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2925 else if (handled
== HANDLED_RETURN
)
2927 /* We still want to show before and after strings from
2928 overlays even if the actual buffer text is replaced. */
2929 if (!handle_overlay_change_p
2931 || !get_overlay_strings_1 (it
, 0, 0))
2934 setup_for_ellipsis (it
, 0);
2935 /* When handling a display spec, we might load an
2936 empty string. In that case, discard it here. We
2937 used to discard it in handle_single_display_spec,
2938 but that causes get_overlay_strings_1, above, to
2939 ignore overlay strings that we must check. */
2940 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2944 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2948 it
->ignore_overlay_strings_at_pos_p
= 1;
2949 it
->string_from_display_prop_p
= 0;
2950 handle_overlay_change_p
= 0;
2952 handled
= HANDLED_RECOMPUTE_PROPS
;
2955 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2956 handle_overlay_change_p
= 0;
2959 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2961 /* Don't check for overlay strings below when set to deliver
2962 characters from a display vector. */
2963 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2964 handle_overlay_change_p
= 0;
2966 /* Handle overlay changes.
2967 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2968 if it finds overlays. */
2969 if (handle_overlay_change_p
)
2970 handled
= handle_overlay_change (it
);
2975 setup_for_ellipsis (it
, 0);
2979 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2981 /* Determine where to stop next. */
2982 if (handled
== HANDLED_NORMALLY
)
2983 compute_stop_pos (it
);
2987 /* Compute IT->stop_charpos from text property and overlay change
2988 information for IT's current position. */
2991 compute_stop_pos (struct it
*it
)
2993 register INTERVAL iv
, next_iv
;
2994 Lisp_Object object
, limit
, position
;
2995 EMACS_INT charpos
, bytepos
;
2997 /* If nowhere else, stop at the end. */
2998 it
->stop_charpos
= it
->end_charpos
;
3000 if (STRINGP (it
->string
))
3002 /* Strings are usually short, so don't limit the search for
3004 object
= it
->string
;
3006 charpos
= IT_STRING_CHARPOS (*it
);
3007 bytepos
= IT_STRING_BYTEPOS (*it
);
3013 /* If next overlay change is in front of the current stop pos
3014 (which is IT->end_charpos), stop there. Note: value of
3015 next_overlay_change is point-max if no overlay change
3017 charpos
= IT_CHARPOS (*it
);
3018 bytepos
= IT_BYTEPOS (*it
);
3019 pos
= next_overlay_change (charpos
);
3020 if (pos
< it
->stop_charpos
)
3021 it
->stop_charpos
= pos
;
3023 /* If showing the region, we have to stop at the region
3024 start or end because the face might change there. */
3025 if (it
->region_beg_charpos
> 0)
3027 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3028 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3029 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3030 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3033 /* Set up variables for computing the stop position from text
3034 property changes. */
3035 XSETBUFFER (object
, current_buffer
);
3036 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3039 /* Get the interval containing IT's position. Value is a null
3040 interval if there isn't such an interval. */
3041 position
= make_number (charpos
);
3042 iv
= validate_interval_range (object
, &position
, &position
, 0);
3043 if (!NULL_INTERVAL_P (iv
))
3045 Lisp_Object values_here
[LAST_PROP_IDX
];
3048 /* Get properties here. */
3049 for (p
= it_props
; p
->handler
; ++p
)
3050 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3052 /* Look for an interval following iv that has different
3054 for (next_iv
= next_interval (iv
);
3055 (!NULL_INTERVAL_P (next_iv
)
3057 || XFASTINT (limit
) > next_iv
->position
));
3058 next_iv
= next_interval (next_iv
))
3060 for (p
= it_props
; p
->handler
; ++p
)
3062 Lisp_Object new_value
;
3064 new_value
= textget (next_iv
->plist
, *p
->name
);
3065 if (!EQ (values_here
[p
->idx
], new_value
))
3073 if (!NULL_INTERVAL_P (next_iv
))
3075 if (INTEGERP (limit
)
3076 && next_iv
->position
>= XFASTINT (limit
))
3077 /* No text property change up to limit. */
3078 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3080 /* Text properties change in next_iv. */
3081 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3085 if (it
->cmp_it
.id
< 0)
3087 EMACS_INT stoppos
= it
->end_charpos
;
3089 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3091 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3092 stoppos
, it
->string
);
3095 xassert (STRINGP (it
->string
)
3096 || (it
->stop_charpos
>= BEGV
3097 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3101 /* Return the position of the next overlay change after POS in
3102 current_buffer. Value is point-max if no overlay change
3103 follows. This is like `next-overlay-change' but doesn't use
3107 next_overlay_change (EMACS_INT pos
)
3111 Lisp_Object
*overlays
;
3114 /* Get all overlays at the given position. */
3115 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3117 /* If any of these overlays ends before endpos,
3118 use its ending point instead. */
3119 for (i
= 0; i
< noverlays
; ++i
)
3124 oend
= OVERLAY_END (overlays
[i
]);
3125 oendpos
= OVERLAY_POSITION (oend
);
3126 endpos
= min (endpos
, oendpos
);
3134 /***********************************************************************
3136 ***********************************************************************/
3138 /* Handle changes in the `fontified' property of the current buffer by
3139 calling hook functions from Qfontification_functions to fontify
3142 static enum prop_handled
3143 handle_fontified_prop (struct it
*it
)
3145 Lisp_Object prop
, pos
;
3146 enum prop_handled handled
= HANDLED_NORMALLY
;
3148 if (!NILP (Vmemory_full
))
3151 /* Get the value of the `fontified' property at IT's current buffer
3152 position. (The `fontified' property doesn't have a special
3153 meaning in strings.) If the value is nil, call functions from
3154 Qfontification_functions. */
3155 if (!STRINGP (it
->string
)
3157 && !NILP (Vfontification_functions
)
3158 && !NILP (Vrun_hooks
)
3159 && (pos
= make_number (IT_CHARPOS (*it
)),
3160 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3161 /* Ignore the special cased nil value always present at EOB since
3162 no amount of fontifying will be able to change it. */
3163 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3165 int count
= SPECPDL_INDEX ();
3167 struct buffer
*obuf
= current_buffer
;
3168 int begv
= BEGV
, zv
= ZV
;
3169 int old_clip_changed
= current_buffer
->clip_changed
;
3171 val
= Vfontification_functions
;
3172 specbind (Qfontification_functions
, Qnil
);
3174 xassert (it
->end_charpos
== ZV
);
3176 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3177 safe_call1 (val
, pos
);
3180 Lisp_Object fns
, fn
;
3181 struct gcpro gcpro1
, gcpro2
;
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 (fns
= Fdefault_value (Qfontification_functions
);
3203 safe_call1 (fn
, pos
);
3207 safe_call1 (fn
, pos
);
3213 unbind_to (count
, Qnil
);
3215 /* Fontification functions routinely call `save-restriction'.
3216 Normally, this tags clip_changed, which can confuse redisplay
3217 (see discussion in Bug#6671). Since we don't perform any
3218 special handling of fontification changes in the case where
3219 `save-restriction' isn't called, there's no point doing so in
3220 this case either. So, if the buffer's restrictions are
3221 actually left unchanged, reset clip_changed. */
3222 if (obuf
== current_buffer
)
3224 if (begv
== BEGV
&& zv
== ZV
)
3225 current_buffer
->clip_changed
= old_clip_changed
;
3227 /* There isn't much we can reasonably do to protect against
3228 misbehaving fontification, but here's a fig leaf. */
3229 else if (!NILP (BVAR (obuf
, name
)))
3230 set_buffer_internal_1 (obuf
);
3232 /* The fontification code may have added/removed text.
3233 It could do even a lot worse, but let's at least protect against
3234 the most obvious case where only the text past `pos' gets changed',
3235 as is/was done in grep.el where some escapes sequences are turned
3236 into face properties (bug#7876). */
3237 it
->end_charpos
= ZV
;
3239 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3240 something. This avoids an endless loop if they failed to
3241 fontify the text for which reason ever. */
3242 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3243 handled
= HANDLED_RECOMPUTE_PROPS
;
3251 /***********************************************************************
3253 ***********************************************************************/
3255 /* Set up iterator IT from face properties at its current position.
3256 Called from handle_stop. */
3258 static enum prop_handled
3259 handle_face_prop (struct it
*it
)
3262 EMACS_INT next_stop
;
3264 if (!STRINGP (it
->string
))
3267 = face_at_buffer_position (it
->w
,
3269 it
->region_beg_charpos
,
3270 it
->region_end_charpos
,
3273 + TEXT_PROP_DISTANCE_LIMIT
),
3274 0, it
->base_face_id
);
3276 /* Is this a start of a run of characters with box face?
3277 Caveat: this can be called for a freshly initialized
3278 iterator; face_id is -1 in this case. We know that the new
3279 face will not change until limit, i.e. if the new face has a
3280 box, all characters up to limit will have one. But, as
3281 usual, we don't know whether limit is really the end. */
3282 if (new_face_id
!= it
->face_id
)
3284 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3286 /* If new face has a box but old face has not, this is
3287 the start of a run of characters with box, i.e. it has
3288 a shadow on the left side. The value of face_id of the
3289 iterator will be -1 if this is the initial call that gets
3290 the face. In this case, we have to look in front of IT's
3291 position and see whether there is a face != new_face_id. */
3292 it
->start_of_box_run_p
3293 = (new_face
->box
!= FACE_NO_BOX
3294 && (it
->face_id
>= 0
3295 || IT_CHARPOS (*it
) == BEG
3296 || new_face_id
!= face_before_it_pos (it
)));
3297 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3305 Lisp_Object from_overlay
3306 = (it
->current
.overlay_string_index
>= 0
3307 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3310 /* See if we got to this string directly or indirectly from
3311 an overlay property. That includes the before-string or
3312 after-string of an overlay, strings in display properties
3313 provided by an overlay, their text properties, etc.
3315 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3316 if (! NILP (from_overlay
))
3317 for (i
= it
->sp
- 1; i
>= 0; i
--)
3319 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3321 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3322 else if (! NILP (it
->stack
[i
].from_overlay
))
3323 from_overlay
= it
->stack
[i
].from_overlay
;
3325 if (!NILP (from_overlay
))
3329 if (! NILP (from_overlay
))
3331 bufpos
= IT_CHARPOS (*it
);
3332 /* For a string from an overlay, the base face depends
3333 only on text properties and ignores overlays. */
3335 = face_for_overlay_string (it
->w
,
3337 it
->region_beg_charpos
,
3338 it
->region_end_charpos
,
3341 + TEXT_PROP_DISTANCE_LIMIT
),
3349 /* For strings from a `display' property, use the face at
3350 IT's current buffer position as the base face to merge
3351 with, so that overlay strings appear in the same face as
3352 surrounding text, unless they specify their own
3354 base_face_id
= underlying_face_id (it
);
3357 new_face_id
= face_at_string_position (it
->w
,
3359 IT_STRING_CHARPOS (*it
),
3361 it
->region_beg_charpos
,
3362 it
->region_end_charpos
,
3366 /* Is this a start of a run of characters with box? Caveat:
3367 this can be called for a freshly allocated iterator; face_id
3368 is -1 is this case. We know that the new face will not
3369 change until the next check pos, i.e. if the new face has a
3370 box, all characters up to that position will have a
3371 box. But, as usual, we don't know whether that position
3372 is really the end. */
3373 if (new_face_id
!= it
->face_id
)
3375 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3376 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3378 /* If new face has a box but old face hasn't, this is the
3379 start of a run of characters with box, i.e. it has a
3380 shadow on the left side. */
3381 it
->start_of_box_run_p
3382 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3383 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3387 it
->face_id
= new_face_id
;
3388 return HANDLED_NORMALLY
;
3392 /* Return the ID of the face ``underlying'' IT's current position,
3393 which is in a string. If the iterator is associated with a
3394 buffer, return the face at IT's current buffer position.
3395 Otherwise, use the iterator's base_face_id. */
3398 underlying_face_id (struct it
*it
)
3400 int face_id
= it
->base_face_id
, i
;
3402 xassert (STRINGP (it
->string
));
3404 for (i
= it
->sp
- 1; i
>= 0; --i
)
3405 if (NILP (it
->stack
[i
].string
))
3406 face_id
= it
->stack
[i
].face_id
;
3412 /* Compute the face one character before or after the current position
3413 of IT. BEFORE_P non-zero means get the face in front of IT's
3414 position. Value is the id of the face. */
3417 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3420 EMACS_INT next_check_charpos
;
3421 struct text_pos pos
;
3423 xassert (it
->s
== NULL
);
3425 if (STRINGP (it
->string
))
3430 /* No face change past the end of the string (for the case
3431 we are padding with spaces). No face change before the
3433 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3434 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3437 /* Set pos to the position before or after IT's current position. */
3439 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3441 /* For composition, we must check the character after the
3443 pos
= (it
->what
== IT_COMPOSITION
3444 ? string_pos (IT_STRING_CHARPOS (*it
)
3445 + it
->cmp_it
.nchars
, it
->string
)
3446 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3448 if (it
->current
.overlay_string_index
>= 0)
3449 bufpos
= IT_CHARPOS (*it
);
3453 base_face_id
= underlying_face_id (it
);
3455 /* Get the face for ASCII, or unibyte. */
3456 face_id
= face_at_string_position (it
->w
,
3460 it
->region_beg_charpos
,
3461 it
->region_end_charpos
,
3462 &next_check_charpos
,
3465 /* Correct the face for charsets different from ASCII. Do it
3466 for the multibyte case only. The face returned above is
3467 suitable for unibyte text if IT->string is unibyte. */
3468 if (STRING_MULTIBYTE (it
->string
))
3470 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3472 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3474 c
= string_char_and_length (p
, &len
);
3475 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3480 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3481 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3484 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3485 pos
= it
->current
.pos
;
3488 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3491 if (it
->what
== IT_COMPOSITION
)
3492 /* For composition, we must check the position after the
3494 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3496 INC_TEXT_POS (pos
, it
->multibyte_p
);
3499 /* Determine face for CHARSET_ASCII, or unibyte. */
3500 face_id
= face_at_buffer_position (it
->w
,
3502 it
->region_beg_charpos
,
3503 it
->region_end_charpos
,
3504 &next_check_charpos
,
3507 /* Correct the face for charsets different from ASCII. Do it
3508 for the multibyte case only. The face returned above is
3509 suitable for unibyte text if current_buffer is unibyte. */
3510 if (it
->multibyte_p
)
3512 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3513 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3514 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3523 /***********************************************************************
3525 ***********************************************************************/
3527 /* Set up iterator IT from invisible properties at its current
3528 position. Called from handle_stop. */
3530 static enum prop_handled
3531 handle_invisible_prop (struct it
*it
)
3533 enum prop_handled handled
= HANDLED_NORMALLY
;
3535 if (STRINGP (it
->string
))
3537 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3539 /* Get the value of the invisible text property at the
3540 current position. Value will be nil if there is no such
3542 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3543 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3546 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3548 handled
= HANDLED_RECOMPUTE_PROPS
;
3550 /* Get the position at which the next change of the
3551 invisible text property can be found in IT->string.
3552 Value will be nil if the property value is the same for
3553 all the rest of IT->string. */
3554 XSETINT (limit
, SCHARS (it
->string
));
3555 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3558 /* Text at current position is invisible. The next
3559 change in the property is at position end_charpos.
3560 Move IT's current position to that position. */
3561 if (INTEGERP (end_charpos
)
3562 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3564 struct text_pos old
;
3565 old
= it
->current
.string_pos
;
3566 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3567 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3571 /* The rest of the string is invisible. If this is an
3572 overlay string, proceed with the next overlay string
3573 or whatever comes and return a character from there. */
3574 if (it
->current
.overlay_string_index
>= 0)
3576 next_overlay_string (it
);
3577 /* Don't check for overlay strings when we just
3578 finished processing them. */
3579 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3583 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3584 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3592 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3593 Lisp_Object pos
, prop
, overlay
;
3595 /* First of all, is there invisible text at this position? */
3596 tem
= start_charpos
= IT_CHARPOS (*it
);
3597 pos
= make_number (tem
);
3598 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3600 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3602 /* If we are on invisible text, skip over it. */
3603 if (invis_p
&& start_charpos
< it
->end_charpos
)
3605 /* Record whether we have to display an ellipsis for the
3607 int display_ellipsis_p
= invis_p
== 2;
3609 handled
= HANDLED_RECOMPUTE_PROPS
;
3611 /* Loop skipping over invisible text. The loop is left at
3612 ZV or with IT on the first char being visible again. */
3615 /* Try to skip some invisible text. Return value is the
3616 position reached which can be equal to where we start
3617 if there is nothing invisible there. This skips both
3618 over invisible text properties and overlays with
3619 invisible property. */
3620 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3622 /* If we skipped nothing at all we weren't at invisible
3623 text in the first place. If everything to the end of
3624 the buffer was skipped, end the loop. */
3625 if (newpos
== tem
|| newpos
>= ZV
)
3629 /* We skipped some characters but not necessarily
3630 all there are. Check if we ended up on visible
3631 text. Fget_char_property returns the property of
3632 the char before the given position, i.e. if we
3633 get invis_p = 0, this means that the char at
3634 newpos is visible. */
3635 pos
= make_number (newpos
);
3636 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3637 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3640 /* If we ended up on invisible text, proceed to
3641 skip starting with next_stop. */
3645 /* If there are adjacent invisible texts, don't lose the
3646 second one's ellipsis. */
3648 display_ellipsis_p
= 1;
3652 /* The position newpos is now either ZV or on visible text. */
3653 if (it
->bidi_p
&& newpos
< ZV
)
3655 /* With bidi iteration, the region of invisible text
3656 could start and/or end in the middle of a non-base
3657 embedding level. Therefore, we need to skip
3658 invisible text using the bidi iterator, starting at
3659 IT's current position, until we find ourselves
3660 outside the invisible text. Skipping invisible text
3661 _after_ bidi iteration avoids affecting the visual
3662 order of the displayed text when invisible properties
3663 are added or removed. */
3664 if (it
->bidi_it
.first_elt
)
3666 /* If we were `reseat'ed to a new paragraph,
3667 determine the paragraph base direction. We need
3668 to do it now because next_element_from_buffer may
3669 not have a chance to do it, if we are going to
3670 skip any text at the beginning, which resets the
3672 bidi_paragraph_init (it
->paragraph_embedding
,
3677 bidi_move_to_visually_next (&it
->bidi_it
);
3679 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3680 && it
->bidi_it
.charpos
< newpos
);
3681 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3682 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3683 /* If we overstepped NEWPOS, record its position in the
3684 iterator, so that we skip invisible text if later the
3685 bidi iteration lands us in the invisible region
3687 if (IT_CHARPOS (*it
) >= newpos
)
3688 it
->prev_stop
= newpos
;
3692 IT_CHARPOS (*it
) = newpos
;
3693 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3696 /* If there are before-strings at the start of invisible
3697 text, and the text is invisible because of a text
3698 property, arrange to show before-strings because 20.x did
3699 it that way. (If the text is invisible because of an
3700 overlay property instead of a text property, this is
3701 already handled in the overlay code.) */
3703 && get_overlay_strings (it
, it
->stop_charpos
))
3705 handled
= HANDLED_RECOMPUTE_PROPS
;
3706 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3708 else if (display_ellipsis_p
)
3710 /* Make sure that the glyphs of the ellipsis will get
3711 correct `charpos' values. If we would not update
3712 it->position here, the glyphs would belong to the
3713 last visible character _before_ the invisible
3714 text, which confuses `set_cursor_from_row'.
3716 We use the last invisible position instead of the
3717 first because this way the cursor is always drawn on
3718 the first "." of the ellipsis, whenever PT is inside
3719 the invisible text. Otherwise the cursor would be
3720 placed _after_ the ellipsis when the point is after the
3721 first invisible character. */
3722 if (!STRINGP (it
->object
))
3724 it
->position
.charpos
= newpos
- 1;
3725 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3728 /* Let the ellipsis display before
3729 considering any properties of the following char.
3730 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3731 handled
= HANDLED_RETURN
;
3740 /* Make iterator IT return `...' next.
3741 Replaces LEN characters from buffer. */
3744 setup_for_ellipsis (struct it
*it
, int len
)
3746 /* Use the display table definition for `...'. Invalid glyphs
3747 will be handled by the method returning elements from dpvec. */
3748 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3750 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3751 it
->dpvec
= v
->contents
;
3752 it
->dpend
= v
->contents
+ v
->size
;
3756 /* Default `...'. */
3757 it
->dpvec
= default_invis_vector
;
3758 it
->dpend
= default_invis_vector
+ 3;
3761 it
->dpvec_char_len
= len
;
3762 it
->current
.dpvec_index
= 0;
3763 it
->dpvec_face_id
= -1;
3765 /* Remember the current face id in case glyphs specify faces.
3766 IT's face is restored in set_iterator_to_next.
3767 saved_face_id was set to preceding char's face in handle_stop. */
3768 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3769 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3771 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3777 /***********************************************************************
3779 ***********************************************************************/
3781 /* Set up iterator IT from `display' property at its current position.
3782 Called from handle_stop.
3783 We return HANDLED_RETURN if some part of the display property
3784 overrides the display of the buffer text itself.
3785 Otherwise we return HANDLED_NORMALLY. */
3787 static enum prop_handled
3788 handle_display_prop (struct it
*it
)
3790 Lisp_Object prop
, object
, overlay
;
3791 struct text_pos
*position
;
3792 /* Nonzero if some property replaces the display of the text itself. */
3793 int display_replaced_p
= 0;
3795 if (STRINGP (it
->string
))
3797 object
= it
->string
;
3798 position
= &it
->current
.string_pos
;
3802 XSETWINDOW (object
, it
->w
);
3803 position
= &it
->current
.pos
;
3806 /* Reset those iterator values set from display property values. */
3807 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3808 it
->space_width
= Qnil
;
3809 it
->font_height
= Qnil
;
3812 /* We don't support recursive `display' properties, i.e. string
3813 values that have a string `display' property, that have a string
3814 `display' property etc. */
3815 if (!it
->string_from_display_prop_p
)
3816 it
->area
= TEXT_AREA
;
3818 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3819 Qdisplay
, object
, &overlay
);
3821 return HANDLED_NORMALLY
;
3822 /* Now OVERLAY is the overlay that gave us this property, or nil
3823 if it was a text property. */
3825 if (!STRINGP (it
->string
))
3826 object
= it
->w
->buffer
;
3829 /* Simple properties. */
3830 && !EQ (XCAR (prop
), Qimage
)
3831 && !EQ (XCAR (prop
), Qspace
)
3832 && !EQ (XCAR (prop
), Qwhen
)
3833 && !EQ (XCAR (prop
), Qslice
)
3834 && !EQ (XCAR (prop
), Qspace_width
)
3835 && !EQ (XCAR (prop
), Qheight
)
3836 && !EQ (XCAR (prop
), Qraise
)
3837 /* Marginal area specifications. */
3838 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3839 && !EQ (XCAR (prop
), Qleft_fringe
)
3840 && !EQ (XCAR (prop
), Qright_fringe
)
3841 && !NILP (XCAR (prop
)))
3843 for (; CONSP (prop
); prop
= XCDR (prop
))
3845 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3846 position
, display_replaced_p
))
3848 display_replaced_p
= 1;
3849 /* If some text in a string is replaced, `position' no
3850 longer points to the position of `object'. */
3851 if (STRINGP (object
))
3856 else if (VECTORP (prop
))
3859 for (i
= 0; i
< ASIZE (prop
); ++i
)
3860 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3861 position
, display_replaced_p
))
3863 display_replaced_p
= 1;
3864 /* If some text in a string is replaced, `position' no
3865 longer points to the position of `object'. */
3866 if (STRINGP (object
))
3872 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3874 display_replaced_p
= 1;
3877 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3881 /* Value is the position of the end of the `display' property starting
3882 at START_POS in OBJECT. */
3884 static struct text_pos
3885 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3888 struct text_pos end_pos
;
3890 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3891 Qdisplay
, object
, Qnil
);
3892 CHARPOS (end_pos
) = XFASTINT (end
);
3893 if (STRINGP (object
))
3894 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3896 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3902 /* Set up IT from a single `display' specification PROP. OBJECT
3903 is the object in which the `display' property was found. *POSITION
3904 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3905 means that we previously saw a display specification which already
3906 replaced text display with something else, for example an image;
3907 we ignore such properties after the first one has been processed.
3909 OVERLAY is the overlay this `display' property came from,
3910 or nil if it was a text property.
3912 If PROP is a `space' or `image' specification, and in some other
3913 cases too, set *POSITION to the position where the `display'
3916 Value is non-zero if something was found which replaces the display
3917 of buffer or string text. */
3920 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3921 Lisp_Object overlay
, struct text_pos
*position
,
3922 int display_replaced_before_p
)
3925 Lisp_Object location
, value
;
3926 struct text_pos start_pos
, save_pos
;
3929 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3930 If the result is non-nil, use VALUE instead of SPEC. */
3932 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3941 if (!NILP (form
) && !EQ (form
, Qt
))
3943 int count
= SPECPDL_INDEX ();
3944 struct gcpro gcpro1
;
3946 /* Bind `object' to the object having the `display' property, a
3947 buffer or string. Bind `position' to the position in the
3948 object where the property was found, and `buffer-position'
3949 to the current position in the buffer. */
3950 specbind (Qobject
, object
);
3951 specbind (Qposition
, make_number (CHARPOS (*position
)));
3952 specbind (Qbuffer_position
,
3953 make_number (STRINGP (object
)
3954 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3956 form
= safe_eval (form
);
3958 unbind_to (count
, Qnil
);
3964 /* Handle `(height HEIGHT)' specifications. */
3966 && EQ (XCAR (spec
), Qheight
)
3967 && CONSP (XCDR (spec
)))
3969 if (!FRAME_WINDOW_P (it
->f
))
3972 it
->font_height
= XCAR (XCDR (spec
));
3973 if (!NILP (it
->font_height
))
3975 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3976 int new_height
= -1;
3978 if (CONSP (it
->font_height
)
3979 && (EQ (XCAR (it
->font_height
), Qplus
)
3980 || EQ (XCAR (it
->font_height
), Qminus
))
3981 && CONSP (XCDR (it
->font_height
))
3982 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3984 /* `(+ N)' or `(- N)' where N is an integer. */
3985 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3986 if (EQ (XCAR (it
->font_height
), Qplus
))
3988 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3990 else if (FUNCTIONP (it
->font_height
))
3992 /* Call function with current height as argument.
3993 Value is the new height. */
3995 height
= safe_call1 (it
->font_height
,
3996 face
->lface
[LFACE_HEIGHT_INDEX
]);
3997 if (NUMBERP (height
))
3998 new_height
= XFLOATINT (height
);
4000 else if (NUMBERP (it
->font_height
))
4002 /* Value is a multiple of the canonical char height. */
4005 f
= FACE_FROM_ID (it
->f
,
4006 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4007 new_height
= (XFLOATINT (it
->font_height
)
4008 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4012 /* Evaluate IT->font_height with `height' bound to the
4013 current specified height to get the new height. */
4014 int count
= SPECPDL_INDEX ();
4016 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4017 value
= safe_eval (it
->font_height
);
4018 unbind_to (count
, Qnil
);
4020 if (NUMBERP (value
))
4021 new_height
= XFLOATINT (value
);
4025 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4031 /* Handle `(space-width WIDTH)'. */
4033 && EQ (XCAR (spec
), Qspace_width
)
4034 && CONSP (XCDR (spec
)))
4036 if (!FRAME_WINDOW_P (it
->f
))
4039 value
= XCAR (XCDR (spec
));
4040 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4041 it
->space_width
= value
;
4046 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4048 && EQ (XCAR (spec
), Qslice
))
4052 if (!FRAME_WINDOW_P (it
->f
))
4055 if (tem
= XCDR (spec
), CONSP (tem
))
4057 it
->slice
.x
= XCAR (tem
);
4058 if (tem
= XCDR (tem
), CONSP (tem
))
4060 it
->slice
.y
= XCAR (tem
);
4061 if (tem
= XCDR (tem
), CONSP (tem
))
4063 it
->slice
.width
= XCAR (tem
);
4064 if (tem
= XCDR (tem
), CONSP (tem
))
4065 it
->slice
.height
= XCAR (tem
);
4073 /* Handle `(raise FACTOR)'. */
4075 && EQ (XCAR (spec
), Qraise
)
4076 && CONSP (XCDR (spec
)))
4078 if (!FRAME_WINDOW_P (it
->f
))
4081 #ifdef HAVE_WINDOW_SYSTEM
4082 value
= XCAR (XCDR (spec
));
4083 if (NUMBERP (value
))
4085 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4086 it
->voffset
= - (XFLOATINT (value
)
4087 * (FONT_HEIGHT (face
->font
)));
4089 #endif /* HAVE_WINDOW_SYSTEM */
4094 /* Don't handle the other kinds of display specifications
4095 inside a string that we got from a `display' property. */
4096 if (it
->string_from_display_prop_p
)
4099 /* Characters having this form of property are not displayed, so
4100 we have to find the end of the property. */
4101 start_pos
= *position
;
4102 *position
= display_prop_end (it
, object
, start_pos
);
4105 /* Stop the scan at that end position--we assume that all
4106 text properties change there. */
4107 it
->stop_charpos
= position
->charpos
;
4109 /* Handle `(left-fringe BITMAP [FACE])'
4110 and `(right-fringe BITMAP [FACE])'. */
4112 && (EQ (XCAR (spec
), Qleft_fringe
)
4113 || EQ (XCAR (spec
), Qright_fringe
))
4114 && CONSP (XCDR (spec
)))
4116 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4119 if (!FRAME_WINDOW_P (it
->f
))
4120 /* If we return here, POSITION has been advanced
4121 across the text with this property. */
4124 #ifdef HAVE_WINDOW_SYSTEM
4125 value
= XCAR (XCDR (spec
));
4126 if (!SYMBOLP (value
)
4127 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4128 /* If we return here, POSITION has been advanced
4129 across the text with this property. */
4132 if (CONSP (XCDR (XCDR (spec
))))
4134 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4135 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4141 /* Save current settings of IT so that we can restore them
4142 when we are finished with the glyph property value. */
4144 save_pos
= it
->position
;
4145 it
->position
= *position
;
4147 it
->position
= save_pos
;
4149 it
->area
= TEXT_AREA
;
4150 it
->what
= IT_IMAGE
;
4151 it
->image_id
= -1; /* no image */
4152 it
->position
= start_pos
;
4153 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4154 it
->method
= GET_FROM_IMAGE
;
4155 it
->from_overlay
= Qnil
;
4156 it
->face_id
= face_id
;
4158 /* Say that we haven't consumed the characters with
4159 `display' property yet. The call to pop_it in
4160 set_iterator_to_next will clean this up. */
4161 *position
= start_pos
;
4163 if (EQ (XCAR (spec
), Qleft_fringe
))
4165 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4166 it
->left_user_fringe_face_id
= face_id
;
4170 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4171 it
->right_user_fringe_face_id
= face_id
;
4173 #endif /* HAVE_WINDOW_SYSTEM */
4177 /* Prepare to handle `((margin left-margin) ...)',
4178 `((margin right-margin) ...)' and `((margin nil) ...)'
4179 prefixes for display specifications. */
4180 location
= Qunbound
;
4181 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4185 value
= XCDR (spec
);
4187 value
= XCAR (value
);
4190 if (EQ (XCAR (tem
), Qmargin
)
4191 && (tem
= XCDR (tem
),
4192 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4194 || EQ (tem
, Qleft_margin
)
4195 || EQ (tem
, Qright_margin
))))
4199 if (EQ (location
, Qunbound
))
4205 /* After this point, VALUE is the property after any
4206 margin prefix has been stripped. It must be a string,
4207 an image specification, or `(space ...)'.
4209 LOCATION specifies where to display: `left-margin',
4210 `right-margin' or nil. */
4212 valid_p
= (STRINGP (value
)
4213 #ifdef HAVE_WINDOW_SYSTEM
4214 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4215 #endif /* not HAVE_WINDOW_SYSTEM */
4216 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4218 if (valid_p
&& !display_replaced_before_p
)
4220 /* Save current settings of IT so that we can restore them
4221 when we are finished with the glyph property value. */
4222 save_pos
= it
->position
;
4223 it
->position
= *position
;
4225 it
->position
= save_pos
;
4226 it
->from_overlay
= overlay
;
4228 if (NILP (location
))
4229 it
->area
= TEXT_AREA
;
4230 else if (EQ (location
, Qleft_margin
))
4231 it
->area
= LEFT_MARGIN_AREA
;
4233 it
->area
= RIGHT_MARGIN_AREA
;
4235 if (STRINGP (value
))
4238 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4239 it
->current
.overlay_string_index
= -1;
4240 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4241 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4242 it
->method
= GET_FROM_STRING
;
4243 it
->stop_charpos
= 0;
4244 it
->string_from_display_prop_p
= 1;
4245 /* Say that we haven't consumed the characters with
4246 `display' property yet. The call to pop_it in
4247 set_iterator_to_next will clean this up. */
4248 if (BUFFERP (object
))
4249 *position
= start_pos
;
4251 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4253 it
->method
= GET_FROM_STRETCH
;
4255 *position
= it
->position
= start_pos
;
4257 #ifdef HAVE_WINDOW_SYSTEM
4260 it
->what
= IT_IMAGE
;
4261 it
->image_id
= lookup_image (it
->f
, value
);
4262 it
->position
= start_pos
;
4263 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4264 it
->method
= GET_FROM_IMAGE
;
4266 /* Say that we haven't consumed the characters with
4267 `display' property yet. The call to pop_it in
4268 set_iterator_to_next will clean this up. */
4269 *position
= start_pos
;
4271 #endif /* HAVE_WINDOW_SYSTEM */
4276 /* Invalid property or property not supported. Restore
4277 POSITION to what it was before. */
4278 *position
= start_pos
;
4283 /* Check if SPEC is a display sub-property value whose text should be
4284 treated as intangible. */
4287 single_display_spec_intangible_p (Lisp_Object prop
)
4289 /* Skip over `when FORM'. */
4290 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4304 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4305 we don't need to treat text as intangible. */
4306 if (EQ (XCAR (prop
), Qmargin
))
4314 || EQ (XCAR (prop
), Qleft_margin
)
4315 || EQ (XCAR (prop
), Qright_margin
))
4319 return (CONSP (prop
)
4320 && (EQ (XCAR (prop
), Qimage
)
4321 || EQ (XCAR (prop
), Qspace
)));
4325 /* Check if PROP is a display property value whose text should be
4326 treated as intangible. */
4329 display_prop_intangible_p (Lisp_Object prop
)
4332 && CONSP (XCAR (prop
))
4333 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4335 /* A list of sub-properties. */
4336 while (CONSP (prop
))
4338 if (single_display_spec_intangible_p (XCAR (prop
)))
4343 else if (VECTORP (prop
))
4345 /* A vector of sub-properties. */
4347 for (i
= 0; i
< ASIZE (prop
); ++i
)
4348 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4352 return single_display_spec_intangible_p (prop
);
4358 /* Return 1 if PROP is a display sub-property value containing STRING. */
4361 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4363 if (EQ (string
, prop
))
4366 /* Skip over `when FORM'. */
4367 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4376 /* Skip over `margin LOCATION'. */
4377 if (EQ (XCAR (prop
), Qmargin
))
4388 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4392 /* Return 1 if STRING appears in the `display' property PROP. */
4395 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4398 && CONSP (XCAR (prop
))
4399 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4401 /* A list of sub-properties. */
4402 while (CONSP (prop
))
4404 if (single_display_spec_string_p (XCAR (prop
), string
))
4409 else if (VECTORP (prop
))
4411 /* A vector of sub-properties. */
4413 for (i
= 0; i
< ASIZE (prop
); ++i
)
4414 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4418 return single_display_spec_string_p (prop
, string
);
4423 /* Look for STRING in overlays and text properties in W's buffer,
4424 between character positions FROM and TO (excluding TO).
4425 BACK_P non-zero means look back (in this case, TO is supposed to be
4427 Value is the first character position where STRING was found, or
4428 zero if it wasn't found before hitting TO.
4430 W's buffer must be current.
4432 This function may only use code that doesn't eval because it is
4433 called asynchronously from note_mouse_highlight. */
4436 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4437 EMACS_INT from
, EMACS_INT to
, int back_p
)
4439 Lisp_Object limit
, prop
, pos
;
4442 pos
= make_number (from
);
4444 if (!back_p
) /* looking forward */
4446 limit
= make_number (min (to
, ZV
));
4447 while (!found
&& !EQ (pos
, limit
))
4449 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4450 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4453 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4457 else /* looking back */
4459 limit
= make_number (max (to
, BEGV
));
4460 while (!found
&& !EQ (pos
, limit
))
4462 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4463 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4466 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4471 return found
? XINT (pos
) : 0;
4474 /* Determine which buffer position in W's buffer STRING comes from.
4475 AROUND_CHARPOS is an approximate position where it could come from.
4476 Value is the buffer position or 0 if it couldn't be determined.
4478 W's buffer must be current.
4480 This function is necessary because we don't record buffer positions
4481 in glyphs generated from strings (to keep struct glyph small).
4482 This function may only use code that doesn't eval because it is
4483 called asynchronously from note_mouse_highlight. */
4486 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4488 const int MAX_DISTANCE
= 1000;
4489 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4490 around_charpos
+ MAX_DISTANCE
,
4494 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4495 around_charpos
- MAX_DISTANCE
, 1);
4501 /***********************************************************************
4502 `composition' property
4503 ***********************************************************************/
4505 /* Set up iterator IT from `composition' property at its current
4506 position. Called from handle_stop. */
4508 static enum prop_handled
4509 handle_composition_prop (struct it
*it
)
4511 Lisp_Object prop
, string
;
4512 EMACS_INT pos
, pos_byte
, start
, end
;
4514 if (STRINGP (it
->string
))
4518 pos
= IT_STRING_CHARPOS (*it
);
4519 pos_byte
= IT_STRING_BYTEPOS (*it
);
4520 string
= it
->string
;
4521 s
= SDATA (string
) + pos_byte
;
4522 it
->c
= STRING_CHAR (s
);
4526 pos
= IT_CHARPOS (*it
);
4527 pos_byte
= IT_BYTEPOS (*it
);
4529 it
->c
= FETCH_CHAR (pos_byte
);
4532 /* If there's a valid composition and point is not inside of the
4533 composition (in the case that the composition is from the current
4534 buffer), draw a glyph composed from the composition components. */
4535 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4536 && COMPOSITION_VALID_P (start
, end
, prop
)
4537 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4541 if (STRINGP (it
->string
))
4542 pos_byte
= string_char_to_byte (it
->string
, start
);
4544 pos_byte
= CHAR_TO_BYTE (start
);
4546 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4549 if (it
->cmp_it
.id
>= 0)
4552 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4553 it
->cmp_it
.nglyphs
= -1;
4557 return HANDLED_NORMALLY
;
4562 /***********************************************************************
4564 ***********************************************************************/
4566 /* The following structure is used to record overlay strings for
4567 later sorting in load_overlay_strings. */
4569 struct overlay_entry
4571 Lisp_Object overlay
;
4578 /* Set up iterator IT from overlay strings at its current position.
4579 Called from handle_stop. */
4581 static enum prop_handled
4582 handle_overlay_change (struct it
*it
)
4584 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4585 return HANDLED_RECOMPUTE_PROPS
;
4587 return HANDLED_NORMALLY
;
4591 /* Set up the next overlay string for delivery by IT, if there is an
4592 overlay string to deliver. Called by set_iterator_to_next when the
4593 end of the current overlay string is reached. If there are more
4594 overlay strings to display, IT->string and
4595 IT->current.overlay_string_index are set appropriately here.
4596 Otherwise IT->string is set to nil. */
4599 next_overlay_string (struct it
*it
)
4601 ++it
->current
.overlay_string_index
;
4602 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4604 /* No more overlay strings. Restore IT's settings to what
4605 they were before overlay strings were processed, and
4606 continue to deliver from current_buffer. */
4608 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4611 || (NILP (it
->string
)
4612 && it
->method
== GET_FROM_BUFFER
4613 && it
->stop_charpos
>= BEGV
4614 && it
->stop_charpos
<= it
->end_charpos
));
4615 it
->current
.overlay_string_index
= -1;
4616 it
->n_overlay_strings
= 0;
4617 it
->overlay_strings_charpos
= -1;
4619 /* If we're at the end of the buffer, record that we have
4620 processed the overlay strings there already, so that
4621 next_element_from_buffer doesn't try it again. */
4622 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4623 it
->overlay_strings_at_end_processed_p
= 1;
4627 /* There are more overlay strings to process. If
4628 IT->current.overlay_string_index has advanced to a position
4629 where we must load IT->overlay_strings with more strings, do
4630 it. We must load at the IT->overlay_strings_charpos where
4631 IT->n_overlay_strings was originally computed; when invisible
4632 text is present, this might not be IT_CHARPOS (Bug#7016). */
4633 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4635 if (it
->current
.overlay_string_index
&& i
== 0)
4636 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4638 /* Initialize IT to deliver display elements from the overlay
4640 it
->string
= it
->overlay_strings
[i
];
4641 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4642 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4643 it
->method
= GET_FROM_STRING
;
4644 it
->stop_charpos
= 0;
4645 if (it
->cmp_it
.stop_pos
>= 0)
4646 it
->cmp_it
.stop_pos
= 0;
4653 /* Compare two overlay_entry structures E1 and E2. Used as a
4654 comparison function for qsort in load_overlay_strings. Overlay
4655 strings for the same position are sorted so that
4657 1. All after-strings come in front of before-strings, except
4658 when they come from the same overlay.
4660 2. Within after-strings, strings are sorted so that overlay strings
4661 from overlays with higher priorities come first.
4663 2. Within before-strings, strings are sorted so that overlay
4664 strings from overlays with higher priorities come last.
4666 Value is analogous to strcmp. */
4670 compare_overlay_entries (const void *e1
, const void *e2
)
4672 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4673 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4676 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4678 /* Let after-strings appear in front of before-strings if
4679 they come from different overlays. */
4680 if (EQ (entry1
->overlay
, entry2
->overlay
))
4681 result
= entry1
->after_string_p
? 1 : -1;
4683 result
= entry1
->after_string_p
? -1 : 1;
4685 else if (entry1
->after_string_p
)
4686 /* After-strings sorted in order of decreasing priority. */
4687 result
= entry2
->priority
- entry1
->priority
;
4689 /* Before-strings sorted in order of increasing priority. */
4690 result
= entry1
->priority
- entry2
->priority
;
4696 /* Load the vector IT->overlay_strings with overlay strings from IT's
4697 current buffer position, or from CHARPOS if that is > 0. Set
4698 IT->n_overlays to the total number of overlay strings found.
4700 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4701 a time. On entry into load_overlay_strings,
4702 IT->current.overlay_string_index gives the number of overlay
4703 strings that have already been loaded by previous calls to this
4706 IT->add_overlay_start contains an additional overlay start
4707 position to consider for taking overlay strings from, if non-zero.
4708 This position comes into play when the overlay has an `invisible'
4709 property, and both before and after-strings. When we've skipped to
4710 the end of the overlay, because of its `invisible' property, we
4711 nevertheless want its before-string to appear.
4712 IT->add_overlay_start will contain the overlay start position
4715 Overlay strings are sorted so that after-string strings come in
4716 front of before-string strings. Within before and after-strings,
4717 strings are sorted by overlay priority. See also function
4718 compare_overlay_entries. */
4721 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4723 Lisp_Object overlay
, window
, str
, invisible
;
4724 struct Lisp_Overlay
*ov
;
4725 EMACS_INT start
, end
;
4727 int n
= 0, i
, j
, invis_p
;
4728 struct overlay_entry
*entries
4729 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4732 charpos
= IT_CHARPOS (*it
);
4734 /* Append the overlay string STRING of overlay OVERLAY to vector
4735 `entries' which has size `size' and currently contains `n'
4736 elements. AFTER_P non-zero means STRING is an after-string of
4738 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4741 Lisp_Object priority; \
4745 int new_size = 2 * size; \
4746 struct overlay_entry *old = entries; \
4748 (struct overlay_entry *) alloca (new_size \
4749 * sizeof *entries); \
4750 memcpy (entries, old, size * sizeof *entries); \
4754 entries[n].string = (STRING); \
4755 entries[n].overlay = (OVERLAY); \
4756 priority = Foverlay_get ((OVERLAY), Qpriority); \
4757 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4758 entries[n].after_string_p = (AFTER_P); \
4763 /* Process overlay before the overlay center. */
4764 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4766 XSETMISC (overlay
, ov
);
4767 xassert (OVERLAYP (overlay
));
4768 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4769 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4774 /* Skip this overlay if it doesn't start or end at IT's current
4776 if (end
!= charpos
&& start
!= charpos
)
4779 /* Skip this overlay if it doesn't apply to IT->w. */
4780 window
= Foverlay_get (overlay
, Qwindow
);
4781 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4784 /* If the text ``under'' the overlay is invisible, both before-
4785 and after-strings from this overlay are visible; start and
4786 end position are indistinguishable. */
4787 invisible
= Foverlay_get (overlay
, Qinvisible
);
4788 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4790 /* If overlay has a non-empty before-string, record it. */
4791 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4792 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4794 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4796 /* If overlay has a non-empty after-string, record it. */
4797 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4798 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4800 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4803 /* Process overlays after the overlay center. */
4804 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4806 XSETMISC (overlay
, ov
);
4807 xassert (OVERLAYP (overlay
));
4808 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4809 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4811 if (start
> charpos
)
4814 /* Skip this overlay if it doesn't start or end at IT's current
4816 if (end
!= charpos
&& start
!= charpos
)
4819 /* Skip this overlay if it doesn't apply to IT->w. */
4820 window
= Foverlay_get (overlay
, Qwindow
);
4821 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4824 /* If the text ``under'' the overlay is invisible, it has a zero
4825 dimension, and both before- and after-strings apply. */
4826 invisible
= Foverlay_get (overlay
, Qinvisible
);
4827 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4829 /* If overlay has a non-empty before-string, record it. */
4830 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4831 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4833 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4835 /* If overlay has a non-empty after-string, record it. */
4836 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4837 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4839 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4842 #undef RECORD_OVERLAY_STRING
4846 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4848 /* Record number of overlay strings, and where we computed it. */
4849 it
->n_overlay_strings
= n
;
4850 it
->overlay_strings_charpos
= charpos
;
4852 /* IT->current.overlay_string_index is the number of overlay strings
4853 that have already been consumed by IT. Copy some of the
4854 remaining overlay strings to IT->overlay_strings. */
4856 j
= it
->current
.overlay_string_index
;
4857 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4859 it
->overlay_strings
[i
] = entries
[j
].string
;
4860 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4867 /* Get the first chunk of overlay strings at IT's current buffer
4868 position, or at CHARPOS if that is > 0. Value is non-zero if at
4869 least one overlay string was found. */
4872 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4874 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4875 process. This fills IT->overlay_strings with strings, and sets
4876 IT->n_overlay_strings to the total number of strings to process.
4877 IT->pos.overlay_string_index has to be set temporarily to zero
4878 because load_overlay_strings needs this; it must be set to -1
4879 when no overlay strings are found because a zero value would
4880 indicate a position in the first overlay string. */
4881 it
->current
.overlay_string_index
= 0;
4882 load_overlay_strings (it
, charpos
);
4884 /* If we found overlay strings, set up IT to deliver display
4885 elements from the first one. Otherwise set up IT to deliver
4886 from current_buffer. */
4887 if (it
->n_overlay_strings
)
4889 /* Make sure we know settings in current_buffer, so that we can
4890 restore meaningful values when we're done with the overlay
4893 compute_stop_pos (it
);
4894 xassert (it
->face_id
>= 0);
4896 /* Save IT's settings. They are restored after all overlay
4897 strings have been processed. */
4898 xassert (!compute_stop_p
|| it
->sp
== 0);
4900 /* When called from handle_stop, there might be an empty display
4901 string loaded. In that case, don't bother saving it. */
4902 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4905 /* Set up IT to deliver display elements from the first overlay
4907 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4908 it
->string
= it
->overlay_strings
[0];
4909 it
->from_overlay
= Qnil
;
4910 it
->stop_charpos
= 0;
4911 xassert (STRINGP (it
->string
));
4912 it
->end_charpos
= SCHARS (it
->string
);
4913 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4914 it
->method
= GET_FROM_STRING
;
4918 it
->current
.overlay_string_index
= -1;
4923 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4926 it
->method
= GET_FROM_BUFFER
;
4928 (void) get_overlay_strings_1 (it
, charpos
, 1);
4932 /* Value is non-zero if we found at least one overlay string. */
4933 return STRINGP (it
->string
);
4938 /***********************************************************************
4939 Saving and restoring state
4940 ***********************************************************************/
4942 /* Save current settings of IT on IT->stack. Called, for example,
4943 before setting up IT for an overlay string, to be able to restore
4944 IT's settings to what they were after the overlay string has been
4948 push_it (struct it
*it
)
4950 struct iterator_stack_entry
*p
;
4952 xassert (it
->sp
< IT_STACK_SIZE
);
4953 p
= it
->stack
+ it
->sp
;
4955 p
->stop_charpos
= it
->stop_charpos
;
4956 p
->prev_stop
= it
->prev_stop
;
4957 p
->base_level_stop
= it
->base_level_stop
;
4958 p
->cmp_it
= it
->cmp_it
;
4959 xassert (it
->face_id
>= 0);
4960 p
->face_id
= it
->face_id
;
4961 p
->string
= it
->string
;
4962 p
->method
= it
->method
;
4963 p
->from_overlay
= it
->from_overlay
;
4966 case GET_FROM_IMAGE
:
4967 p
->u
.image
.object
= it
->object
;
4968 p
->u
.image
.image_id
= it
->image_id
;
4969 p
->u
.image
.slice
= it
->slice
;
4971 case GET_FROM_STRETCH
:
4972 p
->u
.stretch
.object
= it
->object
;
4975 p
->position
= it
->position
;
4976 p
->current
= it
->current
;
4977 p
->end_charpos
= it
->end_charpos
;
4978 p
->string_nchars
= it
->string_nchars
;
4980 p
->multibyte_p
= it
->multibyte_p
;
4981 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4982 p
->space_width
= it
->space_width
;
4983 p
->font_height
= it
->font_height
;
4984 p
->voffset
= it
->voffset
;
4985 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4986 p
->display_ellipsis_p
= 0;
4987 p
->line_wrap
= it
->line_wrap
;
4992 iterate_out_of_display_property (struct it
*it
)
4994 /* Maybe initialize paragraph direction. If we are at the beginning
4995 of a new paragraph, next_element_from_buffer may not have a
4996 chance to do that. */
4997 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4998 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4999 /* prev_stop can be zero, so check against BEGV as well. */
5000 while (it
->bidi_it
.charpos
>= BEGV
5001 && it
->prev_stop
<= it
->bidi_it
.charpos
5002 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5003 bidi_move_to_visually_next (&it
->bidi_it
);
5004 /* Record the stop_pos we just crossed, for when we cross it
5006 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5007 it
->prev_stop
= CHARPOS (it
->position
);
5008 /* If we ended up not where pop_it put us, resync IT's
5009 positional members with the bidi iterator. */
5010 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5012 SET_TEXT_POS (it
->position
,
5013 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5014 it
->current
.pos
= it
->position
;
5018 /* Restore IT's settings from IT->stack. Called, for example, when no
5019 more overlay strings must be processed, and we return to delivering
5020 display elements from a buffer, or when the end of a string from a
5021 `display' property is reached and we return to delivering display
5022 elements from an overlay string, or from a buffer. */
5025 pop_it (struct it
*it
)
5027 struct iterator_stack_entry
*p
;
5029 xassert (it
->sp
> 0);
5031 p
= it
->stack
+ it
->sp
;
5032 it
->stop_charpos
= p
->stop_charpos
;
5033 it
->prev_stop
= p
->prev_stop
;
5034 it
->base_level_stop
= p
->base_level_stop
;
5035 it
->cmp_it
= p
->cmp_it
;
5036 it
->face_id
= p
->face_id
;
5037 it
->current
= p
->current
;
5038 it
->position
= p
->position
;
5039 it
->string
= p
->string
;
5040 it
->from_overlay
= p
->from_overlay
;
5041 if (NILP (it
->string
))
5042 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5043 it
->method
= p
->method
;
5046 case GET_FROM_IMAGE
:
5047 it
->image_id
= p
->u
.image
.image_id
;
5048 it
->object
= p
->u
.image
.object
;
5049 it
->slice
= p
->u
.image
.slice
;
5051 case GET_FROM_STRETCH
:
5052 it
->object
= p
->u
.comp
.object
;
5054 case GET_FROM_BUFFER
:
5055 it
->object
= it
->w
->buffer
;
5058 /* Bidi-iterate until we get out of the portion of text, if
5059 any, covered by a `display' text property or an overlay
5060 with `display' property. (We cannot just jump there,
5061 because the internal coherency of the bidi iterator state
5062 can not be preserved across such jumps.) We also must
5063 determine the paragraph base direction if the overlay we
5064 just processed is at the beginning of a new
5066 iterate_out_of_display_property (it
);
5069 case GET_FROM_STRING
:
5070 it
->object
= it
->string
;
5072 case GET_FROM_DISPLAY_VECTOR
:
5074 it
->method
= GET_FROM_C_STRING
;
5075 else if (STRINGP (it
->string
))
5076 it
->method
= GET_FROM_STRING
;
5079 it
->method
= GET_FROM_BUFFER
;
5080 it
->object
= it
->w
->buffer
;
5083 it
->end_charpos
= p
->end_charpos
;
5084 it
->string_nchars
= p
->string_nchars
;
5086 it
->multibyte_p
= p
->multibyte_p
;
5087 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5088 it
->space_width
= p
->space_width
;
5089 it
->font_height
= p
->font_height
;
5090 it
->voffset
= p
->voffset
;
5091 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5092 it
->line_wrap
= p
->line_wrap
;
5097 /***********************************************************************
5099 ***********************************************************************/
5101 /* Set IT's current position to the previous line start. */
5104 back_to_previous_line_start (struct it
*it
)
5106 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5107 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5111 /* Move IT to the next line start.
5113 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5114 we skipped over part of the text (as opposed to moving the iterator
5115 continuously over the text). Otherwise, don't change the value
5118 Newlines may come from buffer text, overlay strings, or strings
5119 displayed via the `display' property. That's the reason we can't
5120 simply use find_next_newline_no_quit.
5122 Note that this function may not skip over invisible text that is so
5123 because of text properties and immediately follows a newline. If
5124 it would, function reseat_at_next_visible_line_start, when called
5125 from set_iterator_to_next, would effectively make invisible
5126 characters following a newline part of the wrong glyph row, which
5127 leads to wrong cursor motion. */
5130 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5132 int old_selective
, newline_found_p
, n
;
5133 const int MAX_NEWLINE_DISTANCE
= 500;
5135 /* If already on a newline, just consume it to avoid unintended
5136 skipping over invisible text below. */
5137 if (it
->what
== IT_CHARACTER
5139 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5141 set_iterator_to_next (it
, 0);
5146 /* Don't handle selective display in the following. It's (a)
5147 unnecessary because it's done by the caller, and (b) leads to an
5148 infinite recursion because next_element_from_ellipsis indirectly
5149 calls this function. */
5150 old_selective
= it
->selective
;
5153 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5154 from buffer text. */
5155 for (n
= newline_found_p
= 0;
5156 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5157 n
+= STRINGP (it
->string
) ? 0 : 1)
5159 if (!get_next_display_element (it
))
5161 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5162 set_iterator_to_next (it
, 0);
5165 /* If we didn't find a newline near enough, see if we can use a
5167 if (!newline_found_p
)
5169 EMACS_INT start
= IT_CHARPOS (*it
);
5170 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5173 xassert (!STRINGP (it
->string
));
5175 /* If there isn't any `display' property in sight, and no
5176 overlays, we can just use the position of the newline in
5178 if (it
->stop_charpos
>= limit
5179 || ((pos
= Fnext_single_property_change (make_number (start
),
5181 Qnil
, make_number (limit
)),
5183 && next_overlay_change (start
) == ZV
))
5185 IT_CHARPOS (*it
) = limit
;
5186 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5187 *skipped_p
= newline_found_p
= 1;
5191 while (get_next_display_element (it
)
5192 && !newline_found_p
)
5194 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5195 set_iterator_to_next (it
, 0);
5200 it
->selective
= old_selective
;
5201 return newline_found_p
;
5205 /* Set IT's current position to the previous visible line start. Skip
5206 invisible text that is so either due to text properties or due to
5207 selective display. Caution: this does not change IT->current_x and
5211 back_to_previous_visible_line_start (struct it
*it
)
5213 while (IT_CHARPOS (*it
) > BEGV
)
5215 back_to_previous_line_start (it
);
5217 if (IT_CHARPOS (*it
) <= BEGV
)
5220 /* If selective > 0, then lines indented more than its value are
5222 if (it
->selective
> 0
5223 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5224 (double) it
->selective
)) /* iftc */
5227 /* Check the newline before point for invisibility. */
5230 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5231 Qinvisible
, it
->window
);
5232 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5236 if (IT_CHARPOS (*it
) <= BEGV
)
5243 Lisp_Object val
, overlay
;
5245 /* If newline is part of a composition, continue from start of composition */
5246 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5247 && beg
< IT_CHARPOS (*it
))
5250 /* If newline is replaced by a display property, find start of overlay
5251 or interval and continue search from that point. */
5253 pos
= --IT_CHARPOS (it2
);
5256 it2
.string_from_display_prop_p
= 0;
5257 if (handle_display_prop (&it2
) == HANDLED_RETURN
5258 && !NILP (val
= get_char_property_and_overlay
5259 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5260 && (OVERLAYP (overlay
)
5261 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5262 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5265 /* Newline is not replaced by anything -- so we are done. */
5271 IT_CHARPOS (*it
) = beg
;
5272 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5276 it
->continuation_lines_width
= 0;
5278 xassert (IT_CHARPOS (*it
) >= BEGV
);
5279 xassert (IT_CHARPOS (*it
) == BEGV
5280 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5285 /* Reseat iterator IT at the previous visible line start. Skip
5286 invisible text that is so either due to text properties or due to
5287 selective display. At the end, update IT's overlay information,
5288 face information etc. */
5291 reseat_at_previous_visible_line_start (struct it
*it
)
5293 back_to_previous_visible_line_start (it
);
5294 reseat (it
, it
->current
.pos
, 1);
5299 /* Reseat iterator IT on the next visible line start in the current
5300 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5301 preceding the line start. Skip over invisible text that is so
5302 because of selective display. Compute faces, overlays etc at the
5303 new position. Note that this function does not skip over text that
5304 is invisible because of text properties. */
5307 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5309 int newline_found_p
, skipped_p
= 0;
5311 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5313 /* Skip over lines that are invisible because they are indented
5314 more than the value of IT->selective. */
5315 if (it
->selective
> 0)
5316 while (IT_CHARPOS (*it
) < ZV
5317 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5318 (double) it
->selective
)) /* iftc */
5320 xassert (IT_BYTEPOS (*it
) == BEGV
5321 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5322 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5325 /* Position on the newline if that's what's requested. */
5326 if (on_newline_p
&& newline_found_p
)
5328 if (STRINGP (it
->string
))
5330 if (IT_STRING_CHARPOS (*it
) > 0)
5332 --IT_STRING_CHARPOS (*it
);
5333 --IT_STRING_BYTEPOS (*it
);
5336 else if (IT_CHARPOS (*it
) > BEGV
)
5340 reseat (it
, it
->current
.pos
, 0);
5344 reseat (it
, it
->current
.pos
, 0);
5351 /***********************************************************************
5352 Changing an iterator's position
5353 ***********************************************************************/
5355 /* Change IT's current position to POS in current_buffer. If FORCE_P
5356 is non-zero, always check for text properties at the new position.
5357 Otherwise, text properties are only looked up if POS >=
5358 IT->check_charpos of a property. */
5361 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5363 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5365 reseat_1 (it
, pos
, 0);
5367 /* Determine where to check text properties. Avoid doing it
5368 where possible because text property lookup is very expensive. */
5370 || CHARPOS (pos
) > it
->stop_charpos
5371 || CHARPOS (pos
) < original_pos
)
5375 /* For bidi iteration, we need to prime prev_stop and
5376 base_level_stop with our best estimations. */
5377 if (CHARPOS (pos
) < it
->prev_stop
)
5379 handle_stop_backwards (it
, BEGV
);
5380 if (CHARPOS (pos
) < it
->base_level_stop
)
5381 it
->base_level_stop
= 0;
5383 else if (CHARPOS (pos
) > it
->stop_charpos
5384 && it
->stop_charpos
>= BEGV
)
5385 handle_stop_backwards (it
, it
->stop_charpos
);
5392 it
->prev_stop
= it
->base_level_stop
= 0;
5401 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5402 IT->stop_pos to POS, also. */
5405 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5407 /* Don't call this function when scanning a C string. */
5408 xassert (it
->s
== NULL
);
5410 /* POS must be a reasonable value. */
5411 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5413 it
->current
.pos
= it
->position
= pos
;
5414 it
->end_charpos
= ZV
;
5416 it
->current
.dpvec_index
= -1;
5417 it
->current
.overlay_string_index
= -1;
5418 IT_STRING_CHARPOS (*it
) = -1;
5419 IT_STRING_BYTEPOS (*it
) = -1;
5421 it
->string_from_display_prop_p
= 0;
5422 it
->method
= GET_FROM_BUFFER
;
5423 it
->object
= it
->w
->buffer
;
5424 it
->area
= TEXT_AREA
;
5425 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5427 it
->string_from_display_prop_p
= 0;
5428 it
->face_before_selective_p
= 0;
5431 it
->bidi_it
.first_elt
= 1;
5432 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5437 it
->stop_charpos
= CHARPOS (pos
);
5438 it
->base_level_stop
= CHARPOS (pos
);
5443 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5444 If S is non-null, it is a C string to iterate over. Otherwise,
5445 STRING gives a Lisp string to iterate over.
5447 If PRECISION > 0, don't return more then PRECISION number of
5448 characters from the string.
5450 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5451 characters have been returned. FIELD_WIDTH < 0 means an infinite
5454 MULTIBYTE = 0 means disable processing of multibyte characters,
5455 MULTIBYTE > 0 means enable it,
5456 MULTIBYTE < 0 means use IT->multibyte_p.
5458 IT must be initialized via a prior call to init_iterator before
5459 calling this function. */
5462 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5463 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5466 /* No region in strings. */
5467 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5469 /* No text property checks performed by default, but see below. */
5470 it
->stop_charpos
= -1;
5472 /* Set iterator position and end position. */
5473 memset (&it
->current
, 0, sizeof it
->current
);
5474 it
->current
.overlay_string_index
= -1;
5475 it
->current
.dpvec_index
= -1;
5476 xassert (charpos
>= 0);
5478 /* If STRING is specified, use its multibyteness, otherwise use the
5479 setting of MULTIBYTE, if specified. */
5481 it
->multibyte_p
= multibyte
> 0;
5485 xassert (STRINGP (string
));
5486 it
->string
= string
;
5488 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5489 it
->method
= GET_FROM_STRING
;
5490 it
->current
.string_pos
= string_pos (charpos
, string
);
5494 it
->s
= (const unsigned char *) s
;
5497 /* Note that we use IT->current.pos, not it->current.string_pos,
5498 for displaying C strings. */
5499 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5500 if (it
->multibyte_p
)
5502 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5503 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5507 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5508 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5511 it
->method
= GET_FROM_C_STRING
;
5514 /* PRECISION > 0 means don't return more than PRECISION characters
5516 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5517 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5519 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5520 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5521 FIELD_WIDTH < 0 means infinite field width. This is useful for
5522 padding with `-' at the end of a mode line. */
5523 if (field_width
< 0)
5524 field_width
= INFINITY
;
5525 if (field_width
> it
->end_charpos
- charpos
)
5526 it
->end_charpos
= charpos
+ field_width
;
5528 /* Use the standard display table for displaying strings. */
5529 if (DISP_TABLE_P (Vstandard_display_table
))
5530 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5532 it
->stop_charpos
= charpos
;
5533 if (s
== NULL
&& it
->multibyte_p
)
5535 EMACS_INT endpos
= SCHARS (it
->string
);
5536 if (endpos
> it
->end_charpos
)
5537 endpos
= it
->end_charpos
;
5538 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5546 /***********************************************************************
5548 ***********************************************************************/
5550 /* Map enum it_method value to corresponding next_element_from_* function. */
5552 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5554 next_element_from_buffer
,
5555 next_element_from_display_vector
,
5556 next_element_from_string
,
5557 next_element_from_c_string
,
5558 next_element_from_image
,
5559 next_element_from_stretch
5562 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5565 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5566 (possibly with the following characters). */
5568 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5569 ((IT)->cmp_it.id >= 0 \
5570 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5571 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5572 END_CHARPOS, (IT)->w, \
5573 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5577 /* Lookup the char-table Vglyphless_char_display for character C (-1
5578 if we want information for no-font case), and return the display
5579 method symbol. By side-effect, update it->what and
5580 it->glyphless_method. This function is called from
5581 get_next_display_element for each character element, and from
5582 x_produce_glyphs when no suitable font was found. */
5585 lookup_glyphless_char_display (int c
, struct it
*it
)
5587 Lisp_Object glyphless_method
= Qnil
;
5589 if (CHAR_TABLE_P (Vglyphless_char_display
)
5590 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5591 glyphless_method
= (c
>= 0
5592 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5593 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5595 if (NILP (glyphless_method
))
5598 /* The default is to display the character by a proper font. */
5600 /* The default for the no-font case is to display an empty box. */
5601 glyphless_method
= Qempty_box
;
5603 if (EQ (glyphless_method
, Qzero_width
))
5606 return glyphless_method
;
5607 /* This method can't be used for the no-font case. */
5608 glyphless_method
= Qempty_box
;
5610 if (EQ (glyphless_method
, Qthin_space
))
5611 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5612 else if (EQ (glyphless_method
, Qempty_box
))
5613 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5614 else if (EQ (glyphless_method
, Qhex_code
))
5615 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5616 else if (STRINGP (glyphless_method
))
5617 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5620 /* Invalid value. We use the default method. */
5621 glyphless_method
= Qnil
;
5624 it
->what
= IT_GLYPHLESS
;
5625 return glyphless_method
;
5628 /* Load IT's display element fields with information about the next
5629 display element from the current position of IT. Value is zero if
5630 end of buffer (or C string) is reached. */
5632 static struct frame
*last_escape_glyph_frame
= NULL
;
5633 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5634 static int last_escape_glyph_merged_face_id
= 0;
5636 struct frame
*last_glyphless_glyph_frame
= NULL
;
5637 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5638 int last_glyphless_glyph_merged_face_id
= 0;
5641 get_next_display_element (struct it
*it
)
5643 /* Non-zero means that we found a display element. Zero means that
5644 we hit the end of what we iterate over. Performance note: the
5645 function pointer `method' used here turns out to be faster than
5646 using a sequence of if-statements. */
5650 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5652 if (it
->what
== IT_CHARACTER
)
5654 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5655 and only if (a) the resolved directionality of that character
5657 /* FIXME: Do we need an exception for characters from display
5659 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5660 it
->c
= bidi_mirror_char (it
->c
);
5661 /* Map via display table or translate control characters.
5662 IT->c, IT->len etc. have been set to the next character by
5663 the function call above. If we have a display table, and it
5664 contains an entry for IT->c, translate it. Don't do this if
5665 IT->c itself comes from a display table, otherwise we could
5666 end up in an infinite recursion. (An alternative could be to
5667 count the recursion depth of this function and signal an
5668 error when a certain maximum depth is reached.) Is it worth
5670 if (success_p
&& it
->dpvec
== NULL
)
5673 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5674 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5675 nbsp_or_shy
= char_is_other
;
5676 int c
= it
->c
; /* This is the character to display. */
5678 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5680 xassert (SINGLE_BYTE_CHAR_P (c
));
5681 if (unibyte_display_via_language_environment
)
5683 c
= DECODE_CHAR (unibyte
, c
);
5685 c
= BYTE8_TO_CHAR (it
->c
);
5688 c
= BYTE8_TO_CHAR (it
->c
);
5692 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5695 struct Lisp_Vector
*v
= XVECTOR (dv
);
5697 /* Return the first character from the display table
5698 entry, if not empty. If empty, don't display the
5699 current character. */
5702 it
->dpvec_char_len
= it
->len
;
5703 it
->dpvec
= v
->contents
;
5704 it
->dpend
= v
->contents
+ v
->size
;
5705 it
->current
.dpvec_index
= 0;
5706 it
->dpvec_face_id
= -1;
5707 it
->saved_face_id
= it
->face_id
;
5708 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5713 set_iterator_to_next (it
, 0);
5718 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5720 if (it
->what
== IT_GLYPHLESS
)
5722 /* Don't display this character. */
5723 set_iterator_to_next (it
, 0);
5727 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5728 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5729 : c
== 0xAD ? char_is_soft_hyphen
5732 /* Translate control characters into `\003' or `^C' form.
5733 Control characters coming from a display table entry are
5734 currently not translated because we use IT->dpvec to hold
5735 the translation. This could easily be changed but I
5736 don't believe that it is worth doing.
5738 NBSP and SOFT-HYPEN are property translated too.
5740 Non-printable characters and raw-byte characters are also
5741 translated to octal form. */
5742 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5743 ? (it
->area
!= TEXT_AREA
5744 /* In mode line, treat \n, \t like other crl chars. */
5747 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5748 || (c
!= '\n' && c
!= '\t'))
5751 || ! CHAR_PRINTABLE_P (c
))))
5753 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5754 or a non-printable character which must be displayed
5755 either as '\003' or as `^C' where the '\\' and '^'
5756 can be defined in the display table. Fill
5757 IT->ctl_chars with glyphs for what we have to
5758 display. Then, set IT->dpvec to these glyphs. */
5761 int face_id
, lface_id
= 0 ;
5764 /* Handle control characters with ^. */
5766 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5770 g
= '^'; /* default glyph for Control */
5771 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5773 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5774 && GLYPH_CODE_CHAR_VALID_P (gc
))
5776 g
= GLYPH_CODE_CHAR (gc
);
5777 lface_id
= GLYPH_CODE_FACE (gc
);
5781 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5783 else if (it
->f
== last_escape_glyph_frame
5784 && it
->face_id
== last_escape_glyph_face_id
)
5786 face_id
= last_escape_glyph_merged_face_id
;
5790 /* Merge the escape-glyph face into the current face. */
5791 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5793 last_escape_glyph_frame
= it
->f
;
5794 last_escape_glyph_face_id
= it
->face_id
;
5795 last_escape_glyph_merged_face_id
= face_id
;
5798 XSETINT (it
->ctl_chars
[0], g
);
5799 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5801 goto display_control
;
5804 /* Handle non-break space in the mode where it only gets
5807 if (EQ (Vnobreak_char_display
, Qt
)
5808 && nbsp_or_shy
== char_is_nbsp
)
5810 /* Merge the no-break-space face into the current face. */
5811 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5815 XSETINT (it
->ctl_chars
[0], ' ');
5817 goto display_control
;
5820 /* Handle sequences that start with the "escape glyph". */
5822 /* the default escape glyph is \. */
5823 escape_glyph
= '\\';
5826 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5827 && GLYPH_CODE_CHAR_VALID_P (gc
))
5829 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5830 lface_id
= GLYPH_CODE_FACE (gc
);
5834 /* The display table specified a face.
5835 Merge it into face_id and also into escape_glyph. */
5836 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5839 else if (it
->f
== last_escape_glyph_frame
5840 && it
->face_id
== last_escape_glyph_face_id
)
5842 face_id
= last_escape_glyph_merged_face_id
;
5846 /* Merge the escape-glyph face into the current face. */
5847 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5849 last_escape_glyph_frame
= it
->f
;
5850 last_escape_glyph_face_id
= it
->face_id
;
5851 last_escape_glyph_merged_face_id
= face_id
;
5854 /* Handle soft hyphens in the mode where they only get
5857 if (EQ (Vnobreak_char_display
, Qt
)
5858 && nbsp_or_shy
== char_is_soft_hyphen
)
5860 XSETINT (it
->ctl_chars
[0], '-');
5862 goto display_control
;
5865 /* Handle non-break space and soft hyphen
5866 with the escape glyph. */
5870 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5871 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5872 XSETINT (it
->ctl_chars
[1], c
);
5874 goto display_control
;
5881 if (CHAR_BYTE8_P (c
))
5882 /* Display \200 instead of \17777600. */
5883 c
= CHAR_TO_BYTE8 (c
);
5884 len
= sprintf (str
, "%03o", c
);
5886 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5887 for (i
= 0; i
< len
; i
++)
5888 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5893 /* Set up IT->dpvec and return first character from it. */
5894 it
->dpvec_char_len
= it
->len
;
5895 it
->dpvec
= it
->ctl_chars
;
5896 it
->dpend
= it
->dpvec
+ ctl_len
;
5897 it
->current
.dpvec_index
= 0;
5898 it
->dpvec_face_id
= face_id
;
5899 it
->saved_face_id
= it
->face_id
;
5900 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5904 it
->char_to_display
= c
;
5908 it
->char_to_display
= it
->c
;
5912 #ifdef HAVE_WINDOW_SYSTEM
5913 /* Adjust face id for a multibyte character. There are no multibyte
5914 character in unibyte text. */
5915 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5918 && FRAME_WINDOW_P (it
->f
))
5920 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5922 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5924 /* Automatic composition with glyph-string. */
5925 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5927 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5931 EMACS_INT pos
= (it
->s
? -1
5932 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5933 : IT_CHARPOS (*it
));
5935 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5942 /* Is this character the last one of a run of characters with
5943 box? If yes, set IT->end_of_box_run_p to 1. */
5947 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5949 int face_id
= underlying_face_id (it
);
5950 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5954 if (face
->box
== FACE_NO_BOX
)
5956 /* If the box comes from face properties in a
5957 display string, check faces in that string. */
5958 int string_face_id
= face_after_it_pos (it
);
5959 it
->end_of_box_run_p
5960 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5963 /* Otherwise, the box comes from the underlying face.
5964 If this is the last string character displayed, check
5965 the next buffer location. */
5966 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5967 && (it
->current
.overlay_string_index
5968 == it
->n_overlay_strings
- 1))
5972 struct text_pos pos
= it
->current
.pos
;
5973 INC_TEXT_POS (pos
, it
->multibyte_p
);
5975 next_face_id
= face_at_buffer_position
5976 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5977 it
->region_end_charpos
, &ignore
,
5978 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5980 it
->end_of_box_run_p
5981 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5988 int face_id
= face_after_it_pos (it
);
5989 it
->end_of_box_run_p
5990 = (face_id
!= it
->face_id
5991 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5995 /* Value is 0 if end of buffer or string reached. */
6000 /* Move IT to the next display element.
6002 RESEAT_P non-zero means if called on a newline in buffer text,
6003 skip to the next visible line start.
6005 Functions get_next_display_element and set_iterator_to_next are
6006 separate because I find this arrangement easier to handle than a
6007 get_next_display_element function that also increments IT's
6008 position. The way it is we can first look at an iterator's current
6009 display element, decide whether it fits on a line, and if it does,
6010 increment the iterator position. The other way around we probably
6011 would either need a flag indicating whether the iterator has to be
6012 incremented the next time, or we would have to implement a
6013 decrement position function which would not be easy to write. */
6016 set_iterator_to_next (struct it
*it
, int reseat_p
)
6018 /* Reset flags indicating start and end of a sequence of characters
6019 with box. Reset them at the start of this function because
6020 moving the iterator to a new position might set them. */
6021 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6025 case GET_FROM_BUFFER
:
6026 /* The current display element of IT is a character from
6027 current_buffer. Advance in the buffer, and maybe skip over
6028 invisible lines that are so because of selective display. */
6029 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6030 reseat_at_next_visible_line_start (it
, 0);
6031 else if (it
->cmp_it
.id
>= 0)
6033 /* We are currently getting glyphs from a composition. */
6038 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6039 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6040 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6042 it
->cmp_it
.from
= it
->cmp_it
.to
;
6047 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6049 it
->end_charpos
, Qnil
);
6052 else if (! it
->cmp_it
.reversed_p
)
6054 /* Composition created while scanning forward. */
6055 /* Update IT's char/byte positions to point to the first
6056 character of the next grapheme cluster, or to the
6057 character visually after the current composition. */
6058 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6059 bidi_move_to_visually_next (&it
->bidi_it
);
6060 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6061 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6063 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6065 /* Proceed to the next grapheme cluster. */
6066 it
->cmp_it
.from
= it
->cmp_it
.to
;
6070 /* No more grapheme clusters in this composition.
6071 Find the next stop position. */
6072 EMACS_INT stop
= it
->end_charpos
;
6073 if (it
->bidi_it
.scan_dir
< 0)
6074 /* Now we are scanning backward and don't know
6077 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6078 IT_BYTEPOS (*it
), stop
, Qnil
);
6083 /* Composition created while scanning backward. */
6084 /* Update IT's char/byte positions to point to the last
6085 character of the previous grapheme cluster, or the
6086 character visually after the current composition. */
6087 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6088 bidi_move_to_visually_next (&it
->bidi_it
);
6089 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6090 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6091 if (it
->cmp_it
.from
> 0)
6093 /* Proceed to the previous grapheme cluster. */
6094 it
->cmp_it
.to
= it
->cmp_it
.from
;
6098 /* No more grapheme clusters in this composition.
6099 Find the next stop position. */
6100 EMACS_INT stop
= it
->end_charpos
;
6101 if (it
->bidi_it
.scan_dir
< 0)
6102 /* Now we are scanning backward and don't know
6105 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6106 IT_BYTEPOS (*it
), stop
, Qnil
);
6112 xassert (it
->len
!= 0);
6116 IT_BYTEPOS (*it
) += it
->len
;
6117 IT_CHARPOS (*it
) += 1;
6121 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6122 /* If this is a new paragraph, determine its base
6123 direction (a.k.a. its base embedding level). */
6124 if (it
->bidi_it
.new_paragraph
)
6125 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6126 bidi_move_to_visually_next (&it
->bidi_it
);
6127 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6128 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6129 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6131 /* As the scan direction was changed, we must
6132 re-compute the stop position for composition. */
6133 EMACS_INT stop
= it
->end_charpos
;
6134 if (it
->bidi_it
.scan_dir
< 0)
6136 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6137 IT_BYTEPOS (*it
), stop
, Qnil
);
6140 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6144 case GET_FROM_C_STRING
:
6145 /* Current display element of IT is from a C string. */
6146 IT_BYTEPOS (*it
) += it
->len
;
6147 IT_CHARPOS (*it
) += 1;
6150 case GET_FROM_DISPLAY_VECTOR
:
6151 /* Current display element of IT is from a display table entry.
6152 Advance in the display table definition. Reset it to null if
6153 end reached, and continue with characters from buffers/
6155 ++it
->current
.dpvec_index
;
6157 /* Restore face of the iterator to what they were before the
6158 display vector entry (these entries may contain faces). */
6159 it
->face_id
= it
->saved_face_id
;
6161 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6163 int recheck_faces
= it
->ellipsis_p
;
6166 it
->method
= GET_FROM_C_STRING
;
6167 else if (STRINGP (it
->string
))
6168 it
->method
= GET_FROM_STRING
;
6171 it
->method
= GET_FROM_BUFFER
;
6172 it
->object
= it
->w
->buffer
;
6176 it
->current
.dpvec_index
= -1;
6178 /* Skip over characters which were displayed via IT->dpvec. */
6179 if (it
->dpvec_char_len
< 0)
6180 reseat_at_next_visible_line_start (it
, 1);
6181 else if (it
->dpvec_char_len
> 0)
6183 if (it
->method
== GET_FROM_STRING
6184 && it
->n_overlay_strings
> 0)
6185 it
->ignore_overlay_strings_at_pos_p
= 1;
6186 it
->len
= it
->dpvec_char_len
;
6187 set_iterator_to_next (it
, reseat_p
);
6190 /* Maybe recheck faces after display vector */
6192 it
->stop_charpos
= IT_CHARPOS (*it
);
6196 case GET_FROM_STRING
:
6197 /* Current display element is a character from a Lisp string. */
6198 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6199 if (it
->cmp_it
.id
>= 0)
6201 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6202 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6203 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6204 it
->cmp_it
.from
= it
->cmp_it
.to
;
6208 composition_compute_stop_pos (&it
->cmp_it
,
6209 IT_STRING_CHARPOS (*it
),
6210 IT_STRING_BYTEPOS (*it
),
6211 it
->end_charpos
, it
->string
);
6216 IT_STRING_BYTEPOS (*it
) += it
->len
;
6217 IT_STRING_CHARPOS (*it
) += 1;
6220 consider_string_end
:
6222 if (it
->current
.overlay_string_index
>= 0)
6224 /* IT->string is an overlay string. Advance to the
6225 next, if there is one. */
6226 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6229 next_overlay_string (it
);
6231 setup_for_ellipsis (it
, 0);
6236 /* IT->string is not an overlay string. If we reached
6237 its end, and there is something on IT->stack, proceed
6238 with what is on the stack. This can be either another
6239 string, this time an overlay string, or a buffer. */
6240 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6244 if (it
->method
== GET_FROM_STRING
)
6245 goto consider_string_end
;
6250 case GET_FROM_IMAGE
:
6251 case GET_FROM_STRETCH
:
6252 /* The position etc with which we have to proceed are on
6253 the stack. The position may be at the end of a string,
6254 if the `display' property takes up the whole string. */
6255 xassert (it
->sp
> 0);
6257 if (it
->method
== GET_FROM_STRING
)
6258 goto consider_string_end
;
6262 /* There are no other methods defined, so this should be a bug. */
6266 xassert (it
->method
!= GET_FROM_STRING
6267 || (STRINGP (it
->string
)
6268 && IT_STRING_CHARPOS (*it
) >= 0));
6271 /* Load IT's display element fields with information about the next
6272 display element which comes from a display table entry or from the
6273 result of translating a control character to one of the forms `^C'
6276 IT->dpvec holds the glyphs to return as characters.
6277 IT->saved_face_id holds the face id before the display vector--it
6278 is restored into IT->face_id in set_iterator_to_next. */
6281 next_element_from_display_vector (struct it
*it
)
6286 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6288 it
->face_id
= it
->saved_face_id
;
6290 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6291 That seemed totally bogus - so I changed it... */
6292 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6294 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6296 it
->c
= GLYPH_CODE_CHAR (gc
);
6297 it
->len
= CHAR_BYTES (it
->c
);
6299 /* The entry may contain a face id to use. Such a face id is
6300 the id of a Lisp face, not a realized face. A face id of
6301 zero means no face is specified. */
6302 if (it
->dpvec_face_id
>= 0)
6303 it
->face_id
= it
->dpvec_face_id
;
6306 int lface_id
= GLYPH_CODE_FACE (gc
);
6308 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6313 /* Display table entry is invalid. Return a space. */
6314 it
->c
= ' ', it
->len
= 1;
6316 /* Don't change position and object of the iterator here. They are
6317 still the values of the character that had this display table
6318 entry or was translated, and that's what we want. */
6319 it
->what
= IT_CHARACTER
;
6324 /* Load IT with the next display element from Lisp string IT->string.
6325 IT->current.string_pos is the current position within the string.
6326 If IT->current.overlay_string_index >= 0, the Lisp string is an
6330 next_element_from_string (struct it
*it
)
6332 struct text_pos position
;
6334 xassert (STRINGP (it
->string
));
6335 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6336 position
= it
->current
.string_pos
;
6338 /* Time to check for invisible text? */
6339 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6340 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6344 /* Since a handler may have changed IT->method, we must
6346 return GET_NEXT_DISPLAY_ELEMENT (it
);
6349 if (it
->current
.overlay_string_index
>= 0)
6351 /* Get the next character from an overlay string. In overlay
6352 strings, There is no field width or padding with spaces to
6354 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6359 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6360 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6361 && next_element_from_composition (it
))
6365 else if (STRING_MULTIBYTE (it
->string
))
6367 const unsigned char *s
= (SDATA (it
->string
)
6368 + IT_STRING_BYTEPOS (*it
));
6369 it
->c
= string_char_and_length (s
, &it
->len
);
6373 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6379 /* Get the next character from a Lisp string that is not an
6380 overlay string. Such strings come from the mode line, for
6381 example. We may have to pad with spaces, or truncate the
6382 string. See also next_element_from_c_string. */
6383 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6388 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6390 /* Pad with spaces. */
6391 it
->c
= ' ', it
->len
= 1;
6392 CHARPOS (position
) = BYTEPOS (position
) = -1;
6394 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6395 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6396 && next_element_from_composition (it
))
6400 else if (STRING_MULTIBYTE (it
->string
))
6402 const unsigned char *s
= (SDATA (it
->string
)
6403 + IT_STRING_BYTEPOS (*it
));
6404 it
->c
= string_char_and_length (s
, &it
->len
);
6408 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6413 /* Record what we have and where it came from. */
6414 it
->what
= IT_CHARACTER
;
6415 it
->object
= it
->string
;
6416 it
->position
= position
;
6421 /* Load IT with next display element from C string IT->s.
6422 IT->string_nchars is the maximum number of characters to return
6423 from the string. IT->end_charpos may be greater than
6424 IT->string_nchars when this function is called, in which case we
6425 may have to return padding spaces. Value is zero if end of string
6426 reached, including padding spaces. */
6429 next_element_from_c_string (struct it
*it
)
6434 it
->what
= IT_CHARACTER
;
6435 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6438 /* IT's position can be greater IT->string_nchars in case a field
6439 width or precision has been specified when the iterator was
6441 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6443 /* End of the game. */
6447 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6449 /* Pad with spaces. */
6450 it
->c
= ' ', it
->len
= 1;
6451 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6453 else if (it
->multibyte_p
)
6454 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6456 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6462 /* Set up IT to return characters from an ellipsis, if appropriate.
6463 The definition of the ellipsis glyphs may come from a display table
6464 entry. This function fills IT with the first glyph from the
6465 ellipsis if an ellipsis is to be displayed. */
6468 next_element_from_ellipsis (struct it
*it
)
6470 if (it
->selective_display_ellipsis_p
)
6471 setup_for_ellipsis (it
, it
->len
);
6474 /* The face at the current position may be different from the
6475 face we find after the invisible text. Remember what it
6476 was in IT->saved_face_id, and signal that it's there by
6477 setting face_before_selective_p. */
6478 it
->saved_face_id
= it
->face_id
;
6479 it
->method
= GET_FROM_BUFFER
;
6480 it
->object
= it
->w
->buffer
;
6481 reseat_at_next_visible_line_start (it
, 1);
6482 it
->face_before_selective_p
= 1;
6485 return GET_NEXT_DISPLAY_ELEMENT (it
);
6489 /* Deliver an image display element. The iterator IT is already
6490 filled with image information (done in handle_display_prop). Value
6495 next_element_from_image (struct it
*it
)
6497 it
->what
= IT_IMAGE
;
6498 it
->ignore_overlay_strings_at_pos_p
= 0;
6503 /* Fill iterator IT with next display element from a stretch glyph
6504 property. IT->object is the value of the text property. Value is
6508 next_element_from_stretch (struct it
*it
)
6510 it
->what
= IT_STRETCH
;
6514 /* Scan forward from CHARPOS in the current buffer, until we find a
6515 stop position > current IT's position. Then handle the stop
6516 position before that. This is called when we bump into a stop
6517 position while reordering bidirectional text. CHARPOS should be
6518 the last previously processed stop_pos (or BEGV, if none were
6519 processed yet) whose position is less that IT's current
6523 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6525 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6526 struct display_pos save_current
= it
->current
;
6527 struct text_pos save_position
= it
->position
;
6528 struct text_pos pos1
;
6529 EMACS_INT next_stop
;
6531 /* Scan in strict logical order. */
6535 it
->prev_stop
= charpos
;
6536 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6537 reseat_1 (it
, pos1
, 0);
6538 compute_stop_pos (it
);
6539 /* We must advance forward, right? */
6540 if (it
->stop_charpos
<= it
->prev_stop
)
6542 charpos
= it
->stop_charpos
;
6544 while (charpos
<= where_we_are
);
6546 next_stop
= it
->stop_charpos
;
6547 it
->stop_charpos
= it
->prev_stop
;
6549 it
->current
= save_current
;
6550 it
->position
= save_position
;
6552 it
->stop_charpos
= next_stop
;
6555 /* Load IT with the next display element from current_buffer. Value
6556 is zero if end of buffer reached. IT->stop_charpos is the next
6557 position at which to stop and check for text properties or buffer
6561 next_element_from_buffer (struct it
*it
)
6565 xassert (IT_CHARPOS (*it
) >= BEGV
);
6567 /* With bidi reordering, the character to display might not be the
6568 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6569 we were reseat()ed to a new buffer position, which is potentially
6570 a different paragraph. */
6571 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6573 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6574 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6575 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6577 /* Nothing to do, but reset the FIRST_ELT flag, like
6578 bidi_paragraph_init does, because we are not going to
6580 it
->bidi_it
.first_elt
= 0;
6582 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6583 /* FIXME: Should support all Unicode line separators. */
6584 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6585 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6587 /* If we are at the beginning of a line, we can produce the
6588 next element right away. */
6589 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6590 bidi_move_to_visually_next (&it
->bidi_it
);
6594 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6596 /* We need to prime the bidi iterator starting at the line's
6597 beginning, before we will be able to produce the next
6599 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6601 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6602 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6603 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6606 /* Now return to buffer position where we were asked to
6607 get the next display element, and produce that. */
6608 bidi_move_to_visually_next (&it
->bidi_it
);
6610 while (it
->bidi_it
.bytepos
!= orig_bytepos
6611 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6614 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6615 /* Adjust IT's position information to where we ended up. */
6616 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6617 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6618 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6620 EMACS_INT stop
= it
->end_charpos
;
6621 if (it
->bidi_it
.scan_dir
< 0)
6623 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6624 IT_BYTEPOS (*it
), stop
, Qnil
);
6628 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6630 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6632 int overlay_strings_follow_p
;
6634 /* End of the game, except when overlay strings follow that
6635 haven't been returned yet. */
6636 if (it
->overlay_strings_at_end_processed_p
)
6637 overlay_strings_follow_p
= 0;
6640 it
->overlay_strings_at_end_processed_p
= 1;
6641 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6644 if (overlay_strings_follow_p
)
6645 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6649 it
->position
= it
->current
.pos
;
6653 else if (!(!it
->bidi_p
6654 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6655 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6657 /* With bidi non-linear iteration, we could find ourselves
6658 far beyond the last computed stop_charpos, with several
6659 other stop positions in between that we missed. Scan
6660 them all now, in buffer's logical order, until we find
6661 and handle the last stop_charpos that precedes our
6662 current position. */
6663 handle_stop_backwards (it
, it
->stop_charpos
);
6664 return GET_NEXT_DISPLAY_ELEMENT (it
);
6670 /* Take note of the stop position we just moved across,
6671 for when we will move back across it. */
6672 it
->prev_stop
= it
->stop_charpos
;
6673 /* If we are at base paragraph embedding level, take
6674 note of the last stop position seen at this
6676 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6677 it
->base_level_stop
= it
->stop_charpos
;
6680 return GET_NEXT_DISPLAY_ELEMENT (it
);
6684 /* We can sometimes back up for reasons that have nothing
6685 to do with bidi reordering. E.g., compositions. The
6686 code below is only needed when we are above the base
6687 embedding level, so test for that explicitly. */
6688 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6689 && IT_CHARPOS (*it
) < it
->prev_stop
)
6691 if (it
->base_level_stop
<= 0)
6692 it
->base_level_stop
= BEGV
;
6693 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6695 handle_stop_backwards (it
, it
->base_level_stop
);
6696 return GET_NEXT_DISPLAY_ELEMENT (it
);
6700 /* No face changes, overlays etc. in sight, so just return a
6701 character from current_buffer. */
6705 /* Maybe run the redisplay end trigger hook. Performance note:
6706 This doesn't seem to cost measurable time. */
6707 if (it
->redisplay_end_trigger_charpos
6709 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6710 run_redisplay_end_trigger_hook (it
);
6712 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6713 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6715 && next_element_from_composition (it
))
6720 /* Get the next character, maybe multibyte. */
6721 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6722 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6723 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6725 it
->c
= *p
, it
->len
= 1;
6727 /* Record what we have and where it came from. */
6728 it
->what
= IT_CHARACTER
;
6729 it
->object
= it
->w
->buffer
;
6730 it
->position
= it
->current
.pos
;
6732 /* Normally we return the character found above, except when we
6733 really want to return an ellipsis for selective display. */
6738 /* A value of selective > 0 means hide lines indented more
6739 than that number of columns. */
6740 if (it
->selective
> 0
6741 && IT_CHARPOS (*it
) + 1 < ZV
6742 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6743 IT_BYTEPOS (*it
) + 1,
6744 (double) it
->selective
)) /* iftc */
6746 success_p
= next_element_from_ellipsis (it
);
6747 it
->dpvec_char_len
= -1;
6750 else if (it
->c
== '\r' && it
->selective
== -1)
6752 /* A value of selective == -1 means that everything from the
6753 CR to the end of the line is invisible, with maybe an
6754 ellipsis displayed for it. */
6755 success_p
= next_element_from_ellipsis (it
);
6756 it
->dpvec_char_len
= -1;
6761 /* Value is zero if end of buffer reached. */
6762 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6767 /* Run the redisplay end trigger hook for IT. */
6770 run_redisplay_end_trigger_hook (struct it
*it
)
6772 Lisp_Object args
[3];
6774 /* IT->glyph_row should be non-null, i.e. we should be actually
6775 displaying something, or otherwise we should not run the hook. */
6776 xassert (it
->glyph_row
);
6778 /* Set up hook arguments. */
6779 args
[0] = Qredisplay_end_trigger_functions
;
6780 args
[1] = it
->window
;
6781 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6782 it
->redisplay_end_trigger_charpos
= 0;
6784 /* Since we are *trying* to run these functions, don't try to run
6785 them again, even if they get an error. */
6786 it
->w
->redisplay_end_trigger
= Qnil
;
6787 Frun_hook_with_args (3, args
);
6789 /* Notice if it changed the face of the character we are on. */
6790 handle_face_prop (it
);
6794 /* Deliver a composition display element. Unlike the other
6795 next_element_from_XXX, this function is not registered in the array
6796 get_next_element[]. It is called from next_element_from_buffer and
6797 next_element_from_string when necessary. */
6800 next_element_from_composition (struct it
*it
)
6802 it
->what
= IT_COMPOSITION
;
6803 it
->len
= it
->cmp_it
.nbytes
;
6804 if (STRINGP (it
->string
))
6808 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6809 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6812 it
->position
= it
->current
.string_pos
;
6813 it
->object
= it
->string
;
6814 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6815 IT_STRING_BYTEPOS (*it
), it
->string
);
6821 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6822 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6825 if (it
->bidi_it
.new_paragraph
)
6826 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6827 /* Resync the bidi iterator with IT's new position.
6828 FIXME: this doesn't support bidirectional text. */
6829 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6830 bidi_move_to_visually_next (&it
->bidi_it
);
6834 it
->position
= it
->current
.pos
;
6835 it
->object
= it
->w
->buffer
;
6836 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6837 IT_BYTEPOS (*it
), Qnil
);
6844 /***********************************************************************
6845 Moving an iterator without producing glyphs
6846 ***********************************************************************/
6848 /* Check if iterator is at a position corresponding to a valid buffer
6849 position after some move_it_ call. */
6851 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6852 ((it)->method == GET_FROM_STRING \
6853 ? IT_STRING_CHARPOS (*it) == 0 \
6857 /* Move iterator IT to a specified buffer or X position within one
6858 line on the display without producing glyphs.
6860 OP should be a bit mask including some or all of these bits:
6861 MOVE_TO_X: Stop upon reaching x-position TO_X.
6862 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6863 Regardless of OP's value, stop upon reaching the end of the display line.
6865 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6866 This means, in particular, that TO_X includes window's horizontal
6869 The return value has several possible values that
6870 say what condition caused the scan to stop:
6872 MOVE_POS_MATCH_OR_ZV
6873 - when TO_POS or ZV was reached.
6876 -when TO_X was reached before TO_POS or ZV were reached.
6879 - when we reached the end of the display area and the line must
6883 - when we reached the end of the display area and the line is
6887 - when we stopped at a line end, i.e. a newline or a CR and selective
6890 static enum move_it_result
6891 move_it_in_display_line_to (struct it
*it
,
6892 EMACS_INT to_charpos
, int to_x
,
6893 enum move_operation_enum op
)
6895 enum move_it_result result
= MOVE_UNDEFINED
;
6896 struct glyph_row
*saved_glyph_row
;
6897 struct it wrap_it
, atpos_it
, atx_it
;
6899 enum it_method prev_method
= it
->method
;
6900 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6902 /* Don't produce glyphs in produce_glyphs. */
6903 saved_glyph_row
= it
->glyph_row
;
6904 it
->glyph_row
= NULL
;
6906 /* Use wrap_it to save a copy of IT wherever a word wrap could
6907 occur. Use atpos_it to save a copy of IT at the desired buffer
6908 position, if found, so that we can scan ahead and check if the
6909 word later overshoots the window edge. Use atx_it similarly, for
6915 #define BUFFER_POS_REACHED_P() \
6916 ((op & MOVE_TO_POS) != 0 \
6917 && BUFFERP (it->object) \
6918 && (IT_CHARPOS (*it) == to_charpos \
6919 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6920 && (it->method == GET_FROM_BUFFER \
6921 || (it->method == GET_FROM_DISPLAY_VECTOR \
6922 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6924 /* If there's a line-/wrap-prefix, handle it. */
6925 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6926 && it
->current_y
< it
->last_visible_y
)
6927 handle_line_prefix (it
);
6929 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6930 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6934 int x
, i
, ascent
= 0, descent
= 0;
6936 /* Utility macro to reset an iterator with x, ascent, and descent. */
6937 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6938 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6939 (IT)->max_descent = descent)
6941 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6943 if ((op
& MOVE_TO_POS
) != 0
6944 && BUFFERP (it
->object
)
6945 && it
->method
== GET_FROM_BUFFER
6946 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6948 && (prev_method
== GET_FROM_IMAGE
6949 || prev_method
== GET_FROM_STRETCH
)
6950 /* Passed TO_CHARPOS from left to right. */
6951 && ((prev_pos
< to_charpos
6952 && IT_CHARPOS (*it
) > to_charpos
)
6953 /* Passed TO_CHARPOS from right to left. */
6954 || (prev_pos
> to_charpos
6955 && IT_CHARPOS (*it
) < to_charpos
)))))
6957 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6959 result
= MOVE_POS_MATCH_OR_ZV
;
6962 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6963 /* If wrap_it is valid, the current position might be in a
6964 word that is wrapped. So, save the iterator in
6965 atpos_it and continue to see if wrapping happens. */
6969 prev_method
= it
->method
;
6970 if (it
->method
== GET_FROM_BUFFER
)
6971 prev_pos
= IT_CHARPOS (*it
);
6972 /* Stop when ZV reached.
6973 We used to stop here when TO_CHARPOS reached as well, but that is
6974 too soon if this glyph does not fit on this line. So we handle it
6975 explicitly below. */
6976 if (!get_next_display_element (it
))
6978 result
= MOVE_POS_MATCH_OR_ZV
;
6982 if (it
->line_wrap
== TRUNCATE
)
6984 if (BUFFER_POS_REACHED_P ())
6986 result
= MOVE_POS_MATCH_OR_ZV
;
6992 if (it
->line_wrap
== WORD_WRAP
)
6994 if (IT_DISPLAYING_WHITESPACE (it
))
6998 /* We have reached a glyph that follows one or more
6999 whitespace characters. If the position is
7000 already found, we are done. */
7001 if (atpos_it
.sp
>= 0)
7004 result
= MOVE_POS_MATCH_OR_ZV
;
7010 result
= MOVE_X_REACHED
;
7013 /* Otherwise, we can wrap here. */
7020 /* Remember the line height for the current line, in case
7021 the next element doesn't fit on the line. */
7022 ascent
= it
->max_ascent
;
7023 descent
= it
->max_descent
;
7025 /* The call to produce_glyphs will get the metrics of the
7026 display element IT is loaded with. Record the x-position
7027 before this display element, in case it doesn't fit on the
7031 PRODUCE_GLYPHS (it
);
7033 if (it
->area
!= TEXT_AREA
)
7035 set_iterator_to_next (it
, 1);
7036 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7037 SET_TEXT_POS (this_line_min_pos
,
7038 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7042 /* The number of glyphs we get back in IT->nglyphs will normally
7043 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7044 character on a terminal frame, or (iii) a line end. For the
7045 second case, IT->nglyphs - 1 padding glyphs will be present.
7046 (On X frames, there is only one glyph produced for a
7047 composite character.)
7049 The behavior implemented below means, for continuation lines,
7050 that as many spaces of a TAB as fit on the current line are
7051 displayed there. For terminal frames, as many glyphs of a
7052 multi-glyph character are displayed in the current line, too.
7053 This is what the old redisplay code did, and we keep it that
7054 way. Under X, the whole shape of a complex character must
7055 fit on the line or it will be completely displayed in the
7058 Note that both for tabs and padding glyphs, all glyphs have
7062 /* More than one glyph or glyph doesn't fit on line. All
7063 glyphs have the same width. */
7064 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7066 int x_before_this_char
= x
;
7067 int hpos_before_this_char
= it
->hpos
;
7069 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7071 new_x
= x
+ single_glyph_width
;
7073 /* We want to leave anything reaching TO_X to the caller. */
7074 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7076 if (BUFFER_POS_REACHED_P ())
7078 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7079 goto buffer_pos_reached
;
7080 if (atpos_it
.sp
< 0)
7083 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7088 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7091 result
= MOVE_X_REACHED
;
7097 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7102 if (/* Lines are continued. */
7103 it
->line_wrap
!= TRUNCATE
7104 && (/* And glyph doesn't fit on the line. */
7105 new_x
> it
->last_visible_x
7106 /* Or it fits exactly and we're on a window
7108 || (new_x
== it
->last_visible_x
7109 && FRAME_WINDOW_P (it
->f
))))
7111 if (/* IT->hpos == 0 means the very first glyph
7112 doesn't fit on the line, e.g. a wide image. */
7114 || (new_x
== it
->last_visible_x
7115 && FRAME_WINDOW_P (it
->f
)))
7118 it
->current_x
= new_x
;
7120 /* The character's last glyph just barely fits
7122 if (i
== it
->nglyphs
- 1)
7124 /* If this is the destination position,
7125 return a position *before* it in this row,
7126 now that we know it fits in this row. */
7127 if (BUFFER_POS_REACHED_P ())
7129 if (it
->line_wrap
!= WORD_WRAP
7132 it
->hpos
= hpos_before_this_char
;
7133 it
->current_x
= x_before_this_char
;
7134 result
= MOVE_POS_MATCH_OR_ZV
;
7137 if (it
->line_wrap
== WORD_WRAP
7141 atpos_it
.current_x
= x_before_this_char
;
7142 atpos_it
.hpos
= hpos_before_this_char
;
7146 set_iterator_to_next (it
, 1);
7147 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7148 SET_TEXT_POS (this_line_min_pos
,
7149 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7150 /* On graphical terminals, newlines may
7151 "overflow" into the fringe if
7152 overflow-newline-into-fringe is non-nil.
7153 On text-only terminals, newlines may
7154 overflow into the last glyph on the
7156 if (!FRAME_WINDOW_P (it
->f
)
7157 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7159 if (!get_next_display_element (it
))
7161 result
= MOVE_POS_MATCH_OR_ZV
;
7164 if (BUFFER_POS_REACHED_P ())
7166 if (ITERATOR_AT_END_OF_LINE_P (it
))
7167 result
= MOVE_POS_MATCH_OR_ZV
;
7169 result
= MOVE_LINE_CONTINUED
;
7172 if (ITERATOR_AT_END_OF_LINE_P (it
))
7174 result
= MOVE_NEWLINE_OR_CR
;
7181 IT_RESET_X_ASCENT_DESCENT (it
);
7183 if (wrap_it
.sp
>= 0)
7190 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7192 result
= MOVE_LINE_CONTINUED
;
7196 if (BUFFER_POS_REACHED_P ())
7198 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7199 goto buffer_pos_reached
;
7200 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7203 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7207 if (new_x
> it
->first_visible_x
)
7209 /* Glyph is visible. Increment number of glyphs that
7210 would be displayed. */
7215 if (result
!= MOVE_UNDEFINED
)
7218 else if (BUFFER_POS_REACHED_P ())
7221 IT_RESET_X_ASCENT_DESCENT (it
);
7222 result
= MOVE_POS_MATCH_OR_ZV
;
7225 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7227 /* Stop when TO_X specified and reached. This check is
7228 necessary here because of lines consisting of a line end,
7229 only. The line end will not produce any glyphs and we
7230 would never get MOVE_X_REACHED. */
7231 xassert (it
->nglyphs
== 0);
7232 result
= MOVE_X_REACHED
;
7236 /* Is this a line end? If yes, we're done. */
7237 if (ITERATOR_AT_END_OF_LINE_P (it
))
7239 result
= MOVE_NEWLINE_OR_CR
;
7243 if (it
->method
== GET_FROM_BUFFER
)
7244 prev_pos
= IT_CHARPOS (*it
);
7245 /* The current display element has been consumed. Advance
7247 set_iterator_to_next (it
, 1);
7248 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7249 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7251 /* Stop if lines are truncated and IT's current x-position is
7252 past the right edge of the window now. */
7253 if (it
->line_wrap
== TRUNCATE
7254 && it
->current_x
>= it
->last_visible_x
)
7256 if (!FRAME_WINDOW_P (it
->f
)
7257 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7259 if (!get_next_display_element (it
)
7260 || BUFFER_POS_REACHED_P ())
7262 result
= MOVE_POS_MATCH_OR_ZV
;
7265 if (ITERATOR_AT_END_OF_LINE_P (it
))
7267 result
= MOVE_NEWLINE_OR_CR
;
7271 result
= MOVE_LINE_TRUNCATED
;
7274 #undef IT_RESET_X_ASCENT_DESCENT
7277 #undef BUFFER_POS_REACHED_P
7279 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7280 restore the saved iterator. */
7281 if (atpos_it
.sp
>= 0)
7283 else if (atx_it
.sp
>= 0)
7288 /* Restore the iterator settings altered at the beginning of this
7290 it
->glyph_row
= saved_glyph_row
;
7294 /* For external use. */
7296 move_it_in_display_line (struct it
*it
,
7297 EMACS_INT to_charpos
, int to_x
,
7298 enum move_operation_enum op
)
7300 if (it
->line_wrap
== WORD_WRAP
7301 && (op
& MOVE_TO_X
))
7303 struct it save_it
= *it
;
7304 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7305 /* When word-wrap is on, TO_X may lie past the end
7306 of a wrapped line. Then it->current is the
7307 character on the next line, so backtrack to the
7308 space before the wrap point. */
7309 if (skip
== MOVE_LINE_CONTINUED
)
7311 int prev_x
= max (it
->current_x
- 1, 0);
7313 move_it_in_display_line_to
7314 (it
, -1, prev_x
, MOVE_TO_X
);
7318 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7322 /* Move IT forward until it satisfies one or more of the criteria in
7323 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7325 OP is a bit-mask that specifies where to stop, and in particular,
7326 which of those four position arguments makes a difference. See the
7327 description of enum move_operation_enum.
7329 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7330 screen line, this function will set IT to the next position >
7334 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7336 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7337 int line_height
, line_start_x
= 0, reached
= 0;
7341 if (op
& MOVE_TO_VPOS
)
7343 /* If no TO_CHARPOS and no TO_X specified, stop at the
7344 start of the line TO_VPOS. */
7345 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7347 if (it
->vpos
== to_vpos
)
7353 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7357 /* TO_VPOS >= 0 means stop at TO_X in the line at
7358 TO_VPOS, or at TO_POS, whichever comes first. */
7359 if (it
->vpos
== to_vpos
)
7365 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7367 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7372 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7374 /* We have reached TO_X but not in the line we want. */
7375 skip
= move_it_in_display_line_to (it
, to_charpos
,
7377 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7385 else if (op
& MOVE_TO_Y
)
7387 struct it it_backup
;
7389 if (it
->line_wrap
== WORD_WRAP
)
7392 /* TO_Y specified means stop at TO_X in the line containing
7393 TO_Y---or at TO_CHARPOS if this is reached first. The
7394 problem is that we can't really tell whether the line
7395 contains TO_Y before we have completely scanned it, and
7396 this may skip past TO_X. What we do is to first scan to
7399 If TO_X is not specified, use a TO_X of zero. The reason
7400 is to make the outcome of this function more predictable.
7401 If we didn't use TO_X == 0, we would stop at the end of
7402 the line which is probably not what a caller would expect
7404 skip
= move_it_in_display_line_to
7405 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7406 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7408 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7409 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7411 else if (skip
== MOVE_X_REACHED
)
7413 /* If TO_X was reached, we want to know whether TO_Y is
7414 in the line. We know this is the case if the already
7415 scanned glyphs make the line tall enough. Otherwise,
7416 we must check by scanning the rest of the line. */
7417 line_height
= it
->max_ascent
+ it
->max_descent
;
7418 if (to_y
>= it
->current_y
7419 && to_y
< it
->current_y
+ line_height
)
7425 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7426 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7428 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7429 line_height
= it
->max_ascent
+ it
->max_descent
;
7430 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7432 if (to_y
>= it
->current_y
7433 && to_y
< it
->current_y
+ line_height
)
7435 /* If TO_Y is in this line and TO_X was reached
7436 above, we scanned too far. We have to restore
7437 IT's settings to the ones before skipping. */
7444 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7450 /* Check whether TO_Y is in this line. */
7451 line_height
= it
->max_ascent
+ it
->max_descent
;
7452 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7454 if (to_y
>= it
->current_y
7455 && to_y
< it
->current_y
+ line_height
)
7457 /* When word-wrap is on, TO_X may lie past the end
7458 of a wrapped line. Then it->current is the
7459 character on the next line, so backtrack to the
7460 space before the wrap point. */
7461 if (skip
== MOVE_LINE_CONTINUED
7462 && it
->line_wrap
== WORD_WRAP
)
7464 int prev_x
= max (it
->current_x
- 1, 0);
7466 skip
= move_it_in_display_line_to
7467 (it
, -1, prev_x
, MOVE_TO_X
);
7476 else if (BUFFERP (it
->object
)
7477 && (it
->method
== GET_FROM_BUFFER
7478 || it
->method
== GET_FROM_STRETCH
)
7479 && IT_CHARPOS (*it
) >= to_charpos
)
7480 skip
= MOVE_POS_MATCH_OR_ZV
;
7482 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7486 case MOVE_POS_MATCH_OR_ZV
:
7490 case MOVE_NEWLINE_OR_CR
:
7491 set_iterator_to_next (it
, 1);
7492 it
->continuation_lines_width
= 0;
7495 case MOVE_LINE_TRUNCATED
:
7496 it
->continuation_lines_width
= 0;
7497 reseat_at_next_visible_line_start (it
, 0);
7498 if ((op
& MOVE_TO_POS
) != 0
7499 && IT_CHARPOS (*it
) > to_charpos
)
7506 case MOVE_LINE_CONTINUED
:
7507 /* For continued lines ending in a tab, some of the glyphs
7508 associated with the tab are displayed on the current
7509 line. Since it->current_x does not include these glyphs,
7510 we use it->last_visible_x instead. */
7513 it
->continuation_lines_width
+= it
->last_visible_x
;
7514 /* When moving by vpos, ensure that the iterator really
7515 advances to the next line (bug#847, bug#969). Fixme:
7516 do we need to do this in other circumstances? */
7517 if (it
->current_x
!= it
->last_visible_x
7518 && (op
& MOVE_TO_VPOS
)
7519 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7521 line_start_x
= it
->current_x
+ it
->pixel_width
7522 - it
->last_visible_x
;
7523 set_iterator_to_next (it
, 0);
7527 it
->continuation_lines_width
+= it
->current_x
;
7534 /* Reset/increment for the next run. */
7535 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7536 it
->current_x
= line_start_x
;
7539 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7541 last_height
= it
->max_ascent
+ it
->max_descent
;
7542 last_max_ascent
= it
->max_ascent
;
7543 it
->max_ascent
= it
->max_descent
= 0;
7548 /* On text terminals, we may stop at the end of a line in the middle
7549 of a multi-character glyph. If the glyph itself is continued,
7550 i.e. it is actually displayed on the next line, don't treat this
7551 stopping point as valid; move to the next line instead (unless
7552 that brings us offscreen). */
7553 if (!FRAME_WINDOW_P (it
->f
)
7555 && IT_CHARPOS (*it
) == to_charpos
7556 && it
->what
== IT_CHARACTER
7558 && it
->line_wrap
== WINDOW_WRAP
7559 && it
->current_x
== it
->last_visible_x
- 1
7562 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7564 it
->continuation_lines_width
+= it
->current_x
;
7565 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7566 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7568 last_height
= it
->max_ascent
+ it
->max_descent
;
7569 last_max_ascent
= it
->max_ascent
;
7572 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7576 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7578 If DY > 0, move IT backward at least that many pixels. DY = 0
7579 means move IT backward to the preceding line start or BEGV. This
7580 function may move over more than DY pixels if IT->current_y - DY
7581 ends up in the middle of a line; in this case IT->current_y will be
7582 set to the top of the line moved to. */
7585 move_it_vertically_backward (struct it
*it
, int dy
)
7589 EMACS_INT start_pos
;
7594 start_pos
= IT_CHARPOS (*it
);
7596 /* Estimate how many newlines we must move back. */
7597 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7599 /* Set the iterator's position that many lines back. */
7600 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7601 back_to_previous_visible_line_start (it
);
7603 /* Reseat the iterator here. When moving backward, we don't want
7604 reseat to skip forward over invisible text, set up the iterator
7605 to deliver from overlay strings at the new position etc. So,
7606 use reseat_1 here. */
7607 reseat_1 (it
, it
->current
.pos
, 1);
7609 /* We are now surely at a line start. */
7610 it
->current_x
= it
->hpos
= 0;
7611 it
->continuation_lines_width
= 0;
7613 /* Move forward and see what y-distance we moved. First move to the
7614 start of the next line so that we get its height. We need this
7615 height to be able to tell whether we reached the specified
7618 it2
.max_ascent
= it2
.max_descent
= 0;
7621 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7622 MOVE_TO_POS
| MOVE_TO_VPOS
);
7624 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7625 xassert (IT_CHARPOS (*it
) >= BEGV
);
7628 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7629 xassert (IT_CHARPOS (*it
) >= BEGV
);
7630 /* H is the actual vertical distance from the position in *IT
7631 and the starting position. */
7632 h
= it2
.current_y
- it
->current_y
;
7633 /* NLINES is the distance in number of lines. */
7634 nlines
= it2
.vpos
- it
->vpos
;
7636 /* Correct IT's y and vpos position
7637 so that they are relative to the starting point. */
7643 /* DY == 0 means move to the start of the screen line. The
7644 value of nlines is > 0 if continuation lines were involved. */
7646 move_it_by_lines (it
, nlines
, 1);
7650 /* The y-position we try to reach, relative to *IT.
7651 Note that H has been subtracted in front of the if-statement. */
7652 int target_y
= it
->current_y
+ h
- dy
;
7653 int y0
= it3
.current_y
;
7654 int y1
= line_bottom_y (&it3
);
7655 int line_height
= y1
- y0
;
7657 /* If we did not reach target_y, try to move further backward if
7658 we can. If we moved too far backward, try to move forward. */
7659 if (target_y
< it
->current_y
7660 /* This is heuristic. In a window that's 3 lines high, with
7661 a line height of 13 pixels each, recentering with point
7662 on the bottom line will try to move -39/2 = 19 pixels
7663 backward. Try to avoid moving into the first line. */
7664 && (it
->current_y
- target_y
7665 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7666 && IT_CHARPOS (*it
) > BEGV
)
7668 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7669 target_y
- it
->current_y
));
7670 dy
= it
->current_y
- target_y
;
7671 goto move_further_back
;
7673 else if (target_y
>= it
->current_y
+ line_height
7674 && IT_CHARPOS (*it
) < ZV
)
7676 /* Should move forward by at least one line, maybe more.
7678 Note: Calling move_it_by_lines can be expensive on
7679 terminal frames, where compute_motion is used (via
7680 vmotion) to do the job, when there are very long lines
7681 and truncate-lines is nil. That's the reason for
7682 treating terminal frames specially here. */
7684 if (!FRAME_WINDOW_P (it
->f
))
7685 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7690 move_it_by_lines (it
, 1, 1);
7692 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7699 /* Move IT by a specified amount of pixel lines DY. DY negative means
7700 move backwards. DY = 0 means move to start of screen line. At the
7701 end, IT will be on the start of a screen line. */
7704 move_it_vertically (struct it
*it
, int dy
)
7707 move_it_vertically_backward (it
, -dy
);
7710 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7711 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7712 MOVE_TO_POS
| MOVE_TO_Y
);
7713 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7715 /* If buffer ends in ZV without a newline, move to the start of
7716 the line to satisfy the post-condition. */
7717 if (IT_CHARPOS (*it
) == ZV
7719 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7720 move_it_by_lines (it
, 0, 0);
7725 /* Move iterator IT past the end of the text line it is in. */
7728 move_it_past_eol (struct it
*it
)
7730 enum move_it_result rc
;
7732 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7733 if (rc
== MOVE_NEWLINE_OR_CR
)
7734 set_iterator_to_next (it
, 0);
7738 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7739 negative means move up. DVPOS == 0 means move to the start of the
7740 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7741 NEED_Y_P is zero, IT->current_y will be left unchanged.
7743 Further optimization ideas: If we would know that IT->f doesn't use
7744 a face with proportional font, we could be faster for
7745 truncate-lines nil. */
7748 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7751 /* The commented-out optimization uses vmotion on terminals. This
7752 gives bad results, because elements like it->what, on which
7753 callers such as pos_visible_p rely, aren't updated. */
7754 /* struct position pos;
7755 if (!FRAME_WINDOW_P (it->f))
7757 struct text_pos textpos;
7759 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7760 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7761 reseat (it, textpos, 1);
7762 it->vpos += pos.vpos;
7763 it->current_y += pos.vpos;
7769 /* DVPOS == 0 means move to the start of the screen line. */
7770 move_it_vertically_backward (it
, 0);
7771 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7772 /* Let next call to line_bottom_y calculate real line height */
7777 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7778 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7779 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7784 EMACS_INT start_charpos
, i
;
7786 /* Start at the beginning of the screen line containing IT's
7787 position. This may actually move vertically backwards,
7788 in case of overlays, so adjust dvpos accordingly. */
7790 move_it_vertically_backward (it
, 0);
7793 /* Go back -DVPOS visible lines and reseat the iterator there. */
7794 start_charpos
= IT_CHARPOS (*it
);
7795 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7796 back_to_previous_visible_line_start (it
);
7797 reseat (it
, it
->current
.pos
, 1);
7799 /* Move further back if we end up in a string or an image. */
7800 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7802 /* First try to move to start of display line. */
7804 move_it_vertically_backward (it
, 0);
7806 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7808 /* If start of line is still in string or image,
7809 move further back. */
7810 back_to_previous_visible_line_start (it
);
7811 reseat (it
, it
->current
.pos
, 1);
7815 it
->current_x
= it
->hpos
= 0;
7817 /* Above call may have moved too far if continuation lines
7818 are involved. Scan forward and see if it did. */
7820 it2
.vpos
= it2
.current_y
= 0;
7821 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7822 it
->vpos
-= it2
.vpos
;
7823 it
->current_y
-= it2
.current_y
;
7824 it
->current_x
= it
->hpos
= 0;
7826 /* If we moved too far back, move IT some lines forward. */
7827 if (it2
.vpos
> -dvpos
)
7829 int delta
= it2
.vpos
+ dvpos
;
7831 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7832 /* Move back again if we got too far ahead. */
7833 if (IT_CHARPOS (*it
) >= start_charpos
)
7839 /* Return 1 if IT points into the middle of a display vector. */
7842 in_display_vector_p (struct it
*it
)
7844 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7845 && it
->current
.dpvec_index
> 0
7846 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7850 /***********************************************************************
7852 ***********************************************************************/
7855 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7859 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7861 Lisp_Object args
[3];
7862 Lisp_Object msg
, fmt
;
7865 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7868 /* Do nothing if called asynchronously. Inserting text into
7869 a buffer may call after-change-functions and alike and
7870 that would means running Lisp asynchronously. */
7871 if (handling_signal
)
7875 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7877 args
[0] = fmt
= build_string (format
);
7880 msg
= Fformat (3, args
);
7882 len
= SBYTES (msg
) + 1;
7883 SAFE_ALLOCA (buffer
, char *, len
);
7884 memcpy (buffer
, SDATA (msg
), len
);
7886 message_dolog (buffer
, len
- 1, 1, 0);
7893 /* Output a newline in the *Messages* buffer if "needs" one. */
7896 message_log_maybe_newline (void)
7898 if (message_log_need_newline
)
7899 message_dolog ("", 0, 1, 0);
7903 /* Add a string M of length NBYTES to the message log, optionally
7904 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7905 nonzero, means interpret the contents of M as multibyte. This
7906 function calls low-level routines in order to bypass text property
7907 hooks, etc. which might not be safe to run.
7909 This may GC (insert may run before/after change hooks),
7910 so the buffer M must NOT point to a Lisp string. */
7913 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7915 const unsigned char *msg
= (const unsigned char *) m
;
7917 if (!NILP (Vmemory_full
))
7920 if (!NILP (Vmessage_log_max
))
7922 struct buffer
*oldbuf
;
7923 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7924 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7925 EMACS_INT point_at_end
= 0;
7926 EMACS_INT zv_at_end
= 0;
7927 Lisp_Object old_deactivate_mark
, tem
;
7928 struct gcpro gcpro1
;
7930 old_deactivate_mark
= Vdeactivate_mark
;
7931 oldbuf
= current_buffer
;
7932 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7933 BVAR (current_buffer
, undo_list
) = Qt
;
7935 oldpoint
= message_dolog_marker1
;
7936 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7937 oldbegv
= message_dolog_marker2
;
7938 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7939 oldzv
= message_dolog_marker3
;
7940 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7941 GCPRO1 (old_deactivate_mark
);
7949 BEGV_BYTE
= BEG_BYTE
;
7952 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7954 /* Insert the string--maybe converting multibyte to single byte
7955 or vice versa, so that all the text fits the buffer. */
7957 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7963 /* Convert a multibyte string to single-byte
7964 for the *Message* buffer. */
7965 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7967 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7968 work
[0] = (ASCII_CHAR_P (c
)
7970 : multibyte_char_to_unibyte (c
, Qnil
));
7971 insert_1_both (work
, 1, 1, 1, 0, 0);
7974 else if (! multibyte
7975 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7979 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7980 /* Convert a single-byte string to multibyte
7981 for the *Message* buffer. */
7982 for (i
= 0; i
< nbytes
; i
++)
7985 MAKE_CHAR_MULTIBYTE (c
);
7986 char_bytes
= CHAR_STRING (c
, str
);
7987 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7991 insert_1 (m
, nbytes
, 1, 0, 0);
7995 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7996 unsigned long int dups
;
7997 insert_1 ("\n", 1, 1, 0, 0);
7999 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8001 this_bol_byte
= PT_BYTE
;
8003 /* See if this line duplicates the previous one.
8004 If so, combine duplicates. */
8007 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8009 prev_bol_byte
= PT_BYTE
;
8011 dups
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8012 this_bol
, this_bol_byte
);
8015 del_range_both (prev_bol
, prev_bol_byte
,
8016 this_bol
, this_bol_byte
, 0);
8022 /* If you change this format, don't forget to also
8023 change message_log_check_duplicate. */
8024 sprintf (dupstr
, " [%lu times]", dups
);
8025 duplen
= strlen (dupstr
);
8026 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8027 insert_1 (dupstr
, duplen
, 1, 0, 1);
8032 /* If we have more than the desired maximum number of lines
8033 in the *Messages* buffer now, delete the oldest ones.
8034 This is safe because we don't have undo in this buffer. */
8036 if (NATNUMP (Vmessage_log_max
))
8038 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8039 -XFASTINT (Vmessage_log_max
) - 1, 0);
8040 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8043 BEGV
= XMARKER (oldbegv
)->charpos
;
8044 BEGV_BYTE
= marker_byte_position (oldbegv
);
8053 ZV
= XMARKER (oldzv
)->charpos
;
8054 ZV_BYTE
= marker_byte_position (oldzv
);
8058 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8060 /* We can't do Fgoto_char (oldpoint) because it will run some
8062 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8063 XMARKER (oldpoint
)->bytepos
);
8066 unchain_marker (XMARKER (oldpoint
));
8067 unchain_marker (XMARKER (oldbegv
));
8068 unchain_marker (XMARKER (oldzv
));
8070 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8071 set_buffer_internal (oldbuf
);
8073 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8074 message_log_need_newline
= !nlflag
;
8075 Vdeactivate_mark
= old_deactivate_mark
;
8080 /* We are at the end of the buffer after just having inserted a newline.
8081 (Note: We depend on the fact we won't be crossing the gap.)
8082 Check to see if the most recent message looks a lot like the previous one.
8083 Return 0 if different, 1 if the new one should just replace it, or a
8084 value N > 1 if we should also append " [N times]". */
8086 static unsigned long int
8087 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8088 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8091 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8093 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8094 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8096 for (i
= 0; i
< len
; i
++)
8098 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8106 if (*p1
++ == ' ' && *p1
++ == '[')
8109 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8110 if (strncmp (pend
, " times]\n", 8) == 0)
8117 /* Display an echo area message M with a specified length of NBYTES
8118 bytes. The string may include null characters. If M is 0, clear
8119 out any existing message, and let the mini-buffer text show
8122 This may GC, so the buffer M must NOT point to a Lisp string. */
8125 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8127 /* First flush out any partial line written with print. */
8128 message_log_maybe_newline ();
8130 message_dolog (m
, nbytes
, 1, multibyte
);
8131 message2_nolog (m
, nbytes
, multibyte
);
8135 /* The non-logging counterpart of message2. */
8138 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8140 struct frame
*sf
= SELECTED_FRAME ();
8141 message_enable_multibyte
= multibyte
;
8143 if (FRAME_INITIAL_P (sf
))
8145 if (noninteractive_need_newline
)
8146 putc ('\n', stderr
);
8147 noninteractive_need_newline
= 0;
8149 fwrite (m
, nbytes
, 1, stderr
);
8150 if (cursor_in_echo_area
== 0)
8151 fprintf (stderr
, "\n");
8154 /* A null message buffer means that the frame hasn't really been
8155 initialized yet. Error messages get reported properly by
8156 cmd_error, so this must be just an informative message; toss it. */
8157 else if (INTERACTIVE
8158 && sf
->glyphs_initialized_p
8159 && FRAME_MESSAGE_BUF (sf
))
8161 Lisp_Object mini_window
;
8164 /* Get the frame containing the mini-buffer
8165 that the selected frame is using. */
8166 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8167 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8169 FRAME_SAMPLE_VISIBILITY (f
);
8170 if (FRAME_VISIBLE_P (sf
)
8171 && ! FRAME_VISIBLE_P (f
))
8172 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8176 set_message (m
, Qnil
, nbytes
, multibyte
);
8177 if (minibuffer_auto_raise
)
8178 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8181 clear_message (1, 1);
8183 do_pending_window_change (0);
8184 echo_area_display (1);
8185 do_pending_window_change (0);
8186 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8187 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8192 /* Display an echo area message M with a specified length of NBYTES
8193 bytes. The string may include null characters. If M is not a
8194 string, clear out any existing message, and let the mini-buffer
8197 This function cancels echoing. */
8200 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8202 struct gcpro gcpro1
;
8205 clear_message (1,1);
8208 /* First flush out any partial line written with print. */
8209 message_log_maybe_newline ();
8215 SAFE_ALLOCA (buffer
, char *, nbytes
);
8216 memcpy (buffer
, SDATA (m
), nbytes
);
8217 message_dolog (buffer
, nbytes
, 1, multibyte
);
8220 message3_nolog (m
, nbytes
, multibyte
);
8226 /* The non-logging version of message3.
8227 This does not cancel echoing, because it is used for echoing.
8228 Perhaps we need to make a separate function for echoing
8229 and make this cancel echoing. */
8232 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8234 struct frame
*sf
= SELECTED_FRAME ();
8235 message_enable_multibyte
= multibyte
;
8237 if (FRAME_INITIAL_P (sf
))
8239 if (noninteractive_need_newline
)
8240 putc ('\n', stderr
);
8241 noninteractive_need_newline
= 0;
8243 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8244 if (cursor_in_echo_area
== 0)
8245 fprintf (stderr
, "\n");
8248 /* A null message buffer means that the frame hasn't really been
8249 initialized yet. Error messages get reported properly by
8250 cmd_error, so this must be just an informative message; toss it. */
8251 else if (INTERACTIVE
8252 && sf
->glyphs_initialized_p
8253 && FRAME_MESSAGE_BUF (sf
))
8255 Lisp_Object mini_window
;
8259 /* Get the frame containing the mini-buffer
8260 that the selected frame is using. */
8261 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8262 frame
= XWINDOW (mini_window
)->frame
;
8265 FRAME_SAMPLE_VISIBILITY (f
);
8266 if (FRAME_VISIBLE_P (sf
)
8267 && !FRAME_VISIBLE_P (f
))
8268 Fmake_frame_visible (frame
);
8270 if (STRINGP (m
) && SCHARS (m
) > 0)
8272 set_message (NULL
, m
, nbytes
, multibyte
);
8273 if (minibuffer_auto_raise
)
8274 Fraise_frame (frame
);
8275 /* Assume we are not echoing.
8276 (If we are, echo_now will override this.) */
8277 echo_message_buffer
= Qnil
;
8280 clear_message (1, 1);
8282 do_pending_window_change (0);
8283 echo_area_display (1);
8284 do_pending_window_change (0);
8285 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8286 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8291 /* Display a null-terminated echo area message M. If M is 0, clear
8292 out any existing message, and let the mini-buffer text show through.
8294 The buffer M must continue to exist until after the echo area gets
8295 cleared or some other message gets displayed there. Do not pass
8296 text that is stored in a Lisp string. Do not pass text in a buffer
8297 that was alloca'd. */
8300 message1 (const char *m
)
8302 message2 (m
, (m
? strlen (m
) : 0), 0);
8306 /* The non-logging counterpart of message1. */
8309 message1_nolog (const char *m
)
8311 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8314 /* Display a message M which contains a single %s
8315 which gets replaced with STRING. */
8318 message_with_string (const char *m
, Lisp_Object string
, int log
)
8320 CHECK_STRING (string
);
8326 if (noninteractive_need_newline
)
8327 putc ('\n', stderr
);
8328 noninteractive_need_newline
= 0;
8329 fprintf (stderr
, m
, SDATA (string
));
8330 if (!cursor_in_echo_area
)
8331 fprintf (stderr
, "\n");
8335 else if (INTERACTIVE
)
8337 /* The frame whose minibuffer we're going to display the message on.
8338 It may be larger than the selected frame, so we need
8339 to use its buffer, not the selected frame's buffer. */
8340 Lisp_Object mini_window
;
8341 struct frame
*f
, *sf
= SELECTED_FRAME ();
8343 /* Get the frame containing the minibuffer
8344 that the selected frame is using. */
8345 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8346 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8348 /* A null message buffer means that the frame hasn't really been
8349 initialized yet. Error messages get reported properly by
8350 cmd_error, so this must be just an informative message; toss it. */
8351 if (FRAME_MESSAGE_BUF (f
))
8353 Lisp_Object args
[2], msg
;
8354 struct gcpro gcpro1
, gcpro2
;
8356 args
[0] = build_string (m
);
8357 args
[1] = msg
= string
;
8358 GCPRO2 (args
[0], msg
);
8361 msg
= Fformat (2, args
);
8364 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8366 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8370 /* Print should start at the beginning of the message
8371 buffer next time. */
8372 message_buf_print
= 0;
8378 /* Dump an informative message to the minibuf. If M is 0, clear out
8379 any existing message, and let the mini-buffer text show through. */
8382 vmessage (const char *m
, va_list ap
)
8388 if (noninteractive_need_newline
)
8389 putc ('\n', stderr
);
8390 noninteractive_need_newline
= 0;
8391 vfprintf (stderr
, m
, ap
);
8392 if (cursor_in_echo_area
== 0)
8393 fprintf (stderr
, "\n");
8397 else if (INTERACTIVE
)
8399 /* The frame whose mini-buffer we're going to display the message
8400 on. It may be larger than the selected frame, so we need to
8401 use its buffer, not the selected frame's buffer. */
8402 Lisp_Object mini_window
;
8403 struct frame
*f
, *sf
= SELECTED_FRAME ();
8405 /* Get the frame containing the mini-buffer
8406 that the selected frame is using. */
8407 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8408 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8410 /* A null message buffer means that the frame hasn't really been
8411 initialized yet. Error messages get reported properly by
8412 cmd_error, so this must be just an informative message; toss
8414 if (FRAME_MESSAGE_BUF (f
))
8420 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8421 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8423 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8428 /* Print should start at the beginning of the message
8429 buffer next time. */
8430 message_buf_print
= 0;
8436 message (const char *m
, ...)
8445 /* The non-logging version of message. */
8448 message_nolog (const char *m
, ...)
8450 Lisp_Object old_log_max
;
8453 old_log_max
= Vmessage_log_max
;
8454 Vmessage_log_max
= Qnil
;
8456 Vmessage_log_max
= old_log_max
;
8461 /* Display the current message in the current mini-buffer. This is
8462 only called from error handlers in process.c, and is not time
8466 update_echo_area (void)
8468 if (!NILP (echo_area_buffer
[0]))
8471 string
= Fcurrent_message ();
8472 message3 (string
, SBYTES (string
),
8473 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8478 /* Make sure echo area buffers in `echo_buffers' are live.
8479 If they aren't, make new ones. */
8482 ensure_echo_area_buffers (void)
8486 for (i
= 0; i
< 2; ++i
)
8487 if (!BUFFERP (echo_buffer
[i
])
8488 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8491 Lisp_Object old_buffer
;
8494 old_buffer
= echo_buffer
[i
];
8495 sprintf (name
, " *Echo Area %d*", i
);
8496 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8497 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8498 /* to force word wrap in echo area -
8499 it was decided to postpone this*/
8500 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8502 for (j
= 0; j
< 2; ++j
)
8503 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8504 echo_area_buffer
[j
] = echo_buffer
[i
];
8509 /* Call FN with args A1..A4 with either the current or last displayed
8510 echo_area_buffer as current buffer.
8512 WHICH zero means use the current message buffer
8513 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8514 from echo_buffer[] and clear it.
8516 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8517 suitable buffer from echo_buffer[] and clear it.
8519 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8520 that the current message becomes the last displayed one, make
8521 choose a suitable buffer for echo_area_buffer[0], and clear it.
8523 Value is what FN returns. */
8526 with_echo_area_buffer (struct window
*w
, int which
,
8527 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8528 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8531 int this_one
, the_other
, clear_buffer_p
, rc
;
8532 int count
= SPECPDL_INDEX ();
8534 /* If buffers aren't live, make new ones. */
8535 ensure_echo_area_buffers ();
8540 this_one
= 0, the_other
= 1;
8542 this_one
= 1, the_other
= 0;
8545 this_one
= 0, the_other
= 1;
8548 /* We need a fresh one in case the current echo buffer equals
8549 the one containing the last displayed echo area message. */
8550 if (!NILP (echo_area_buffer
[this_one
])
8551 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8552 echo_area_buffer
[this_one
] = Qnil
;
8555 /* Choose a suitable buffer from echo_buffer[] is we don't
8557 if (NILP (echo_area_buffer
[this_one
]))
8559 echo_area_buffer
[this_one
]
8560 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8561 ? echo_buffer
[the_other
]
8562 : echo_buffer
[this_one
]);
8566 buffer
= echo_area_buffer
[this_one
];
8568 /* Don't get confused by reusing the buffer used for echoing
8569 for a different purpose. */
8570 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8573 record_unwind_protect (unwind_with_echo_area_buffer
,
8574 with_echo_area_buffer_unwind_data (w
));
8576 /* Make the echo area buffer current. Note that for display
8577 purposes, it is not necessary that the displayed window's buffer
8578 == current_buffer, except for text property lookup. So, let's
8579 only set that buffer temporarily here without doing a full
8580 Fset_window_buffer. We must also change w->pointm, though,
8581 because otherwise an assertions in unshow_buffer fails, and Emacs
8583 set_buffer_internal_1 (XBUFFER (buffer
));
8587 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8590 BVAR (current_buffer
, undo_list
) = Qt
;
8591 BVAR (current_buffer
, read_only
) = Qnil
;
8592 specbind (Qinhibit_read_only
, Qt
);
8593 specbind (Qinhibit_modification_hooks
, Qt
);
8595 if (clear_buffer_p
&& Z
> BEG
)
8598 xassert (BEGV
>= BEG
);
8599 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8601 rc
= fn (a1
, a2
, a3
, a4
);
8603 xassert (BEGV
>= BEG
);
8604 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8606 unbind_to (count
, Qnil
);
8611 /* Save state that should be preserved around the call to the function
8612 FN called in with_echo_area_buffer. */
8615 with_echo_area_buffer_unwind_data (struct window
*w
)
8618 Lisp_Object vector
, tmp
;
8620 /* Reduce consing by keeping one vector in
8621 Vwith_echo_area_save_vector. */
8622 vector
= Vwith_echo_area_save_vector
;
8623 Vwith_echo_area_save_vector
= Qnil
;
8626 vector
= Fmake_vector (make_number (7), Qnil
);
8628 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8629 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8630 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8634 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8635 ASET (vector
, i
, w
->buffer
); ++i
;
8636 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8637 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8642 for (; i
< end
; ++i
)
8643 ASET (vector
, i
, Qnil
);
8646 xassert (i
== ASIZE (vector
));
8651 /* Restore global state from VECTOR which was created by
8652 with_echo_area_buffer_unwind_data. */
8655 unwind_with_echo_area_buffer (Lisp_Object vector
)
8657 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8658 Vdeactivate_mark
= AREF (vector
, 1);
8659 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8661 if (WINDOWP (AREF (vector
, 3)))
8664 Lisp_Object buffer
, charpos
, bytepos
;
8666 w
= XWINDOW (AREF (vector
, 3));
8667 buffer
= AREF (vector
, 4);
8668 charpos
= AREF (vector
, 5);
8669 bytepos
= AREF (vector
, 6);
8672 set_marker_both (w
->pointm
, buffer
,
8673 XFASTINT (charpos
), XFASTINT (bytepos
));
8676 Vwith_echo_area_save_vector
= vector
;
8681 /* Set up the echo area for use by print functions. MULTIBYTE_P
8682 non-zero means we will print multibyte. */
8685 setup_echo_area_for_printing (int multibyte_p
)
8687 /* If we can't find an echo area any more, exit. */
8688 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8691 ensure_echo_area_buffers ();
8693 if (!message_buf_print
)
8695 /* A message has been output since the last time we printed.
8696 Choose a fresh echo area buffer. */
8697 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8698 echo_area_buffer
[0] = echo_buffer
[1];
8700 echo_area_buffer
[0] = echo_buffer
[0];
8702 /* Switch to that buffer and clear it. */
8703 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8704 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8708 int count
= SPECPDL_INDEX ();
8709 specbind (Qinhibit_read_only
, Qt
);
8710 /* Note that undo recording is always disabled. */
8712 unbind_to (count
, Qnil
);
8714 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8716 /* Set up the buffer for the multibyteness we need. */
8718 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8719 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8721 /* Raise the frame containing the echo area. */
8722 if (minibuffer_auto_raise
)
8724 struct frame
*sf
= SELECTED_FRAME ();
8725 Lisp_Object mini_window
;
8726 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8727 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8730 message_log_maybe_newline ();
8731 message_buf_print
= 1;
8735 if (NILP (echo_area_buffer
[0]))
8737 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8738 echo_area_buffer
[0] = echo_buffer
[1];
8740 echo_area_buffer
[0] = echo_buffer
[0];
8743 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8745 /* Someone switched buffers between print requests. */
8746 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8747 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8753 /* Display an echo area message in window W. Value is non-zero if W's
8754 height is changed. If display_last_displayed_message_p is
8755 non-zero, display the message that was last displayed, otherwise
8756 display the current message. */
8759 display_echo_area (struct window
*w
)
8761 int i
, no_message_p
, window_height_changed_p
, count
;
8763 /* Temporarily disable garbage collections while displaying the echo
8764 area. This is done because a GC can print a message itself.
8765 That message would modify the echo area buffer's contents while a
8766 redisplay of the buffer is going on, and seriously confuse
8768 count
= inhibit_garbage_collection ();
8770 /* If there is no message, we must call display_echo_area_1
8771 nevertheless because it resizes the window. But we will have to
8772 reset the echo_area_buffer in question to nil at the end because
8773 with_echo_area_buffer will sets it to an empty buffer. */
8774 i
= display_last_displayed_message_p
? 1 : 0;
8775 no_message_p
= NILP (echo_area_buffer
[i
]);
8777 window_height_changed_p
8778 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8779 display_echo_area_1
,
8780 (EMACS_INT
) w
, Qnil
, 0, 0);
8783 echo_area_buffer
[i
] = Qnil
;
8785 unbind_to (count
, Qnil
);
8786 return window_height_changed_p
;
8790 /* Helper for display_echo_area. Display the current buffer which
8791 contains the current echo area message in window W, a mini-window,
8792 a pointer to which is passed in A1. A2..A4 are currently not used.
8793 Change the height of W so that all of the message is displayed.
8794 Value is non-zero if height of W was changed. */
8797 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8799 struct window
*w
= (struct window
*) a1
;
8801 struct text_pos start
;
8802 int window_height_changed_p
= 0;
8804 /* Do this before displaying, so that we have a large enough glyph
8805 matrix for the display. If we can't get enough space for the
8806 whole text, display the last N lines. That works by setting w->start. */
8807 window_height_changed_p
= resize_mini_window (w
, 0);
8809 /* Use the starting position chosen by resize_mini_window. */
8810 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8813 clear_glyph_matrix (w
->desired_matrix
);
8814 XSETWINDOW (window
, w
);
8815 try_window (window
, start
, 0);
8817 return window_height_changed_p
;
8821 /* Resize the echo area window to exactly the size needed for the
8822 currently displayed message, if there is one. If a mini-buffer
8823 is active, don't shrink it. */
8826 resize_echo_area_exactly (void)
8828 if (BUFFERP (echo_area_buffer
[0])
8829 && WINDOWP (echo_area_window
))
8831 struct window
*w
= XWINDOW (echo_area_window
);
8833 Lisp_Object resize_exactly
;
8835 if (minibuf_level
== 0)
8836 resize_exactly
= Qt
;
8838 resize_exactly
= Qnil
;
8840 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8841 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8844 ++windows_or_buffers_changed
;
8845 ++update_mode_lines
;
8846 redisplay_internal (0);
8852 /* Callback function for with_echo_area_buffer, when used from
8853 resize_echo_area_exactly. A1 contains a pointer to the window to
8854 resize, EXACTLY non-nil means resize the mini-window exactly to the
8855 size of the text displayed. A3 and A4 are not used. Value is what
8856 resize_mini_window returns. */
8859 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8861 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8865 /* Resize mini-window W to fit the size of its contents. EXACT_P
8866 means size the window exactly to the size needed. Otherwise, it's
8867 only enlarged until W's buffer is empty.
8869 Set W->start to the right place to begin display. If the whole
8870 contents fit, start at the beginning. Otherwise, start so as
8871 to make the end of the contents appear. This is particularly
8872 important for y-or-n-p, but seems desirable generally.
8874 Value is non-zero if the window height has been changed. */
8877 resize_mini_window (struct window
*w
, int exact_p
)
8879 struct frame
*f
= XFRAME (w
->frame
);
8880 int window_height_changed_p
= 0;
8882 xassert (MINI_WINDOW_P (w
));
8884 /* By default, start display at the beginning. */
8885 set_marker_both (w
->start
, w
->buffer
,
8886 BUF_BEGV (XBUFFER (w
->buffer
)),
8887 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8889 /* Don't resize windows while redisplaying a window; it would
8890 confuse redisplay functions when the size of the window they are
8891 displaying changes from under them. Such a resizing can happen,
8892 for instance, when which-func prints a long message while
8893 we are running fontification-functions. We're running these
8894 functions with safe_call which binds inhibit-redisplay to t. */
8895 if (!NILP (Vinhibit_redisplay
))
8898 /* Nil means don't try to resize. */
8899 if (NILP (Vresize_mini_windows
)
8900 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8903 if (!FRAME_MINIBUF_ONLY_P (f
))
8906 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8907 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8908 int height
, max_height
;
8909 int unit
= FRAME_LINE_HEIGHT (f
);
8910 struct text_pos start
;
8911 struct buffer
*old_current_buffer
= NULL
;
8913 if (current_buffer
!= XBUFFER (w
->buffer
))
8915 old_current_buffer
= current_buffer
;
8916 set_buffer_internal (XBUFFER (w
->buffer
));
8919 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8921 /* Compute the max. number of lines specified by the user. */
8922 if (FLOATP (Vmax_mini_window_height
))
8923 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8924 else if (INTEGERP (Vmax_mini_window_height
))
8925 max_height
= XINT (Vmax_mini_window_height
);
8927 max_height
= total_height
/ 4;
8929 /* Correct that max. height if it's bogus. */
8930 max_height
= max (1, max_height
);
8931 max_height
= min (total_height
, max_height
);
8933 /* Find out the height of the text in the window. */
8934 if (it
.line_wrap
== TRUNCATE
)
8939 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8940 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8941 height
= it
.current_y
+ last_height
;
8943 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8944 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8945 height
= (height
+ unit
- 1) / unit
;
8948 /* Compute a suitable window start. */
8949 if (height
> max_height
)
8951 height
= max_height
;
8952 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8953 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8954 start
= it
.current
.pos
;
8957 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8958 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8960 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8962 /* Let it grow only, until we display an empty message, in which
8963 case the window shrinks again. */
8964 if (height
> WINDOW_TOTAL_LINES (w
))
8966 int old_height
= WINDOW_TOTAL_LINES (w
);
8967 freeze_window_starts (f
, 1);
8968 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8969 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8971 else if (height
< WINDOW_TOTAL_LINES (w
)
8972 && (exact_p
|| BEGV
== ZV
))
8974 int old_height
= WINDOW_TOTAL_LINES (w
);
8975 freeze_window_starts (f
, 0);
8976 shrink_mini_window (w
);
8977 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8982 /* Always resize to exact size needed. */
8983 if (height
> WINDOW_TOTAL_LINES (w
))
8985 int old_height
= WINDOW_TOTAL_LINES (w
);
8986 freeze_window_starts (f
, 1);
8987 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8988 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8990 else if (height
< WINDOW_TOTAL_LINES (w
))
8992 int old_height
= WINDOW_TOTAL_LINES (w
);
8993 freeze_window_starts (f
, 0);
8994 shrink_mini_window (w
);
8998 freeze_window_starts (f
, 1);
8999 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9002 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9006 if (old_current_buffer
)
9007 set_buffer_internal (old_current_buffer
);
9010 return window_height_changed_p
;
9014 /* Value is the current message, a string, or nil if there is no
9018 current_message (void)
9022 if (!BUFFERP (echo_area_buffer
[0]))
9026 with_echo_area_buffer (0, 0, current_message_1
,
9027 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9029 echo_area_buffer
[0] = Qnil
;
9037 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9039 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9042 *msg
= make_buffer_string (BEG
, Z
, 1);
9049 /* Push the current message on Vmessage_stack for later restauration
9050 by restore_message. Value is non-zero if the current message isn't
9051 empty. This is a relatively infrequent operation, so it's not
9052 worth optimizing. */
9058 msg
= current_message ();
9059 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9060 return STRINGP (msg
);
9064 /* Restore message display from the top of Vmessage_stack. */
9067 restore_message (void)
9071 xassert (CONSP (Vmessage_stack
));
9072 msg
= XCAR (Vmessage_stack
);
9074 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9076 message3_nolog (msg
, 0, 0);
9080 /* Handler for record_unwind_protect calling pop_message. */
9083 pop_message_unwind (Lisp_Object dummy
)
9089 /* Pop the top-most entry off Vmessage_stack. */
9094 xassert (CONSP (Vmessage_stack
));
9095 Vmessage_stack
= XCDR (Vmessage_stack
);
9099 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9100 exits. If the stack is not empty, we have a missing pop_message
9104 check_message_stack (void)
9106 if (!NILP (Vmessage_stack
))
9111 /* Truncate to NCHARS what will be displayed in the echo area the next
9112 time we display it---but don't redisplay it now. */
9115 truncate_echo_area (EMACS_INT nchars
)
9118 echo_area_buffer
[0] = Qnil
;
9119 /* A null message buffer means that the frame hasn't really been
9120 initialized yet. Error messages get reported properly by
9121 cmd_error, so this must be just an informative message; toss it. */
9122 else if (!noninteractive
9124 && !NILP (echo_area_buffer
[0]))
9126 struct frame
*sf
= SELECTED_FRAME ();
9127 if (FRAME_MESSAGE_BUF (sf
))
9128 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9133 /* Helper function for truncate_echo_area. Truncate the current
9134 message to at most NCHARS characters. */
9137 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9139 if (BEG
+ nchars
< Z
)
9140 del_range (BEG
+ nchars
, Z
);
9142 echo_area_buffer
[0] = Qnil
;
9147 /* Set the current message to a substring of S or STRING.
9149 If STRING is a Lisp string, set the message to the first NBYTES
9150 bytes from STRING. NBYTES zero means use the whole string. If
9151 STRING is multibyte, the message will be displayed multibyte.
9153 If S is not null, set the message to the first LEN bytes of S. LEN
9154 zero means use the whole string. MULTIBYTE_P non-zero means S is
9155 multibyte. Display the message multibyte in that case.
9157 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9158 to t before calling set_message_1 (which calls insert).
9162 set_message (const char *s
, Lisp_Object string
,
9163 EMACS_INT nbytes
, int multibyte_p
)
9165 message_enable_multibyte
9166 = ((s
&& multibyte_p
)
9167 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9169 with_echo_area_buffer (0, -1, set_message_1
,
9170 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9171 message_buf_print
= 0;
9172 help_echo_showing_p
= 0;
9176 /* Helper function for set_message. Arguments have the same meaning
9177 as there, with A1 corresponding to S and A2 corresponding to STRING
9178 This function is called with the echo area buffer being
9182 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9184 const char *s
= (const char *) a1
;
9185 const unsigned char *msg
= (const unsigned char *) s
;
9186 Lisp_Object string
= a2
;
9188 /* Change multibyteness of the echo buffer appropriately. */
9189 if (message_enable_multibyte
9190 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9191 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9193 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9194 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9195 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9197 /* Insert new message at BEG. */
9198 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9200 if (STRINGP (string
))
9205 nbytes
= SBYTES (string
);
9206 nchars
= string_byte_to_char (string
, nbytes
);
9208 /* This function takes care of single/multibyte conversion. We
9209 just have to ensure that the echo area buffer has the right
9210 setting of enable_multibyte_characters. */
9211 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9216 nbytes
= strlen (s
);
9218 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9220 /* Convert from multi-byte to single-byte. */
9225 /* Convert a multibyte string to single-byte. */
9226 for (i
= 0; i
< nbytes
; i
+= n
)
9228 c
= string_char_and_length (msg
+ i
, &n
);
9229 work
[0] = (ASCII_CHAR_P (c
)
9231 : multibyte_char_to_unibyte (c
, Qnil
));
9232 insert_1_both (work
, 1, 1, 1, 0, 0);
9235 else if (!multibyte_p
9236 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9238 /* Convert from single-byte to multi-byte. */
9241 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9243 /* Convert a single-byte string to multibyte. */
9244 for (i
= 0; i
< nbytes
; i
++)
9247 MAKE_CHAR_MULTIBYTE (c
);
9248 n
= CHAR_STRING (c
, str
);
9249 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9253 insert_1 (s
, nbytes
, 1, 0, 0);
9260 /* Clear messages. CURRENT_P non-zero means clear the current
9261 message. LAST_DISPLAYED_P non-zero means clear the message
9265 clear_message (int current_p
, int last_displayed_p
)
9269 echo_area_buffer
[0] = Qnil
;
9270 message_cleared_p
= 1;
9273 if (last_displayed_p
)
9274 echo_area_buffer
[1] = Qnil
;
9276 message_buf_print
= 0;
9279 /* Clear garbaged frames.
9281 This function is used where the old redisplay called
9282 redraw_garbaged_frames which in turn called redraw_frame which in
9283 turn called clear_frame. The call to clear_frame was a source of
9284 flickering. I believe a clear_frame is not necessary. It should
9285 suffice in the new redisplay to invalidate all current matrices,
9286 and ensure a complete redisplay of all windows. */
9289 clear_garbaged_frames (void)
9293 Lisp_Object tail
, frame
;
9294 int changed_count
= 0;
9296 FOR_EACH_FRAME (tail
, frame
)
9298 struct frame
*f
= XFRAME (frame
);
9300 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9304 Fredraw_frame (frame
);
9305 f
->force_flush_display_p
= 1;
9307 clear_current_matrices (f
);
9316 ++windows_or_buffers_changed
;
9321 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9322 is non-zero update selected_frame. Value is non-zero if the
9323 mini-windows height has been changed. */
9326 echo_area_display (int update_frame_p
)
9328 Lisp_Object mini_window
;
9331 int window_height_changed_p
= 0;
9332 struct frame
*sf
= SELECTED_FRAME ();
9334 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9335 w
= XWINDOW (mini_window
);
9336 f
= XFRAME (WINDOW_FRAME (w
));
9338 /* Don't display if frame is invisible or not yet initialized. */
9339 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9342 #ifdef HAVE_WINDOW_SYSTEM
9343 /* When Emacs starts, selected_frame may be the initial terminal
9344 frame. If we let this through, a message would be displayed on
9346 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9348 #endif /* HAVE_WINDOW_SYSTEM */
9350 /* Redraw garbaged frames. */
9352 clear_garbaged_frames ();
9354 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9356 echo_area_window
= mini_window
;
9357 window_height_changed_p
= display_echo_area (w
);
9358 w
->must_be_updated_p
= 1;
9360 /* Update the display, unless called from redisplay_internal.
9361 Also don't update the screen during redisplay itself. The
9362 update will happen at the end of redisplay, and an update
9363 here could cause confusion. */
9364 if (update_frame_p
&& !redisplaying_p
)
9368 /* If the display update has been interrupted by pending
9369 input, update mode lines in the frame. Due to the
9370 pending input, it might have been that redisplay hasn't
9371 been called, so that mode lines above the echo area are
9372 garbaged. This looks odd, so we prevent it here. */
9373 if (!display_completed
)
9374 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9376 if (window_height_changed_p
9377 /* Don't do this if Emacs is shutting down. Redisplay
9378 needs to run hooks. */
9379 && !NILP (Vrun_hooks
))
9381 /* Must update other windows. Likewise as in other
9382 cases, don't let this update be interrupted by
9384 int count
= SPECPDL_INDEX ();
9385 specbind (Qredisplay_dont_pause
, Qt
);
9386 windows_or_buffers_changed
= 1;
9387 redisplay_internal (0);
9388 unbind_to (count
, Qnil
);
9390 else if (FRAME_WINDOW_P (f
) && n
== 0)
9392 /* Window configuration is the same as before.
9393 Can do with a display update of the echo area,
9394 unless we displayed some mode lines. */
9395 update_single_window (w
, 1);
9396 FRAME_RIF (f
)->flush_display (f
);
9399 update_frame (f
, 1, 1);
9401 /* If cursor is in the echo area, make sure that the next
9402 redisplay displays the minibuffer, so that the cursor will
9403 be replaced with what the minibuffer wants. */
9404 if (cursor_in_echo_area
)
9405 ++windows_or_buffers_changed
;
9408 else if (!EQ (mini_window
, selected_window
))
9409 windows_or_buffers_changed
++;
9411 /* Last displayed message is now the current message. */
9412 echo_area_buffer
[1] = echo_area_buffer
[0];
9413 /* Inform read_char that we're not echoing. */
9414 echo_message_buffer
= Qnil
;
9416 /* Prevent redisplay optimization in redisplay_internal by resetting
9417 this_line_start_pos. This is done because the mini-buffer now
9418 displays the message instead of its buffer text. */
9419 if (EQ (mini_window
, selected_window
))
9420 CHARPOS (this_line_start_pos
) = 0;
9422 return window_height_changed_p
;
9427 /***********************************************************************
9428 Mode Lines and Frame Titles
9429 ***********************************************************************/
9431 /* A buffer for constructing non-propertized mode-line strings and
9432 frame titles in it; allocated from the heap in init_xdisp and
9433 resized as needed in store_mode_line_noprop_char. */
9435 static char *mode_line_noprop_buf
;
9437 /* The buffer's end, and a current output position in it. */
9439 static char *mode_line_noprop_buf_end
;
9440 static char *mode_line_noprop_ptr
;
9442 #define MODE_LINE_NOPROP_LEN(start) \
9443 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9446 MODE_LINE_DISPLAY
= 0,
9452 /* Alist that caches the results of :propertize.
9453 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9454 static Lisp_Object mode_line_proptrans_alist
;
9456 /* List of strings making up the mode-line. */
9457 static Lisp_Object mode_line_string_list
;
9459 /* Base face property when building propertized mode line string. */
9460 static Lisp_Object mode_line_string_face
;
9461 static Lisp_Object mode_line_string_face_prop
;
9464 /* Unwind data for mode line strings */
9466 static Lisp_Object Vmode_line_unwind_vector
;
9469 format_mode_line_unwind_data (struct buffer
*obuf
,
9473 Lisp_Object vector
, tmp
;
9475 /* Reduce consing by keeping one vector in
9476 Vwith_echo_area_save_vector. */
9477 vector
= Vmode_line_unwind_vector
;
9478 Vmode_line_unwind_vector
= Qnil
;
9481 vector
= Fmake_vector (make_number (8), Qnil
);
9483 ASET (vector
, 0, make_number (mode_line_target
));
9484 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9485 ASET (vector
, 2, mode_line_string_list
);
9486 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9487 ASET (vector
, 4, mode_line_string_face
);
9488 ASET (vector
, 5, mode_line_string_face_prop
);
9491 XSETBUFFER (tmp
, obuf
);
9494 ASET (vector
, 6, tmp
);
9495 ASET (vector
, 7, owin
);
9501 unwind_format_mode_line (Lisp_Object vector
)
9503 mode_line_target
= XINT (AREF (vector
, 0));
9504 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9505 mode_line_string_list
= AREF (vector
, 2);
9506 if (! EQ (AREF (vector
, 3), Qt
))
9507 mode_line_proptrans_alist
= AREF (vector
, 3);
9508 mode_line_string_face
= AREF (vector
, 4);
9509 mode_line_string_face_prop
= AREF (vector
, 5);
9511 if (!NILP (AREF (vector
, 7)))
9512 /* Select window before buffer, since it may change the buffer. */
9513 Fselect_window (AREF (vector
, 7), Qt
);
9515 if (!NILP (AREF (vector
, 6)))
9517 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9518 ASET (vector
, 6, Qnil
);
9521 Vmode_line_unwind_vector
= vector
;
9526 /* Store a single character C for the frame title in mode_line_noprop_buf.
9527 Re-allocate mode_line_noprop_buf if necessary. */
9530 store_mode_line_noprop_char (char c
)
9532 /* If output position has reached the end of the allocated buffer,
9533 double the buffer's size. */
9534 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9536 int len
= MODE_LINE_NOPROP_LEN (0);
9537 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9538 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9539 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9540 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9543 *mode_line_noprop_ptr
++ = c
;
9547 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9548 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9549 characters that yield more columns than PRECISION; PRECISION <= 0
9550 means copy the whole string. Pad with spaces until FIELD_WIDTH
9551 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9552 pad. Called from display_mode_element when it is used to build a
9556 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9558 const unsigned char *str
= (const unsigned char *) string
;
9560 EMACS_INT dummy
, nbytes
;
9562 /* Copy at most PRECISION chars from STR. */
9563 nbytes
= strlen (string
);
9564 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9566 store_mode_line_noprop_char (*str
++);
9568 /* Fill up with spaces until FIELD_WIDTH reached. */
9569 while (field_width
> 0
9572 store_mode_line_noprop_char (' ');
9579 /***********************************************************************
9581 ***********************************************************************/
9583 #ifdef HAVE_WINDOW_SYSTEM
9585 /* Set the title of FRAME, if it has changed. The title format is
9586 Vicon_title_format if FRAME is iconified, otherwise it is
9587 frame_title_format. */
9590 x_consider_frame_title (Lisp_Object frame
)
9592 struct frame
*f
= XFRAME (frame
);
9594 if (FRAME_WINDOW_P (f
)
9595 || FRAME_MINIBUF_ONLY_P (f
)
9596 || f
->explicit_name
)
9598 /* Do we have more than one visible frame on this X display? */
9605 int count
= SPECPDL_INDEX ();
9607 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9609 Lisp_Object other_frame
= XCAR (tail
);
9610 struct frame
*tf
= XFRAME (other_frame
);
9613 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9614 && !FRAME_MINIBUF_ONLY_P (tf
)
9615 && !EQ (other_frame
, tip_frame
)
9616 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9620 /* Set global variable indicating that multiple frames exist. */
9621 multiple_frames
= CONSP (tail
);
9623 /* Switch to the buffer of selected window of the frame. Set up
9624 mode_line_target so that display_mode_element will output into
9625 mode_line_noprop_buf; then display the title. */
9626 record_unwind_protect (unwind_format_mode_line
,
9627 format_mode_line_unwind_data
9628 (current_buffer
, selected_window
, 0));
9630 Fselect_window (f
->selected_window
, Qt
);
9631 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9632 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9634 mode_line_target
= MODE_LINE_TITLE
;
9635 title_start
= MODE_LINE_NOPROP_LEN (0);
9636 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9637 NULL
, DEFAULT_FACE_ID
);
9638 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9639 len
= MODE_LINE_NOPROP_LEN (title_start
);
9640 title
= mode_line_noprop_buf
+ title_start
;
9641 unbind_to (count
, Qnil
);
9643 /* Set the title only if it's changed. This avoids consing in
9644 the common case where it hasn't. (If it turns out that we've
9645 already wasted too much time by walking through the list with
9646 display_mode_element, then we might need to optimize at a
9647 higher level than this.) */
9648 if (! STRINGP (f
->name
)
9649 || SBYTES (f
->name
) != len
9650 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9651 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9655 #endif /* not HAVE_WINDOW_SYSTEM */
9660 /***********************************************************************
9662 ***********************************************************************/
9665 /* Prepare for redisplay by updating menu-bar item lists when
9666 appropriate. This can call eval. */
9669 prepare_menu_bars (void)
9672 struct gcpro gcpro1
, gcpro2
;
9674 Lisp_Object tooltip_frame
;
9676 #ifdef HAVE_WINDOW_SYSTEM
9677 tooltip_frame
= tip_frame
;
9679 tooltip_frame
= Qnil
;
9682 /* Update all frame titles based on their buffer names, etc. We do
9683 this before the menu bars so that the buffer-menu will show the
9684 up-to-date frame titles. */
9685 #ifdef HAVE_WINDOW_SYSTEM
9686 if (windows_or_buffers_changed
|| update_mode_lines
)
9688 Lisp_Object tail
, frame
;
9690 FOR_EACH_FRAME (tail
, frame
)
9693 if (!EQ (frame
, tooltip_frame
)
9694 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9695 x_consider_frame_title (frame
);
9698 #endif /* HAVE_WINDOW_SYSTEM */
9700 /* Update the menu bar item lists, if appropriate. This has to be
9701 done before any actual redisplay or generation of display lines. */
9702 all_windows
= (update_mode_lines
9703 || buffer_shared
> 1
9704 || windows_or_buffers_changed
);
9707 Lisp_Object tail
, frame
;
9708 int count
= SPECPDL_INDEX ();
9709 /* 1 means that update_menu_bar has run its hooks
9710 so any further calls to update_menu_bar shouldn't do so again. */
9711 int menu_bar_hooks_run
= 0;
9713 record_unwind_save_match_data ();
9715 FOR_EACH_FRAME (tail
, frame
)
9719 /* Ignore tooltip frame. */
9720 if (EQ (frame
, tooltip_frame
))
9723 /* If a window on this frame changed size, report that to
9724 the user and clear the size-change flag. */
9725 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9727 Lisp_Object functions
;
9729 /* Clear flag first in case we get an error below. */
9730 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9731 functions
= Vwindow_size_change_functions
;
9732 GCPRO2 (tail
, functions
);
9734 while (CONSP (functions
))
9736 if (!EQ (XCAR (functions
), Qt
))
9737 call1 (XCAR (functions
), frame
);
9738 functions
= XCDR (functions
);
9744 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9745 #ifdef HAVE_WINDOW_SYSTEM
9746 update_tool_bar (f
, 0);
9749 if (windows_or_buffers_changed
9751 ns_set_doc_edited (f
, Fbuffer_modified_p
9752 (XWINDOW (f
->selected_window
)->buffer
));
9757 unbind_to (count
, Qnil
);
9761 struct frame
*sf
= SELECTED_FRAME ();
9762 update_menu_bar (sf
, 1, 0);
9763 #ifdef HAVE_WINDOW_SYSTEM
9764 update_tool_bar (sf
, 1);
9770 /* Update the menu bar item list for frame F. This has to be done
9771 before we start to fill in any display lines, because it can call
9774 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9776 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9777 already ran the menu bar hooks for this redisplay, so there
9778 is no need to run them again. The return value is the
9779 updated value of this flag, to pass to the next call. */
9782 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9785 register struct window
*w
;
9787 /* If called recursively during a menu update, do nothing. This can
9788 happen when, for instance, an activate-menubar-hook causes a
9790 if (inhibit_menubar_update
)
9793 window
= FRAME_SELECTED_WINDOW (f
);
9794 w
= XWINDOW (window
);
9796 if (FRAME_WINDOW_P (f
)
9798 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9799 || defined (HAVE_NS) || defined (USE_GTK)
9800 FRAME_EXTERNAL_MENU_BAR (f
)
9802 FRAME_MENU_BAR_LINES (f
) > 0
9804 : FRAME_MENU_BAR_LINES (f
) > 0)
9806 /* If the user has switched buffers or windows, we need to
9807 recompute to reflect the new bindings. But we'll
9808 recompute when update_mode_lines is set too; that means
9809 that people can use force-mode-line-update to request
9810 that the menu bar be recomputed. The adverse effect on
9811 the rest of the redisplay algorithm is about the same as
9812 windows_or_buffers_changed anyway. */
9813 if (windows_or_buffers_changed
9814 /* This used to test w->update_mode_line, but we believe
9815 there is no need to recompute the menu in that case. */
9816 || update_mode_lines
9817 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9818 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9819 != !NILP (w
->last_had_star
))
9820 || ((!NILP (Vtransient_mark_mode
)
9821 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9822 != !NILP (w
->region_showing
)))
9824 struct buffer
*prev
= current_buffer
;
9825 int count
= SPECPDL_INDEX ();
9827 specbind (Qinhibit_menubar_update
, Qt
);
9829 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9830 if (save_match_data
)
9831 record_unwind_save_match_data ();
9832 if (NILP (Voverriding_local_map_menu_flag
))
9834 specbind (Qoverriding_terminal_local_map
, Qnil
);
9835 specbind (Qoverriding_local_map
, Qnil
);
9840 /* Run the Lucid hook. */
9841 safe_run_hooks (Qactivate_menubar_hook
);
9843 /* If it has changed current-menubar from previous value,
9844 really recompute the menu-bar from the value. */
9845 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9846 call0 (Qrecompute_lucid_menubar
);
9848 safe_run_hooks (Qmenu_bar_update_hook
);
9853 XSETFRAME (Vmenu_updating_frame
, f
);
9854 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9856 /* Redisplay the menu bar in case we changed it. */
9857 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9858 || defined (HAVE_NS) || defined (USE_GTK)
9859 if (FRAME_WINDOW_P (f
))
9861 #if defined (HAVE_NS)
9862 /* All frames on Mac OS share the same menubar. So only
9863 the selected frame should be allowed to set it. */
9864 if (f
== SELECTED_FRAME ())
9866 set_frame_menubar (f
, 0, 0);
9869 /* On a terminal screen, the menu bar is an ordinary screen
9870 line, and this makes it get updated. */
9871 w
->update_mode_line
= Qt
;
9872 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9873 /* In the non-toolkit version, the menu bar is an ordinary screen
9874 line, and this makes it get updated. */
9875 w
->update_mode_line
= Qt
;
9876 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9878 unbind_to (count
, Qnil
);
9879 set_buffer_internal_1 (prev
);
9888 /***********************************************************************
9890 ***********************************************************************/
9892 #ifdef HAVE_WINDOW_SYSTEM
9895 Nominal cursor position -- where to draw output.
9896 HPOS and VPOS are window relative glyph matrix coordinates.
9897 X and Y are window relative pixel coordinates. */
9899 struct cursor_pos output_cursor
;
9903 Set the global variable output_cursor to CURSOR. All cursor
9904 positions are relative to updated_window. */
9907 set_output_cursor (struct cursor_pos
*cursor
)
9909 output_cursor
.hpos
= cursor
->hpos
;
9910 output_cursor
.vpos
= cursor
->vpos
;
9911 output_cursor
.x
= cursor
->x
;
9912 output_cursor
.y
= cursor
->y
;
9917 Set a nominal cursor position.
9919 HPOS and VPOS are column/row positions in a window glyph matrix. X
9920 and Y are window text area relative pixel positions.
9922 If this is done during an update, updated_window will contain the
9923 window that is being updated and the position is the future output
9924 cursor position for that window. If updated_window is null, use
9925 selected_window and display the cursor at the given position. */
9928 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9932 /* If updated_window is not set, work on selected_window. */
9936 w
= XWINDOW (selected_window
);
9938 /* Set the output cursor. */
9939 output_cursor
.hpos
= hpos
;
9940 output_cursor
.vpos
= vpos
;
9941 output_cursor
.x
= x
;
9942 output_cursor
.y
= y
;
9944 /* If not called as part of an update, really display the cursor.
9945 This will also set the cursor position of W. */
9946 if (updated_window
== NULL
)
9949 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9950 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9951 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9956 #endif /* HAVE_WINDOW_SYSTEM */
9959 /***********************************************************************
9961 ***********************************************************************/
9963 #ifdef HAVE_WINDOW_SYSTEM
9965 /* Where the mouse was last time we reported a mouse event. */
9967 FRAME_PTR last_mouse_frame
;
9969 /* Tool-bar item index of the item on which a mouse button was pressed
9972 int last_tool_bar_item
;
9976 update_tool_bar_unwind (Lisp_Object frame
)
9978 selected_frame
= frame
;
9982 /* Update the tool-bar item list for frame F. This has to be done
9983 before we start to fill in any display lines. Called from
9984 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9985 and restore it here. */
9988 update_tool_bar (struct frame
*f
, int save_match_data
)
9990 #if defined (USE_GTK) || defined (HAVE_NS)
9991 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9993 int do_update
= WINDOWP (f
->tool_bar_window
)
9994 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10002 window
= FRAME_SELECTED_WINDOW (f
);
10003 w
= XWINDOW (window
);
10005 /* If the user has switched buffers or windows, we need to
10006 recompute to reflect the new bindings. But we'll
10007 recompute when update_mode_lines is set too; that means
10008 that people can use force-mode-line-update to request
10009 that the menu bar be recomputed. The adverse effect on
10010 the rest of the redisplay algorithm is about the same as
10011 windows_or_buffers_changed anyway. */
10012 if (windows_or_buffers_changed
10013 || !NILP (w
->update_mode_line
)
10014 || update_mode_lines
10015 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10016 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10017 != !NILP (w
->last_had_star
))
10018 || ((!NILP (Vtransient_mark_mode
)
10019 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10020 != !NILP (w
->region_showing
)))
10022 struct buffer
*prev
= current_buffer
;
10023 int count
= SPECPDL_INDEX ();
10024 Lisp_Object frame
, new_tool_bar
;
10025 int new_n_tool_bar
;
10026 struct gcpro gcpro1
;
10028 /* Set current_buffer to the buffer of the selected
10029 window of the frame, so that we get the right local
10031 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10033 /* Save match data, if we must. */
10034 if (save_match_data
)
10035 record_unwind_save_match_data ();
10037 /* Make sure that we don't accidentally use bogus keymaps. */
10038 if (NILP (Voverriding_local_map_menu_flag
))
10040 specbind (Qoverriding_terminal_local_map
, Qnil
);
10041 specbind (Qoverriding_local_map
, Qnil
);
10044 GCPRO1 (new_tool_bar
);
10046 /* We must temporarily set the selected frame to this frame
10047 before calling tool_bar_items, because the calculation of
10048 the tool-bar keymap uses the selected frame (see
10049 `tool-bar-make-keymap' in tool-bar.el). */
10050 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10051 XSETFRAME (frame
, f
);
10052 selected_frame
= frame
;
10054 /* Build desired tool-bar items from keymaps. */
10055 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10058 /* Redisplay the tool-bar if we changed it. */
10059 if (new_n_tool_bar
!= f
->n_tool_bar_items
10060 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10062 /* Redisplay that happens asynchronously due to an expose event
10063 may access f->tool_bar_items. Make sure we update both
10064 variables within BLOCK_INPUT so no such event interrupts. */
10066 f
->tool_bar_items
= new_tool_bar
;
10067 f
->n_tool_bar_items
= new_n_tool_bar
;
10068 w
->update_mode_line
= Qt
;
10074 unbind_to (count
, Qnil
);
10075 set_buffer_internal_1 (prev
);
10081 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10082 F's desired tool-bar contents. F->tool_bar_items must have
10083 been set up previously by calling prepare_menu_bars. */
10086 build_desired_tool_bar_string (struct frame
*f
)
10088 int i
, size
, size_needed
;
10089 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10090 Lisp_Object image
, plist
, props
;
10092 image
= plist
= props
= Qnil
;
10093 GCPRO3 (image
, plist
, props
);
10095 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10096 Otherwise, make a new string. */
10098 /* The size of the string we might be able to reuse. */
10099 size
= (STRINGP (f
->desired_tool_bar_string
)
10100 ? SCHARS (f
->desired_tool_bar_string
)
10103 /* We need one space in the string for each image. */
10104 size_needed
= f
->n_tool_bar_items
;
10106 /* Reuse f->desired_tool_bar_string, if possible. */
10107 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10108 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10109 make_number (' '));
10112 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10113 Fremove_text_properties (make_number (0), make_number (size
),
10114 props
, f
->desired_tool_bar_string
);
10117 /* Put a `display' property on the string for the images to display,
10118 put a `menu_item' property on tool-bar items with a value that
10119 is the index of the item in F's tool-bar item vector. */
10120 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10122 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10124 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10125 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10126 int hmargin
, vmargin
, relief
, idx
, end
;
10128 /* If image is a vector, choose the image according to the
10130 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10131 if (VECTORP (image
))
10135 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10136 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10139 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10140 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10142 xassert (ASIZE (image
) >= idx
);
10143 image
= AREF (image
, idx
);
10148 /* Ignore invalid image specifications. */
10149 if (!valid_image_p (image
))
10152 /* Display the tool-bar button pressed, or depressed. */
10153 plist
= Fcopy_sequence (XCDR (image
));
10155 /* Compute margin and relief to draw. */
10156 relief
= (tool_bar_button_relief
>= 0
10157 ? tool_bar_button_relief
10158 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10159 hmargin
= vmargin
= relief
;
10161 if (INTEGERP (Vtool_bar_button_margin
)
10162 && XINT (Vtool_bar_button_margin
) > 0)
10164 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10165 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10167 else if (CONSP (Vtool_bar_button_margin
))
10169 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10170 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10171 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10173 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10174 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10175 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10178 if (auto_raise_tool_bar_buttons_p
)
10180 /* Add a `:relief' property to the image spec if the item is
10184 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10191 /* If image is selected, display it pressed, i.e. with a
10192 negative relief. If it's not selected, display it with a
10194 plist
= Fplist_put (plist
, QCrelief
,
10196 ? make_number (-relief
)
10197 : make_number (relief
)));
10202 /* Put a margin around the image. */
10203 if (hmargin
|| vmargin
)
10205 if (hmargin
== vmargin
)
10206 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10208 plist
= Fplist_put (plist
, QCmargin
,
10209 Fcons (make_number (hmargin
),
10210 make_number (vmargin
)));
10213 /* If button is not enabled, and we don't have special images
10214 for the disabled state, make the image appear disabled by
10215 applying an appropriate algorithm to it. */
10216 if (!enabled_p
&& idx
< 0)
10217 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10219 /* Put a `display' text property on the string for the image to
10220 display. Put a `menu-item' property on the string that gives
10221 the start of this item's properties in the tool-bar items
10223 image
= Fcons (Qimage
, plist
);
10224 props
= list4 (Qdisplay
, image
,
10225 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10227 /* Let the last image hide all remaining spaces in the tool bar
10228 string. The string can be longer than needed when we reuse a
10229 previous string. */
10230 if (i
+ 1 == f
->n_tool_bar_items
)
10231 end
= SCHARS (f
->desired_tool_bar_string
);
10234 Fadd_text_properties (make_number (i
), make_number (end
),
10235 props
, f
->desired_tool_bar_string
);
10243 /* Display one line of the tool-bar of frame IT->f.
10245 HEIGHT specifies the desired height of the tool-bar line.
10246 If the actual height of the glyph row is less than HEIGHT, the
10247 row's height is increased to HEIGHT, and the icons are centered
10248 vertically in the new height.
10250 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10251 count a final empty row in case the tool-bar width exactly matches
10256 display_tool_bar_line (struct it
*it
, int height
)
10258 struct glyph_row
*row
= it
->glyph_row
;
10259 int max_x
= it
->last_visible_x
;
10260 struct glyph
*last
;
10262 prepare_desired_row (row
);
10263 row
->y
= it
->current_y
;
10265 /* Note that this isn't made use of if the face hasn't a box,
10266 so there's no need to check the face here. */
10267 it
->start_of_box_run_p
= 1;
10269 while (it
->current_x
< max_x
)
10271 int x
, n_glyphs_before
, i
, nglyphs
;
10272 struct it it_before
;
10274 /* Get the next display element. */
10275 if (!get_next_display_element (it
))
10277 /* Don't count empty row if we are counting needed tool-bar lines. */
10278 if (height
< 0 && !it
->hpos
)
10283 /* Produce glyphs. */
10284 n_glyphs_before
= row
->used
[TEXT_AREA
];
10287 PRODUCE_GLYPHS (it
);
10289 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10291 x
= it_before
.current_x
;
10292 while (i
< nglyphs
)
10294 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10296 if (x
+ glyph
->pixel_width
> max_x
)
10298 /* Glyph doesn't fit on line. Backtrack. */
10299 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10301 /* If this is the only glyph on this line, it will never fit on the
10302 tool-bar, so skip it. But ensure there is at least one glyph,
10303 so we don't accidentally disable the tool-bar. */
10304 if (n_glyphs_before
== 0
10305 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10311 x
+= glyph
->pixel_width
;
10315 /* Stop at line ends. */
10316 if (ITERATOR_AT_END_OF_LINE_P (it
))
10319 set_iterator_to_next (it
, 1);
10324 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10326 /* Use default face for the border below the tool bar.
10328 FIXME: When auto-resize-tool-bars is grow-only, there is
10329 no additional border below the possibly empty tool-bar lines.
10330 So to make the extra empty lines look "normal", we have to
10331 use the tool-bar face for the border too. */
10332 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10333 it
->face_id
= DEFAULT_FACE_ID
;
10335 extend_face_to_end_of_line (it
);
10336 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10337 last
->right_box_line_p
= 1;
10338 if (last
== row
->glyphs
[TEXT_AREA
])
10339 last
->left_box_line_p
= 1;
10341 /* Make line the desired height and center it vertically. */
10342 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10344 /* Don't add more than one line height. */
10345 height
%= FRAME_LINE_HEIGHT (it
->f
);
10346 it
->max_ascent
+= height
/ 2;
10347 it
->max_descent
+= (height
+ 1) / 2;
10350 compute_line_metrics (it
);
10352 /* If line is empty, make it occupy the rest of the tool-bar. */
10353 if (!row
->displays_text_p
)
10355 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10356 row
->visible_height
= row
->height
;
10357 row
->ascent
= row
->phys_ascent
= 0;
10358 row
->extra_line_spacing
= 0;
10361 row
->full_width_p
= 1;
10362 row
->continued_p
= 0;
10363 row
->truncated_on_left_p
= 0;
10364 row
->truncated_on_right_p
= 0;
10366 it
->current_x
= it
->hpos
= 0;
10367 it
->current_y
+= row
->height
;
10373 /* Max tool-bar height. */
10375 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10376 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10378 /* Value is the number of screen lines needed to make all tool-bar
10379 items of frame F visible. The number of actual rows needed is
10380 returned in *N_ROWS if non-NULL. */
10383 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10385 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10387 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10388 the desired matrix, so use (unused) mode-line row as temporary row to
10389 avoid destroying the first tool-bar row. */
10390 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10392 /* Initialize an iterator for iteration over
10393 F->desired_tool_bar_string in the tool-bar window of frame F. */
10394 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10395 it
.first_visible_x
= 0;
10396 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10397 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10399 while (!ITERATOR_AT_END_P (&it
))
10401 clear_glyph_row (temp_row
);
10402 it
.glyph_row
= temp_row
;
10403 display_tool_bar_line (&it
, -1);
10405 clear_glyph_row (temp_row
);
10407 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10409 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10411 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10415 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10417 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10418 (Lisp_Object frame
)
10425 frame
= selected_frame
;
10427 CHECK_FRAME (frame
);
10428 f
= XFRAME (frame
);
10430 if (WINDOWP (f
->tool_bar_window
)
10431 || (w
= XWINDOW (f
->tool_bar_window
),
10432 WINDOW_TOTAL_LINES (w
) > 0))
10434 update_tool_bar (f
, 1);
10435 if (f
->n_tool_bar_items
)
10437 build_desired_tool_bar_string (f
);
10438 nlines
= tool_bar_lines_needed (f
, NULL
);
10442 return make_number (nlines
);
10446 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10447 height should be changed. */
10450 redisplay_tool_bar (struct frame
*f
)
10454 struct glyph_row
*row
;
10456 #if defined (USE_GTK) || defined (HAVE_NS)
10457 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10458 update_frame_tool_bar (f
);
10462 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10463 do anything. This means you must start with tool-bar-lines
10464 non-zero to get the auto-sizing effect. Or in other words, you
10465 can turn off tool-bars by specifying tool-bar-lines zero. */
10466 if (!WINDOWP (f
->tool_bar_window
)
10467 || (w
= XWINDOW (f
->tool_bar_window
),
10468 WINDOW_TOTAL_LINES (w
) == 0))
10471 /* Set up an iterator for the tool-bar window. */
10472 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10473 it
.first_visible_x
= 0;
10474 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10475 row
= it
.glyph_row
;
10477 /* Build a string that represents the contents of the tool-bar. */
10478 build_desired_tool_bar_string (f
);
10479 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10481 if (f
->n_tool_bar_rows
== 0)
10485 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10486 nlines
!= WINDOW_TOTAL_LINES (w
)))
10489 int old_height
= WINDOW_TOTAL_LINES (w
);
10491 XSETFRAME (frame
, f
);
10492 Fmodify_frame_parameters (frame
,
10493 Fcons (Fcons (Qtool_bar_lines
,
10494 make_number (nlines
)),
10496 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10498 clear_glyph_matrix (w
->desired_matrix
);
10499 fonts_changed_p
= 1;
10505 /* Display as many lines as needed to display all tool-bar items. */
10507 if (f
->n_tool_bar_rows
> 0)
10509 int border
, rows
, height
, extra
;
10511 if (INTEGERP (Vtool_bar_border
))
10512 border
= XINT (Vtool_bar_border
);
10513 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10514 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10515 else if (EQ (Vtool_bar_border
, Qborder_width
))
10516 border
= f
->border_width
;
10522 rows
= f
->n_tool_bar_rows
;
10523 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10524 extra
= it
.last_visible_y
- border
- height
* rows
;
10526 while (it
.current_y
< it
.last_visible_y
)
10529 if (extra
> 0 && rows
-- > 0)
10531 h
= (extra
+ rows
- 1) / rows
;
10534 display_tool_bar_line (&it
, height
+ h
);
10539 while (it
.current_y
< it
.last_visible_y
)
10540 display_tool_bar_line (&it
, 0);
10543 /* It doesn't make much sense to try scrolling in the tool-bar
10544 window, so don't do it. */
10545 w
->desired_matrix
->no_scrolling_p
= 1;
10546 w
->must_be_updated_p
= 1;
10548 if (!NILP (Vauto_resize_tool_bars
))
10550 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10551 int change_height_p
= 0;
10553 /* If we couldn't display everything, change the tool-bar's
10554 height if there is room for more. */
10555 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10556 && it
.current_y
< max_tool_bar_height
)
10557 change_height_p
= 1;
10559 row
= it
.glyph_row
- 1;
10561 /* If there are blank lines at the end, except for a partially
10562 visible blank line at the end that is smaller than
10563 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10564 if (!row
->displays_text_p
10565 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10566 change_height_p
= 1;
10568 /* If row displays tool-bar items, but is partially visible,
10569 change the tool-bar's height. */
10570 if (row
->displays_text_p
10571 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10572 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10573 change_height_p
= 1;
10575 /* Resize windows as needed by changing the `tool-bar-lines'
10576 frame parameter. */
10577 if (change_height_p
)
10580 int old_height
= WINDOW_TOTAL_LINES (w
);
10582 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10584 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10585 && !f
->minimize_tool_bar_window_p
)
10586 ? (nlines
> old_height
)
10587 : (nlines
!= old_height
));
10588 f
->minimize_tool_bar_window_p
= 0;
10590 if (change_height_p
)
10592 XSETFRAME (frame
, f
);
10593 Fmodify_frame_parameters (frame
,
10594 Fcons (Fcons (Qtool_bar_lines
,
10595 make_number (nlines
)),
10597 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10599 clear_glyph_matrix (w
->desired_matrix
);
10600 f
->n_tool_bar_rows
= nrows
;
10601 fonts_changed_p
= 1;
10608 f
->minimize_tool_bar_window_p
= 0;
10613 /* Get information about the tool-bar item which is displayed in GLYPH
10614 on frame F. Return in *PROP_IDX the index where tool-bar item
10615 properties start in F->tool_bar_items. Value is zero if
10616 GLYPH doesn't display a tool-bar item. */
10619 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10625 /* This function can be called asynchronously, which means we must
10626 exclude any possibility that Fget_text_property signals an
10628 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10629 charpos
= max (0, charpos
);
10631 /* Get the text property `menu-item' at pos. The value of that
10632 property is the start index of this item's properties in
10633 F->tool_bar_items. */
10634 prop
= Fget_text_property (make_number (charpos
),
10635 Qmenu_item
, f
->current_tool_bar_string
);
10636 if (INTEGERP (prop
))
10638 *prop_idx
= XINT (prop
);
10648 /* Get information about the tool-bar item at position X/Y on frame F.
10649 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10650 the current matrix of the tool-bar window of F, or NULL if not
10651 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10652 item in F->tool_bar_items. Value is
10654 -1 if X/Y is not on a tool-bar item
10655 0 if X/Y is on the same item that was highlighted before.
10659 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10660 int *hpos
, int *vpos
, int *prop_idx
)
10662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10663 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10666 /* Find the glyph under X/Y. */
10667 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10668 if (*glyph
== NULL
)
10671 /* Get the start of this tool-bar item's properties in
10672 f->tool_bar_items. */
10673 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10676 /* Is mouse on the highlighted item? */
10677 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10678 && *vpos
>= hlinfo
->mouse_face_beg_row
10679 && *vpos
<= hlinfo
->mouse_face_end_row
10680 && (*vpos
> hlinfo
->mouse_face_beg_row
10681 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10682 && (*vpos
< hlinfo
->mouse_face_end_row
10683 || *hpos
< hlinfo
->mouse_face_end_col
10684 || hlinfo
->mouse_face_past_end
))
10692 Handle mouse button event on the tool-bar of frame F, at
10693 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10694 0 for button release. MODIFIERS is event modifiers for button
10698 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10699 unsigned int modifiers
)
10701 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10702 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10703 int hpos
, vpos
, prop_idx
;
10704 struct glyph
*glyph
;
10705 Lisp_Object enabled_p
;
10707 /* If not on the highlighted tool-bar item, return. */
10708 frame_to_window_pixel_xy (w
, &x
, &y
);
10709 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10712 /* If item is disabled, do nothing. */
10713 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10714 if (NILP (enabled_p
))
10719 /* Show item in pressed state. */
10720 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10721 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10722 last_tool_bar_item
= prop_idx
;
10726 Lisp_Object key
, frame
;
10727 struct input_event event
;
10728 EVENT_INIT (event
);
10730 /* Show item in released state. */
10731 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10732 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10734 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10736 XSETFRAME (frame
, f
);
10737 event
.kind
= TOOL_BAR_EVENT
;
10738 event
.frame_or_window
= frame
;
10740 kbd_buffer_store_event (&event
);
10742 event
.kind
= TOOL_BAR_EVENT
;
10743 event
.frame_or_window
= frame
;
10745 event
.modifiers
= modifiers
;
10746 kbd_buffer_store_event (&event
);
10747 last_tool_bar_item
= -1;
10752 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10753 tool-bar window-relative coordinates X/Y. Called from
10754 note_mouse_highlight. */
10757 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10759 Lisp_Object window
= f
->tool_bar_window
;
10760 struct window
*w
= XWINDOW (window
);
10761 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10762 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10764 struct glyph
*glyph
;
10765 struct glyph_row
*row
;
10767 Lisp_Object enabled_p
;
10769 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10770 int mouse_down_p
, rc
;
10772 /* Function note_mouse_highlight is called with negative X/Y
10773 values when mouse moves outside of the frame. */
10774 if (x
<= 0 || y
<= 0)
10776 clear_mouse_face (hlinfo
);
10780 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10783 /* Not on tool-bar item. */
10784 clear_mouse_face (hlinfo
);
10788 /* On same tool-bar item as before. */
10789 goto set_help_echo
;
10791 clear_mouse_face (hlinfo
);
10793 /* Mouse is down, but on different tool-bar item? */
10794 mouse_down_p
= (dpyinfo
->grabbed
10795 && f
== last_mouse_frame
10796 && FRAME_LIVE_P (f
));
10798 && last_tool_bar_item
!= prop_idx
)
10801 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10802 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10804 /* If tool-bar item is not enabled, don't highlight it. */
10805 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10806 if (!NILP (enabled_p
))
10808 /* Compute the x-position of the glyph. In front and past the
10809 image is a space. We include this in the highlighted area. */
10810 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10811 for (i
= x
= 0; i
< hpos
; ++i
)
10812 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10814 /* Record this as the current active region. */
10815 hlinfo
->mouse_face_beg_col
= hpos
;
10816 hlinfo
->mouse_face_beg_row
= vpos
;
10817 hlinfo
->mouse_face_beg_x
= x
;
10818 hlinfo
->mouse_face_beg_y
= row
->y
;
10819 hlinfo
->mouse_face_past_end
= 0;
10821 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10822 hlinfo
->mouse_face_end_row
= vpos
;
10823 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10824 hlinfo
->mouse_face_end_y
= row
->y
;
10825 hlinfo
->mouse_face_window
= window
;
10826 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10828 /* Display it as active. */
10829 show_mouse_face (hlinfo
, draw
);
10830 hlinfo
->mouse_face_image_state
= draw
;
10835 /* Set help_echo_string to a help string to display for this tool-bar item.
10836 XTread_socket does the rest. */
10837 help_echo_object
= help_echo_window
= Qnil
;
10838 help_echo_pos
= -1;
10839 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10840 if (NILP (help_echo_string
))
10841 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10844 #endif /* HAVE_WINDOW_SYSTEM */
10848 /************************************************************************
10849 Horizontal scrolling
10850 ************************************************************************/
10852 static int hscroll_window_tree (Lisp_Object
);
10853 static int hscroll_windows (Lisp_Object
);
10855 /* For all leaf windows in the window tree rooted at WINDOW, set their
10856 hscroll value so that PT is (i) visible in the window, and (ii) so
10857 that it is not within a certain margin at the window's left and
10858 right border. Value is non-zero if any window's hscroll has been
10862 hscroll_window_tree (Lisp_Object window
)
10864 int hscrolled_p
= 0;
10865 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10866 int hscroll_step_abs
= 0;
10867 double hscroll_step_rel
= 0;
10869 if (hscroll_relative_p
)
10871 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10872 if (hscroll_step_rel
< 0)
10874 hscroll_relative_p
= 0;
10875 hscroll_step_abs
= 0;
10878 else if (INTEGERP (Vhscroll_step
))
10880 hscroll_step_abs
= XINT (Vhscroll_step
);
10881 if (hscroll_step_abs
< 0)
10882 hscroll_step_abs
= 0;
10885 hscroll_step_abs
= 0;
10887 while (WINDOWP (window
))
10889 struct window
*w
= XWINDOW (window
);
10891 if (WINDOWP (w
->hchild
))
10892 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10893 else if (WINDOWP (w
->vchild
))
10894 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10895 else if (w
->cursor
.vpos
>= 0)
10898 int text_area_width
;
10899 struct glyph_row
*current_cursor_row
10900 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10901 struct glyph_row
*desired_cursor_row
10902 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10903 struct glyph_row
*cursor_row
10904 = (desired_cursor_row
->enabled_p
10905 ? desired_cursor_row
10906 : current_cursor_row
);
10908 text_area_width
= window_box_width (w
, TEXT_AREA
);
10910 /* Scroll when cursor is inside this scroll margin. */
10911 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10913 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10914 && ((XFASTINT (w
->hscroll
)
10915 && w
->cursor
.x
<= h_margin
)
10916 || (cursor_row
->enabled_p
10917 && cursor_row
->truncated_on_right_p
10918 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10922 struct buffer
*saved_current_buffer
;
10926 /* Find point in a display of infinite width. */
10927 saved_current_buffer
= current_buffer
;
10928 current_buffer
= XBUFFER (w
->buffer
);
10930 if (w
== XWINDOW (selected_window
))
10934 pt
= marker_position (w
->pointm
);
10935 pt
= max (BEGV
, pt
);
10939 /* Move iterator to pt starting at cursor_row->start in
10940 a line with infinite width. */
10941 init_to_row_start (&it
, w
, cursor_row
);
10942 it
.last_visible_x
= INFINITY
;
10943 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10944 current_buffer
= saved_current_buffer
;
10946 /* Position cursor in window. */
10947 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10948 hscroll
= max (0, (it
.current_x
10949 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10950 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10951 : (text_area_width
/ 2))))
10952 / FRAME_COLUMN_WIDTH (it
.f
);
10953 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10955 if (hscroll_relative_p
)
10956 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10959 wanted_x
= text_area_width
10960 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10963 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10967 if (hscroll_relative_p
)
10968 wanted_x
= text_area_width
* hscroll_step_rel
10971 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10974 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10976 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10978 /* Don't call Fset_window_hscroll if value hasn't
10979 changed because it will prevent redisplay
10981 if (XFASTINT (w
->hscroll
) != hscroll
)
10983 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10984 w
->hscroll
= make_number (hscroll
);
10993 /* Value is non-zero if hscroll of any leaf window has been changed. */
10994 return hscrolled_p
;
10998 /* Set hscroll so that cursor is visible and not inside horizontal
10999 scroll margins for all windows in the tree rooted at WINDOW. See
11000 also hscroll_window_tree above. Value is non-zero if any window's
11001 hscroll has been changed. If it has, desired matrices on the frame
11002 of WINDOW are cleared. */
11005 hscroll_windows (Lisp_Object window
)
11007 int hscrolled_p
= hscroll_window_tree (window
);
11009 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11010 return hscrolled_p
;
11015 /************************************************************************
11017 ************************************************************************/
11019 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11020 to a non-zero value. This is sometimes handy to have in a debugger
11025 /* First and last unchanged row for try_window_id. */
11027 int debug_first_unchanged_at_end_vpos
;
11028 int debug_last_unchanged_at_beg_vpos
;
11030 /* Delta vpos and y. */
11032 int debug_dvpos
, debug_dy
;
11034 /* Delta in characters and bytes for try_window_id. */
11036 EMACS_INT debug_delta
, debug_delta_bytes
;
11038 /* Values of window_end_pos and window_end_vpos at the end of
11041 EMACS_INT debug_end_vpos
;
11043 /* Append a string to W->desired_matrix->method. FMT is a printf
11044 format string. A1...A9 are a supplement for a variable-length
11045 argument list. If trace_redisplay_p is non-zero also printf the
11046 resulting string to stderr. */
11049 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11052 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11055 char *method
= w
->desired_matrix
->method
;
11056 int len
= strlen (method
);
11057 int size
= sizeof w
->desired_matrix
->method
;
11058 int remaining
= size
- len
- 1;
11060 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11061 if (len
&& remaining
)
11064 --remaining
, ++len
;
11067 strncpy (method
+ len
, buffer
, remaining
);
11069 if (trace_redisplay_p
)
11070 fprintf (stderr
, "%p (%s): %s\n",
11072 ((BUFFERP (w
->buffer
)
11073 && STRINGP (XBUFFER (w
->buffer
)->name
))
11074 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11079 #endif /* GLYPH_DEBUG */
11082 /* Value is non-zero if all changes in window W, which displays
11083 current_buffer, are in the text between START and END. START is a
11084 buffer position, END is given as a distance from Z. Used in
11085 redisplay_internal for display optimization. */
11088 text_outside_line_unchanged_p (struct window
*w
,
11089 EMACS_INT start
, EMACS_INT end
)
11091 int unchanged_p
= 1;
11093 /* If text or overlays have changed, see where. */
11094 if (XFASTINT (w
->last_modified
) < MODIFF
11095 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11097 /* Gap in the line? */
11098 if (GPT
< start
|| Z
- GPT
< end
)
11101 /* Changes start in front of the line, or end after it? */
11103 && (BEG_UNCHANGED
< start
- 1
11104 || END_UNCHANGED
< end
))
11107 /* If selective display, can't optimize if changes start at the
11108 beginning of the line. */
11110 && INTEGERP (BVAR (current_buffer
, selective_display
))
11111 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11112 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11115 /* If there are overlays at the start or end of the line, these
11116 may have overlay strings with newlines in them. A change at
11117 START, for instance, may actually concern the display of such
11118 overlay strings as well, and they are displayed on different
11119 lines. So, quickly rule out this case. (For the future, it
11120 might be desirable to implement something more telling than
11121 just BEG/END_UNCHANGED.) */
11124 if (BEG
+ BEG_UNCHANGED
== start
11125 && overlay_touches_p (start
))
11127 if (END_UNCHANGED
== end
11128 && overlay_touches_p (Z
- end
))
11132 /* Under bidi reordering, adding or deleting a character in the
11133 beginning of a paragraph, before the first strong directional
11134 character, can change the base direction of the paragraph (unless
11135 the buffer specifies a fixed paragraph direction), which will
11136 require to redisplay the whole paragraph. It might be worthwhile
11137 to find the paragraph limits and widen the range of redisplayed
11138 lines to that, but for now just give up this optimization. */
11139 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11140 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11144 return unchanged_p
;
11148 /* Do a frame update, taking possible shortcuts into account. This is
11149 the main external entry point for redisplay.
11151 If the last redisplay displayed an echo area message and that message
11152 is no longer requested, we clear the echo area or bring back the
11153 mini-buffer if that is in use. */
11158 redisplay_internal (0);
11163 overlay_arrow_string_or_property (Lisp_Object var
)
11167 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11170 return Voverlay_arrow_string
;
11173 /* Return 1 if there are any overlay-arrows in current_buffer. */
11175 overlay_arrow_in_current_buffer_p (void)
11179 for (vlist
= Voverlay_arrow_variable_list
;
11181 vlist
= XCDR (vlist
))
11183 Lisp_Object var
= XCAR (vlist
);
11186 if (!SYMBOLP (var
))
11188 val
= find_symbol_value (var
);
11190 && current_buffer
== XMARKER (val
)->buffer
)
11197 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11201 overlay_arrows_changed_p (void)
11205 for (vlist
= Voverlay_arrow_variable_list
;
11207 vlist
= XCDR (vlist
))
11209 Lisp_Object var
= XCAR (vlist
);
11210 Lisp_Object val
, pstr
;
11212 if (!SYMBOLP (var
))
11214 val
= find_symbol_value (var
);
11215 if (!MARKERP (val
))
11217 if (! EQ (COERCE_MARKER (val
),
11218 Fget (var
, Qlast_arrow_position
))
11219 || ! (pstr
= overlay_arrow_string_or_property (var
),
11220 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11226 /* Mark overlay arrows to be updated on next redisplay. */
11229 update_overlay_arrows (int up_to_date
)
11233 for (vlist
= Voverlay_arrow_variable_list
;
11235 vlist
= XCDR (vlist
))
11237 Lisp_Object var
= XCAR (vlist
);
11239 if (!SYMBOLP (var
))
11242 if (up_to_date
> 0)
11244 Lisp_Object val
= find_symbol_value (var
);
11245 Fput (var
, Qlast_arrow_position
,
11246 COERCE_MARKER (val
));
11247 Fput (var
, Qlast_arrow_string
,
11248 overlay_arrow_string_or_property (var
));
11250 else if (up_to_date
< 0
11251 || !NILP (Fget (var
, Qlast_arrow_position
)))
11253 Fput (var
, Qlast_arrow_position
, Qt
);
11254 Fput (var
, Qlast_arrow_string
, Qt
);
11260 /* Return overlay arrow string to display at row.
11261 Return integer (bitmap number) for arrow bitmap in left fringe.
11262 Return nil if no overlay arrow. */
11265 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11269 for (vlist
= Voverlay_arrow_variable_list
;
11271 vlist
= XCDR (vlist
))
11273 Lisp_Object var
= XCAR (vlist
);
11276 if (!SYMBOLP (var
))
11279 val
= find_symbol_value (var
);
11282 && current_buffer
== XMARKER (val
)->buffer
11283 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11285 if (FRAME_WINDOW_P (it
->f
)
11286 /* FIXME: if ROW->reversed_p is set, this should test
11287 the right fringe, not the left one. */
11288 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11290 #ifdef HAVE_WINDOW_SYSTEM
11291 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11294 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11295 return make_number (fringe_bitmap
);
11298 return make_number (-1); /* Use default arrow bitmap */
11300 return overlay_arrow_string_or_property (var
);
11307 /* Return 1 if point moved out of or into a composition. Otherwise
11308 return 0. PREV_BUF and PREV_PT are the last point buffer and
11309 position. BUF and PT are the current point buffer and position. */
11312 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11313 struct buffer
*buf
, EMACS_INT pt
)
11315 EMACS_INT start
, end
;
11317 Lisp_Object buffer
;
11319 XSETBUFFER (buffer
, buf
);
11320 /* Check a composition at the last point if point moved within the
11322 if (prev_buf
== buf
)
11325 /* Point didn't move. */
11328 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11329 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11330 && COMPOSITION_VALID_P (start
, end
, prop
)
11331 && start
< prev_pt
&& end
> prev_pt
)
11332 /* The last point was within the composition. Return 1 iff
11333 point moved out of the composition. */
11334 return (pt
<= start
|| pt
>= end
);
11337 /* Check a composition at the current point. */
11338 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11339 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11340 && COMPOSITION_VALID_P (start
, end
, prop
)
11341 && start
< pt
&& end
> pt
);
11345 /* Reconsider the setting of B->clip_changed which is displayed
11349 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11351 if (b
->clip_changed
11352 && !NILP (w
->window_end_valid
)
11353 && w
->current_matrix
->buffer
== b
11354 && w
->current_matrix
->zv
== BUF_ZV (b
)
11355 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11356 b
->clip_changed
= 0;
11358 /* If display wasn't paused, and W is not a tool bar window, see if
11359 point has been moved into or out of a composition. In that case,
11360 we set b->clip_changed to 1 to force updating the screen. If
11361 b->clip_changed has already been set to 1, we can skip this
11363 if (!b
->clip_changed
11364 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11368 if (w
== XWINDOW (selected_window
))
11371 pt
= marker_position (w
->pointm
);
11373 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11374 || pt
!= XINT (w
->last_point
))
11375 && check_point_in_composition (w
->current_matrix
->buffer
,
11376 XINT (w
->last_point
),
11377 XBUFFER (w
->buffer
), pt
))
11378 b
->clip_changed
= 1;
11383 /* Select FRAME to forward the values of frame-local variables into C
11384 variables so that the redisplay routines can access those values
11388 select_frame_for_redisplay (Lisp_Object frame
)
11390 Lisp_Object tail
, tem
;
11391 Lisp_Object old
= selected_frame
;
11392 struct Lisp_Symbol
*sym
;
11394 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11396 selected_frame
= frame
;
11399 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11400 if (CONSP (XCAR (tail
))
11401 && (tem
= XCAR (XCAR (tail
)),
11403 && (sym
= indirect_variable (XSYMBOL (tem
)),
11404 sym
->redirect
== SYMBOL_LOCALIZED
)
11405 && sym
->val
.blv
->frame_local
)
11406 /* Use find_symbol_value rather than Fsymbol_value
11407 to avoid an error if it is void. */
11408 find_symbol_value (tem
);
11409 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11413 #define STOP_POLLING \
11414 do { if (! polling_stopped_here) stop_polling (); \
11415 polling_stopped_here = 1; } while (0)
11417 #define RESUME_POLLING \
11418 do { if (polling_stopped_here) start_polling (); \
11419 polling_stopped_here = 0; } while (0)
11422 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11423 response to any user action; therefore, we should preserve the echo
11424 area. (Actually, our caller does that job.) Perhaps in the future
11425 avoid recentering windows if it is not necessary; currently that
11426 causes some problems. */
11429 redisplay_internal (int preserve_echo_area
)
11431 struct window
*w
= XWINDOW (selected_window
);
11435 int must_finish
= 0;
11436 struct text_pos tlbufpos
, tlendpos
;
11437 int number_of_visible_frames
;
11440 int polling_stopped_here
= 0;
11441 Lisp_Object old_frame
= selected_frame
;
11443 /* Non-zero means redisplay has to consider all windows on all
11444 frames. Zero means, only selected_window is considered. */
11445 int consider_all_windows_p
;
11447 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11449 /* No redisplay if running in batch mode or frame is not yet fully
11450 initialized, or redisplay is explicitly turned off by setting
11451 Vinhibit_redisplay. */
11452 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11453 || !NILP (Vinhibit_redisplay
))
11456 /* Don't examine these until after testing Vinhibit_redisplay.
11457 When Emacs is shutting down, perhaps because its connection to
11458 X has dropped, we should not look at them at all. */
11459 fr
= XFRAME (w
->frame
);
11460 sf
= SELECTED_FRAME ();
11462 if (!fr
->glyphs_initialized_p
)
11465 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11466 if (popup_activated ())
11470 /* I don't think this happens but let's be paranoid. */
11471 if (redisplaying_p
)
11474 /* Record a function that resets redisplaying_p to its old value
11475 when we leave this function. */
11476 count
= SPECPDL_INDEX ();
11477 record_unwind_protect (unwind_redisplay
,
11478 Fcons (make_number (redisplaying_p
), selected_frame
));
11480 specbind (Qinhibit_free_realized_faces
, Qnil
);
11483 Lisp_Object tail
, frame
;
11485 FOR_EACH_FRAME (tail
, frame
)
11487 struct frame
*f
= XFRAME (frame
);
11488 f
->already_hscrolled_p
= 0;
11493 /* Remember the currently selected window. */
11496 if (!EQ (old_frame
, selected_frame
)
11497 && FRAME_LIVE_P (XFRAME (old_frame
)))
11498 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11499 selected_frame and selected_window to be temporarily out-of-sync so
11500 when we come back here via `goto retry', we need to resync because we
11501 may need to run Elisp code (via prepare_menu_bars). */
11502 select_frame_for_redisplay (old_frame
);
11505 reconsider_clip_changes (w
, current_buffer
);
11506 last_escape_glyph_frame
= NULL
;
11507 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11508 last_glyphless_glyph_frame
= NULL
;
11509 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11511 /* If new fonts have been loaded that make a glyph matrix adjustment
11512 necessary, do it. */
11513 if (fonts_changed_p
)
11515 adjust_glyphs (NULL
);
11516 ++windows_or_buffers_changed
;
11517 fonts_changed_p
= 0;
11520 /* If face_change_count is non-zero, init_iterator will free all
11521 realized faces, which includes the faces referenced from current
11522 matrices. So, we can't reuse current matrices in this case. */
11523 if (face_change_count
)
11524 ++windows_or_buffers_changed
;
11526 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11527 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11529 /* Since frames on a single ASCII terminal share the same
11530 display area, displaying a different frame means redisplay
11531 the whole thing. */
11532 windows_or_buffers_changed
++;
11533 SET_FRAME_GARBAGED (sf
);
11535 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11537 FRAME_TTY (sf
)->previous_frame
= sf
;
11540 /* Set the visible flags for all frames. Do this before checking
11541 for resized or garbaged frames; they want to know if their frames
11542 are visible. See the comment in frame.h for
11543 FRAME_SAMPLE_VISIBILITY. */
11545 Lisp_Object tail
, frame
;
11547 number_of_visible_frames
= 0;
11549 FOR_EACH_FRAME (tail
, frame
)
11551 struct frame
*f
= XFRAME (frame
);
11553 FRAME_SAMPLE_VISIBILITY (f
);
11554 if (FRAME_VISIBLE_P (f
))
11555 ++number_of_visible_frames
;
11556 clear_desired_matrices (f
);
11560 /* Notice any pending interrupt request to change frame size. */
11561 do_pending_window_change (1);
11563 /* do_pending_window_change could change the selected_window due to
11564 frame resizing which makes the selected window too small. */
11565 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11568 reconsider_clip_changes (w
, current_buffer
);
11571 /* Clear frames marked as garbaged. */
11572 if (frame_garbaged
)
11573 clear_garbaged_frames ();
11575 /* Build menubar and tool-bar items. */
11576 if (NILP (Vmemory_full
))
11577 prepare_menu_bars ();
11579 if (windows_or_buffers_changed
)
11580 update_mode_lines
++;
11582 /* Detect case that we need to write or remove a star in the mode line. */
11583 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11585 w
->update_mode_line
= Qt
;
11586 if (buffer_shared
> 1)
11587 update_mode_lines
++;
11590 /* Avoid invocation of point motion hooks by `current_column' below. */
11591 count1
= SPECPDL_INDEX ();
11592 specbind (Qinhibit_point_motion_hooks
, Qt
);
11594 /* If %c is in the mode line, update it if needed. */
11595 if (!NILP (w
->column_number_displayed
)
11596 /* This alternative quickly identifies a common case
11597 where no change is needed. */
11598 && !(PT
== XFASTINT (w
->last_point
)
11599 && XFASTINT (w
->last_modified
) >= MODIFF
11600 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11601 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11602 w
->update_mode_line
= Qt
;
11604 unbind_to (count1
, Qnil
);
11606 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11608 /* The variable buffer_shared is set in redisplay_window and
11609 indicates that we redisplay a buffer in different windows. See
11611 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11612 || cursor_type_changed
);
11614 /* If specs for an arrow have changed, do thorough redisplay
11615 to ensure we remove any arrow that should no longer exist. */
11616 if (overlay_arrows_changed_p ())
11617 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11619 /* Normally the message* functions will have already displayed and
11620 updated the echo area, but the frame may have been trashed, or
11621 the update may have been preempted, so display the echo area
11622 again here. Checking message_cleared_p captures the case that
11623 the echo area should be cleared. */
11624 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11625 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11626 || (message_cleared_p
11627 && minibuf_level
== 0
11628 /* If the mini-window is currently selected, this means the
11629 echo-area doesn't show through. */
11630 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11632 int window_height_changed_p
= echo_area_display (0);
11635 /* If we don't display the current message, don't clear the
11636 message_cleared_p flag, because, if we did, we wouldn't clear
11637 the echo area in the next redisplay which doesn't preserve
11639 if (!display_last_displayed_message_p
)
11640 message_cleared_p
= 0;
11642 if (fonts_changed_p
)
11644 else if (window_height_changed_p
)
11646 consider_all_windows_p
= 1;
11647 ++update_mode_lines
;
11648 ++windows_or_buffers_changed
;
11650 /* If window configuration was changed, frames may have been
11651 marked garbaged. Clear them or we will experience
11652 surprises wrt scrolling. */
11653 if (frame_garbaged
)
11654 clear_garbaged_frames ();
11657 else if (EQ (selected_window
, minibuf_window
)
11658 && (current_buffer
->clip_changed
11659 || XFASTINT (w
->last_modified
) < MODIFF
11660 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11661 && resize_mini_window (w
, 0))
11663 /* Resized active mini-window to fit the size of what it is
11664 showing if its contents might have changed. */
11666 /* FIXME: this causes all frames to be updated, which seems unnecessary
11667 since only the current frame needs to be considered. This function needs
11668 to be rewritten with two variables, consider_all_windows and
11669 consider_all_frames. */
11670 consider_all_windows_p
= 1;
11671 ++windows_or_buffers_changed
;
11672 ++update_mode_lines
;
11674 /* If window configuration was changed, frames may have been
11675 marked garbaged. Clear them or we will experience
11676 surprises wrt scrolling. */
11677 if (frame_garbaged
)
11678 clear_garbaged_frames ();
11682 /* If showing the region, and mark has changed, we must redisplay
11683 the whole window. The assignment to this_line_start_pos prevents
11684 the optimization directly below this if-statement. */
11685 if (((!NILP (Vtransient_mark_mode
)
11686 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11687 != !NILP (w
->region_showing
))
11688 || (!NILP (w
->region_showing
)
11689 && !EQ (w
->region_showing
,
11690 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11691 CHARPOS (this_line_start_pos
) = 0;
11693 /* Optimize the case that only the line containing the cursor in the
11694 selected window has changed. Variables starting with this_ are
11695 set in display_line and record information about the line
11696 containing the cursor. */
11697 tlbufpos
= this_line_start_pos
;
11698 tlendpos
= this_line_end_pos
;
11699 if (!consider_all_windows_p
11700 && CHARPOS (tlbufpos
) > 0
11701 && NILP (w
->update_mode_line
)
11702 && !current_buffer
->clip_changed
11703 && !current_buffer
->prevent_redisplay_optimizations_p
11704 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11705 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11706 /* Make sure recorded data applies to current buffer, etc. */
11707 && this_line_buffer
== current_buffer
11708 && current_buffer
== XBUFFER (w
->buffer
)
11709 && NILP (w
->force_start
)
11710 && NILP (w
->optional_new_start
)
11711 /* Point must be on the line that we have info recorded about. */
11712 && PT
>= CHARPOS (tlbufpos
)
11713 && PT
<= Z
- CHARPOS (tlendpos
)
11714 /* All text outside that line, including its final newline,
11715 must be unchanged. */
11716 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11717 CHARPOS (tlendpos
)))
11719 if (CHARPOS (tlbufpos
) > BEGV
11720 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11721 && (CHARPOS (tlbufpos
) == ZV
11722 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11723 /* Former continuation line has disappeared by becoming empty. */
11725 else if (XFASTINT (w
->last_modified
) < MODIFF
11726 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11727 || MINI_WINDOW_P (w
))
11729 /* We have to handle the case of continuation around a
11730 wide-column character (see the comment in indent.c around
11733 For instance, in the following case:
11735 -------- Insert --------
11736 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11737 J_I_ ==> J_I_ `^^' are cursors.
11741 As we have to redraw the line above, we cannot use this
11745 int line_height_before
= this_line_pixel_height
;
11747 /* Note that start_display will handle the case that the
11748 line starting at tlbufpos is a continuation line. */
11749 start_display (&it
, w
, tlbufpos
);
11751 /* Implementation note: It this still necessary? */
11752 if (it
.current_x
!= this_line_start_x
)
11755 TRACE ((stderr
, "trying display optimization 1\n"));
11756 w
->cursor
.vpos
= -1;
11757 overlay_arrow_seen
= 0;
11758 it
.vpos
= this_line_vpos
;
11759 it
.current_y
= this_line_y
;
11760 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11761 display_line (&it
);
11763 /* If line contains point, is not continued,
11764 and ends at same distance from eob as before, we win. */
11765 if (w
->cursor
.vpos
>= 0
11766 /* Line is not continued, otherwise this_line_start_pos
11767 would have been set to 0 in display_line. */
11768 && CHARPOS (this_line_start_pos
)
11769 /* Line ends as before. */
11770 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11771 /* Line has same height as before. Otherwise other lines
11772 would have to be shifted up or down. */
11773 && this_line_pixel_height
== line_height_before
)
11775 /* If this is not the window's last line, we must adjust
11776 the charstarts of the lines below. */
11777 if (it
.current_y
< it
.last_visible_y
)
11779 struct glyph_row
*row
11780 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11781 EMACS_INT delta
, delta_bytes
;
11783 /* We used to distinguish between two cases here,
11784 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11785 when the line ends in a newline or the end of the
11786 buffer's accessible portion. But both cases did
11787 the same, so they were collapsed. */
11789 - CHARPOS (tlendpos
)
11790 - MATRIX_ROW_START_CHARPOS (row
));
11791 delta_bytes
= (Z_BYTE
11792 - BYTEPOS (tlendpos
)
11793 - MATRIX_ROW_START_BYTEPOS (row
));
11795 increment_matrix_positions (w
->current_matrix
,
11796 this_line_vpos
+ 1,
11797 w
->current_matrix
->nrows
,
11798 delta
, delta_bytes
);
11801 /* If this row displays text now but previously didn't,
11802 or vice versa, w->window_end_vpos may have to be
11804 if ((it
.glyph_row
- 1)->displays_text_p
)
11806 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11807 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11809 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11810 && this_line_vpos
> 0)
11811 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11812 w
->window_end_valid
= Qnil
;
11814 /* Update hint: No need to try to scroll in update_window. */
11815 w
->desired_matrix
->no_scrolling_p
= 1;
11818 *w
->desired_matrix
->method
= 0;
11819 debug_method_add (w
, "optimization 1");
11821 #ifdef HAVE_WINDOW_SYSTEM
11822 update_window_fringes (w
, 0);
11829 else if (/* Cursor position hasn't changed. */
11830 PT
== XFASTINT (w
->last_point
)
11831 /* Make sure the cursor was last displayed
11832 in this window. Otherwise we have to reposition it. */
11833 && 0 <= w
->cursor
.vpos
11834 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11838 do_pending_window_change (1);
11839 /* If selected_window changed, redisplay again. */
11840 if (WINDOWP (selected_window
)
11841 && (w
= XWINDOW (selected_window
)) != sw
)
11844 /* We used to always goto end_of_redisplay here, but this
11845 isn't enough if we have a blinking cursor. */
11846 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11847 goto end_of_redisplay
;
11851 /* If highlighting the region, or if the cursor is in the echo area,
11852 then we can't just move the cursor. */
11853 else if (! (!NILP (Vtransient_mark_mode
)
11854 && !NILP (BVAR (current_buffer
, mark_active
)))
11855 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11856 || highlight_nonselected_windows
)
11857 && NILP (w
->region_showing
)
11858 && NILP (Vshow_trailing_whitespace
)
11859 && !cursor_in_echo_area
)
11862 struct glyph_row
*row
;
11864 /* Skip from tlbufpos to PT and see where it is. Note that
11865 PT may be in invisible text. If so, we will end at the
11866 next visible position. */
11867 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11868 NULL
, DEFAULT_FACE_ID
);
11869 it
.current_x
= this_line_start_x
;
11870 it
.current_y
= this_line_y
;
11871 it
.vpos
= this_line_vpos
;
11873 /* The call to move_it_to stops in front of PT, but
11874 moves over before-strings. */
11875 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11877 if (it
.vpos
== this_line_vpos
11878 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11881 xassert (this_line_vpos
== it
.vpos
);
11882 xassert (this_line_y
== it
.current_y
);
11883 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11885 *w
->desired_matrix
->method
= 0;
11886 debug_method_add (w
, "optimization 3");
11895 /* Text changed drastically or point moved off of line. */
11896 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11899 CHARPOS (this_line_start_pos
) = 0;
11900 consider_all_windows_p
|= buffer_shared
> 1;
11901 ++clear_face_cache_count
;
11902 #ifdef HAVE_WINDOW_SYSTEM
11903 ++clear_image_cache_count
;
11906 /* Build desired matrices, and update the display. If
11907 consider_all_windows_p is non-zero, do it for all windows on all
11908 frames. Otherwise do it for selected_window, only. */
11910 if (consider_all_windows_p
)
11912 Lisp_Object tail
, frame
;
11914 FOR_EACH_FRAME (tail
, frame
)
11915 XFRAME (frame
)->updated_p
= 0;
11917 /* Recompute # windows showing selected buffer. This will be
11918 incremented each time such a window is displayed. */
11921 FOR_EACH_FRAME (tail
, frame
)
11923 struct frame
*f
= XFRAME (frame
);
11925 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11927 if (! EQ (frame
, selected_frame
))
11928 /* Select the frame, for the sake of frame-local
11930 select_frame_for_redisplay (frame
);
11932 /* Mark all the scroll bars to be removed; we'll redeem
11933 the ones we want when we redisplay their windows. */
11934 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11935 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11937 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11938 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11940 /* The X error handler may have deleted that frame. */
11941 if (!FRAME_LIVE_P (f
))
11944 /* Any scroll bars which redisplay_windows should have
11945 nuked should now go away. */
11946 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11947 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11949 /* If fonts changed, display again. */
11950 /* ??? rms: I suspect it is a mistake to jump all the way
11951 back to retry here. It should just retry this frame. */
11952 if (fonts_changed_p
)
11955 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11957 /* See if we have to hscroll. */
11958 if (!f
->already_hscrolled_p
)
11960 f
->already_hscrolled_p
= 1;
11961 if (hscroll_windows (f
->root_window
))
11965 /* Prevent various kinds of signals during display
11966 update. stdio is not robust about handling
11967 signals, which can cause an apparent I/O
11969 if (interrupt_input
)
11970 unrequest_sigio ();
11973 /* Update the display. */
11974 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11975 pending
|= update_frame (f
, 0, 0);
11981 if (!EQ (old_frame
, selected_frame
)
11982 && FRAME_LIVE_P (XFRAME (old_frame
)))
11983 /* We played a bit fast-and-loose above and allowed selected_frame
11984 and selected_window to be temporarily out-of-sync but let's make
11985 sure this stays contained. */
11986 select_frame_for_redisplay (old_frame
);
11987 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11991 /* Do the mark_window_display_accurate after all windows have
11992 been redisplayed because this call resets flags in buffers
11993 which are needed for proper redisplay. */
11994 FOR_EACH_FRAME (tail
, frame
)
11996 struct frame
*f
= XFRAME (frame
);
11999 mark_window_display_accurate (f
->root_window
, 1);
12000 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12001 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12006 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12008 Lisp_Object mini_window
;
12009 struct frame
*mini_frame
;
12011 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12012 /* Use list_of_error, not Qerror, so that
12013 we catch only errors and don't run the debugger. */
12014 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12016 redisplay_window_error
);
12018 /* Compare desired and current matrices, perform output. */
12021 /* If fonts changed, display again. */
12022 if (fonts_changed_p
)
12025 /* Prevent various kinds of signals during display update.
12026 stdio is not robust about handling signals,
12027 which can cause an apparent I/O error. */
12028 if (interrupt_input
)
12029 unrequest_sigio ();
12032 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12034 if (hscroll_windows (selected_window
))
12037 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12038 pending
= update_frame (sf
, 0, 0);
12041 /* We may have called echo_area_display at the top of this
12042 function. If the echo area is on another frame, that may
12043 have put text on a frame other than the selected one, so the
12044 above call to update_frame would not have caught it. Catch
12046 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12047 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12049 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12051 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12052 pending
|= update_frame (mini_frame
, 0, 0);
12053 if (!pending
&& hscroll_windows (mini_window
))
12058 /* If display was paused because of pending input, make sure we do a
12059 thorough update the next time. */
12062 /* Prevent the optimization at the beginning of
12063 redisplay_internal that tries a single-line update of the
12064 line containing the cursor in the selected window. */
12065 CHARPOS (this_line_start_pos
) = 0;
12067 /* Let the overlay arrow be updated the next time. */
12068 update_overlay_arrows (0);
12070 /* If we pause after scrolling, some rows in the current
12071 matrices of some windows are not valid. */
12072 if (!WINDOW_FULL_WIDTH_P (w
)
12073 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12074 update_mode_lines
= 1;
12078 if (!consider_all_windows_p
)
12080 /* This has already been done above if
12081 consider_all_windows_p is set. */
12082 mark_window_display_accurate_1 (w
, 1);
12084 /* Say overlay arrows are up to date. */
12085 update_overlay_arrows (1);
12087 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12088 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12091 update_mode_lines
= 0;
12092 windows_or_buffers_changed
= 0;
12093 cursor_type_changed
= 0;
12096 /* Start SIGIO interrupts coming again. Having them off during the
12097 code above makes it less likely one will discard output, but not
12098 impossible, since there might be stuff in the system buffer here.
12099 But it is much hairier to try to do anything about that. */
12100 if (interrupt_input
)
12104 /* If a frame has become visible which was not before, redisplay
12105 again, so that we display it. Expose events for such a frame
12106 (which it gets when becoming visible) don't call the parts of
12107 redisplay constructing glyphs, so simply exposing a frame won't
12108 display anything in this case. So, we have to display these
12109 frames here explicitly. */
12112 Lisp_Object tail
, frame
;
12115 FOR_EACH_FRAME (tail
, frame
)
12117 int this_is_visible
= 0;
12119 if (XFRAME (frame
)->visible
)
12120 this_is_visible
= 1;
12121 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12122 if (XFRAME (frame
)->visible
)
12123 this_is_visible
= 1;
12125 if (this_is_visible
)
12129 if (new_count
!= number_of_visible_frames
)
12130 windows_or_buffers_changed
++;
12133 /* Change frame size now if a change is pending. */
12134 do_pending_window_change (1);
12136 /* If we just did a pending size change, or have additional
12137 visible frames, or selected_window changed, redisplay again. */
12138 if ((windows_or_buffers_changed
&& !pending
)
12139 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12142 /* Clear the face and image caches.
12144 We used to do this only if consider_all_windows_p. But the cache
12145 needs to be cleared if a timer creates images in the current
12146 buffer (e.g. the test case in Bug#6230). */
12148 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12150 clear_face_cache (0);
12151 clear_face_cache_count
= 0;
12154 #ifdef HAVE_WINDOW_SYSTEM
12155 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12157 clear_image_caches (Qnil
);
12158 clear_image_cache_count
= 0;
12160 #endif /* HAVE_WINDOW_SYSTEM */
12163 unbind_to (count
, Qnil
);
12168 /* Redisplay, but leave alone any recent echo area message unless
12169 another message has been requested in its place.
12171 This is useful in situations where you need to redisplay but no
12172 user action has occurred, making it inappropriate for the message
12173 area to be cleared. See tracking_off and
12174 wait_reading_process_output for examples of these situations.
12176 FROM_WHERE is an integer saying from where this function was
12177 called. This is useful for debugging. */
12180 redisplay_preserve_echo_area (int from_where
)
12182 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12184 if (!NILP (echo_area_buffer
[1]))
12186 /* We have a previously displayed message, but no current
12187 message. Redisplay the previous message. */
12188 display_last_displayed_message_p
= 1;
12189 redisplay_internal (1);
12190 display_last_displayed_message_p
= 0;
12193 redisplay_internal (1);
12195 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12196 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12197 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12201 /* Function registered with record_unwind_protect in
12202 redisplay_internal. Reset redisplaying_p to the value it had
12203 before redisplay_internal was called, and clear
12204 prevent_freeing_realized_faces_p. It also selects the previously
12205 selected frame, unless it has been deleted (by an X connection
12206 failure during redisplay, for example). */
12209 unwind_redisplay (Lisp_Object val
)
12211 Lisp_Object old_redisplaying_p
, old_frame
;
12213 old_redisplaying_p
= XCAR (val
);
12214 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12215 old_frame
= XCDR (val
);
12216 if (! EQ (old_frame
, selected_frame
)
12217 && FRAME_LIVE_P (XFRAME (old_frame
)))
12218 select_frame_for_redisplay (old_frame
);
12223 /* Mark the display of window W as accurate or inaccurate. If
12224 ACCURATE_P is non-zero mark display of W as accurate. If
12225 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12226 redisplay_internal is called. */
12229 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12231 if (BUFFERP (w
->buffer
))
12233 struct buffer
*b
= XBUFFER (w
->buffer
);
12236 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12237 w
->last_overlay_modified
12238 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12240 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12244 b
->clip_changed
= 0;
12245 b
->prevent_redisplay_optimizations_p
= 0;
12247 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12248 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12249 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12250 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12252 w
->current_matrix
->buffer
= b
;
12253 w
->current_matrix
->begv
= BUF_BEGV (b
);
12254 w
->current_matrix
->zv
= BUF_ZV (b
);
12256 w
->last_cursor
= w
->cursor
;
12257 w
->last_cursor_off_p
= w
->cursor_off_p
;
12259 if (w
== XWINDOW (selected_window
))
12260 w
->last_point
= make_number (BUF_PT (b
));
12262 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12268 w
->window_end_valid
= w
->buffer
;
12269 w
->update_mode_line
= Qnil
;
12274 /* Mark the display of windows in the window tree rooted at WINDOW as
12275 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12276 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12277 be redisplayed the next time redisplay_internal is called. */
12280 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12284 for (; !NILP (window
); window
= w
->next
)
12286 w
= XWINDOW (window
);
12287 mark_window_display_accurate_1 (w
, accurate_p
);
12289 if (!NILP (w
->vchild
))
12290 mark_window_display_accurate (w
->vchild
, accurate_p
);
12291 if (!NILP (w
->hchild
))
12292 mark_window_display_accurate (w
->hchild
, accurate_p
);
12297 update_overlay_arrows (1);
12301 /* Force a thorough redisplay the next time by setting
12302 last_arrow_position and last_arrow_string to t, which is
12303 unequal to any useful value of Voverlay_arrow_... */
12304 update_overlay_arrows (-1);
12309 /* Return value in display table DP (Lisp_Char_Table *) for character
12310 C. Since a display table doesn't have any parent, we don't have to
12311 follow parent. Do not call this function directly but use the
12312 macro DISP_CHAR_VECTOR. */
12315 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12319 if (ASCII_CHAR_P (c
))
12322 if (SUB_CHAR_TABLE_P (val
))
12323 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12329 XSETCHAR_TABLE (table
, dp
);
12330 val
= char_table_ref (table
, c
);
12339 /***********************************************************************
12341 ***********************************************************************/
12343 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12346 redisplay_windows (Lisp_Object window
)
12348 while (!NILP (window
))
12350 struct window
*w
= XWINDOW (window
);
12352 if (!NILP (w
->hchild
))
12353 redisplay_windows (w
->hchild
);
12354 else if (!NILP (w
->vchild
))
12355 redisplay_windows (w
->vchild
);
12356 else if (!NILP (w
->buffer
))
12358 displayed_buffer
= XBUFFER (w
->buffer
);
12359 /* Use list_of_error, not Qerror, so that
12360 we catch only errors and don't run the debugger. */
12361 internal_condition_case_1 (redisplay_window_0
, window
,
12363 redisplay_window_error
);
12371 redisplay_window_error (Lisp_Object ignore
)
12373 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12378 redisplay_window_0 (Lisp_Object window
)
12380 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12381 redisplay_window (window
, 0);
12386 redisplay_window_1 (Lisp_Object window
)
12388 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12389 redisplay_window (window
, 1);
12394 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12395 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12396 which positions recorded in ROW differ from current buffer
12399 Return 0 if cursor is not on this row, 1 otherwise. */
12402 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12403 struct glyph_matrix
*matrix
,
12404 EMACS_INT delta
, EMACS_INT delta_bytes
,
12407 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12408 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12409 struct glyph
*cursor
= NULL
;
12410 /* The last known character position in row. */
12411 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12413 EMACS_INT pt_old
= PT
- delta
;
12414 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12415 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12416 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12417 /* A glyph beyond the edge of TEXT_AREA which we should never
12419 struct glyph
*glyphs_end
= end
;
12420 /* Non-zero means we've found a match for cursor position, but that
12421 glyph has the avoid_cursor_p flag set. */
12422 int match_with_avoid_cursor
= 0;
12423 /* Non-zero means we've seen at least one glyph that came from a
12425 int string_seen
= 0;
12426 /* Largest and smalles buffer positions seen so far during scan of
12428 EMACS_INT bpos_max
= pos_before
;
12429 EMACS_INT bpos_min
= pos_after
;
12430 /* Last buffer position covered by an overlay string with an integer
12431 `cursor' property. */
12432 EMACS_INT bpos_covered
= 0;
12434 /* Skip over glyphs not having an object at the start and the end of
12435 the row. These are special glyphs like truncation marks on
12436 terminal frames. */
12437 if (row
->displays_text_p
)
12439 if (!row
->reversed_p
)
12442 && INTEGERP (glyph
->object
)
12443 && glyph
->charpos
< 0)
12445 x
+= glyph
->pixel_width
;
12449 && INTEGERP ((end
- 1)->object
)
12450 /* CHARPOS is zero for blanks and stretch glyphs
12451 inserted by extend_face_to_end_of_line. */
12452 && (end
- 1)->charpos
<= 0)
12454 glyph_before
= glyph
- 1;
12461 /* If the glyph row is reversed, we need to process it from back
12462 to front, so swap the edge pointers. */
12463 glyphs_end
= end
= glyph
- 1;
12464 glyph
+= row
->used
[TEXT_AREA
] - 1;
12466 while (glyph
> end
+ 1
12467 && INTEGERP (glyph
->object
)
12468 && glyph
->charpos
< 0)
12471 x
-= glyph
->pixel_width
;
12473 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12475 /* By default, in reversed rows we put the cursor on the
12476 rightmost (first in the reading order) glyph. */
12477 for (g
= end
+ 1; g
< glyph
; g
++)
12478 x
+= g
->pixel_width
;
12480 && INTEGERP ((end
+ 1)->object
)
12481 && (end
+ 1)->charpos
<= 0)
12483 glyph_before
= glyph
+ 1;
12487 else if (row
->reversed_p
)
12489 /* In R2L rows that don't display text, put the cursor on the
12490 rightmost glyph. Case in point: an empty last line that is
12491 part of an R2L paragraph. */
12493 /* Avoid placing the cursor on the last glyph of the row, where
12494 on terminal frames we hold the vertical border between
12495 adjacent windows. */
12496 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12497 && !WINDOW_RIGHTMOST_P (w
)
12498 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12500 x
= -1; /* will be computed below, at label compute_x */
12503 /* Step 1: Try to find the glyph whose character position
12504 corresponds to point. If that's not possible, find 2 glyphs
12505 whose character positions are the closest to point, one before
12506 point, the other after it. */
12507 if (!row
->reversed_p
)
12508 while (/* not marched to end of glyph row */
12510 /* glyph was not inserted by redisplay for internal purposes */
12511 && !INTEGERP (glyph
->object
))
12513 if (BUFFERP (glyph
->object
))
12515 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12517 if (glyph
->charpos
> bpos_max
)
12518 bpos_max
= glyph
->charpos
;
12519 if (glyph
->charpos
< bpos_min
)
12520 bpos_min
= glyph
->charpos
;
12521 if (!glyph
->avoid_cursor_p
)
12523 /* If we hit point, we've found the glyph on which to
12524 display the cursor. */
12527 match_with_avoid_cursor
= 0;
12530 /* See if we've found a better approximation to
12531 POS_BEFORE or to POS_AFTER. Note that we want the
12532 first (leftmost) glyph of all those that are the
12533 closest from below, and the last (rightmost) of all
12534 those from above. */
12535 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12537 pos_before
= glyph
->charpos
;
12538 glyph_before
= glyph
;
12540 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12542 pos_after
= glyph
->charpos
;
12543 glyph_after
= glyph
;
12546 else if (dpos
== 0)
12547 match_with_avoid_cursor
= 1;
12549 else if (STRINGP (glyph
->object
))
12551 Lisp_Object chprop
;
12552 EMACS_INT glyph_pos
= glyph
->charpos
;
12554 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12556 if (INTEGERP (chprop
))
12558 bpos_covered
= bpos_max
+ XINT (chprop
);
12559 /* If the `cursor' property covers buffer positions up
12560 to and including point, we should display cursor on
12561 this glyph. Note that overlays and text properties
12562 with string values stop bidi reordering, so every
12563 buffer position to the left of the string is always
12564 smaller than any position to the right of the
12565 string. Therefore, if a `cursor' property on one
12566 of the string's characters has an integer value, we
12567 will break out of the loop below _before_ we get to
12568 the position match above. IOW, integer values of
12569 the `cursor' property override the "exact match for
12570 point" strategy of positioning the cursor. */
12571 /* Implementation note: bpos_max == pt_old when, e.g.,
12572 we are in an empty line, where bpos_max is set to
12573 MATRIX_ROW_START_CHARPOS, see above. */
12574 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12583 x
+= glyph
->pixel_width
;
12586 else if (glyph
> end
) /* row is reversed */
12587 while (!INTEGERP (glyph
->object
))
12589 if (BUFFERP (glyph
->object
))
12591 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12593 if (glyph
->charpos
> bpos_max
)
12594 bpos_max
= glyph
->charpos
;
12595 if (glyph
->charpos
< bpos_min
)
12596 bpos_min
= glyph
->charpos
;
12597 if (!glyph
->avoid_cursor_p
)
12601 match_with_avoid_cursor
= 0;
12604 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12606 pos_before
= glyph
->charpos
;
12607 glyph_before
= glyph
;
12609 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12611 pos_after
= glyph
->charpos
;
12612 glyph_after
= glyph
;
12615 else if (dpos
== 0)
12616 match_with_avoid_cursor
= 1;
12618 else if (STRINGP (glyph
->object
))
12620 Lisp_Object chprop
;
12621 EMACS_INT glyph_pos
= glyph
->charpos
;
12623 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12625 if (INTEGERP (chprop
))
12627 bpos_covered
= bpos_max
+ XINT (chprop
);
12628 /* If the `cursor' property covers buffer positions up
12629 to and including point, we should display cursor on
12631 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12640 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12642 x
--; /* can't use any pixel_width */
12645 x
-= glyph
->pixel_width
;
12648 /* Step 2: If we didn't find an exact match for point, we need to
12649 look for a proper place to put the cursor among glyphs between
12650 GLYPH_BEFORE and GLYPH_AFTER. */
12651 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12652 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12653 && bpos_covered
< pt_old
)
12655 /* An empty line has a single glyph whose OBJECT is zero and
12656 whose CHARPOS is the position of a newline on that line.
12657 Note that on a TTY, there are more glyphs after that, which
12658 were produced by extend_face_to_end_of_line, but their
12659 CHARPOS is zero or negative. */
12661 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12662 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12664 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12666 EMACS_INT ellipsis_pos
;
12668 /* Scan back over the ellipsis glyphs. */
12669 if (!row
->reversed_p
)
12671 ellipsis_pos
= (glyph
- 1)->charpos
;
12672 while (glyph
> row
->glyphs
[TEXT_AREA
]
12673 && (glyph
- 1)->charpos
== ellipsis_pos
)
12674 glyph
--, x
-= glyph
->pixel_width
;
12675 /* That loop always goes one position too far, including
12676 the glyph before the ellipsis. So scan forward over
12678 x
+= glyph
->pixel_width
;
12681 else /* row is reversed */
12683 ellipsis_pos
= (glyph
+ 1)->charpos
;
12684 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12685 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12686 glyph
++, x
+= glyph
->pixel_width
;
12687 x
-= glyph
->pixel_width
;
12691 else if (match_with_avoid_cursor
12692 /* A truncated row may not include PT among its
12693 character positions. Setting the cursor inside the
12694 scroll margin will trigger recalculation of hscroll
12695 in hscroll_window_tree. */
12696 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12697 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12698 /* Zero-width characters produce no glyphs. */
12701 && (row
->reversed_p
12702 ? glyph_after
> glyphs_end
12703 : glyph_after
< glyphs_end
)))
12705 cursor
= glyph_after
;
12708 else if (string_seen
)
12710 int incr
= row
->reversed_p
? -1 : +1;
12712 /* Need to find the glyph that came out of a string which is
12713 present at point. That glyph is somewhere between
12714 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12715 positioned between POS_BEFORE and POS_AFTER in the
12717 struct glyph
*stop
= glyph_after
;
12718 EMACS_INT pos
= pos_before
;
12721 for (glyph
= glyph_before
+ incr
;
12722 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12725 /* Any glyphs that come from the buffer are here because
12726 of bidi reordering. Skip them, and only pay
12727 attention to glyphs that came from some string. */
12728 if (STRINGP (glyph
->object
))
12733 str
= glyph
->object
;
12734 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12735 if (tem
== 0 /* from overlay */
12738 /* If the string from which this glyph came is
12739 found in the buffer at point, then we've
12740 found the glyph we've been looking for. If
12741 it comes from an overlay (tem == 0), and it
12742 has the `cursor' property on one of its
12743 glyphs, record that glyph as a candidate for
12744 displaying the cursor. (As in the
12745 unidirectional version, we will display the
12746 cursor on the last candidate we find.) */
12747 if (tem
== 0 || tem
== pt_old
)
12749 /* The glyphs from this string could have
12750 been reordered. Find the one with the
12751 smallest string position. Or there could
12752 be a character in the string with the
12753 `cursor' property, which means display
12754 cursor on that character's glyph. */
12755 EMACS_INT strpos
= glyph
->charpos
;
12760 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12761 && EQ (glyph
->object
, str
);
12765 EMACS_INT gpos
= glyph
->charpos
;
12767 cprop
= Fget_char_property (make_number (gpos
),
12775 if (tem
&& glyph
->charpos
< strpos
)
12777 strpos
= glyph
->charpos
;
12786 pos
= tem
+ 1; /* don't find previous instances */
12788 /* This string is not what we want; skip all of the
12789 glyphs that came from it. */
12790 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12791 && EQ (glyph
->object
, str
))
12798 /* If we reached the end of the line, and END was from a string,
12799 the cursor is not on this line. */
12801 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12802 && STRINGP (end
->object
)
12803 && row
->continued_p
)
12809 if (cursor
!= NULL
)
12815 /* Need to compute x that corresponds to GLYPH. */
12816 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12818 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12820 x
+= g
->pixel_width
;
12824 /* ROW could be part of a continued line, which, under bidi
12825 reordering, might have other rows whose start and end charpos
12826 occlude point. Only set w->cursor if we found a better
12827 approximation to the cursor position than we have from previously
12828 examined candidate rows belonging to the same continued line. */
12829 if (/* we already have a candidate row */
12830 w
->cursor
.vpos
>= 0
12831 /* that candidate is not the row we are processing */
12832 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12833 /* the row we are processing is part of a continued line */
12834 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12835 /* Make sure cursor.vpos specifies a row whose start and end
12836 charpos occlude point. This is because some callers of this
12837 function leave cursor.vpos at the row where the cursor was
12838 displayed during the last redisplay cycle. */
12839 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12840 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12843 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12845 /* Don't consider glyphs that are outside TEXT_AREA. */
12846 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12848 /* Keep the candidate whose buffer position is the closest to
12850 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12851 w
->cursor
.hpos
>= 0
12852 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12853 && BUFFERP (g1
->object
)
12854 && (g1
->charpos
== pt_old
/* an exact match always wins */
12855 || (BUFFERP (glyph
->object
)
12856 && eabs (g1
->charpos
- pt_old
)
12857 < eabs (glyph
->charpos
- pt_old
))))
12859 /* If this candidate gives an exact match, use that. */
12860 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12861 /* Otherwise, keep the candidate that comes from a row
12862 spanning less buffer positions. This may win when one or
12863 both candidate positions are on glyphs that came from
12864 display strings, for which we cannot compare buffer
12866 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12867 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12868 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12871 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12873 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12874 w
->cursor
.y
= row
->y
+ dy
;
12876 if (w
== XWINDOW (selected_window
))
12878 if (!row
->continued_p
12879 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12882 this_line_buffer
= XBUFFER (w
->buffer
);
12884 CHARPOS (this_line_start_pos
)
12885 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12886 BYTEPOS (this_line_start_pos
)
12887 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12889 CHARPOS (this_line_end_pos
)
12890 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12891 BYTEPOS (this_line_end_pos
)
12892 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12894 this_line_y
= w
->cursor
.y
;
12895 this_line_pixel_height
= row
->height
;
12896 this_line_vpos
= w
->cursor
.vpos
;
12897 this_line_start_x
= row
->x
;
12900 CHARPOS (this_line_start_pos
) = 0;
12907 /* Run window scroll functions, if any, for WINDOW with new window
12908 start STARTP. Sets the window start of WINDOW to that position.
12910 We assume that the window's buffer is really current. */
12912 static INLINE
struct text_pos
12913 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12915 struct window
*w
= XWINDOW (window
);
12916 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12918 if (current_buffer
!= XBUFFER (w
->buffer
))
12921 if (!NILP (Vwindow_scroll_functions
))
12923 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12924 make_number (CHARPOS (startp
)));
12925 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12926 /* In case the hook functions switch buffers. */
12927 if (current_buffer
!= XBUFFER (w
->buffer
))
12928 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12935 /* Make sure the line containing the cursor is fully visible.
12936 A value of 1 means there is nothing to be done.
12937 (Either the line is fully visible, or it cannot be made so,
12938 or we cannot tell.)
12940 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12941 is higher than window.
12943 A value of 0 means the caller should do scrolling
12944 as if point had gone off the screen. */
12947 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12949 struct glyph_matrix
*matrix
;
12950 struct glyph_row
*row
;
12953 if (!make_cursor_line_fully_visible_p
)
12956 /* It's not always possible to find the cursor, e.g, when a window
12957 is full of overlay strings. Don't do anything in that case. */
12958 if (w
->cursor
.vpos
< 0)
12961 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12962 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12964 /* If the cursor row is not partially visible, there's nothing to do. */
12965 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12968 /* If the row the cursor is in is taller than the window's height,
12969 it's not clear what to do, so do nothing. */
12970 window_height
= window_box_height (w
);
12971 if (row
->height
>= window_height
)
12973 if (!force_p
|| MINI_WINDOW_P (w
)
12974 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12981 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12982 non-zero means only WINDOW is redisplayed in redisplay_internal.
12983 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12984 in redisplay_window to bring a partially visible line into view in
12985 the case that only the cursor has moved.
12987 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12988 last screen line's vertical height extends past the end of the screen.
12992 1 if scrolling succeeded
12994 0 if scrolling didn't find point.
12996 -1 if new fonts have been loaded so that we must interrupt
12997 redisplay, adjust glyph matrices, and try again. */
13003 SCROLLING_NEED_LARGER_MATRICES
13006 /* If scroll-conservatively is more than this, never recenter. */
13007 #define SCROLL_LIMIT 100
13010 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13011 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13012 int temp_scroll_step
, int last_line_misfit
)
13014 struct window
*w
= XWINDOW (window
);
13015 struct frame
*f
= XFRAME (w
->frame
);
13016 struct text_pos pos
, startp
;
13018 int this_scroll_margin
, scroll_max
, rc
, height
;
13019 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13020 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13021 Lisp_Object aggressive
;
13022 /* We will never try scrolling more than this number of lines. */
13023 int scroll_limit
= SCROLL_LIMIT
;
13026 debug_method_add (w
, "try_scrolling");
13029 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13031 /* Compute scroll margin height in pixels. We scroll when point is
13032 within this distance from the top or bottom of the window. */
13033 if (scroll_margin
> 0)
13034 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13035 * FRAME_LINE_HEIGHT (f
);
13037 this_scroll_margin
= 0;
13039 /* Force arg_scroll_conservatively to have a reasonable value, to
13040 avoid scrolling too far away with slow move_it_* functions. Note
13041 that the user can supply scroll-conservatively equal to
13042 `most-positive-fixnum', which can be larger than INT_MAX. */
13043 if (arg_scroll_conservatively
> scroll_limit
)
13045 arg_scroll_conservatively
= scroll_limit
+ 1;
13046 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13048 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13049 /* Compute how much we should try to scroll maximally to bring
13050 point into view. */
13051 scroll_max
= (max (scroll_step
,
13052 max (arg_scroll_conservatively
, temp_scroll_step
))
13053 * FRAME_LINE_HEIGHT (f
));
13054 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13055 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13056 /* We're trying to scroll because of aggressive scrolling but no
13057 scroll_step is set. Choose an arbitrary one. */
13058 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13064 /* Decide whether to scroll down. */
13065 if (PT
> CHARPOS (startp
))
13067 int scroll_margin_y
;
13069 /* Compute the pixel ypos of the scroll margin, then move it to
13070 either that ypos or PT, whichever comes first. */
13071 start_display (&it
, w
, startp
);
13072 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13073 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13074 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13075 (MOVE_TO_POS
| MOVE_TO_Y
));
13077 if (PT
> CHARPOS (it
.current
.pos
))
13079 int y0
= line_bottom_y (&it
);
13080 /* Compute how many pixels below window bottom to stop searching
13081 for PT. This avoids costly search for PT that is far away if
13082 the user limited scrolling by a small number of lines, but
13083 always finds PT if scroll_conservatively is set to a large
13084 number, such as most-positive-fixnum. */
13085 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13087 slack
>= INT_MAX
- it
.last_visible_y
13089 : it
.last_visible_y
+ slack
;
13091 /* Compute the distance from the scroll margin to PT or to
13092 the scroll limit, whichever comes first. This should
13093 include the height of the cursor line, to make that line
13095 move_it_to (&it
, PT
, -1, y_to_move
,
13096 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13097 dy
= line_bottom_y (&it
) - y0
;
13099 if (dy
> scroll_max
)
13100 return SCROLLING_FAILED
;
13108 /* Point is in or below the bottom scroll margin, so move the
13109 window start down. If scrolling conservatively, move it just
13110 enough down to make point visible. If scroll_step is set,
13111 move it down by scroll_step. */
13112 if (arg_scroll_conservatively
)
13114 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13115 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13116 else if (scroll_step
|| temp_scroll_step
)
13117 amount_to_scroll
= scroll_max
;
13120 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13121 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13122 if (NUMBERP (aggressive
))
13124 double float_amount
= XFLOATINT (aggressive
) * height
;
13125 amount_to_scroll
= float_amount
;
13126 if (amount_to_scroll
== 0 && float_amount
> 0)
13127 amount_to_scroll
= 1;
13131 if (amount_to_scroll
<= 0)
13132 return SCROLLING_FAILED
;
13134 start_display (&it
, w
, startp
);
13135 if (arg_scroll_conservatively
<= scroll_limit
)
13136 move_it_vertically (&it
, amount_to_scroll
);
13139 /* Extra precision for users who set scroll-conservatively
13140 to a large number: make sure the amount we scroll
13141 the window start is never less than amount_to_scroll,
13142 which was computed as distance from window bottom to
13143 point. This matters when lines at window top and lines
13144 below window bottom have different height. */
13145 struct it it1
= it
;
13146 /* We use a temporary it1 because line_bottom_y can modify
13147 its argument, if it moves one line down; see there. */
13148 int start_y
= line_bottom_y (&it1
);
13151 move_it_by_lines (&it
, 1, 1);
13153 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13156 /* If STARTP is unchanged, move it down another screen line. */
13157 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13158 move_it_by_lines (&it
, 1, 1);
13159 startp
= it
.current
.pos
;
13163 struct text_pos scroll_margin_pos
= startp
;
13165 /* See if point is inside the scroll margin at the top of the
13167 if (this_scroll_margin
)
13169 start_display (&it
, w
, startp
);
13170 move_it_vertically (&it
, this_scroll_margin
);
13171 scroll_margin_pos
= it
.current
.pos
;
13174 if (PT
< CHARPOS (scroll_margin_pos
))
13176 /* Point is in the scroll margin at the top of the window or
13177 above what is displayed in the window. */
13180 /* Compute the vertical distance from PT to the scroll
13181 margin position. Give up if distance is greater than
13183 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13184 start_display (&it
, w
, pos
);
13186 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13187 it
.last_visible_y
, -1,
13188 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13189 dy
= it
.current_y
- y0
;
13190 if (dy
> scroll_max
)
13191 return SCROLLING_FAILED
;
13193 /* Compute new window start. */
13194 start_display (&it
, w
, startp
);
13196 if (arg_scroll_conservatively
)
13198 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13199 else if (scroll_step
|| temp_scroll_step
)
13200 amount_to_scroll
= scroll_max
;
13203 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13204 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13205 if (NUMBERP (aggressive
))
13207 double float_amount
= XFLOATINT (aggressive
) * height
;
13208 amount_to_scroll
= float_amount
;
13209 if (amount_to_scroll
== 0 && float_amount
> 0)
13210 amount_to_scroll
= 1;
13214 if (amount_to_scroll
<= 0)
13215 return SCROLLING_FAILED
;
13217 move_it_vertically_backward (&it
, amount_to_scroll
);
13218 startp
= it
.current
.pos
;
13222 /* Run window scroll functions. */
13223 startp
= run_window_scroll_functions (window
, startp
);
13225 /* Display the window. Give up if new fonts are loaded, or if point
13227 if (!try_window (window
, startp
, 0))
13228 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13229 else if (w
->cursor
.vpos
< 0)
13231 clear_glyph_matrix (w
->desired_matrix
);
13232 rc
= SCROLLING_FAILED
;
13236 /* Maybe forget recorded base line for line number display. */
13237 if (!just_this_one_p
13238 || current_buffer
->clip_changed
13239 || BEG_UNCHANGED
< CHARPOS (startp
))
13240 w
->base_line_number
= Qnil
;
13242 /* If cursor ends up on a partially visible line,
13243 treat that as being off the bottom of the screen. */
13244 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13245 /* It's possible that the cursor is on the first line of the
13246 buffer, which is partially obscured due to a vscroll
13247 (Bug#7537). In that case, avoid looping forever . */
13248 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13250 clear_glyph_matrix (w
->desired_matrix
);
13251 ++extra_scroll_margin_lines
;
13254 rc
= SCROLLING_SUCCESS
;
13261 /* Compute a suitable window start for window W if display of W starts
13262 on a continuation line. Value is non-zero if a new window start
13265 The new window start will be computed, based on W's width, starting
13266 from the start of the continued line. It is the start of the
13267 screen line with the minimum distance from the old start W->start. */
13270 compute_window_start_on_continuation_line (struct window
*w
)
13272 struct text_pos pos
, start_pos
;
13273 int window_start_changed_p
= 0;
13275 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13277 /* If window start is on a continuation line... Window start may be
13278 < BEGV in case there's invisible text at the start of the
13279 buffer (M-x rmail, for example). */
13280 if (CHARPOS (start_pos
) > BEGV
13281 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13284 struct glyph_row
*row
;
13286 /* Handle the case that the window start is out of range. */
13287 if (CHARPOS (start_pos
) < BEGV
)
13288 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13289 else if (CHARPOS (start_pos
) > ZV
)
13290 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13292 /* Find the start of the continued line. This should be fast
13293 because scan_buffer is fast (newline cache). */
13294 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13295 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13296 row
, DEFAULT_FACE_ID
);
13297 reseat_at_previous_visible_line_start (&it
);
13299 /* If the line start is "too far" away from the window start,
13300 say it takes too much time to compute a new window start. */
13301 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13302 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13304 int min_distance
, distance
;
13306 /* Move forward by display lines to find the new window
13307 start. If window width was enlarged, the new start can
13308 be expected to be > the old start. If window width was
13309 decreased, the new window start will be < the old start.
13310 So, we're looking for the display line start with the
13311 minimum distance from the old window start. */
13312 pos
= it
.current
.pos
;
13313 min_distance
= INFINITY
;
13314 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13315 distance
< min_distance
)
13317 min_distance
= distance
;
13318 pos
= it
.current
.pos
;
13319 move_it_by_lines (&it
, 1, 0);
13322 /* Set the window start there. */
13323 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13324 window_start_changed_p
= 1;
13328 return window_start_changed_p
;
13332 /* Try cursor movement in case text has not changed in window WINDOW,
13333 with window start STARTP. Value is
13335 CURSOR_MOVEMENT_SUCCESS if successful
13337 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13339 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13340 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13341 we want to scroll as if scroll-step were set to 1. See the code.
13343 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13344 which case we have to abort this redisplay, and adjust matrices
13349 CURSOR_MOVEMENT_SUCCESS
,
13350 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13351 CURSOR_MOVEMENT_MUST_SCROLL
,
13352 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13356 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13358 struct window
*w
= XWINDOW (window
);
13359 struct frame
*f
= XFRAME (w
->frame
);
13360 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13363 if (inhibit_try_cursor_movement
)
13367 /* Handle case where text has not changed, only point, and it has
13368 not moved off the frame. */
13369 if (/* Point may be in this window. */
13370 PT
>= CHARPOS (startp
)
13371 /* Selective display hasn't changed. */
13372 && !current_buffer
->clip_changed
13373 /* Function force-mode-line-update is used to force a thorough
13374 redisplay. It sets either windows_or_buffers_changed or
13375 update_mode_lines. So don't take a shortcut here for these
13377 && !update_mode_lines
13378 && !windows_or_buffers_changed
13379 && !cursor_type_changed
13380 /* Can't use this case if highlighting a region. When a
13381 region exists, cursor movement has to do more than just
13383 && !(!NILP (Vtransient_mark_mode
)
13384 && !NILP (BVAR (current_buffer
, mark_active
)))
13385 && NILP (w
->region_showing
)
13386 && NILP (Vshow_trailing_whitespace
)
13387 /* Right after splitting windows, last_point may be nil. */
13388 && INTEGERP (w
->last_point
)
13389 /* This code is not used for mini-buffer for the sake of the case
13390 of redisplaying to replace an echo area message; since in
13391 that case the mini-buffer contents per se are usually
13392 unchanged. This code is of no real use in the mini-buffer
13393 since the handling of this_line_start_pos, etc., in redisplay
13394 handles the same cases. */
13395 && !EQ (window
, minibuf_window
)
13396 /* When splitting windows or for new windows, it happens that
13397 redisplay is called with a nil window_end_vpos or one being
13398 larger than the window. This should really be fixed in
13399 window.c. I don't have this on my list, now, so we do
13400 approximately the same as the old redisplay code. --gerd. */
13401 && INTEGERP (w
->window_end_vpos
)
13402 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13403 && (FRAME_WINDOW_P (f
)
13404 || !overlay_arrow_in_current_buffer_p ()))
13406 int this_scroll_margin
, top_scroll_margin
;
13407 struct glyph_row
*row
= NULL
;
13410 debug_method_add (w
, "cursor movement");
13413 /* Scroll if point within this distance from the top or bottom
13414 of the window. This is a pixel value. */
13415 if (scroll_margin
> 0)
13417 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13418 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13421 this_scroll_margin
= 0;
13423 top_scroll_margin
= this_scroll_margin
;
13424 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13425 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13427 /* Start with the row the cursor was displayed during the last
13428 not paused redisplay. Give up if that row is not valid. */
13429 if (w
->last_cursor
.vpos
< 0
13430 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13431 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13434 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13435 if (row
->mode_line_p
)
13437 if (!row
->enabled_p
)
13438 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13441 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13443 int scroll_p
= 0, must_scroll
= 0;
13444 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13446 if (PT
> XFASTINT (w
->last_point
))
13448 /* Point has moved forward. */
13449 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13450 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13452 xassert (row
->enabled_p
);
13456 /* If the end position of a row equals the start
13457 position of the next row, and PT is at that position,
13458 we would rather display cursor in the next line. */
13459 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13460 && MATRIX_ROW_END_CHARPOS (row
) == PT
13461 && row
< w
->current_matrix
->rows
13462 + w
->current_matrix
->nrows
- 1
13463 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13464 && !cursor_row_p (w
, row
))
13467 /* If within the scroll margin, scroll. Note that
13468 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13469 the next line would be drawn, and that
13470 this_scroll_margin can be zero. */
13471 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13472 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13473 /* Line is completely visible last line in window
13474 and PT is to be set in the next line. */
13475 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13476 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13477 && !row
->ends_at_zv_p
13478 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13481 else if (PT
< XFASTINT (w
->last_point
))
13483 /* Cursor has to be moved backward. Note that PT >=
13484 CHARPOS (startp) because of the outer if-statement. */
13485 while (!row
->mode_line_p
13486 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13487 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13488 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13489 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13490 row
> w
->current_matrix
->rows
13491 && (row
-1)->ends_in_newline_from_string_p
))))
13492 && (row
->y
> top_scroll_margin
13493 || CHARPOS (startp
) == BEGV
))
13495 xassert (row
->enabled_p
);
13499 /* Consider the following case: Window starts at BEGV,
13500 there is invisible, intangible text at BEGV, so that
13501 display starts at some point START > BEGV. It can
13502 happen that we are called with PT somewhere between
13503 BEGV and START. Try to handle that case. */
13504 if (row
< w
->current_matrix
->rows
13505 || row
->mode_line_p
)
13507 row
= w
->current_matrix
->rows
;
13508 if (row
->mode_line_p
)
13512 /* Due to newlines in overlay strings, we may have to
13513 skip forward over overlay strings. */
13514 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13515 && MATRIX_ROW_END_CHARPOS (row
) == PT
13516 && !cursor_row_p (w
, row
))
13519 /* If within the scroll margin, scroll. */
13520 if (row
->y
< top_scroll_margin
13521 && CHARPOS (startp
) != BEGV
)
13526 /* Cursor did not move. So don't scroll even if cursor line
13527 is partially visible, as it was so before. */
13528 rc
= CURSOR_MOVEMENT_SUCCESS
;
13531 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13532 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13534 /* if PT is not in the glyph row, give up. */
13535 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13538 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13539 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13541 /* If rows are bidi-reordered and point moved, back up
13542 until we find a row that does not belong to a
13543 continuation line. This is because we must consider
13544 all rows of a continued line as candidates for the
13545 new cursor positioning, since row start and end
13546 positions change non-linearly with vertical position
13548 /* FIXME: Revisit this when glyph ``spilling'' in
13549 continuation lines' rows is implemented for
13550 bidi-reordered rows. */
13551 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13553 xassert (row
->enabled_p
);
13555 /* If we hit the beginning of the displayed portion
13556 without finding the first row of a continued
13558 if (row
<= w
->current_matrix
->rows
)
13560 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13568 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13569 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13570 && make_cursor_line_fully_visible_p
)
13572 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13573 && !row
->ends_at_zv_p
13574 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13575 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13576 else if (row
->height
> window_box_height (w
))
13578 /* If we end up in a partially visible line, let's
13579 make it fully visible, except when it's taller
13580 than the window, in which case we can't do much
13583 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13587 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13588 if (!cursor_row_fully_visible_p (w
, 0, 1))
13589 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13591 rc
= CURSOR_MOVEMENT_SUCCESS
;
13595 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13596 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13597 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13599 /* With bidi-reordered rows, there could be more than
13600 one candidate row whose start and end positions
13601 occlude point. We need to let set_cursor_from_row
13602 find the best candidate. */
13603 /* FIXME: Revisit this when glyph ``spilling'' in
13604 continuation lines' rows is implemented for
13605 bidi-reordered rows. */
13610 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13611 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13612 && cursor_row_p (w
, row
))
13613 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13615 /* As soon as we've found the first suitable row
13616 whose ends_at_zv_p flag is set, we are done. */
13618 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13620 rc
= CURSOR_MOVEMENT_SUCCESS
;
13625 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13626 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13627 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13628 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13629 /* If we didn't find any candidate rows, or exited the
13630 loop before all the candidates were examined, signal
13631 to the caller that this method failed. */
13632 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13633 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13634 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13636 rc
= CURSOR_MOVEMENT_SUCCESS
;
13642 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13644 rc
= CURSOR_MOVEMENT_SUCCESS
;
13649 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13650 && MATRIX_ROW_START_CHARPOS (row
) == PT
13651 && cursor_row_p (w
, row
));
13660 set_vertical_scroll_bar (struct window
*w
)
13662 EMACS_INT start
, end
, whole
;
13664 /* Calculate the start and end positions for the current window.
13665 At some point, it would be nice to choose between scrollbars
13666 which reflect the whole buffer size, with special markers
13667 indicating narrowing, and scrollbars which reflect only the
13670 Note that mini-buffers sometimes aren't displaying any text. */
13671 if (!MINI_WINDOW_P (w
)
13672 || (w
== XWINDOW (minibuf_window
)
13673 && NILP (echo_area_buffer
[0])))
13675 struct buffer
*buf
= XBUFFER (w
->buffer
);
13676 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13677 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13678 /* I don't think this is guaranteed to be right. For the
13679 moment, we'll pretend it is. */
13680 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13684 if (whole
< (end
- start
))
13685 whole
= end
- start
;
13688 start
= end
= whole
= 0;
13690 /* Indicate what this scroll bar ought to be displaying now. */
13691 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13692 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13693 (w
, end
- start
, whole
, start
);
13697 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13698 selected_window is redisplayed.
13700 We can return without actually redisplaying the window if
13701 fonts_changed_p is nonzero. In that case, redisplay_internal will
13705 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13707 struct window
*w
= XWINDOW (window
);
13708 struct frame
*f
= XFRAME (w
->frame
);
13709 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13710 struct buffer
*old
= current_buffer
;
13711 struct text_pos lpoint
, opoint
, startp
;
13712 int update_mode_line
;
13715 /* Record it now because it's overwritten. */
13716 int current_matrix_up_to_date_p
= 0;
13717 int used_current_matrix_p
= 0;
13718 /* This is less strict than current_matrix_up_to_date_p.
13719 It indictes that the buffer contents and narrowing are unchanged. */
13720 int buffer_unchanged_p
= 0;
13721 int temp_scroll_step
= 0;
13722 int count
= SPECPDL_INDEX ();
13724 int centering_position
= -1;
13725 int last_line_misfit
= 0;
13726 EMACS_INT beg_unchanged
, end_unchanged
;
13728 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13731 /* W must be a leaf window here. */
13732 xassert (!NILP (w
->buffer
));
13734 *w
->desired_matrix
->method
= 0;
13738 reconsider_clip_changes (w
, buffer
);
13740 /* Has the mode line to be updated? */
13741 update_mode_line
= (!NILP (w
->update_mode_line
)
13742 || update_mode_lines
13743 || buffer
->clip_changed
13744 || buffer
->prevent_redisplay_optimizations_p
);
13746 if (MINI_WINDOW_P (w
))
13748 if (w
== XWINDOW (echo_area_window
)
13749 && !NILP (echo_area_buffer
[0]))
13751 if (update_mode_line
)
13752 /* We may have to update a tty frame's menu bar or a
13753 tool-bar. Example `M-x C-h C-h C-g'. */
13754 goto finish_menu_bars
;
13756 /* We've already displayed the echo area glyphs in this window. */
13757 goto finish_scroll_bars
;
13759 else if ((w
!= XWINDOW (minibuf_window
)
13760 || minibuf_level
== 0)
13761 /* When buffer is nonempty, redisplay window normally. */
13762 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13763 /* Quail displays non-mini buffers in minibuffer window.
13764 In that case, redisplay the window normally. */
13765 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13767 /* W is a mini-buffer window, but it's not active, so clear
13769 int yb
= window_text_bottom_y (w
);
13770 struct glyph_row
*row
;
13773 for (y
= 0, row
= w
->desired_matrix
->rows
;
13775 y
+= row
->height
, ++row
)
13776 blank_row (w
, row
, y
);
13777 goto finish_scroll_bars
;
13780 clear_glyph_matrix (w
->desired_matrix
);
13783 /* Otherwise set up data on this window; select its buffer and point
13785 /* Really select the buffer, for the sake of buffer-local
13787 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13789 current_matrix_up_to_date_p
13790 = (!NILP (w
->window_end_valid
)
13791 && !current_buffer
->clip_changed
13792 && !current_buffer
->prevent_redisplay_optimizations_p
13793 && XFASTINT (w
->last_modified
) >= MODIFF
13794 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13796 /* Run the window-bottom-change-functions
13797 if it is possible that the text on the screen has changed
13798 (either due to modification of the text, or any other reason). */
13799 if (!current_matrix_up_to_date_p
13800 && !NILP (Vwindow_text_change_functions
))
13802 safe_run_hooks (Qwindow_text_change_functions
);
13806 beg_unchanged
= BEG_UNCHANGED
;
13807 end_unchanged
= END_UNCHANGED
;
13809 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13811 specbind (Qinhibit_point_motion_hooks
, Qt
);
13814 = (!NILP (w
->window_end_valid
)
13815 && !current_buffer
->clip_changed
13816 && XFASTINT (w
->last_modified
) >= MODIFF
13817 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13819 /* When windows_or_buffers_changed is non-zero, we can't rely on
13820 the window end being valid, so set it to nil there. */
13821 if (windows_or_buffers_changed
)
13823 /* If window starts on a continuation line, maybe adjust the
13824 window start in case the window's width changed. */
13825 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13826 compute_window_start_on_continuation_line (w
);
13828 w
->window_end_valid
= Qnil
;
13831 /* Some sanity checks. */
13832 CHECK_WINDOW_END (w
);
13833 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13835 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13838 /* If %c is in mode line, update it if needed. */
13839 if (!NILP (w
->column_number_displayed
)
13840 /* This alternative quickly identifies a common case
13841 where no change is needed. */
13842 && !(PT
== XFASTINT (w
->last_point
)
13843 && XFASTINT (w
->last_modified
) >= MODIFF
13844 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13845 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13846 update_mode_line
= 1;
13848 /* Count number of windows showing the selected buffer. An indirect
13849 buffer counts as its base buffer. */
13850 if (!just_this_one_p
)
13852 struct buffer
*current_base
, *window_base
;
13853 current_base
= current_buffer
;
13854 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13855 if (current_base
->base_buffer
)
13856 current_base
= current_base
->base_buffer
;
13857 if (window_base
->base_buffer
)
13858 window_base
= window_base
->base_buffer
;
13859 if (current_base
== window_base
)
13863 /* Point refers normally to the selected window. For any other
13864 window, set up appropriate value. */
13865 if (!EQ (window
, selected_window
))
13867 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13868 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13872 new_pt_byte
= BEGV_BYTE
;
13873 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13875 else if (new_pt
> (ZV
- 1))
13878 new_pt_byte
= ZV_BYTE
;
13879 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13882 /* We don't use SET_PT so that the point-motion hooks don't run. */
13883 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13886 /* If any of the character widths specified in the display table
13887 have changed, invalidate the width run cache. It's true that
13888 this may be a bit late to catch such changes, but the rest of
13889 redisplay goes (non-fatally) haywire when the display table is
13890 changed, so why should we worry about doing any better? */
13891 if (current_buffer
->width_run_cache
)
13893 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13895 if (! disptab_matches_widthtab (disptab
,
13896 XVECTOR (BVAR (current_buffer
, width_table
))))
13898 invalidate_region_cache (current_buffer
,
13899 current_buffer
->width_run_cache
,
13901 recompute_width_table (current_buffer
, disptab
);
13905 /* If window-start is screwed up, choose a new one. */
13906 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13909 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13911 /* If someone specified a new starting point but did not insist,
13912 check whether it can be used. */
13913 if (!NILP (w
->optional_new_start
)
13914 && CHARPOS (startp
) >= BEGV
13915 && CHARPOS (startp
) <= ZV
)
13917 w
->optional_new_start
= Qnil
;
13918 start_display (&it
, w
, startp
);
13919 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13920 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13921 if (IT_CHARPOS (it
) == PT
)
13922 w
->force_start
= Qt
;
13923 /* IT may overshoot PT if text at PT is invisible. */
13924 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13925 w
->force_start
= Qt
;
13930 /* Handle case where place to start displaying has been specified,
13931 unless the specified location is outside the accessible range. */
13932 if (!NILP (w
->force_start
)
13933 || w
->frozen_window_start_p
)
13935 /* We set this later on if we have to adjust point. */
13938 w
->force_start
= Qnil
;
13940 w
->window_end_valid
= Qnil
;
13942 /* Forget any recorded base line for line number display. */
13943 if (!buffer_unchanged_p
)
13944 w
->base_line_number
= Qnil
;
13946 /* Redisplay the mode line. Select the buffer properly for that.
13947 Also, run the hook window-scroll-functions
13948 because we have scrolled. */
13949 /* Note, we do this after clearing force_start because
13950 if there's an error, it is better to forget about force_start
13951 than to get into an infinite loop calling the hook functions
13952 and having them get more errors. */
13953 if (!update_mode_line
13954 || ! NILP (Vwindow_scroll_functions
))
13956 update_mode_line
= 1;
13957 w
->update_mode_line
= Qt
;
13958 startp
= run_window_scroll_functions (window
, startp
);
13961 w
->last_modified
= make_number (0);
13962 w
->last_overlay_modified
= make_number (0);
13963 if (CHARPOS (startp
) < BEGV
)
13964 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13965 else if (CHARPOS (startp
) > ZV
)
13966 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13968 /* Redisplay, then check if cursor has been set during the
13969 redisplay. Give up if new fonts were loaded. */
13970 /* We used to issue a CHECK_MARGINS argument to try_window here,
13971 but this causes scrolling to fail when point begins inside
13972 the scroll margin (bug#148) -- cyd */
13973 if (!try_window (window
, startp
, 0))
13975 w
->force_start
= Qt
;
13976 clear_glyph_matrix (w
->desired_matrix
);
13977 goto need_larger_matrices
;
13980 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13982 /* If point does not appear, try to move point so it does
13983 appear. The desired matrix has been built above, so we
13984 can use it here. */
13985 new_vpos
= window_box_height (w
) / 2;
13988 if (!cursor_row_fully_visible_p (w
, 0, 0))
13990 /* Point does appear, but on a line partly visible at end of window.
13991 Move it back to a fully-visible line. */
13992 new_vpos
= window_box_height (w
);
13995 /* If we need to move point for either of the above reasons,
13996 now actually do it. */
13999 struct glyph_row
*row
;
14001 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14002 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14005 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14006 MATRIX_ROW_START_BYTEPOS (row
));
14008 if (w
!= XWINDOW (selected_window
))
14009 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14010 else if (current_buffer
== old
)
14011 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14013 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14015 /* If we are highlighting the region, then we just changed
14016 the region, so redisplay to show it. */
14017 if (!NILP (Vtransient_mark_mode
)
14018 && !NILP (BVAR (current_buffer
, mark_active
)))
14020 clear_glyph_matrix (w
->desired_matrix
);
14021 if (!try_window (window
, startp
, 0))
14022 goto need_larger_matrices
;
14027 debug_method_add (w
, "forced window start");
14032 /* Handle case where text has not changed, only point, and it has
14033 not moved off the frame, and we are not retrying after hscroll.
14034 (current_matrix_up_to_date_p is nonzero when retrying.) */
14035 if (current_matrix_up_to_date_p
14036 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14037 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14041 case CURSOR_MOVEMENT_SUCCESS
:
14042 used_current_matrix_p
= 1;
14045 case CURSOR_MOVEMENT_MUST_SCROLL
:
14046 goto try_to_scroll
;
14052 /* If current starting point was originally the beginning of a line
14053 but no longer is, find a new starting point. */
14054 else if (!NILP (w
->start_at_line_beg
)
14055 && !(CHARPOS (startp
) <= BEGV
14056 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14059 debug_method_add (w
, "recenter 1");
14064 /* Try scrolling with try_window_id. Value is > 0 if update has
14065 been done, it is -1 if we know that the same window start will
14066 not work. It is 0 if unsuccessful for some other reason. */
14067 else if ((tem
= try_window_id (w
)) != 0)
14070 debug_method_add (w
, "try_window_id %d", tem
);
14073 if (fonts_changed_p
)
14074 goto need_larger_matrices
;
14078 /* Otherwise try_window_id has returned -1 which means that we
14079 don't want the alternative below this comment to execute. */
14081 else if (CHARPOS (startp
) >= BEGV
14082 && CHARPOS (startp
) <= ZV
14083 && PT
>= CHARPOS (startp
)
14084 && (CHARPOS (startp
) < ZV
14085 /* Avoid starting at end of buffer. */
14086 || CHARPOS (startp
) == BEGV
14087 || (XFASTINT (w
->last_modified
) >= MODIFF
14088 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14091 /* If first window line is a continuation line, and window start
14092 is inside the modified region, but the first change is before
14093 current window start, we must select a new window start.
14095 However, if this is the result of a down-mouse event (e.g. by
14096 extending the mouse-drag-overlay), we don't want to select a
14097 new window start, since that would change the position under
14098 the mouse, resulting in an unwanted mouse-movement rather
14099 than a simple mouse-click. */
14100 if (NILP (w
->start_at_line_beg
)
14101 && NILP (do_mouse_tracking
)
14102 && CHARPOS (startp
) > BEGV
14103 && CHARPOS (startp
) > BEG
+ beg_unchanged
14104 && CHARPOS (startp
) <= Z
- end_unchanged
14105 /* Even if w->start_at_line_beg is nil, a new window may
14106 start at a line_beg, since that's how set_buffer_window
14107 sets it. So, we need to check the return value of
14108 compute_window_start_on_continuation_line. (See also
14110 && XMARKER (w
->start
)->buffer
== current_buffer
14111 && compute_window_start_on_continuation_line (w
))
14113 w
->force_start
= Qt
;
14114 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14119 debug_method_add (w
, "same window start");
14122 /* Try to redisplay starting at same place as before.
14123 If point has not moved off frame, accept the results. */
14124 if (!current_matrix_up_to_date_p
14125 /* Don't use try_window_reusing_current_matrix in this case
14126 because a window scroll function can have changed the
14128 || !NILP (Vwindow_scroll_functions
)
14129 || MINI_WINDOW_P (w
)
14130 || !(used_current_matrix_p
14131 = try_window_reusing_current_matrix (w
)))
14133 IF_DEBUG (debug_method_add (w
, "1"));
14134 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14135 /* -1 means we need to scroll.
14136 0 means we need new matrices, but fonts_changed_p
14137 is set in that case, so we will detect it below. */
14138 goto try_to_scroll
;
14141 if (fonts_changed_p
)
14142 goto need_larger_matrices
;
14144 if (w
->cursor
.vpos
>= 0)
14146 if (!just_this_one_p
14147 || current_buffer
->clip_changed
14148 || BEG_UNCHANGED
< CHARPOS (startp
))
14149 /* Forget any recorded base line for line number display. */
14150 w
->base_line_number
= Qnil
;
14152 if (!cursor_row_fully_visible_p (w
, 1, 0))
14154 clear_glyph_matrix (w
->desired_matrix
);
14155 last_line_misfit
= 1;
14157 /* Drop through and scroll. */
14162 clear_glyph_matrix (w
->desired_matrix
);
14167 w
->last_modified
= make_number (0);
14168 w
->last_overlay_modified
= make_number (0);
14170 /* Redisplay the mode line. Select the buffer properly for that. */
14171 if (!update_mode_line
)
14173 update_mode_line
= 1;
14174 w
->update_mode_line
= Qt
;
14177 /* Try to scroll by specified few lines. */
14178 if ((scroll_conservatively
14179 || emacs_scroll_step
14180 || temp_scroll_step
14181 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14182 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14183 && CHARPOS (startp
) >= BEGV
14184 && CHARPOS (startp
) <= ZV
)
14186 /* The function returns -1 if new fonts were loaded, 1 if
14187 successful, 0 if not successful. */
14188 int ss
= try_scrolling (window
, just_this_one_p
,
14189 scroll_conservatively
,
14191 temp_scroll_step
, last_line_misfit
);
14194 case SCROLLING_SUCCESS
:
14197 case SCROLLING_NEED_LARGER_MATRICES
:
14198 goto need_larger_matrices
;
14200 case SCROLLING_FAILED
:
14208 /* Finally, just choose a place to start which positions point
14209 according to user preferences. */
14214 debug_method_add (w
, "recenter");
14217 /* w->vscroll = 0; */
14219 /* Forget any previously recorded base line for line number display. */
14220 if (!buffer_unchanged_p
)
14221 w
->base_line_number
= Qnil
;
14223 /* Determine the window start relative to point. */
14224 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14225 it
.current_y
= it
.last_visible_y
;
14226 if (centering_position
< 0)
14230 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14232 int scrolling_up
= PT
> CHARPOS (startp
) + margin
;
14233 Lisp_Object aggressive
=
14235 ? BVAR (current_buffer
, scroll_up_aggressively
)
14236 : BVAR (current_buffer
, scroll_down_aggressively
);
14238 if (!MINI_WINDOW_P (w
)
14239 && scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
))
14243 /* Setting scroll-conservatively overrides
14244 scroll-*-aggressively. */
14245 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14247 double float_amount
= XFLOATINT (aggressive
);
14249 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14250 if (pt_offset
== 0 && float_amount
> 0)
14255 /* Compute how much to move the window start backward from
14256 point so that point will be displayed where the user
14260 centering_position
= it
.last_visible_y
;
14262 centering_position
-= pt_offset
;
14263 centering_position
-=
14264 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14265 /* Don't let point enter the scroll margin near top of
14267 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14268 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14271 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14274 /* Move backward from point half the height of the window. */
14275 centering_position
= window_box_height (w
) / 2;
14277 move_it_vertically_backward (&it
, centering_position
);
14279 xassert (IT_CHARPOS (it
) >= BEGV
);
14281 /* The function move_it_vertically_backward may move over more
14282 than the specified y-distance. If it->w is small, e.g. a
14283 mini-buffer window, we may end up in front of the window's
14284 display area. Start displaying at the start of the line
14285 containing PT in this case. */
14286 if (it
.current_y
<= 0)
14288 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14289 move_it_vertically_backward (&it
, 0);
14293 it
.current_x
= it
.hpos
= 0;
14295 /* Set the window start position here explicitly, to avoid an
14296 infinite loop in case the functions in window-scroll-functions
14298 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14300 /* Run scroll hooks. */
14301 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14303 /* Redisplay the window. */
14304 if (!current_matrix_up_to_date_p
14305 || windows_or_buffers_changed
14306 || cursor_type_changed
14307 /* Don't use try_window_reusing_current_matrix in this case
14308 because it can have changed the buffer. */
14309 || !NILP (Vwindow_scroll_functions
)
14310 || !just_this_one_p
14311 || MINI_WINDOW_P (w
)
14312 || !(used_current_matrix_p
14313 = try_window_reusing_current_matrix (w
)))
14314 try_window (window
, startp
, 0);
14316 /* If new fonts have been loaded (due to fontsets), give up. We
14317 have to start a new redisplay since we need to re-adjust glyph
14319 if (fonts_changed_p
)
14320 goto need_larger_matrices
;
14322 /* If cursor did not appear assume that the middle of the window is
14323 in the first line of the window. Do it again with the next line.
14324 (Imagine a window of height 100, displaying two lines of height
14325 60. Moving back 50 from it->last_visible_y will end in the first
14327 if (w
->cursor
.vpos
< 0)
14329 if (!NILP (w
->window_end_valid
)
14330 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14332 clear_glyph_matrix (w
->desired_matrix
);
14333 move_it_by_lines (&it
, 1, 0);
14334 try_window (window
, it
.current
.pos
, 0);
14336 else if (PT
< IT_CHARPOS (it
))
14338 clear_glyph_matrix (w
->desired_matrix
);
14339 move_it_by_lines (&it
, -1, 0);
14340 try_window (window
, it
.current
.pos
, 0);
14344 /* Not much we can do about it. */
14348 /* Consider the following case: Window starts at BEGV, there is
14349 invisible, intangible text at BEGV, so that display starts at
14350 some point START > BEGV. It can happen that we are called with
14351 PT somewhere between BEGV and START. Try to handle that case. */
14352 if (w
->cursor
.vpos
< 0)
14354 struct glyph_row
*row
= w
->current_matrix
->rows
;
14355 if (row
->mode_line_p
)
14357 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14360 if (!cursor_row_fully_visible_p (w
, 0, 0))
14362 /* If vscroll is enabled, disable it and try again. */
14366 clear_glyph_matrix (w
->desired_matrix
);
14370 /* If centering point failed to make the whole line visible,
14371 put point at the top instead. That has to make the whole line
14372 visible, if it can be done. */
14373 if (centering_position
== 0)
14376 clear_glyph_matrix (w
->desired_matrix
);
14377 centering_position
= 0;
14383 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14384 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14385 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14388 /* Display the mode line, if we must. */
14389 if ((update_mode_line
14390 /* If window not full width, must redo its mode line
14391 if (a) the window to its side is being redone and
14392 (b) we do a frame-based redisplay. This is a consequence
14393 of how inverted lines are drawn in frame-based redisplay. */
14394 || (!just_this_one_p
14395 && !FRAME_WINDOW_P (f
)
14396 && !WINDOW_FULL_WIDTH_P (w
))
14397 /* Line number to display. */
14398 || INTEGERP (w
->base_line_pos
)
14399 /* Column number is displayed and different from the one displayed. */
14400 || (!NILP (w
->column_number_displayed
)
14401 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14402 /* This means that the window has a mode line. */
14403 && (WINDOW_WANTS_MODELINE_P (w
)
14404 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14406 display_mode_lines (w
);
14408 /* If mode line height has changed, arrange for a thorough
14409 immediate redisplay using the correct mode line height. */
14410 if (WINDOW_WANTS_MODELINE_P (w
)
14411 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14413 fonts_changed_p
= 1;
14414 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14415 = DESIRED_MODE_LINE_HEIGHT (w
);
14418 /* If header line height has changed, arrange for a thorough
14419 immediate redisplay using the correct header line height. */
14420 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14421 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14423 fonts_changed_p
= 1;
14424 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14425 = DESIRED_HEADER_LINE_HEIGHT (w
);
14428 if (fonts_changed_p
)
14429 goto need_larger_matrices
;
14432 if (!line_number_displayed
14433 && !BUFFERP (w
->base_line_pos
))
14435 w
->base_line_pos
= Qnil
;
14436 w
->base_line_number
= Qnil
;
14441 /* When we reach a frame's selected window, redo the frame's menu bar. */
14442 if (update_mode_line
14443 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14445 int redisplay_menu_p
= 0;
14446 int redisplay_tool_bar_p
= 0;
14448 if (FRAME_WINDOW_P (f
))
14450 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14451 || defined (HAVE_NS) || defined (USE_GTK)
14452 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14454 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14458 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14460 if (redisplay_menu_p
)
14461 display_menu_bar (w
);
14463 #ifdef HAVE_WINDOW_SYSTEM
14464 if (FRAME_WINDOW_P (f
))
14466 #if defined (USE_GTK) || defined (HAVE_NS)
14467 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14469 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14470 && (FRAME_TOOL_BAR_LINES (f
) > 0
14471 || !NILP (Vauto_resize_tool_bars
));
14474 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14476 ignore_mouse_drag_p
= 1;
14482 #ifdef HAVE_WINDOW_SYSTEM
14483 if (FRAME_WINDOW_P (f
)
14484 && update_window_fringes (w
, (just_this_one_p
14485 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14486 || w
->pseudo_window_p
)))
14490 if (draw_window_fringes (w
, 1))
14491 x_draw_vertical_border (w
);
14495 #endif /* HAVE_WINDOW_SYSTEM */
14497 /* We go to this label, with fonts_changed_p nonzero,
14498 if it is necessary to try again using larger glyph matrices.
14499 We have to redeem the scroll bar even in this case,
14500 because the loop in redisplay_internal expects that. */
14501 need_larger_matrices
:
14503 finish_scroll_bars
:
14505 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14507 /* Set the thumb's position and size. */
14508 set_vertical_scroll_bar (w
);
14510 /* Note that we actually used the scroll bar attached to this
14511 window, so it shouldn't be deleted at the end of redisplay. */
14512 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14513 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14516 /* Restore current_buffer and value of point in it. The window
14517 update may have changed the buffer, so first make sure `opoint'
14518 is still valid (Bug#6177). */
14519 if (CHARPOS (opoint
) < BEGV
)
14520 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14521 else if (CHARPOS (opoint
) > ZV
)
14522 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14524 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14526 set_buffer_internal_1 (old
);
14527 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14528 shorter. This can be caused by log truncation in *Messages*. */
14529 if (CHARPOS (lpoint
) <= ZV
)
14530 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14532 unbind_to (count
, Qnil
);
14536 /* Build the complete desired matrix of WINDOW with a window start
14537 buffer position POS.
14539 Value is 1 if successful. It is zero if fonts were loaded during
14540 redisplay which makes re-adjusting glyph matrices necessary, and -1
14541 if point would appear in the scroll margins.
14542 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14543 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14547 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14549 struct window
*w
= XWINDOW (window
);
14551 struct glyph_row
*last_text_row
= NULL
;
14552 struct frame
*f
= XFRAME (w
->frame
);
14554 /* Make POS the new window start. */
14555 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14557 /* Mark cursor position as unknown. No overlay arrow seen. */
14558 w
->cursor
.vpos
= -1;
14559 overlay_arrow_seen
= 0;
14561 /* Initialize iterator and info to start at POS. */
14562 start_display (&it
, w
, pos
);
14564 /* Display all lines of W. */
14565 while (it
.current_y
< it
.last_visible_y
)
14567 if (display_line (&it
))
14568 last_text_row
= it
.glyph_row
- 1;
14569 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14573 /* Don't let the cursor end in the scroll margins. */
14574 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14575 && !MINI_WINDOW_P (w
))
14577 int this_scroll_margin
;
14579 if (scroll_margin
> 0)
14581 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14582 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14585 this_scroll_margin
= 0;
14587 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14588 && w
->cursor
.y
< this_scroll_margin
14589 && CHARPOS (pos
) > BEGV
14590 && IT_CHARPOS (it
) < ZV
)
14591 /* rms: considering make_cursor_line_fully_visible_p here
14592 seems to give wrong results. We don't want to recenter
14593 when the last line is partly visible, we want to allow
14594 that case to be handled in the usual way. */
14595 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14597 w
->cursor
.vpos
= -1;
14598 clear_glyph_matrix (w
->desired_matrix
);
14603 /* If bottom moved off end of frame, change mode line percentage. */
14604 if (XFASTINT (w
->window_end_pos
) <= 0
14605 && Z
!= IT_CHARPOS (it
))
14606 w
->update_mode_line
= Qt
;
14608 /* Set window_end_pos to the offset of the last character displayed
14609 on the window from the end of current_buffer. Set
14610 window_end_vpos to its row number. */
14613 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14614 w
->window_end_bytepos
14615 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14617 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14619 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14620 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14621 ->displays_text_p
);
14625 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14626 w
->window_end_pos
= make_number (Z
- ZV
);
14627 w
->window_end_vpos
= make_number (0);
14630 /* But that is not valid info until redisplay finishes. */
14631 w
->window_end_valid
= Qnil
;
14637 /************************************************************************
14638 Window redisplay reusing current matrix when buffer has not changed
14639 ************************************************************************/
14641 /* Try redisplay of window W showing an unchanged buffer with a
14642 different window start than the last time it was displayed by
14643 reusing its current matrix. Value is non-zero if successful.
14644 W->start is the new window start. */
14647 try_window_reusing_current_matrix (struct window
*w
)
14649 struct frame
*f
= XFRAME (w
->frame
);
14650 struct glyph_row
*bottom_row
;
14653 struct text_pos start
, new_start
;
14654 int nrows_scrolled
, i
;
14655 struct glyph_row
*last_text_row
;
14656 struct glyph_row
*last_reused_text_row
;
14657 struct glyph_row
*start_row
;
14658 int start_vpos
, min_y
, max_y
;
14661 if (inhibit_try_window_reusing
)
14665 if (/* This function doesn't handle terminal frames. */
14666 !FRAME_WINDOW_P (f
)
14667 /* Don't try to reuse the display if windows have been split
14669 || windows_or_buffers_changed
14670 || cursor_type_changed
)
14673 /* Can't do this if region may have changed. */
14674 if ((!NILP (Vtransient_mark_mode
)
14675 && !NILP (BVAR (current_buffer
, mark_active
)))
14676 || !NILP (w
->region_showing
)
14677 || !NILP (Vshow_trailing_whitespace
))
14680 /* If top-line visibility has changed, give up. */
14681 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14682 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14685 /* Give up if old or new display is scrolled vertically. We could
14686 make this function handle this, but right now it doesn't. */
14687 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14688 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14691 /* The variable new_start now holds the new window start. The old
14692 start `start' can be determined from the current matrix. */
14693 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14694 start
= start_row
->minpos
;
14695 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14697 /* Clear the desired matrix for the display below. */
14698 clear_glyph_matrix (w
->desired_matrix
);
14700 if (CHARPOS (new_start
) <= CHARPOS (start
))
14704 /* Don't use this method if the display starts with an ellipsis
14705 displayed for invisible text. It's not easy to handle that case
14706 below, and it's certainly not worth the effort since this is
14707 not a frequent case. */
14708 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14711 IF_DEBUG (debug_method_add (w
, "twu1"));
14713 /* Display up to a row that can be reused. The variable
14714 last_text_row is set to the last row displayed that displays
14715 text. Note that it.vpos == 0 if or if not there is a
14716 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14717 start_display (&it
, w
, new_start
);
14718 first_row_y
= it
.current_y
;
14719 w
->cursor
.vpos
= -1;
14720 last_text_row
= last_reused_text_row
= NULL
;
14722 while (it
.current_y
< it
.last_visible_y
14723 && !fonts_changed_p
)
14725 /* If we have reached into the characters in the START row,
14726 that means the line boundaries have changed. So we
14727 can't start copying with the row START. Maybe it will
14728 work to start copying with the following row. */
14729 while (IT_CHARPOS (it
) > CHARPOS (start
))
14731 /* Advance to the next row as the "start". */
14733 start
= start_row
->minpos
;
14734 /* If there are no more rows to try, or just one, give up. */
14735 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14736 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14737 || CHARPOS (start
) == ZV
)
14739 clear_glyph_matrix (w
->desired_matrix
);
14743 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14745 /* If we have reached alignment,
14746 we can copy the rest of the rows. */
14747 if (IT_CHARPOS (it
) == CHARPOS (start
))
14750 if (display_line (&it
))
14751 last_text_row
= it
.glyph_row
- 1;
14754 /* A value of current_y < last_visible_y means that we stopped
14755 at the previous window start, which in turn means that we
14756 have at least one reusable row. */
14757 if (it
.current_y
< it
.last_visible_y
)
14759 struct glyph_row
*row
;
14761 /* IT.vpos always starts from 0; it counts text lines. */
14762 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14764 /* Find PT if not already found in the lines displayed. */
14765 if (w
->cursor
.vpos
< 0)
14767 int dy
= it
.current_y
- start_row
->y
;
14769 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14770 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14772 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14773 dy
, nrows_scrolled
);
14776 clear_glyph_matrix (w
->desired_matrix
);
14781 /* Scroll the display. Do it before the current matrix is
14782 changed. The problem here is that update has not yet
14783 run, i.e. part of the current matrix is not up to date.
14784 scroll_run_hook will clear the cursor, and use the
14785 current matrix to get the height of the row the cursor is
14787 run
.current_y
= start_row
->y
;
14788 run
.desired_y
= it
.current_y
;
14789 run
.height
= it
.last_visible_y
- it
.current_y
;
14791 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14794 FRAME_RIF (f
)->update_window_begin_hook (w
);
14795 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14796 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14797 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14801 /* Shift current matrix down by nrows_scrolled lines. */
14802 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14803 rotate_matrix (w
->current_matrix
,
14805 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14808 /* Disable lines that must be updated. */
14809 for (i
= 0; i
< nrows_scrolled
; ++i
)
14810 (start_row
+ i
)->enabled_p
= 0;
14812 /* Re-compute Y positions. */
14813 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14814 max_y
= it
.last_visible_y
;
14815 for (row
= start_row
+ nrows_scrolled
;
14819 row
->y
= it
.current_y
;
14820 row
->visible_height
= row
->height
;
14822 if (row
->y
< min_y
)
14823 row
->visible_height
-= min_y
- row
->y
;
14824 if (row
->y
+ row
->height
> max_y
)
14825 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14826 row
->redraw_fringe_bitmaps_p
= 1;
14828 it
.current_y
+= row
->height
;
14830 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14831 last_reused_text_row
= row
;
14832 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14836 /* Disable lines in the current matrix which are now
14837 below the window. */
14838 for (++row
; row
< bottom_row
; ++row
)
14839 row
->enabled_p
= row
->mode_line_p
= 0;
14842 /* Update window_end_pos etc.; last_reused_text_row is the last
14843 reused row from the current matrix containing text, if any.
14844 The value of last_text_row is the last displayed line
14845 containing text. */
14846 if (last_reused_text_row
)
14848 w
->window_end_bytepos
14849 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14851 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14853 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14854 w
->current_matrix
));
14856 else if (last_text_row
)
14858 w
->window_end_bytepos
14859 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14861 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14863 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14867 /* This window must be completely empty. */
14868 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14869 w
->window_end_pos
= make_number (Z
- ZV
);
14870 w
->window_end_vpos
= make_number (0);
14872 w
->window_end_valid
= Qnil
;
14874 /* Update hint: don't try scrolling again in update_window. */
14875 w
->desired_matrix
->no_scrolling_p
= 1;
14878 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14882 else if (CHARPOS (new_start
) > CHARPOS (start
))
14884 struct glyph_row
*pt_row
, *row
;
14885 struct glyph_row
*first_reusable_row
;
14886 struct glyph_row
*first_row_to_display
;
14888 int yb
= window_text_bottom_y (w
);
14890 /* Find the row starting at new_start, if there is one. Don't
14891 reuse a partially visible line at the end. */
14892 first_reusable_row
= start_row
;
14893 while (first_reusable_row
->enabled_p
14894 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14895 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14896 < CHARPOS (new_start
)))
14897 ++first_reusable_row
;
14899 /* Give up if there is no row to reuse. */
14900 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14901 || !first_reusable_row
->enabled_p
14902 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14903 != CHARPOS (new_start
)))
14906 /* We can reuse fully visible rows beginning with
14907 first_reusable_row to the end of the window. Set
14908 first_row_to_display to the first row that cannot be reused.
14909 Set pt_row to the row containing point, if there is any. */
14911 for (first_row_to_display
= first_reusable_row
;
14912 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14913 ++first_row_to_display
)
14915 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14916 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14917 pt_row
= first_row_to_display
;
14920 /* Start displaying at the start of first_row_to_display. */
14921 xassert (first_row_to_display
->y
< yb
);
14922 init_to_row_start (&it
, w
, first_row_to_display
);
14924 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14926 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14928 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14929 + WINDOW_HEADER_LINE_HEIGHT (w
));
14931 /* Display lines beginning with first_row_to_display in the
14932 desired matrix. Set last_text_row to the last row displayed
14933 that displays text. */
14934 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14935 if (pt_row
== NULL
)
14936 w
->cursor
.vpos
= -1;
14937 last_text_row
= NULL
;
14938 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14939 if (display_line (&it
))
14940 last_text_row
= it
.glyph_row
- 1;
14942 /* If point is in a reused row, adjust y and vpos of the cursor
14946 w
->cursor
.vpos
-= nrows_scrolled
;
14947 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14950 /* Give up if point isn't in a row displayed or reused. (This
14951 also handles the case where w->cursor.vpos < nrows_scrolled
14952 after the calls to display_line, which can happen with scroll
14953 margins. See bug#1295.) */
14954 if (w
->cursor
.vpos
< 0)
14956 clear_glyph_matrix (w
->desired_matrix
);
14960 /* Scroll the display. */
14961 run
.current_y
= first_reusable_row
->y
;
14962 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14963 run
.height
= it
.last_visible_y
- run
.current_y
;
14964 dy
= run
.current_y
- run
.desired_y
;
14969 FRAME_RIF (f
)->update_window_begin_hook (w
);
14970 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14971 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14972 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14976 /* Adjust Y positions of reused rows. */
14977 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14978 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14979 max_y
= it
.last_visible_y
;
14980 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14983 row
->visible_height
= row
->height
;
14984 if (row
->y
< min_y
)
14985 row
->visible_height
-= min_y
- row
->y
;
14986 if (row
->y
+ row
->height
> max_y
)
14987 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14988 row
->redraw_fringe_bitmaps_p
= 1;
14991 /* Scroll the current matrix. */
14992 xassert (nrows_scrolled
> 0);
14993 rotate_matrix (w
->current_matrix
,
14995 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14998 /* Disable rows not reused. */
14999 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15000 row
->enabled_p
= 0;
15002 /* Point may have moved to a different line, so we cannot assume that
15003 the previous cursor position is valid; locate the correct row. */
15006 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15007 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15011 w
->cursor
.y
= row
->y
;
15013 if (row
< bottom_row
)
15015 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15016 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15018 /* Can't use this optimization with bidi-reordered glyph
15019 rows, unless cursor is already at point. */
15020 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15022 if (!(w
->cursor
.hpos
>= 0
15023 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15024 && BUFFERP (glyph
->object
)
15025 && glyph
->charpos
== PT
))
15030 && (!BUFFERP (glyph
->object
)
15031 || glyph
->charpos
< PT
);
15035 w
->cursor
.x
+= glyph
->pixel_width
;
15040 /* Adjust window end. A null value of last_text_row means that
15041 the window end is in reused rows which in turn means that
15042 only its vpos can have changed. */
15045 w
->window_end_bytepos
15046 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15048 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15050 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15055 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15058 w
->window_end_valid
= Qnil
;
15059 w
->desired_matrix
->no_scrolling_p
= 1;
15062 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15072 /************************************************************************
15073 Window redisplay reusing current matrix when buffer has changed
15074 ************************************************************************/
15076 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15077 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15078 EMACS_INT
*, EMACS_INT
*);
15079 static struct glyph_row
*
15080 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15081 struct glyph_row
*);
15084 /* Return the last row in MATRIX displaying text. If row START is
15085 non-null, start searching with that row. IT gives the dimensions
15086 of the display. Value is null if matrix is empty; otherwise it is
15087 a pointer to the row found. */
15089 static struct glyph_row
*
15090 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15091 struct glyph_row
*start
)
15093 struct glyph_row
*row
, *row_found
;
15095 /* Set row_found to the last row in IT->w's current matrix
15096 displaying text. The loop looks funny but think of partially
15099 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15100 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15102 xassert (row
->enabled_p
);
15104 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15113 /* Return the last row in the current matrix of W that is not affected
15114 by changes at the start of current_buffer that occurred since W's
15115 current matrix was built. Value is null if no such row exists.
15117 BEG_UNCHANGED us the number of characters unchanged at the start of
15118 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15119 first changed character in current_buffer. Characters at positions <
15120 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15121 when the current matrix was built. */
15123 static struct glyph_row
*
15124 find_last_unchanged_at_beg_row (struct window
*w
)
15126 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15127 struct glyph_row
*row
;
15128 struct glyph_row
*row_found
= NULL
;
15129 int yb
= window_text_bottom_y (w
);
15131 /* Find the last row displaying unchanged text. */
15132 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15133 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15134 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15137 if (/* If row ends before first_changed_pos, it is unchanged,
15138 except in some case. */
15139 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15140 /* When row ends in ZV and we write at ZV it is not
15142 && !row
->ends_at_zv_p
15143 /* When first_changed_pos is the end of a continued line,
15144 row is not unchanged because it may be no longer
15146 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15147 && (row
->continued_p
15148 || row
->exact_window_width_line_p
)))
15151 /* Stop if last visible row. */
15152 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15160 /* Find the first glyph row in the current matrix of W that is not
15161 affected by changes at the end of current_buffer since the
15162 time W's current matrix was built.
15164 Return in *DELTA the number of chars by which buffer positions in
15165 unchanged text at the end of current_buffer must be adjusted.
15167 Return in *DELTA_BYTES the corresponding number of bytes.
15169 Value is null if no such row exists, i.e. all rows are affected by
15172 static struct glyph_row
*
15173 find_first_unchanged_at_end_row (struct window
*w
,
15174 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15176 struct glyph_row
*row
;
15177 struct glyph_row
*row_found
= NULL
;
15179 *delta
= *delta_bytes
= 0;
15181 /* Display must not have been paused, otherwise the current matrix
15182 is not up to date. */
15183 eassert (!NILP (w
->window_end_valid
));
15185 /* A value of window_end_pos >= END_UNCHANGED means that the window
15186 end is in the range of changed text. If so, there is no
15187 unchanged row at the end of W's current matrix. */
15188 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15191 /* Set row to the last row in W's current matrix displaying text. */
15192 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15194 /* If matrix is entirely empty, no unchanged row exists. */
15195 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15197 /* The value of row is the last glyph row in the matrix having a
15198 meaningful buffer position in it. The end position of row
15199 corresponds to window_end_pos. This allows us to translate
15200 buffer positions in the current matrix to current buffer
15201 positions for characters not in changed text. */
15203 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15204 EMACS_INT Z_BYTE_old
=
15205 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15206 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15207 struct glyph_row
*first_text_row
15208 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15210 *delta
= Z
- Z_old
;
15211 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15213 /* Set last_unchanged_pos to the buffer position of the last
15214 character in the buffer that has not been changed. Z is the
15215 index + 1 of the last character in current_buffer, i.e. by
15216 subtracting END_UNCHANGED we get the index of the last
15217 unchanged character, and we have to add BEG to get its buffer
15219 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15220 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15222 /* Search backward from ROW for a row displaying a line that
15223 starts at a minimum position >= last_unchanged_pos_old. */
15224 for (; row
> first_text_row
; --row
)
15226 /* This used to abort, but it can happen.
15227 It is ok to just stop the search instead here. KFS. */
15228 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15231 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15236 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15242 /* Make sure that glyph rows in the current matrix of window W
15243 reference the same glyph memory as corresponding rows in the
15244 frame's frame matrix. This function is called after scrolling W's
15245 current matrix on a terminal frame in try_window_id and
15246 try_window_reusing_current_matrix. */
15249 sync_frame_with_window_matrix_rows (struct window
*w
)
15251 struct frame
*f
= XFRAME (w
->frame
);
15252 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15254 /* Preconditions: W must be a leaf window and full-width. Its frame
15255 must have a frame matrix. */
15256 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15257 xassert (WINDOW_FULL_WIDTH_P (w
));
15258 xassert (!FRAME_WINDOW_P (f
));
15260 /* If W is a full-width window, glyph pointers in W's current matrix
15261 have, by definition, to be the same as glyph pointers in the
15262 corresponding frame matrix. Note that frame matrices have no
15263 marginal areas (see build_frame_matrix). */
15264 window_row
= w
->current_matrix
->rows
;
15265 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15266 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15267 while (window_row
< window_row_end
)
15269 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15270 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15272 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15273 frame_row
->glyphs
[TEXT_AREA
] = start
;
15274 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15275 frame_row
->glyphs
[LAST_AREA
] = end
;
15277 /* Disable frame rows whose corresponding window rows have
15278 been disabled in try_window_id. */
15279 if (!window_row
->enabled_p
)
15280 frame_row
->enabled_p
= 0;
15282 ++window_row
, ++frame_row
;
15287 /* Find the glyph row in window W containing CHARPOS. Consider all
15288 rows between START and END (not inclusive). END null means search
15289 all rows to the end of the display area of W. Value is the row
15290 containing CHARPOS or null. */
15293 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15294 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15296 struct glyph_row
*row
= start
;
15297 struct glyph_row
*best_row
= NULL
;
15298 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15301 /* If we happen to start on a header-line, skip that. */
15302 if (row
->mode_line_p
)
15305 if ((end
&& row
>= end
) || !row
->enabled_p
)
15308 last_y
= window_text_bottom_y (w
) - dy
;
15312 /* Give up if we have gone too far. */
15313 if (end
&& row
>= end
)
15315 /* This formerly returned if they were equal.
15316 I think that both quantities are of a "last plus one" type;
15317 if so, when they are equal, the row is within the screen. -- rms. */
15318 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15321 /* If it is in this row, return this row. */
15322 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15323 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15324 /* The end position of a row equals the start
15325 position of the next row. If CHARPOS is there, we
15326 would rather display it in the next line, except
15327 when this line ends in ZV. */
15328 && !row
->ends_at_zv_p
15329 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15330 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15334 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15335 || (!best_row
&& !row
->continued_p
))
15337 /* In bidi-reordered rows, there could be several rows
15338 occluding point, all of them belonging to the same
15339 continued line. We need to find the row which fits
15340 CHARPOS the best. */
15341 for (g
= row
->glyphs
[TEXT_AREA
];
15342 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15345 if (!STRINGP (g
->object
))
15347 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15349 mindif
= eabs (g
->charpos
- charpos
);
15351 /* Exact match always wins. */
15358 else if (best_row
&& !row
->continued_p
)
15365 /* Try to redisplay window W by reusing its existing display. W's
15366 current matrix must be up to date when this function is called,
15367 i.e. window_end_valid must not be nil.
15371 1 if display has been updated
15372 0 if otherwise unsuccessful
15373 -1 if redisplay with same window start is known not to succeed
15375 The following steps are performed:
15377 1. Find the last row in the current matrix of W that is not
15378 affected by changes at the start of current_buffer. If no such row
15381 2. Find the first row in W's current matrix that is not affected by
15382 changes at the end of current_buffer. Maybe there is no such row.
15384 3. Display lines beginning with the row + 1 found in step 1 to the
15385 row found in step 2 or, if step 2 didn't find a row, to the end of
15388 4. If cursor is not known to appear on the window, give up.
15390 5. If display stopped at the row found in step 2, scroll the
15391 display and current matrix as needed.
15393 6. Maybe display some lines at the end of W, if we must. This can
15394 happen under various circumstances, like a partially visible line
15395 becoming fully visible, or because newly displayed lines are displayed
15396 in smaller font sizes.
15398 7. Update W's window end information. */
15401 try_window_id (struct window
*w
)
15403 struct frame
*f
= XFRAME (w
->frame
);
15404 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15405 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15406 struct glyph_row
*last_unchanged_at_beg_row
;
15407 struct glyph_row
*first_unchanged_at_end_row
;
15408 struct glyph_row
*row
;
15409 struct glyph_row
*bottom_row
;
15412 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15414 struct text_pos start_pos
;
15416 int first_unchanged_at_end_vpos
= 0;
15417 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15418 struct text_pos start
;
15419 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15422 if (inhibit_try_window_id
)
15426 /* This is handy for debugging. */
15428 #define GIVE_UP(X) \
15430 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15434 #define GIVE_UP(X) return 0
15437 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15439 /* Don't use this for mini-windows because these can show
15440 messages and mini-buffers, and we don't handle that here. */
15441 if (MINI_WINDOW_P (w
))
15444 /* This flag is used to prevent redisplay optimizations. */
15445 if (windows_or_buffers_changed
|| cursor_type_changed
)
15448 /* Verify that narrowing has not changed.
15449 Also verify that we were not told to prevent redisplay optimizations.
15450 It would be nice to further
15451 reduce the number of cases where this prevents try_window_id. */
15452 if (current_buffer
->clip_changed
15453 || current_buffer
->prevent_redisplay_optimizations_p
)
15456 /* Window must either use window-based redisplay or be full width. */
15457 if (!FRAME_WINDOW_P (f
)
15458 && (!FRAME_LINE_INS_DEL_OK (f
)
15459 || !WINDOW_FULL_WIDTH_P (w
)))
15462 /* Give up if point is known NOT to appear in W. */
15463 if (PT
< CHARPOS (start
))
15466 /* Another way to prevent redisplay optimizations. */
15467 if (XFASTINT (w
->last_modified
) == 0)
15470 /* Verify that window is not hscrolled. */
15471 if (XFASTINT (w
->hscroll
) != 0)
15474 /* Verify that display wasn't paused. */
15475 if (NILP (w
->window_end_valid
))
15478 /* Can't use this if highlighting a region because a cursor movement
15479 will do more than just set the cursor. */
15480 if (!NILP (Vtransient_mark_mode
)
15481 && !NILP (BVAR (current_buffer
, mark_active
)))
15484 /* Likewise if highlighting trailing whitespace. */
15485 if (!NILP (Vshow_trailing_whitespace
))
15488 /* Likewise if showing a region. */
15489 if (!NILP (w
->region_showing
))
15492 /* Can't use this if overlay arrow position and/or string have
15494 if (overlay_arrows_changed_p ())
15497 /* When word-wrap is on, adding a space to the first word of a
15498 wrapped line can change the wrap position, altering the line
15499 above it. It might be worthwhile to handle this more
15500 intelligently, but for now just redisplay from scratch. */
15501 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15504 /* Under bidi reordering, adding or deleting a character in the
15505 beginning of a paragraph, before the first strong directional
15506 character, can change the base direction of the paragraph (unless
15507 the buffer specifies a fixed paragraph direction), which will
15508 require to redisplay the whole paragraph. It might be worthwhile
15509 to find the paragraph limits and widen the range of redisplayed
15510 lines to that, but for now just give up this optimization and
15511 redisplay from scratch. */
15512 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15513 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15516 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15517 only if buffer has really changed. The reason is that the gap is
15518 initially at Z for freshly visited files. The code below would
15519 set end_unchanged to 0 in that case. */
15520 if (MODIFF
> SAVE_MODIFF
15521 /* This seems to happen sometimes after saving a buffer. */
15522 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15524 if (GPT
- BEG
< BEG_UNCHANGED
)
15525 BEG_UNCHANGED
= GPT
- BEG
;
15526 if (Z
- GPT
< END_UNCHANGED
)
15527 END_UNCHANGED
= Z
- GPT
;
15530 /* The position of the first and last character that has been changed. */
15531 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15532 last_changed_charpos
= Z
- END_UNCHANGED
;
15534 /* If window starts after a line end, and the last change is in
15535 front of that newline, then changes don't affect the display.
15536 This case happens with stealth-fontification. Note that although
15537 the display is unchanged, glyph positions in the matrix have to
15538 be adjusted, of course. */
15539 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15540 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15541 && ((last_changed_charpos
< CHARPOS (start
)
15542 && CHARPOS (start
) == BEGV
)
15543 || (last_changed_charpos
< CHARPOS (start
) - 1
15544 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15546 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15547 struct glyph_row
*r0
;
15549 /* Compute how many chars/bytes have been added to or removed
15550 from the buffer. */
15551 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15552 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15553 Z_delta
= Z
- Z_old
;
15554 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15556 /* Give up if PT is not in the window. Note that it already has
15557 been checked at the start of try_window_id that PT is not in
15558 front of the window start. */
15559 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15562 /* If window start is unchanged, we can reuse the whole matrix
15563 as is, after adjusting glyph positions. No need to compute
15564 the window end again, since its offset from Z hasn't changed. */
15565 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15566 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15567 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15568 /* PT must not be in a partially visible line. */
15569 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15570 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15572 /* Adjust positions in the glyph matrix. */
15573 if (Z_delta
|| Z_delta_bytes
)
15575 struct glyph_row
*r1
15576 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15577 increment_matrix_positions (w
->current_matrix
,
15578 MATRIX_ROW_VPOS (r0
, current_matrix
),
15579 MATRIX_ROW_VPOS (r1
, current_matrix
),
15580 Z_delta
, Z_delta_bytes
);
15583 /* Set the cursor. */
15584 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15586 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15593 /* Handle the case that changes are all below what is displayed in
15594 the window, and that PT is in the window. This shortcut cannot
15595 be taken if ZV is visible in the window, and text has been added
15596 there that is visible in the window. */
15597 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15598 /* ZV is not visible in the window, or there are no
15599 changes at ZV, actually. */
15600 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15601 || first_changed_charpos
== last_changed_charpos
))
15603 struct glyph_row
*r0
;
15605 /* Give up if PT is not in the window. Note that it already has
15606 been checked at the start of try_window_id that PT is not in
15607 front of the window start. */
15608 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15611 /* If window start is unchanged, we can reuse the whole matrix
15612 as is, without changing glyph positions since no text has
15613 been added/removed in front of the window end. */
15614 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15615 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15616 /* PT must not be in a partially visible line. */
15617 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15618 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15620 /* We have to compute the window end anew since text
15621 could have been added/removed after it. */
15623 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15624 w
->window_end_bytepos
15625 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15627 /* Set the cursor. */
15628 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15630 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15637 /* Give up if window start is in the changed area.
15639 The condition used to read
15641 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15643 but why that was tested escapes me at the moment. */
15644 if (CHARPOS (start
) >= first_changed_charpos
15645 && CHARPOS (start
) <= last_changed_charpos
)
15648 /* Check that window start agrees with the start of the first glyph
15649 row in its current matrix. Check this after we know the window
15650 start is not in changed text, otherwise positions would not be
15652 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15653 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15656 /* Give up if the window ends in strings. Overlay strings
15657 at the end are difficult to handle, so don't try. */
15658 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15659 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15662 /* Compute the position at which we have to start displaying new
15663 lines. Some of the lines at the top of the window might be
15664 reusable because they are not displaying changed text. Find the
15665 last row in W's current matrix not affected by changes at the
15666 start of current_buffer. Value is null if changes start in the
15667 first line of window. */
15668 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15669 if (last_unchanged_at_beg_row
)
15671 /* Avoid starting to display in the moddle of a character, a TAB
15672 for instance. This is easier than to set up the iterator
15673 exactly, and it's not a frequent case, so the additional
15674 effort wouldn't really pay off. */
15675 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15676 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15677 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15678 --last_unchanged_at_beg_row
;
15680 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15683 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15685 start_pos
= it
.current
.pos
;
15687 /* Start displaying new lines in the desired matrix at the same
15688 vpos we would use in the current matrix, i.e. below
15689 last_unchanged_at_beg_row. */
15690 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15692 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15693 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15695 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15699 /* There are no reusable lines at the start of the window.
15700 Start displaying in the first text line. */
15701 start_display (&it
, w
, start
);
15702 it
.vpos
= it
.first_vpos
;
15703 start_pos
= it
.current
.pos
;
15706 /* Find the first row that is not affected by changes at the end of
15707 the buffer. Value will be null if there is no unchanged row, in
15708 which case we must redisplay to the end of the window. delta
15709 will be set to the value by which buffer positions beginning with
15710 first_unchanged_at_end_row have to be adjusted due to text
15712 first_unchanged_at_end_row
15713 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15714 IF_DEBUG (debug_delta
= delta
);
15715 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15717 /* Set stop_pos to the buffer position up to which we will have to
15718 display new lines. If first_unchanged_at_end_row != NULL, this
15719 is the buffer position of the start of the line displayed in that
15720 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15721 that we don't stop at a buffer position. */
15723 if (first_unchanged_at_end_row
)
15725 xassert (last_unchanged_at_beg_row
== NULL
15726 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15728 /* If this is a continuation line, move forward to the next one
15729 that isn't. Changes in lines above affect this line.
15730 Caution: this may move first_unchanged_at_end_row to a row
15731 not displaying text. */
15732 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15733 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15734 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15735 < it
.last_visible_y
))
15736 ++first_unchanged_at_end_row
;
15738 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15739 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15740 >= it
.last_visible_y
))
15741 first_unchanged_at_end_row
= NULL
;
15744 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15746 first_unchanged_at_end_vpos
15747 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15748 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15751 else if (last_unchanged_at_beg_row
== NULL
)
15757 /* Either there is no unchanged row at the end, or the one we have
15758 now displays text. This is a necessary condition for the window
15759 end pos calculation at the end of this function. */
15760 xassert (first_unchanged_at_end_row
== NULL
15761 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15763 debug_last_unchanged_at_beg_vpos
15764 = (last_unchanged_at_beg_row
15765 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15767 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15769 #endif /* GLYPH_DEBUG != 0 */
15772 /* Display new lines. Set last_text_row to the last new line
15773 displayed which has text on it, i.e. might end up as being the
15774 line where the window_end_vpos is. */
15775 w
->cursor
.vpos
= -1;
15776 last_text_row
= NULL
;
15777 overlay_arrow_seen
= 0;
15778 while (it
.current_y
< it
.last_visible_y
15779 && !fonts_changed_p
15780 && (first_unchanged_at_end_row
== NULL
15781 || IT_CHARPOS (it
) < stop_pos
))
15783 if (display_line (&it
))
15784 last_text_row
= it
.glyph_row
- 1;
15787 if (fonts_changed_p
)
15791 /* Compute differences in buffer positions, y-positions etc. for
15792 lines reused at the bottom of the window. Compute what we can
15794 if (first_unchanged_at_end_row
15795 /* No lines reused because we displayed everything up to the
15796 bottom of the window. */
15797 && it
.current_y
< it
.last_visible_y
)
15800 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15802 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15803 run
.current_y
= first_unchanged_at_end_row
->y
;
15804 run
.desired_y
= run
.current_y
+ dy
;
15805 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15809 delta
= delta_bytes
= dvpos
= dy
15810 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15811 first_unchanged_at_end_row
= NULL
;
15813 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15816 /* Find the cursor if not already found. We have to decide whether
15817 PT will appear on this window (it sometimes doesn't, but this is
15818 not a very frequent case.) This decision has to be made before
15819 the current matrix is altered. A value of cursor.vpos < 0 means
15820 that PT is either in one of the lines beginning at
15821 first_unchanged_at_end_row or below the window. Don't care for
15822 lines that might be displayed later at the window end; as
15823 mentioned, this is not a frequent case. */
15824 if (w
->cursor
.vpos
< 0)
15826 /* Cursor in unchanged rows at the top? */
15827 if (PT
< CHARPOS (start_pos
)
15828 && last_unchanged_at_beg_row
)
15830 row
= row_containing_pos (w
, PT
,
15831 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15832 last_unchanged_at_beg_row
+ 1, 0);
15834 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15837 /* Start from first_unchanged_at_end_row looking for PT. */
15838 else if (first_unchanged_at_end_row
)
15840 row
= row_containing_pos (w
, PT
- delta
,
15841 first_unchanged_at_end_row
, NULL
, 0);
15843 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15844 delta_bytes
, dy
, dvpos
);
15847 /* Give up if cursor was not found. */
15848 if (w
->cursor
.vpos
< 0)
15850 clear_glyph_matrix (w
->desired_matrix
);
15855 /* Don't let the cursor end in the scroll margins. */
15857 int this_scroll_margin
, cursor_height
;
15859 this_scroll_margin
= max (0, scroll_margin
);
15860 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15861 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15862 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15864 if ((w
->cursor
.y
< this_scroll_margin
15865 && CHARPOS (start
) > BEGV
)
15866 /* Old redisplay didn't take scroll margin into account at the bottom,
15867 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15868 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15869 ? cursor_height
+ this_scroll_margin
15870 : 1)) > it
.last_visible_y
)
15872 w
->cursor
.vpos
= -1;
15873 clear_glyph_matrix (w
->desired_matrix
);
15878 /* Scroll the display. Do it before changing the current matrix so
15879 that xterm.c doesn't get confused about where the cursor glyph is
15881 if (dy
&& run
.height
)
15885 if (FRAME_WINDOW_P (f
))
15887 FRAME_RIF (f
)->update_window_begin_hook (w
);
15888 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15889 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15890 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15894 /* Terminal frame. In this case, dvpos gives the number of
15895 lines to scroll by; dvpos < 0 means scroll up. */
15897 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15898 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15899 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15900 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15901 + window_internal_height (w
));
15903 #if defined (HAVE_GPM) || defined (MSDOS)
15904 x_clear_window_mouse_face (w
);
15906 /* Perform the operation on the screen. */
15909 /* Scroll last_unchanged_at_beg_row to the end of the
15910 window down dvpos lines. */
15911 set_terminal_window (f
, end
);
15913 /* On dumb terminals delete dvpos lines at the end
15914 before inserting dvpos empty lines. */
15915 if (!FRAME_SCROLL_REGION_OK (f
))
15916 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15918 /* Insert dvpos empty lines in front of
15919 last_unchanged_at_beg_row. */
15920 ins_del_lines (f
, from
, dvpos
);
15922 else if (dvpos
< 0)
15924 /* Scroll up last_unchanged_at_beg_vpos to the end of
15925 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15926 set_terminal_window (f
, end
);
15928 /* Delete dvpos lines in front of
15929 last_unchanged_at_beg_vpos. ins_del_lines will set
15930 the cursor to the given vpos and emit |dvpos| delete
15932 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15934 /* On a dumb terminal insert dvpos empty lines at the
15936 if (!FRAME_SCROLL_REGION_OK (f
))
15937 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15940 set_terminal_window (f
, 0);
15946 /* Shift reused rows of the current matrix to the right position.
15947 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15949 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15950 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15953 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15954 bottom_vpos
, dvpos
);
15955 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15958 else if (dvpos
> 0)
15960 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15961 bottom_vpos
, dvpos
);
15962 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15963 first_unchanged_at_end_vpos
+ dvpos
, 0);
15966 /* For frame-based redisplay, make sure that current frame and window
15967 matrix are in sync with respect to glyph memory. */
15968 if (!FRAME_WINDOW_P (f
))
15969 sync_frame_with_window_matrix_rows (w
);
15971 /* Adjust buffer positions in reused rows. */
15972 if (delta
|| delta_bytes
)
15973 increment_matrix_positions (current_matrix
,
15974 first_unchanged_at_end_vpos
+ dvpos
,
15975 bottom_vpos
, delta
, delta_bytes
);
15977 /* Adjust Y positions. */
15979 shift_glyph_matrix (w
, current_matrix
,
15980 first_unchanged_at_end_vpos
+ dvpos
,
15983 if (first_unchanged_at_end_row
)
15985 first_unchanged_at_end_row
+= dvpos
;
15986 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15987 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15988 first_unchanged_at_end_row
= NULL
;
15991 /* If scrolling up, there may be some lines to display at the end of
15993 last_text_row_at_end
= NULL
;
15996 /* Scrolling up can leave for example a partially visible line
15997 at the end of the window to be redisplayed. */
15998 /* Set last_row to the glyph row in the current matrix where the
15999 window end line is found. It has been moved up or down in
16000 the matrix by dvpos. */
16001 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16002 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16004 /* If last_row is the window end line, it should display text. */
16005 xassert (last_row
->displays_text_p
);
16007 /* If window end line was partially visible before, begin
16008 displaying at that line. Otherwise begin displaying with the
16009 line following it. */
16010 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16012 init_to_row_start (&it
, w
, last_row
);
16013 it
.vpos
= last_vpos
;
16014 it
.current_y
= last_row
->y
;
16018 init_to_row_end (&it
, w
, last_row
);
16019 it
.vpos
= 1 + last_vpos
;
16020 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16024 /* We may start in a continuation line. If so, we have to
16025 get the right continuation_lines_width and current_x. */
16026 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16027 it
.hpos
= it
.current_x
= 0;
16029 /* Display the rest of the lines at the window end. */
16030 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16031 while (it
.current_y
< it
.last_visible_y
16032 && !fonts_changed_p
)
16034 /* Is it always sure that the display agrees with lines in
16035 the current matrix? I don't think so, so we mark rows
16036 displayed invalid in the current matrix by setting their
16037 enabled_p flag to zero. */
16038 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16039 if (display_line (&it
))
16040 last_text_row_at_end
= it
.glyph_row
- 1;
16044 /* Update window_end_pos and window_end_vpos. */
16045 if (first_unchanged_at_end_row
16046 && !last_text_row_at_end
)
16048 /* Window end line if one of the preserved rows from the current
16049 matrix. Set row to the last row displaying text in current
16050 matrix starting at first_unchanged_at_end_row, after
16052 xassert (first_unchanged_at_end_row
->displays_text_p
);
16053 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16054 first_unchanged_at_end_row
);
16055 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16057 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16058 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16060 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16061 xassert (w
->window_end_bytepos
>= 0);
16062 IF_DEBUG (debug_method_add (w
, "A"));
16064 else if (last_text_row_at_end
)
16067 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16068 w
->window_end_bytepos
16069 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16071 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16072 xassert (w
->window_end_bytepos
>= 0);
16073 IF_DEBUG (debug_method_add (w
, "B"));
16075 else if (last_text_row
)
16077 /* We have displayed either to the end of the window or at the
16078 end of the window, i.e. the last row with text is to be found
16079 in the desired matrix. */
16081 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16082 w
->window_end_bytepos
16083 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16085 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16086 xassert (w
->window_end_bytepos
>= 0);
16088 else if (first_unchanged_at_end_row
== NULL
16089 && last_text_row
== NULL
16090 && last_text_row_at_end
== NULL
)
16092 /* Displayed to end of window, but no line containing text was
16093 displayed. Lines were deleted at the end of the window. */
16094 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16095 int vpos
= XFASTINT (w
->window_end_vpos
);
16096 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16097 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16100 row
== NULL
&& vpos
>= first_vpos
;
16101 --vpos
, --current_row
, --desired_row
)
16103 if (desired_row
->enabled_p
)
16105 if (desired_row
->displays_text_p
)
16108 else if (current_row
->displays_text_p
)
16112 xassert (row
!= NULL
);
16113 w
->window_end_vpos
= make_number (vpos
+ 1);
16114 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16115 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16116 xassert (w
->window_end_bytepos
>= 0);
16117 IF_DEBUG (debug_method_add (w
, "C"));
16122 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16123 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16125 /* Record that display has not been completed. */
16126 w
->window_end_valid
= Qnil
;
16127 w
->desired_matrix
->no_scrolling_p
= 1;
16135 /***********************************************************************
16136 More debugging support
16137 ***********************************************************************/
16141 void dump_glyph_row (struct glyph_row
*, int, int);
16142 void dump_glyph_matrix (struct glyph_matrix
*, int);
16143 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16146 /* Dump the contents of glyph matrix MATRIX on stderr.
16148 GLYPHS 0 means don't show glyph contents.
16149 GLYPHS 1 means show glyphs in short form
16150 GLYPHS > 1 means show glyphs in long form. */
16153 dump_glyph_matrix (matrix
, glyphs
)
16154 struct glyph_matrix
*matrix
;
16158 for (i
= 0; i
< matrix
->nrows
; ++i
)
16159 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16163 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16164 the glyph row and area where the glyph comes from. */
16167 dump_glyph (row
, glyph
, area
)
16168 struct glyph_row
*row
;
16169 struct glyph
*glyph
;
16172 if (glyph
->type
== CHAR_GLYPH
)
16175 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16176 glyph
- row
->glyphs
[TEXT_AREA
],
16179 (BUFFERP (glyph
->object
)
16181 : (STRINGP (glyph
->object
)
16184 glyph
->pixel_width
,
16186 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16190 glyph
->left_box_line_p
,
16191 glyph
->right_box_line_p
);
16193 else if (glyph
->type
== STRETCH_GLYPH
)
16196 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16197 glyph
- row
->glyphs
[TEXT_AREA
],
16200 (BUFFERP (glyph
->object
)
16202 : (STRINGP (glyph
->object
)
16205 glyph
->pixel_width
,
16209 glyph
->left_box_line_p
,
16210 glyph
->right_box_line_p
);
16212 else if (glyph
->type
== IMAGE_GLYPH
)
16215 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16216 glyph
- row
->glyphs
[TEXT_AREA
],
16219 (BUFFERP (glyph
->object
)
16221 : (STRINGP (glyph
->object
)
16224 glyph
->pixel_width
,
16228 glyph
->left_box_line_p
,
16229 glyph
->right_box_line_p
);
16231 else if (glyph
->type
== COMPOSITE_GLYPH
)
16234 " %5d %4c %6d %c %3d 0x%05x",
16235 glyph
- row
->glyphs
[TEXT_AREA
],
16238 (BUFFERP (glyph
->object
)
16240 : (STRINGP (glyph
->object
)
16243 glyph
->pixel_width
,
16245 if (glyph
->u
.cmp
.automatic
)
16248 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16249 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16251 glyph
->left_box_line_p
,
16252 glyph
->right_box_line_p
);
16257 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16258 GLYPHS 0 means don't show glyph contents.
16259 GLYPHS 1 means show glyphs in short form
16260 GLYPHS > 1 means show glyphs in long form. */
16263 dump_glyph_row (row
, vpos
, glyphs
)
16264 struct glyph_row
*row
;
16269 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16270 fprintf (stderr
, "======================================================================\n");
16272 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16273 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16275 MATRIX_ROW_START_CHARPOS (row
),
16276 MATRIX_ROW_END_CHARPOS (row
),
16277 row
->used
[TEXT_AREA
],
16278 row
->contains_overlapping_glyphs_p
,
16280 row
->truncated_on_left_p
,
16281 row
->truncated_on_right_p
,
16283 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16284 row
->displays_text_p
,
16287 row
->ends_in_middle_of_char_p
,
16288 row
->starts_in_middle_of_char_p
,
16294 row
->visible_height
,
16297 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16298 row
->end
.overlay_string_index
,
16299 row
->continuation_lines_width
);
16300 fprintf (stderr
, "%9d %5d\n",
16301 CHARPOS (row
->start
.string_pos
),
16302 CHARPOS (row
->end
.string_pos
));
16303 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16304 row
->end
.dpvec_index
);
16311 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16313 struct glyph
*glyph
= row
->glyphs
[area
];
16314 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16316 /* Glyph for a line end in text. */
16317 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16320 if (glyph
< glyph_end
)
16321 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16323 for (; glyph
< glyph_end
; ++glyph
)
16324 dump_glyph (row
, glyph
, area
);
16327 else if (glyphs
== 1)
16331 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16333 char *s
= (char *) alloca (row
->used
[area
] + 1);
16336 for (i
= 0; i
< row
->used
[area
]; ++i
)
16338 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16339 if (glyph
->type
== CHAR_GLYPH
16340 && glyph
->u
.ch
< 0x80
16341 && glyph
->u
.ch
>= ' ')
16342 s
[i
] = glyph
->u
.ch
;
16348 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16354 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16355 Sdump_glyph_matrix
, 0, 1, "p",
16356 doc
: /* Dump the current matrix of the selected window to stderr.
16357 Shows contents of glyph row structures. With non-nil
16358 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16359 glyphs in short form, otherwise show glyphs in long form. */)
16360 (Lisp_Object glyphs
)
16362 struct window
*w
= XWINDOW (selected_window
);
16363 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16365 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16366 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16367 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16368 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16369 fprintf (stderr
, "=============================================\n");
16370 dump_glyph_matrix (w
->current_matrix
,
16371 NILP (glyphs
) ? 0 : XINT (glyphs
));
16376 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16377 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16380 struct frame
*f
= XFRAME (selected_frame
);
16381 dump_glyph_matrix (f
->current_matrix
, 1);
16386 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16387 doc
: /* Dump glyph row ROW to stderr.
16388 GLYPH 0 means don't dump glyphs.
16389 GLYPH 1 means dump glyphs in short form.
16390 GLYPH > 1 or omitted means dump glyphs in long form. */)
16391 (Lisp_Object row
, Lisp_Object glyphs
)
16393 struct glyph_matrix
*matrix
;
16396 CHECK_NUMBER (row
);
16397 matrix
= XWINDOW (selected_window
)->current_matrix
;
16399 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16400 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16402 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16407 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16408 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16409 GLYPH 0 means don't dump glyphs.
16410 GLYPH 1 means dump glyphs in short form.
16411 GLYPH > 1 or omitted means dump glyphs in long form. */)
16412 (Lisp_Object row
, Lisp_Object glyphs
)
16414 struct frame
*sf
= SELECTED_FRAME ();
16415 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16418 CHECK_NUMBER (row
);
16420 if (vpos
>= 0 && vpos
< m
->nrows
)
16421 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16422 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16427 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16428 doc
: /* Toggle tracing of redisplay.
16429 With ARG, turn tracing on if and only if ARG is positive. */)
16433 trace_redisplay_p
= !trace_redisplay_p
;
16436 arg
= Fprefix_numeric_value (arg
);
16437 trace_redisplay_p
= XINT (arg
) > 0;
16444 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16445 doc
: /* Like `format', but print result to stderr.
16446 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16447 (int nargs
, Lisp_Object
*args
)
16449 Lisp_Object s
= Fformat (nargs
, args
);
16450 fprintf (stderr
, "%s", SDATA (s
));
16454 #endif /* GLYPH_DEBUG */
16458 /***********************************************************************
16459 Building Desired Matrix Rows
16460 ***********************************************************************/
16462 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16463 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16465 static struct glyph_row
*
16466 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16468 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16469 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16470 struct buffer
*old
= current_buffer
;
16471 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16472 int arrow_len
= SCHARS (overlay_arrow_string
);
16473 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16474 const unsigned char *p
;
16477 int n_glyphs_before
;
16479 set_buffer_temp (buffer
);
16480 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16481 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16482 SET_TEXT_POS (it
.position
, 0, 0);
16484 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16486 while (p
< arrow_end
)
16488 Lisp_Object face
, ilisp
;
16490 /* Get the next character. */
16492 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16495 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16496 if (! ASCII_CHAR_P (it
.c
))
16497 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16501 /* Get its face. */
16502 ilisp
= make_number (p
- arrow_string
);
16503 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16504 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16506 /* Compute its width, get its glyphs. */
16507 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16508 SET_TEXT_POS (it
.position
, -1, -1);
16509 PRODUCE_GLYPHS (&it
);
16511 /* If this character doesn't fit any more in the line, we have
16512 to remove some glyphs. */
16513 if (it
.current_x
> it
.last_visible_x
)
16515 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16520 set_buffer_temp (old
);
16521 return it
.glyph_row
;
16525 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16526 glyphs are only inserted for terminal frames since we can't really
16527 win with truncation glyphs when partially visible glyphs are
16528 involved. Which glyphs to insert is determined by
16529 produce_special_glyphs. */
16532 insert_left_trunc_glyphs (struct it
*it
)
16534 struct it truncate_it
;
16535 struct glyph
*from
, *end
, *to
, *toend
;
16537 xassert (!FRAME_WINDOW_P (it
->f
));
16539 /* Get the truncation glyphs. */
16541 truncate_it
.current_x
= 0;
16542 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16543 truncate_it
.glyph_row
= &scratch_glyph_row
;
16544 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16545 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16546 truncate_it
.object
= make_number (0);
16547 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16549 /* Overwrite glyphs from IT with truncation glyphs. */
16550 if (!it
->glyph_row
->reversed_p
)
16552 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16553 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16554 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16555 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16560 /* There may be padding glyphs left over. Overwrite them too. */
16561 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16563 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16569 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16573 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16574 that back to front. */
16575 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16576 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16577 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16578 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16580 while (from
>= end
&& to
>= toend
)
16582 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16585 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16586 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16587 while (from
>= end
&& to
>= toend
)
16592 /* Need to free some room before prepending additional
16594 int move_by
= from
- end
+ 1;
16595 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16596 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16598 for ( ; g
>= g0
; g
--)
16600 while (from
>= end
)
16602 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16608 /* Compute the pixel height and width of IT->glyph_row.
16610 Most of the time, ascent and height of a display line will be equal
16611 to the max_ascent and max_height values of the display iterator
16612 structure. This is not the case if
16614 1. We hit ZV without displaying anything. In this case, max_ascent
16615 and max_height will be zero.
16617 2. We have some glyphs that don't contribute to the line height.
16618 (The glyph row flag contributes_to_line_height_p is for future
16619 pixmap extensions).
16621 The first case is easily covered by using default values because in
16622 these cases, the line height does not really matter, except that it
16623 must not be zero. */
16626 compute_line_metrics (struct it
*it
)
16628 struct glyph_row
*row
= it
->glyph_row
;
16630 if (FRAME_WINDOW_P (it
->f
))
16632 int i
, min_y
, max_y
;
16634 /* The line may consist of one space only, that was added to
16635 place the cursor on it. If so, the row's height hasn't been
16637 if (row
->height
== 0)
16639 if (it
->max_ascent
+ it
->max_descent
== 0)
16640 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16641 row
->ascent
= it
->max_ascent
;
16642 row
->height
= it
->max_ascent
+ it
->max_descent
;
16643 row
->phys_ascent
= it
->max_phys_ascent
;
16644 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16645 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16648 /* Compute the width of this line. */
16649 row
->pixel_width
= row
->x
;
16650 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16651 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16653 xassert (row
->pixel_width
>= 0);
16654 xassert (row
->ascent
>= 0 && row
->height
> 0);
16656 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16657 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16659 /* If first line's physical ascent is larger than its logical
16660 ascent, use the physical ascent, and make the row taller.
16661 This makes accented characters fully visible. */
16662 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16663 && row
->phys_ascent
> row
->ascent
)
16665 row
->height
+= row
->phys_ascent
- row
->ascent
;
16666 row
->ascent
= row
->phys_ascent
;
16669 /* Compute how much of the line is visible. */
16670 row
->visible_height
= row
->height
;
16672 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16673 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16675 if (row
->y
< min_y
)
16676 row
->visible_height
-= min_y
- row
->y
;
16677 if (row
->y
+ row
->height
> max_y
)
16678 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16682 row
->pixel_width
= row
->used
[TEXT_AREA
];
16683 if (row
->continued_p
)
16684 row
->pixel_width
-= it
->continuation_pixel_width
;
16685 else if (row
->truncated_on_right_p
)
16686 row
->pixel_width
-= it
->truncation_pixel_width
;
16687 row
->ascent
= row
->phys_ascent
= 0;
16688 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16689 row
->extra_line_spacing
= 0;
16692 /* Compute a hash code for this row. */
16696 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16697 for (i
= 0; i
< row
->used
[area
]; ++i
)
16698 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16699 + row
->glyphs
[area
][i
].u
.val
16700 + row
->glyphs
[area
][i
].face_id
16701 + row
->glyphs
[area
][i
].padding_p
16702 + (row
->glyphs
[area
][i
].type
<< 2));
16705 it
->max_ascent
= it
->max_descent
= 0;
16706 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16710 /* Append one space to the glyph row of iterator IT if doing a
16711 window-based redisplay. The space has the same face as
16712 IT->face_id. Value is non-zero if a space was added.
16714 This function is called to make sure that there is always one glyph
16715 at the end of a glyph row that the cursor can be set on under
16716 window-systems. (If there weren't such a glyph we would not know
16717 how wide and tall a box cursor should be displayed).
16719 At the same time this space let's a nicely handle clearing to the
16720 end of the line if the row ends in italic text. */
16723 append_space_for_newline (struct it
*it
, int default_face_p
)
16725 if (FRAME_WINDOW_P (it
->f
))
16727 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16729 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16730 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16732 /* Save some values that must not be changed.
16733 Must save IT->c and IT->len because otherwise
16734 ITERATOR_AT_END_P wouldn't work anymore after
16735 append_space_for_newline has been called. */
16736 enum display_element_type saved_what
= it
->what
;
16737 int saved_c
= it
->c
, saved_len
= it
->len
;
16738 int saved_char_to_display
= it
->char_to_display
;
16739 int saved_x
= it
->current_x
;
16740 int saved_face_id
= it
->face_id
;
16741 struct text_pos saved_pos
;
16742 Lisp_Object saved_object
;
16745 saved_object
= it
->object
;
16746 saved_pos
= it
->position
;
16748 it
->what
= IT_CHARACTER
;
16749 memset (&it
->position
, 0, sizeof it
->position
);
16750 it
->object
= make_number (0);
16751 it
->c
= it
->char_to_display
= ' ';
16754 if (default_face_p
)
16755 it
->face_id
= DEFAULT_FACE_ID
;
16756 else if (it
->face_before_selective_p
)
16757 it
->face_id
= it
->saved_face_id
;
16758 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16759 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16761 PRODUCE_GLYPHS (it
);
16763 it
->override_ascent
= -1;
16764 it
->constrain_row_ascent_descent_p
= 0;
16765 it
->current_x
= saved_x
;
16766 it
->object
= saved_object
;
16767 it
->position
= saved_pos
;
16768 it
->what
= saved_what
;
16769 it
->face_id
= saved_face_id
;
16770 it
->len
= saved_len
;
16772 it
->char_to_display
= saved_char_to_display
;
16781 /* Extend the face of the last glyph in the text area of IT->glyph_row
16782 to the end of the display line. Called from display_line. If the
16783 glyph row is empty, add a space glyph to it so that we know the
16784 face to draw. Set the glyph row flag fill_line_p. If the glyph
16785 row is R2L, prepend a stretch glyph to cover the empty space to the
16786 left of the leftmost glyph. */
16789 extend_face_to_end_of_line (struct it
*it
)
16792 struct frame
*f
= it
->f
;
16794 /* If line is already filled, do nothing. Non window-system frames
16795 get a grace of one more ``pixel'' because their characters are
16796 1-``pixel'' wide, so they hit the equality too early. This grace
16797 is needed only for R2L rows that are not continued, to produce
16798 one extra blank where we could display the cursor. */
16799 if (it
->current_x
>= it
->last_visible_x
16800 + (!FRAME_WINDOW_P (f
)
16801 && it
->glyph_row
->reversed_p
16802 && !it
->glyph_row
->continued_p
))
16805 /* Face extension extends the background and box of IT->face_id
16806 to the end of the line. If the background equals the background
16807 of the frame, we don't have to do anything. */
16808 if (it
->face_before_selective_p
)
16809 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16811 face
= FACE_FROM_ID (f
, it
->face_id
);
16813 if (FRAME_WINDOW_P (f
)
16814 && it
->glyph_row
->displays_text_p
16815 && face
->box
== FACE_NO_BOX
16816 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16818 && !it
->glyph_row
->reversed_p
)
16821 /* Set the glyph row flag indicating that the face of the last glyph
16822 in the text area has to be drawn to the end of the text area. */
16823 it
->glyph_row
->fill_line_p
= 1;
16825 /* If current character of IT is not ASCII, make sure we have the
16826 ASCII face. This will be automatically undone the next time
16827 get_next_display_element returns a multibyte character. Note
16828 that the character will always be single byte in unibyte
16830 if (!ASCII_CHAR_P (it
->c
))
16832 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16835 if (FRAME_WINDOW_P (f
))
16837 /* If the row is empty, add a space with the current face of IT,
16838 so that we know which face to draw. */
16839 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16841 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16842 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16843 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16845 #ifdef HAVE_WINDOW_SYSTEM
16846 if (it
->glyph_row
->reversed_p
)
16848 /* Prepend a stretch glyph to the row, such that the
16849 rightmost glyph will be drawn flushed all the way to the
16850 right margin of the window. The stretch glyph that will
16851 occupy the empty space, if any, to the left of the
16853 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16854 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16855 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16857 int row_width
, stretch_ascent
, stretch_width
;
16858 struct text_pos saved_pos
;
16859 int saved_face_id
, saved_avoid_cursor
;
16861 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16862 row_width
+= g
->pixel_width
;
16863 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16864 if (stretch_width
> 0)
16867 (((it
->ascent
+ it
->descent
)
16868 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16869 saved_pos
= it
->position
;
16870 memset (&it
->position
, 0, sizeof it
->position
);
16871 saved_avoid_cursor
= it
->avoid_cursor_p
;
16872 it
->avoid_cursor_p
= 1;
16873 saved_face_id
= it
->face_id
;
16874 /* The last row's stretch glyph should get the default
16875 face, to avoid painting the rest of the window with
16876 the region face, if the region ends at ZV. */
16877 if (it
->glyph_row
->ends_at_zv_p
)
16878 it
->face_id
= DEFAULT_FACE_ID
;
16880 it
->face_id
= face
->id
;
16881 append_stretch_glyph (it
, make_number (0), stretch_width
,
16882 it
->ascent
+ it
->descent
, stretch_ascent
);
16883 it
->position
= saved_pos
;
16884 it
->avoid_cursor_p
= saved_avoid_cursor
;
16885 it
->face_id
= saved_face_id
;
16888 #endif /* HAVE_WINDOW_SYSTEM */
16892 /* Save some values that must not be changed. */
16893 int saved_x
= it
->current_x
;
16894 struct text_pos saved_pos
;
16895 Lisp_Object saved_object
;
16896 enum display_element_type saved_what
= it
->what
;
16897 int saved_face_id
= it
->face_id
;
16899 saved_object
= it
->object
;
16900 saved_pos
= it
->position
;
16902 it
->what
= IT_CHARACTER
;
16903 memset (&it
->position
, 0, sizeof it
->position
);
16904 it
->object
= make_number (0);
16905 it
->c
= it
->char_to_display
= ' ';
16907 /* The last row's blank glyphs should get the default face, to
16908 avoid painting the rest of the window with the region face,
16909 if the region ends at ZV. */
16910 if (it
->glyph_row
->ends_at_zv_p
)
16911 it
->face_id
= DEFAULT_FACE_ID
;
16913 it
->face_id
= face
->id
;
16915 PRODUCE_GLYPHS (it
);
16917 while (it
->current_x
<= it
->last_visible_x
)
16918 PRODUCE_GLYPHS (it
);
16920 /* Don't count these blanks really. It would let us insert a left
16921 truncation glyph below and make us set the cursor on them, maybe. */
16922 it
->current_x
= saved_x
;
16923 it
->object
= saved_object
;
16924 it
->position
= saved_pos
;
16925 it
->what
= saved_what
;
16926 it
->face_id
= saved_face_id
;
16931 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16932 trailing whitespace. */
16935 trailing_whitespace_p (EMACS_INT charpos
)
16937 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16940 while (bytepos
< ZV_BYTE
16941 && (c
= FETCH_CHAR (bytepos
),
16942 c
== ' ' || c
== '\t'))
16945 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16947 if (bytepos
!= PT_BYTE
)
16954 /* Highlight trailing whitespace, if any, in ROW. */
16957 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16959 int used
= row
->used
[TEXT_AREA
];
16963 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16964 struct glyph
*glyph
= start
+ used
- 1;
16966 if (row
->reversed_p
)
16968 /* Right-to-left rows need to be processed in the opposite
16969 direction, so swap the edge pointers. */
16971 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16974 /* Skip over glyphs inserted to display the cursor at the
16975 end of a line, for extending the face of the last glyph
16976 to the end of the line on terminals, and for truncation
16977 and continuation glyphs. */
16978 if (!row
->reversed_p
)
16980 while (glyph
>= start
16981 && glyph
->type
== CHAR_GLYPH
16982 && INTEGERP (glyph
->object
))
16987 while (glyph
<= start
16988 && glyph
->type
== CHAR_GLYPH
16989 && INTEGERP (glyph
->object
))
16993 /* If last glyph is a space or stretch, and it's trailing
16994 whitespace, set the face of all trailing whitespace glyphs in
16995 IT->glyph_row to `trailing-whitespace'. */
16996 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16997 && BUFFERP (glyph
->object
)
16998 && (glyph
->type
== STRETCH_GLYPH
16999 || (glyph
->type
== CHAR_GLYPH
17000 && glyph
->u
.ch
== ' '))
17001 && trailing_whitespace_p (glyph
->charpos
))
17003 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17007 if (!row
->reversed_p
)
17009 while (glyph
>= start
17010 && BUFFERP (glyph
->object
)
17011 && (glyph
->type
== STRETCH_GLYPH
17012 || (glyph
->type
== CHAR_GLYPH
17013 && glyph
->u
.ch
== ' ')))
17014 (glyph
--)->face_id
= face_id
;
17018 while (glyph
<= start
17019 && BUFFERP (glyph
->object
)
17020 && (glyph
->type
== STRETCH_GLYPH
17021 || (glyph
->type
== CHAR_GLYPH
17022 && glyph
->u
.ch
== ' ')))
17023 (glyph
++)->face_id
= face_id
;
17030 /* Value is non-zero if glyph row ROW in window W should be
17031 used to hold the cursor. */
17034 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17038 if (PT
== CHARPOS (row
->end
.pos
))
17040 /* Suppose the row ends on a string.
17041 Unless the row is continued, that means it ends on a newline
17042 in the string. If it's anything other than a display string
17043 (e.g. a before-string from an overlay), we don't want the
17044 cursor there. (This heuristic seems to give the optimal
17045 behavior for the various types of multi-line strings.) */
17046 if (CHARPOS (row
->end
.string_pos
) >= 0)
17048 if (row
->continued_p
)
17052 /* Check for `display' property. */
17053 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17054 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17055 struct glyph
*glyph
;
17058 for (glyph
= end
; glyph
>= beg
; --glyph
)
17059 if (STRINGP (glyph
->object
))
17062 = Fget_char_property (make_number (PT
),
17066 && display_prop_string_p (prop
, glyph
->object
));
17071 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17073 /* If the row ends in middle of a real character,
17074 and the line is continued, we want the cursor here.
17075 That's because CHARPOS (ROW->end.pos) would equal
17076 PT if PT is before the character. */
17077 if (!row
->ends_in_ellipsis_p
)
17078 result
= row
->continued_p
;
17080 /* If the row ends in an ellipsis, then
17081 CHARPOS (ROW->end.pos) will equal point after the
17082 invisible text. We want that position to be displayed
17083 after the ellipsis. */
17086 /* If the row ends at ZV, display the cursor at the end of that
17087 row instead of at the start of the row below. */
17088 else if (row
->ends_at_zv_p
)
17099 /* Push the display property PROP so that it will be rendered at the
17100 current position in IT. Return 1 if PROP was successfully pushed,
17104 push_display_prop (struct it
*it
, Lisp_Object prop
)
17108 if (STRINGP (prop
))
17110 if (SCHARS (prop
) == 0)
17117 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17118 it
->current
.overlay_string_index
= -1;
17119 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17120 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17121 it
->method
= GET_FROM_STRING
;
17122 it
->stop_charpos
= 0;
17124 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17126 it
->method
= GET_FROM_STRETCH
;
17129 #ifdef HAVE_WINDOW_SYSTEM
17130 else if (IMAGEP (prop
))
17132 it
->what
= IT_IMAGE
;
17133 it
->image_id
= lookup_image (it
->f
, prop
);
17134 it
->method
= GET_FROM_IMAGE
;
17136 #endif /* HAVE_WINDOW_SYSTEM */
17139 pop_it (it
); /* bogus display property, give up */
17146 /* Return the character-property PROP at the current position in IT. */
17149 get_it_property (struct it
*it
, Lisp_Object prop
)
17151 Lisp_Object position
;
17153 if (STRINGP (it
->object
))
17154 position
= make_number (IT_STRING_CHARPOS (*it
));
17155 else if (BUFFERP (it
->object
))
17156 position
= make_number (IT_CHARPOS (*it
));
17160 return Fget_char_property (position
, prop
, it
->object
);
17163 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17166 handle_line_prefix (struct it
*it
)
17168 Lisp_Object prefix
;
17169 if (it
->continuation_lines_width
> 0)
17171 prefix
= get_it_property (it
, Qwrap_prefix
);
17173 prefix
= Vwrap_prefix
;
17177 prefix
= get_it_property (it
, Qline_prefix
);
17179 prefix
= Vline_prefix
;
17181 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17183 /* If the prefix is wider than the window, and we try to wrap
17184 it, it would acquire its own wrap prefix, and so on till the
17185 iterator stack overflows. So, don't wrap the prefix. */
17186 it
->line_wrap
= TRUNCATE
;
17187 it
->avoid_cursor_p
= 1;
17193 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17194 only for R2L lines from display_line, when it decides that too many
17195 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17198 unproduce_glyphs (struct it
*it
, int n
)
17200 struct glyph
*glyph
, *end
;
17202 xassert (it
->glyph_row
);
17203 xassert (it
->glyph_row
->reversed_p
);
17204 xassert (it
->area
== TEXT_AREA
);
17205 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17207 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17208 n
= it
->glyph_row
->used
[TEXT_AREA
];
17209 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17210 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17211 for ( ; glyph
< end
; glyph
++)
17212 glyph
[-n
] = *glyph
;
17215 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17216 and ROW->maxpos. */
17218 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17219 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17220 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17222 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17223 lines' rows is implemented for bidi-reordered rows. */
17225 /* ROW->minpos is the value of min_pos, the minimal buffer position
17228 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17230 /* We didn't find _any_ valid buffer positions in any of the
17231 glyphs, so we must trust the iterator's computed positions. */
17232 row
->minpos
= row
->start
.pos
;
17235 max_pos
= CHARPOS (it
->current
.pos
);
17236 max_bpos
= BYTEPOS (it
->current
.pos
);
17239 /* Here are the various use-cases for ending the row, and the
17240 corresponding values for ROW->maxpos:
17242 Line ends in a newline from buffer eol_pos + 1
17243 Line is continued from buffer max_pos + 1
17244 Line is truncated on right it->current.pos
17245 Line ends in a newline from string max_pos
17246 Line is continued from string max_pos
17247 Line is continued from display vector max_pos
17248 Line is entirely from a string min_pos == max_pos
17249 Line is entirely from a display vector min_pos == max_pos
17250 Line that ends at ZV ZV
17252 If you discover other use-cases, please add them here as
17254 if (row
->ends_at_zv_p
)
17255 row
->maxpos
= it
->current
.pos
;
17256 else if (row
->used
[TEXT_AREA
])
17258 if (row
->ends_in_newline_from_string_p
)
17259 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17260 else if (CHARPOS (it
->eol_pos
) > 0)
17261 SET_TEXT_POS (row
->maxpos
,
17262 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17263 else if (row
->continued_p
)
17265 /* If max_pos is different from IT's current position, it
17266 means IT->method does not belong to the display element
17267 at max_pos. However, it also means that the display
17268 element at max_pos was displayed in its entirety on this
17269 line, which is equivalent to saying that the next line
17270 starts at the next buffer position. */
17271 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17272 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17275 INC_BOTH (max_pos
, max_bpos
);
17276 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17279 else if (row
->truncated_on_right_p
)
17280 /* display_line already called reseat_at_next_visible_line_start,
17281 which puts the iterator at the beginning of the next line, in
17282 the logical order. */
17283 row
->maxpos
= it
->current
.pos
;
17284 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17285 /* A line that is entirely from a string/image/stretch... */
17286 row
->maxpos
= row
->minpos
;
17291 row
->maxpos
= it
->current
.pos
;
17294 /* Construct the glyph row IT->glyph_row in the desired matrix of
17295 IT->w from text at the current position of IT. See dispextern.h
17296 for an overview of struct it. Value is non-zero if
17297 IT->glyph_row displays text, as opposed to a line displaying ZV
17301 display_line (struct it
*it
)
17303 struct glyph_row
*row
= it
->glyph_row
;
17304 Lisp_Object overlay_arrow_string
;
17306 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17307 int wrap_row_used
= -1;
17308 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17309 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17310 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17311 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17312 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17314 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17315 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17317 /* We always start displaying at hpos zero even if hscrolled. */
17318 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17320 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17321 >= it
->w
->desired_matrix
->nrows
)
17323 it
->w
->nrows_scale_factor
++;
17324 fonts_changed_p
= 1;
17328 /* Is IT->w showing the region? */
17329 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17331 /* Clear the result glyph row and enable it. */
17332 prepare_desired_row (row
);
17334 row
->y
= it
->current_y
;
17335 row
->start
= it
->start
;
17336 row
->continuation_lines_width
= it
->continuation_lines_width
;
17337 row
->displays_text_p
= 1;
17338 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17339 it
->starts_in_middle_of_char_p
= 0;
17341 /* Arrange the overlays nicely for our purposes. Usually, we call
17342 display_line on only one line at a time, in which case this
17343 can't really hurt too much, or we call it on lines which appear
17344 one after another in the buffer, in which case all calls to
17345 recenter_overlay_lists but the first will be pretty cheap. */
17346 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17348 /* Move over display elements that are not visible because we are
17349 hscrolled. This may stop at an x-position < IT->first_visible_x
17350 if the first glyph is partially visible or if we hit a line end. */
17351 if (it
->current_x
< it
->first_visible_x
)
17353 this_line_min_pos
= row
->start
.pos
;
17354 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17355 MOVE_TO_POS
| MOVE_TO_X
);
17356 /* Record the smallest positions seen while we moved over
17357 display elements that are not visible. This is needed by
17358 redisplay_internal for optimizing the case where the cursor
17359 stays inside the same line. The rest of this function only
17360 considers positions that are actually displayed, so
17361 RECORD_MAX_MIN_POS will not otherwise record positions that
17362 are hscrolled to the left of the left edge of the window. */
17363 min_pos
= CHARPOS (this_line_min_pos
);
17364 min_bpos
= BYTEPOS (this_line_min_pos
);
17368 /* We only do this when not calling `move_it_in_display_line_to'
17369 above, because move_it_in_display_line_to calls
17370 handle_line_prefix itself. */
17371 handle_line_prefix (it
);
17374 /* Get the initial row height. This is either the height of the
17375 text hscrolled, if there is any, or zero. */
17376 row
->ascent
= it
->max_ascent
;
17377 row
->height
= it
->max_ascent
+ it
->max_descent
;
17378 row
->phys_ascent
= it
->max_phys_ascent
;
17379 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17380 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17382 /* Utility macro to record max and min buffer positions seen until now. */
17383 #define RECORD_MAX_MIN_POS(IT) \
17386 if (IT_CHARPOS (*(IT)) < min_pos) \
17388 min_pos = IT_CHARPOS (*(IT)); \
17389 min_bpos = IT_BYTEPOS (*(IT)); \
17391 if (IT_CHARPOS (*(IT)) > max_pos) \
17393 max_pos = IT_CHARPOS (*(IT)); \
17394 max_bpos = IT_BYTEPOS (*(IT)); \
17399 /* Loop generating characters. The loop is left with IT on the next
17400 character to display. */
17403 int n_glyphs_before
, hpos_before
, x_before
;
17405 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17407 /* Retrieve the next thing to display. Value is zero if end of
17409 if (!get_next_display_element (it
))
17411 /* Maybe add a space at the end of this line that is used to
17412 display the cursor there under X. Set the charpos of the
17413 first glyph of blank lines not corresponding to any text
17415 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17416 row
->exact_window_width_line_p
= 1;
17417 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17418 || row
->used
[TEXT_AREA
] == 0)
17420 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17421 row
->displays_text_p
= 0;
17423 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17424 && (!MINI_WINDOW_P (it
->w
)
17425 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17426 row
->indicate_empty_line_p
= 1;
17429 it
->continuation_lines_width
= 0;
17430 row
->ends_at_zv_p
= 1;
17431 /* A row that displays right-to-left text must always have
17432 its last face extended all the way to the end of line,
17433 even if this row ends in ZV, because we still write to
17434 the screen left to right. */
17435 if (row
->reversed_p
)
17436 extend_face_to_end_of_line (it
);
17440 /* Now, get the metrics of what we want to display. This also
17441 generates glyphs in `row' (which is IT->glyph_row). */
17442 n_glyphs_before
= row
->used
[TEXT_AREA
];
17445 /* Remember the line height so far in case the next element doesn't
17446 fit on the line. */
17447 if (it
->line_wrap
!= TRUNCATE
)
17449 ascent
= it
->max_ascent
;
17450 descent
= it
->max_descent
;
17451 phys_ascent
= it
->max_phys_ascent
;
17452 phys_descent
= it
->max_phys_descent
;
17454 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17456 if (IT_DISPLAYING_WHITESPACE (it
))
17462 wrap_row_used
= row
->used
[TEXT_AREA
];
17463 wrap_row_ascent
= row
->ascent
;
17464 wrap_row_height
= row
->height
;
17465 wrap_row_phys_ascent
= row
->phys_ascent
;
17466 wrap_row_phys_height
= row
->phys_height
;
17467 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17468 wrap_row_min_pos
= min_pos
;
17469 wrap_row_min_bpos
= min_bpos
;
17470 wrap_row_max_pos
= max_pos
;
17471 wrap_row_max_bpos
= max_bpos
;
17477 PRODUCE_GLYPHS (it
);
17479 /* If this display element was in marginal areas, continue with
17481 if (it
->area
!= TEXT_AREA
)
17483 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17484 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17485 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17486 row
->phys_height
= max (row
->phys_height
,
17487 it
->max_phys_ascent
+ it
->max_phys_descent
);
17488 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17489 it
->max_extra_line_spacing
);
17490 set_iterator_to_next (it
, 1);
17494 /* Does the display element fit on the line? If we truncate
17495 lines, we should draw past the right edge of the window. If
17496 we don't truncate, we want to stop so that we can display the
17497 continuation glyph before the right margin. If lines are
17498 continued, there are two possible strategies for characters
17499 resulting in more than 1 glyph (e.g. tabs): Display as many
17500 glyphs as possible in this line and leave the rest for the
17501 continuation line, or display the whole element in the next
17502 line. Original redisplay did the former, so we do it also. */
17503 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17504 hpos_before
= it
->hpos
;
17507 if (/* Not a newline. */
17509 /* Glyphs produced fit entirely in the line. */
17510 && it
->current_x
< it
->last_visible_x
)
17512 it
->hpos
+= nglyphs
;
17513 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17514 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17515 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17516 row
->phys_height
= max (row
->phys_height
,
17517 it
->max_phys_ascent
+ it
->max_phys_descent
);
17518 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17519 it
->max_extra_line_spacing
);
17520 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17521 row
->x
= x
- it
->first_visible_x
;
17522 /* Record the maximum and minimum buffer positions seen so
17523 far in glyphs that will be displayed by this row. */
17525 RECORD_MAX_MIN_POS (it
);
17530 struct glyph
*glyph
;
17532 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17534 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17535 new_x
= x
+ glyph
->pixel_width
;
17537 if (/* Lines are continued. */
17538 it
->line_wrap
!= TRUNCATE
17539 && (/* Glyph doesn't fit on the line. */
17540 new_x
> it
->last_visible_x
17541 /* Or it fits exactly on a window system frame. */
17542 || (new_x
== it
->last_visible_x
17543 && FRAME_WINDOW_P (it
->f
))))
17545 /* End of a continued line. */
17548 || (new_x
== it
->last_visible_x
17549 && FRAME_WINDOW_P (it
->f
)))
17551 /* Current glyph is the only one on the line or
17552 fits exactly on the line. We must continue
17553 the line because we can't draw the cursor
17554 after the glyph. */
17555 row
->continued_p
= 1;
17556 it
->current_x
= new_x
;
17557 it
->continuation_lines_width
+= new_x
;
17559 /* Record the maximum and minimum buffer
17560 positions seen so far in glyphs that will be
17561 displayed by this row. */
17563 RECORD_MAX_MIN_POS (it
);
17564 if (i
== nglyphs
- 1)
17566 /* If line-wrap is on, check if a previous
17567 wrap point was found. */
17568 if (wrap_row_used
> 0
17569 /* Even if there is a previous wrap
17570 point, continue the line here as
17571 usual, if (i) the previous character
17572 was a space or tab AND (ii) the
17573 current character is not. */
17575 || IT_DISPLAYING_WHITESPACE (it
)))
17578 set_iterator_to_next (it
, 1);
17579 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17581 if (!get_next_display_element (it
))
17583 row
->exact_window_width_line_p
= 1;
17584 it
->continuation_lines_width
= 0;
17585 row
->continued_p
= 0;
17586 row
->ends_at_zv_p
= 1;
17588 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17590 row
->continued_p
= 0;
17591 row
->exact_window_width_line_p
= 1;
17596 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17597 && !FRAME_WINDOW_P (it
->f
))
17599 /* A padding glyph that doesn't fit on this line.
17600 This means the whole character doesn't fit
17602 if (row
->reversed_p
)
17603 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17604 - n_glyphs_before
);
17605 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17607 /* Fill the rest of the row with continuation
17608 glyphs like in 20.x. */
17609 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17610 < row
->glyphs
[1 + TEXT_AREA
])
17611 produce_special_glyphs (it
, IT_CONTINUATION
);
17613 row
->continued_p
= 1;
17614 it
->current_x
= x_before
;
17615 it
->continuation_lines_width
+= x_before
;
17617 /* Restore the height to what it was before the
17618 element not fitting on the line. */
17619 it
->max_ascent
= ascent
;
17620 it
->max_descent
= descent
;
17621 it
->max_phys_ascent
= phys_ascent
;
17622 it
->max_phys_descent
= phys_descent
;
17624 else if (wrap_row_used
> 0)
17627 if (row
->reversed_p
)
17628 unproduce_glyphs (it
,
17629 row
->used
[TEXT_AREA
] - wrap_row_used
);
17631 it
->continuation_lines_width
+= wrap_x
;
17632 row
->used
[TEXT_AREA
] = wrap_row_used
;
17633 row
->ascent
= wrap_row_ascent
;
17634 row
->height
= wrap_row_height
;
17635 row
->phys_ascent
= wrap_row_phys_ascent
;
17636 row
->phys_height
= wrap_row_phys_height
;
17637 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17638 min_pos
= wrap_row_min_pos
;
17639 min_bpos
= wrap_row_min_bpos
;
17640 max_pos
= wrap_row_max_pos
;
17641 max_bpos
= wrap_row_max_bpos
;
17642 row
->continued_p
= 1;
17643 row
->ends_at_zv_p
= 0;
17644 row
->exact_window_width_line_p
= 0;
17645 it
->continuation_lines_width
+= x
;
17647 /* Make sure that a non-default face is extended
17648 up to the right margin of the window. */
17649 extend_face_to_end_of_line (it
);
17651 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17653 /* A TAB that extends past the right edge of the
17654 window. This produces a single glyph on
17655 window system frames. We leave the glyph in
17656 this row and let it fill the row, but don't
17657 consume the TAB. */
17658 it
->continuation_lines_width
+= it
->last_visible_x
;
17659 row
->ends_in_middle_of_char_p
= 1;
17660 row
->continued_p
= 1;
17661 glyph
->pixel_width
= it
->last_visible_x
- x
;
17662 it
->starts_in_middle_of_char_p
= 1;
17666 /* Something other than a TAB that draws past
17667 the right edge of the window. Restore
17668 positions to values before the element. */
17669 if (row
->reversed_p
)
17670 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17671 - (n_glyphs_before
+ i
));
17672 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17674 /* Display continuation glyphs. */
17675 if (!FRAME_WINDOW_P (it
->f
))
17676 produce_special_glyphs (it
, IT_CONTINUATION
);
17677 row
->continued_p
= 1;
17679 it
->current_x
= x_before
;
17680 it
->continuation_lines_width
+= x
;
17681 extend_face_to_end_of_line (it
);
17683 if (nglyphs
> 1 && i
> 0)
17685 row
->ends_in_middle_of_char_p
= 1;
17686 it
->starts_in_middle_of_char_p
= 1;
17689 /* Restore the height to what it was before the
17690 element not fitting on the line. */
17691 it
->max_ascent
= ascent
;
17692 it
->max_descent
= descent
;
17693 it
->max_phys_ascent
= phys_ascent
;
17694 it
->max_phys_descent
= phys_descent
;
17699 else if (new_x
> it
->first_visible_x
)
17701 /* Increment number of glyphs actually displayed. */
17704 /* Record the maximum and minimum buffer positions
17705 seen so far in glyphs that will be displayed by
17708 RECORD_MAX_MIN_POS (it
);
17710 if (x
< it
->first_visible_x
)
17711 /* Glyph is partially visible, i.e. row starts at
17712 negative X position. */
17713 row
->x
= x
- it
->first_visible_x
;
17717 /* Glyph is completely off the left margin of the
17718 window. This should not happen because of the
17719 move_it_in_display_line at the start of this
17720 function, unless the text display area of the
17721 window is empty. */
17722 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17726 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17727 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17728 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17729 row
->phys_height
= max (row
->phys_height
,
17730 it
->max_phys_ascent
+ it
->max_phys_descent
);
17731 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17732 it
->max_extra_line_spacing
);
17734 /* End of this display line if row is continued. */
17735 if (row
->continued_p
|| row
->ends_at_zv_p
)
17740 /* Is this a line end? If yes, we're also done, after making
17741 sure that a non-default face is extended up to the right
17742 margin of the window. */
17743 if (ITERATOR_AT_END_OF_LINE_P (it
))
17745 int used_before
= row
->used
[TEXT_AREA
];
17747 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17749 /* Add a space at the end of the line that is used to
17750 display the cursor there. */
17751 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17752 append_space_for_newline (it
, 0);
17754 /* Extend the face to the end of the line. */
17755 extend_face_to_end_of_line (it
);
17757 /* Make sure we have the position. */
17758 if (used_before
== 0)
17759 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17761 /* Record the position of the newline, for use in
17763 it
->eol_pos
= it
->current
.pos
;
17765 /* Consume the line end. This skips over invisible lines. */
17766 set_iterator_to_next (it
, 1);
17767 it
->continuation_lines_width
= 0;
17771 /* Proceed with next display element. Note that this skips
17772 over lines invisible because of selective display. */
17773 set_iterator_to_next (it
, 1);
17775 /* If we truncate lines, we are done when the last displayed
17776 glyphs reach past the right margin of the window. */
17777 if (it
->line_wrap
== TRUNCATE
17778 && (FRAME_WINDOW_P (it
->f
)
17779 ? (it
->current_x
>= it
->last_visible_x
)
17780 : (it
->current_x
> it
->last_visible_x
)))
17782 /* Maybe add truncation glyphs. */
17783 if (!FRAME_WINDOW_P (it
->f
))
17787 if (!row
->reversed_p
)
17789 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17790 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17795 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17796 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17798 /* Remove any padding glyphs at the front of ROW, to
17799 make room for the truncation glyphs we will be
17800 adding below. The loop below always inserts at
17801 least one truncation glyph, so also remove the
17802 last glyph added to ROW. */
17803 unproduce_glyphs (it
, i
+ 1);
17804 /* Adjust i for the loop below. */
17805 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17808 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17810 row
->used
[TEXT_AREA
] = i
;
17811 produce_special_glyphs (it
, IT_TRUNCATION
);
17814 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17816 /* Don't truncate if we can overflow newline into fringe. */
17817 if (!get_next_display_element (it
))
17819 it
->continuation_lines_width
= 0;
17820 row
->ends_at_zv_p
= 1;
17821 row
->exact_window_width_line_p
= 1;
17824 if (ITERATOR_AT_END_OF_LINE_P (it
))
17826 row
->exact_window_width_line_p
= 1;
17827 goto at_end_of_line
;
17831 row
->truncated_on_right_p
= 1;
17832 it
->continuation_lines_width
= 0;
17833 reseat_at_next_visible_line_start (it
, 0);
17834 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17835 it
->hpos
= hpos_before
;
17836 it
->current_x
= x_before
;
17841 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17842 at the left window margin. */
17843 if (it
->first_visible_x
17844 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17846 if (!FRAME_WINDOW_P (it
->f
))
17847 insert_left_trunc_glyphs (it
);
17848 row
->truncated_on_left_p
= 1;
17851 /* Remember the position at which this line ends.
17853 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17854 cannot be before the call to find_row_edges below, since that is
17855 where these positions are determined. */
17856 row
->end
= it
->current
;
17859 row
->minpos
= row
->start
.pos
;
17860 row
->maxpos
= row
->end
.pos
;
17864 /* ROW->minpos and ROW->maxpos must be the smallest and
17865 `1 + the largest' buffer positions in ROW. But if ROW was
17866 bidi-reordered, these two positions can be anywhere in the
17867 row, so we must determine them now. */
17868 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17871 /* If the start of this line is the overlay arrow-position, then
17872 mark this glyph row as the one containing the overlay arrow.
17873 This is clearly a mess with variable size fonts. It would be
17874 better to let it be displayed like cursors under X. */
17875 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17876 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17877 !NILP (overlay_arrow_string
)))
17879 /* Overlay arrow in window redisplay is a fringe bitmap. */
17880 if (STRINGP (overlay_arrow_string
))
17882 struct glyph_row
*arrow_row
17883 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17884 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17885 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17886 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17887 struct glyph
*p2
, *end
;
17889 /* Copy the arrow glyphs. */
17890 while (glyph
< arrow_end
)
17893 /* Throw away padding glyphs. */
17895 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17896 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17902 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17907 xassert (INTEGERP (overlay_arrow_string
));
17908 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17910 overlay_arrow_seen
= 1;
17913 /* Compute pixel dimensions of this line. */
17914 compute_line_metrics (it
);
17916 /* Record whether this row ends inside an ellipsis. */
17917 row
->ends_in_ellipsis_p
17918 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17919 && it
->ellipsis_p
);
17921 /* Save fringe bitmaps in this row. */
17922 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17923 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17924 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17925 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17927 it
->left_user_fringe_bitmap
= 0;
17928 it
->left_user_fringe_face_id
= 0;
17929 it
->right_user_fringe_bitmap
= 0;
17930 it
->right_user_fringe_face_id
= 0;
17932 /* Maybe set the cursor. */
17933 cvpos
= it
->w
->cursor
.vpos
;
17935 /* In bidi-reordered rows, keep checking for proper cursor
17936 position even if one has been found already, because buffer
17937 positions in such rows change non-linearly with ROW->VPOS,
17938 when a line is continued. One exception: when we are at ZV,
17939 display cursor on the first suitable glyph row, since all
17940 the empty rows after that also have their position set to ZV. */
17941 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17942 lines' rows is implemented for bidi-reordered rows. */
17944 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17945 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17946 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17947 && cursor_row_p (it
->w
, row
))
17948 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17950 /* Highlight trailing whitespace. */
17951 if (!NILP (Vshow_trailing_whitespace
))
17952 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17954 /* Prepare for the next line. This line starts horizontally at (X
17955 HPOS) = (0 0). Vertical positions are incremented. As a
17956 convenience for the caller, IT->glyph_row is set to the next
17958 it
->current_x
= it
->hpos
= 0;
17959 it
->current_y
+= row
->height
;
17960 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17963 /* The next row should by default use the same value of the
17964 reversed_p flag as this one. set_iterator_to_next decides when
17965 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17966 the flag accordingly. */
17967 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17968 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17969 it
->start
= row
->end
;
17970 return row
->displays_text_p
;
17972 #undef RECORD_MAX_MIN_POS
17975 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17976 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17977 doc
: /* Return paragraph direction at point in BUFFER.
17978 Value is either `left-to-right' or `right-to-left'.
17979 If BUFFER is omitted or nil, it defaults to the current buffer.
17981 Paragraph direction determines how the text in the paragraph is displayed.
17982 In left-to-right paragraphs, text begins at the left margin of the window
17983 and the reading direction is generally left to right. In right-to-left
17984 paragraphs, text begins at the right margin and is read from right to left.
17986 See also `bidi-paragraph-direction'. */)
17987 (Lisp_Object buffer
)
17989 struct buffer
*buf
= current_buffer
;
17990 struct buffer
*old
= buf
;
17992 if (! NILP (buffer
))
17994 CHECK_BUFFER (buffer
);
17995 buf
= XBUFFER (buffer
);
17998 if (NILP (BVAR (buf
, bidi_display_reordering
)))
17999 return Qleft_to_right
;
18000 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18001 return BVAR (buf
, bidi_paragraph_direction
);
18004 /* Determine the direction from buffer text. We could try to
18005 use current_matrix if it is up to date, but this seems fast
18006 enough as it is. */
18007 struct bidi_it itb
;
18008 EMACS_INT pos
= BUF_PT (buf
);
18009 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18012 set_buffer_temp (buf
);
18013 /* bidi_paragraph_init finds the base direction of the paragraph
18014 by searching forward from paragraph start. We need the base
18015 direction of the current or _previous_ paragraph, so we need
18016 to make sure we are within that paragraph. To that end, find
18017 the previous non-empty line. */
18018 if (pos
>= ZV
&& pos
> BEGV
)
18021 bytepos
= CHAR_TO_BYTE (pos
);
18023 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18024 || c
== ' ' || c
== '\t' || c
== '\f')
18026 if (bytepos
<= BEGV_BYTE
)
18031 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18034 itb
.bytepos
= bytepos
;
18036 itb
.separator_limit
= -1;
18037 itb
.paragraph_dir
= NEUTRAL_DIR
;
18039 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18040 set_buffer_temp (old
);
18041 switch (itb
.paragraph_dir
)
18044 return Qleft_to_right
;
18047 return Qright_to_left
;
18057 /***********************************************************************
18059 ***********************************************************************/
18061 /* Redisplay the menu bar in the frame for window W.
18063 The menu bar of X frames that don't have X toolkit support is
18064 displayed in a special window W->frame->menu_bar_window.
18066 The menu bar of terminal frames is treated specially as far as
18067 glyph matrices are concerned. Menu bar lines are not part of
18068 windows, so the update is done directly on the frame matrix rows
18069 for the menu bar. */
18072 display_menu_bar (struct window
*w
)
18074 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18079 /* Don't do all this for graphical frames. */
18081 if (FRAME_W32_P (f
))
18084 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18090 if (FRAME_NS_P (f
))
18092 #endif /* HAVE_NS */
18094 #ifdef USE_X_TOOLKIT
18095 xassert (!FRAME_WINDOW_P (f
));
18096 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18097 it
.first_visible_x
= 0;
18098 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18099 #else /* not USE_X_TOOLKIT */
18100 if (FRAME_WINDOW_P (f
))
18102 /* Menu bar lines are displayed in the desired matrix of the
18103 dummy window menu_bar_window. */
18104 struct window
*menu_w
;
18105 xassert (WINDOWP (f
->menu_bar_window
));
18106 menu_w
= XWINDOW (f
->menu_bar_window
);
18107 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18109 it
.first_visible_x
= 0;
18110 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18114 /* This is a TTY frame, i.e. character hpos/vpos are used as
18116 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18118 it
.first_visible_x
= 0;
18119 it
.last_visible_x
= FRAME_COLS (f
);
18121 #endif /* not USE_X_TOOLKIT */
18123 if (! mode_line_inverse_video
)
18124 /* Force the menu-bar to be displayed in the default face. */
18125 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18127 /* Clear all rows of the menu bar. */
18128 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18130 struct glyph_row
*row
= it
.glyph_row
+ i
;
18131 clear_glyph_row (row
);
18132 row
->enabled_p
= 1;
18133 row
->full_width_p
= 1;
18136 /* Display all items of the menu bar. */
18137 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18138 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18140 Lisp_Object string
;
18142 /* Stop at nil string. */
18143 string
= AREF (items
, i
+ 1);
18147 /* Remember where item was displayed. */
18148 ASET (items
, i
+ 3, make_number (it
.hpos
));
18150 /* Display the item, pad with one space. */
18151 if (it
.current_x
< it
.last_visible_x
)
18152 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18153 SCHARS (string
) + 1, 0, 0, -1);
18156 /* Fill out the line with spaces. */
18157 if (it
.current_x
< it
.last_visible_x
)
18158 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18160 /* Compute the total height of the lines. */
18161 compute_line_metrics (&it
);
18166 /***********************************************************************
18168 ***********************************************************************/
18170 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18171 FORCE is non-zero, redisplay mode lines unconditionally.
18172 Otherwise, redisplay only mode lines that are garbaged. Value is
18173 the number of windows whose mode lines were redisplayed. */
18176 redisplay_mode_lines (Lisp_Object window
, int force
)
18180 while (!NILP (window
))
18182 struct window
*w
= XWINDOW (window
);
18184 if (WINDOWP (w
->hchild
))
18185 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18186 else if (WINDOWP (w
->vchild
))
18187 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18189 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18190 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18192 struct text_pos lpoint
;
18193 struct buffer
*old
= current_buffer
;
18195 /* Set the window's buffer for the mode line display. */
18196 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18197 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18199 /* Point refers normally to the selected window. For any
18200 other window, set up appropriate value. */
18201 if (!EQ (window
, selected_window
))
18203 struct text_pos pt
;
18205 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18206 if (CHARPOS (pt
) < BEGV
)
18207 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18208 else if (CHARPOS (pt
) > (ZV
- 1))
18209 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18211 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18214 /* Display mode lines. */
18215 clear_glyph_matrix (w
->desired_matrix
);
18216 if (display_mode_lines (w
))
18219 w
->must_be_updated_p
= 1;
18222 /* Restore old settings. */
18223 set_buffer_internal_1 (old
);
18224 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18234 /* Display the mode and/or header line of window W. Value is the
18235 sum number of mode lines and header lines displayed. */
18238 display_mode_lines (struct window
*w
)
18240 Lisp_Object old_selected_window
, old_selected_frame
;
18243 old_selected_frame
= selected_frame
;
18244 selected_frame
= w
->frame
;
18245 old_selected_window
= selected_window
;
18246 XSETWINDOW (selected_window
, w
);
18248 /* These will be set while the mode line specs are processed. */
18249 line_number_displayed
= 0;
18250 w
->column_number_displayed
= Qnil
;
18252 if (WINDOW_WANTS_MODELINE_P (w
))
18254 struct window
*sel_w
= XWINDOW (old_selected_window
);
18256 /* Select mode line face based on the real selected window. */
18257 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18258 BVAR (current_buffer
, mode_line_format
));
18262 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18264 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18265 BVAR (current_buffer
, header_line_format
));
18269 selected_frame
= old_selected_frame
;
18270 selected_window
= old_selected_window
;
18275 /* Display mode or header line of window W. FACE_ID specifies which
18276 line to display; it is either MODE_LINE_FACE_ID or
18277 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18278 display. Value is the pixel height of the mode/header line
18282 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18286 int count
= SPECPDL_INDEX ();
18288 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18289 /* Don't extend on a previously drawn mode-line.
18290 This may happen if called from pos_visible_p. */
18291 it
.glyph_row
->enabled_p
= 0;
18292 prepare_desired_row (it
.glyph_row
);
18294 it
.glyph_row
->mode_line_p
= 1;
18296 if (! mode_line_inverse_video
)
18297 /* Force the mode-line to be displayed in the default face. */
18298 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18300 record_unwind_protect (unwind_format_mode_line
,
18301 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18303 mode_line_target
= MODE_LINE_DISPLAY
;
18305 /* Temporarily make frame's keyboard the current kboard so that
18306 kboard-local variables in the mode_line_format will get the right
18308 push_kboard (FRAME_KBOARD (it
.f
));
18309 record_unwind_save_match_data ();
18310 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18313 unbind_to (count
, Qnil
);
18315 /* Fill up with spaces. */
18316 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18318 compute_line_metrics (&it
);
18319 it
.glyph_row
->full_width_p
= 1;
18320 it
.glyph_row
->continued_p
= 0;
18321 it
.glyph_row
->truncated_on_left_p
= 0;
18322 it
.glyph_row
->truncated_on_right_p
= 0;
18324 /* Make a 3D mode-line have a shadow at its right end. */
18325 face
= FACE_FROM_ID (it
.f
, face_id
);
18326 extend_face_to_end_of_line (&it
);
18327 if (face
->box
!= FACE_NO_BOX
)
18329 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18330 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18331 last
->right_box_line_p
= 1;
18334 return it
.glyph_row
->height
;
18337 /* Move element ELT in LIST to the front of LIST.
18338 Return the updated list. */
18341 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18343 register Lisp_Object tail
, prev
;
18344 register Lisp_Object tem
;
18348 while (CONSP (tail
))
18354 /* Splice out the link TAIL. */
18356 list
= XCDR (tail
);
18358 Fsetcdr (prev
, XCDR (tail
));
18360 /* Now make it the first. */
18361 Fsetcdr (tail
, list
);
18366 tail
= XCDR (tail
);
18370 /* Not found--return unchanged LIST. */
18374 /* Contribute ELT to the mode line for window IT->w. How it
18375 translates into text depends on its data type.
18377 IT describes the display environment in which we display, as usual.
18379 DEPTH is the depth in recursion. It is used to prevent
18380 infinite recursion here.
18382 FIELD_WIDTH is the number of characters the display of ELT should
18383 occupy in the mode line, and PRECISION is the maximum number of
18384 characters to display from ELT's representation. See
18385 display_string for details.
18387 Returns the hpos of the end of the text generated by ELT.
18389 PROPS is a property list to add to any string we encounter.
18391 If RISKY is nonzero, remove (disregard) any properties in any string
18392 we encounter, and ignore :eval and :propertize.
18394 The global variable `mode_line_target' determines whether the
18395 output is passed to `store_mode_line_noprop',
18396 `store_mode_line_string', or `display_string'. */
18399 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18400 Lisp_Object elt
, Lisp_Object props
, int risky
)
18402 int n
= 0, field
, prec
;
18407 elt
= build_string ("*too-deep*");
18411 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18415 /* A string: output it and check for %-constructs within it. */
18417 EMACS_INT offset
= 0;
18419 if (SCHARS (elt
) > 0
18420 && (!NILP (props
) || risky
))
18422 Lisp_Object oprops
, aelt
;
18423 oprops
= Ftext_properties_at (make_number (0), elt
);
18425 /* If the starting string's properties are not what
18426 we want, translate the string. Also, if the string
18427 is risky, do that anyway. */
18429 if (NILP (Fequal (props
, oprops
)) || risky
)
18431 /* If the starting string has properties,
18432 merge the specified ones onto the existing ones. */
18433 if (! NILP (oprops
) && !risky
)
18437 oprops
= Fcopy_sequence (oprops
);
18439 while (CONSP (tem
))
18441 oprops
= Fplist_put (oprops
, XCAR (tem
),
18442 XCAR (XCDR (tem
)));
18443 tem
= XCDR (XCDR (tem
));
18448 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18449 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18451 /* AELT is what we want. Move it to the front
18452 without consing. */
18454 mode_line_proptrans_alist
18455 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18461 /* If AELT has the wrong props, it is useless.
18462 so get rid of it. */
18464 mode_line_proptrans_alist
18465 = Fdelq (aelt
, mode_line_proptrans_alist
);
18467 elt
= Fcopy_sequence (elt
);
18468 Fset_text_properties (make_number (0), Flength (elt
),
18470 /* Add this item to mode_line_proptrans_alist. */
18471 mode_line_proptrans_alist
18472 = Fcons (Fcons (elt
, props
),
18473 mode_line_proptrans_alist
);
18474 /* Truncate mode_line_proptrans_alist
18475 to at most 50 elements. */
18476 tem
= Fnthcdr (make_number (50),
18477 mode_line_proptrans_alist
);
18479 XSETCDR (tem
, Qnil
);
18488 prec
= precision
- n
;
18489 switch (mode_line_target
)
18491 case MODE_LINE_NOPROP
:
18492 case MODE_LINE_TITLE
:
18493 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18495 case MODE_LINE_STRING
:
18496 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18498 case MODE_LINE_DISPLAY
:
18499 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18500 0, prec
, 0, STRING_MULTIBYTE (elt
));
18507 /* Handle the non-literal case. */
18509 while ((precision
<= 0 || n
< precision
)
18510 && SREF (elt
, offset
) != 0
18511 && (mode_line_target
!= MODE_LINE_DISPLAY
18512 || it
->current_x
< it
->last_visible_x
))
18514 EMACS_INT last_offset
= offset
;
18516 /* Advance to end of string or next format specifier. */
18517 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18520 if (offset
- 1 != last_offset
)
18522 EMACS_INT nchars
, nbytes
;
18524 /* Output to end of string or up to '%'. Field width
18525 is length of string. Don't output more than
18526 PRECISION allows us. */
18529 prec
= c_string_width (SDATA (elt
) + last_offset
,
18530 offset
- last_offset
, precision
- n
,
18533 switch (mode_line_target
)
18535 case MODE_LINE_NOPROP
:
18536 case MODE_LINE_TITLE
:
18537 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18539 case MODE_LINE_STRING
:
18541 EMACS_INT bytepos
= last_offset
;
18542 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18543 EMACS_INT endpos
= (precision
<= 0
18544 ? string_byte_to_char (elt
, offset
)
18545 : charpos
+ nchars
);
18547 n
+= store_mode_line_string (NULL
,
18548 Fsubstring (elt
, make_number (charpos
),
18549 make_number (endpos
)),
18553 case MODE_LINE_DISPLAY
:
18555 EMACS_INT bytepos
= last_offset
;
18556 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18558 if (precision
<= 0)
18559 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18560 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18562 STRING_MULTIBYTE (elt
));
18567 else /* c == '%' */
18569 EMACS_INT percent_position
= offset
;
18571 /* Get the specified minimum width. Zero means
18574 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18575 field
= field
* 10 + c
- '0';
18577 /* Don't pad beyond the total padding allowed. */
18578 if (field_width
- n
> 0 && field
> field_width
- n
)
18579 field
= field_width
- n
;
18581 /* Note that either PRECISION <= 0 or N < PRECISION. */
18582 prec
= precision
- n
;
18585 n
+= display_mode_element (it
, depth
, field
, prec
,
18586 Vglobal_mode_string
, props
,
18591 EMACS_INT bytepos
, charpos
;
18593 Lisp_Object string
;
18595 bytepos
= percent_position
;
18596 charpos
= (STRING_MULTIBYTE (elt
)
18597 ? string_byte_to_char (elt
, bytepos
)
18599 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18600 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18602 switch (mode_line_target
)
18604 case MODE_LINE_NOPROP
:
18605 case MODE_LINE_TITLE
:
18606 n
+= store_mode_line_noprop (spec
, field
, prec
);
18608 case MODE_LINE_STRING
:
18610 int len
= strlen (spec
);
18611 Lisp_Object tem
= make_string (spec
, len
);
18612 props
= Ftext_properties_at (make_number (charpos
), elt
);
18613 /* Should only keep face property in props */
18614 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18617 case MODE_LINE_DISPLAY
:
18619 int nglyphs_before
, nwritten
;
18621 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18622 nwritten
= display_string (spec
, string
, elt
,
18627 /* Assign to the glyphs written above the
18628 string where the `%x' came from, position
18632 struct glyph
*glyph
18633 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18637 for (i
= 0; i
< nwritten
; ++i
)
18639 glyph
[i
].object
= elt
;
18640 glyph
[i
].charpos
= charpos
;
18657 /* A symbol: process the value of the symbol recursively
18658 as if it appeared here directly. Avoid error if symbol void.
18659 Special case: if value of symbol is a string, output the string
18662 register Lisp_Object tem
;
18664 /* If the variable is not marked as risky to set
18665 then its contents are risky to use. */
18666 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18669 tem
= Fboundp (elt
);
18672 tem
= Fsymbol_value (elt
);
18673 /* If value is a string, output that string literally:
18674 don't check for % within it. */
18678 if (!EQ (tem
, elt
))
18680 /* Give up right away for nil or t. */
18690 register Lisp_Object car
, tem
;
18692 /* A cons cell: five distinct cases.
18693 If first element is :eval or :propertize, do something special.
18694 If first element is a string or a cons, process all the elements
18695 and effectively concatenate them.
18696 If first element is a negative number, truncate displaying cdr to
18697 at most that many characters. If positive, pad (with spaces)
18698 to at least that many characters.
18699 If first element is a symbol, process the cadr or caddr recursively
18700 according to whether the symbol's value is non-nil or nil. */
18702 if (EQ (car
, QCeval
))
18704 /* An element of the form (:eval FORM) means evaluate FORM
18705 and use the result as mode line elements. */
18710 if (CONSP (XCDR (elt
)))
18713 spec
= safe_eval (XCAR (XCDR (elt
)));
18714 n
+= display_mode_element (it
, depth
, field_width
- n
,
18715 precision
- n
, spec
, props
,
18719 else if (EQ (car
, QCpropertize
))
18721 /* An element of the form (:propertize ELT PROPS...)
18722 means display ELT but applying properties PROPS. */
18727 if (CONSP (XCDR (elt
)))
18728 n
+= display_mode_element (it
, depth
, field_width
- n
,
18729 precision
- n
, XCAR (XCDR (elt
)),
18730 XCDR (XCDR (elt
)), risky
);
18732 else if (SYMBOLP (car
))
18734 tem
= Fboundp (car
);
18738 /* elt is now the cdr, and we know it is a cons cell.
18739 Use its car if CAR has a non-nil value. */
18742 tem
= Fsymbol_value (car
);
18749 /* Symbol's value is nil (or symbol is unbound)
18750 Get the cddr of the original list
18751 and if possible find the caddr and use that. */
18755 else if (!CONSP (elt
))
18760 else if (INTEGERP (car
))
18762 register int lim
= XINT (car
);
18766 /* Negative int means reduce maximum width. */
18767 if (precision
<= 0)
18770 precision
= min (precision
, -lim
);
18774 /* Padding specified. Don't let it be more than
18775 current maximum. */
18777 lim
= min (precision
, lim
);
18779 /* If that's more padding than already wanted, queue it.
18780 But don't reduce padding already specified even if
18781 that is beyond the current truncation point. */
18782 field_width
= max (lim
, field_width
);
18786 else if (STRINGP (car
) || CONSP (car
))
18788 Lisp_Object halftail
= elt
;
18792 && (precision
<= 0 || n
< precision
))
18794 n
+= display_mode_element (it
, depth
,
18795 /* Do padding only after the last
18796 element in the list. */
18797 (! CONSP (XCDR (elt
))
18800 precision
- n
, XCAR (elt
),
18804 if ((len
& 1) == 0)
18805 halftail
= XCDR (halftail
);
18806 /* Check for cycle. */
18807 if (EQ (halftail
, elt
))
18816 elt
= build_string ("*invalid*");
18820 /* Pad to FIELD_WIDTH. */
18821 if (field_width
> 0 && n
< field_width
)
18823 switch (mode_line_target
)
18825 case MODE_LINE_NOPROP
:
18826 case MODE_LINE_TITLE
:
18827 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18829 case MODE_LINE_STRING
:
18830 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18832 case MODE_LINE_DISPLAY
:
18833 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18842 /* Store a mode-line string element in mode_line_string_list.
18844 If STRING is non-null, display that C string. Otherwise, the Lisp
18845 string LISP_STRING is displayed.
18847 FIELD_WIDTH is the minimum number of output glyphs to produce.
18848 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18849 with spaces. FIELD_WIDTH <= 0 means don't pad.
18851 PRECISION is the maximum number of characters to output from
18852 STRING. PRECISION <= 0 means don't truncate the string.
18854 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18855 properties to the string.
18857 PROPS are the properties to add to the string.
18858 The mode_line_string_face face property is always added to the string.
18862 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18863 int field_width
, int precision
, Lisp_Object props
)
18868 if (string
!= NULL
)
18870 len
= strlen (string
);
18871 if (precision
> 0 && len
> precision
)
18873 lisp_string
= make_string (string
, len
);
18875 props
= mode_line_string_face_prop
;
18876 else if (!NILP (mode_line_string_face
))
18878 Lisp_Object face
= Fplist_get (props
, Qface
);
18879 props
= Fcopy_sequence (props
);
18881 face
= mode_line_string_face
;
18883 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18884 props
= Fplist_put (props
, Qface
, face
);
18886 Fadd_text_properties (make_number (0), make_number (len
),
18887 props
, lisp_string
);
18891 len
= XFASTINT (Flength (lisp_string
));
18892 if (precision
> 0 && len
> precision
)
18895 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18898 if (!NILP (mode_line_string_face
))
18902 props
= Ftext_properties_at (make_number (0), lisp_string
);
18903 face
= Fplist_get (props
, Qface
);
18905 face
= mode_line_string_face
;
18907 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18908 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18910 lisp_string
= Fcopy_sequence (lisp_string
);
18913 Fadd_text_properties (make_number (0), make_number (len
),
18914 props
, lisp_string
);
18919 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18923 if (field_width
> len
)
18925 field_width
-= len
;
18926 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18928 Fadd_text_properties (make_number (0), make_number (field_width
),
18929 props
, lisp_string
);
18930 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18938 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18940 doc
: /* Format a string out of a mode line format specification.
18941 First arg FORMAT specifies the mode line format (see `mode-line-format'
18942 for details) to use.
18944 By default, the format is evaluated for the currently selected window.
18946 Optional second arg FACE specifies the face property to put on all
18947 characters for which no face is specified. The value nil means the
18948 default face. The value t means whatever face the window's mode line
18949 currently uses (either `mode-line' or `mode-line-inactive',
18950 depending on whether the window is the selected window or not).
18951 An integer value means the value string has no text
18954 Optional third and fourth args WINDOW and BUFFER specify the window
18955 and buffer to use as the context for the formatting (defaults
18956 are the selected window and the WINDOW's buffer). */)
18957 (Lisp_Object format
, Lisp_Object face
,
18958 Lisp_Object window
, Lisp_Object buffer
)
18963 struct buffer
*old_buffer
= NULL
;
18965 int no_props
= INTEGERP (face
);
18966 int count
= SPECPDL_INDEX ();
18968 int string_start
= 0;
18971 window
= selected_window
;
18972 CHECK_WINDOW (window
);
18973 w
= XWINDOW (window
);
18976 buffer
= w
->buffer
;
18977 CHECK_BUFFER (buffer
);
18979 /* Make formatting the modeline a non-op when noninteractive, otherwise
18980 there will be problems later caused by a partially initialized frame. */
18981 if (NILP (format
) || noninteractive
)
18982 return empty_unibyte_string
;
18987 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18988 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18989 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18990 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18991 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18992 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18993 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18996 if (XBUFFER (buffer
) != current_buffer
)
18997 old_buffer
= current_buffer
;
18999 /* Save things including mode_line_proptrans_alist,
19000 and set that to nil so that we don't alter the outer value. */
19001 record_unwind_protect (unwind_format_mode_line
,
19002 format_mode_line_unwind_data
19003 (old_buffer
, selected_window
, 1));
19004 mode_line_proptrans_alist
= Qnil
;
19006 Fselect_window (window
, Qt
);
19008 set_buffer_internal_1 (XBUFFER (buffer
));
19010 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19014 mode_line_target
= MODE_LINE_NOPROP
;
19015 mode_line_string_face_prop
= Qnil
;
19016 mode_line_string_list
= Qnil
;
19017 string_start
= MODE_LINE_NOPROP_LEN (0);
19021 mode_line_target
= MODE_LINE_STRING
;
19022 mode_line_string_list
= Qnil
;
19023 mode_line_string_face
= face
;
19024 mode_line_string_face_prop
19025 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19028 push_kboard (FRAME_KBOARD (it
.f
));
19029 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19034 len
= MODE_LINE_NOPROP_LEN (string_start
);
19035 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19039 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19040 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19041 empty_unibyte_string
);
19044 unbind_to (count
, Qnil
);
19048 /* Write a null-terminated, right justified decimal representation of
19049 the positive integer D to BUF using a minimal field width WIDTH. */
19052 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19054 register char *p
= buf
;
19062 *p
++ = d
% 10 + '0';
19067 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19078 /* Write a null-terminated, right justified decimal and "human
19079 readable" representation of the nonnegative integer D to BUF using
19080 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19082 static const char power_letter
[] =
19096 pint2hrstr (char *buf
, int width
, int d
)
19098 /* We aim to represent the nonnegative integer D as
19099 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19102 /* -1 means: do not use TENTHS. */
19106 /* Length of QUOTIENT.TENTHS as a string. */
19112 if (1000 <= quotient
)
19114 /* Scale to the appropriate EXPONENT. */
19117 remainder
= quotient
% 1000;
19121 while (1000 <= quotient
);
19123 /* Round to nearest and decide whether to use TENTHS or not. */
19126 tenths
= remainder
/ 100;
19127 if (50 <= remainder
% 100)
19134 if (quotient
== 10)
19142 if (500 <= remainder
)
19144 if (quotient
< 999)
19155 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19156 if (tenths
== -1 && quotient
<= 99)
19163 p
= psuffix
= buf
+ max (width
, length
);
19165 /* Print EXPONENT. */
19166 *psuffix
++ = power_letter
[exponent
];
19169 /* Print TENTHS. */
19172 *--p
= '0' + tenths
;
19176 /* Print QUOTIENT. */
19179 int digit
= quotient
% 10;
19180 *--p
= '0' + digit
;
19182 while ((quotient
/= 10) != 0);
19184 /* Print leading spaces. */
19189 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19190 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19191 type of CODING_SYSTEM. Return updated pointer into BUF. */
19193 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19196 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19199 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19200 const unsigned char *eol_str
;
19202 /* The EOL conversion we are using. */
19203 Lisp_Object eoltype
;
19205 val
= CODING_SYSTEM_SPEC (coding_system
);
19208 if (!VECTORP (val
)) /* Not yet decided. */
19213 eoltype
= eol_mnemonic_undecided
;
19214 /* Don't mention EOL conversion if it isn't decided. */
19219 Lisp_Object eolvalue
;
19221 attrs
= AREF (val
, 0);
19222 eolvalue
= AREF (val
, 2);
19225 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19229 /* The EOL conversion that is normal on this system. */
19231 if (NILP (eolvalue
)) /* Not yet decided. */
19232 eoltype
= eol_mnemonic_undecided
;
19233 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19234 eoltype
= eol_mnemonic_undecided
;
19235 else /* eolvalue is Qunix, Qdos, or Qmac. */
19236 eoltype
= (EQ (eolvalue
, Qunix
)
19237 ? eol_mnemonic_unix
19238 : (EQ (eolvalue
, Qdos
) == 1
19239 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19245 /* Mention the EOL conversion if it is not the usual one. */
19246 if (STRINGP (eoltype
))
19248 eol_str
= SDATA (eoltype
);
19249 eol_str_len
= SBYTES (eoltype
);
19251 else if (CHARACTERP (eoltype
))
19253 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19254 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19259 eol_str
= invalid_eol_type
;
19260 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19262 memcpy (buf
, eol_str
, eol_str_len
);
19263 buf
+= eol_str_len
;
19269 /* Return a string for the output of a mode line %-spec for window W,
19270 generated by character C. PRECISION >= 0 means don't return a
19271 string longer than that value. FIELD_WIDTH > 0 means pad the
19272 string returned with spaces to that value. Return a Lisp string in
19273 *STRING if the resulting string is taken from that Lisp string.
19275 Note we operate on the current buffer for most purposes,
19276 the exception being w->base_line_pos. */
19278 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19280 static const char *
19281 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19282 int precision
, Lisp_Object
*string
)
19285 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19286 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19287 struct buffer
*b
= current_buffer
;
19295 if (!NILP (BVAR (b
, read_only
)))
19297 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19302 /* This differs from %* only for a modified read-only buffer. */
19303 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19305 if (!NILP (BVAR (b
, read_only
)))
19310 /* This differs from %* in ignoring read-only-ness. */
19311 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19323 if (command_loop_level
> 5)
19325 p
= decode_mode_spec_buf
;
19326 for (i
= 0; i
< command_loop_level
; i
++)
19329 return decode_mode_spec_buf
;
19337 if (command_loop_level
> 5)
19339 p
= decode_mode_spec_buf
;
19340 for (i
= 0; i
< command_loop_level
; i
++)
19343 return decode_mode_spec_buf
;
19350 /* Let lots_of_dashes be a string of infinite length. */
19351 if (mode_line_target
== MODE_LINE_NOPROP
||
19352 mode_line_target
== MODE_LINE_STRING
)
19354 if (field_width
<= 0
19355 || field_width
> sizeof (lots_of_dashes
))
19357 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19358 decode_mode_spec_buf
[i
] = '-';
19359 decode_mode_spec_buf
[i
] = '\0';
19360 return decode_mode_spec_buf
;
19363 return lots_of_dashes
;
19367 obj
= BVAR (b
, name
);
19371 /* %c and %l are ignored in `frame-title-format'.
19372 (In redisplay_internal, the frame title is drawn _before_ the
19373 windows are updated, so the stuff which depends on actual
19374 window contents (such as %l) may fail to render properly, or
19375 even crash emacs.) */
19376 if (mode_line_target
== MODE_LINE_TITLE
)
19380 EMACS_INT col
= current_column ();
19381 w
->column_number_displayed
= make_number (col
);
19382 pint2str (decode_mode_spec_buf
, field_width
, col
);
19383 return decode_mode_spec_buf
;
19387 #ifndef SYSTEM_MALLOC
19389 if (NILP (Vmemory_full
))
19392 return "!MEM FULL! ";
19399 /* %F displays the frame name. */
19400 if (!NILP (f
->title
))
19401 return SSDATA (f
->title
);
19402 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19403 return SSDATA (f
->name
);
19407 obj
= BVAR (b
, filename
);
19412 EMACS_INT size
= ZV
- BEGV
;
19413 pint2str (decode_mode_spec_buf
, field_width
, size
);
19414 return decode_mode_spec_buf
;
19419 EMACS_INT size
= ZV
- BEGV
;
19420 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19421 return decode_mode_spec_buf
;
19426 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19427 int topline
, nlines
, height
;
19430 /* %c and %l are ignored in `frame-title-format'. */
19431 if (mode_line_target
== MODE_LINE_TITLE
)
19434 startpos
= XMARKER (w
->start
)->charpos
;
19435 startpos_byte
= marker_byte_position (w
->start
);
19436 height
= WINDOW_TOTAL_LINES (w
);
19438 /* If we decided that this buffer isn't suitable for line numbers,
19439 don't forget that too fast. */
19440 if (EQ (w
->base_line_pos
, w
->buffer
))
19442 /* But do forget it, if the window shows a different buffer now. */
19443 else if (BUFFERP (w
->base_line_pos
))
19444 w
->base_line_pos
= Qnil
;
19446 /* If the buffer is very big, don't waste time. */
19447 if (INTEGERP (Vline_number_display_limit
)
19448 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19450 w
->base_line_pos
= Qnil
;
19451 w
->base_line_number
= Qnil
;
19455 if (INTEGERP (w
->base_line_number
)
19456 && INTEGERP (w
->base_line_pos
)
19457 && XFASTINT (w
->base_line_pos
) <= startpos
)
19459 line
= XFASTINT (w
->base_line_number
);
19460 linepos
= XFASTINT (w
->base_line_pos
);
19461 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19466 linepos
= BUF_BEGV (b
);
19467 linepos_byte
= BUF_BEGV_BYTE (b
);
19470 /* Count lines from base line to window start position. */
19471 nlines
= display_count_lines (linepos
, linepos_byte
,
19475 topline
= nlines
+ line
;
19477 /* Determine a new base line, if the old one is too close
19478 or too far away, or if we did not have one.
19479 "Too close" means it's plausible a scroll-down would
19480 go back past it. */
19481 if (startpos
== BUF_BEGV (b
))
19483 w
->base_line_number
= make_number (topline
);
19484 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19486 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19487 || linepos
== BUF_BEGV (b
))
19489 EMACS_INT limit
= BUF_BEGV (b
);
19490 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19491 EMACS_INT position
;
19492 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19494 if (startpos
- distance
> limit
)
19496 limit
= startpos
- distance
;
19497 limit_byte
= CHAR_TO_BYTE (limit
);
19500 nlines
= display_count_lines (startpos
, startpos_byte
,
19502 - (height
* 2 + 30),
19504 /* If we couldn't find the lines we wanted within
19505 line_number_display_limit_width chars per line,
19506 give up on line numbers for this window. */
19507 if (position
== limit_byte
&& limit
== startpos
- distance
)
19509 w
->base_line_pos
= w
->buffer
;
19510 w
->base_line_number
= Qnil
;
19514 w
->base_line_number
= make_number (topline
- nlines
);
19515 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19518 /* Now count lines from the start pos to point. */
19519 nlines
= display_count_lines (startpos
, startpos_byte
,
19520 PT_BYTE
, PT
, &junk
);
19522 /* Record that we did display the line number. */
19523 line_number_displayed
= 1;
19525 /* Make the string to show. */
19526 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19527 return decode_mode_spec_buf
;
19530 char* p
= decode_mode_spec_buf
;
19531 int pad
= field_width
- 2;
19537 return decode_mode_spec_buf
;
19543 obj
= BVAR (b
, mode_name
);
19547 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19553 EMACS_INT pos
= marker_position (w
->start
);
19554 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19556 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19558 if (pos
<= BUF_BEGV (b
))
19563 else if (pos
<= BUF_BEGV (b
))
19567 if (total
> 1000000)
19568 /* Do it differently for a large value, to avoid overflow. */
19569 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19571 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19572 /* We can't normally display a 3-digit number,
19573 so get us a 2-digit number that is close. */
19576 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19577 return decode_mode_spec_buf
;
19581 /* Display percentage of size above the bottom of the screen. */
19584 EMACS_INT toppos
= marker_position (w
->start
);
19585 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19586 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19588 if (botpos
>= BUF_ZV (b
))
19590 if (toppos
<= BUF_BEGV (b
))
19597 if (total
> 1000000)
19598 /* Do it differently for a large value, to avoid overflow. */
19599 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19601 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19602 /* We can't normally display a 3-digit number,
19603 so get us a 2-digit number that is close. */
19606 if (toppos
<= BUF_BEGV (b
))
19607 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19609 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19610 return decode_mode_spec_buf
;
19615 /* status of process */
19616 obj
= Fget_buffer_process (Fcurrent_buffer ());
19618 return "no process";
19620 obj
= Fsymbol_name (Fprocess_status (obj
));
19626 int count
= inhibit_garbage_collection ();
19627 Lisp_Object val
= call1 (intern ("file-remote-p"),
19628 BVAR (current_buffer
, directory
));
19629 unbind_to (count
, Qnil
);
19637 case 't': /* indicate TEXT or BINARY */
19641 /* coding-system (not including end-of-line format) */
19643 /* coding-system (including end-of-line type) */
19645 int eol_flag
= (c
== 'Z');
19646 char *p
= decode_mode_spec_buf
;
19648 if (! FRAME_WINDOW_P (f
))
19650 /* No need to mention EOL here--the terminal never needs
19651 to do EOL conversion. */
19652 p
= decode_mode_spec_coding (CODING_ID_NAME
19653 (FRAME_KEYBOARD_CODING (f
)->id
),
19655 p
= decode_mode_spec_coding (CODING_ID_NAME
19656 (FRAME_TERMINAL_CODING (f
)->id
),
19659 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19662 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19663 #ifdef subprocesses
19664 obj
= Fget_buffer_process (Fcurrent_buffer ());
19665 if (PROCESSP (obj
))
19667 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19669 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19672 #endif /* subprocesses */
19675 return decode_mode_spec_buf
;
19682 return SSDATA (obj
);
19689 /* Count up to COUNT lines starting from START / START_BYTE.
19690 But don't go beyond LIMIT_BYTE.
19691 Return the number of lines thus found (always nonnegative).
19693 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19696 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19697 EMACS_INT limit_byte
, int count
,
19698 EMACS_INT
*byte_pos_ptr
)
19700 register unsigned char *cursor
;
19701 unsigned char *base
;
19703 register int ceiling
;
19704 register unsigned char *ceiling_addr
;
19705 int orig_count
= count
;
19707 /* If we are not in selective display mode,
19708 check only for newlines. */
19709 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19710 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19714 while (start_byte
< limit_byte
)
19716 ceiling
= BUFFER_CEILING_OF (start_byte
);
19717 ceiling
= min (limit_byte
- 1, ceiling
);
19718 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19719 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19722 if (selective_display
)
19723 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19726 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19729 if (cursor
!= ceiling_addr
)
19733 start_byte
+= cursor
- base
+ 1;
19734 *byte_pos_ptr
= start_byte
;
19738 if (++cursor
== ceiling_addr
)
19744 start_byte
+= cursor
- base
;
19749 while (start_byte
> limit_byte
)
19751 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19752 ceiling
= max (limit_byte
, ceiling
);
19753 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19754 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19757 if (selective_display
)
19758 while (--cursor
!= ceiling_addr
19759 && *cursor
!= '\n' && *cursor
!= 015)
19762 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19765 if (cursor
!= ceiling_addr
)
19769 start_byte
+= cursor
- base
+ 1;
19770 *byte_pos_ptr
= start_byte
;
19771 /* When scanning backwards, we should
19772 not count the newline posterior to which we stop. */
19773 return - orig_count
- 1;
19779 /* Here we add 1 to compensate for the last decrement
19780 of CURSOR, which took it past the valid range. */
19781 start_byte
+= cursor
- base
+ 1;
19785 *byte_pos_ptr
= limit_byte
;
19788 return - orig_count
+ count
;
19789 return orig_count
- count
;
19795 /***********************************************************************
19797 ***********************************************************************/
19799 /* Display a NUL-terminated string, starting with index START.
19801 If STRING is non-null, display that C string. Otherwise, the Lisp
19802 string LISP_STRING is displayed. There's a case that STRING is
19803 non-null and LISP_STRING is not nil. It means STRING is a string
19804 data of LISP_STRING. In that case, we display LISP_STRING while
19805 ignoring its text properties.
19807 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19808 FACE_STRING. Display STRING or LISP_STRING with the face at
19809 FACE_STRING_POS in FACE_STRING:
19811 Display the string in the environment given by IT, but use the
19812 standard display table, temporarily.
19814 FIELD_WIDTH is the minimum number of output glyphs to produce.
19815 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19816 with spaces. If STRING has more characters, more than FIELD_WIDTH
19817 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19819 PRECISION is the maximum number of characters to output from
19820 STRING. PRECISION < 0 means don't truncate the string.
19822 This is roughly equivalent to printf format specifiers:
19824 FIELD_WIDTH PRECISION PRINTF
19825 ----------------------------------------
19831 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19832 display them, and < 0 means obey the current buffer's value of
19833 enable_multibyte_characters.
19835 Value is the number of columns displayed. */
19838 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19839 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19840 int field_width
, int precision
, int max_x
, int multibyte
)
19842 int hpos_at_start
= it
->hpos
;
19843 int saved_face_id
= it
->face_id
;
19844 struct glyph_row
*row
= it
->glyph_row
;
19846 /* Initialize the iterator IT for iteration over STRING beginning
19847 with index START. */
19848 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19849 precision
, field_width
, multibyte
);
19850 if (string
&& STRINGP (lisp_string
))
19851 /* LISP_STRING is the one returned by decode_mode_spec. We should
19852 ignore its text properties. */
19853 it
->stop_charpos
= -1;
19855 /* If displaying STRING, set up the face of the iterator
19856 from LISP_STRING, if that's given. */
19857 if (STRINGP (face_string
))
19863 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19864 0, it
->region_beg_charpos
,
19865 it
->region_end_charpos
,
19866 &endptr
, it
->base_face_id
, 0);
19867 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19868 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19871 /* Set max_x to the maximum allowed X position. Don't let it go
19872 beyond the right edge of the window. */
19874 max_x
= it
->last_visible_x
;
19876 max_x
= min (max_x
, it
->last_visible_x
);
19878 /* Skip over display elements that are not visible. because IT->w is
19880 if (it
->current_x
< it
->first_visible_x
)
19881 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19882 MOVE_TO_POS
| MOVE_TO_X
);
19884 row
->ascent
= it
->max_ascent
;
19885 row
->height
= it
->max_ascent
+ it
->max_descent
;
19886 row
->phys_ascent
= it
->max_phys_ascent
;
19887 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19888 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19890 /* This condition is for the case that we are called with current_x
19891 past last_visible_x. */
19892 while (it
->current_x
< max_x
)
19894 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19896 /* Get the next display element. */
19897 if (!get_next_display_element (it
))
19900 /* Produce glyphs. */
19901 x_before
= it
->current_x
;
19902 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19903 PRODUCE_GLYPHS (it
);
19905 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19908 while (i
< nglyphs
)
19910 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19912 if (it
->line_wrap
!= TRUNCATE
19913 && x
+ glyph
->pixel_width
> max_x
)
19915 /* End of continued line or max_x reached. */
19916 if (CHAR_GLYPH_PADDING_P (*glyph
))
19918 /* A wide character is unbreakable. */
19919 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19920 it
->current_x
= x_before
;
19924 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19929 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19931 /* Glyph is at least partially visible. */
19933 if (x
< it
->first_visible_x
)
19934 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19938 /* Glyph is off the left margin of the display area.
19939 Should not happen. */
19943 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19944 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19945 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19946 row
->phys_height
= max (row
->phys_height
,
19947 it
->max_phys_ascent
+ it
->max_phys_descent
);
19948 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19949 it
->max_extra_line_spacing
);
19950 x
+= glyph
->pixel_width
;
19954 /* Stop if max_x reached. */
19958 /* Stop at line ends. */
19959 if (ITERATOR_AT_END_OF_LINE_P (it
))
19961 it
->continuation_lines_width
= 0;
19965 set_iterator_to_next (it
, 1);
19967 /* Stop if truncating at the right edge. */
19968 if (it
->line_wrap
== TRUNCATE
19969 && it
->current_x
>= it
->last_visible_x
)
19971 /* Add truncation mark, but don't do it if the line is
19972 truncated at a padding space. */
19973 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19975 if (!FRAME_WINDOW_P (it
->f
))
19979 if (it
->current_x
> it
->last_visible_x
)
19981 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19982 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19984 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19986 row
->used
[TEXT_AREA
] = ii
;
19987 produce_special_glyphs (it
, IT_TRUNCATION
);
19990 produce_special_glyphs (it
, IT_TRUNCATION
);
19992 it
->glyph_row
->truncated_on_right_p
= 1;
19998 /* Maybe insert a truncation at the left. */
19999 if (it
->first_visible_x
20000 && IT_CHARPOS (*it
) > 0)
20002 if (!FRAME_WINDOW_P (it
->f
))
20003 insert_left_trunc_glyphs (it
);
20004 it
->glyph_row
->truncated_on_left_p
= 1;
20007 it
->face_id
= saved_face_id
;
20009 /* Value is number of columns displayed. */
20010 return it
->hpos
- hpos_at_start
;
20015 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20016 appears as an element of LIST or as the car of an element of LIST.
20017 If PROPVAL is a list, compare each element against LIST in that
20018 way, and return 1/2 if any element of PROPVAL is found in LIST.
20019 Otherwise return 0. This function cannot quit.
20020 The return value is 2 if the text is invisible but with an ellipsis
20021 and 1 if it's invisible and without an ellipsis. */
20024 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20026 register Lisp_Object tail
, proptail
;
20028 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20030 register Lisp_Object tem
;
20032 if (EQ (propval
, tem
))
20034 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20035 return NILP (XCDR (tem
)) ? 1 : 2;
20038 if (CONSP (propval
))
20040 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20042 Lisp_Object propelt
;
20043 propelt
= XCAR (proptail
);
20044 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20046 register Lisp_Object tem
;
20048 if (EQ (propelt
, tem
))
20050 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20051 return NILP (XCDR (tem
)) ? 1 : 2;
20059 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20060 doc
: /* Non-nil if the property makes the text invisible.
20061 POS-OR-PROP can be a marker or number, in which case it is taken to be
20062 a position in the current buffer and the value of the `invisible' property
20063 is checked; or it can be some other value, which is then presumed to be the
20064 value of the `invisible' property of the text of interest.
20065 The non-nil value returned can be t for truly invisible text or something
20066 else if the text is replaced by an ellipsis. */)
20067 (Lisp_Object pos_or_prop
)
20070 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20071 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20073 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20074 return (invis
== 0 ? Qnil
20076 : make_number (invis
));
20079 /* Calculate a width or height in pixels from a specification using
20080 the following elements:
20083 NUM - a (fractional) multiple of the default font width/height
20084 (NUM) - specifies exactly NUM pixels
20085 UNIT - a fixed number of pixels, see below.
20086 ELEMENT - size of a display element in pixels, see below.
20087 (NUM . SPEC) - equals NUM * SPEC
20088 (+ SPEC SPEC ...) - add pixel values
20089 (- SPEC SPEC ...) - subtract pixel values
20090 (- SPEC) - negate pixel value
20093 INT or FLOAT - a number constant
20094 SYMBOL - use symbol's (buffer local) variable binding.
20097 in - pixels per inch *)
20098 mm - pixels per 1/1000 meter *)
20099 cm - pixels per 1/100 meter *)
20100 width - width of current font in pixels.
20101 height - height of current font in pixels.
20103 *) using the ratio(s) defined in display-pixels-per-inch.
20107 left-fringe - left fringe width in pixels
20108 right-fringe - right fringe width in pixels
20110 left-margin - left margin width in pixels
20111 right-margin - right margin width in pixels
20113 scroll-bar - scroll-bar area width in pixels
20117 Pixels corresponding to 5 inches:
20120 Total width of non-text areas on left side of window (if scroll-bar is on left):
20121 '(space :width (+ left-fringe left-margin scroll-bar))
20123 Align to first text column (in header line):
20124 '(space :align-to 0)
20126 Align to middle of text area minus half the width of variable `my-image'
20127 containing a loaded image:
20128 '(space :align-to (0.5 . (- text my-image)))
20130 Width of left margin minus width of 1 character in the default font:
20131 '(space :width (- left-margin 1))
20133 Width of left margin minus width of 2 characters in the current font:
20134 '(space :width (- left-margin (2 . width)))
20136 Center 1 character over left-margin (in header line):
20137 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20139 Different ways to express width of left fringe plus left margin minus one pixel:
20140 '(space :width (- (+ left-fringe left-margin) (1)))
20141 '(space :width (+ left-fringe left-margin (- (1))))
20142 '(space :width (+ left-fringe left-margin (-1)))
20146 #define NUMVAL(X) \
20147 ((INTEGERP (X) || FLOATP (X)) \
20152 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20153 struct font
*font
, int width_p
, int *align_to
)
20157 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20158 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20161 return OK_PIXELS (0);
20163 xassert (FRAME_LIVE_P (it
->f
));
20165 if (SYMBOLP (prop
))
20167 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20169 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20171 if (unit
[0] == 'i' && unit
[1] == 'n')
20173 else if (unit
[0] == 'm' && unit
[1] == 'm')
20175 else if (unit
[0] == 'c' && unit
[1] == 'm')
20182 #ifdef HAVE_WINDOW_SYSTEM
20183 if (FRAME_WINDOW_P (it
->f
)
20185 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20186 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20188 return OK_PIXELS (ppi
/ pixels
);
20191 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20192 || (CONSP (Vdisplay_pixels_per_inch
)
20194 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20195 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20197 return OK_PIXELS (ppi
/ pixels
);
20203 #ifdef HAVE_WINDOW_SYSTEM
20204 if (EQ (prop
, Qheight
))
20205 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20206 if (EQ (prop
, Qwidth
))
20207 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20209 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20210 return OK_PIXELS (1);
20213 if (EQ (prop
, Qtext
))
20214 return OK_PIXELS (width_p
20215 ? window_box_width (it
->w
, TEXT_AREA
)
20216 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20218 if (align_to
&& *align_to
< 0)
20221 if (EQ (prop
, Qleft
))
20222 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20223 if (EQ (prop
, Qright
))
20224 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20225 if (EQ (prop
, Qcenter
))
20226 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20227 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20228 if (EQ (prop
, Qleft_fringe
))
20229 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20230 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20231 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20232 if (EQ (prop
, Qright_fringe
))
20233 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20234 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20235 : window_box_right_offset (it
->w
, TEXT_AREA
));
20236 if (EQ (prop
, Qleft_margin
))
20237 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20238 if (EQ (prop
, Qright_margin
))
20239 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20240 if (EQ (prop
, Qscroll_bar
))
20241 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20243 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20244 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20245 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20250 if (EQ (prop
, Qleft_fringe
))
20251 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20252 if (EQ (prop
, Qright_fringe
))
20253 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20254 if (EQ (prop
, Qleft_margin
))
20255 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20256 if (EQ (prop
, Qright_margin
))
20257 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20258 if (EQ (prop
, Qscroll_bar
))
20259 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20262 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20265 if (INTEGERP (prop
) || FLOATP (prop
))
20267 int base_unit
= (width_p
20268 ? FRAME_COLUMN_WIDTH (it
->f
)
20269 : FRAME_LINE_HEIGHT (it
->f
));
20270 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20275 Lisp_Object car
= XCAR (prop
);
20276 Lisp_Object cdr
= XCDR (prop
);
20280 #ifdef HAVE_WINDOW_SYSTEM
20281 if (FRAME_WINDOW_P (it
->f
)
20282 && valid_image_p (prop
))
20284 int id
= lookup_image (it
->f
, prop
);
20285 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20287 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20290 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20296 while (CONSP (cdr
))
20298 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20299 font
, width_p
, align_to
))
20302 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20307 if (EQ (car
, Qminus
))
20309 return OK_PIXELS (pixels
);
20312 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20315 if (INTEGERP (car
) || FLOATP (car
))
20318 pixels
= XFLOATINT (car
);
20320 return OK_PIXELS (pixels
);
20321 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20322 font
, width_p
, align_to
))
20323 return OK_PIXELS (pixels
* fact
);
20334 /***********************************************************************
20336 ***********************************************************************/
20338 #ifdef HAVE_WINDOW_SYSTEM
20343 dump_glyph_string (s
)
20344 struct glyph_string
*s
;
20346 fprintf (stderr
, "glyph string\n");
20347 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20348 s
->x
, s
->y
, s
->width
, s
->height
);
20349 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20350 fprintf (stderr
, " hl = %d\n", s
->hl
);
20351 fprintf (stderr
, " left overhang = %d, right = %d\n",
20352 s
->left_overhang
, s
->right_overhang
);
20353 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20354 fprintf (stderr
, " extends to end of line = %d\n",
20355 s
->extends_to_end_of_line_p
);
20356 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20357 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20360 #endif /* GLYPH_DEBUG */
20362 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20363 of XChar2b structures for S; it can't be allocated in
20364 init_glyph_string because it must be allocated via `alloca'. W
20365 is the window on which S is drawn. ROW and AREA are the glyph row
20366 and area within the row from which S is constructed. START is the
20367 index of the first glyph structure covered by S. HL is a
20368 face-override for drawing S. */
20371 #define OPTIONAL_HDC(hdc) HDC hdc,
20372 #define DECLARE_HDC(hdc) HDC hdc;
20373 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20374 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20377 #ifndef OPTIONAL_HDC
20378 #define OPTIONAL_HDC(hdc)
20379 #define DECLARE_HDC(hdc)
20380 #define ALLOCATE_HDC(hdc, f)
20381 #define RELEASE_HDC(hdc, f)
20385 init_glyph_string (struct glyph_string
*s
,
20387 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20388 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20390 memset (s
, 0, sizeof *s
);
20392 s
->f
= XFRAME (w
->frame
);
20396 s
->display
= FRAME_X_DISPLAY (s
->f
);
20397 s
->window
= FRAME_X_WINDOW (s
->f
);
20398 s
->char2b
= char2b
;
20402 s
->first_glyph
= row
->glyphs
[area
] + start
;
20403 s
->height
= row
->height
;
20404 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20405 s
->ybase
= s
->y
+ row
->ascent
;
20409 /* Append the list of glyph strings with head H and tail T to the list
20410 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20413 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20414 struct glyph_string
*h
, struct glyph_string
*t
)
20428 /* Prepend the list of glyph strings with head H and tail T to the
20429 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20433 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20434 struct glyph_string
*h
, struct glyph_string
*t
)
20448 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20449 Set *HEAD and *TAIL to the resulting list. */
20452 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20453 struct glyph_string
*s
)
20455 s
->next
= s
->prev
= NULL
;
20456 append_glyph_string_lists (head
, tail
, s
, s
);
20460 /* Get face and two-byte form of character C in face FACE_ID on frame
20461 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20462 means we want to display multibyte text. DISPLAY_P non-zero means
20463 make sure that X resources for the face returned are allocated.
20464 Value is a pointer to a realized face that is ready for display if
20465 DISPLAY_P is non-zero. */
20467 static INLINE
struct face
*
20468 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20469 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20471 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20475 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20477 if (code
!= FONT_INVALID_CODE
)
20478 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20480 STORE_XCHAR2B (char2b
, 0, 0);
20483 /* Make sure X resources of the face are allocated. */
20484 #ifdef HAVE_X_WINDOWS
20488 xassert (face
!= NULL
);
20489 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20496 /* Get face and two-byte form of character glyph GLYPH on frame F.
20497 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20498 a pointer to a realized face that is ready for display. */
20500 static INLINE
struct face
*
20501 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20502 XChar2b
*char2b
, int *two_byte_p
)
20506 xassert (glyph
->type
== CHAR_GLYPH
);
20507 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20516 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20517 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20519 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20521 if (code
!= FONT_INVALID_CODE
)
20522 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20524 STORE_XCHAR2B (char2b
, 0, 0);
20527 /* Make sure X resources of the face are allocated. */
20528 xassert (face
!= NULL
);
20529 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20534 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20535 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20538 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20542 if (CHAR_BYTE8_P (c
))
20543 code
= CHAR_TO_BYTE8 (c
);
20545 code
= font
->driver
->encode_char (font
, c
);
20547 if (code
== FONT_INVALID_CODE
)
20549 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20554 /* Fill glyph string S with composition components specified by S->cmp.
20556 BASE_FACE is the base face of the composition.
20557 S->cmp_from is the index of the first component for S.
20559 OVERLAPS non-zero means S should draw the foreground only, and use
20560 its physical height for clipping. See also draw_glyphs.
20562 Value is the index of a component not in S. */
20565 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20569 /* For all glyphs of this composition, starting at the offset
20570 S->cmp_from, until we reach the end of the definition or encounter a
20571 glyph that requires the different face, add it to S. */
20576 s
->for_overlaps
= overlaps
;
20579 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20581 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20585 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20588 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20589 s
->char2b
+ i
, 1, 1);
20595 s
->font
= s
->face
->font
;
20597 else if (s
->face
!= face
)
20605 /* All glyph strings for the same composition has the same width,
20606 i.e. the width set for the first component of the composition. */
20607 s
->width
= s
->first_glyph
->pixel_width
;
20609 /* If the specified font could not be loaded, use the frame's
20610 default font, but record the fact that we couldn't load it in
20611 the glyph string so that we can draw rectangles for the
20612 characters of the glyph string. */
20613 if (s
->font
== NULL
)
20615 s
->font_not_found_p
= 1;
20616 s
->font
= FRAME_FONT (s
->f
);
20619 /* Adjust base line for subscript/superscript text. */
20620 s
->ybase
+= s
->first_glyph
->voffset
;
20622 /* This glyph string must always be drawn with 16-bit functions. */
20629 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20630 int start
, int end
, int overlaps
)
20632 struct glyph
*glyph
, *last
;
20633 Lisp_Object lgstring
;
20636 s
->for_overlaps
= overlaps
;
20637 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20638 last
= s
->row
->glyphs
[s
->area
] + end
;
20639 s
->cmp_id
= glyph
->u
.cmp
.id
;
20640 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20641 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20642 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20643 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20644 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20646 while (glyph
< last
20647 && glyph
->u
.cmp
.automatic
20648 && glyph
->u
.cmp
.id
== s
->cmp_id
20649 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20650 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20652 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20654 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20655 unsigned code
= LGLYPH_CODE (lglyph
);
20657 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20659 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20660 return glyph
- s
->row
->glyphs
[s
->area
];
20664 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20665 See the comment of fill_glyph_string for arguments.
20666 Value is the index of the first glyph not in S. */
20670 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20671 int start
, int end
, int overlaps
)
20673 struct glyph
*glyph
, *last
;
20676 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20677 s
->for_overlaps
= overlaps
;
20678 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20679 last
= s
->row
->glyphs
[s
->area
] + end
;
20680 voffset
= glyph
->voffset
;
20681 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20682 s
->font
= s
->face
->font
;
20684 s
->width
= glyph
->pixel_width
;
20686 while (glyph
< last
20687 && glyph
->type
== GLYPHLESS_GLYPH
20688 && glyph
->voffset
== voffset
20689 && glyph
->face_id
== face_id
)
20692 s
->width
+= glyph
->pixel_width
;
20695 s
->ybase
+= voffset
;
20696 return glyph
- s
->row
->glyphs
[s
->area
];
20700 /* Fill glyph string S from a sequence of character glyphs.
20702 FACE_ID is the face id of the string. START is the index of the
20703 first glyph to consider, END is the index of the last + 1.
20704 OVERLAPS non-zero means S should draw the foreground only, and use
20705 its physical height for clipping. See also draw_glyphs.
20707 Value is the index of the first glyph not in S. */
20710 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20711 int start
, int end
, int overlaps
)
20713 struct glyph
*glyph
, *last
;
20715 int glyph_not_available_p
;
20717 xassert (s
->f
== XFRAME (s
->w
->frame
));
20718 xassert (s
->nchars
== 0);
20719 xassert (start
>= 0 && end
> start
);
20721 s
->for_overlaps
= overlaps
;
20722 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20723 last
= s
->row
->glyphs
[s
->area
] + end
;
20724 voffset
= glyph
->voffset
;
20725 s
->padding_p
= glyph
->padding_p
;
20726 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20728 while (glyph
< last
20729 && glyph
->type
== CHAR_GLYPH
20730 && glyph
->voffset
== voffset
20731 /* Same face id implies same font, nowadays. */
20732 && glyph
->face_id
== face_id
20733 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20737 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20738 s
->char2b
+ s
->nchars
,
20740 s
->two_byte_p
= two_byte_p
;
20742 xassert (s
->nchars
<= end
- start
);
20743 s
->width
+= glyph
->pixel_width
;
20744 if (glyph
++->padding_p
!= s
->padding_p
)
20748 s
->font
= s
->face
->font
;
20750 /* If the specified font could not be loaded, use the frame's font,
20751 but record the fact that we couldn't load it in
20752 S->font_not_found_p so that we can draw rectangles for the
20753 characters of the glyph string. */
20754 if (s
->font
== NULL
|| glyph_not_available_p
)
20756 s
->font_not_found_p
= 1;
20757 s
->font
= FRAME_FONT (s
->f
);
20760 /* Adjust base line for subscript/superscript text. */
20761 s
->ybase
+= voffset
;
20763 xassert (s
->face
&& s
->face
->gc
);
20764 return glyph
- s
->row
->glyphs
[s
->area
];
20768 /* Fill glyph string S from image glyph S->first_glyph. */
20771 fill_image_glyph_string (struct glyph_string
*s
)
20773 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20774 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20776 s
->slice
= s
->first_glyph
->slice
.img
;
20777 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20778 s
->font
= s
->face
->font
;
20779 s
->width
= s
->first_glyph
->pixel_width
;
20781 /* Adjust base line for subscript/superscript text. */
20782 s
->ybase
+= s
->first_glyph
->voffset
;
20786 /* Fill glyph string S from a sequence of stretch glyphs.
20788 ROW is the glyph row in which the glyphs are found, AREA is the
20789 area within the row. START is the index of the first glyph to
20790 consider, END is the index of the last + 1.
20792 Value is the index of the first glyph not in S. */
20795 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20796 enum glyph_row_area area
, int start
, int end
)
20798 struct glyph
*glyph
, *last
;
20799 int voffset
, face_id
;
20801 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20803 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20804 last
= s
->row
->glyphs
[s
->area
] + end
;
20805 face_id
= glyph
->face_id
;
20806 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20807 s
->font
= s
->face
->font
;
20808 s
->width
= glyph
->pixel_width
;
20810 voffset
= glyph
->voffset
;
20814 && glyph
->type
== STRETCH_GLYPH
20815 && glyph
->voffset
== voffset
20816 && glyph
->face_id
== face_id
);
20818 s
->width
+= glyph
->pixel_width
;
20820 /* Adjust base line for subscript/superscript text. */
20821 s
->ybase
+= voffset
;
20823 /* The case that face->gc == 0 is handled when drawing the glyph
20824 string by calling PREPARE_FACE_FOR_DISPLAY. */
20826 return glyph
- s
->row
->glyphs
[s
->area
];
20829 static struct font_metrics
*
20830 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20832 static struct font_metrics metrics
;
20833 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20835 if (! font
|| code
== FONT_INVALID_CODE
)
20837 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20842 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20843 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20844 assumed to be zero. */
20847 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20849 *left
= *right
= 0;
20851 if (glyph
->type
== CHAR_GLYPH
)
20855 struct font_metrics
*pcm
;
20857 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20858 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20860 if (pcm
->rbearing
> pcm
->width
)
20861 *right
= pcm
->rbearing
- pcm
->width
;
20862 if (pcm
->lbearing
< 0)
20863 *left
= -pcm
->lbearing
;
20866 else if (glyph
->type
== COMPOSITE_GLYPH
)
20868 if (! glyph
->u
.cmp
.automatic
)
20870 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20872 if (cmp
->rbearing
> cmp
->pixel_width
)
20873 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20874 if (cmp
->lbearing
< 0)
20875 *left
= - cmp
->lbearing
;
20879 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20880 struct font_metrics metrics
;
20882 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20883 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20884 if (metrics
.rbearing
> metrics
.width
)
20885 *right
= metrics
.rbearing
- metrics
.width
;
20886 if (metrics
.lbearing
< 0)
20887 *left
= - metrics
.lbearing
;
20893 /* Return the index of the first glyph preceding glyph string S that
20894 is overwritten by S because of S's left overhang. Value is -1
20895 if no glyphs are overwritten. */
20898 left_overwritten (struct glyph_string
*s
)
20902 if (s
->left_overhang
)
20905 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20906 int first
= s
->first_glyph
- glyphs
;
20908 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20909 x
-= glyphs
[i
].pixel_width
;
20920 /* Return the index of the first glyph preceding glyph string S that
20921 is overwriting S because of its right overhang. Value is -1 if no
20922 glyph in front of S overwrites S. */
20925 left_overwriting (struct glyph_string
*s
)
20928 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20929 int first
= s
->first_glyph
- glyphs
;
20933 for (i
= first
- 1; i
>= 0; --i
)
20936 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20939 x
-= glyphs
[i
].pixel_width
;
20946 /* Return the index of the last glyph following glyph string S that is
20947 overwritten by S because of S's right overhang. Value is -1 if
20948 no such glyph is found. */
20951 right_overwritten (struct glyph_string
*s
)
20955 if (s
->right_overhang
)
20958 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20959 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20960 int end
= s
->row
->used
[s
->area
];
20962 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20963 x
+= glyphs
[i
].pixel_width
;
20972 /* Return the index of the last glyph following glyph string S that
20973 overwrites S because of its left overhang. Value is negative
20974 if no such glyph is found. */
20977 right_overwriting (struct glyph_string
*s
)
20980 int end
= s
->row
->used
[s
->area
];
20981 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20982 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20986 for (i
= first
; i
< end
; ++i
)
20989 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20992 x
+= glyphs
[i
].pixel_width
;
20999 /* Set background width of glyph string S. START is the index of the
21000 first glyph following S. LAST_X is the right-most x-position + 1
21001 in the drawing area. */
21004 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21006 /* If the face of this glyph string has to be drawn to the end of
21007 the drawing area, set S->extends_to_end_of_line_p. */
21009 if (start
== s
->row
->used
[s
->area
]
21010 && s
->area
== TEXT_AREA
21011 && ((s
->row
->fill_line_p
21012 && (s
->hl
== DRAW_NORMAL_TEXT
21013 || s
->hl
== DRAW_IMAGE_RAISED
21014 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21015 || s
->hl
== DRAW_MOUSE_FACE
))
21016 s
->extends_to_end_of_line_p
= 1;
21018 /* If S extends its face to the end of the line, set its
21019 background_width to the distance to the right edge of the drawing
21021 if (s
->extends_to_end_of_line_p
)
21022 s
->background_width
= last_x
- s
->x
+ 1;
21024 s
->background_width
= s
->width
;
21028 /* Compute overhangs and x-positions for glyph string S and its
21029 predecessors, or successors. X is the starting x-position for S.
21030 BACKWARD_P non-zero means process predecessors. */
21033 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21039 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21040 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21050 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21051 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21061 /* The following macros are only called from draw_glyphs below.
21062 They reference the following parameters of that function directly:
21063 `w', `row', `area', and `overlap_p'
21064 as well as the following local variables:
21065 `s', `f', and `hdc' (in W32) */
21068 /* On W32, silently add local `hdc' variable to argument list of
21069 init_glyph_string. */
21070 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21071 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21073 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21074 init_glyph_string (s, char2b, w, row, area, start, hl)
21077 /* Add a glyph string for a stretch glyph to the list of strings
21078 between HEAD and TAIL. START is the index of the stretch glyph in
21079 row area AREA of glyph row ROW. END is the index of the last glyph
21080 in that glyph row area. X is the current output position assigned
21081 to the new glyph string constructed. HL overrides that face of the
21082 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21083 is the right-most x-position of the drawing area. */
21085 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21086 and below -- keep them on one line. */
21087 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21090 s = (struct glyph_string *) alloca (sizeof *s); \
21091 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21092 START = fill_stretch_glyph_string (s, row, area, START, END); \
21093 append_glyph_string (&HEAD, &TAIL, s); \
21099 /* Add a glyph string for an image glyph to the list of strings
21100 between HEAD and TAIL. START is the index of the image glyph in
21101 row area AREA of glyph row ROW. END is the index of the last glyph
21102 in that glyph row area. X is the current output position assigned
21103 to the new glyph string constructed. HL overrides that face of the
21104 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21105 is the right-most x-position of the drawing area. */
21107 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21110 s = (struct glyph_string *) alloca (sizeof *s); \
21111 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21112 fill_image_glyph_string (s); \
21113 append_glyph_string (&HEAD, &TAIL, s); \
21120 /* Add a glyph string for a sequence of character glyphs to the list
21121 of strings between HEAD and TAIL. START is the index of the first
21122 glyph in row area AREA of glyph row ROW that is part of the new
21123 glyph string. END is the index of the last glyph in that glyph row
21124 area. X is the current output position assigned to the new glyph
21125 string constructed. HL overrides that face of the glyph; e.g. it
21126 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21127 right-most x-position of the drawing area. */
21129 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21135 face_id = (row)->glyphs[area][START].face_id; \
21137 s = (struct glyph_string *) alloca (sizeof *s); \
21138 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21139 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21140 append_glyph_string (&HEAD, &TAIL, s); \
21142 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21147 /* Add a glyph string for a composite sequence to the list of strings
21148 between HEAD and TAIL. START is the index of the first glyph in
21149 row area AREA of glyph row ROW that is part of the new glyph
21150 string. END is the index of the last glyph in that glyph row area.
21151 X is the current output position assigned to the new glyph string
21152 constructed. HL overrides that face of the glyph; e.g. it is
21153 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21154 x-position of the drawing area. */
21156 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21158 int face_id = (row)->glyphs[area][START].face_id; \
21159 struct face *base_face = FACE_FROM_ID (f, face_id); \
21160 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21161 struct composition *cmp = composition_table[cmp_id]; \
21163 struct glyph_string *first_s IF_LINT (= NULL); \
21166 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21168 /* Make glyph_strings for each glyph sequence that is drawable by \
21169 the same face, and append them to HEAD/TAIL. */ \
21170 for (n = 0; n < cmp->glyph_len;) \
21172 s = (struct glyph_string *) alloca (sizeof *s); \
21173 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21174 append_glyph_string (&(HEAD), &(TAIL), s); \
21180 n = fill_composite_glyph_string (s, base_face, overlaps); \
21188 /* Add a glyph string for a glyph-string sequence to the list of strings
21189 between HEAD and TAIL. */
21191 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21195 Lisp_Object gstring; \
21197 face_id = (row)->glyphs[area][START].face_id; \
21198 gstring = (composition_gstring_from_id \
21199 ((row)->glyphs[area][START].u.cmp.id)); \
21200 s = (struct glyph_string *) alloca (sizeof *s); \
21201 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21202 * LGSTRING_GLYPH_LEN (gstring)); \
21203 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21204 append_glyph_string (&(HEAD), &(TAIL), s); \
21206 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21210 /* Add a glyph string for a sequence of glyphless character's glyphs
21211 to the list of strings between HEAD and TAIL. The meanings of
21212 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21214 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21219 face_id = (row)->glyphs[area][START].face_id; \
21221 s = (struct glyph_string *) alloca (sizeof *s); \
21222 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21223 append_glyph_string (&HEAD, &TAIL, s); \
21225 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21231 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21232 of AREA of glyph row ROW on window W between indices START and END.
21233 HL overrides the face for drawing glyph strings, e.g. it is
21234 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21235 x-positions of the drawing area.
21237 This is an ugly monster macro construct because we must use alloca
21238 to allocate glyph strings (because draw_glyphs can be called
21239 asynchronously). */
21241 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21244 HEAD = TAIL = NULL; \
21245 while (START < END) \
21247 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21248 switch (first_glyph->type) \
21251 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21255 case COMPOSITE_GLYPH: \
21256 if (first_glyph->u.cmp.automatic) \
21257 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21260 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21264 case STRETCH_GLYPH: \
21265 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21269 case IMAGE_GLYPH: \
21270 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21274 case GLYPHLESS_GLYPH: \
21275 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21285 set_glyph_string_background_width (s, START, LAST_X); \
21292 /* Draw glyphs between START and END in AREA of ROW on window W,
21293 starting at x-position X. X is relative to AREA in W. HL is a
21294 face-override with the following meaning:
21296 DRAW_NORMAL_TEXT draw normally
21297 DRAW_CURSOR draw in cursor face
21298 DRAW_MOUSE_FACE draw in mouse face.
21299 DRAW_INVERSE_VIDEO draw in mode line face
21300 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21301 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21303 If OVERLAPS is non-zero, draw only the foreground of characters and
21304 clip to the physical height of ROW. Non-zero value also defines
21305 the overlapping part to be drawn:
21307 OVERLAPS_PRED overlap with preceding rows
21308 OVERLAPS_SUCC overlap with succeeding rows
21309 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21310 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21312 Value is the x-position reached, relative to AREA of W. */
21315 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21316 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21317 enum draw_glyphs_face hl
, int overlaps
)
21319 struct glyph_string
*head
, *tail
;
21320 struct glyph_string
*s
;
21321 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21322 int i
, j
, x_reached
, last_x
, area_left
= 0;
21323 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21326 ALLOCATE_HDC (hdc
, f
);
21328 /* Let's rather be paranoid than getting a SEGV. */
21329 end
= min (end
, row
->used
[area
]);
21330 start
= max (0, start
);
21331 start
= min (end
, start
);
21333 /* Translate X to frame coordinates. Set last_x to the right
21334 end of the drawing area. */
21335 if (row
->full_width_p
)
21337 /* X is relative to the left edge of W, without scroll bars
21339 area_left
= WINDOW_LEFT_EDGE_X (w
);
21340 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21344 area_left
= window_box_left (w
, area
);
21345 last_x
= area_left
+ window_box_width (w
, area
);
21349 /* Build a doubly-linked list of glyph_string structures between
21350 head and tail from what we have to draw. Note that the macro
21351 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21352 the reason we use a separate variable `i'. */
21354 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21356 x_reached
= tail
->x
+ tail
->background_width
;
21360 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21361 the row, redraw some glyphs in front or following the glyph
21362 strings built above. */
21363 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21365 struct glyph_string
*h
, *t
;
21366 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21367 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21368 int check_mouse_face
= 0;
21371 /* If mouse highlighting is on, we may need to draw adjacent
21372 glyphs using mouse-face highlighting. */
21373 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21375 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21377 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21378 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21380 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21382 check_mouse_face
= 1;
21383 mouse_beg_col
= (row
== mouse_beg_row
)
21384 ? hlinfo
->mouse_face_beg_col
: 0;
21385 mouse_end_col
= (row
== mouse_end_row
)
21386 ? hlinfo
->mouse_face_end_col
21387 : row
->used
[TEXT_AREA
];
21391 /* Compute overhangs for all glyph strings. */
21392 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21393 for (s
= head
; s
; s
= s
->next
)
21394 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21396 /* Prepend glyph strings for glyphs in front of the first glyph
21397 string that are overwritten because of the first glyph
21398 string's left overhang. The background of all strings
21399 prepended must be drawn because the first glyph string
21401 i
= left_overwritten (head
);
21404 enum draw_glyphs_face overlap_hl
;
21406 /* If this row contains mouse highlighting, attempt to draw
21407 the overlapped glyphs with the correct highlight. This
21408 code fails if the overlap encompasses more than one glyph
21409 and mouse-highlight spans only some of these glyphs.
21410 However, making it work perfectly involves a lot more
21411 code, and I don't know if the pathological case occurs in
21412 practice, so we'll stick to this for now. --- cyd */
21413 if (check_mouse_face
21414 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21415 overlap_hl
= DRAW_MOUSE_FACE
;
21417 overlap_hl
= DRAW_NORMAL_TEXT
;
21420 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21421 overlap_hl
, dummy_x
, last_x
);
21423 compute_overhangs_and_x (t
, head
->x
, 1);
21424 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21428 /* Prepend glyph strings for glyphs in front of the first glyph
21429 string that overwrite that glyph string because of their
21430 right overhang. For these strings, only the foreground must
21431 be drawn, because it draws over the glyph string at `head'.
21432 The background must not be drawn because this would overwrite
21433 right overhangs of preceding glyphs for which no glyph
21435 i
= left_overwriting (head
);
21438 enum draw_glyphs_face overlap_hl
;
21440 if (check_mouse_face
21441 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21442 overlap_hl
= DRAW_MOUSE_FACE
;
21444 overlap_hl
= DRAW_NORMAL_TEXT
;
21447 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21448 overlap_hl
, dummy_x
, last_x
);
21449 for (s
= h
; s
; s
= s
->next
)
21450 s
->background_filled_p
= 1;
21451 compute_overhangs_and_x (t
, head
->x
, 1);
21452 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21455 /* Append glyphs strings for glyphs following the last glyph
21456 string tail that are overwritten by tail. The background of
21457 these strings has to be drawn because tail's foreground draws
21459 i
= right_overwritten (tail
);
21462 enum draw_glyphs_face overlap_hl
;
21464 if (check_mouse_face
21465 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21466 overlap_hl
= DRAW_MOUSE_FACE
;
21468 overlap_hl
= DRAW_NORMAL_TEXT
;
21470 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21471 overlap_hl
, x
, last_x
);
21472 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21473 we don't have `end = i;' here. */
21474 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21475 append_glyph_string_lists (&head
, &tail
, h
, t
);
21479 /* Append glyph strings for glyphs following the last glyph
21480 string tail that overwrite tail. The foreground of such
21481 glyphs has to be drawn because it writes into the background
21482 of tail. The background must not be drawn because it could
21483 paint over the foreground of following glyphs. */
21484 i
= right_overwriting (tail
);
21487 enum draw_glyphs_face overlap_hl
;
21488 if (check_mouse_face
21489 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21490 overlap_hl
= DRAW_MOUSE_FACE
;
21492 overlap_hl
= DRAW_NORMAL_TEXT
;
21495 i
++; /* We must include the Ith glyph. */
21496 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21497 overlap_hl
, x
, last_x
);
21498 for (s
= h
; s
; s
= s
->next
)
21499 s
->background_filled_p
= 1;
21500 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21501 append_glyph_string_lists (&head
, &tail
, h
, t
);
21503 if (clip_head
|| clip_tail
)
21504 for (s
= head
; s
; s
= s
->next
)
21506 s
->clip_head
= clip_head
;
21507 s
->clip_tail
= clip_tail
;
21511 /* Draw all strings. */
21512 for (s
= head
; s
; s
= s
->next
)
21513 FRAME_RIF (f
)->draw_glyph_string (s
);
21516 /* When focus a sole frame and move horizontally, this sets on_p to 0
21517 causing a failure to erase prev cursor position. */
21518 if (area
== TEXT_AREA
21519 && !row
->full_width_p
21520 /* When drawing overlapping rows, only the glyph strings'
21521 foreground is drawn, which doesn't erase a cursor
21525 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21526 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21527 : (tail
? tail
->x
+ tail
->background_width
: x
));
21531 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21532 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21536 /* Value is the x-position up to which drawn, relative to AREA of W.
21537 This doesn't include parts drawn because of overhangs. */
21538 if (row
->full_width_p
)
21539 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21541 x_reached
-= area_left
;
21543 RELEASE_HDC (hdc
, f
);
21548 /* Expand row matrix if too narrow. Don't expand if area
21551 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21553 if (!fonts_changed_p \
21554 && (it->glyph_row->glyphs[area] \
21555 < it->glyph_row->glyphs[area + 1])) \
21557 it->w->ncols_scale_factor++; \
21558 fonts_changed_p = 1; \
21562 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21563 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21566 append_glyph (struct it
*it
)
21568 struct glyph
*glyph
;
21569 enum glyph_row_area area
= it
->area
;
21571 xassert (it
->glyph_row
);
21572 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21574 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21575 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21577 /* If the glyph row is reversed, we need to prepend the glyph
21578 rather than append it. */
21579 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21583 /* Make room for the additional glyph. */
21584 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21586 glyph
= it
->glyph_row
->glyphs
[area
];
21588 glyph
->charpos
= CHARPOS (it
->position
);
21589 glyph
->object
= it
->object
;
21590 if (it
->pixel_width
> 0)
21592 glyph
->pixel_width
= it
->pixel_width
;
21593 glyph
->padding_p
= 0;
21597 /* Assure at least 1-pixel width. Otherwise, cursor can't
21598 be displayed correctly. */
21599 glyph
->pixel_width
= 1;
21600 glyph
->padding_p
= 1;
21602 glyph
->ascent
= it
->ascent
;
21603 glyph
->descent
= it
->descent
;
21604 glyph
->voffset
= it
->voffset
;
21605 glyph
->type
= CHAR_GLYPH
;
21606 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21607 glyph
->multibyte_p
= it
->multibyte_p
;
21608 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21609 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21610 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21611 || it
->phys_descent
> it
->descent
);
21612 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21613 glyph
->face_id
= it
->face_id
;
21614 glyph
->u
.ch
= it
->char_to_display
;
21615 glyph
->slice
.img
= null_glyph_slice
;
21616 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21619 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21620 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21622 glyph
->bidi_type
= it
->bidi_it
.type
;
21626 glyph
->resolved_level
= 0;
21627 glyph
->bidi_type
= UNKNOWN_BT
;
21629 ++it
->glyph_row
->used
[area
];
21632 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21635 /* Store one glyph for the composition IT->cmp_it.id in
21636 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21640 append_composite_glyph (struct it
*it
)
21642 struct glyph
*glyph
;
21643 enum glyph_row_area area
= it
->area
;
21645 xassert (it
->glyph_row
);
21647 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21648 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21650 /* If the glyph row is reversed, we need to prepend the glyph
21651 rather than append it. */
21652 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21656 /* Make room for the new glyph. */
21657 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21659 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21661 glyph
->charpos
= it
->cmp_it
.charpos
;
21662 glyph
->object
= it
->object
;
21663 glyph
->pixel_width
= it
->pixel_width
;
21664 glyph
->ascent
= it
->ascent
;
21665 glyph
->descent
= it
->descent
;
21666 glyph
->voffset
= it
->voffset
;
21667 glyph
->type
= COMPOSITE_GLYPH
;
21668 if (it
->cmp_it
.ch
< 0)
21670 glyph
->u
.cmp
.automatic
= 0;
21671 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21672 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21676 glyph
->u
.cmp
.automatic
= 1;
21677 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21678 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21679 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21681 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21682 glyph
->multibyte_p
= it
->multibyte_p
;
21683 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21684 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21685 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21686 || it
->phys_descent
> it
->descent
);
21687 glyph
->padding_p
= 0;
21688 glyph
->glyph_not_available_p
= 0;
21689 glyph
->face_id
= it
->face_id
;
21690 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21693 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21694 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21696 glyph
->bidi_type
= it
->bidi_it
.type
;
21698 ++it
->glyph_row
->used
[area
];
21701 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21705 /* Change IT->ascent and IT->height according to the setting of
21709 take_vertical_position_into_account (struct it
*it
)
21713 if (it
->voffset
< 0)
21714 /* Increase the ascent so that we can display the text higher
21716 it
->ascent
-= it
->voffset
;
21718 /* Increase the descent so that we can display the text lower
21720 it
->descent
+= it
->voffset
;
21725 /* Produce glyphs/get display metrics for the image IT is loaded with.
21726 See the description of struct display_iterator in dispextern.h for
21727 an overview of struct display_iterator. */
21730 produce_image_glyph (struct it
*it
)
21734 int glyph_ascent
, crop
;
21735 struct glyph_slice slice
;
21737 xassert (it
->what
== IT_IMAGE
);
21739 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21741 /* Make sure X resources of the face is loaded. */
21742 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21744 if (it
->image_id
< 0)
21746 /* Fringe bitmap. */
21747 it
->ascent
= it
->phys_ascent
= 0;
21748 it
->descent
= it
->phys_descent
= 0;
21749 it
->pixel_width
= 0;
21754 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21756 /* Make sure X resources of the image is loaded. */
21757 prepare_image_for_display (it
->f
, img
);
21759 slice
.x
= slice
.y
= 0;
21760 slice
.width
= img
->width
;
21761 slice
.height
= img
->height
;
21763 if (INTEGERP (it
->slice
.x
))
21764 slice
.x
= XINT (it
->slice
.x
);
21765 else if (FLOATP (it
->slice
.x
))
21766 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21768 if (INTEGERP (it
->slice
.y
))
21769 slice
.y
= XINT (it
->slice
.y
);
21770 else if (FLOATP (it
->slice
.y
))
21771 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21773 if (INTEGERP (it
->slice
.width
))
21774 slice
.width
= XINT (it
->slice
.width
);
21775 else if (FLOATP (it
->slice
.width
))
21776 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21778 if (INTEGERP (it
->slice
.height
))
21779 slice
.height
= XINT (it
->slice
.height
);
21780 else if (FLOATP (it
->slice
.height
))
21781 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21783 if (slice
.x
>= img
->width
)
21784 slice
.x
= img
->width
;
21785 if (slice
.y
>= img
->height
)
21786 slice
.y
= img
->height
;
21787 if (slice
.x
+ slice
.width
>= img
->width
)
21788 slice
.width
= img
->width
- slice
.x
;
21789 if (slice
.y
+ slice
.height
> img
->height
)
21790 slice
.height
= img
->height
- slice
.y
;
21792 if (slice
.width
== 0 || slice
.height
== 0)
21795 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21797 it
->descent
= slice
.height
- glyph_ascent
;
21799 it
->descent
+= img
->vmargin
;
21800 if (slice
.y
+ slice
.height
== img
->height
)
21801 it
->descent
+= img
->vmargin
;
21802 it
->phys_descent
= it
->descent
;
21804 it
->pixel_width
= slice
.width
;
21806 it
->pixel_width
+= img
->hmargin
;
21807 if (slice
.x
+ slice
.width
== img
->width
)
21808 it
->pixel_width
+= img
->hmargin
;
21810 /* It's quite possible for images to have an ascent greater than
21811 their height, so don't get confused in that case. */
21812 if (it
->descent
< 0)
21817 if (face
->box
!= FACE_NO_BOX
)
21819 if (face
->box_line_width
> 0)
21822 it
->ascent
+= face
->box_line_width
;
21823 if (slice
.y
+ slice
.height
== img
->height
)
21824 it
->descent
+= face
->box_line_width
;
21827 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21828 it
->pixel_width
+= eabs (face
->box_line_width
);
21829 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21830 it
->pixel_width
+= eabs (face
->box_line_width
);
21833 take_vertical_position_into_account (it
);
21835 /* Automatically crop wide image glyphs at right edge so we can
21836 draw the cursor on same display row. */
21837 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21838 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21840 it
->pixel_width
-= crop
;
21841 slice
.width
-= crop
;
21846 struct glyph
*glyph
;
21847 enum glyph_row_area area
= it
->area
;
21849 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21850 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21852 glyph
->charpos
= CHARPOS (it
->position
);
21853 glyph
->object
= it
->object
;
21854 glyph
->pixel_width
= it
->pixel_width
;
21855 glyph
->ascent
= glyph_ascent
;
21856 glyph
->descent
= it
->descent
;
21857 glyph
->voffset
= it
->voffset
;
21858 glyph
->type
= IMAGE_GLYPH
;
21859 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21860 glyph
->multibyte_p
= it
->multibyte_p
;
21861 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21862 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21863 glyph
->overlaps_vertically_p
= 0;
21864 glyph
->padding_p
= 0;
21865 glyph
->glyph_not_available_p
= 0;
21866 glyph
->face_id
= it
->face_id
;
21867 glyph
->u
.img_id
= img
->id
;
21868 glyph
->slice
.img
= slice
;
21869 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21872 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21873 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21875 glyph
->bidi_type
= it
->bidi_it
.type
;
21877 ++it
->glyph_row
->used
[area
];
21880 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21885 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21886 of the glyph, WIDTH and HEIGHT are the width and height of the
21887 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21890 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21891 int width
, int height
, int ascent
)
21893 struct glyph
*glyph
;
21894 enum glyph_row_area area
= it
->area
;
21896 xassert (ascent
>= 0 && ascent
<= height
);
21898 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21899 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21901 /* If the glyph row is reversed, we need to prepend the glyph
21902 rather than append it. */
21903 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21907 /* Make room for the additional glyph. */
21908 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21910 glyph
= it
->glyph_row
->glyphs
[area
];
21912 glyph
->charpos
= CHARPOS (it
->position
);
21913 glyph
->object
= object
;
21914 glyph
->pixel_width
= width
;
21915 glyph
->ascent
= ascent
;
21916 glyph
->descent
= height
- ascent
;
21917 glyph
->voffset
= it
->voffset
;
21918 glyph
->type
= STRETCH_GLYPH
;
21919 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21920 glyph
->multibyte_p
= it
->multibyte_p
;
21921 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21922 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21923 glyph
->overlaps_vertically_p
= 0;
21924 glyph
->padding_p
= 0;
21925 glyph
->glyph_not_available_p
= 0;
21926 glyph
->face_id
= it
->face_id
;
21927 glyph
->u
.stretch
.ascent
= ascent
;
21928 glyph
->u
.stretch
.height
= height
;
21929 glyph
->slice
.img
= null_glyph_slice
;
21930 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21933 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21934 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21936 glyph
->bidi_type
= it
->bidi_it
.type
;
21940 glyph
->resolved_level
= 0;
21941 glyph
->bidi_type
= UNKNOWN_BT
;
21943 ++it
->glyph_row
->used
[area
];
21946 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21950 /* Produce a stretch glyph for iterator IT. IT->object is the value
21951 of the glyph property displayed. The value must be a list
21952 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21955 1. `:width WIDTH' specifies that the space should be WIDTH *
21956 canonical char width wide. WIDTH may be an integer or floating
21959 2. `:relative-width FACTOR' specifies that the width of the stretch
21960 should be computed from the width of the first character having the
21961 `glyph' property, and should be FACTOR times that width.
21963 3. `:align-to HPOS' specifies that the space should be wide enough
21964 to reach HPOS, a value in canonical character units.
21966 Exactly one of the above pairs must be present.
21968 4. `:height HEIGHT' specifies that the height of the stretch produced
21969 should be HEIGHT, measured in canonical character units.
21971 5. `:relative-height FACTOR' specifies that the height of the
21972 stretch should be FACTOR times the height of the characters having
21973 the glyph property.
21975 Either none or exactly one of 4 or 5 must be present.
21977 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21978 of the stretch should be used for the ascent of the stretch.
21979 ASCENT must be in the range 0 <= ASCENT <= 100. */
21982 produce_stretch_glyph (struct it
*it
)
21984 /* (space :width WIDTH :height HEIGHT ...) */
21985 Lisp_Object prop
, plist
;
21986 int width
= 0, height
= 0, align_to
= -1;
21987 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21990 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21991 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21993 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21995 /* List should start with `space'. */
21996 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21997 plist
= XCDR (it
->object
);
21999 /* Compute the width of the stretch. */
22000 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22001 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22003 /* Absolute width `:width WIDTH' specified and valid. */
22004 zero_width_ok_p
= 1;
22007 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22010 /* Relative width `:relative-width FACTOR' specified and valid.
22011 Compute the width of the characters having the `glyph'
22014 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22017 if (it
->multibyte_p
)
22018 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22021 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22022 if (! ASCII_CHAR_P (it2
.c
))
22023 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22026 it2
.glyph_row
= NULL
;
22027 it2
.what
= IT_CHARACTER
;
22028 x_produce_glyphs (&it2
);
22029 width
= NUMVAL (prop
) * it2
.pixel_width
;
22031 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22032 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22034 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22035 align_to
= (align_to
< 0
22037 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22038 else if (align_to
< 0)
22039 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22040 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22041 zero_width_ok_p
= 1;
22044 /* Nothing specified -> width defaults to canonical char width. */
22045 width
= FRAME_COLUMN_WIDTH (it
->f
);
22047 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22050 /* Compute height. */
22051 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22052 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22055 zero_height_ok_p
= 1;
22057 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22059 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22061 height
= FONT_HEIGHT (font
);
22063 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22066 /* Compute percentage of height used for ascent. If
22067 `:ascent ASCENT' is present and valid, use that. Otherwise,
22068 derive the ascent from the font in use. */
22069 if (prop
= Fplist_get (plist
, QCascent
),
22070 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22071 ascent
= height
* NUMVAL (prop
) / 100.0;
22072 else if (!NILP (prop
)
22073 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22074 ascent
= min (max (0, (int)tem
), height
);
22076 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22078 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22079 && it
->current_x
+ width
> it
->last_visible_x
)
22080 width
= it
->last_visible_x
- it
->current_x
- 1;
22082 if (width
> 0 && height
> 0 && it
->glyph_row
)
22084 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22085 if (!STRINGP (object
))
22086 object
= it
->w
->buffer
;
22087 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22090 it
->pixel_width
= width
;
22091 it
->ascent
= it
->phys_ascent
= ascent
;
22092 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22093 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22095 take_vertical_position_into_account (it
);
22098 /* Calculate line-height and line-spacing properties.
22099 An integer value specifies explicit pixel value.
22100 A float value specifies relative value to current face height.
22101 A cons (float . face-name) specifies relative value to
22102 height of specified face font.
22104 Returns height in pixels, or nil. */
22108 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22109 int boff
, int override
)
22111 Lisp_Object face_name
= Qnil
;
22112 int ascent
, descent
, height
;
22114 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22119 face_name
= XCAR (val
);
22121 if (!NUMBERP (val
))
22122 val
= make_number (1);
22123 if (NILP (face_name
))
22125 height
= it
->ascent
+ it
->descent
;
22130 if (NILP (face_name
))
22132 font
= FRAME_FONT (it
->f
);
22133 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22135 else if (EQ (face_name
, Qt
))
22144 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22146 return make_number (-1);
22148 face
= FACE_FROM_ID (it
->f
, face_id
);
22151 return make_number (-1);
22152 boff
= font
->baseline_offset
;
22153 if (font
->vertical_centering
)
22154 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22157 ascent
= FONT_BASE (font
) + boff
;
22158 descent
= FONT_DESCENT (font
) - boff
;
22162 it
->override_ascent
= ascent
;
22163 it
->override_descent
= descent
;
22164 it
->override_boff
= boff
;
22167 height
= ascent
+ descent
;
22171 height
= (int)(XFLOAT_DATA (val
) * height
);
22172 else if (INTEGERP (val
))
22173 height
*= XINT (val
);
22175 return make_number (height
);
22179 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22180 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22181 and only if this is for a character for which no font was found.
22183 If the display method (it->glyphless_method) is
22184 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22185 length of the acronym or the hexadecimal string, UPPER_XOFF and
22186 UPPER_YOFF are pixel offsets for the upper part of the string,
22187 LOWER_XOFF and LOWER_YOFF are for the lower part.
22189 For the other display methods, LEN through LOWER_YOFF are zero. */
22192 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22193 short upper_xoff
, short upper_yoff
,
22194 short lower_xoff
, short lower_yoff
)
22196 struct glyph
*glyph
;
22197 enum glyph_row_area area
= it
->area
;
22199 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22200 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22202 /* If the glyph row is reversed, we need to prepend the glyph
22203 rather than append it. */
22204 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22208 /* Make room for the additional glyph. */
22209 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22211 glyph
= it
->glyph_row
->glyphs
[area
];
22213 glyph
->charpos
= CHARPOS (it
->position
);
22214 glyph
->object
= it
->object
;
22215 glyph
->pixel_width
= it
->pixel_width
;
22216 glyph
->ascent
= it
->ascent
;
22217 glyph
->descent
= it
->descent
;
22218 glyph
->voffset
= it
->voffset
;
22219 glyph
->type
= GLYPHLESS_GLYPH
;
22220 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22221 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22222 glyph
->u
.glyphless
.len
= len
;
22223 glyph
->u
.glyphless
.ch
= it
->c
;
22224 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22225 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22226 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22227 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22228 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22229 glyph
->multibyte_p
= it
->multibyte_p
;
22230 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22231 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22232 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22233 || it
->phys_descent
> it
->descent
);
22234 glyph
->padding_p
= 0;
22235 glyph
->glyph_not_available_p
= 0;
22236 glyph
->face_id
= face_id
;
22237 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22240 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22241 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22243 glyph
->bidi_type
= it
->bidi_it
.type
;
22245 ++it
->glyph_row
->used
[area
];
22248 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22252 /* Produce a glyph for a glyphless character for iterator IT.
22253 IT->glyphless_method specifies which method to use for displaying
22254 the character. See the description of enum
22255 glyphless_display_method in dispextern.h for the detail.
22257 FOR_NO_FONT is nonzero if and only if this is for a character for
22258 which no font was found. ACRONYM, if non-nil, is an acronym string
22259 for the character. */
22262 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22267 int base_width
, base_height
, width
, height
;
22268 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22271 /* Get the metrics of the base font. We always refer to the current
22273 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22274 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22275 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22276 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22277 base_height
= it
->ascent
+ it
->descent
;
22278 base_width
= font
->average_width
;
22280 /* Get a face ID for the glyph by utilizing a cache (the same way as
22281 doen for `escape-glyph' in get_next_display_element). */
22282 if (it
->f
== last_glyphless_glyph_frame
22283 && it
->face_id
== last_glyphless_glyph_face_id
)
22285 face_id
= last_glyphless_glyph_merged_face_id
;
22289 /* Merge the `glyphless-char' face into the current face. */
22290 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22291 last_glyphless_glyph_frame
= it
->f
;
22292 last_glyphless_glyph_face_id
= it
->face_id
;
22293 last_glyphless_glyph_merged_face_id
= face_id
;
22296 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22298 it
->pixel_width
= THIN_SPACE_WIDTH
;
22300 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22302 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22304 width
= CHAR_WIDTH (it
->c
);
22307 else if (width
> 4)
22309 it
->pixel_width
= base_width
* width
;
22311 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22317 unsigned int code
[6];
22319 int ascent
, descent
;
22320 struct font_metrics metrics_upper
, metrics_lower
;
22322 face
= FACE_FROM_ID (it
->f
, face_id
);
22323 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22324 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22326 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22328 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22329 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22330 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22334 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22335 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22338 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22339 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22340 upper_len
= (len
+ 1) / 2;
22341 font
->driver
->text_extents (font
, code
, upper_len
,
22343 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22348 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22349 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22350 upper_xoff
= upper_yoff
= 2; /* the typical case */
22351 if (base_width
>= width
)
22353 /* Align the upper to the left, the lower to the right. */
22354 it
->pixel_width
= base_width
;
22355 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22359 /* Center the shorter one. */
22360 it
->pixel_width
= width
;
22361 if (metrics_upper
.width
>= metrics_lower
.width
)
22362 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22365 /* FIXME: This code doesn't look right. It formerly was
22366 missing the "lower_xoff = 0;", which couldn't have
22367 been right since it left lower_xoff uninitialized. */
22369 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22373 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22374 top, bottom, and between upper and lower strings. */
22375 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22376 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22377 /* Center vertically.
22378 H:base_height, D:base_descent
22379 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22381 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22382 descent = D - H/2 + h/2;
22383 lower_yoff = descent - 2 - ld;
22384 upper_yoff = lower_yoff - la - 1 - ud; */
22385 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22386 descent
= it
->descent
- (base_height
- height
) / 2;
22387 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22388 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22389 - metrics_upper
.descent
);
22390 /* Don't make the height shorter than the base height. */
22391 if (height
> base_height
)
22393 it
->ascent
= ascent
;
22394 it
->descent
= descent
;
22398 it
->phys_ascent
= it
->ascent
;
22399 it
->phys_descent
= it
->descent
;
22401 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22402 upper_xoff
, upper_yoff
,
22403 lower_xoff
, lower_yoff
);
22405 take_vertical_position_into_account (it
);
22410 Produce glyphs/get display metrics for the display element IT is
22411 loaded with. See the description of struct it in dispextern.h
22412 for an overview of struct it. */
22415 x_produce_glyphs (struct it
*it
)
22417 int extra_line_spacing
= it
->extra_line_spacing
;
22419 it
->glyph_not_available_p
= 0;
22421 if (it
->what
== IT_CHARACTER
)
22424 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22425 struct font
*font
= face
->font
;
22426 struct font_metrics
*pcm
= NULL
;
22427 int boff
; /* baseline offset */
22431 /* When no suitable font is found, display this character by
22432 the method specified in the first extra slot of
22433 Vglyphless_char_display. */
22434 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22436 xassert (it
->what
== IT_GLYPHLESS
);
22437 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22441 boff
= font
->baseline_offset
;
22442 if (font
->vertical_centering
)
22443 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22445 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22451 if (it
->override_ascent
>= 0)
22453 it
->ascent
= it
->override_ascent
;
22454 it
->descent
= it
->override_descent
;
22455 boff
= it
->override_boff
;
22459 it
->ascent
= FONT_BASE (font
) + boff
;
22460 it
->descent
= FONT_DESCENT (font
) - boff
;
22463 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22465 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22466 if (pcm
->width
== 0
22467 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22473 it
->phys_ascent
= pcm
->ascent
+ boff
;
22474 it
->phys_descent
= pcm
->descent
- boff
;
22475 it
->pixel_width
= pcm
->width
;
22479 it
->glyph_not_available_p
= 1;
22480 it
->phys_ascent
= it
->ascent
;
22481 it
->phys_descent
= it
->descent
;
22482 it
->pixel_width
= font
->space_width
;
22485 if (it
->constrain_row_ascent_descent_p
)
22487 if (it
->descent
> it
->max_descent
)
22489 it
->ascent
+= it
->descent
- it
->max_descent
;
22490 it
->descent
= it
->max_descent
;
22492 if (it
->ascent
> it
->max_ascent
)
22494 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22495 it
->ascent
= it
->max_ascent
;
22497 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22498 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22499 extra_line_spacing
= 0;
22502 /* If this is a space inside a region of text with
22503 `space-width' property, change its width. */
22504 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22506 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22508 /* If face has a box, add the box thickness to the character
22509 height. If character has a box line to the left and/or
22510 right, add the box line width to the character's width. */
22511 if (face
->box
!= FACE_NO_BOX
)
22513 int thick
= face
->box_line_width
;
22517 it
->ascent
+= thick
;
22518 it
->descent
+= thick
;
22523 if (it
->start_of_box_run_p
)
22524 it
->pixel_width
+= thick
;
22525 if (it
->end_of_box_run_p
)
22526 it
->pixel_width
+= thick
;
22529 /* If face has an overline, add the height of the overline
22530 (1 pixel) and a 1 pixel margin to the character height. */
22531 if (face
->overline_p
)
22532 it
->ascent
+= overline_margin
;
22534 if (it
->constrain_row_ascent_descent_p
)
22536 if (it
->ascent
> it
->max_ascent
)
22537 it
->ascent
= it
->max_ascent
;
22538 if (it
->descent
> it
->max_descent
)
22539 it
->descent
= it
->max_descent
;
22542 take_vertical_position_into_account (it
);
22544 /* If we have to actually produce glyphs, do it. */
22549 /* Translate a space with a `space-width' property
22550 into a stretch glyph. */
22551 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22552 / FONT_HEIGHT (font
));
22553 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22554 it
->ascent
+ it
->descent
, ascent
);
22559 /* If characters with lbearing or rbearing are displayed
22560 in this line, record that fact in a flag of the
22561 glyph row. This is used to optimize X output code. */
22562 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22563 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22565 if (! stretched_p
&& it
->pixel_width
== 0)
22566 /* We assure that all visible glyphs have at least 1-pixel
22568 it
->pixel_width
= 1;
22570 else if (it
->char_to_display
== '\n')
22572 /* A newline has no width, but we need the height of the
22573 line. But if previous part of the line sets a height,
22574 don't increase that height */
22576 Lisp_Object height
;
22577 Lisp_Object total_height
= Qnil
;
22579 it
->override_ascent
= -1;
22580 it
->pixel_width
= 0;
22583 height
= get_it_property (it
, Qline_height
);
22584 /* Split (line-height total-height) list */
22586 && CONSP (XCDR (height
))
22587 && NILP (XCDR (XCDR (height
))))
22589 total_height
= XCAR (XCDR (height
));
22590 height
= XCAR (height
);
22592 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22594 if (it
->override_ascent
>= 0)
22596 it
->ascent
= it
->override_ascent
;
22597 it
->descent
= it
->override_descent
;
22598 boff
= it
->override_boff
;
22602 it
->ascent
= FONT_BASE (font
) + boff
;
22603 it
->descent
= FONT_DESCENT (font
) - boff
;
22606 if (EQ (height
, Qt
))
22608 if (it
->descent
> it
->max_descent
)
22610 it
->ascent
+= it
->descent
- it
->max_descent
;
22611 it
->descent
= it
->max_descent
;
22613 if (it
->ascent
> it
->max_ascent
)
22615 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22616 it
->ascent
= it
->max_ascent
;
22618 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22619 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22620 it
->constrain_row_ascent_descent_p
= 1;
22621 extra_line_spacing
= 0;
22625 Lisp_Object spacing
;
22627 it
->phys_ascent
= it
->ascent
;
22628 it
->phys_descent
= it
->descent
;
22630 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22631 && face
->box
!= FACE_NO_BOX
22632 && face
->box_line_width
> 0)
22634 it
->ascent
+= face
->box_line_width
;
22635 it
->descent
+= face
->box_line_width
;
22638 && XINT (height
) > it
->ascent
+ it
->descent
)
22639 it
->ascent
= XINT (height
) - it
->descent
;
22641 if (!NILP (total_height
))
22642 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22645 spacing
= get_it_property (it
, Qline_spacing
);
22646 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22648 if (INTEGERP (spacing
))
22650 extra_line_spacing
= XINT (spacing
);
22651 if (!NILP (total_height
))
22652 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22656 else /* i.e. (it->char_to_display == '\t') */
22658 if (font
->space_width
> 0)
22660 int tab_width
= it
->tab_width
* font
->space_width
;
22661 int x
= it
->current_x
+ it
->continuation_lines_width
;
22662 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22664 /* If the distance from the current position to the next tab
22665 stop is less than a space character width, use the
22666 tab stop after that. */
22667 if (next_tab_x
- x
< font
->space_width
)
22668 next_tab_x
+= tab_width
;
22670 it
->pixel_width
= next_tab_x
- x
;
22672 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22673 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22677 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22678 it
->ascent
+ it
->descent
, it
->ascent
);
22683 it
->pixel_width
= 0;
22688 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22690 /* A static composition.
22692 Note: A composition is represented as one glyph in the
22693 glyph matrix. There are no padding glyphs.
22695 Important note: pixel_width, ascent, and descent are the
22696 values of what is drawn by draw_glyphs (i.e. the values of
22697 the overall glyphs composed). */
22698 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22699 int boff
; /* baseline offset */
22700 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22701 int glyph_len
= cmp
->glyph_len
;
22702 struct font
*font
= face
->font
;
22706 /* If we have not yet calculated pixel size data of glyphs of
22707 the composition for the current face font, calculate them
22708 now. Theoretically, we have to check all fonts for the
22709 glyphs, but that requires much time and memory space. So,
22710 here we check only the font of the first glyph. This may
22711 lead to incorrect display, but it's very rare, and C-l
22712 (recenter-top-bottom) can correct the display anyway. */
22713 if (! cmp
->font
|| cmp
->font
!= font
)
22715 /* Ascent and descent of the font of the first character
22716 of this composition (adjusted by baseline offset).
22717 Ascent and descent of overall glyphs should not be less
22718 than these, respectively. */
22719 int font_ascent
, font_descent
, font_height
;
22720 /* Bounding box of the overall glyphs. */
22721 int leftmost
, rightmost
, lowest
, highest
;
22722 int lbearing
, rbearing
;
22723 int i
, width
, ascent
, descent
;
22724 int left_padded
= 0, right_padded
= 0;
22727 struct font_metrics
*pcm
;
22728 int font_not_found_p
;
22731 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22732 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22734 if (glyph_len
< cmp
->glyph_len
)
22736 for (i
= 0; i
< glyph_len
; i
++)
22738 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22740 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22745 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22746 : IT_CHARPOS (*it
));
22747 /* If no suitable font is found, use the default font. */
22748 font_not_found_p
= font
== NULL
;
22749 if (font_not_found_p
)
22751 face
= face
->ascii_face
;
22754 boff
= font
->baseline_offset
;
22755 if (font
->vertical_centering
)
22756 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22757 font_ascent
= FONT_BASE (font
) + boff
;
22758 font_descent
= FONT_DESCENT (font
) - boff
;
22759 font_height
= FONT_HEIGHT (font
);
22761 cmp
->font
= (void *) font
;
22764 if (! font_not_found_p
)
22766 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22767 &char2b
, it
->multibyte_p
, 0);
22768 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22771 /* Initialize the bounding box. */
22774 width
= pcm
->width
;
22775 ascent
= pcm
->ascent
;
22776 descent
= pcm
->descent
;
22777 lbearing
= pcm
->lbearing
;
22778 rbearing
= pcm
->rbearing
;
22782 width
= font
->space_width
;
22783 ascent
= FONT_BASE (font
);
22784 descent
= FONT_DESCENT (font
);
22791 lowest
= - descent
+ boff
;
22792 highest
= ascent
+ boff
;
22794 if (! font_not_found_p
22795 && font
->default_ascent
22796 && CHAR_TABLE_P (Vuse_default_ascent
)
22797 && !NILP (Faref (Vuse_default_ascent
,
22798 make_number (it
->char_to_display
))))
22799 highest
= font
->default_ascent
+ boff
;
22801 /* Draw the first glyph at the normal position. It may be
22802 shifted to right later if some other glyphs are drawn
22804 cmp
->offsets
[i
* 2] = 0;
22805 cmp
->offsets
[i
* 2 + 1] = boff
;
22806 cmp
->lbearing
= lbearing
;
22807 cmp
->rbearing
= rbearing
;
22809 /* Set cmp->offsets for the remaining glyphs. */
22810 for (i
++; i
< glyph_len
; i
++)
22812 int left
, right
, btm
, top
;
22813 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22815 struct face
*this_face
;
22820 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22821 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22822 font
= this_face
->font
;
22828 this_boff
= font
->baseline_offset
;
22829 if (font
->vertical_centering
)
22830 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22831 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22832 &char2b
, it
->multibyte_p
, 0);
22833 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22836 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22839 width
= pcm
->width
;
22840 ascent
= pcm
->ascent
;
22841 descent
= pcm
->descent
;
22842 lbearing
= pcm
->lbearing
;
22843 rbearing
= pcm
->rbearing
;
22844 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22846 /* Relative composition with or without
22847 alternate chars. */
22848 left
= (leftmost
+ rightmost
- width
) / 2;
22849 btm
= - descent
+ boff
;
22850 if (font
->relative_compose
22851 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22852 || NILP (Faref (Vignore_relative_composition
,
22853 make_number (ch
)))))
22856 if (- descent
>= font
->relative_compose
)
22857 /* One extra pixel between two glyphs. */
22859 else if (ascent
<= 0)
22860 /* One extra pixel between two glyphs. */
22861 btm
= lowest
- 1 - ascent
- descent
;
22866 /* A composition rule is specified by an integer
22867 value that encodes global and new reference
22868 points (GREF and NREF). GREF and NREF are
22869 specified by numbers as below:
22871 0---1---2 -- ascent
22875 9--10--11 -- center
22877 ---3---4---5--- baseline
22879 6---7---8 -- descent
22881 int rule
= COMPOSITION_RULE (cmp
, i
);
22882 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22884 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22885 grefx
= gref
% 3, nrefx
= nref
% 3;
22886 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22888 xoff
= font_height
* (xoff
- 128) / 256;
22890 yoff
= font_height
* (yoff
- 128) / 256;
22893 + grefx
* (rightmost
- leftmost
) / 2
22894 - nrefx
* width
/ 2
22897 btm
= ((grefy
== 0 ? highest
22899 : grefy
== 2 ? lowest
22900 : (highest
+ lowest
) / 2)
22901 - (nrefy
== 0 ? ascent
+ descent
22902 : nrefy
== 1 ? descent
- boff
22904 : (ascent
+ descent
) / 2)
22908 cmp
->offsets
[i
* 2] = left
;
22909 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22911 /* Update the bounding box of the overall glyphs. */
22914 right
= left
+ width
;
22915 if (left
< leftmost
)
22917 if (right
> rightmost
)
22920 top
= btm
+ descent
+ ascent
;
22926 if (cmp
->lbearing
> left
+ lbearing
)
22927 cmp
->lbearing
= left
+ lbearing
;
22928 if (cmp
->rbearing
< left
+ rbearing
)
22929 cmp
->rbearing
= left
+ rbearing
;
22933 /* If there are glyphs whose x-offsets are negative,
22934 shift all glyphs to the right and make all x-offsets
22938 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22939 cmp
->offsets
[i
* 2] -= leftmost
;
22940 rightmost
-= leftmost
;
22941 cmp
->lbearing
-= leftmost
;
22942 cmp
->rbearing
-= leftmost
;
22945 if (left_padded
&& cmp
->lbearing
< 0)
22947 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22948 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22949 rightmost
-= cmp
->lbearing
;
22950 cmp
->rbearing
-= cmp
->lbearing
;
22953 if (right_padded
&& rightmost
< cmp
->rbearing
)
22955 rightmost
= cmp
->rbearing
;
22958 cmp
->pixel_width
= rightmost
;
22959 cmp
->ascent
= highest
;
22960 cmp
->descent
= - lowest
;
22961 if (cmp
->ascent
< font_ascent
)
22962 cmp
->ascent
= font_ascent
;
22963 if (cmp
->descent
< font_descent
)
22964 cmp
->descent
= font_descent
;
22968 && (cmp
->lbearing
< 0
22969 || cmp
->rbearing
> cmp
->pixel_width
))
22970 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22972 it
->pixel_width
= cmp
->pixel_width
;
22973 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22974 it
->descent
= it
->phys_descent
= cmp
->descent
;
22975 if (face
->box
!= FACE_NO_BOX
)
22977 int thick
= face
->box_line_width
;
22981 it
->ascent
+= thick
;
22982 it
->descent
+= thick
;
22987 if (it
->start_of_box_run_p
)
22988 it
->pixel_width
+= thick
;
22989 if (it
->end_of_box_run_p
)
22990 it
->pixel_width
+= thick
;
22993 /* If face has an overline, add the height of the overline
22994 (1 pixel) and a 1 pixel margin to the character height. */
22995 if (face
->overline_p
)
22996 it
->ascent
+= overline_margin
;
22998 take_vertical_position_into_account (it
);
22999 if (it
->ascent
< 0)
23001 if (it
->descent
< 0)
23005 append_composite_glyph (it
);
23007 else if (it
->what
== IT_COMPOSITION
)
23009 /* A dynamic (automatic) composition. */
23010 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23011 Lisp_Object gstring
;
23012 struct font_metrics metrics
;
23014 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23016 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23019 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23020 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23021 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23022 it
->descent
= it
->phys_descent
= metrics
.descent
;
23023 if (face
->box
!= FACE_NO_BOX
)
23025 int thick
= face
->box_line_width
;
23029 it
->ascent
+= thick
;
23030 it
->descent
+= thick
;
23035 if (it
->start_of_box_run_p
)
23036 it
->pixel_width
+= thick
;
23037 if (it
->end_of_box_run_p
)
23038 it
->pixel_width
+= thick
;
23040 /* If face has an overline, add the height of the overline
23041 (1 pixel) and a 1 pixel margin to the character height. */
23042 if (face
->overline_p
)
23043 it
->ascent
+= overline_margin
;
23044 take_vertical_position_into_account (it
);
23045 if (it
->ascent
< 0)
23047 if (it
->descent
< 0)
23051 append_composite_glyph (it
);
23053 else if (it
->what
== IT_GLYPHLESS
)
23054 produce_glyphless_glyph (it
, 0, Qnil
);
23055 else if (it
->what
== IT_IMAGE
)
23056 produce_image_glyph (it
);
23057 else if (it
->what
== IT_STRETCH
)
23058 produce_stretch_glyph (it
);
23061 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23062 because this isn't true for images with `:ascent 100'. */
23063 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23064 if (it
->area
== TEXT_AREA
)
23065 it
->current_x
+= it
->pixel_width
;
23067 if (extra_line_spacing
> 0)
23069 it
->descent
+= extra_line_spacing
;
23070 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23071 it
->max_extra_line_spacing
= extra_line_spacing
;
23074 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23075 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23076 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23077 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23081 Output LEN glyphs starting at START at the nominal cursor position.
23082 Advance the nominal cursor over the text. The global variable
23083 updated_window contains the window being updated, updated_row is
23084 the glyph row being updated, and updated_area is the area of that
23085 row being updated. */
23088 x_write_glyphs (struct glyph
*start
, int len
)
23092 xassert (updated_window
&& updated_row
);
23095 /* Write glyphs. */
23097 hpos
= start
- updated_row
->glyphs
[updated_area
];
23098 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23099 updated_row
, updated_area
,
23101 DRAW_NORMAL_TEXT
, 0);
23103 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23104 if (updated_area
== TEXT_AREA
23105 && updated_window
->phys_cursor_on_p
23106 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23107 && updated_window
->phys_cursor
.hpos
>= hpos
23108 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23109 updated_window
->phys_cursor_on_p
= 0;
23113 /* Advance the output cursor. */
23114 output_cursor
.hpos
+= len
;
23115 output_cursor
.x
= x
;
23120 Insert LEN glyphs from START at the nominal cursor position. */
23123 x_insert_glyphs (struct glyph
*start
, int len
)
23127 int line_height
, shift_by_width
, shifted_region_width
;
23128 struct glyph_row
*row
;
23129 struct glyph
*glyph
;
23130 int frame_x
, frame_y
;
23133 xassert (updated_window
&& updated_row
);
23135 w
= updated_window
;
23136 f
= XFRAME (WINDOW_FRAME (w
));
23138 /* Get the height of the line we are in. */
23140 line_height
= row
->height
;
23142 /* Get the width of the glyphs to insert. */
23143 shift_by_width
= 0;
23144 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23145 shift_by_width
+= glyph
->pixel_width
;
23147 /* Get the width of the region to shift right. */
23148 shifted_region_width
= (window_box_width (w
, updated_area
)
23153 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23154 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23156 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23157 line_height
, shift_by_width
);
23159 /* Write the glyphs. */
23160 hpos
= start
- row
->glyphs
[updated_area
];
23161 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23163 DRAW_NORMAL_TEXT
, 0);
23165 /* Advance the output cursor. */
23166 output_cursor
.hpos
+= len
;
23167 output_cursor
.x
+= shift_by_width
;
23173 Erase the current text line from the nominal cursor position
23174 (inclusive) to pixel column TO_X (exclusive). The idea is that
23175 everything from TO_X onward is already erased.
23177 TO_X is a pixel position relative to updated_area of
23178 updated_window. TO_X == -1 means clear to the end of this area. */
23181 x_clear_end_of_line (int to_x
)
23184 struct window
*w
= updated_window
;
23185 int max_x
, min_y
, max_y
;
23186 int from_x
, from_y
, to_y
;
23188 xassert (updated_window
&& updated_row
);
23189 f
= XFRAME (w
->frame
);
23191 if (updated_row
->full_width_p
)
23192 max_x
= WINDOW_TOTAL_WIDTH (w
);
23194 max_x
= window_box_width (w
, updated_area
);
23195 max_y
= window_text_bottom_y (w
);
23197 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23198 of window. For TO_X > 0, truncate to end of drawing area. */
23204 to_x
= min (to_x
, max_x
);
23206 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23208 /* Notice if the cursor will be cleared by this operation. */
23209 if (!updated_row
->full_width_p
)
23210 notice_overwritten_cursor (w
, updated_area
,
23211 output_cursor
.x
, -1,
23213 MATRIX_ROW_BOTTOM_Y (updated_row
));
23215 from_x
= output_cursor
.x
;
23217 /* Translate to frame coordinates. */
23218 if (updated_row
->full_width_p
)
23220 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23221 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23225 int area_left
= window_box_left (w
, updated_area
);
23226 from_x
+= area_left
;
23230 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23231 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23232 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23234 /* Prevent inadvertently clearing to end of the X window. */
23235 if (to_x
> from_x
&& to_y
> from_y
)
23238 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23239 to_x
- from_x
, to_y
- from_y
);
23244 #endif /* HAVE_WINDOW_SYSTEM */
23248 /***********************************************************************
23250 ***********************************************************************/
23252 /* Value is the internal representation of the specified cursor type
23253 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23254 of the bar cursor. */
23256 static enum text_cursor_kinds
23257 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23259 enum text_cursor_kinds type
;
23264 if (EQ (arg
, Qbox
))
23265 return FILLED_BOX_CURSOR
;
23267 if (EQ (arg
, Qhollow
))
23268 return HOLLOW_BOX_CURSOR
;
23270 if (EQ (arg
, Qbar
))
23277 && EQ (XCAR (arg
), Qbar
)
23278 && INTEGERP (XCDR (arg
))
23279 && XINT (XCDR (arg
)) >= 0)
23281 *width
= XINT (XCDR (arg
));
23285 if (EQ (arg
, Qhbar
))
23288 return HBAR_CURSOR
;
23292 && EQ (XCAR (arg
), Qhbar
)
23293 && INTEGERP (XCDR (arg
))
23294 && XINT (XCDR (arg
)) >= 0)
23296 *width
= XINT (XCDR (arg
));
23297 return HBAR_CURSOR
;
23300 /* Treat anything unknown as "hollow box cursor".
23301 It was bad to signal an error; people have trouble fixing
23302 .Xdefaults with Emacs, when it has something bad in it. */
23303 type
= HOLLOW_BOX_CURSOR
;
23308 /* Set the default cursor types for specified frame. */
23310 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23315 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23316 FRAME_CURSOR_WIDTH (f
) = width
;
23318 /* By default, set up the blink-off state depending on the on-state. */
23320 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23323 FRAME_BLINK_OFF_CURSOR (f
)
23324 = get_specified_cursor_type (XCDR (tem
), &width
);
23325 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23328 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23332 #ifdef HAVE_WINDOW_SYSTEM
23334 /* Return the cursor we want to be displayed in window W. Return
23335 width of bar/hbar cursor through WIDTH arg. Return with
23336 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23337 (i.e. if the `system caret' should track this cursor).
23339 In a mini-buffer window, we want the cursor only to appear if we
23340 are reading input from this window. For the selected window, we
23341 want the cursor type given by the frame parameter or buffer local
23342 setting of cursor-type. If explicitly marked off, draw no cursor.
23343 In all other cases, we want a hollow box cursor. */
23345 static enum text_cursor_kinds
23346 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23347 int *active_cursor
)
23349 struct frame
*f
= XFRAME (w
->frame
);
23350 struct buffer
*b
= XBUFFER (w
->buffer
);
23351 int cursor_type
= DEFAULT_CURSOR
;
23352 Lisp_Object alt_cursor
;
23353 int non_selected
= 0;
23355 *active_cursor
= 1;
23358 if (cursor_in_echo_area
23359 && FRAME_HAS_MINIBUF_P (f
)
23360 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23362 if (w
== XWINDOW (echo_area_window
))
23364 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23366 *width
= FRAME_CURSOR_WIDTH (f
);
23367 return FRAME_DESIRED_CURSOR (f
);
23370 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23373 *active_cursor
= 0;
23377 /* Detect a nonselected window or nonselected frame. */
23378 else if (w
!= XWINDOW (f
->selected_window
)
23379 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23381 *active_cursor
= 0;
23383 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23389 /* Never display a cursor in a window in which cursor-type is nil. */
23390 if (NILP (BVAR (b
, cursor_type
)))
23393 /* Get the normal cursor type for this window. */
23394 if (EQ (BVAR (b
, cursor_type
), Qt
))
23396 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23397 *width
= FRAME_CURSOR_WIDTH (f
);
23400 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23402 /* Use cursor-in-non-selected-windows instead
23403 for non-selected window or frame. */
23406 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23407 if (!EQ (Qt
, alt_cursor
))
23408 return get_specified_cursor_type (alt_cursor
, width
);
23409 /* t means modify the normal cursor type. */
23410 if (cursor_type
== FILLED_BOX_CURSOR
)
23411 cursor_type
= HOLLOW_BOX_CURSOR
;
23412 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23414 return cursor_type
;
23417 /* Use normal cursor if not blinked off. */
23418 if (!w
->cursor_off_p
)
23420 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23422 if (cursor_type
== FILLED_BOX_CURSOR
)
23424 /* Using a block cursor on large images can be very annoying.
23425 So use a hollow cursor for "large" images.
23426 If image is not transparent (no mask), also use hollow cursor. */
23427 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23428 if (img
!= NULL
&& IMAGEP (img
->spec
))
23430 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23431 where N = size of default frame font size.
23432 This should cover most of the "tiny" icons people may use. */
23434 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23435 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23436 cursor_type
= HOLLOW_BOX_CURSOR
;
23439 else if (cursor_type
!= NO_CURSOR
)
23441 /* Display current only supports BOX and HOLLOW cursors for images.
23442 So for now, unconditionally use a HOLLOW cursor when cursor is
23443 not a solid box cursor. */
23444 cursor_type
= HOLLOW_BOX_CURSOR
;
23447 return cursor_type
;
23450 /* Cursor is blinked off, so determine how to "toggle" it. */
23452 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23453 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23454 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23456 /* Then see if frame has specified a specific blink off cursor type. */
23457 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23459 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23460 return FRAME_BLINK_OFF_CURSOR (f
);
23464 /* Some people liked having a permanently visible blinking cursor,
23465 while others had very strong opinions against it. So it was
23466 decided to remove it. KFS 2003-09-03 */
23468 /* Finally perform built-in cursor blinking:
23469 filled box <-> hollow box
23470 wide [h]bar <-> narrow [h]bar
23471 narrow [h]bar <-> no cursor
23472 other type <-> no cursor */
23474 if (cursor_type
== FILLED_BOX_CURSOR
)
23475 return HOLLOW_BOX_CURSOR
;
23477 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23480 return cursor_type
;
23488 /* Notice when the text cursor of window W has been completely
23489 overwritten by a drawing operation that outputs glyphs in AREA
23490 starting at X0 and ending at X1 in the line starting at Y0 and
23491 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23492 the rest of the line after X0 has been written. Y coordinates
23493 are window-relative. */
23496 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23497 int x0
, int x1
, int y0
, int y1
)
23499 int cx0
, cx1
, cy0
, cy1
;
23500 struct glyph_row
*row
;
23502 if (!w
->phys_cursor_on_p
)
23504 if (area
!= TEXT_AREA
)
23507 if (w
->phys_cursor
.vpos
< 0
23508 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23509 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23510 !(row
->enabled_p
&& row
->displays_text_p
)))
23513 if (row
->cursor_in_fringe_p
)
23515 row
->cursor_in_fringe_p
= 0;
23516 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23517 w
->phys_cursor_on_p
= 0;
23521 cx0
= w
->phys_cursor
.x
;
23522 cx1
= cx0
+ w
->phys_cursor_width
;
23523 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23526 /* The cursor image will be completely removed from the
23527 screen if the output area intersects the cursor area in
23528 y-direction. When we draw in [y0 y1[, and some part of
23529 the cursor is at y < y0, that part must have been drawn
23530 before. When scrolling, the cursor is erased before
23531 actually scrolling, so we don't come here. When not
23532 scrolling, the rows above the old cursor row must have
23533 changed, and in this case these rows must have written
23534 over the cursor image.
23536 Likewise if part of the cursor is below y1, with the
23537 exception of the cursor being in the first blank row at
23538 the buffer and window end because update_text_area
23539 doesn't draw that row. (Except when it does, but
23540 that's handled in update_text_area.) */
23542 cy0
= w
->phys_cursor
.y
;
23543 cy1
= cy0
+ w
->phys_cursor_height
;
23544 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23547 w
->phys_cursor_on_p
= 0;
23550 #endif /* HAVE_WINDOW_SYSTEM */
23553 /************************************************************************
23555 ************************************************************************/
23557 #ifdef HAVE_WINDOW_SYSTEM
23560 Fix the display of area AREA of overlapping row ROW in window W
23561 with respect to the overlapping part OVERLAPS. */
23564 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23565 enum glyph_row_area area
, int overlaps
)
23572 for (i
= 0; i
< row
->used
[area
];)
23574 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23576 int start
= i
, start_x
= x
;
23580 x
+= row
->glyphs
[area
][i
].pixel_width
;
23583 while (i
< row
->used
[area
]
23584 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23586 draw_glyphs (w
, start_x
, row
, area
,
23588 DRAW_NORMAL_TEXT
, overlaps
);
23592 x
+= row
->glyphs
[area
][i
].pixel_width
;
23602 Draw the cursor glyph of window W in glyph row ROW. See the
23603 comment of draw_glyphs for the meaning of HL. */
23606 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23607 enum draw_glyphs_face hl
)
23609 /* If cursor hpos is out of bounds, don't draw garbage. This can
23610 happen in mini-buffer windows when switching between echo area
23611 glyphs and mini-buffer. */
23612 if ((row
->reversed_p
23613 ? (w
->phys_cursor
.hpos
>= 0)
23614 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23616 int on_p
= w
->phys_cursor_on_p
;
23618 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23619 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23621 w
->phys_cursor_on_p
= on_p
;
23623 if (hl
== DRAW_CURSOR
)
23624 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23625 /* When we erase the cursor, and ROW is overlapped by other
23626 rows, make sure that these overlapping parts of other rows
23628 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23630 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23632 if (row
> w
->current_matrix
->rows
23633 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23634 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23635 OVERLAPS_ERASED_CURSOR
);
23637 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23638 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23639 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23640 OVERLAPS_ERASED_CURSOR
);
23647 Erase the image of a cursor of window W from the screen. */
23650 erase_phys_cursor (struct window
*w
)
23652 struct frame
*f
= XFRAME (w
->frame
);
23653 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23654 int hpos
= w
->phys_cursor
.hpos
;
23655 int vpos
= w
->phys_cursor
.vpos
;
23656 int mouse_face_here_p
= 0;
23657 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23658 struct glyph_row
*cursor_row
;
23659 struct glyph
*cursor_glyph
;
23660 enum draw_glyphs_face hl
;
23662 /* No cursor displayed or row invalidated => nothing to do on the
23664 if (w
->phys_cursor_type
== NO_CURSOR
)
23665 goto mark_cursor_off
;
23667 /* VPOS >= active_glyphs->nrows means that window has been resized.
23668 Don't bother to erase the cursor. */
23669 if (vpos
>= active_glyphs
->nrows
)
23670 goto mark_cursor_off
;
23672 /* If row containing cursor is marked invalid, there is nothing we
23674 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23675 if (!cursor_row
->enabled_p
)
23676 goto mark_cursor_off
;
23678 /* If line spacing is > 0, old cursor may only be partially visible in
23679 window after split-window. So adjust visible height. */
23680 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23681 window_text_bottom_y (w
) - cursor_row
->y
);
23683 /* If row is completely invisible, don't attempt to delete a cursor which
23684 isn't there. This can happen if cursor is at top of a window, and
23685 we switch to a buffer with a header line in that window. */
23686 if (cursor_row
->visible_height
<= 0)
23687 goto mark_cursor_off
;
23689 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23690 if (cursor_row
->cursor_in_fringe_p
)
23692 cursor_row
->cursor_in_fringe_p
= 0;
23693 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23694 goto mark_cursor_off
;
23697 /* This can happen when the new row is shorter than the old one.
23698 In this case, either draw_glyphs or clear_end_of_line
23699 should have cleared the cursor. Note that we wouldn't be
23700 able to erase the cursor in this case because we don't have a
23701 cursor glyph at hand. */
23702 if ((cursor_row
->reversed_p
23703 ? (w
->phys_cursor
.hpos
< 0)
23704 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23705 goto mark_cursor_off
;
23707 /* If the cursor is in the mouse face area, redisplay that when
23708 we clear the cursor. */
23709 if (! NILP (hlinfo
->mouse_face_window
)
23710 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23711 /* Don't redraw the cursor's spot in mouse face if it is at the
23712 end of a line (on a newline). The cursor appears there, but
23713 mouse highlighting does not. */
23714 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23715 mouse_face_here_p
= 1;
23717 /* Maybe clear the display under the cursor. */
23718 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23721 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23724 cursor_glyph
= get_phys_cursor_glyph (w
);
23725 if (cursor_glyph
== NULL
)
23726 goto mark_cursor_off
;
23728 width
= cursor_glyph
->pixel_width
;
23729 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23730 x
= w
->phys_cursor
.x
;
23732 width
-= left_x
- x
;
23733 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23734 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23735 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23738 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23741 /* Erase the cursor by redrawing the character underneath it. */
23742 if (mouse_face_here_p
)
23743 hl
= DRAW_MOUSE_FACE
;
23745 hl
= DRAW_NORMAL_TEXT
;
23746 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23749 w
->phys_cursor_on_p
= 0;
23750 w
->phys_cursor_type
= NO_CURSOR
;
23755 Display or clear cursor of window W. If ON is zero, clear the
23756 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23757 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23760 display_and_set_cursor (struct window
*w
, int on
,
23761 int hpos
, int vpos
, int x
, int y
)
23763 struct frame
*f
= XFRAME (w
->frame
);
23764 int new_cursor_type
;
23765 int new_cursor_width
;
23767 struct glyph_row
*glyph_row
;
23768 struct glyph
*glyph
;
23770 /* This is pointless on invisible frames, and dangerous on garbaged
23771 windows and frames; in the latter case, the frame or window may
23772 be in the midst of changing its size, and x and y may be off the
23774 if (! FRAME_VISIBLE_P (f
)
23775 || FRAME_GARBAGED_P (f
)
23776 || vpos
>= w
->current_matrix
->nrows
23777 || hpos
>= w
->current_matrix
->matrix_w
)
23780 /* If cursor is off and we want it off, return quickly. */
23781 if (!on
&& !w
->phys_cursor_on_p
)
23784 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23785 /* If cursor row is not enabled, we don't really know where to
23786 display the cursor. */
23787 if (!glyph_row
->enabled_p
)
23789 w
->phys_cursor_on_p
= 0;
23794 if (!glyph_row
->exact_window_width_line_p
23795 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23796 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23798 xassert (interrupt_input_blocked
);
23800 /* Set new_cursor_type to the cursor we want to be displayed. */
23801 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23802 &new_cursor_width
, &active_cursor
);
23804 /* If cursor is currently being shown and we don't want it to be or
23805 it is in the wrong place, or the cursor type is not what we want,
23807 if (w
->phys_cursor_on_p
23809 || w
->phys_cursor
.x
!= x
23810 || w
->phys_cursor
.y
!= y
23811 || new_cursor_type
!= w
->phys_cursor_type
23812 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23813 && new_cursor_width
!= w
->phys_cursor_width
)))
23814 erase_phys_cursor (w
);
23816 /* Don't check phys_cursor_on_p here because that flag is only set
23817 to zero in some cases where we know that the cursor has been
23818 completely erased, to avoid the extra work of erasing the cursor
23819 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23820 still not be visible, or it has only been partly erased. */
23823 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23824 w
->phys_cursor_height
= glyph_row
->height
;
23826 /* Set phys_cursor_.* before x_draw_.* is called because some
23827 of them may need the information. */
23828 w
->phys_cursor
.x
= x
;
23829 w
->phys_cursor
.y
= glyph_row
->y
;
23830 w
->phys_cursor
.hpos
= hpos
;
23831 w
->phys_cursor
.vpos
= vpos
;
23834 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23835 new_cursor_type
, new_cursor_width
,
23836 on
, active_cursor
);
23840 /* Switch the display of W's cursor on or off, according to the value
23844 update_window_cursor (struct window
*w
, int on
)
23846 /* Don't update cursor in windows whose frame is in the process
23847 of being deleted. */
23848 if (w
->current_matrix
)
23851 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23852 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23858 /* Call update_window_cursor with parameter ON_P on all leaf windows
23859 in the window tree rooted at W. */
23862 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23866 if (!NILP (w
->hchild
))
23867 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23868 else if (!NILP (w
->vchild
))
23869 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23871 update_window_cursor (w
, on_p
);
23873 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23879 Display the cursor on window W, or clear it, according to ON_P.
23880 Don't change the cursor's position. */
23883 x_update_cursor (struct frame
*f
, int on_p
)
23885 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23890 Clear the cursor of window W to background color, and mark the
23891 cursor as not shown. This is used when the text where the cursor
23892 is about to be rewritten. */
23895 x_clear_cursor (struct window
*w
)
23897 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23898 update_window_cursor (w
, 0);
23901 #endif /* HAVE_WINDOW_SYSTEM */
23903 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23906 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23907 int start_hpos
, int end_hpos
,
23908 enum draw_glyphs_face draw
)
23910 #ifdef HAVE_WINDOW_SYSTEM
23911 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23913 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23917 #if defined (HAVE_GPM) || defined (MSDOS)
23918 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23923 Display the active region described by mouse_face_* according to DRAW. */
23926 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23928 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23929 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23931 if (/* If window is in the process of being destroyed, don't bother
23933 w
->current_matrix
!= NULL
23934 /* Don't update mouse highlight if hidden */
23935 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23936 /* Recognize when we are called to operate on rows that don't exist
23937 anymore. This can happen when a window is split. */
23938 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23940 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23941 struct glyph_row
*row
, *first
, *last
;
23943 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23944 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23946 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23948 int start_hpos
, end_hpos
, start_x
;
23950 /* For all but the first row, the highlight starts at column 0. */
23953 /* R2L rows have BEG and END in reversed order, but the
23954 screen drawing geometry is always left to right. So
23955 we need to mirror the beginning and end of the
23956 highlighted area in R2L rows. */
23957 if (!row
->reversed_p
)
23959 start_hpos
= hlinfo
->mouse_face_beg_col
;
23960 start_x
= hlinfo
->mouse_face_beg_x
;
23962 else if (row
== last
)
23964 start_hpos
= hlinfo
->mouse_face_end_col
;
23965 start_x
= hlinfo
->mouse_face_end_x
;
23973 else if (row
->reversed_p
&& row
== last
)
23975 start_hpos
= hlinfo
->mouse_face_end_col
;
23976 start_x
= hlinfo
->mouse_face_end_x
;
23986 if (!row
->reversed_p
)
23987 end_hpos
= hlinfo
->mouse_face_end_col
;
23988 else if (row
== first
)
23989 end_hpos
= hlinfo
->mouse_face_beg_col
;
23992 end_hpos
= row
->used
[TEXT_AREA
];
23993 if (draw
== DRAW_NORMAL_TEXT
)
23994 row
->fill_line_p
= 1; /* Clear to end of line */
23997 else if (row
->reversed_p
&& row
== first
)
23998 end_hpos
= hlinfo
->mouse_face_beg_col
;
24001 end_hpos
= row
->used
[TEXT_AREA
];
24002 if (draw
== DRAW_NORMAL_TEXT
)
24003 row
->fill_line_p
= 1; /* Clear to end of line */
24006 if (end_hpos
> start_hpos
)
24008 draw_row_with_mouse_face (w
, start_x
, row
,
24009 start_hpos
, end_hpos
, draw
);
24012 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24016 #ifdef HAVE_WINDOW_SYSTEM
24017 /* When we've written over the cursor, arrange for it to
24018 be displayed again. */
24019 if (FRAME_WINDOW_P (f
)
24020 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24023 display_and_set_cursor (w
, 1,
24024 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24025 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24028 #endif /* HAVE_WINDOW_SYSTEM */
24031 #ifdef HAVE_WINDOW_SYSTEM
24032 /* Change the mouse cursor. */
24033 if (FRAME_WINDOW_P (f
))
24035 if (draw
== DRAW_NORMAL_TEXT
24036 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24037 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24038 else if (draw
== DRAW_MOUSE_FACE
)
24039 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24041 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24043 #endif /* HAVE_WINDOW_SYSTEM */
24047 Clear out the mouse-highlighted active region.
24048 Redraw it un-highlighted first. Value is non-zero if mouse
24049 face was actually drawn unhighlighted. */
24052 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24056 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24058 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24062 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24063 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24064 hlinfo
->mouse_face_window
= Qnil
;
24065 hlinfo
->mouse_face_overlay
= Qnil
;
24069 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24070 within the mouse face on that window. */
24072 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24074 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24076 /* Quickly resolve the easy cases. */
24077 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24078 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24080 if (vpos
< hlinfo
->mouse_face_beg_row
24081 || vpos
> hlinfo
->mouse_face_end_row
)
24083 if (vpos
> hlinfo
->mouse_face_beg_row
24084 && vpos
< hlinfo
->mouse_face_end_row
)
24087 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24089 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24091 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24094 else if ((vpos
== hlinfo
->mouse_face_beg_row
24095 && hpos
>= hlinfo
->mouse_face_beg_col
)
24096 || (vpos
== hlinfo
->mouse_face_end_row
24097 && hpos
< hlinfo
->mouse_face_end_col
))
24102 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24104 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24107 else if ((vpos
== hlinfo
->mouse_face_beg_row
24108 && hpos
<= hlinfo
->mouse_face_beg_col
)
24109 || (vpos
== hlinfo
->mouse_face_end_row
24110 && hpos
> hlinfo
->mouse_face_end_col
))
24118 Non-zero if physical cursor of window W is within mouse face. */
24121 cursor_in_mouse_face_p (struct window
*w
)
24123 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24128 /* Find the glyph rows START_ROW and END_ROW of window W that display
24129 characters between buffer positions START_CHARPOS and END_CHARPOS
24130 (excluding END_CHARPOS). This is similar to row_containing_pos,
24131 but is more accurate when bidi reordering makes buffer positions
24132 change non-linearly with glyph rows. */
24134 rows_from_pos_range (struct window
*w
,
24135 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24136 struct glyph_row
**start
, struct glyph_row
**end
)
24138 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24139 int last_y
= window_text_bottom_y (w
);
24140 struct glyph_row
*row
;
24145 while (!first
->enabled_p
24146 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24149 /* Find the START row. */
24151 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24154 /* A row can potentially be the START row if the range of the
24155 characters it displays intersects the range
24156 [START_CHARPOS..END_CHARPOS). */
24157 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24158 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24159 /* See the commentary in row_containing_pos, for the
24160 explanation of the complicated way to check whether
24161 some position is beyond the end of the characters
24162 displayed by a row. */
24163 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24164 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24165 && !row
->ends_at_zv_p
24166 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24167 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24168 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24169 && !row
->ends_at_zv_p
24170 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24172 /* Found a candidate row. Now make sure at least one of the
24173 glyphs it displays has a charpos from the range
24174 [START_CHARPOS..END_CHARPOS).
24176 This is not obvious because bidi reordering could make
24177 buffer positions of a row be 1,2,3,102,101,100, and if we
24178 want to highlight characters in [50..60), we don't want
24179 this row, even though [50..60) does intersect [1..103),
24180 the range of character positions given by the row's start
24181 and end positions. */
24182 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24183 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24187 if (BUFFERP (g
->object
)
24188 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24197 /* Find the END row. */
24199 /* If the last row is partially visible, start looking for END
24200 from that row, instead of starting from FIRST. */
24201 && !(row
->enabled_p
24202 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24204 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24206 struct glyph_row
*next
= row
+ 1;
24208 if (!next
->enabled_p
24209 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24210 /* The first row >= START whose range of displayed characters
24211 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24212 is the row END + 1. */
24213 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24214 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24215 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24216 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24217 && !next
->ends_at_zv_p
24218 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24219 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24220 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24221 && !next
->ends_at_zv_p
24222 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24229 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24230 but none of the characters it displays are in the range, it is
24232 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24233 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24237 if (BUFFERP (g
->object
)
24238 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24251 /* This function sets the mouse_face_* elements of HLINFO, assuming
24252 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24253 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24254 for the overlay or run of text properties specifying the mouse
24255 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24256 before-string and after-string that must also be highlighted.
24257 COVER_STRING, if non-nil, is a display string that may cover some
24258 or all of the highlighted text. */
24261 mouse_face_from_buffer_pos (Lisp_Object window
,
24262 Mouse_HLInfo
*hlinfo
,
24263 EMACS_INT mouse_charpos
,
24264 EMACS_INT start_charpos
,
24265 EMACS_INT end_charpos
,
24266 Lisp_Object before_string
,
24267 Lisp_Object after_string
,
24268 Lisp_Object cover_string
)
24270 struct window
*w
= XWINDOW (window
);
24271 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24272 struct glyph_row
*r1
, *r2
;
24273 struct glyph
*glyph
, *end
;
24274 EMACS_INT ignore
, pos
;
24277 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24278 xassert (NILP (before_string
) || STRINGP (before_string
));
24279 xassert (NILP (after_string
) || STRINGP (after_string
));
24281 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24282 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24284 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24285 /* If the before-string or display-string contains newlines,
24286 rows_from_pos_range skips to its last row. Move back. */
24287 if (!NILP (before_string
) || !NILP (cover_string
))
24289 struct glyph_row
*prev
;
24290 while ((prev
= r1
- 1, prev
>= first
)
24291 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24292 && prev
->used
[TEXT_AREA
] > 0)
24294 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24295 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24296 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24298 || !(EQ (glyph
->object
, before_string
)
24299 || EQ (glyph
->object
, cover_string
)))
24306 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24307 hlinfo
->mouse_face_past_end
= 1;
24309 else if (!NILP (after_string
))
24311 /* If the after-string has newlines, advance to its last row. */
24312 struct glyph_row
*next
;
24313 struct glyph_row
*last
24314 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24316 for (next
= r2
+ 1;
24318 && next
->used
[TEXT_AREA
] > 0
24319 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24323 /* The rest of the display engine assumes that mouse_face_beg_row is
24324 either above below mouse_face_end_row or identical to it. But
24325 with bidi-reordered continued lines, the row for START_CHARPOS
24326 could be below the row for END_CHARPOS. If so, swap the rows and
24327 store them in correct order. */
24330 struct glyph_row
*tem
= r2
;
24336 hlinfo
->mouse_face_beg_y
= r1
->y
;
24337 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24338 hlinfo
->mouse_face_end_y
= r2
->y
;
24339 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24341 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24342 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24343 could be anywhere in the row and in any order. The strategy
24344 below is to find the leftmost and the rightmost glyph that
24345 belongs to either of these 3 strings, or whose position is
24346 between START_CHARPOS and END_CHARPOS, and highlight all the
24347 glyphs between those two. This may cover more than just the text
24348 between START_CHARPOS and END_CHARPOS if the range of characters
24349 strides the bidi level boundary, e.g. if the beginning is in R2L
24350 text while the end is in L2R text or vice versa. */
24351 if (!r1
->reversed_p
)
24353 /* This row is in a left to right paragraph. Scan it left to
24355 glyph
= r1
->glyphs
[TEXT_AREA
];
24356 end
= glyph
+ r1
->used
[TEXT_AREA
];
24359 /* Skip truncation glyphs at the start of the glyph row. */
24360 if (r1
->displays_text_p
)
24362 && INTEGERP (glyph
->object
)
24363 && glyph
->charpos
< 0;
24365 x
+= glyph
->pixel_width
;
24367 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24368 or COVER_STRING, and the first glyph from buffer whose
24369 position is between START_CHARPOS and END_CHARPOS. */
24371 && !INTEGERP (glyph
->object
)
24372 && !EQ (glyph
->object
, cover_string
)
24373 && !(BUFFERP (glyph
->object
)
24374 && (glyph
->charpos
>= start_charpos
24375 && glyph
->charpos
< end_charpos
));
24378 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24379 are present at buffer positions between START_CHARPOS and
24380 END_CHARPOS, or if they come from an overlay. */
24381 if (EQ (glyph
->object
, before_string
))
24383 pos
= string_buffer_position (w
, before_string
,
24385 /* If pos == 0, it means before_string came from an
24386 overlay, not from a buffer position. */
24387 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24390 else if (EQ (glyph
->object
, after_string
))
24392 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24393 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24396 x
+= glyph
->pixel_width
;
24398 hlinfo
->mouse_face_beg_x
= x
;
24399 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24403 /* This row is in a right to left paragraph. Scan it right to
24407 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24408 glyph
= end
+ r1
->used
[TEXT_AREA
];
24410 /* Skip truncation glyphs at the start of the glyph row. */
24411 if (r1
->displays_text_p
)
24413 && INTEGERP (glyph
->object
)
24414 && glyph
->charpos
< 0;
24418 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24419 or COVER_STRING, and the first glyph from buffer whose
24420 position is between START_CHARPOS and END_CHARPOS. */
24422 && !INTEGERP (glyph
->object
)
24423 && !EQ (glyph
->object
, cover_string
)
24424 && !(BUFFERP (glyph
->object
)
24425 && (glyph
->charpos
>= start_charpos
24426 && glyph
->charpos
< end_charpos
));
24429 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24430 are present at buffer positions between START_CHARPOS and
24431 END_CHARPOS, or if they come from an overlay. */
24432 if (EQ (glyph
->object
, before_string
))
24434 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24435 /* If pos == 0, it means before_string came from an
24436 overlay, not from a buffer position. */
24437 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24440 else if (EQ (glyph
->object
, after_string
))
24442 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24443 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24448 glyph
++; /* first glyph to the right of the highlighted area */
24449 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24450 x
+= g
->pixel_width
;
24451 hlinfo
->mouse_face_beg_x
= x
;
24452 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24455 /* If the highlight ends in a different row, compute GLYPH and END
24456 for the end row. Otherwise, reuse the values computed above for
24457 the row where the highlight begins. */
24460 if (!r2
->reversed_p
)
24462 glyph
= r2
->glyphs
[TEXT_AREA
];
24463 end
= glyph
+ r2
->used
[TEXT_AREA
];
24468 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24469 glyph
= end
+ r2
->used
[TEXT_AREA
];
24473 if (!r2
->reversed_p
)
24475 /* Skip truncation and continuation glyphs near the end of the
24476 row, and also blanks and stretch glyphs inserted by
24477 extend_face_to_end_of_line. */
24479 && INTEGERP ((end
- 1)->object
)
24480 && (end
- 1)->charpos
<= 0)
24482 /* Scan the rest of the glyph row from the end, looking for the
24483 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24484 COVER_STRING, or whose position is between START_CHARPOS
24488 && !INTEGERP (end
->object
)
24489 && !EQ (end
->object
, cover_string
)
24490 && !(BUFFERP (end
->object
)
24491 && (end
->charpos
>= start_charpos
24492 && end
->charpos
< end_charpos
));
24495 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24496 are present at buffer positions between START_CHARPOS and
24497 END_CHARPOS, or if they come from an overlay. */
24498 if (EQ (end
->object
, before_string
))
24500 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24501 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24504 else if (EQ (end
->object
, after_string
))
24506 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24507 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24511 /* Find the X coordinate of the last glyph to be highlighted. */
24512 for (; glyph
<= end
; ++glyph
)
24513 x
+= glyph
->pixel_width
;
24515 hlinfo
->mouse_face_end_x
= x
;
24516 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24520 /* Skip truncation and continuation glyphs near the end of the
24521 row, and also blanks and stretch glyphs inserted by
24522 extend_face_to_end_of_line. */
24526 && INTEGERP (end
->object
)
24527 && end
->charpos
<= 0)
24529 x
+= end
->pixel_width
;
24532 /* Scan the rest of the glyph row from the end, looking for the
24533 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24534 COVER_STRING, or whose position is between START_CHARPOS
24538 && !INTEGERP (end
->object
)
24539 && !EQ (end
->object
, cover_string
)
24540 && !(BUFFERP (end
->object
)
24541 && (end
->charpos
>= start_charpos
24542 && end
->charpos
< end_charpos
));
24545 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24546 are present at buffer positions between START_CHARPOS and
24547 END_CHARPOS, or if they come from an overlay. */
24548 if (EQ (end
->object
, before_string
))
24550 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24551 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24554 else if (EQ (end
->object
, after_string
))
24556 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24557 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24560 x
+= end
->pixel_width
;
24562 hlinfo
->mouse_face_end_x
= x
;
24563 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24566 hlinfo
->mouse_face_window
= window
;
24567 hlinfo
->mouse_face_face_id
24568 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24570 !hlinfo
->mouse_face_hidden
, -1);
24571 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24574 /* The following function is not used anymore (replaced with
24575 mouse_face_from_string_pos), but I leave it here for the time
24576 being, in case someone would. */
24578 #if 0 /* not used */
24580 /* Find the position of the glyph for position POS in OBJECT in
24581 window W's current matrix, and return in *X, *Y the pixel
24582 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24584 RIGHT_P non-zero means return the position of the right edge of the
24585 glyph, RIGHT_P zero means return the left edge position.
24587 If no glyph for POS exists in the matrix, return the position of
24588 the glyph with the next smaller position that is in the matrix, if
24589 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24590 exists in the matrix, return the position of the glyph with the
24591 next larger position in OBJECT.
24593 Value is non-zero if a glyph was found. */
24596 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24597 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24599 int yb
= window_text_bottom_y (w
);
24600 struct glyph_row
*r
;
24601 struct glyph
*best_glyph
= NULL
;
24602 struct glyph_row
*best_row
= NULL
;
24605 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24606 r
->enabled_p
&& r
->y
< yb
;
24609 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24610 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24613 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24614 if (EQ (g
->object
, object
))
24616 if (g
->charpos
== pos
)
24623 else if (best_glyph
== NULL
24624 || ((eabs (g
->charpos
- pos
)
24625 < eabs (best_glyph
->charpos
- pos
))
24628 : g
->charpos
> pos
)))
24642 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24646 *x
+= best_glyph
->pixel_width
;
24651 *vpos
= best_row
- w
->current_matrix
->rows
;
24654 return best_glyph
!= NULL
;
24656 #endif /* not used */
24658 /* Find the positions of the first and the last glyphs in window W's
24659 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24660 (assumed to be a string), and return in HLINFO's mouse_face_*
24661 members the pixel and column/row coordinates of those glyphs. */
24664 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24665 Lisp_Object object
,
24666 EMACS_INT startpos
, EMACS_INT endpos
)
24668 int yb
= window_text_bottom_y (w
);
24669 struct glyph_row
*r
;
24670 struct glyph
*g
, *e
;
24674 /* Find the glyph row with at least one position in the range
24675 [STARTPOS..ENDPOS], and the first glyph in that row whose
24676 position belongs to that range. */
24677 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24678 r
->enabled_p
&& r
->y
< yb
;
24681 if (!r
->reversed_p
)
24683 g
= r
->glyphs
[TEXT_AREA
];
24684 e
= g
+ r
->used
[TEXT_AREA
];
24685 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24686 if (EQ (g
->object
, object
)
24687 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24689 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24690 hlinfo
->mouse_face_beg_y
= r
->y
;
24691 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24692 hlinfo
->mouse_face_beg_x
= gx
;
24701 e
= r
->glyphs
[TEXT_AREA
];
24702 g
= e
+ r
->used
[TEXT_AREA
];
24703 for ( ; g
> e
; --g
)
24704 if (EQ ((g
-1)->object
, object
)
24705 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24707 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24708 hlinfo
->mouse_face_beg_y
= r
->y
;
24709 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24710 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24711 gx
+= g1
->pixel_width
;
24712 hlinfo
->mouse_face_beg_x
= gx
;
24724 /* Starting with the next row, look for the first row which does NOT
24725 include any glyphs whose positions are in the range. */
24726 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24728 g
= r
->glyphs
[TEXT_AREA
];
24729 e
= g
+ r
->used
[TEXT_AREA
];
24731 for ( ; g
< e
; ++g
)
24732 if (EQ (g
->object
, object
)
24733 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24742 /* The highlighted region ends on the previous row. */
24745 /* Set the end row and its vertical pixel coordinate. */
24746 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24747 hlinfo
->mouse_face_end_y
= r
->y
;
24749 /* Compute and set the end column and the end column's horizontal
24750 pixel coordinate. */
24751 if (!r
->reversed_p
)
24753 g
= r
->glyphs
[TEXT_AREA
];
24754 e
= g
+ r
->used
[TEXT_AREA
];
24755 for ( ; e
> g
; --e
)
24756 if (EQ ((e
-1)->object
, object
)
24757 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24759 hlinfo
->mouse_face_end_col
= e
- g
;
24761 for (gx
= r
->x
; g
< e
; ++g
)
24762 gx
+= g
->pixel_width
;
24763 hlinfo
->mouse_face_end_x
= gx
;
24767 e
= r
->glyphs
[TEXT_AREA
];
24768 g
= e
+ r
->used
[TEXT_AREA
];
24769 for (gx
= r
->x
; e
< g
; ++e
)
24771 if (EQ (e
->object
, object
)
24772 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24774 gx
+= e
->pixel_width
;
24776 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24777 hlinfo
->mouse_face_end_x
= gx
;
24781 #ifdef HAVE_WINDOW_SYSTEM
24783 /* See if position X, Y is within a hot-spot of an image. */
24786 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24788 if (!CONSP (hot_spot
))
24791 if (EQ (XCAR (hot_spot
), Qrect
))
24793 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24794 Lisp_Object rect
= XCDR (hot_spot
);
24798 if (!CONSP (XCAR (rect
)))
24800 if (!CONSP (XCDR (rect
)))
24802 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24804 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24806 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24808 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24812 else if (EQ (XCAR (hot_spot
), Qcircle
))
24814 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24815 Lisp_Object circ
= XCDR (hot_spot
);
24816 Lisp_Object lr
, lx0
, ly0
;
24818 && CONSP (XCAR (circ
))
24819 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24820 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24821 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24823 double r
= XFLOATINT (lr
);
24824 double dx
= XINT (lx0
) - x
;
24825 double dy
= XINT (ly0
) - y
;
24826 return (dx
* dx
+ dy
* dy
<= r
* r
);
24829 else if (EQ (XCAR (hot_spot
), Qpoly
))
24831 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24832 if (VECTORP (XCDR (hot_spot
)))
24834 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24835 Lisp_Object
*poly
= v
->contents
;
24839 Lisp_Object lx
, ly
;
24842 /* Need an even number of coordinates, and at least 3 edges. */
24843 if (n
< 6 || n
& 1)
24846 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24847 If count is odd, we are inside polygon. Pixels on edges
24848 may or may not be included depending on actual geometry of the
24850 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24851 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24853 x0
= XINT (lx
), y0
= XINT (ly
);
24854 for (i
= 0; i
< n
; i
+= 2)
24856 int x1
= x0
, y1
= y0
;
24857 if ((lx
= poly
[i
], !INTEGERP (lx
))
24858 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24860 x0
= XINT (lx
), y0
= XINT (ly
);
24862 /* Does this segment cross the X line? */
24870 if (y
> y0
&& y
> y1
)
24872 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24882 find_hot_spot (Lisp_Object map
, int x
, int y
)
24884 while (CONSP (map
))
24886 if (CONSP (XCAR (map
))
24887 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24895 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24897 doc
: /* Lookup in image map MAP coordinates X and Y.
24898 An image map is an alist where each element has the format (AREA ID PLIST).
24899 An AREA is specified as either a rectangle, a circle, or a polygon:
24900 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24901 pixel coordinates of the upper left and bottom right corners.
24902 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24903 and the radius of the circle; r may be a float or integer.
24904 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24905 vector describes one corner in the polygon.
24906 Returns the alist element for the first matching AREA in MAP. */)
24907 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24915 return find_hot_spot (map
, XINT (x
), XINT (y
));
24919 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24921 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24923 /* Do not change cursor shape while dragging mouse. */
24924 if (!NILP (do_mouse_tracking
))
24927 if (!NILP (pointer
))
24929 if (EQ (pointer
, Qarrow
))
24930 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24931 else if (EQ (pointer
, Qhand
))
24932 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24933 else if (EQ (pointer
, Qtext
))
24934 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24935 else if (EQ (pointer
, intern ("hdrag")))
24936 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24937 #ifdef HAVE_X_WINDOWS
24938 else if (EQ (pointer
, intern ("vdrag")))
24939 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24941 else if (EQ (pointer
, intern ("hourglass")))
24942 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24943 else if (EQ (pointer
, Qmodeline
))
24944 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24946 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24949 if (cursor
!= No_Cursor
)
24950 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24953 #endif /* HAVE_WINDOW_SYSTEM */
24955 /* Take proper action when mouse has moved to the mode or header line
24956 or marginal area AREA of window W, x-position X and y-position Y.
24957 X is relative to the start of the text display area of W, so the
24958 width of bitmap areas and scroll bars must be subtracted to get a
24959 position relative to the start of the mode line. */
24962 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24963 enum window_part area
)
24965 struct window
*w
= XWINDOW (window
);
24966 struct frame
*f
= XFRAME (w
->frame
);
24967 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24968 #ifdef HAVE_WINDOW_SYSTEM
24969 Display_Info
*dpyinfo
;
24971 Cursor cursor
= No_Cursor
;
24972 Lisp_Object pointer
= Qnil
;
24973 int dx
, dy
, width
, height
;
24975 Lisp_Object string
, object
= Qnil
;
24976 Lisp_Object pos
, help
;
24978 Lisp_Object mouse_face
;
24979 int original_x_pixel
= x
;
24980 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24981 struct glyph_row
*row
;
24983 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24988 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24989 returns them in row/column units! */
24990 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24991 &object
, &dx
, &dy
, &width
, &height
);
24993 row
= (area
== ON_MODE_LINE
24994 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24995 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24997 /* Find the glyph under the mouse pointer. */
24998 if (row
->mode_line_p
&& row
->enabled_p
)
25000 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25001 end
= glyph
+ row
->used
[TEXT_AREA
];
25003 for (x0
= original_x_pixel
;
25004 glyph
< end
&& x0
>= glyph
->pixel_width
;
25006 x0
-= glyph
->pixel_width
;
25014 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25015 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25016 returns them in row/column units! */
25017 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25018 &object
, &dx
, &dy
, &width
, &height
);
25023 #ifdef HAVE_WINDOW_SYSTEM
25024 if (IMAGEP (object
))
25026 Lisp_Object image_map
, hotspot
;
25027 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25029 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25031 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25033 Lisp_Object area_id
, plist
;
25035 area_id
= XCAR (hotspot
);
25036 /* Could check AREA_ID to see if we enter/leave this hot-spot.
25037 If so, we could look for mouse-enter, mouse-leave
25038 properties in PLIST (and do something...). */
25039 hotspot
= XCDR (hotspot
);
25040 if (CONSP (hotspot
)
25041 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25043 pointer
= Fplist_get (plist
, Qpointer
);
25044 if (NILP (pointer
))
25046 help
= Fplist_get (plist
, Qhelp_echo
);
25049 help_echo_string
= help
;
25050 /* Is this correct? ++kfs */
25051 XSETWINDOW (help_echo_window
, w
);
25052 help_echo_object
= w
->buffer
;
25053 help_echo_pos
= charpos
;
25057 if (NILP (pointer
))
25058 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25060 #endif /* HAVE_WINDOW_SYSTEM */
25062 if (STRINGP (string
))
25064 pos
= make_number (charpos
);
25065 /* If we're on a string with `help-echo' text property, arrange
25066 for the help to be displayed. This is done by setting the
25067 global variable help_echo_string to the help string. */
25070 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25073 help_echo_string
= help
;
25074 XSETWINDOW (help_echo_window
, w
);
25075 help_echo_object
= string
;
25076 help_echo_pos
= charpos
;
25080 #ifdef HAVE_WINDOW_SYSTEM
25081 if (FRAME_WINDOW_P (f
))
25083 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25084 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25085 if (NILP (pointer
))
25086 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25088 /* Change the mouse pointer according to what is under X/Y. */
25090 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25093 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25094 if (!KEYMAPP (map
))
25095 map
= Fget_text_property (pos
, Qkeymap
, string
);
25096 if (!KEYMAPP (map
))
25097 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25102 /* Change the mouse face according to what is under X/Y. */
25103 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25104 if (!NILP (mouse_face
)
25105 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25110 struct glyph
* tmp_glyph
;
25114 int total_pixel_width
;
25115 EMACS_INT begpos
, endpos
, ignore
;
25119 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25120 Qmouse_face
, string
, Qnil
);
25126 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25128 endpos
= SCHARS (string
);
25132 /* Calculate the glyph position GPOS of GLYPH in the
25133 displayed string, relative to the beginning of the
25134 highlighted part of the string.
25136 Note: GPOS is different from CHARPOS. CHARPOS is the
25137 position of GLYPH in the internal string object. A mode
25138 line string format has structures which are converted to
25139 a flattened string by the Emacs Lisp interpreter. The
25140 internal string is an element of those structures. The
25141 displayed string is the flattened string. */
25142 tmp_glyph
= row_start_glyph
;
25143 while (tmp_glyph
< glyph
25144 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25145 && begpos
<= tmp_glyph
->charpos
25146 && tmp_glyph
->charpos
< endpos
)))
25148 gpos
= glyph
- tmp_glyph
;
25150 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25151 the highlighted part of the displayed string to which
25152 GLYPH belongs. Note: GSEQ_LENGTH is different from
25153 SCHARS (STRING), because the latter returns the length of
25154 the internal string. */
25155 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25157 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25158 && begpos
<= tmp_glyph
->charpos
25159 && tmp_glyph
->charpos
< endpos
));
25162 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25164 /* Calculate the total pixel width of all the glyphs between
25165 the beginning of the highlighted area and GLYPH. */
25166 total_pixel_width
= 0;
25167 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25168 total_pixel_width
+= tmp_glyph
->pixel_width
;
25170 /* Pre calculation of re-rendering position. Note: X is in
25171 column units here, after the call to mode_line_string or
25172 marginal_area_string. */
25174 vpos
= (area
== ON_MODE_LINE
25175 ? (w
->current_matrix
)->nrows
- 1
25178 /* If GLYPH's position is included in the region that is
25179 already drawn in mouse face, we have nothing to do. */
25180 if ( EQ (window
, hlinfo
->mouse_face_window
)
25181 && (!row
->reversed_p
25182 ? (hlinfo
->mouse_face_beg_col
<= hpos
25183 && hpos
< hlinfo
->mouse_face_end_col
)
25184 /* In R2L rows we swap BEG and END, see below. */
25185 : (hlinfo
->mouse_face_end_col
<= hpos
25186 && hpos
< hlinfo
->mouse_face_beg_col
))
25187 && hlinfo
->mouse_face_beg_row
== vpos
)
25190 if (clear_mouse_face (hlinfo
))
25191 cursor
= No_Cursor
;
25193 if (!row
->reversed_p
)
25195 hlinfo
->mouse_face_beg_col
= hpos
;
25196 hlinfo
->mouse_face_beg_x
= original_x_pixel
25197 - (total_pixel_width
+ dx
);
25198 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25199 hlinfo
->mouse_face_end_x
= 0;
25203 /* In R2L rows, show_mouse_face expects BEG and END
25204 coordinates to be swapped. */
25205 hlinfo
->mouse_face_end_col
= hpos
;
25206 hlinfo
->mouse_face_end_x
= original_x_pixel
25207 - (total_pixel_width
+ dx
);
25208 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25209 hlinfo
->mouse_face_beg_x
= 0;
25212 hlinfo
->mouse_face_beg_row
= vpos
;
25213 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25214 hlinfo
->mouse_face_beg_y
= 0;
25215 hlinfo
->mouse_face_end_y
= 0;
25216 hlinfo
->mouse_face_past_end
= 0;
25217 hlinfo
->mouse_face_window
= window
;
25219 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25225 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25227 if (NILP (pointer
))
25230 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25231 clear_mouse_face (hlinfo
);
25233 #ifdef HAVE_WINDOW_SYSTEM
25234 if (FRAME_WINDOW_P (f
))
25235 define_frame_cursor1 (f
, cursor
, pointer
);
25241 Take proper action when the mouse has moved to position X, Y on
25242 frame F as regards highlighting characters that have mouse-face
25243 properties. Also de-highlighting chars where the mouse was before.
25244 X and Y can be negative or out of range. */
25247 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25249 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25250 enum window_part part
;
25251 Lisp_Object window
;
25253 Cursor cursor
= No_Cursor
;
25254 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25257 /* When a menu is active, don't highlight because this looks odd. */
25258 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25259 if (popup_activated ())
25263 if (NILP (Vmouse_highlight
)
25264 || !f
->glyphs_initialized_p
25265 || f
->pointer_invisible
)
25268 hlinfo
->mouse_face_mouse_x
= x
;
25269 hlinfo
->mouse_face_mouse_y
= y
;
25270 hlinfo
->mouse_face_mouse_frame
= f
;
25272 if (hlinfo
->mouse_face_defer
)
25275 if (gc_in_progress
)
25277 hlinfo
->mouse_face_deferred_gc
= 1;
25281 /* Which window is that in? */
25282 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25284 /* If we were displaying active text in another window, clear that.
25285 Also clear if we move out of text area in same window. */
25286 if (! EQ (window
, hlinfo
->mouse_face_window
)
25287 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25288 && !NILP (hlinfo
->mouse_face_window
)))
25289 clear_mouse_face (hlinfo
);
25291 /* Not on a window -> return. */
25292 if (!WINDOWP (window
))
25295 /* Reset help_echo_string. It will get recomputed below. */
25296 help_echo_string
= Qnil
;
25298 /* Convert to window-relative pixel coordinates. */
25299 w
= XWINDOW (window
);
25300 frame_to_window_pixel_xy (w
, &x
, &y
);
25302 #ifdef HAVE_WINDOW_SYSTEM
25303 /* Handle tool-bar window differently since it doesn't display a
25305 if (EQ (window
, f
->tool_bar_window
))
25307 note_tool_bar_highlight (f
, x
, y
);
25312 /* Mouse is on the mode, header line or margin? */
25313 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25314 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25316 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25320 #ifdef HAVE_WINDOW_SYSTEM
25321 if (part
== ON_VERTICAL_BORDER
)
25323 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25324 help_echo_string
= build_string ("drag-mouse-1: resize");
25326 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25327 || part
== ON_SCROLL_BAR
)
25328 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25330 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25333 /* Are we in a window whose display is up to date?
25334 And verify the buffer's text has not changed. */
25335 b
= XBUFFER (w
->buffer
);
25336 if (part
== ON_TEXT
25337 && EQ (w
->window_end_valid
, w
->buffer
)
25338 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25339 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25341 int hpos
, vpos
, i
, dx
, dy
, area
;
25343 struct glyph
*glyph
;
25344 Lisp_Object object
;
25345 Lisp_Object mouse_face
= Qnil
, position
;
25346 Lisp_Object
*overlay_vec
= NULL
;
25348 struct buffer
*obuf
;
25349 EMACS_INT obegv
, ozv
;
25352 /* Find the glyph under X/Y. */
25353 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25355 #ifdef HAVE_WINDOW_SYSTEM
25356 /* Look for :pointer property on image. */
25357 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25359 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25360 if (img
!= NULL
&& IMAGEP (img
->spec
))
25362 Lisp_Object image_map
, hotspot
;
25363 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25365 && (hotspot
= find_hot_spot (image_map
,
25366 glyph
->slice
.img
.x
+ dx
,
25367 glyph
->slice
.img
.y
+ dy
),
25369 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25371 Lisp_Object area_id
, plist
;
25373 area_id
= XCAR (hotspot
);
25374 /* Could check AREA_ID to see if we enter/leave this hot-spot.
25375 If so, we could look for mouse-enter, mouse-leave
25376 properties in PLIST (and do something...). */
25377 hotspot
= XCDR (hotspot
);
25378 if (CONSP (hotspot
)
25379 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25381 pointer
= Fplist_get (plist
, Qpointer
);
25382 if (NILP (pointer
))
25384 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25385 if (!NILP (help_echo_string
))
25387 help_echo_window
= window
;
25388 help_echo_object
= glyph
->object
;
25389 help_echo_pos
= glyph
->charpos
;
25393 if (NILP (pointer
))
25394 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25397 #endif /* HAVE_WINDOW_SYSTEM */
25399 /* Clear mouse face if X/Y not over text. */
25401 || area
!= TEXT_AREA
25402 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25403 /* Glyph's OBJECT is an integer for glyphs inserted by the
25404 display engine for its internal purposes, like truncation
25405 and continuation glyphs and blanks beyond the end of
25406 line's text on text terminals. If we are over such a
25407 glyph, we are not over any text. */
25408 || INTEGERP (glyph
->object
)
25409 /* R2L rows have a stretch glyph at their front, which
25410 stands for no text, whereas L2R rows have no glyphs at
25411 all beyond the end of text. Treat such stretch glyphs
25412 like we do with NULL glyphs in L2R rows. */
25413 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25414 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25415 && glyph
->type
== STRETCH_GLYPH
25416 && glyph
->avoid_cursor_p
))
25418 if (clear_mouse_face (hlinfo
))
25419 cursor
= No_Cursor
;
25420 #ifdef HAVE_WINDOW_SYSTEM
25421 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25423 if (area
!= TEXT_AREA
)
25424 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25426 pointer
= Vvoid_text_area_pointer
;
25432 pos
= glyph
->charpos
;
25433 object
= glyph
->object
;
25434 if (!STRINGP (object
) && !BUFFERP (object
))
25437 /* If we get an out-of-range value, return now; avoid an error. */
25438 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25441 /* Make the window's buffer temporarily current for
25442 overlays_at and compute_char_face. */
25443 obuf
= current_buffer
;
25444 current_buffer
= b
;
25450 /* Is this char mouse-active or does it have help-echo? */
25451 position
= make_number (pos
);
25453 if (BUFFERP (object
))
25455 /* Put all the overlays we want in a vector in overlay_vec. */
25456 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25457 /* Sort overlays into increasing priority order. */
25458 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25463 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25466 cursor
= No_Cursor
;
25468 /* Check mouse-face highlighting. */
25470 /* If there exists an overlay with mouse-face overlapping
25471 the one we are currently highlighting, we have to
25472 check if we enter the overlapping overlay, and then
25473 highlight only that. */
25474 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25475 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25477 /* Find the highest priority overlay with a mouse-face. */
25478 Lisp_Object overlay
= Qnil
;
25479 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25481 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25482 if (!NILP (mouse_face
))
25483 overlay
= overlay_vec
[i
];
25486 /* If we're highlighting the same overlay as before, there's
25487 no need to do that again. */
25488 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25489 goto check_help_echo
;
25490 hlinfo
->mouse_face_overlay
= overlay
;
25492 /* Clear the display of the old active region, if any. */
25493 if (clear_mouse_face (hlinfo
))
25494 cursor
= No_Cursor
;
25496 /* If no overlay applies, get a text property. */
25497 if (NILP (overlay
))
25498 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25500 /* Next, compute the bounds of the mouse highlighting and
25502 if (!NILP (mouse_face
) && STRINGP (object
))
25504 /* The mouse-highlighting comes from a display string
25505 with a mouse-face. */
25509 s
= Fprevious_single_property_change
25510 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25511 e
= Fnext_single_property_change
25512 (position
, Qmouse_face
, object
, Qnil
);
25514 s
= make_number (0);
25516 e
= make_number (SCHARS (object
) - 1);
25517 mouse_face_from_string_pos (w
, hlinfo
, object
,
25518 XINT (s
), XINT (e
));
25519 hlinfo
->mouse_face_past_end
= 0;
25520 hlinfo
->mouse_face_window
= window
;
25521 hlinfo
->mouse_face_face_id
25522 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25523 glyph
->face_id
, 1);
25524 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25525 cursor
= No_Cursor
;
25529 /* The mouse-highlighting, if any, comes from an overlay
25530 or text property in the buffer. */
25531 Lisp_Object buffer
IF_LINT (= Qnil
);
25532 Lisp_Object cover_string
IF_LINT (= Qnil
);
25534 if (STRINGP (object
))
25536 /* If we are on a display string with no mouse-face,
25537 check if the text under it has one. */
25538 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25539 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25540 pos
= string_buffer_position (w
, object
, start
);
25543 mouse_face
= get_char_property_and_overlay
25544 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25545 buffer
= w
->buffer
;
25546 cover_string
= object
;
25552 cover_string
= Qnil
;
25555 if (!NILP (mouse_face
))
25557 Lisp_Object before
, after
;
25558 Lisp_Object before_string
, after_string
;
25559 /* To correctly find the limits of mouse highlight
25560 in a bidi-reordered buffer, we must not use the
25561 optimization of limiting the search in
25562 previous-single-property-change and
25563 next-single-property-change, because
25564 rows_from_pos_range needs the real start and end
25565 positions to DTRT in this case. That's because
25566 the first row visible in a window does not
25567 necessarily display the character whose position
25568 is the smallest. */
25570 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25571 ? Fmarker_position (w
->start
)
25574 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25575 ? make_number (BUF_Z (XBUFFER (buffer
))
25576 - XFASTINT (w
->window_end_pos
))
25579 if (NILP (overlay
))
25581 /* Handle the text property case. */
25582 before
= Fprevious_single_property_change
25583 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25584 after
= Fnext_single_property_change
25585 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25586 before_string
= after_string
= Qnil
;
25590 /* Handle the overlay case. */
25591 before
= Foverlay_start (overlay
);
25592 after
= Foverlay_end (overlay
);
25593 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25594 after_string
= Foverlay_get (overlay
, Qafter_string
);
25596 if (!STRINGP (before_string
)) before_string
= Qnil
;
25597 if (!STRINGP (after_string
)) after_string
= Qnil
;
25600 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25603 before_string
, after_string
,
25605 cursor
= No_Cursor
;
25612 /* Look for a `help-echo' property. */
25613 if (NILP (help_echo_string
)) {
25614 Lisp_Object help
, overlay
;
25616 /* Check overlays first. */
25617 help
= overlay
= Qnil
;
25618 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25620 overlay
= overlay_vec
[i
];
25621 help
= Foverlay_get (overlay
, Qhelp_echo
);
25626 help_echo_string
= help
;
25627 help_echo_window
= window
;
25628 help_echo_object
= overlay
;
25629 help_echo_pos
= pos
;
25633 Lisp_Object obj
= glyph
->object
;
25634 EMACS_INT charpos
= glyph
->charpos
;
25636 /* Try text properties. */
25639 && charpos
< SCHARS (obj
))
25641 help
= Fget_text_property (make_number (charpos
),
25645 /* If the string itself doesn't specify a help-echo,
25646 see if the buffer text ``under'' it does. */
25647 struct glyph_row
*r
25648 = MATRIX_ROW (w
->current_matrix
, vpos
);
25649 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25650 EMACS_INT p
= string_buffer_position (w
, obj
, start
);
25653 help
= Fget_char_property (make_number (p
),
25654 Qhelp_echo
, w
->buffer
);
25663 else if (BUFFERP (obj
)
25666 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25671 help_echo_string
= help
;
25672 help_echo_window
= window
;
25673 help_echo_object
= obj
;
25674 help_echo_pos
= charpos
;
25679 #ifdef HAVE_WINDOW_SYSTEM
25680 /* Look for a `pointer' property. */
25681 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25683 /* Check overlays first. */
25684 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25685 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25687 if (NILP (pointer
))
25689 Lisp_Object obj
= glyph
->object
;
25690 EMACS_INT charpos
= glyph
->charpos
;
25692 /* Try text properties. */
25695 && charpos
< SCHARS (obj
))
25697 pointer
= Fget_text_property (make_number (charpos
),
25699 if (NILP (pointer
))
25701 /* If the string itself doesn't specify a pointer,
25702 see if the buffer text ``under'' it does. */
25703 struct glyph_row
*r
25704 = MATRIX_ROW (w
->current_matrix
, vpos
);
25705 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25706 EMACS_INT p
= string_buffer_position (w
, obj
, start
);
25708 pointer
= Fget_char_property (make_number (p
),
25709 Qpointer
, w
->buffer
);
25712 else if (BUFFERP (obj
)
25715 pointer
= Fget_text_property (make_number (charpos
),
25719 #endif /* HAVE_WINDOW_SYSTEM */
25723 current_buffer
= obuf
;
25728 #ifdef HAVE_WINDOW_SYSTEM
25729 if (FRAME_WINDOW_P (f
))
25730 define_frame_cursor1 (f
, cursor
, pointer
);
25732 /* This is here to prevent a compiler error, about "label at end of
25733 compound statement". */
25740 Clear any mouse-face on window W. This function is part of the
25741 redisplay interface, and is called from try_window_id and similar
25742 functions to ensure the mouse-highlight is off. */
25745 x_clear_window_mouse_face (struct window
*w
)
25747 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25748 Lisp_Object window
;
25751 XSETWINDOW (window
, w
);
25752 if (EQ (window
, hlinfo
->mouse_face_window
))
25753 clear_mouse_face (hlinfo
);
25759 Just discard the mouse face information for frame F, if any.
25760 This is used when the size of F is changed. */
25763 cancel_mouse_face (struct frame
*f
)
25765 Lisp_Object window
;
25766 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25768 window
= hlinfo
->mouse_face_window
;
25769 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25771 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25772 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25773 hlinfo
->mouse_face_window
= Qnil
;
25779 /***********************************************************************
25781 ***********************************************************************/
25783 #ifdef HAVE_WINDOW_SYSTEM
25785 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25786 which intersects rectangle R. R is in window-relative coordinates. */
25789 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25790 enum glyph_row_area area
)
25792 struct glyph
*first
= row
->glyphs
[area
];
25793 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25794 struct glyph
*last
;
25795 int first_x
, start_x
, x
;
25797 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25798 /* If row extends face to end of line write the whole line. */
25799 draw_glyphs (w
, 0, row
, area
,
25800 0, row
->used
[area
],
25801 DRAW_NORMAL_TEXT
, 0);
25804 /* Set START_X to the window-relative start position for drawing glyphs of
25805 AREA. The first glyph of the text area can be partially visible.
25806 The first glyphs of other areas cannot. */
25807 start_x
= window_box_left_offset (w
, area
);
25809 if (area
== TEXT_AREA
)
25812 /* Find the first glyph that must be redrawn. */
25814 && x
+ first
->pixel_width
< r
->x
)
25816 x
+= first
->pixel_width
;
25820 /* Find the last one. */
25824 && x
< r
->x
+ r
->width
)
25826 x
+= last
->pixel_width
;
25832 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25833 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25834 DRAW_NORMAL_TEXT
, 0);
25839 /* Redraw the parts of the glyph row ROW on window W intersecting
25840 rectangle R. R is in window-relative coordinates. Value is
25841 non-zero if mouse-face was overwritten. */
25844 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25846 xassert (row
->enabled_p
);
25848 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25849 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25850 0, row
->used
[TEXT_AREA
],
25851 DRAW_NORMAL_TEXT
, 0);
25854 if (row
->used
[LEFT_MARGIN_AREA
])
25855 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25856 if (row
->used
[TEXT_AREA
])
25857 expose_area (w
, row
, r
, TEXT_AREA
);
25858 if (row
->used
[RIGHT_MARGIN_AREA
])
25859 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25860 draw_row_fringe_bitmaps (w
, row
);
25863 return row
->mouse_face_p
;
25867 /* Redraw those parts of glyphs rows during expose event handling that
25868 overlap other rows. Redrawing of an exposed line writes over parts
25869 of lines overlapping that exposed line; this function fixes that.
25871 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25872 row in W's current matrix that is exposed and overlaps other rows.
25873 LAST_OVERLAPPING_ROW is the last such row. */
25876 expose_overlaps (struct window
*w
,
25877 struct glyph_row
*first_overlapping_row
,
25878 struct glyph_row
*last_overlapping_row
,
25881 struct glyph_row
*row
;
25883 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25884 if (row
->overlapping_p
)
25886 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25889 if (row
->used
[LEFT_MARGIN_AREA
])
25890 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25892 if (row
->used
[TEXT_AREA
])
25893 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25895 if (row
->used
[RIGHT_MARGIN_AREA
])
25896 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25902 /* Return non-zero if W's cursor intersects rectangle R. */
25905 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25907 XRectangle cr
, result
;
25908 struct glyph
*cursor_glyph
;
25909 struct glyph_row
*row
;
25911 if (w
->phys_cursor
.vpos
>= 0
25912 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25913 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25915 && row
->cursor_in_fringe_p
)
25917 /* Cursor is in the fringe. */
25918 cr
.x
= window_box_right_offset (w
,
25919 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25920 ? RIGHT_MARGIN_AREA
25923 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25924 cr
.height
= row
->height
;
25925 return x_intersect_rectangles (&cr
, r
, &result
);
25928 cursor_glyph
= get_phys_cursor_glyph (w
);
25931 /* r is relative to W's box, but w->phys_cursor.x is relative
25932 to left edge of W's TEXT area. Adjust it. */
25933 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25934 cr
.y
= w
->phys_cursor
.y
;
25935 cr
.width
= cursor_glyph
->pixel_width
;
25936 cr
.height
= w
->phys_cursor_height
;
25937 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25938 I assume the effect is the same -- and this is portable. */
25939 return x_intersect_rectangles (&cr
, r
, &result
);
25941 /* If we don't understand the format, pretend we're not in the hot-spot. */
25947 Draw a vertical window border to the right of window W if W doesn't
25948 have vertical scroll bars. */
25951 x_draw_vertical_border (struct window
*w
)
25953 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25955 /* We could do better, if we knew what type of scroll-bar the adjacent
25956 windows (on either side) have... But we don't :-(
25957 However, I think this works ok. ++KFS 2003-04-25 */
25959 /* Redraw borders between horizontally adjacent windows. Don't
25960 do it for frames with vertical scroll bars because either the
25961 right scroll bar of a window, or the left scroll bar of its
25962 neighbor will suffice as a border. */
25963 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25966 if (!WINDOW_RIGHTMOST_P (w
)
25967 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25969 int x0
, x1
, y0
, y1
;
25971 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25974 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25977 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25979 else if (!WINDOW_LEFTMOST_P (w
)
25980 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25982 int x0
, x1
, y0
, y1
;
25984 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25987 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25990 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25995 /* Redraw the part of window W intersection rectangle FR. Pixel
25996 coordinates in FR are frame-relative. Call this function with
25997 input blocked. Value is non-zero if the exposure overwrites
26001 expose_window (struct window
*w
, XRectangle
*fr
)
26003 struct frame
*f
= XFRAME (w
->frame
);
26005 int mouse_face_overwritten_p
= 0;
26007 /* If window is not yet fully initialized, do nothing. This can
26008 happen when toolkit scroll bars are used and a window is split.
26009 Reconfiguring the scroll bar will generate an expose for a newly
26011 if (w
->current_matrix
== NULL
)
26014 /* When we're currently updating the window, display and current
26015 matrix usually don't agree. Arrange for a thorough display
26017 if (w
== updated_window
)
26019 SET_FRAME_GARBAGED (f
);
26023 /* Frame-relative pixel rectangle of W. */
26024 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26025 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26026 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26027 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26029 if (x_intersect_rectangles (fr
, &wr
, &r
))
26031 int yb
= window_text_bottom_y (w
);
26032 struct glyph_row
*row
;
26033 int cursor_cleared_p
;
26034 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26036 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26037 r
.x
, r
.y
, r
.width
, r
.height
));
26039 /* Convert to window coordinates. */
26040 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26041 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26043 /* Turn off the cursor. */
26044 if (!w
->pseudo_window_p
26045 && phys_cursor_in_rect_p (w
, &r
))
26047 x_clear_cursor (w
);
26048 cursor_cleared_p
= 1;
26051 cursor_cleared_p
= 0;
26053 /* Update lines intersecting rectangle R. */
26054 first_overlapping_row
= last_overlapping_row
= NULL
;
26055 for (row
= w
->current_matrix
->rows
;
26060 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26062 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26063 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26064 || (r
.y
>= y0
&& r
.y
< y1
)
26065 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26067 /* A header line may be overlapping, but there is no need
26068 to fix overlapping areas for them. KFS 2005-02-12 */
26069 if (row
->overlapping_p
&& !row
->mode_line_p
)
26071 if (first_overlapping_row
== NULL
)
26072 first_overlapping_row
= row
;
26073 last_overlapping_row
= row
;
26077 if (expose_line (w
, row
, &r
))
26078 mouse_face_overwritten_p
= 1;
26081 else if (row
->overlapping_p
)
26083 /* We must redraw a row overlapping the exposed area. */
26085 ? y0
+ row
->phys_height
> r
.y
26086 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26088 if (first_overlapping_row
== NULL
)
26089 first_overlapping_row
= row
;
26090 last_overlapping_row
= row
;
26098 /* Display the mode line if there is one. */
26099 if (WINDOW_WANTS_MODELINE_P (w
)
26100 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26102 && row
->y
< r
.y
+ r
.height
)
26104 if (expose_line (w
, row
, &r
))
26105 mouse_face_overwritten_p
= 1;
26108 if (!w
->pseudo_window_p
)
26110 /* Fix the display of overlapping rows. */
26111 if (first_overlapping_row
)
26112 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26115 /* Draw border between windows. */
26116 x_draw_vertical_border (w
);
26118 /* Turn the cursor on again. */
26119 if (cursor_cleared_p
)
26120 update_window_cursor (w
, 1);
26124 return mouse_face_overwritten_p
;
26129 /* Redraw (parts) of all windows in the window tree rooted at W that
26130 intersect R. R contains frame pixel coordinates. Value is
26131 non-zero if the exposure overwrites mouse-face. */
26134 expose_window_tree (struct window
*w
, XRectangle
*r
)
26136 struct frame
*f
= XFRAME (w
->frame
);
26137 int mouse_face_overwritten_p
= 0;
26139 while (w
&& !FRAME_GARBAGED_P (f
))
26141 if (!NILP (w
->hchild
))
26142 mouse_face_overwritten_p
26143 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26144 else if (!NILP (w
->vchild
))
26145 mouse_face_overwritten_p
26146 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26148 mouse_face_overwritten_p
|= expose_window (w
, r
);
26150 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26153 return mouse_face_overwritten_p
;
26158 Redisplay an exposed area of frame F. X and Y are the upper-left
26159 corner of the exposed rectangle. W and H are width and height of
26160 the exposed area. All are pixel values. W or H zero means redraw
26161 the entire frame. */
26164 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26167 int mouse_face_overwritten_p
= 0;
26169 TRACE ((stderr
, "expose_frame "));
26171 /* No need to redraw if frame will be redrawn soon. */
26172 if (FRAME_GARBAGED_P (f
))
26174 TRACE ((stderr
, " garbaged\n"));
26178 /* If basic faces haven't been realized yet, there is no point in
26179 trying to redraw anything. This can happen when we get an expose
26180 event while Emacs is starting, e.g. by moving another window. */
26181 if (FRAME_FACE_CACHE (f
) == NULL
26182 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26184 TRACE ((stderr
, " no faces\n"));
26188 if (w
== 0 || h
== 0)
26191 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26192 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26202 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26203 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26205 if (WINDOWP (f
->tool_bar_window
))
26206 mouse_face_overwritten_p
26207 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26209 #ifdef HAVE_X_WINDOWS
26211 #ifndef USE_X_TOOLKIT
26212 if (WINDOWP (f
->menu_bar_window
))
26213 mouse_face_overwritten_p
26214 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26215 #endif /* not USE_X_TOOLKIT */
26219 /* Some window managers support a focus-follows-mouse style with
26220 delayed raising of frames. Imagine a partially obscured frame,
26221 and moving the mouse into partially obscured mouse-face on that
26222 frame. The visible part of the mouse-face will be highlighted,
26223 then the WM raises the obscured frame. With at least one WM, KDE
26224 2.1, Emacs is not getting any event for the raising of the frame
26225 (even tried with SubstructureRedirectMask), only Expose events.
26226 These expose events will draw text normally, i.e. not
26227 highlighted. Which means we must redo the highlight here.
26228 Subsume it under ``we love X''. --gerd 2001-08-15 */
26229 /* Included in Windows version because Windows most likely does not
26230 do the right thing if any third party tool offers
26231 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26232 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26234 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26235 if (f
== hlinfo
->mouse_face_mouse_frame
)
26237 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26238 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26239 clear_mouse_face (hlinfo
);
26240 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26247 Determine the intersection of two rectangles R1 and R2. Return
26248 the intersection in *RESULT. Value is non-zero if RESULT is not
26252 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26254 XRectangle
*left
, *right
;
26255 XRectangle
*upper
, *lower
;
26256 int intersection_p
= 0;
26258 /* Rearrange so that R1 is the left-most rectangle. */
26260 left
= r1
, right
= r2
;
26262 left
= r2
, right
= r1
;
26264 /* X0 of the intersection is right.x0, if this is inside R1,
26265 otherwise there is no intersection. */
26266 if (right
->x
<= left
->x
+ left
->width
)
26268 result
->x
= right
->x
;
26270 /* The right end of the intersection is the minimum of the
26271 the right ends of left and right. */
26272 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26275 /* Same game for Y. */
26277 upper
= r1
, lower
= r2
;
26279 upper
= r2
, lower
= r1
;
26281 /* The upper end of the intersection is lower.y0, if this is inside
26282 of upper. Otherwise, there is no intersection. */
26283 if (lower
->y
<= upper
->y
+ upper
->height
)
26285 result
->y
= lower
->y
;
26287 /* The lower end of the intersection is the minimum of the lower
26288 ends of upper and lower. */
26289 result
->height
= (min (lower
->y
+ lower
->height
,
26290 upper
->y
+ upper
->height
)
26292 intersection_p
= 1;
26296 return intersection_p
;
26299 #endif /* HAVE_WINDOW_SYSTEM */
26302 /***********************************************************************
26304 ***********************************************************************/
26307 syms_of_xdisp (void)
26309 Vwith_echo_area_save_vector
= Qnil
;
26310 staticpro (&Vwith_echo_area_save_vector
);
26312 Vmessage_stack
= Qnil
;
26313 staticpro (&Vmessage_stack
);
26315 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26316 staticpro (&Qinhibit_redisplay
);
26318 message_dolog_marker1
= Fmake_marker ();
26319 staticpro (&message_dolog_marker1
);
26320 message_dolog_marker2
= Fmake_marker ();
26321 staticpro (&message_dolog_marker2
);
26322 message_dolog_marker3
= Fmake_marker ();
26323 staticpro (&message_dolog_marker3
);
26326 defsubr (&Sdump_frame_glyph_matrix
);
26327 defsubr (&Sdump_glyph_matrix
);
26328 defsubr (&Sdump_glyph_row
);
26329 defsubr (&Sdump_tool_bar_row
);
26330 defsubr (&Strace_redisplay
);
26331 defsubr (&Strace_to_stderr
);
26333 #ifdef HAVE_WINDOW_SYSTEM
26334 defsubr (&Stool_bar_lines_needed
);
26335 defsubr (&Slookup_image_map
);
26337 defsubr (&Sformat_mode_line
);
26338 defsubr (&Sinvisible_p
);
26339 defsubr (&Scurrent_bidi_paragraph_direction
);
26341 staticpro (&Qmenu_bar_update_hook
);
26342 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26344 staticpro (&Qoverriding_terminal_local_map
);
26345 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26347 staticpro (&Qoverriding_local_map
);
26348 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26350 staticpro (&Qwindow_scroll_functions
);
26351 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26353 staticpro (&Qwindow_text_change_functions
);
26354 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26356 staticpro (&Qredisplay_end_trigger_functions
);
26357 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26359 staticpro (&Qinhibit_point_motion_hooks
);
26360 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26362 Qeval
= intern_c_string ("eval");
26363 staticpro (&Qeval
);
26365 QCdata
= intern_c_string (":data");
26366 staticpro (&QCdata
);
26367 Qdisplay
= intern_c_string ("display");
26368 staticpro (&Qdisplay
);
26369 Qspace_width
= intern_c_string ("space-width");
26370 staticpro (&Qspace_width
);
26371 Qraise
= intern_c_string ("raise");
26372 staticpro (&Qraise
);
26373 Qslice
= intern_c_string ("slice");
26374 staticpro (&Qslice
);
26375 Qspace
= intern_c_string ("space");
26376 staticpro (&Qspace
);
26377 Qmargin
= intern_c_string ("margin");
26378 staticpro (&Qmargin
);
26379 Qpointer
= intern_c_string ("pointer");
26380 staticpro (&Qpointer
);
26381 Qleft_margin
= intern_c_string ("left-margin");
26382 staticpro (&Qleft_margin
);
26383 Qright_margin
= intern_c_string ("right-margin");
26384 staticpro (&Qright_margin
);
26385 Qcenter
= intern_c_string ("center");
26386 staticpro (&Qcenter
);
26387 Qline_height
= intern_c_string ("line-height");
26388 staticpro (&Qline_height
);
26389 QCalign_to
= intern_c_string (":align-to");
26390 staticpro (&QCalign_to
);
26391 QCrelative_width
= intern_c_string (":relative-width");
26392 staticpro (&QCrelative_width
);
26393 QCrelative_height
= intern_c_string (":relative-height");
26394 staticpro (&QCrelative_height
);
26395 QCeval
= intern_c_string (":eval");
26396 staticpro (&QCeval
);
26397 QCpropertize
= intern_c_string (":propertize");
26398 staticpro (&QCpropertize
);
26399 QCfile
= intern_c_string (":file");
26400 staticpro (&QCfile
);
26401 Qfontified
= intern_c_string ("fontified");
26402 staticpro (&Qfontified
);
26403 Qfontification_functions
= intern_c_string ("fontification-functions");
26404 staticpro (&Qfontification_functions
);
26405 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26406 staticpro (&Qtrailing_whitespace
);
26407 Qescape_glyph
= intern_c_string ("escape-glyph");
26408 staticpro (&Qescape_glyph
);
26409 Qnobreak_space
= intern_c_string ("nobreak-space");
26410 staticpro (&Qnobreak_space
);
26411 Qimage
= intern_c_string ("image");
26412 staticpro (&Qimage
);
26413 Qtext
= intern_c_string ("text");
26414 staticpro (&Qtext
);
26415 Qboth
= intern_c_string ("both");
26416 staticpro (&Qboth
);
26417 Qboth_horiz
= intern_c_string ("both-horiz");
26418 staticpro (&Qboth_horiz
);
26419 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26420 staticpro (&Qtext_image_horiz
);
26421 QCmap
= intern_c_string (":map");
26422 staticpro (&QCmap
);
26423 QCpointer
= intern_c_string (":pointer");
26424 staticpro (&QCpointer
);
26425 Qrect
= intern_c_string ("rect");
26426 staticpro (&Qrect
);
26427 Qcircle
= intern_c_string ("circle");
26428 staticpro (&Qcircle
);
26429 Qpoly
= intern_c_string ("poly");
26430 staticpro (&Qpoly
);
26431 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26432 staticpro (&Qmessage_truncate_lines
);
26433 Qgrow_only
= intern_c_string ("grow-only");
26434 staticpro (&Qgrow_only
);
26435 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26436 staticpro (&Qinhibit_menubar_update
);
26437 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26438 staticpro (&Qinhibit_eval_during_redisplay
);
26439 Qposition
= intern_c_string ("position");
26440 staticpro (&Qposition
);
26441 Qbuffer_position
= intern_c_string ("buffer-position");
26442 staticpro (&Qbuffer_position
);
26443 Qobject
= intern_c_string ("object");
26444 staticpro (&Qobject
);
26445 Qbar
= intern_c_string ("bar");
26447 Qhbar
= intern_c_string ("hbar");
26448 staticpro (&Qhbar
);
26449 Qbox
= intern_c_string ("box");
26451 Qhollow
= intern_c_string ("hollow");
26452 staticpro (&Qhollow
);
26453 Qhand
= intern_c_string ("hand");
26454 staticpro (&Qhand
);
26455 Qarrow
= intern_c_string ("arrow");
26456 staticpro (&Qarrow
);
26457 Qtext
= intern_c_string ("text");
26458 staticpro (&Qtext
);
26459 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26460 staticpro (&Qinhibit_free_realized_faces
);
26462 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26463 Fcons (intern_c_string ("void-variable"), Qnil
)),
26465 staticpro (&list_of_error
);
26467 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26468 staticpro (&Qlast_arrow_position
);
26469 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26470 staticpro (&Qlast_arrow_string
);
26472 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26473 staticpro (&Qoverlay_arrow_string
);
26474 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26475 staticpro (&Qoverlay_arrow_bitmap
);
26477 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26478 staticpro (&echo_buffer
[0]);
26479 staticpro (&echo_buffer
[1]);
26481 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26482 staticpro (&echo_area_buffer
[0]);
26483 staticpro (&echo_area_buffer
[1]);
26485 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26486 staticpro (&Vmessages_buffer_name
);
26488 mode_line_proptrans_alist
= Qnil
;
26489 staticpro (&mode_line_proptrans_alist
);
26490 mode_line_string_list
= Qnil
;
26491 staticpro (&mode_line_string_list
);
26492 mode_line_string_face
= Qnil
;
26493 staticpro (&mode_line_string_face
);
26494 mode_line_string_face_prop
= Qnil
;
26495 staticpro (&mode_line_string_face_prop
);
26496 Vmode_line_unwind_vector
= Qnil
;
26497 staticpro (&Vmode_line_unwind_vector
);
26499 help_echo_string
= Qnil
;
26500 staticpro (&help_echo_string
);
26501 help_echo_object
= Qnil
;
26502 staticpro (&help_echo_object
);
26503 help_echo_window
= Qnil
;
26504 staticpro (&help_echo_window
);
26505 previous_help_echo_string
= Qnil
;
26506 staticpro (&previous_help_echo_string
);
26507 help_echo_pos
= -1;
26509 Qright_to_left
= intern_c_string ("right-to-left");
26510 staticpro (&Qright_to_left
);
26511 Qleft_to_right
= intern_c_string ("left-to-right");
26512 staticpro (&Qleft_to_right
);
26514 #ifdef HAVE_WINDOW_SYSTEM
26515 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26516 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26517 For example, if a block cursor is over a tab, it will be drawn as
26518 wide as that tab on the display. */);
26519 x_stretch_cursor_p
= 0;
26522 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26523 doc
: /* *Non-nil means highlight trailing whitespace.
26524 The face used for trailing whitespace is `trailing-whitespace'. */);
26525 Vshow_trailing_whitespace
= Qnil
;
26527 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26528 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26529 A value of t means highlight the character itself (for nobreak space,
26530 use face `nobreak-space').
26531 A value of nil means no highlighting.
26532 Other values mean display the escape glyph followed by an ordinary
26533 space or ordinary hyphen. */);
26534 Vnobreak_char_display
= Qt
;
26536 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26537 doc
: /* *The pointer shape to show in void text areas.
26538 A value of nil means to show the text pointer. Other options are `arrow',
26539 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26540 Vvoid_text_area_pointer
= Qarrow
;
26542 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26543 doc
: /* Non-nil means don't actually do any redisplay.
26544 This is used for internal purposes. */);
26545 Vinhibit_redisplay
= Qnil
;
26547 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26548 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26549 Vglobal_mode_string
= Qnil
;
26551 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26552 doc
: /* Marker for where to display an arrow on top of the buffer text.
26553 This must be the beginning of a line in order to work.
26554 See also `overlay-arrow-string'. */);
26555 Voverlay_arrow_position
= Qnil
;
26557 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26558 doc
: /* String to display as an arrow in non-window frames.
26559 See also `overlay-arrow-position'. */);
26560 Voverlay_arrow_string
= make_pure_c_string ("=>");
26562 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26563 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26564 The symbols on this list are examined during redisplay to determine
26565 where to display overlay arrows. */);
26566 Voverlay_arrow_variable_list
26567 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26569 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26570 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26571 If that fails to bring point back on frame, point is centered instead.
26572 If this is zero, point is always centered after it moves off frame.
26573 If you want scrolling to always be a line at a time, you should set
26574 `scroll-conservatively' to a large value rather than set this to 1. */);
26576 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26577 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26578 If point moves off-screen, redisplay will scroll by up to
26579 `scroll-conservatively' lines in order to bring point just barely
26580 onto the screen again. If that cannot be done, then redisplay
26581 recenters point as usual.
26583 A value of zero means always recenter point if it moves off screen. */);
26584 scroll_conservatively
= 0;
26586 DEFVAR_INT ("scroll-margin", scroll_margin
,
26587 doc
: /* *Number of lines of margin at the top and bottom of a window.
26588 Recenter the window whenever point gets within this many lines
26589 of the top or bottom of the window. */);
26592 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26593 doc
: /* Pixels per inch value for non-window system displays.
26594 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26595 Vdisplay_pixels_per_inch
= make_float (72.0);
26598 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26601 DEFVAR_LISP ("truncate-partial-width-windows",
26602 Vtruncate_partial_width_windows
,
26603 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26604 For an integer value, truncate lines in each window narrower than the
26605 full frame width, provided the window width is less than that integer;
26606 otherwise, respect the value of `truncate-lines'.
26608 For any other non-nil value, truncate lines in all windows that do
26609 not span the full frame width.
26611 A value of nil means to respect the value of `truncate-lines'.
26613 If `word-wrap' is enabled, you might want to reduce this. */);
26614 Vtruncate_partial_width_windows
= make_number (50);
26616 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26617 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26618 Any other value means to use the appropriate face, `mode-line',
26619 `header-line', or `menu' respectively. */);
26620 mode_line_inverse_video
= 1;
26622 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26623 doc
: /* *Maximum buffer size for which line number should be displayed.
26624 If the buffer is bigger than this, the line number does not appear
26625 in the mode line. A value of nil means no limit. */);
26626 Vline_number_display_limit
= Qnil
;
26628 DEFVAR_INT ("line-number-display-limit-width",
26629 line_number_display_limit_width
,
26630 doc
: /* *Maximum line width (in characters) for line number display.
26631 If the average length of the lines near point is bigger than this, then the
26632 line number may be omitted from the mode line. */);
26633 line_number_display_limit_width
= 200;
26635 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26636 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26637 highlight_nonselected_windows
= 0;
26639 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26640 doc
: /* Non-nil if more than one frame is visible on this display.
26641 Minibuffer-only frames don't count, but iconified frames do.
26642 This variable is not guaranteed to be accurate except while processing
26643 `frame-title-format' and `icon-title-format'. */);
26645 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26646 doc
: /* Template for displaying the title bar of visible frames.
26647 \(Assuming the window manager supports this feature.)
26649 This variable has the same structure as `mode-line-format', except that
26650 the %c and %l constructs are ignored. It is used only on frames for
26651 which no explicit name has been set \(see `modify-frame-parameters'). */);
26653 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26654 doc
: /* Template for displaying the title bar of an iconified frame.
26655 \(Assuming the window manager supports this feature.)
26656 This variable has the same structure as `mode-line-format' (which see),
26657 and is used only on frames for which no explicit name has been set
26658 \(see `modify-frame-parameters'). */);
26660 = Vframe_title_format
26661 = pure_cons (intern_c_string ("multiple-frames"),
26662 pure_cons (make_pure_c_string ("%b"),
26663 pure_cons (pure_cons (empty_unibyte_string
,
26664 pure_cons (intern_c_string ("invocation-name"),
26665 pure_cons (make_pure_c_string ("@"),
26666 pure_cons (intern_c_string ("system-name"),
26670 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26671 doc
: /* Maximum number of lines to keep in the message log buffer.
26672 If nil, disable message logging. If t, log messages but don't truncate
26673 the buffer when it becomes large. */);
26674 Vmessage_log_max
= make_number (100);
26676 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26677 doc
: /* Functions called before redisplay, if window sizes have changed.
26678 The value should be a list of functions that take one argument.
26679 Just before redisplay, for each frame, if any of its windows have changed
26680 size since the last redisplay, or have been split or deleted,
26681 all the functions in the list are called, with the frame as argument. */);
26682 Vwindow_size_change_functions
= Qnil
;
26684 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26685 doc
: /* List of functions to call before redisplaying a window with scrolling.
26686 Each function is called with two arguments, the window and its new
26687 display-start position. Note that these functions are also called by
26688 `set-window-buffer'. Also note that the value of `window-end' is not
26689 valid when these functions are called. */);
26690 Vwindow_scroll_functions
= Qnil
;
26692 DEFVAR_LISP ("window-text-change-functions",
26693 Vwindow_text_change_functions
,
26694 doc
: /* Functions to call in redisplay when text in the window might change. */);
26695 Vwindow_text_change_functions
= Qnil
;
26697 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26698 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26699 Each function is called with two arguments, the window and the end trigger value.
26700 See `set-window-redisplay-end-trigger'. */);
26701 Vredisplay_end_trigger_functions
= Qnil
;
26703 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26704 doc
: /* *Non-nil means autoselect window with mouse pointer.
26705 If nil, do not autoselect windows.
26706 A positive number means delay autoselection by that many seconds: a
26707 window is autoselected only after the mouse has remained in that
26708 window for the duration of the delay.
26709 A negative number has a similar effect, but causes windows to be
26710 autoselected only after the mouse has stopped moving. \(Because of
26711 the way Emacs compares mouse events, you will occasionally wait twice
26712 that time before the window gets selected.\)
26713 Any other value means to autoselect window instantaneously when the
26714 mouse pointer enters it.
26716 Autoselection selects the minibuffer only if it is active, and never
26717 unselects the minibuffer if it is active.
26719 When customizing this variable make sure that the actual value of
26720 `focus-follows-mouse' matches the behavior of your window manager. */);
26721 Vmouse_autoselect_window
= Qnil
;
26723 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26724 doc
: /* *Non-nil means automatically resize tool-bars.
26725 This dynamically changes the tool-bar's height to the minimum height
26726 that is needed to make all tool-bar items visible.
26727 If value is `grow-only', the tool-bar's height is only increased
26728 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26729 Vauto_resize_tool_bars
= Qt
;
26731 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26732 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26733 auto_raise_tool_bar_buttons_p
= 1;
26735 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26736 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26737 make_cursor_line_fully_visible_p
= 1;
26739 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26740 doc
: /* *Border below tool-bar in pixels.
26741 If an integer, use it as the height of the border.
26742 If it is one of `internal-border-width' or `border-width', use the
26743 value of the corresponding frame parameter.
26744 Otherwise, no border is added below the tool-bar. */);
26745 Vtool_bar_border
= Qinternal_border_width
;
26747 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26748 doc
: /* *Margin around tool-bar buttons in pixels.
26749 If an integer, use that for both horizontal and vertical margins.
26750 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26751 HORZ specifying the horizontal margin, and VERT specifying the
26752 vertical margin. */);
26753 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26755 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26756 doc
: /* *Relief thickness of tool-bar buttons. */);
26757 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26759 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26760 doc
: /* Tool bar style to use.
26762 image - show images only
26763 text - show text only
26764 both - show both, text below image
26765 both-horiz - show text to the right of the image
26766 text-image-horiz - show text to the left of the image
26767 any other - use system default or image if no system default. */);
26768 Vtool_bar_style
= Qnil
;
26770 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26771 doc
: /* *Maximum number of characters a label can have to be shown.
26772 The tool bar style must also show labels for this to have any effect, see
26773 `tool-bar-style'. */);
26774 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26776 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26777 doc
: /* List of functions to call to fontify regions of text.
26778 Each function is called with one argument POS. Functions must
26779 fontify a region starting at POS in the current buffer, and give
26780 fontified regions the property `fontified'. */);
26781 Vfontification_functions
= Qnil
;
26782 Fmake_variable_buffer_local (Qfontification_functions
);
26784 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26785 unibyte_display_via_language_environment
,
26786 doc
: /* *Non-nil means display unibyte text according to language environment.
26787 Specifically, this means that raw bytes in the range 160-255 decimal
26788 are displayed by converting them to the equivalent multibyte characters
26789 according to the current language environment. As a result, they are
26790 displayed according to the current fontset.
26792 Note that this variable affects only how these bytes are displayed,
26793 but does not change the fact they are interpreted as raw bytes. */);
26794 unibyte_display_via_language_environment
= 0;
26796 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26797 doc
: /* *Maximum height for resizing mini-windows.
26798 If a float, it specifies a fraction of the mini-window frame's height.
26799 If an integer, it specifies a number of lines. */);
26800 Vmax_mini_window_height
= make_float (0.25);
26802 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26803 doc
: /* *How to resize mini-windows.
26804 A value of nil means don't automatically resize mini-windows.
26805 A value of t means resize them to fit the text displayed in them.
26806 A value of `grow-only', the default, means let mini-windows grow
26807 only, until their display becomes empty, at which point the windows
26808 go back to their normal size. */);
26809 Vresize_mini_windows
= Qgrow_only
;
26811 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26812 doc
: /* Alist specifying how to blink the cursor off.
26813 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26814 `cursor-type' frame-parameter or variable equals ON-STATE,
26815 comparing using `equal', Emacs uses OFF-STATE to specify
26816 how to blink it off. ON-STATE and OFF-STATE are values for
26817 the `cursor-type' frame parameter.
26819 If a frame's ON-STATE has no entry in this list,
26820 the frame's other specifications determine how to blink the cursor off. */);
26821 Vblink_cursor_alist
= Qnil
;
26823 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26824 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26825 If non-nil, windows are automatically scrolled horizontally to make
26826 point visible. */);
26827 automatic_hscrolling_p
= 1;
26828 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26829 staticpro (&Qauto_hscroll_mode
);
26831 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26832 doc
: /* *How many columns away from the window edge point is allowed to get
26833 before automatic hscrolling will horizontally scroll the window. */);
26834 hscroll_margin
= 5;
26836 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26837 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26838 When point is less than `hscroll-margin' columns from the window
26839 edge, automatic hscrolling will scroll the window by the amount of columns
26840 determined by this variable. If its value is a positive integer, scroll that
26841 many columns. If it's a positive floating-point number, it specifies the
26842 fraction of the window's width to scroll. If it's nil or zero, point will be
26843 centered horizontally after the scroll. Any other value, including negative
26844 numbers, are treated as if the value were zero.
26846 Automatic hscrolling always moves point outside the scroll margin, so if
26847 point was more than scroll step columns inside the margin, the window will
26848 scroll more than the value given by the scroll step.
26850 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26851 and `scroll-right' overrides this variable's effect. */);
26852 Vhscroll_step
= make_number (0);
26854 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26855 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26856 Bind this around calls to `message' to let it take effect. */);
26857 message_truncate_lines
= 0;
26859 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26860 doc
: /* Normal hook run to update the menu bar definitions.
26861 Redisplay runs this hook before it redisplays the menu bar.
26862 This is used to update submenus such as Buffers,
26863 whose contents depend on various data. */);
26864 Vmenu_bar_update_hook
= Qnil
;
26866 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26867 doc
: /* Frame for which we are updating a menu.
26868 The enable predicate for a menu binding should check this variable. */);
26869 Vmenu_updating_frame
= Qnil
;
26871 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26872 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26873 inhibit_menubar_update
= 0;
26875 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26876 doc
: /* Prefix prepended to all continuation lines at display time.
26877 The value may be a string, an image, or a stretch-glyph; it is
26878 interpreted in the same way as the value of a `display' text property.
26880 This variable is overridden by any `wrap-prefix' text or overlay
26883 To add a prefix to non-continuation lines, use `line-prefix'. */);
26884 Vwrap_prefix
= Qnil
;
26885 staticpro (&Qwrap_prefix
);
26886 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26887 Fmake_variable_buffer_local (Qwrap_prefix
);
26889 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26890 doc
: /* Prefix prepended to all non-continuation lines at display time.
26891 The value may be a string, an image, or a stretch-glyph; it is
26892 interpreted in the same way as the value of a `display' text property.
26894 This variable is overridden by any `line-prefix' text or overlay
26897 To add a prefix to continuation lines, use `wrap-prefix'. */);
26898 Vline_prefix
= Qnil
;
26899 staticpro (&Qline_prefix
);
26900 Qline_prefix
= intern_c_string ("line-prefix");
26901 Fmake_variable_buffer_local (Qline_prefix
);
26903 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26904 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26905 inhibit_eval_during_redisplay
= 0;
26907 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26908 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26909 inhibit_free_realized_faces
= 0;
26912 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26913 doc
: /* Inhibit try_window_id display optimization. */);
26914 inhibit_try_window_id
= 0;
26916 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26917 doc
: /* Inhibit try_window_reusing display optimization. */);
26918 inhibit_try_window_reusing
= 0;
26920 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26921 doc
: /* Inhibit try_cursor_movement display optimization. */);
26922 inhibit_try_cursor_movement
= 0;
26923 #endif /* GLYPH_DEBUG */
26925 DEFVAR_INT ("overline-margin", overline_margin
,
26926 doc
: /* *Space between overline and text, in pixels.
26927 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26928 margin to the caracter height. */);
26929 overline_margin
= 2;
26931 DEFVAR_INT ("underline-minimum-offset",
26932 underline_minimum_offset
,
26933 doc
: /* Minimum distance between baseline and underline.
26934 This can improve legibility of underlined text at small font sizes,
26935 particularly when using variable `x-use-underline-position-properties'
26936 with fonts that specify an UNDERLINE_POSITION relatively close to the
26937 baseline. The default value is 1. */);
26938 underline_minimum_offset
= 1;
26940 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26941 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26942 This feature only works when on a window system that can change
26943 cursor shapes. */);
26944 display_hourglass_p
= 1;
26946 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26947 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26948 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26950 hourglass_atimer
= NULL
;
26951 hourglass_shown_p
= 0;
26953 DEFSYM (Qglyphless_char
, "glyphless-char");
26954 DEFSYM (Qhex_code
, "hex-code");
26955 DEFSYM (Qempty_box
, "empty-box");
26956 DEFSYM (Qthin_space
, "thin-space");
26957 DEFSYM (Qzero_width
, "zero-width");
26959 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26960 /* Intern this now in case it isn't already done.
26961 Setting this variable twice is harmless.
26962 But don't staticpro it here--that is done in alloc.c. */
26963 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26964 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26966 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26967 doc
: /* Char-table to control displaying of glyphless characters.
26968 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26969 or one of these symbols:
26970 hex-code: display the hexadecimal code of a character in a box
26971 empty-box: display as an empty box
26972 thin-space: display as 1-pixel width space
26973 zero-width: don't display
26975 It has one extra slot to control the display of a character for which
26976 no font is found. The value of the slot is `hex-code' or `empty-box'.
26977 The default is `empty-box'. */);
26978 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26979 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26984 /* Initialize this module when Emacs starts. */
26989 Lisp_Object root_window
;
26990 struct window
*mini_w
;
26992 current_header_line_height
= current_mode_line_height
= -1;
26994 CHARPOS (this_line_start_pos
) = 0;
26996 mini_w
= XWINDOW (minibuf_window
);
26997 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26999 if (!noninteractive
)
27001 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27004 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27005 set_window_height (root_window
,
27006 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27008 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27009 set_window_height (minibuf_window
, 1, 0);
27011 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27012 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27014 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27015 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27016 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27018 /* The default ellipsis glyphs `...'. */
27019 for (i
= 0; i
< 3; ++i
)
27020 default_invis_vector
[i
] = make_number ('.');
27024 /* Allocate the buffer for frame titles.
27025 Also used for `format-mode-line'. */
27027 mode_line_noprop_buf
= (char *) xmalloc (size
);
27028 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27029 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27030 mode_line_target
= MODE_LINE_DISPLAY
;
27033 help_echo_showing_p
= 0;
27036 /* Since w32 does not support atimers, it defines its own implementation of
27037 the following three functions in w32fns.c. */
27040 /* Platform-independent portion of hourglass implementation. */
27042 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27044 hourglass_started (void)
27046 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27049 /* Cancel a currently active hourglass timer, and start a new one. */
27051 start_hourglass (void)
27053 #if defined (HAVE_WINDOW_SYSTEM)
27055 int secs
, usecs
= 0;
27057 cancel_hourglass ();
27059 if (INTEGERP (Vhourglass_delay
)
27060 && XINT (Vhourglass_delay
) > 0)
27061 secs
= XFASTINT (Vhourglass_delay
);
27062 else if (FLOATP (Vhourglass_delay
)
27063 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27066 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27067 secs
= XFASTINT (tem
);
27068 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27071 secs
= DEFAULT_HOURGLASS_DELAY
;
27073 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27074 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27075 show_hourglass
, NULL
);
27080 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27083 cancel_hourglass (void)
27085 #if defined (HAVE_WINDOW_SYSTEM)
27086 if (hourglass_atimer
)
27088 cancel_atimer (hourglass_atimer
);
27089 hourglass_atimer
= NULL
;
27092 if (hourglass_shown_p
)
27096 #endif /* ! WINDOWSNT */