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 /* Prompt to display in front of the mini-buffer contents. */
488 Lisp_Object minibuf_prompt
;
490 /* Width of current mini-buffer prompt. Only set after display_line
491 of the line that contains the prompt. */
493 int minibuf_prompt_width
;
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 Lisp_Object Qinhibit_menubar_update
;
561 Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
599 /* Non-zero means print traces of redisplay if compiled with
602 int trace_redisplay_p
;
604 #endif /* GLYPH_DEBUG */
606 #ifdef DEBUG_TRACE_MOVE
607 /* Non-zero means trace with TRACE_MOVE to stderr. */
610 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
612 #define TRACE_MOVE(x) (void) 0
615 Lisp_Object Qauto_hscroll_mode
;
617 /* Buffer being redisplayed -- for redisplay_window_error. */
619 struct buffer
*displayed_buffer
;
621 /* Value returned from text property handlers (see below). */
626 HANDLED_RECOMPUTE_PROPS
,
627 HANDLED_OVERLAY_STRING_CONSUMED
,
631 /* A description of text properties that redisplay is interested
636 /* The name of the property. */
639 /* A unique index for the property. */
642 /* A handler function called to set up iterator IT from the property
643 at IT's current position. Value is used to steer handle_stop. */
644 enum prop_handled (*handler
) (struct it
*it
);
647 static enum prop_handled
handle_face_prop (struct it
*);
648 static enum prop_handled
handle_invisible_prop (struct it
*);
649 static enum prop_handled
handle_display_prop (struct it
*);
650 static enum prop_handled
handle_composition_prop (struct it
*);
651 static enum prop_handled
handle_overlay_change (struct it
*);
652 static enum prop_handled
handle_fontified_prop (struct it
*);
654 /* Properties handled by iterators. */
656 static struct props it_props
[] =
658 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
659 /* Handle `face' before `display' because some sub-properties of
660 `display' need to know the face. */
661 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
662 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
663 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
664 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
668 /* Value is the position described by X. If X is a marker, value is
669 the marker_position of X. Otherwise, value is X. */
671 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
673 /* Enumeration returned by some move_it_.* functions internally. */
677 /* Not used. Undefined value. */
680 /* Move ended at the requested buffer position or ZV. */
681 MOVE_POS_MATCH_OR_ZV
,
683 /* Move ended at the requested X pixel position. */
686 /* Move within a line ended at the end of a line that must be
690 /* Move within a line ended at the end of a line that would
691 be displayed truncated. */
694 /* Move within a line ended at a line end. */
698 /* This counter is used to clear the face cache every once in a while
699 in redisplay_internal. It is incremented for each redisplay.
700 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
703 #define CLEAR_FACE_CACHE_COUNT 500
704 static int clear_face_cache_count
;
706 /* Similarly for the image cache. */
708 #ifdef HAVE_WINDOW_SYSTEM
709 #define CLEAR_IMAGE_CACHE_COUNT 101
710 static int clear_image_cache_count
;
712 /* Null glyph slice */
713 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
716 /* Non-zero while redisplay_internal is in progress. */
720 Lisp_Object Qinhibit_free_realized_faces
;
722 /* If a string, XTread_socket generates an event to display that string.
723 (The display is done in read_char.) */
725 Lisp_Object help_echo_string
;
726 Lisp_Object help_echo_window
;
727 Lisp_Object help_echo_object
;
728 EMACS_INT help_echo_pos
;
730 /* Temporary variable for XTread_socket. */
732 Lisp_Object previous_help_echo_string
;
734 /* Platform-independent portion of hourglass implementation. */
736 /* Non-zero means an hourglass cursor is currently shown. */
737 int hourglass_shown_p
;
739 /* If non-null, an asynchronous timer that, when it expires, displays
740 an hourglass cursor on all frames. */
741 struct atimer
*hourglass_atimer
;
743 /* Name of the face used to display glyphless characters. */
744 Lisp_Object Qglyphless_char
;
746 /* Symbol for the purpose of Vglyphless_char_display. */
747 Lisp_Object Qglyphless_char_display
;
749 /* Method symbols for Vglyphless_char_display. */
750 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
752 /* Default pixel width of `thin-space' display method. */
753 #define THIN_SPACE_WIDTH 1
755 /* Default number of seconds to wait before displaying an hourglass
757 #define DEFAULT_HOURGLASS_DELAY 1
760 /* Function prototypes. */
762 static void setup_for_ellipsis (struct it
*, int);
763 static void mark_window_display_accurate_1 (struct window
*, int);
764 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
765 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
766 static int cursor_row_p (struct window
*, struct glyph_row
*);
767 static int redisplay_mode_lines (Lisp_Object
, int);
768 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
770 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
772 static void handle_line_prefix (struct it
*);
774 static void pint2str (char *, int, int);
775 static void pint2hrstr (char *, int, int);
776 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
778 static void reconsider_clip_changes (struct window
*, struct buffer
*);
779 static int text_outside_line_unchanged_p (struct window
*,
780 EMACS_INT
, EMACS_INT
);
781 static void store_mode_line_noprop_char (char);
782 static int store_mode_line_noprop (const char *, int, int);
783 static void handle_stop (struct it
*);
784 static void handle_stop_backwards (struct it
*, EMACS_INT
);
785 static int single_display_spec_intangible_p (Lisp_Object
);
786 static void ensure_echo_area_buffers (void);
787 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
788 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
789 static int with_echo_area_buffer (struct window
*, int,
790 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
791 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static void clear_garbaged_frames (void);
793 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
794 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
795 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
796 static int display_echo_area (struct window
*);
797 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
799 static Lisp_Object
unwind_redisplay (Lisp_Object
);
800 static int string_char_and_length (const unsigned char *, int *);
801 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
803 static int compute_window_start_on_continuation_line (struct window
*);
804 static Lisp_Object
safe_eval_handler (Lisp_Object
);
805 static void insert_left_trunc_glyphs (struct it
*);
806 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
808 static void extend_face_to_end_of_line (struct it
*);
809 static int append_space_for_newline (struct it
*, int);
810 static int cursor_row_fully_visible_p (struct window
*, int, int);
811 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
812 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
813 static int trailing_whitespace_p (EMACS_INT
);
814 static int message_log_check_duplicate (EMACS_INT
, EMACS_INT
,
815 EMACS_INT
, EMACS_INT
);
816 static void push_it (struct it
*);
817 static void pop_it (struct it
*);
818 static void sync_frame_with_window_matrix_rows (struct window
*);
819 static void select_frame_for_redisplay (Lisp_Object
);
820 static void redisplay_internal (int);
821 static int echo_area_display (int);
822 static void redisplay_windows (Lisp_Object
);
823 static void redisplay_window (Lisp_Object
, int);
824 static Lisp_Object
redisplay_window_error (Lisp_Object
);
825 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
826 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
827 static int update_menu_bar (struct frame
*, int, int);
828 static int try_window_reusing_current_matrix (struct window
*);
829 static int try_window_id (struct window
*);
830 static int display_line (struct it
*);
831 static int display_mode_lines (struct window
*);
832 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
833 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
834 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
835 static const char *decode_mode_spec (struct window
*, int, int, int,
837 static void display_menu_bar (struct window
*);
838 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
840 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
841 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
842 static void compute_line_metrics (struct it
*);
843 static void run_redisplay_end_trigger_hook (struct it
*);
844 static int get_overlay_strings (struct it
*, EMACS_INT
);
845 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
846 static void next_overlay_string (struct it
*);
847 static void reseat (struct it
*, struct text_pos
, int);
848 static void reseat_1 (struct it
*, struct text_pos
, int);
849 static void back_to_previous_visible_line_start (struct it
*);
850 void reseat_at_previous_visible_line_start (struct it
*);
851 static void reseat_at_next_visible_line_start (struct it
*, int);
852 static int next_element_from_ellipsis (struct it
*);
853 static int next_element_from_display_vector (struct it
*);
854 static int next_element_from_string (struct it
*);
855 static int next_element_from_c_string (struct it
*);
856 static int next_element_from_buffer (struct it
*);
857 static int next_element_from_composition (struct it
*);
858 static int next_element_from_image (struct it
*);
859 static int next_element_from_stretch (struct it
*);
860 static void load_overlay_strings (struct it
*, EMACS_INT
);
861 static int init_from_display_pos (struct it
*, struct window
*,
862 struct display_pos
*);
863 static void reseat_to_string (struct it
*, const char *,
864 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
865 static enum move_it_result
866 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
867 enum move_operation_enum
);
868 void move_it_vertically_backward (struct it
*, int);
869 static void init_to_row_start (struct it
*, struct window
*,
871 static int init_to_row_end (struct it
*, struct window
*,
873 static void back_to_previous_line_start (struct it
*);
874 static int forward_to_next_line_start (struct it
*, int *);
875 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
876 Lisp_Object
, EMACS_INT
);
877 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
878 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
879 static EMACS_INT
number_of_chars (const char *, int);
880 static void compute_stop_pos (struct it
*);
881 static void compute_string_pos (struct text_pos
*, struct text_pos
,
883 static int face_before_or_after_it_pos (struct it
*, int);
884 static EMACS_INT
next_overlay_change (EMACS_INT
);
885 static int handle_single_display_spec (struct it
*, Lisp_Object
,
886 Lisp_Object
, Lisp_Object
,
887 struct text_pos
*, int);
888 static int underlying_face_id (struct it
*);
889 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
892 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
893 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
895 #ifdef HAVE_WINDOW_SYSTEM
897 static void x_consider_frame_title (Lisp_Object
);
898 static int tool_bar_lines_needed (struct frame
*, int *);
899 static void update_tool_bar (struct frame
*, int);
900 static void build_desired_tool_bar_string (struct frame
*f
);
901 static int redisplay_tool_bar (struct frame
*);
902 static void display_tool_bar_line (struct it
*, int);
903 static void notice_overwritten_cursor (struct window
*,
906 static void append_stretch_glyph (struct it
*, Lisp_Object
,
910 #endif /* HAVE_WINDOW_SYSTEM */
912 static int coords_in_mouse_face_p (struct window
*, int, int);
916 /***********************************************************************
917 Window display dimensions
918 ***********************************************************************/
920 /* Return the bottom boundary y-position for text lines in window W.
921 This is the first y position at which a line cannot start.
922 It is relative to the top of the window.
924 This is the height of W minus the height of a mode line, if any. */
927 window_text_bottom_y (struct window
*w
)
929 int height
= WINDOW_TOTAL_HEIGHT (w
);
931 if (WINDOW_WANTS_MODELINE_P (w
))
932 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
936 /* Return the pixel width of display area AREA of window W. AREA < 0
937 means return the total width of W, not including fringes to
938 the left and right of the window. */
941 window_box_width (struct window
*w
, int area
)
943 int cols
= XFASTINT (w
->total_cols
);
946 if (!w
->pseudo_window_p
)
948 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
950 if (area
== TEXT_AREA
)
952 if (INTEGERP (w
->left_margin_cols
))
953 cols
-= XFASTINT (w
->left_margin_cols
);
954 if (INTEGERP (w
->right_margin_cols
))
955 cols
-= XFASTINT (w
->right_margin_cols
);
956 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
958 else if (area
== LEFT_MARGIN_AREA
)
960 cols
= (INTEGERP (w
->left_margin_cols
)
961 ? XFASTINT (w
->left_margin_cols
) : 0);
964 else if (area
== RIGHT_MARGIN_AREA
)
966 cols
= (INTEGERP (w
->right_margin_cols
)
967 ? XFASTINT (w
->right_margin_cols
) : 0);
972 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
976 /* Return the pixel height of the display area of window W, not
977 including mode lines of W, if any. */
980 window_box_height (struct window
*w
)
982 struct frame
*f
= XFRAME (w
->frame
);
983 int height
= WINDOW_TOTAL_HEIGHT (w
);
985 xassert (height
>= 0);
987 /* Note: the code below that determines the mode-line/header-line
988 height is essentially the same as that contained in the macro
989 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
990 the appropriate glyph row has its `mode_line_p' flag set,
991 and if it doesn't, uses estimate_mode_line_height instead. */
993 if (WINDOW_WANTS_MODELINE_P (w
))
995 struct glyph_row
*ml_row
996 = (w
->current_matrix
&& w
->current_matrix
->rows
997 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
999 if (ml_row
&& ml_row
->mode_line_p
)
1000 height
-= ml_row
->height
;
1002 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1005 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1007 struct glyph_row
*hl_row
1008 = (w
->current_matrix
&& w
->current_matrix
->rows
1009 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1011 if (hl_row
&& hl_row
->mode_line_p
)
1012 height
-= hl_row
->height
;
1014 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1017 /* With a very small font and a mode-line that's taller than
1018 default, we might end up with a negative height. */
1019 return max (0, height
);
1022 /* Return the window-relative coordinate of the left edge of display
1023 area AREA of window W. AREA < 0 means return the left edge of the
1024 whole window, to the right of the left fringe of W. */
1027 window_box_left_offset (struct window
*w
, int area
)
1031 if (w
->pseudo_window_p
)
1034 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1036 if (area
== TEXT_AREA
)
1037 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1038 + window_box_width (w
, LEFT_MARGIN_AREA
));
1039 else if (area
== RIGHT_MARGIN_AREA
)
1040 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1041 + window_box_width (w
, LEFT_MARGIN_AREA
)
1042 + window_box_width (w
, TEXT_AREA
)
1043 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1045 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1046 else if (area
== LEFT_MARGIN_AREA
1047 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1048 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1054 /* Return the window-relative coordinate of the right edge of display
1055 area AREA of window W. AREA < 0 means return the right edge of the
1056 whole window, to the left of the right fringe of W. */
1059 window_box_right_offset (struct window
*w
, int area
)
1061 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1064 /* Return the frame-relative coordinate of the left edge of display
1065 area AREA of window W. AREA < 0 means return the left edge of the
1066 whole window, to the right of the left fringe of W. */
1069 window_box_left (struct window
*w
, int area
)
1071 struct frame
*f
= XFRAME (w
->frame
);
1074 if (w
->pseudo_window_p
)
1075 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1077 x
= (WINDOW_LEFT_EDGE_X (w
)
1078 + window_box_left_offset (w
, area
));
1084 /* Return the frame-relative coordinate of the right edge of display
1085 area AREA of window W. AREA < 0 means return the right edge of the
1086 whole window, to the left of the right fringe of W. */
1089 window_box_right (struct window
*w
, int area
)
1091 return window_box_left (w
, area
) + window_box_width (w
, area
);
1094 /* Get the bounding box of the display area AREA of window W, without
1095 mode lines, in frame-relative coordinates. AREA < 0 means the
1096 whole window, not including the left and right fringes of
1097 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1098 coordinates of the upper-left corner of the box. Return in
1099 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1102 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1103 int *box_width
, int *box_height
)
1106 *box_width
= window_box_width (w
, area
);
1108 *box_height
= window_box_height (w
);
1110 *box_x
= window_box_left (w
, area
);
1113 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1114 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1115 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1120 /* Get the bounding box of the display area AREA of window W, without
1121 mode lines. AREA < 0 means the whole window, not including the
1122 left and right fringe of the window. Return in *TOP_LEFT_X
1123 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1124 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1125 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1129 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1130 int *bottom_right_x
, int *bottom_right_y
)
1132 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1134 *bottom_right_x
+= *top_left_x
;
1135 *bottom_right_y
+= *top_left_y
;
1140 /***********************************************************************
1142 ***********************************************************************/
1144 /* Return the bottom y-position of the line the iterator IT is in.
1145 This can modify IT's settings. */
1148 line_bottom_y (struct it
*it
)
1150 int line_height
= it
->max_ascent
+ it
->max_descent
;
1151 int line_top_y
= it
->current_y
;
1153 if (line_height
== 0)
1156 line_height
= last_height
;
1157 else if (IT_CHARPOS (*it
) < ZV
)
1159 move_it_by_lines (it
, 1, 1);
1160 line_height
= (it
->max_ascent
|| it
->max_descent
1161 ? it
->max_ascent
+ it
->max_descent
1166 struct glyph_row
*row
= it
->glyph_row
;
1168 /* Use the default character height. */
1169 it
->glyph_row
= NULL
;
1170 it
->what
= IT_CHARACTER
;
1173 PRODUCE_GLYPHS (it
);
1174 line_height
= it
->ascent
+ it
->descent
;
1175 it
->glyph_row
= row
;
1179 return line_top_y
+ line_height
;
1183 /* Return 1 if position CHARPOS is visible in window W.
1184 CHARPOS < 0 means return info about WINDOW_END position.
1185 If visible, set *X and *Y to pixel coordinates of top left corner.
1186 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1187 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1190 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1191 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1194 struct text_pos top
;
1196 struct buffer
*old_buffer
= NULL
;
1198 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1201 if (XBUFFER (w
->buffer
) != current_buffer
)
1203 old_buffer
= current_buffer
;
1204 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1207 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1209 /* Compute exact mode line heights. */
1210 if (WINDOW_WANTS_MODELINE_P (w
))
1211 current_mode_line_height
1212 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1213 BVAR (current_buffer
, mode_line_format
));
1215 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1216 current_header_line_height
1217 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1218 BVAR (current_buffer
, header_line_format
));
1220 start_display (&it
, w
, top
);
1221 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1222 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1224 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1226 /* We have reached CHARPOS, or passed it. How the call to
1227 move_it_to can overshoot: (i) If CHARPOS is on invisible
1228 text, move_it_to stops at the end of the invisible text,
1229 after CHARPOS. (ii) If CHARPOS is in a display vector,
1230 move_it_to stops on its last glyph. */
1231 int top_x
= it
.current_x
;
1232 int top_y
= it
.current_y
;
1233 enum it_method it_method
= it
.method
;
1234 /* Calling line_bottom_y may change it.method, it.position, etc. */
1235 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1236 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1238 if (top_y
< window_top_y
)
1239 visible_p
= bottom_y
> window_top_y
;
1240 else if (top_y
< it
.last_visible_y
)
1244 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1246 /* We stopped on the last glyph of a display vector.
1247 Try and recompute. Hack alert! */
1248 if (charpos
< 2 || top
.charpos
>= charpos
)
1249 top_x
= it
.glyph_row
->x
;
1253 start_display (&it2
, w
, top
);
1254 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1255 get_next_display_element (&it2
);
1256 PRODUCE_GLYPHS (&it2
);
1257 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1258 || it2
.current_x
> it2
.last_visible_x
)
1259 top_x
= it
.glyph_row
->x
;
1262 top_x
= it2
.current_x
;
1263 top_y
= it2
.current_y
;
1269 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1270 *rtop
= max (0, window_top_y
- top_y
);
1271 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1272 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1273 - max (top_y
, window_top_y
)));
1282 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1283 move_it_by_lines (&it
, 1, 0);
1284 if (charpos
< IT_CHARPOS (it
)
1285 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1288 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1290 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1291 *rtop
= max (0, -it2
.current_y
);
1292 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1293 - it
.last_visible_y
));
1294 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1296 - max (it2
.current_y
,
1297 WINDOW_HEADER_LINE_HEIGHT (w
))));
1303 set_buffer_internal_1 (old_buffer
);
1305 current_header_line_height
= current_mode_line_height
= -1;
1307 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1308 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1311 /* Debugging code. */
1313 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1314 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1316 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1323 /* Return the next character from STR. Return in *LEN the length of
1324 the character. This is like STRING_CHAR_AND_LENGTH but never
1325 returns an invalid character. If we find one, we return a `?', but
1326 with the length of the invalid character. */
1329 string_char_and_length (const unsigned char *str
, int *len
)
1333 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1334 if (!CHAR_VALID_P (c
, 1))
1335 /* We may not change the length here because other places in Emacs
1336 don't use this function, i.e. they silently accept invalid
1345 /* Given a position POS containing a valid character and byte position
1346 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1348 static struct text_pos
1349 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1351 xassert (STRINGP (string
) && nchars
>= 0);
1353 if (STRING_MULTIBYTE (string
))
1355 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1360 string_char_and_length (p
, &len
);
1363 BYTEPOS (pos
) += len
;
1367 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1373 /* Value is the text position, i.e. character and byte position,
1374 for character position CHARPOS in STRING. */
1376 static INLINE
struct text_pos
1377 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1379 struct text_pos pos
;
1380 xassert (STRINGP (string
));
1381 xassert (charpos
>= 0);
1382 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1387 /* Value is a text position, i.e. character and byte position, for
1388 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1389 means recognize multibyte characters. */
1391 static struct text_pos
1392 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1394 struct text_pos pos
;
1396 xassert (s
!= NULL
);
1397 xassert (charpos
>= 0);
1403 SET_TEXT_POS (pos
, 0, 0);
1406 string_char_and_length ((const unsigned char *) s
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, charpos
, charpos
);
1419 /* Value is the number of characters in C string S. MULTIBYTE_P
1420 non-zero means recognize multibyte characters. */
1423 number_of_chars (const char *s
, int multibyte_p
)
1429 EMACS_INT rest
= strlen (s
);
1431 const unsigned char *p
= (const unsigned char *) s
;
1433 for (nchars
= 0; rest
> 0; ++nchars
)
1435 string_char_and_length (p
, &len
);
1436 rest
-= len
, p
+= len
;
1440 nchars
= strlen (s
);
1446 /* Compute byte position NEWPOS->bytepos corresponding to
1447 NEWPOS->charpos. POS is a known position in string STRING.
1448 NEWPOS->charpos must be >= POS.charpos. */
1451 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1453 xassert (STRINGP (string
));
1454 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1456 if (STRING_MULTIBYTE (string
))
1457 *newpos
= string_pos_nchars_ahead (pos
, string
,
1458 CHARPOS (*newpos
) - CHARPOS (pos
));
1460 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1464 Return an estimation of the pixel height of mode or header lines on
1465 frame F. FACE_ID specifies what line's height to estimate. */
1468 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1470 #ifdef HAVE_WINDOW_SYSTEM
1471 if (FRAME_WINDOW_P (f
))
1473 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1475 /* This function is called so early when Emacs starts that the face
1476 cache and mode line face are not yet initialized. */
1477 if (FRAME_FACE_CACHE (f
))
1479 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1483 height
= FONT_HEIGHT (face
->font
);
1484 if (face
->box_line_width
> 0)
1485 height
+= 2 * face
->box_line_width
;
1496 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1497 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1498 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1499 not force the value into range. */
1502 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1503 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1506 #ifdef HAVE_WINDOW_SYSTEM
1507 if (FRAME_WINDOW_P (f
))
1509 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1510 even for negative values. */
1512 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1514 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1516 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1517 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1520 STORE_NATIVE_RECT (*bounds
,
1521 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1522 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1523 FRAME_COLUMN_WIDTH (f
) - 1,
1524 FRAME_LINE_HEIGHT (f
) - 1);
1530 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1531 pix_x
= FRAME_TOTAL_COLS (f
);
1535 else if (pix_y
> FRAME_LINES (f
))
1536 pix_y
= FRAME_LINES (f
);
1546 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1547 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1548 can't tell the positions because W's display is not up to date,
1552 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1553 int *frame_x
, int *frame_y
)
1555 #ifdef HAVE_WINDOW_SYSTEM
1556 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1560 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1561 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1563 if (display_completed
)
1565 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1566 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1567 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1573 hpos
+= glyph
->pixel_width
;
1577 /* If first glyph is partially visible, its first visible position is still 0. */
1589 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1590 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1601 /* Find the glyph under window-relative coordinates X/Y in window W.
1602 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1603 strings. Return in *HPOS and *VPOS the row and column number of
1604 the glyph found. Return in *AREA the glyph area containing X.
1605 Value is a pointer to the glyph found or null if X/Y is not on
1606 text, or we can't tell because W's current matrix is not up to
1611 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1612 int *dx
, int *dy
, int *area
)
1614 struct glyph
*glyph
, *end
;
1615 struct glyph_row
*row
= NULL
;
1618 /* Find row containing Y. Give up if some row is not enabled. */
1619 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1621 row
= MATRIX_ROW (w
->current_matrix
, i
);
1622 if (!row
->enabled_p
)
1624 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1631 /* Give up if Y is not in the window. */
1632 if (i
== w
->current_matrix
->nrows
)
1635 /* Get the glyph area containing X. */
1636 if (w
->pseudo_window_p
)
1643 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1645 *area
= LEFT_MARGIN_AREA
;
1646 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1648 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1651 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1655 *area
= RIGHT_MARGIN_AREA
;
1656 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1660 /* Find glyph containing X. */
1661 glyph
= row
->glyphs
[*area
];
1662 end
= glyph
+ row
->used
[*area
];
1664 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1666 x
-= glyph
->pixel_width
;
1676 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1679 *hpos
= glyph
- row
->glyphs
[*area
];
1684 Convert frame-relative x/y to coordinates relative to window W.
1685 Takes pseudo-windows into account. */
1688 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1690 if (w
->pseudo_window_p
)
1692 /* A pseudo-window is always full-width, and starts at the
1693 left edge of the frame, plus a frame border. */
1694 struct frame
*f
= XFRAME (w
->frame
);
1695 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1696 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1700 *x
-= WINDOW_LEFT_EDGE_X (w
);
1701 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1705 #ifdef HAVE_WINDOW_SYSTEM
1708 Return in RECTS[] at most N clipping rectangles for glyph string S.
1709 Return the number of stored rectangles. */
1712 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1719 if (s
->row
->full_width_p
)
1721 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1722 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1723 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1725 /* Unless displaying a mode or menu bar line, which are always
1726 fully visible, clip to the visible part of the row. */
1727 if (s
->w
->pseudo_window_p
)
1728 r
.height
= s
->row
->visible_height
;
1730 r
.height
= s
->height
;
1734 /* This is a text line that may be partially visible. */
1735 r
.x
= window_box_left (s
->w
, s
->area
);
1736 r
.width
= window_box_width (s
->w
, s
->area
);
1737 r
.height
= s
->row
->visible_height
;
1741 if (r
.x
< s
->clip_head
->x
)
1743 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1744 r
.width
-= s
->clip_head
->x
- r
.x
;
1747 r
.x
= s
->clip_head
->x
;
1750 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1752 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1753 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1758 /* If S draws overlapping rows, it's sufficient to use the top and
1759 bottom of the window for clipping because this glyph string
1760 intentionally draws over other lines. */
1761 if (s
->for_overlaps
)
1763 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1764 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1766 /* Alas, the above simple strategy does not work for the
1767 environments with anti-aliased text: if the same text is
1768 drawn onto the same place multiple times, it gets thicker.
1769 If the overlap we are processing is for the erased cursor, we
1770 take the intersection with the rectagle of the cursor. */
1771 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1773 XRectangle rc
, r_save
= r
;
1775 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1776 rc
.y
= s
->w
->phys_cursor
.y
;
1777 rc
.width
= s
->w
->phys_cursor_width
;
1778 rc
.height
= s
->w
->phys_cursor_height
;
1780 x_intersect_rectangles (&r_save
, &rc
, &r
);
1785 /* Don't use S->y for clipping because it doesn't take partially
1786 visible lines into account. For example, it can be negative for
1787 partially visible lines at the top of a window. */
1788 if (!s
->row
->full_width_p
1789 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1790 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1792 r
.y
= max (0, s
->row
->y
);
1795 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1797 /* If drawing the cursor, don't let glyph draw outside its
1798 advertised boundaries. Cleartype does this under some circumstances. */
1799 if (s
->hl
== DRAW_CURSOR
)
1801 struct glyph
*glyph
= s
->first_glyph
;
1806 r
.width
-= s
->x
- r
.x
;
1809 r
.width
= min (r
.width
, glyph
->pixel_width
);
1811 /* If r.y is below window bottom, ensure that we still see a cursor. */
1812 height
= min (glyph
->ascent
+ glyph
->descent
,
1813 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1814 max_y
= window_text_bottom_y (s
->w
) - height
;
1815 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1816 if (s
->ybase
- glyph
->ascent
> max_y
)
1823 /* Don't draw cursor glyph taller than our actual glyph. */
1824 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1825 if (height
< r
.height
)
1827 max_y
= r
.y
+ r
.height
;
1828 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1829 r
.height
= min (max_y
- r
.y
, height
);
1836 XRectangle r_save
= r
;
1838 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1842 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1843 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1845 #ifdef CONVERT_FROM_XRECT
1846 CONVERT_FROM_XRECT (r
, *rects
);
1854 /* If we are processing overlapping and allowed to return
1855 multiple clipping rectangles, we exclude the row of the glyph
1856 string from the clipping rectangle. This is to avoid drawing
1857 the same text on the environment with anti-aliasing. */
1858 #ifdef CONVERT_FROM_XRECT
1861 XRectangle
*rs
= rects
;
1863 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1865 if (s
->for_overlaps
& OVERLAPS_PRED
)
1868 if (r
.y
+ r
.height
> row_y
)
1871 rs
[i
].height
= row_y
- r
.y
;
1877 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1880 if (r
.y
< row_y
+ s
->row
->visible_height
)
1882 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1884 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1885 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1894 #ifdef CONVERT_FROM_XRECT
1895 for (i
= 0; i
< n
; i
++)
1896 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1903 Return in *NR the clipping rectangle for glyph string S. */
1906 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1908 get_glyph_string_clip_rects (s
, nr
, 1);
1913 Return the position and height of the phys cursor in window W.
1914 Set w->phys_cursor_width to width of phys cursor.
1918 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1919 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1921 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1922 int x
, y
, wd
, h
, h0
, y0
;
1924 /* Compute the width of the rectangle to draw. If on a stretch
1925 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1926 rectangle as wide as the glyph, but use a canonical character
1928 wd
= glyph
->pixel_width
- 1;
1929 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1933 x
= w
->phys_cursor
.x
;
1940 if (glyph
->type
== STRETCH_GLYPH
1941 && !x_stretch_cursor_p
)
1942 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1943 w
->phys_cursor_width
= wd
;
1945 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1947 /* If y is below window bottom, ensure that we still see a cursor. */
1948 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1950 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1951 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1953 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1956 h
= max (h
- (y0
- y
) + 1, h0
);
1961 y0
= window_text_bottom_y (w
) - h0
;
1969 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1970 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1975 * Remember which glyph the mouse is over.
1979 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1983 struct glyph_row
*r
, *gr
, *end_row
;
1984 enum window_part part
;
1985 enum glyph_row_area area
;
1986 int x
, y
, width
, height
;
1988 /* Try to determine frame pixel position and size of the glyph under
1989 frame pixel coordinates X/Y on frame F. */
1991 if (!f
->glyphs_initialized_p
1992 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1995 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1996 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2000 w
= XWINDOW (window
);
2001 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2002 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2004 x
= window_relative_x_coord (w
, part
, gx
);
2005 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2007 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2008 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2010 if (w
->pseudo_window_p
)
2013 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2019 case ON_LEFT_MARGIN
:
2020 area
= LEFT_MARGIN_AREA
;
2023 case ON_RIGHT_MARGIN
:
2024 area
= RIGHT_MARGIN_AREA
;
2027 case ON_HEADER_LINE
:
2029 gr
= (part
== ON_HEADER_LINE
2030 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2031 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2034 goto text_glyph_row_found
;
2041 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2042 if (r
->y
+ r
->height
> y
)
2048 text_glyph_row_found
:
2051 struct glyph
*g
= gr
->glyphs
[area
];
2052 struct glyph
*end
= g
+ gr
->used
[area
];
2054 height
= gr
->height
;
2055 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2056 if (gx
+ g
->pixel_width
> x
)
2061 if (g
->type
== IMAGE_GLYPH
)
2063 /* Don't remember when mouse is over image, as
2064 image may have hot-spots. */
2065 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2068 width
= g
->pixel_width
;
2072 /* Use nominal char spacing at end of line. */
2074 gx
+= (x
/ width
) * width
;
2077 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2078 gx
+= window_box_left_offset (w
, area
);
2082 /* Use nominal line height at end of window. */
2083 gx
= (x
/ width
) * width
;
2085 gy
+= (y
/ height
) * height
;
2089 case ON_LEFT_FRINGE
:
2090 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2091 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2092 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2093 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2096 case ON_RIGHT_FRINGE
:
2097 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2099 : window_box_right_offset (w
, TEXT_AREA
));
2100 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2104 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2106 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2107 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2108 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2110 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2114 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2115 if (r
->y
+ r
->height
> y
)
2122 height
= gr
->height
;
2125 /* Use nominal line height at end of window. */
2127 gy
+= (y
/ height
) * height
;
2134 /* If there is no glyph under the mouse, then we divide the screen
2135 into a grid of the smallest glyph in the frame, and use that
2138 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2139 round down even for negative values. */
2145 gx
= (gx
/ width
) * width
;
2146 gy
= (gy
/ height
) * height
;
2151 gx
+= WINDOW_LEFT_EDGE_X (w
);
2152 gy
+= WINDOW_TOP_EDGE_Y (w
);
2155 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2157 /* Visible feedback for debugging. */
2160 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2161 f
->output_data
.x
->normal_gc
,
2162 gx
, gy
, width
, height
);
2168 #endif /* HAVE_WINDOW_SYSTEM */
2171 /***********************************************************************
2172 Lisp form evaluation
2173 ***********************************************************************/
2175 /* Error handler for safe_eval and safe_call. */
2178 safe_eval_handler (Lisp_Object arg
)
2180 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2185 /* Evaluate SEXPR and return the result, or nil if something went
2186 wrong. Prevent redisplay during the evaluation. */
2188 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2189 Return the result, or nil if something went wrong. Prevent
2190 redisplay during the evaluation. */
2193 safe_call (int nargs
, Lisp_Object
*args
)
2197 if (inhibit_eval_during_redisplay
)
2201 int count
= SPECPDL_INDEX ();
2202 struct gcpro gcpro1
;
2205 gcpro1
.nvars
= nargs
;
2206 specbind (Qinhibit_redisplay
, Qt
);
2207 /* Use Qt to ensure debugger does not run,
2208 so there is no possibility of wanting to redisplay. */
2209 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2212 val
= unbind_to (count
, val
);
2219 /* Call function FN with one argument ARG.
2220 Return the result, or nil if something went wrong. */
2223 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2225 Lisp_Object args
[2];
2228 return safe_call (2, args
);
2231 static Lisp_Object Qeval
;
2234 safe_eval (Lisp_Object sexpr
)
2236 return safe_call1 (Qeval
, sexpr
);
2239 /* Call function FN with one argument ARG.
2240 Return the result, or nil if something went wrong. */
2243 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2245 Lisp_Object args
[3];
2249 return safe_call (3, args
);
2254 /***********************************************************************
2256 ***********************************************************************/
2260 /* Define CHECK_IT to perform sanity checks on iterators.
2261 This is for debugging. It is too slow to do unconditionally. */
2267 if (it
->method
== GET_FROM_STRING
)
2269 xassert (STRINGP (it
->string
));
2270 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2274 xassert (IT_STRING_CHARPOS (*it
) < 0);
2275 if (it
->method
== GET_FROM_BUFFER
)
2277 /* Check that character and byte positions agree. */
2278 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2283 xassert (it
->current
.dpvec_index
>= 0);
2285 xassert (it
->current
.dpvec_index
< 0);
2288 #define CHECK_IT(IT) check_it ((IT))
2292 #define CHECK_IT(IT) (void) 0
2299 /* Check that the window end of window W is what we expect it
2300 to be---the last row in the current matrix displaying text. */
2303 check_window_end (w
)
2306 if (!MINI_WINDOW_P (w
)
2307 && !NILP (w
->window_end_valid
))
2309 struct glyph_row
*row
;
2310 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2311 XFASTINT (w
->window_end_vpos
)),
2313 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2314 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2318 #define CHECK_WINDOW_END(W) check_window_end ((W))
2320 #else /* not GLYPH_DEBUG */
2322 #define CHECK_WINDOW_END(W) (void) 0
2324 #endif /* not GLYPH_DEBUG */
2328 /***********************************************************************
2329 Iterator initialization
2330 ***********************************************************************/
2332 /* Initialize IT for displaying current_buffer in window W, starting
2333 at character position CHARPOS. CHARPOS < 0 means that no buffer
2334 position is specified which is useful when the iterator is assigned
2335 a position later. BYTEPOS is the byte position corresponding to
2336 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2338 If ROW is not null, calls to produce_glyphs with IT as parameter
2339 will produce glyphs in that row.
2341 BASE_FACE_ID is the id of a base face to use. It must be one of
2342 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2343 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2344 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2346 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2347 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2348 will be initialized to use the corresponding mode line glyph row of
2349 the desired matrix of W. */
2352 init_iterator (struct it
*it
, struct window
*w
,
2353 EMACS_INT charpos
, EMACS_INT bytepos
,
2354 struct glyph_row
*row
, enum face_id base_face_id
)
2356 int highlight_region_p
;
2357 enum face_id remapped_base_face_id
= base_face_id
;
2359 /* Some precondition checks. */
2360 xassert (w
!= NULL
&& it
!= NULL
);
2361 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2364 /* If face attributes have been changed since the last redisplay,
2365 free realized faces now because they depend on face definitions
2366 that might have changed. Don't free faces while there might be
2367 desired matrices pending which reference these faces. */
2368 if (face_change_count
&& !inhibit_free_realized_faces
)
2370 face_change_count
= 0;
2371 free_all_realized_faces (Qnil
);
2374 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2375 if (! NILP (Vface_remapping_alist
))
2376 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2378 /* Use one of the mode line rows of W's desired matrix if
2382 if (base_face_id
== MODE_LINE_FACE_ID
2383 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2384 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2385 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2386 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2390 memset (it
, 0, sizeof *it
);
2391 it
->current
.overlay_string_index
= -1;
2392 it
->current
.dpvec_index
= -1;
2393 it
->base_face_id
= remapped_base_face_id
;
2395 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2397 /* The window in which we iterate over current_buffer: */
2398 XSETWINDOW (it
->window
, w
);
2400 it
->f
= XFRAME (w
->frame
);
2404 /* Extra space between lines (on window systems only). */
2405 if (base_face_id
== DEFAULT_FACE_ID
2406 && FRAME_WINDOW_P (it
->f
))
2408 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2409 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2410 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2411 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2412 * FRAME_LINE_HEIGHT (it
->f
));
2413 else if (it
->f
->extra_line_spacing
> 0)
2414 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2415 it
->max_extra_line_spacing
= 0;
2418 /* If realized faces have been removed, e.g. because of face
2419 attribute changes of named faces, recompute them. When running
2420 in batch mode, the face cache of the initial frame is null. If
2421 we happen to get called, make a dummy face cache. */
2422 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2423 init_frame_faces (it
->f
);
2424 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2425 recompute_basic_faces (it
->f
);
2427 /* Current value of the `slice', `space-width', and 'height' properties. */
2428 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2429 it
->space_width
= Qnil
;
2430 it
->font_height
= Qnil
;
2431 it
->override_ascent
= -1;
2433 /* Are control characters displayed as `^C'? */
2434 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2436 /* -1 means everything between a CR and the following line end
2437 is invisible. >0 means lines indented more than this value are
2439 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2440 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2441 : (!NILP (BVAR (current_buffer
, selective_display
))
2443 it
->selective_display_ellipsis_p
2444 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2446 /* Display table to use. */
2447 it
->dp
= window_display_table (w
);
2449 /* Are multibyte characters enabled in current_buffer? */
2450 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2452 /* Do we need to reorder bidirectional text? Not if this is a
2453 unibyte buffer: by definition, none of the single-byte characters
2454 are strong R2L, so no reordering is needed. And bidi.c doesn't
2455 support unibyte buffers anyway. */
2457 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2459 /* Non-zero if we should highlight the region. */
2461 = (!NILP (Vtransient_mark_mode
)
2462 && !NILP (BVAR (current_buffer
, mark_active
))
2463 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2465 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2466 start and end of a visible region in window IT->w. Set both to
2467 -1 to indicate no region. */
2468 if (highlight_region_p
2469 /* Maybe highlight only in selected window. */
2470 && (/* Either show region everywhere. */
2471 highlight_nonselected_windows
2472 /* Or show region in the selected window. */
2473 || w
== XWINDOW (selected_window
)
2474 /* Or show the region if we are in the mini-buffer and W is
2475 the window the mini-buffer refers to. */
2476 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2477 && WINDOWP (minibuf_selected_window
)
2478 && w
== XWINDOW (minibuf_selected_window
))))
2480 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2481 it
->region_beg_charpos
= min (PT
, markpos
);
2482 it
->region_end_charpos
= max (PT
, markpos
);
2485 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2487 /* Get the position at which the redisplay_end_trigger hook should
2488 be run, if it is to be run at all. */
2489 if (MARKERP (w
->redisplay_end_trigger
)
2490 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2491 it
->redisplay_end_trigger_charpos
2492 = marker_position (w
->redisplay_end_trigger
);
2493 else if (INTEGERP (w
->redisplay_end_trigger
))
2494 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2496 /* Correct bogus values of tab_width. */
2497 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2498 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2501 /* Are lines in the display truncated? */
2502 if (base_face_id
!= DEFAULT_FACE_ID
2503 || XINT (it
->w
->hscroll
)
2504 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2505 && ((!NILP (Vtruncate_partial_width_windows
)
2506 && !INTEGERP (Vtruncate_partial_width_windows
))
2507 || (INTEGERP (Vtruncate_partial_width_windows
)
2508 && (WINDOW_TOTAL_COLS (it
->w
)
2509 < XINT (Vtruncate_partial_width_windows
))))))
2510 it
->line_wrap
= TRUNCATE
;
2511 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2512 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2513 ? WINDOW_WRAP
: WORD_WRAP
;
2515 it
->line_wrap
= TRUNCATE
;
2517 /* Get dimensions of truncation and continuation glyphs. These are
2518 displayed as fringe bitmaps under X, so we don't need them for such
2520 if (!FRAME_WINDOW_P (it
->f
))
2522 if (it
->line_wrap
== TRUNCATE
)
2524 /* We will need the truncation glyph. */
2525 xassert (it
->glyph_row
== NULL
);
2526 produce_special_glyphs (it
, IT_TRUNCATION
);
2527 it
->truncation_pixel_width
= it
->pixel_width
;
2531 /* We will need the continuation glyph. */
2532 xassert (it
->glyph_row
== NULL
);
2533 produce_special_glyphs (it
, IT_CONTINUATION
);
2534 it
->continuation_pixel_width
= it
->pixel_width
;
2537 /* Reset these values to zero because the produce_special_glyphs
2538 above has changed them. */
2539 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2540 it
->phys_ascent
= it
->phys_descent
= 0;
2543 /* Set this after getting the dimensions of truncation and
2544 continuation glyphs, so that we don't produce glyphs when calling
2545 produce_special_glyphs, above. */
2546 it
->glyph_row
= row
;
2547 it
->area
= TEXT_AREA
;
2549 /* Forget any previous info about this row being reversed. */
2551 it
->glyph_row
->reversed_p
= 0;
2553 /* Get the dimensions of the display area. The display area
2554 consists of the visible window area plus a horizontally scrolled
2555 part to the left of the window. All x-values are relative to the
2556 start of this total display area. */
2557 if (base_face_id
!= DEFAULT_FACE_ID
)
2559 /* Mode lines, menu bar in terminal frames. */
2560 it
->first_visible_x
= 0;
2561 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2566 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2567 it
->last_visible_x
= (it
->first_visible_x
2568 + window_box_width (w
, TEXT_AREA
));
2570 /* If we truncate lines, leave room for the truncator glyph(s) at
2571 the right margin. Otherwise, leave room for the continuation
2572 glyph(s). Truncation and continuation glyphs are not inserted
2573 for window-based redisplay. */
2574 if (!FRAME_WINDOW_P (it
->f
))
2576 if (it
->line_wrap
== TRUNCATE
)
2577 it
->last_visible_x
-= it
->truncation_pixel_width
;
2579 it
->last_visible_x
-= it
->continuation_pixel_width
;
2582 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2583 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2586 /* Leave room for a border glyph. */
2587 if (!FRAME_WINDOW_P (it
->f
)
2588 && !WINDOW_RIGHTMOST_P (it
->w
))
2589 it
->last_visible_x
-= 1;
2591 it
->last_visible_y
= window_text_bottom_y (w
);
2593 /* For mode lines and alike, arrange for the first glyph having a
2594 left box line if the face specifies a box. */
2595 if (base_face_id
!= DEFAULT_FACE_ID
)
2599 it
->face_id
= remapped_base_face_id
;
2601 /* If we have a boxed mode line, make the first character appear
2602 with a left box line. */
2603 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2604 if (face
->box
!= FACE_NO_BOX
)
2605 it
->start_of_box_run_p
= 1;
2608 /* If we are to reorder bidirectional text, init the bidi
2612 /* Note the paragraph direction that this buffer wants to
2614 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2615 it
->paragraph_embedding
= L2R
;
2616 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2617 it
->paragraph_embedding
= R2L
;
2619 it
->paragraph_embedding
= NEUTRAL_DIR
;
2620 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2623 /* If a buffer position was specified, set the iterator there,
2624 getting overlays and face properties from that position. */
2625 if (charpos
>= BUF_BEG (current_buffer
))
2627 it
->end_charpos
= ZV
;
2629 IT_CHARPOS (*it
) = charpos
;
2631 /* Compute byte position if not specified. */
2632 if (bytepos
< charpos
)
2633 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2635 IT_BYTEPOS (*it
) = bytepos
;
2637 it
->start
= it
->current
;
2639 /* Compute faces etc. */
2640 reseat (it
, it
->current
.pos
, 1);
2647 /* Initialize IT for the display of window W with window start POS. */
2650 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2652 struct glyph_row
*row
;
2653 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2655 row
= w
->desired_matrix
->rows
+ first_vpos
;
2656 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2657 it
->first_vpos
= first_vpos
;
2659 /* Don't reseat to previous visible line start if current start
2660 position is in a string or image. */
2661 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2663 int start_at_line_beg_p
;
2664 int first_y
= it
->current_y
;
2666 /* If window start is not at a line start, skip forward to POS to
2667 get the correct continuation lines width. */
2668 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2669 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2670 if (!start_at_line_beg_p
)
2674 reseat_at_previous_visible_line_start (it
);
2675 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2677 new_x
= it
->current_x
+ it
->pixel_width
;
2679 /* If lines are continued, this line may end in the middle
2680 of a multi-glyph character (e.g. a control character
2681 displayed as \003, or in the middle of an overlay
2682 string). In this case move_it_to above will not have
2683 taken us to the start of the continuation line but to the
2684 end of the continued line. */
2685 if (it
->current_x
> 0
2686 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2687 && (/* And glyph doesn't fit on the line. */
2688 new_x
> it
->last_visible_x
2689 /* Or it fits exactly and we're on a window
2691 || (new_x
== it
->last_visible_x
2692 && FRAME_WINDOW_P (it
->f
))))
2694 if (it
->current
.dpvec_index
>= 0
2695 || it
->current
.overlay_string_index
>= 0)
2697 set_iterator_to_next (it
, 1);
2698 move_it_in_display_line_to (it
, -1, -1, 0);
2701 it
->continuation_lines_width
+= it
->current_x
;
2704 /* We're starting a new display line, not affected by the
2705 height of the continued line, so clear the appropriate
2706 fields in the iterator structure. */
2707 it
->max_ascent
= it
->max_descent
= 0;
2708 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2710 it
->current_y
= first_y
;
2712 it
->current_x
= it
->hpos
= 0;
2718 /* Return 1 if POS is a position in ellipses displayed for invisible
2719 text. W is the window we display, for text property lookup. */
2722 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2724 Lisp_Object prop
, window
;
2726 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2728 /* If POS specifies a position in a display vector, this might
2729 be for an ellipsis displayed for invisible text. We won't
2730 get the iterator set up for delivering that ellipsis unless
2731 we make sure that it gets aware of the invisible text. */
2732 if (pos
->dpvec_index
>= 0
2733 && pos
->overlay_string_index
< 0
2734 && CHARPOS (pos
->string_pos
) < 0
2736 && (XSETWINDOW (window
, w
),
2737 prop
= Fget_char_property (make_number (charpos
),
2738 Qinvisible
, window
),
2739 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2741 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2743 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2750 /* Initialize IT for stepping through current_buffer in window W,
2751 starting at position POS that includes overlay string and display
2752 vector/ control character translation position information. Value
2753 is zero if there are overlay strings with newlines at POS. */
2756 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2758 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2759 int i
, overlay_strings_with_newlines
= 0;
2761 /* If POS specifies a position in a display vector, this might
2762 be for an ellipsis displayed for invisible text. We won't
2763 get the iterator set up for delivering that ellipsis unless
2764 we make sure that it gets aware of the invisible text. */
2765 if (in_ellipses_for_invisible_text_p (pos
, w
))
2771 /* Keep in mind: the call to reseat in init_iterator skips invisible
2772 text, so we might end up at a position different from POS. This
2773 is only a problem when POS is a row start after a newline and an
2774 overlay starts there with an after-string, and the overlay has an
2775 invisible property. Since we don't skip invisible text in
2776 display_line and elsewhere immediately after consuming the
2777 newline before the row start, such a POS will not be in a string,
2778 but the call to init_iterator below will move us to the
2780 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2782 /* This only scans the current chunk -- it should scan all chunks.
2783 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2784 to 16 in 22.1 to make this a lesser problem. */
2785 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2787 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2788 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2790 while (s
< e
&& *s
!= '\n')
2795 overlay_strings_with_newlines
= 1;
2800 /* If position is within an overlay string, set up IT to the right
2802 if (pos
->overlay_string_index
>= 0)
2806 /* If the first overlay string happens to have a `display'
2807 property for an image, the iterator will be set up for that
2808 image, and we have to undo that setup first before we can
2809 correct the overlay string index. */
2810 if (it
->method
== GET_FROM_IMAGE
)
2813 /* We already have the first chunk of overlay strings in
2814 IT->overlay_strings. Load more until the one for
2815 pos->overlay_string_index is in IT->overlay_strings. */
2816 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2818 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2819 it
->current
.overlay_string_index
= 0;
2822 load_overlay_strings (it
, 0);
2823 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2827 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2828 relative_index
= (it
->current
.overlay_string_index
2829 % OVERLAY_STRING_CHUNK_SIZE
);
2830 it
->string
= it
->overlay_strings
[relative_index
];
2831 xassert (STRINGP (it
->string
));
2832 it
->current
.string_pos
= pos
->string_pos
;
2833 it
->method
= GET_FROM_STRING
;
2836 if (CHARPOS (pos
->string_pos
) >= 0)
2838 /* Recorded position is not in an overlay string, but in another
2839 string. This can only be a string from a `display' property.
2840 IT should already be filled with that string. */
2841 it
->current
.string_pos
= pos
->string_pos
;
2842 xassert (STRINGP (it
->string
));
2845 /* Restore position in display vector translations, control
2846 character translations or ellipses. */
2847 if (pos
->dpvec_index
>= 0)
2849 if (it
->dpvec
== NULL
)
2850 get_next_display_element (it
);
2851 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2852 it
->current
.dpvec_index
= pos
->dpvec_index
;
2856 return !overlay_strings_with_newlines
;
2860 /* Initialize IT for stepping through current_buffer in window W
2861 starting at ROW->start. */
2864 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2866 init_from_display_pos (it
, w
, &row
->start
);
2867 it
->start
= row
->start
;
2868 it
->continuation_lines_width
= row
->continuation_lines_width
;
2873 /* Initialize IT for stepping through current_buffer in window W
2874 starting in the line following ROW, i.e. starting at ROW->end.
2875 Value is zero if there are overlay strings with newlines at ROW's
2879 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2883 if (init_from_display_pos (it
, w
, &row
->end
))
2885 if (row
->continued_p
)
2886 it
->continuation_lines_width
2887 = row
->continuation_lines_width
+ row
->pixel_width
;
2898 /***********************************************************************
2900 ***********************************************************************/
2902 /* Called when IT reaches IT->stop_charpos. Handle text property and
2903 overlay changes. Set IT->stop_charpos to the next position where
2907 handle_stop (struct it
*it
)
2909 enum prop_handled handled
;
2910 int handle_overlay_change_p
;
2914 it
->current
.dpvec_index
= -1;
2915 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2916 it
->ignore_overlay_strings_at_pos_p
= 0;
2919 /* Use face of preceding text for ellipsis (if invisible) */
2920 if (it
->selective_display_ellipsis_p
)
2921 it
->saved_face_id
= it
->face_id
;
2925 handled
= HANDLED_NORMALLY
;
2927 /* Call text property handlers. */
2928 for (p
= it_props
; p
->handler
; ++p
)
2930 handled
= p
->handler (it
);
2932 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2934 else if (handled
== HANDLED_RETURN
)
2936 /* We still want to show before and after strings from
2937 overlays even if the actual buffer text is replaced. */
2938 if (!handle_overlay_change_p
2940 || !get_overlay_strings_1 (it
, 0, 0))
2943 setup_for_ellipsis (it
, 0);
2944 /* When handling a display spec, we might load an
2945 empty string. In that case, discard it here. We
2946 used to discard it in handle_single_display_spec,
2947 but that causes get_overlay_strings_1, above, to
2948 ignore overlay strings that we must check. */
2949 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2957 it
->ignore_overlay_strings_at_pos_p
= 1;
2958 it
->string_from_display_prop_p
= 0;
2959 handle_overlay_change_p
= 0;
2961 handled
= HANDLED_RECOMPUTE_PROPS
;
2964 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2965 handle_overlay_change_p
= 0;
2968 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2970 /* Don't check for overlay strings below when set to deliver
2971 characters from a display vector. */
2972 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2973 handle_overlay_change_p
= 0;
2975 /* Handle overlay changes.
2976 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2977 if it finds overlays. */
2978 if (handle_overlay_change_p
)
2979 handled
= handle_overlay_change (it
);
2984 setup_for_ellipsis (it
, 0);
2988 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2990 /* Determine where to stop next. */
2991 if (handled
== HANDLED_NORMALLY
)
2992 compute_stop_pos (it
);
2996 /* Compute IT->stop_charpos from text property and overlay change
2997 information for IT's current position. */
3000 compute_stop_pos (struct it
*it
)
3002 register INTERVAL iv
, next_iv
;
3003 Lisp_Object object
, limit
, position
;
3004 EMACS_INT charpos
, bytepos
;
3006 /* If nowhere else, stop at the end. */
3007 it
->stop_charpos
= it
->end_charpos
;
3009 if (STRINGP (it
->string
))
3011 /* Strings are usually short, so don't limit the search for
3013 object
= it
->string
;
3015 charpos
= IT_STRING_CHARPOS (*it
);
3016 bytepos
= IT_STRING_BYTEPOS (*it
);
3022 /* If next overlay change is in front of the current stop pos
3023 (which is IT->end_charpos), stop there. Note: value of
3024 next_overlay_change is point-max if no overlay change
3026 charpos
= IT_CHARPOS (*it
);
3027 bytepos
= IT_BYTEPOS (*it
);
3028 pos
= next_overlay_change (charpos
);
3029 if (pos
< it
->stop_charpos
)
3030 it
->stop_charpos
= pos
;
3032 /* If showing the region, we have to stop at the region
3033 start or end because the face might change there. */
3034 if (it
->region_beg_charpos
> 0)
3036 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3037 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3038 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3039 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3042 /* Set up variables for computing the stop position from text
3043 property changes. */
3044 XSETBUFFER (object
, current_buffer
);
3045 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3048 /* Get the interval containing IT's position. Value is a null
3049 interval if there isn't such an interval. */
3050 position
= make_number (charpos
);
3051 iv
= validate_interval_range (object
, &position
, &position
, 0);
3052 if (!NULL_INTERVAL_P (iv
))
3054 Lisp_Object values_here
[LAST_PROP_IDX
];
3057 /* Get properties here. */
3058 for (p
= it_props
; p
->handler
; ++p
)
3059 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3061 /* Look for an interval following iv that has different
3063 for (next_iv
= next_interval (iv
);
3064 (!NULL_INTERVAL_P (next_iv
)
3066 || XFASTINT (limit
) > next_iv
->position
));
3067 next_iv
= next_interval (next_iv
))
3069 for (p
= it_props
; p
->handler
; ++p
)
3071 Lisp_Object new_value
;
3073 new_value
= textget (next_iv
->plist
, *p
->name
);
3074 if (!EQ (values_here
[p
->idx
], new_value
))
3082 if (!NULL_INTERVAL_P (next_iv
))
3084 if (INTEGERP (limit
)
3085 && next_iv
->position
>= XFASTINT (limit
))
3086 /* No text property change up to limit. */
3087 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3089 /* Text properties change in next_iv. */
3090 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3094 if (it
->cmp_it
.id
< 0)
3096 EMACS_INT stoppos
= it
->end_charpos
;
3098 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3100 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3101 stoppos
, it
->string
);
3104 xassert (STRINGP (it
->string
)
3105 || (it
->stop_charpos
>= BEGV
3106 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3110 /* Return the position of the next overlay change after POS in
3111 current_buffer. Value is point-max if no overlay change
3112 follows. This is like `next-overlay-change' but doesn't use
3116 next_overlay_change (EMACS_INT pos
)
3120 Lisp_Object
*overlays
;
3123 /* Get all overlays at the given position. */
3124 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3126 /* If any of these overlays ends before endpos,
3127 use its ending point instead. */
3128 for (i
= 0; i
< noverlays
; ++i
)
3133 oend
= OVERLAY_END (overlays
[i
]);
3134 oendpos
= OVERLAY_POSITION (oend
);
3135 endpos
= min (endpos
, oendpos
);
3143 /***********************************************************************
3145 ***********************************************************************/
3147 /* Handle changes in the `fontified' property of the current buffer by
3148 calling hook functions from Qfontification_functions to fontify
3151 static enum prop_handled
3152 handle_fontified_prop (struct it
*it
)
3154 Lisp_Object prop
, pos
;
3155 enum prop_handled handled
= HANDLED_NORMALLY
;
3157 if (!NILP (Vmemory_full
))
3160 /* Get the value of the `fontified' property at IT's current buffer
3161 position. (The `fontified' property doesn't have a special
3162 meaning in strings.) If the value is nil, call functions from
3163 Qfontification_functions. */
3164 if (!STRINGP (it
->string
)
3166 && !NILP (Vfontification_functions
)
3167 && !NILP (Vrun_hooks
)
3168 && (pos
= make_number (IT_CHARPOS (*it
)),
3169 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3170 /* Ignore the special cased nil value always present at EOB since
3171 no amount of fontifying will be able to change it. */
3172 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3174 int count
= SPECPDL_INDEX ();
3177 val
= Vfontification_functions
;
3178 specbind (Qfontification_functions
, Qnil
);
3180 xassert (it
->end_charpos
== ZV
);
3182 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3183 safe_call1 (val
, pos
);
3186 Lisp_Object fns
, fn
;
3187 struct gcpro gcpro1
, gcpro2
;
3192 for (; CONSP (val
); val
= XCDR (val
))
3198 /* A value of t indicates this hook has a local
3199 binding; it means to run the global binding too.
3200 In a global value, t should not occur. If it
3201 does, we must ignore it to avoid an endless
3203 for (fns
= Fdefault_value (Qfontification_functions
);
3209 safe_call1 (fn
, pos
);
3213 safe_call1 (fn
, pos
);
3219 unbind_to (count
, Qnil
);
3221 /* The fontification code may have added/removed text.
3222 It could do even a lot worse, but let's at least protect against
3223 the most obvious case where only the text past `pos' gets changed',
3224 as is/was done in grep.el where some escapes sequences are turned
3225 into face properties (bug#7876). */
3226 it
->end_charpos
= ZV
;
3228 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3229 something. This avoids an endless loop if they failed to
3230 fontify the text for which reason ever. */
3231 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3232 handled
= HANDLED_RECOMPUTE_PROPS
;
3240 /***********************************************************************
3242 ***********************************************************************/
3244 /* Set up iterator IT from face properties at its current position.
3245 Called from handle_stop. */
3247 static enum prop_handled
3248 handle_face_prop (struct it
*it
)
3251 EMACS_INT next_stop
;
3253 if (!STRINGP (it
->string
))
3256 = face_at_buffer_position (it
->w
,
3258 it
->region_beg_charpos
,
3259 it
->region_end_charpos
,
3262 + TEXT_PROP_DISTANCE_LIMIT
),
3263 0, it
->base_face_id
);
3265 /* Is this a start of a run of characters with box face?
3266 Caveat: this can be called for a freshly initialized
3267 iterator; face_id is -1 in this case. We know that the new
3268 face will not change until limit, i.e. if the new face has a
3269 box, all characters up to limit will have one. But, as
3270 usual, we don't know whether limit is really the end. */
3271 if (new_face_id
!= it
->face_id
)
3273 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3275 /* If new face has a box but old face has not, this is
3276 the start of a run of characters with box, i.e. it has
3277 a shadow on the left side. The value of face_id of the
3278 iterator will be -1 if this is the initial call that gets
3279 the face. In this case, we have to look in front of IT's
3280 position and see whether there is a face != new_face_id. */
3281 it
->start_of_box_run_p
3282 = (new_face
->box
!= FACE_NO_BOX
3283 && (it
->face_id
>= 0
3284 || IT_CHARPOS (*it
) == BEG
3285 || new_face_id
!= face_before_it_pos (it
)));
3286 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3294 Lisp_Object from_overlay
3295 = (it
->current
.overlay_string_index
>= 0
3296 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3299 /* See if we got to this string directly or indirectly from
3300 an overlay property. That includes the before-string or
3301 after-string of an overlay, strings in display properties
3302 provided by an overlay, their text properties, etc.
3304 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3305 if (! NILP (from_overlay
))
3306 for (i
= it
->sp
- 1; i
>= 0; i
--)
3308 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3310 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3311 else if (! NILP (it
->stack
[i
].from_overlay
))
3312 from_overlay
= it
->stack
[i
].from_overlay
;
3314 if (!NILP (from_overlay
))
3318 if (! NILP (from_overlay
))
3320 bufpos
= IT_CHARPOS (*it
);
3321 /* For a string from an overlay, the base face depends
3322 only on text properties and ignores overlays. */
3324 = face_for_overlay_string (it
->w
,
3326 it
->region_beg_charpos
,
3327 it
->region_end_charpos
,
3330 + TEXT_PROP_DISTANCE_LIMIT
),
3338 /* For strings from a `display' property, use the face at
3339 IT's current buffer position as the base face to merge
3340 with, so that overlay strings appear in the same face as
3341 surrounding text, unless they specify their own
3343 base_face_id
= underlying_face_id (it
);
3346 new_face_id
= face_at_string_position (it
->w
,
3348 IT_STRING_CHARPOS (*it
),
3350 it
->region_beg_charpos
,
3351 it
->region_end_charpos
,
3355 /* Is this a start of a run of characters with box? Caveat:
3356 this can be called for a freshly allocated iterator; face_id
3357 is -1 is this case. We know that the new face will not
3358 change until the next check pos, i.e. if the new face has a
3359 box, all characters up to that position will have a
3360 box. But, as usual, we don't know whether that position
3361 is really the end. */
3362 if (new_face_id
!= it
->face_id
)
3364 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3365 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3367 /* If new face has a box but old face hasn't, this is the
3368 start of a run of characters with box, i.e. it has a
3369 shadow on the left side. */
3370 it
->start_of_box_run_p
3371 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3372 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3376 it
->face_id
= new_face_id
;
3377 return HANDLED_NORMALLY
;
3381 /* Return the ID of the face ``underlying'' IT's current position,
3382 which is in a string. If the iterator is associated with a
3383 buffer, return the face at IT's current buffer position.
3384 Otherwise, use the iterator's base_face_id. */
3387 underlying_face_id (struct it
*it
)
3389 int face_id
= it
->base_face_id
, i
;
3391 xassert (STRINGP (it
->string
));
3393 for (i
= it
->sp
- 1; i
>= 0; --i
)
3394 if (NILP (it
->stack
[i
].string
))
3395 face_id
= it
->stack
[i
].face_id
;
3401 /* Compute the face one character before or after the current position
3402 of IT. BEFORE_P non-zero means get the face in front of IT's
3403 position. Value is the id of the face. */
3406 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3409 EMACS_INT next_check_charpos
;
3410 struct text_pos pos
;
3412 xassert (it
->s
== NULL
);
3414 if (STRINGP (it
->string
))
3419 /* No face change past the end of the string (for the case
3420 we are padding with spaces). No face change before the
3422 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3423 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3426 /* Set pos to the position before or after IT's current position. */
3428 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3430 /* For composition, we must check the character after the
3432 pos
= (it
->what
== IT_COMPOSITION
3433 ? string_pos (IT_STRING_CHARPOS (*it
)
3434 + it
->cmp_it
.nchars
, it
->string
)
3435 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3437 if (it
->current
.overlay_string_index
>= 0)
3438 bufpos
= IT_CHARPOS (*it
);
3442 base_face_id
= underlying_face_id (it
);
3444 /* Get the face for ASCII, or unibyte. */
3445 face_id
= face_at_string_position (it
->w
,
3449 it
->region_beg_charpos
,
3450 it
->region_end_charpos
,
3451 &next_check_charpos
,
3454 /* Correct the face for charsets different from ASCII. Do it
3455 for the multibyte case only. The face returned above is
3456 suitable for unibyte text if IT->string is unibyte. */
3457 if (STRING_MULTIBYTE (it
->string
))
3459 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3461 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3463 c
= string_char_and_length (p
, &len
);
3464 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3469 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3470 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3473 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3474 pos
= it
->current
.pos
;
3477 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3480 if (it
->what
== IT_COMPOSITION
)
3481 /* For composition, we must check the position after the
3483 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3485 INC_TEXT_POS (pos
, it
->multibyte_p
);
3488 /* Determine face for CHARSET_ASCII, or unibyte. */
3489 face_id
= face_at_buffer_position (it
->w
,
3491 it
->region_beg_charpos
,
3492 it
->region_end_charpos
,
3493 &next_check_charpos
,
3496 /* Correct the face for charsets different from ASCII. Do it
3497 for the multibyte case only. The face returned above is
3498 suitable for unibyte text if current_buffer is unibyte. */
3499 if (it
->multibyte_p
)
3501 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3502 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3503 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3512 /***********************************************************************
3514 ***********************************************************************/
3516 /* Set up iterator IT from invisible properties at its current
3517 position. Called from handle_stop. */
3519 static enum prop_handled
3520 handle_invisible_prop (struct it
*it
)
3522 enum prop_handled handled
= HANDLED_NORMALLY
;
3524 if (STRINGP (it
->string
))
3526 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3528 /* Get the value of the invisible text property at the
3529 current position. Value will be nil if there is no such
3531 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3532 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3535 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3537 handled
= HANDLED_RECOMPUTE_PROPS
;
3539 /* Get the position at which the next change of the
3540 invisible text property can be found in IT->string.
3541 Value will be nil if the property value is the same for
3542 all the rest of IT->string. */
3543 XSETINT (limit
, SCHARS (it
->string
));
3544 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3547 /* Text at current position is invisible. The next
3548 change in the property is at position end_charpos.
3549 Move IT's current position to that position. */
3550 if (INTEGERP (end_charpos
)
3551 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3553 struct text_pos old
;
3554 old
= it
->current
.string_pos
;
3555 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3556 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3560 /* The rest of the string is invisible. If this is an
3561 overlay string, proceed with the next overlay string
3562 or whatever comes and return a character from there. */
3563 if (it
->current
.overlay_string_index
>= 0)
3565 next_overlay_string (it
);
3566 /* Don't check for overlay strings when we just
3567 finished processing them. */
3568 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3572 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3573 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3581 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3582 Lisp_Object pos
, prop
, overlay
;
3584 /* First of all, is there invisible text at this position? */
3585 tem
= start_charpos
= IT_CHARPOS (*it
);
3586 pos
= make_number (tem
);
3587 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3589 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3591 /* If we are on invisible text, skip over it. */
3592 if (invis_p
&& start_charpos
< it
->end_charpos
)
3594 /* Record whether we have to display an ellipsis for the
3596 int display_ellipsis_p
= invis_p
== 2;
3598 handled
= HANDLED_RECOMPUTE_PROPS
;
3600 /* Loop skipping over invisible text. The loop is left at
3601 ZV or with IT on the first char being visible again. */
3604 /* Try to skip some invisible text. Return value is the
3605 position reached which can be equal to where we start
3606 if there is nothing invisible there. This skips both
3607 over invisible text properties and overlays with
3608 invisible property. */
3609 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3611 /* If we skipped nothing at all we weren't at invisible
3612 text in the first place. If everything to the end of
3613 the buffer was skipped, end the loop. */
3614 if (newpos
== tem
|| newpos
>= ZV
)
3618 /* We skipped some characters but not necessarily
3619 all there are. Check if we ended up on visible
3620 text. Fget_char_property returns the property of
3621 the char before the given position, i.e. if we
3622 get invis_p = 0, this means that the char at
3623 newpos is visible. */
3624 pos
= make_number (newpos
);
3625 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3626 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3629 /* If we ended up on invisible text, proceed to
3630 skip starting with next_stop. */
3634 /* If there are adjacent invisible texts, don't lose the
3635 second one's ellipsis. */
3637 display_ellipsis_p
= 1;
3641 /* The position newpos is now either ZV or on visible text. */
3642 if (it
->bidi_p
&& newpos
< ZV
)
3644 /* With bidi iteration, the region of invisible text
3645 could start and/or end in the middle of a non-base
3646 embedding level. Therefore, we need to skip
3647 invisible text using the bidi iterator, starting at
3648 IT's current position, until we find ourselves
3649 outside the invisible text. Skipping invisible text
3650 _after_ bidi iteration avoids affecting the visual
3651 order of the displayed text when invisible properties
3652 are added or removed. */
3653 if (it
->bidi_it
.first_elt
)
3655 /* If we were `reseat'ed to a new paragraph,
3656 determine the paragraph base direction. We need
3657 to do it now because next_element_from_buffer may
3658 not have a chance to do it, if we are going to
3659 skip any text at the beginning, which resets the
3661 bidi_paragraph_init (it
->paragraph_embedding
,
3666 bidi_move_to_visually_next (&it
->bidi_it
);
3668 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3669 && it
->bidi_it
.charpos
< newpos
);
3670 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3671 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3672 /* If we overstepped NEWPOS, record its position in the
3673 iterator, so that we skip invisible text if later the
3674 bidi iteration lands us in the invisible region
3676 if (IT_CHARPOS (*it
) >= newpos
)
3677 it
->prev_stop
= newpos
;
3681 IT_CHARPOS (*it
) = newpos
;
3682 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3685 /* If there are before-strings at the start of invisible
3686 text, and the text is invisible because of a text
3687 property, arrange to show before-strings because 20.x did
3688 it that way. (If the text is invisible because of an
3689 overlay property instead of a text property, this is
3690 already handled in the overlay code.) */
3692 && get_overlay_strings (it
, it
->stop_charpos
))
3694 handled
= HANDLED_RECOMPUTE_PROPS
;
3695 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3697 else if (display_ellipsis_p
)
3699 /* Make sure that the glyphs of the ellipsis will get
3700 correct `charpos' values. If we would not update
3701 it->position here, the glyphs would belong to the
3702 last visible character _before_ the invisible
3703 text, which confuses `set_cursor_from_row'.
3705 We use the last invisible position instead of the
3706 first because this way the cursor is always drawn on
3707 the first "." of the ellipsis, whenever PT is inside
3708 the invisible text. Otherwise the cursor would be
3709 placed _after_ the ellipsis when the point is after the
3710 first invisible character. */
3711 if (!STRINGP (it
->object
))
3713 it
->position
.charpos
= newpos
- 1;
3714 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3717 /* Let the ellipsis display before
3718 considering any properties of the following char.
3719 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3720 handled
= HANDLED_RETURN
;
3729 /* Make iterator IT return `...' next.
3730 Replaces LEN characters from buffer. */
3733 setup_for_ellipsis (struct it
*it
, int len
)
3735 /* Use the display table definition for `...'. Invalid glyphs
3736 will be handled by the method returning elements from dpvec. */
3737 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3739 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3740 it
->dpvec
= v
->contents
;
3741 it
->dpend
= v
->contents
+ v
->size
;
3745 /* Default `...'. */
3746 it
->dpvec
= default_invis_vector
;
3747 it
->dpend
= default_invis_vector
+ 3;
3750 it
->dpvec_char_len
= len
;
3751 it
->current
.dpvec_index
= 0;
3752 it
->dpvec_face_id
= -1;
3754 /* Remember the current face id in case glyphs specify faces.
3755 IT's face is restored in set_iterator_to_next.
3756 saved_face_id was set to preceding char's face in handle_stop. */
3757 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3758 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3760 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3766 /***********************************************************************
3768 ***********************************************************************/
3770 /* Set up iterator IT from `display' property at its current position.
3771 Called from handle_stop.
3772 We return HANDLED_RETURN if some part of the display property
3773 overrides the display of the buffer text itself.
3774 Otherwise we return HANDLED_NORMALLY. */
3776 static enum prop_handled
3777 handle_display_prop (struct it
*it
)
3779 Lisp_Object prop
, object
, overlay
;
3780 struct text_pos
*position
;
3781 /* Nonzero if some property replaces the display of the text itself. */
3782 int display_replaced_p
= 0;
3784 if (STRINGP (it
->string
))
3786 object
= it
->string
;
3787 position
= &it
->current
.string_pos
;
3791 XSETWINDOW (object
, it
->w
);
3792 position
= &it
->current
.pos
;
3795 /* Reset those iterator values set from display property values. */
3796 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3797 it
->space_width
= Qnil
;
3798 it
->font_height
= Qnil
;
3801 /* We don't support recursive `display' properties, i.e. string
3802 values that have a string `display' property, that have a string
3803 `display' property etc. */
3804 if (!it
->string_from_display_prop_p
)
3805 it
->area
= TEXT_AREA
;
3807 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3808 Qdisplay
, object
, &overlay
);
3810 return HANDLED_NORMALLY
;
3811 /* Now OVERLAY is the overlay that gave us this property, or nil
3812 if it was a text property. */
3814 if (!STRINGP (it
->string
))
3815 object
= it
->w
->buffer
;
3818 /* Simple properties. */
3819 && !EQ (XCAR (prop
), Qimage
)
3820 && !EQ (XCAR (prop
), Qspace
)
3821 && !EQ (XCAR (prop
), Qwhen
)
3822 && !EQ (XCAR (prop
), Qslice
)
3823 && !EQ (XCAR (prop
), Qspace_width
)
3824 && !EQ (XCAR (prop
), Qheight
)
3825 && !EQ (XCAR (prop
), Qraise
)
3826 /* Marginal area specifications. */
3827 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3828 && !EQ (XCAR (prop
), Qleft_fringe
)
3829 && !EQ (XCAR (prop
), Qright_fringe
)
3830 && !NILP (XCAR (prop
)))
3832 for (; CONSP (prop
); prop
= XCDR (prop
))
3834 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3835 position
, display_replaced_p
))
3837 display_replaced_p
= 1;
3838 /* If some text in a string is replaced, `position' no
3839 longer points to the position of `object'. */
3840 if (STRINGP (object
))
3845 else if (VECTORP (prop
))
3848 for (i
= 0; i
< ASIZE (prop
); ++i
)
3849 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3850 position
, display_replaced_p
))
3852 display_replaced_p
= 1;
3853 /* If some text in a string is replaced, `position' no
3854 longer points to the position of `object'. */
3855 if (STRINGP (object
))
3861 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3863 display_replaced_p
= 1;
3866 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3870 /* Value is the position of the end of the `display' property starting
3871 at START_POS in OBJECT. */
3873 static struct text_pos
3874 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3877 struct text_pos end_pos
;
3879 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3880 Qdisplay
, object
, Qnil
);
3881 CHARPOS (end_pos
) = XFASTINT (end
);
3882 if (STRINGP (object
))
3883 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3885 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3891 /* Set up IT from a single `display' specification PROP. OBJECT
3892 is the object in which the `display' property was found. *POSITION
3893 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3894 means that we previously saw a display specification which already
3895 replaced text display with something else, for example an image;
3896 we ignore such properties after the first one has been processed.
3898 OVERLAY is the overlay this `display' property came from,
3899 or nil if it was a text property.
3901 If PROP is a `space' or `image' specification, and in some other
3902 cases too, set *POSITION to the position where the `display'
3905 Value is non-zero if something was found which replaces the display
3906 of buffer or string text. */
3909 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3910 Lisp_Object overlay
, struct text_pos
*position
,
3911 int display_replaced_before_p
)
3914 Lisp_Object location
, value
;
3915 struct text_pos start_pos
, save_pos
;
3918 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3919 If the result is non-nil, use VALUE instead of SPEC. */
3921 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3930 if (!NILP (form
) && !EQ (form
, Qt
))
3932 int count
= SPECPDL_INDEX ();
3933 struct gcpro gcpro1
;
3935 /* Bind `object' to the object having the `display' property, a
3936 buffer or string. Bind `position' to the position in the
3937 object where the property was found, and `buffer-position'
3938 to the current position in the buffer. */
3939 specbind (Qobject
, object
);
3940 specbind (Qposition
, make_number (CHARPOS (*position
)));
3941 specbind (Qbuffer_position
,
3942 make_number (STRINGP (object
)
3943 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3945 form
= safe_eval (form
);
3947 unbind_to (count
, Qnil
);
3953 /* Handle `(height HEIGHT)' specifications. */
3955 && EQ (XCAR (spec
), Qheight
)
3956 && CONSP (XCDR (spec
)))
3958 if (!FRAME_WINDOW_P (it
->f
))
3961 it
->font_height
= XCAR (XCDR (spec
));
3962 if (!NILP (it
->font_height
))
3964 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3965 int new_height
= -1;
3967 if (CONSP (it
->font_height
)
3968 && (EQ (XCAR (it
->font_height
), Qplus
)
3969 || EQ (XCAR (it
->font_height
), Qminus
))
3970 && CONSP (XCDR (it
->font_height
))
3971 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3973 /* `(+ N)' or `(- N)' where N is an integer. */
3974 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3975 if (EQ (XCAR (it
->font_height
), Qplus
))
3977 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3979 else if (FUNCTIONP (it
->font_height
))
3981 /* Call function with current height as argument.
3982 Value is the new height. */
3984 height
= safe_call1 (it
->font_height
,
3985 face
->lface
[LFACE_HEIGHT_INDEX
]);
3986 if (NUMBERP (height
))
3987 new_height
= XFLOATINT (height
);
3989 else if (NUMBERP (it
->font_height
))
3991 /* Value is a multiple of the canonical char height. */
3994 f
= FACE_FROM_ID (it
->f
,
3995 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3996 new_height
= (XFLOATINT (it
->font_height
)
3997 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4001 /* Evaluate IT->font_height with `height' bound to the
4002 current specified height to get the new height. */
4003 int count
= SPECPDL_INDEX ();
4005 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4006 value
= safe_eval (it
->font_height
);
4007 unbind_to (count
, Qnil
);
4009 if (NUMBERP (value
))
4010 new_height
= XFLOATINT (value
);
4014 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4020 /* Handle `(space-width WIDTH)'. */
4022 && EQ (XCAR (spec
), Qspace_width
)
4023 && CONSP (XCDR (spec
)))
4025 if (!FRAME_WINDOW_P (it
->f
))
4028 value
= XCAR (XCDR (spec
));
4029 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4030 it
->space_width
= value
;
4035 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4037 && EQ (XCAR (spec
), Qslice
))
4041 if (!FRAME_WINDOW_P (it
->f
))
4044 if (tem
= XCDR (spec
), CONSP (tem
))
4046 it
->slice
.x
= XCAR (tem
);
4047 if (tem
= XCDR (tem
), CONSP (tem
))
4049 it
->slice
.y
= XCAR (tem
);
4050 if (tem
= XCDR (tem
), CONSP (tem
))
4052 it
->slice
.width
= XCAR (tem
);
4053 if (tem
= XCDR (tem
), CONSP (tem
))
4054 it
->slice
.height
= XCAR (tem
);
4062 /* Handle `(raise FACTOR)'. */
4064 && EQ (XCAR (spec
), Qraise
)
4065 && CONSP (XCDR (spec
)))
4067 if (!FRAME_WINDOW_P (it
->f
))
4070 #ifdef HAVE_WINDOW_SYSTEM
4071 value
= XCAR (XCDR (spec
));
4072 if (NUMBERP (value
))
4074 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4075 it
->voffset
= - (XFLOATINT (value
)
4076 * (FONT_HEIGHT (face
->font
)));
4078 #endif /* HAVE_WINDOW_SYSTEM */
4083 /* Don't handle the other kinds of display specifications
4084 inside a string that we got from a `display' property. */
4085 if (it
->string_from_display_prop_p
)
4088 /* Characters having this form of property are not displayed, so
4089 we have to find the end of the property. */
4090 start_pos
= *position
;
4091 *position
= display_prop_end (it
, object
, start_pos
);
4094 /* Stop the scan at that end position--we assume that all
4095 text properties change there. */
4096 it
->stop_charpos
= position
->charpos
;
4098 /* Handle `(left-fringe BITMAP [FACE])'
4099 and `(right-fringe BITMAP [FACE])'. */
4101 && (EQ (XCAR (spec
), Qleft_fringe
)
4102 || EQ (XCAR (spec
), Qright_fringe
))
4103 && CONSP (XCDR (spec
)))
4105 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4108 if (!FRAME_WINDOW_P (it
->f
))
4109 /* If we return here, POSITION has been advanced
4110 across the text with this property. */
4113 #ifdef HAVE_WINDOW_SYSTEM
4114 value
= XCAR (XCDR (spec
));
4115 if (!SYMBOLP (value
)
4116 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4117 /* If we return here, POSITION has been advanced
4118 across the text with this property. */
4121 if (CONSP (XCDR (XCDR (spec
))))
4123 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4124 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4130 /* Save current settings of IT so that we can restore them
4131 when we are finished with the glyph property value. */
4133 save_pos
= it
->position
;
4134 it
->position
= *position
;
4136 it
->position
= save_pos
;
4138 it
->area
= TEXT_AREA
;
4139 it
->what
= IT_IMAGE
;
4140 it
->image_id
= -1; /* no image */
4141 it
->position
= start_pos
;
4142 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4143 it
->method
= GET_FROM_IMAGE
;
4144 it
->from_overlay
= Qnil
;
4145 it
->face_id
= face_id
;
4147 /* Say that we haven't consumed the characters with
4148 `display' property yet. The call to pop_it in
4149 set_iterator_to_next will clean this up. */
4150 *position
= start_pos
;
4152 if (EQ (XCAR (spec
), Qleft_fringe
))
4154 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4155 it
->left_user_fringe_face_id
= face_id
;
4159 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4160 it
->right_user_fringe_face_id
= face_id
;
4162 #endif /* HAVE_WINDOW_SYSTEM */
4166 /* Prepare to handle `((margin left-margin) ...)',
4167 `((margin right-margin) ...)' and `((margin nil) ...)'
4168 prefixes for display specifications. */
4169 location
= Qunbound
;
4170 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4174 value
= XCDR (spec
);
4176 value
= XCAR (value
);
4179 if (EQ (XCAR (tem
), Qmargin
)
4180 && (tem
= XCDR (tem
),
4181 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4183 || EQ (tem
, Qleft_margin
)
4184 || EQ (tem
, Qright_margin
))))
4188 if (EQ (location
, Qunbound
))
4194 /* After this point, VALUE is the property after any
4195 margin prefix has been stripped. It must be a string,
4196 an image specification, or `(space ...)'.
4198 LOCATION specifies where to display: `left-margin',
4199 `right-margin' or nil. */
4201 valid_p
= (STRINGP (value
)
4202 #ifdef HAVE_WINDOW_SYSTEM
4203 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4204 #endif /* not HAVE_WINDOW_SYSTEM */
4205 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4207 if (valid_p
&& !display_replaced_before_p
)
4209 /* Save current settings of IT so that we can restore them
4210 when we are finished with the glyph property value. */
4211 save_pos
= it
->position
;
4212 it
->position
= *position
;
4214 it
->position
= save_pos
;
4215 it
->from_overlay
= overlay
;
4217 if (NILP (location
))
4218 it
->area
= TEXT_AREA
;
4219 else if (EQ (location
, Qleft_margin
))
4220 it
->area
= LEFT_MARGIN_AREA
;
4222 it
->area
= RIGHT_MARGIN_AREA
;
4224 if (STRINGP (value
))
4227 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4228 it
->current
.overlay_string_index
= -1;
4229 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4230 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4231 it
->method
= GET_FROM_STRING
;
4232 it
->stop_charpos
= 0;
4233 it
->string_from_display_prop_p
= 1;
4234 /* Say that we haven't consumed the characters with
4235 `display' property yet. The call to pop_it in
4236 set_iterator_to_next will clean this up. */
4237 if (BUFFERP (object
))
4238 *position
= start_pos
;
4240 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4242 it
->method
= GET_FROM_STRETCH
;
4244 *position
= it
->position
= start_pos
;
4246 #ifdef HAVE_WINDOW_SYSTEM
4249 it
->what
= IT_IMAGE
;
4250 it
->image_id
= lookup_image (it
->f
, value
);
4251 it
->position
= start_pos
;
4252 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4253 it
->method
= GET_FROM_IMAGE
;
4255 /* Say that we haven't consumed the characters with
4256 `display' property yet. The call to pop_it in
4257 set_iterator_to_next will clean this up. */
4258 *position
= start_pos
;
4260 #endif /* HAVE_WINDOW_SYSTEM */
4265 /* Invalid property or property not supported. Restore
4266 POSITION to what it was before. */
4267 *position
= start_pos
;
4272 /* Check if SPEC is a display sub-property value whose text should be
4273 treated as intangible. */
4276 single_display_spec_intangible_p (Lisp_Object prop
)
4278 /* Skip over `when FORM'. */
4279 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4293 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4294 we don't need to treat text as intangible. */
4295 if (EQ (XCAR (prop
), Qmargin
))
4303 || EQ (XCAR (prop
), Qleft_margin
)
4304 || EQ (XCAR (prop
), Qright_margin
))
4308 return (CONSP (prop
)
4309 && (EQ (XCAR (prop
), Qimage
)
4310 || EQ (XCAR (prop
), Qspace
)));
4314 /* Check if PROP is a display property value whose text should be
4315 treated as intangible. */
4318 display_prop_intangible_p (Lisp_Object prop
)
4321 && CONSP (XCAR (prop
))
4322 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4324 /* A list of sub-properties. */
4325 while (CONSP (prop
))
4327 if (single_display_spec_intangible_p (XCAR (prop
)))
4332 else if (VECTORP (prop
))
4334 /* A vector of sub-properties. */
4336 for (i
= 0; i
< ASIZE (prop
); ++i
)
4337 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4341 return single_display_spec_intangible_p (prop
);
4347 /* Return 1 if PROP is a display sub-property value containing STRING. */
4350 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4352 if (EQ (string
, prop
))
4355 /* Skip over `when FORM'. */
4356 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4365 /* Skip over `margin LOCATION'. */
4366 if (EQ (XCAR (prop
), Qmargin
))
4377 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4381 /* Return 1 if STRING appears in the `display' property PROP. */
4384 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4387 && CONSP (XCAR (prop
))
4388 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4390 /* A list of sub-properties. */
4391 while (CONSP (prop
))
4393 if (single_display_spec_string_p (XCAR (prop
), string
))
4398 else if (VECTORP (prop
))
4400 /* A vector of sub-properties. */
4402 for (i
= 0; i
< ASIZE (prop
); ++i
)
4403 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4407 return single_display_spec_string_p (prop
, string
);
4412 /* Look for STRING in overlays and text properties in W's buffer,
4413 between character positions FROM and TO (excluding TO).
4414 BACK_P non-zero means look back (in this case, TO is supposed to be
4416 Value is the first character position where STRING was found, or
4417 zero if it wasn't found before hitting TO.
4419 W's buffer must be current.
4421 This function may only use code that doesn't eval because it is
4422 called asynchronously from note_mouse_highlight. */
4425 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4426 EMACS_INT from
, EMACS_INT to
, int back_p
)
4428 Lisp_Object limit
, prop
, pos
;
4431 pos
= make_number (from
);
4433 if (!back_p
) /* looking forward */
4435 limit
= make_number (min (to
, ZV
));
4436 while (!found
&& !EQ (pos
, limit
))
4438 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4439 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4442 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4446 else /* looking back */
4448 limit
= make_number (max (to
, BEGV
));
4449 while (!found
&& !EQ (pos
, limit
))
4451 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4452 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4455 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4460 return found
? XINT (pos
) : 0;
4463 /* Determine which buffer position in W's buffer STRING comes from.
4464 AROUND_CHARPOS is an approximate position where it could come from.
4465 Value is the buffer position or 0 if it couldn't be determined.
4467 W's buffer must be current.
4469 This function is necessary because we don't record buffer positions
4470 in glyphs generated from strings (to keep struct glyph small).
4471 This function may only use code that doesn't eval because it is
4472 called asynchronously from note_mouse_highlight. */
4475 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4477 const int MAX_DISTANCE
= 1000;
4478 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4479 around_charpos
+ MAX_DISTANCE
,
4483 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4484 around_charpos
- MAX_DISTANCE
, 1);
4490 /***********************************************************************
4491 `composition' property
4492 ***********************************************************************/
4494 /* Set up iterator IT from `composition' property at its current
4495 position. Called from handle_stop. */
4497 static enum prop_handled
4498 handle_composition_prop (struct it
*it
)
4500 Lisp_Object prop
, string
;
4501 EMACS_INT pos
, pos_byte
, start
, end
;
4503 if (STRINGP (it
->string
))
4507 pos
= IT_STRING_CHARPOS (*it
);
4508 pos_byte
= IT_STRING_BYTEPOS (*it
);
4509 string
= it
->string
;
4510 s
= SDATA (string
) + pos_byte
;
4511 it
->c
= STRING_CHAR (s
);
4515 pos
= IT_CHARPOS (*it
);
4516 pos_byte
= IT_BYTEPOS (*it
);
4518 it
->c
= FETCH_CHAR (pos_byte
);
4521 /* If there's a valid composition and point is not inside of the
4522 composition (in the case that the composition is from the current
4523 buffer), draw a glyph composed from the composition components. */
4524 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4525 && COMPOSITION_VALID_P (start
, end
, prop
)
4526 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4530 if (STRINGP (it
->string
))
4531 pos_byte
= string_char_to_byte (it
->string
, start
);
4533 pos_byte
= CHAR_TO_BYTE (start
);
4535 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4538 if (it
->cmp_it
.id
>= 0)
4541 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4542 it
->cmp_it
.nglyphs
= -1;
4546 return HANDLED_NORMALLY
;
4551 /***********************************************************************
4553 ***********************************************************************/
4555 /* The following structure is used to record overlay strings for
4556 later sorting in load_overlay_strings. */
4558 struct overlay_entry
4560 Lisp_Object overlay
;
4567 /* Set up iterator IT from overlay strings at its current position.
4568 Called from handle_stop. */
4570 static enum prop_handled
4571 handle_overlay_change (struct it
*it
)
4573 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4574 return HANDLED_RECOMPUTE_PROPS
;
4576 return HANDLED_NORMALLY
;
4580 /* Set up the next overlay string for delivery by IT, if there is an
4581 overlay string to deliver. Called by set_iterator_to_next when the
4582 end of the current overlay string is reached. If there are more
4583 overlay strings to display, IT->string and
4584 IT->current.overlay_string_index are set appropriately here.
4585 Otherwise IT->string is set to nil. */
4588 next_overlay_string (struct it
*it
)
4590 ++it
->current
.overlay_string_index
;
4591 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4593 /* No more overlay strings. Restore IT's settings to what
4594 they were before overlay strings were processed, and
4595 continue to deliver from current_buffer. */
4597 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4600 || (NILP (it
->string
)
4601 && it
->method
== GET_FROM_BUFFER
4602 && it
->stop_charpos
>= BEGV
4603 && it
->stop_charpos
<= it
->end_charpos
));
4604 it
->current
.overlay_string_index
= -1;
4605 it
->n_overlay_strings
= 0;
4606 it
->overlay_strings_charpos
= -1;
4608 /* If we're at the end of the buffer, record that we have
4609 processed the overlay strings there already, so that
4610 next_element_from_buffer doesn't try it again. */
4611 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4612 it
->overlay_strings_at_end_processed_p
= 1;
4616 /* There are more overlay strings to process. If
4617 IT->current.overlay_string_index has advanced to a position
4618 where we must load IT->overlay_strings with more strings, do
4619 it. We must load at the IT->overlay_strings_charpos where
4620 IT->n_overlay_strings was originally computed; when invisible
4621 text is present, this might not be IT_CHARPOS (Bug#7016). */
4622 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4624 if (it
->current
.overlay_string_index
&& i
== 0)
4625 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4627 /* Initialize IT to deliver display elements from the overlay
4629 it
->string
= it
->overlay_strings
[i
];
4630 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4631 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4632 it
->method
= GET_FROM_STRING
;
4633 it
->stop_charpos
= 0;
4634 if (it
->cmp_it
.stop_pos
>= 0)
4635 it
->cmp_it
.stop_pos
= 0;
4642 /* Compare two overlay_entry structures E1 and E2. Used as a
4643 comparison function for qsort in load_overlay_strings. Overlay
4644 strings for the same position are sorted so that
4646 1. All after-strings come in front of before-strings, except
4647 when they come from the same overlay.
4649 2. Within after-strings, strings are sorted so that overlay strings
4650 from overlays with higher priorities come first.
4652 2. Within before-strings, strings are sorted so that overlay
4653 strings from overlays with higher priorities come last.
4655 Value is analogous to strcmp. */
4659 compare_overlay_entries (const void *e1
, const void *e2
)
4661 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4662 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4665 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4667 /* Let after-strings appear in front of before-strings if
4668 they come from different overlays. */
4669 if (EQ (entry1
->overlay
, entry2
->overlay
))
4670 result
= entry1
->after_string_p
? 1 : -1;
4672 result
= entry1
->after_string_p
? -1 : 1;
4674 else if (entry1
->after_string_p
)
4675 /* After-strings sorted in order of decreasing priority. */
4676 result
= entry2
->priority
- entry1
->priority
;
4678 /* Before-strings sorted in order of increasing priority. */
4679 result
= entry1
->priority
- entry2
->priority
;
4685 /* Load the vector IT->overlay_strings with overlay strings from IT's
4686 current buffer position, or from CHARPOS if that is > 0. Set
4687 IT->n_overlays to the total number of overlay strings found.
4689 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4690 a time. On entry into load_overlay_strings,
4691 IT->current.overlay_string_index gives the number of overlay
4692 strings that have already been loaded by previous calls to this
4695 IT->add_overlay_start contains an additional overlay start
4696 position to consider for taking overlay strings from, if non-zero.
4697 This position comes into play when the overlay has an `invisible'
4698 property, and both before and after-strings. When we've skipped to
4699 the end of the overlay, because of its `invisible' property, we
4700 nevertheless want its before-string to appear.
4701 IT->add_overlay_start will contain the overlay start position
4704 Overlay strings are sorted so that after-string strings come in
4705 front of before-string strings. Within before and after-strings,
4706 strings are sorted by overlay priority. See also function
4707 compare_overlay_entries. */
4710 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4712 Lisp_Object overlay
, window
, str
, invisible
;
4713 struct Lisp_Overlay
*ov
;
4714 EMACS_INT start
, end
;
4716 int n
= 0, i
, j
, invis_p
;
4717 struct overlay_entry
*entries
4718 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4721 charpos
= IT_CHARPOS (*it
);
4723 /* Append the overlay string STRING of overlay OVERLAY to vector
4724 `entries' which has size `size' and currently contains `n'
4725 elements. AFTER_P non-zero means STRING is an after-string of
4727 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4730 Lisp_Object priority; \
4734 int new_size = 2 * size; \
4735 struct overlay_entry *old = entries; \
4737 (struct overlay_entry *) alloca (new_size \
4738 * sizeof *entries); \
4739 memcpy (entries, old, size * sizeof *entries); \
4743 entries[n].string = (STRING); \
4744 entries[n].overlay = (OVERLAY); \
4745 priority = Foverlay_get ((OVERLAY), Qpriority); \
4746 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4747 entries[n].after_string_p = (AFTER_P); \
4752 /* Process overlay before the overlay center. */
4753 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4755 XSETMISC (overlay
, ov
);
4756 xassert (OVERLAYP (overlay
));
4757 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4758 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4763 /* Skip this overlay if it doesn't start or end at IT's current
4765 if (end
!= charpos
&& start
!= charpos
)
4768 /* Skip this overlay if it doesn't apply to IT->w. */
4769 window
= Foverlay_get (overlay
, Qwindow
);
4770 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4773 /* If the text ``under'' the overlay is invisible, both before-
4774 and after-strings from this overlay are visible; start and
4775 end position are indistinguishable. */
4776 invisible
= Foverlay_get (overlay
, Qinvisible
);
4777 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4779 /* If overlay has a non-empty before-string, record it. */
4780 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4781 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4783 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4785 /* If overlay has a non-empty after-string, record it. */
4786 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4787 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4789 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4792 /* Process overlays after the overlay center. */
4793 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4795 XSETMISC (overlay
, ov
);
4796 xassert (OVERLAYP (overlay
));
4797 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4798 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4800 if (start
> charpos
)
4803 /* Skip this overlay if it doesn't start or end at IT's current
4805 if (end
!= charpos
&& start
!= charpos
)
4808 /* Skip this overlay if it doesn't apply to IT->w. */
4809 window
= Foverlay_get (overlay
, Qwindow
);
4810 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4813 /* If the text ``under'' the overlay is invisible, it has a zero
4814 dimension, and both before- and after-strings apply. */
4815 invisible
= Foverlay_get (overlay
, Qinvisible
);
4816 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4818 /* If overlay has a non-empty before-string, record it. */
4819 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4820 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4822 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4824 /* If overlay has a non-empty after-string, record it. */
4825 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4826 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4828 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4831 #undef RECORD_OVERLAY_STRING
4835 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4837 /* Record number of overlay strings, and where we computed it. */
4838 it
->n_overlay_strings
= n
;
4839 it
->overlay_strings_charpos
= charpos
;
4841 /* IT->current.overlay_string_index is the number of overlay strings
4842 that have already been consumed by IT. Copy some of the
4843 remaining overlay strings to IT->overlay_strings. */
4845 j
= it
->current
.overlay_string_index
;
4846 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4848 it
->overlay_strings
[i
] = entries
[j
].string
;
4849 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4856 /* Get the first chunk of overlay strings at IT's current buffer
4857 position, or at CHARPOS if that is > 0. Value is non-zero if at
4858 least one overlay string was found. */
4861 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4863 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4864 process. This fills IT->overlay_strings with strings, and sets
4865 IT->n_overlay_strings to the total number of strings to process.
4866 IT->pos.overlay_string_index has to be set temporarily to zero
4867 because load_overlay_strings needs this; it must be set to -1
4868 when no overlay strings are found because a zero value would
4869 indicate a position in the first overlay string. */
4870 it
->current
.overlay_string_index
= 0;
4871 load_overlay_strings (it
, charpos
);
4873 /* If we found overlay strings, set up IT to deliver display
4874 elements from the first one. Otherwise set up IT to deliver
4875 from current_buffer. */
4876 if (it
->n_overlay_strings
)
4878 /* Make sure we know settings in current_buffer, so that we can
4879 restore meaningful values when we're done with the overlay
4882 compute_stop_pos (it
);
4883 xassert (it
->face_id
>= 0);
4885 /* Save IT's settings. They are restored after all overlay
4886 strings have been processed. */
4887 xassert (!compute_stop_p
|| it
->sp
== 0);
4889 /* When called from handle_stop, there might be an empty display
4890 string loaded. In that case, don't bother saving it. */
4891 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4894 /* Set up IT to deliver display elements from the first overlay
4896 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4897 it
->string
= it
->overlay_strings
[0];
4898 it
->from_overlay
= Qnil
;
4899 it
->stop_charpos
= 0;
4900 xassert (STRINGP (it
->string
));
4901 it
->end_charpos
= SCHARS (it
->string
);
4902 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4903 it
->method
= GET_FROM_STRING
;
4907 it
->current
.overlay_string_index
= -1;
4912 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4915 it
->method
= GET_FROM_BUFFER
;
4917 (void) get_overlay_strings_1 (it
, charpos
, 1);
4921 /* Value is non-zero if we found at least one overlay string. */
4922 return STRINGP (it
->string
);
4927 /***********************************************************************
4928 Saving and restoring state
4929 ***********************************************************************/
4931 /* Save current settings of IT on IT->stack. Called, for example,
4932 before setting up IT for an overlay string, to be able to restore
4933 IT's settings to what they were after the overlay string has been
4937 push_it (struct it
*it
)
4939 struct iterator_stack_entry
*p
;
4941 xassert (it
->sp
< IT_STACK_SIZE
);
4942 p
= it
->stack
+ it
->sp
;
4944 p
->stop_charpos
= it
->stop_charpos
;
4945 p
->prev_stop
= it
->prev_stop
;
4946 p
->base_level_stop
= it
->base_level_stop
;
4947 p
->cmp_it
= it
->cmp_it
;
4948 xassert (it
->face_id
>= 0);
4949 p
->face_id
= it
->face_id
;
4950 p
->string
= it
->string
;
4951 p
->method
= it
->method
;
4952 p
->from_overlay
= it
->from_overlay
;
4955 case GET_FROM_IMAGE
:
4956 p
->u
.image
.object
= it
->object
;
4957 p
->u
.image
.image_id
= it
->image_id
;
4958 p
->u
.image
.slice
= it
->slice
;
4960 case GET_FROM_STRETCH
:
4961 p
->u
.stretch
.object
= it
->object
;
4964 p
->position
= it
->position
;
4965 p
->current
= it
->current
;
4966 p
->end_charpos
= it
->end_charpos
;
4967 p
->string_nchars
= it
->string_nchars
;
4969 p
->multibyte_p
= it
->multibyte_p
;
4970 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4971 p
->space_width
= it
->space_width
;
4972 p
->font_height
= it
->font_height
;
4973 p
->voffset
= it
->voffset
;
4974 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4975 p
->display_ellipsis_p
= 0;
4976 p
->line_wrap
= it
->line_wrap
;
4981 iterate_out_of_display_property (struct it
*it
)
4983 /* Maybe initialize paragraph direction. If we are at the beginning
4984 of a new paragraph, next_element_from_buffer may not have a
4985 chance to do that. */
4986 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4987 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4988 /* prev_stop can be zero, so check against BEGV as well. */
4989 while (it
->bidi_it
.charpos
>= BEGV
4990 && it
->prev_stop
<= it
->bidi_it
.charpos
4991 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4992 bidi_move_to_visually_next (&it
->bidi_it
);
4993 /* Record the stop_pos we just crossed, for when we cross it
4995 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4996 it
->prev_stop
= CHARPOS (it
->position
);
4997 /* If we ended up not where pop_it put us, resync IT's
4998 positional members with the bidi iterator. */
4999 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5001 SET_TEXT_POS (it
->position
,
5002 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5003 it
->current
.pos
= it
->position
;
5007 /* Restore IT's settings from IT->stack. Called, for example, when no
5008 more overlay strings must be processed, and we return to delivering
5009 display elements from a buffer, or when the end of a string from a
5010 `display' property is reached and we return to delivering display
5011 elements from an overlay string, or from a buffer. */
5014 pop_it (struct it
*it
)
5016 struct iterator_stack_entry
*p
;
5018 xassert (it
->sp
> 0);
5020 p
= it
->stack
+ it
->sp
;
5021 it
->stop_charpos
= p
->stop_charpos
;
5022 it
->prev_stop
= p
->prev_stop
;
5023 it
->base_level_stop
= p
->base_level_stop
;
5024 it
->cmp_it
= p
->cmp_it
;
5025 it
->face_id
= p
->face_id
;
5026 it
->current
= p
->current
;
5027 it
->position
= p
->position
;
5028 it
->string
= p
->string
;
5029 it
->from_overlay
= p
->from_overlay
;
5030 if (NILP (it
->string
))
5031 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5032 it
->method
= p
->method
;
5035 case GET_FROM_IMAGE
:
5036 it
->image_id
= p
->u
.image
.image_id
;
5037 it
->object
= p
->u
.image
.object
;
5038 it
->slice
= p
->u
.image
.slice
;
5040 case GET_FROM_STRETCH
:
5041 it
->object
= p
->u
.comp
.object
;
5043 case GET_FROM_BUFFER
:
5044 it
->object
= it
->w
->buffer
;
5047 /* Bidi-iterate until we get out of the portion of text, if
5048 any, covered by a `display' text property or an overlay
5049 with `display' property. (We cannot just jump there,
5050 because the internal coherency of the bidi iterator state
5051 can not be preserved across such jumps.) We also must
5052 determine the paragraph base direction if the overlay we
5053 just processed is at the beginning of a new
5055 iterate_out_of_display_property (it
);
5058 case GET_FROM_STRING
:
5059 it
->object
= it
->string
;
5061 case GET_FROM_DISPLAY_VECTOR
:
5063 it
->method
= GET_FROM_C_STRING
;
5064 else if (STRINGP (it
->string
))
5065 it
->method
= GET_FROM_STRING
;
5068 it
->method
= GET_FROM_BUFFER
;
5069 it
->object
= it
->w
->buffer
;
5072 it
->end_charpos
= p
->end_charpos
;
5073 it
->string_nchars
= p
->string_nchars
;
5075 it
->multibyte_p
= p
->multibyte_p
;
5076 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5077 it
->space_width
= p
->space_width
;
5078 it
->font_height
= p
->font_height
;
5079 it
->voffset
= p
->voffset
;
5080 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5081 it
->line_wrap
= p
->line_wrap
;
5086 /***********************************************************************
5088 ***********************************************************************/
5090 /* Set IT's current position to the previous line start. */
5093 back_to_previous_line_start (struct it
*it
)
5095 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5096 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5100 /* Move IT to the next line start.
5102 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5103 we skipped over part of the text (as opposed to moving the iterator
5104 continuously over the text). Otherwise, don't change the value
5107 Newlines may come from buffer text, overlay strings, or strings
5108 displayed via the `display' property. That's the reason we can't
5109 simply use find_next_newline_no_quit.
5111 Note that this function may not skip over invisible text that is so
5112 because of text properties and immediately follows a newline. If
5113 it would, function reseat_at_next_visible_line_start, when called
5114 from set_iterator_to_next, would effectively make invisible
5115 characters following a newline part of the wrong glyph row, which
5116 leads to wrong cursor motion. */
5119 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5121 int old_selective
, newline_found_p
, n
;
5122 const int MAX_NEWLINE_DISTANCE
= 500;
5124 /* If already on a newline, just consume it to avoid unintended
5125 skipping over invisible text below. */
5126 if (it
->what
== IT_CHARACTER
5128 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5130 set_iterator_to_next (it
, 0);
5135 /* Don't handle selective display in the following. It's (a)
5136 unnecessary because it's done by the caller, and (b) leads to an
5137 infinite recursion because next_element_from_ellipsis indirectly
5138 calls this function. */
5139 old_selective
= it
->selective
;
5142 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5143 from buffer text. */
5144 for (n
= newline_found_p
= 0;
5145 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5146 n
+= STRINGP (it
->string
) ? 0 : 1)
5148 if (!get_next_display_element (it
))
5150 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5151 set_iterator_to_next (it
, 0);
5154 /* If we didn't find a newline near enough, see if we can use a
5156 if (!newline_found_p
)
5158 EMACS_INT start
= IT_CHARPOS (*it
);
5159 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5162 xassert (!STRINGP (it
->string
));
5164 /* If there isn't any `display' property in sight, and no
5165 overlays, we can just use the position of the newline in
5167 if (it
->stop_charpos
>= limit
5168 || ((pos
= Fnext_single_property_change (make_number (start
),
5170 Qnil
, make_number (limit
)),
5172 && next_overlay_change (start
) == ZV
))
5174 IT_CHARPOS (*it
) = limit
;
5175 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5176 *skipped_p
= newline_found_p
= 1;
5180 while (get_next_display_element (it
)
5181 && !newline_found_p
)
5183 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5184 set_iterator_to_next (it
, 0);
5189 it
->selective
= old_selective
;
5190 return newline_found_p
;
5194 /* Set IT's current position to the previous visible line start. Skip
5195 invisible text that is so either due to text properties or due to
5196 selective display. Caution: this does not change IT->current_x and
5200 back_to_previous_visible_line_start (struct it
*it
)
5202 while (IT_CHARPOS (*it
) > BEGV
)
5204 back_to_previous_line_start (it
);
5206 if (IT_CHARPOS (*it
) <= BEGV
)
5209 /* If selective > 0, then lines indented more than its value are
5211 if (it
->selective
> 0
5212 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5213 (double) it
->selective
)) /* iftc */
5216 /* Check the newline before point for invisibility. */
5219 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5220 Qinvisible
, it
->window
);
5221 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5225 if (IT_CHARPOS (*it
) <= BEGV
)
5232 Lisp_Object val
, overlay
;
5234 /* If newline is part of a composition, continue from start of composition */
5235 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5236 && beg
< IT_CHARPOS (*it
))
5239 /* If newline is replaced by a display property, find start of overlay
5240 or interval and continue search from that point. */
5242 pos
= --IT_CHARPOS (it2
);
5245 it2
.string_from_display_prop_p
= 0;
5246 if (handle_display_prop (&it2
) == HANDLED_RETURN
5247 && !NILP (val
= get_char_property_and_overlay
5248 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5249 && (OVERLAYP (overlay
)
5250 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5251 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5254 /* Newline is not replaced by anything -- so we are done. */
5260 IT_CHARPOS (*it
) = beg
;
5261 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5265 it
->continuation_lines_width
= 0;
5267 xassert (IT_CHARPOS (*it
) >= BEGV
);
5268 xassert (IT_CHARPOS (*it
) == BEGV
5269 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5274 /* Reseat iterator IT at the previous visible line start. Skip
5275 invisible text that is so either due to text properties or due to
5276 selective display. At the end, update IT's overlay information,
5277 face information etc. */
5280 reseat_at_previous_visible_line_start (struct it
*it
)
5282 back_to_previous_visible_line_start (it
);
5283 reseat (it
, it
->current
.pos
, 1);
5288 /* Reseat iterator IT on the next visible line start in the current
5289 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5290 preceding the line start. Skip over invisible text that is so
5291 because of selective display. Compute faces, overlays etc at the
5292 new position. Note that this function does not skip over text that
5293 is invisible because of text properties. */
5296 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5298 int newline_found_p
, skipped_p
= 0;
5300 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5302 /* Skip over lines that are invisible because they are indented
5303 more than the value of IT->selective. */
5304 if (it
->selective
> 0)
5305 while (IT_CHARPOS (*it
) < ZV
5306 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5307 (double) it
->selective
)) /* iftc */
5309 xassert (IT_BYTEPOS (*it
) == BEGV
5310 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5311 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5314 /* Position on the newline if that's what's requested. */
5315 if (on_newline_p
&& newline_found_p
)
5317 if (STRINGP (it
->string
))
5319 if (IT_STRING_CHARPOS (*it
) > 0)
5321 --IT_STRING_CHARPOS (*it
);
5322 --IT_STRING_BYTEPOS (*it
);
5325 else if (IT_CHARPOS (*it
) > BEGV
)
5329 reseat (it
, it
->current
.pos
, 0);
5333 reseat (it
, it
->current
.pos
, 0);
5340 /***********************************************************************
5341 Changing an iterator's position
5342 ***********************************************************************/
5344 /* Change IT's current position to POS in current_buffer. If FORCE_P
5345 is non-zero, always check for text properties at the new position.
5346 Otherwise, text properties are only looked up if POS >=
5347 IT->check_charpos of a property. */
5350 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5352 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5354 reseat_1 (it
, pos
, 0);
5356 /* Determine where to check text properties. Avoid doing it
5357 where possible because text property lookup is very expensive. */
5359 || CHARPOS (pos
) > it
->stop_charpos
5360 || CHARPOS (pos
) < original_pos
)
5364 /* For bidi iteration, we need to prime prev_stop and
5365 base_level_stop with our best estimations. */
5366 if (CHARPOS (pos
) < it
->prev_stop
)
5368 handle_stop_backwards (it
, BEGV
);
5369 if (CHARPOS (pos
) < it
->base_level_stop
)
5370 it
->base_level_stop
= 0;
5372 else if (CHARPOS (pos
) > it
->stop_charpos
5373 && it
->stop_charpos
>= BEGV
)
5374 handle_stop_backwards (it
, it
->stop_charpos
);
5381 it
->prev_stop
= it
->base_level_stop
= 0;
5390 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5391 IT->stop_pos to POS, also. */
5394 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5396 /* Don't call this function when scanning a C string. */
5397 xassert (it
->s
== NULL
);
5399 /* POS must be a reasonable value. */
5400 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5402 it
->current
.pos
= it
->position
= pos
;
5403 it
->end_charpos
= ZV
;
5405 it
->current
.dpvec_index
= -1;
5406 it
->current
.overlay_string_index
= -1;
5407 IT_STRING_CHARPOS (*it
) = -1;
5408 IT_STRING_BYTEPOS (*it
) = -1;
5410 it
->string_from_display_prop_p
= 0;
5411 it
->method
= GET_FROM_BUFFER
;
5412 it
->object
= it
->w
->buffer
;
5413 it
->area
= TEXT_AREA
;
5414 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5416 it
->string_from_display_prop_p
= 0;
5417 it
->face_before_selective_p
= 0;
5420 it
->bidi_it
.first_elt
= 1;
5421 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5426 it
->stop_charpos
= CHARPOS (pos
);
5427 it
->base_level_stop
= CHARPOS (pos
);
5432 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5433 If S is non-null, it is a C string to iterate over. Otherwise,
5434 STRING gives a Lisp string to iterate over.
5436 If PRECISION > 0, don't return more then PRECISION number of
5437 characters from the string.
5439 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5440 characters have been returned. FIELD_WIDTH < 0 means an infinite
5443 MULTIBYTE = 0 means disable processing of multibyte characters,
5444 MULTIBYTE > 0 means enable it,
5445 MULTIBYTE < 0 means use IT->multibyte_p.
5447 IT must be initialized via a prior call to init_iterator before
5448 calling this function. */
5451 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5452 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5455 /* No region in strings. */
5456 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5458 /* No text property checks performed by default, but see below. */
5459 it
->stop_charpos
= -1;
5461 /* Set iterator position and end position. */
5462 memset (&it
->current
, 0, sizeof it
->current
);
5463 it
->current
.overlay_string_index
= -1;
5464 it
->current
.dpvec_index
= -1;
5465 xassert (charpos
>= 0);
5467 /* If STRING is specified, use its multibyteness, otherwise use the
5468 setting of MULTIBYTE, if specified. */
5470 it
->multibyte_p
= multibyte
> 0;
5474 xassert (STRINGP (string
));
5475 it
->string
= string
;
5477 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5478 it
->method
= GET_FROM_STRING
;
5479 it
->current
.string_pos
= string_pos (charpos
, string
);
5483 it
->s
= (const unsigned char *) s
;
5486 /* Note that we use IT->current.pos, not it->current.string_pos,
5487 for displaying C strings. */
5488 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5489 if (it
->multibyte_p
)
5491 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5492 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5496 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5497 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5500 it
->method
= GET_FROM_C_STRING
;
5503 /* PRECISION > 0 means don't return more than PRECISION characters
5505 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5506 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5508 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5509 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5510 FIELD_WIDTH < 0 means infinite field width. This is useful for
5511 padding with `-' at the end of a mode line. */
5512 if (field_width
< 0)
5513 field_width
= INFINITY
;
5514 if (field_width
> it
->end_charpos
- charpos
)
5515 it
->end_charpos
= charpos
+ field_width
;
5517 /* Use the standard display table for displaying strings. */
5518 if (DISP_TABLE_P (Vstandard_display_table
))
5519 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5521 it
->stop_charpos
= charpos
;
5522 if (s
== NULL
&& it
->multibyte_p
)
5524 EMACS_INT endpos
= SCHARS (it
->string
);
5525 if (endpos
> it
->end_charpos
)
5526 endpos
= it
->end_charpos
;
5527 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5535 /***********************************************************************
5537 ***********************************************************************/
5539 /* Map enum it_method value to corresponding next_element_from_* function. */
5541 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5543 next_element_from_buffer
,
5544 next_element_from_display_vector
,
5545 next_element_from_string
,
5546 next_element_from_c_string
,
5547 next_element_from_image
,
5548 next_element_from_stretch
5551 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5554 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5555 (possibly with the following characters). */
5557 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5558 ((IT)->cmp_it.id >= 0 \
5559 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5560 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5561 END_CHARPOS, (IT)->w, \
5562 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5566 /* Lookup the char-table Vglyphless_char_display for character C (-1
5567 if we want information for no-font case), and return the display
5568 method symbol. By side-effect, update it->what and
5569 it->glyphless_method. This function is called from
5570 get_next_display_element for each character element, and from
5571 x_produce_glyphs when no suitable font was found. */
5574 lookup_glyphless_char_display (int c
, struct it
*it
)
5576 Lisp_Object glyphless_method
= Qnil
;
5578 if (CHAR_TABLE_P (Vglyphless_char_display
)
5579 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5580 glyphless_method
= (c
>= 0
5581 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5582 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5584 if (NILP (glyphless_method
))
5587 /* The default is to display the character by a proper font. */
5589 /* The default for the no-font case is to display an empty box. */
5590 glyphless_method
= Qempty_box
;
5592 if (EQ (glyphless_method
, Qzero_width
))
5595 return glyphless_method
;
5596 /* This method can't be used for the no-font case. */
5597 glyphless_method
= Qempty_box
;
5599 if (EQ (glyphless_method
, Qthin_space
))
5600 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5601 else if (EQ (glyphless_method
, Qempty_box
))
5602 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5603 else if (EQ (glyphless_method
, Qhex_code
))
5604 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5605 else if (STRINGP (glyphless_method
))
5606 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5609 /* Invalid value. We use the default method. */
5610 glyphless_method
= Qnil
;
5613 it
->what
= IT_GLYPHLESS
;
5614 return glyphless_method
;
5617 /* Load IT's display element fields with information about the next
5618 display element from the current position of IT. Value is zero if
5619 end of buffer (or C string) is reached. */
5621 static struct frame
*last_escape_glyph_frame
= NULL
;
5622 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5623 static int last_escape_glyph_merged_face_id
= 0;
5625 struct frame
*last_glyphless_glyph_frame
= NULL
;
5626 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5627 int last_glyphless_glyph_merged_face_id
= 0;
5630 get_next_display_element (struct it
*it
)
5632 /* Non-zero means that we found a display element. Zero means that
5633 we hit the end of what we iterate over. Performance note: the
5634 function pointer `method' used here turns out to be faster than
5635 using a sequence of if-statements. */
5639 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5641 if (it
->what
== IT_CHARACTER
)
5643 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5644 and only if (a) the resolved directionality of that character
5646 /* FIXME: Do we need an exception for characters from display
5648 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5649 it
->c
= bidi_mirror_char (it
->c
);
5650 /* Map via display table or translate control characters.
5651 IT->c, IT->len etc. have been set to the next character by
5652 the function call above. If we have a display table, and it
5653 contains an entry for IT->c, translate it. Don't do this if
5654 IT->c itself comes from a display table, otherwise we could
5655 end up in an infinite recursion. (An alternative could be to
5656 count the recursion depth of this function and signal an
5657 error when a certain maximum depth is reached.) Is it worth
5659 if (success_p
&& it
->dpvec
== NULL
)
5662 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5663 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5664 nbsp_or_shy
= char_is_other
;
5665 int c
= it
->c
; /* This is the character to display. */
5667 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5669 xassert (SINGLE_BYTE_CHAR_P (c
));
5670 if (unibyte_display_via_language_environment
)
5672 c
= DECODE_CHAR (unibyte
, c
);
5674 c
= BYTE8_TO_CHAR (it
->c
);
5677 c
= BYTE8_TO_CHAR (it
->c
);
5681 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5684 struct Lisp_Vector
*v
= XVECTOR (dv
);
5686 /* Return the first character from the display table
5687 entry, if not empty. If empty, don't display the
5688 current character. */
5691 it
->dpvec_char_len
= it
->len
;
5692 it
->dpvec
= v
->contents
;
5693 it
->dpend
= v
->contents
+ v
->size
;
5694 it
->current
.dpvec_index
= 0;
5695 it
->dpvec_face_id
= -1;
5696 it
->saved_face_id
= it
->face_id
;
5697 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5702 set_iterator_to_next (it
, 0);
5707 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5709 if (it
->what
== IT_GLYPHLESS
)
5711 /* Don't display this character. */
5712 set_iterator_to_next (it
, 0);
5716 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5717 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5718 : c
== 0xAD ? char_is_soft_hyphen
5721 /* Translate control characters into `\003' or `^C' form.
5722 Control characters coming from a display table entry are
5723 currently not translated because we use IT->dpvec to hold
5724 the translation. This could easily be changed but I
5725 don't believe that it is worth doing.
5727 NBSP and SOFT-HYPEN are property translated too.
5729 Non-printable characters and raw-byte characters are also
5730 translated to octal form. */
5731 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5732 ? (it
->area
!= TEXT_AREA
5733 /* In mode line, treat \n, \t like other crl chars. */
5736 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5737 || (c
!= '\n' && c
!= '\t'))
5740 || ! CHAR_PRINTABLE_P (c
))))
5742 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5743 or a non-printable character which must be displayed
5744 either as '\003' or as `^C' where the '\\' and '^'
5745 can be defined in the display table. Fill
5746 IT->ctl_chars with glyphs for what we have to
5747 display. Then, set IT->dpvec to these glyphs. */
5750 int face_id
, lface_id
= 0 ;
5753 /* Handle control characters with ^. */
5755 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5759 g
= '^'; /* default glyph for Control */
5760 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5762 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5763 && GLYPH_CODE_CHAR_VALID_P (gc
))
5765 g
= GLYPH_CODE_CHAR (gc
);
5766 lface_id
= GLYPH_CODE_FACE (gc
);
5770 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5772 else if (it
->f
== last_escape_glyph_frame
5773 && it
->face_id
== last_escape_glyph_face_id
)
5775 face_id
= last_escape_glyph_merged_face_id
;
5779 /* Merge the escape-glyph face into the current face. */
5780 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5782 last_escape_glyph_frame
= it
->f
;
5783 last_escape_glyph_face_id
= it
->face_id
;
5784 last_escape_glyph_merged_face_id
= face_id
;
5787 XSETINT (it
->ctl_chars
[0], g
);
5788 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5790 goto display_control
;
5793 /* Handle non-break space in the mode where it only gets
5796 if (EQ (Vnobreak_char_display
, Qt
)
5797 && nbsp_or_shy
== char_is_nbsp
)
5799 /* Merge the no-break-space face into the current face. */
5800 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5804 XSETINT (it
->ctl_chars
[0], ' ');
5806 goto display_control
;
5809 /* Handle sequences that start with the "escape glyph". */
5811 /* the default escape glyph is \. */
5812 escape_glyph
= '\\';
5815 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5816 && GLYPH_CODE_CHAR_VALID_P (gc
))
5818 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5819 lface_id
= GLYPH_CODE_FACE (gc
);
5823 /* The display table specified a face.
5824 Merge it into face_id and also into escape_glyph. */
5825 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5828 else if (it
->f
== last_escape_glyph_frame
5829 && it
->face_id
== last_escape_glyph_face_id
)
5831 face_id
= last_escape_glyph_merged_face_id
;
5835 /* Merge the escape-glyph face into the current face. */
5836 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5838 last_escape_glyph_frame
= it
->f
;
5839 last_escape_glyph_face_id
= it
->face_id
;
5840 last_escape_glyph_merged_face_id
= face_id
;
5843 /* Handle soft hyphens in the mode where they only get
5846 if (EQ (Vnobreak_char_display
, Qt
)
5847 && nbsp_or_shy
== char_is_soft_hyphen
)
5849 XSETINT (it
->ctl_chars
[0], '-');
5851 goto display_control
;
5854 /* Handle non-break space and soft hyphen
5855 with the escape glyph. */
5859 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5860 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5861 XSETINT (it
->ctl_chars
[1], c
);
5863 goto display_control
;
5870 if (CHAR_BYTE8_P (c
))
5871 /* Display \200 instead of \17777600. */
5872 c
= CHAR_TO_BYTE8 (c
);
5873 len
= sprintf (str
, "%03o", c
);
5875 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5876 for (i
= 0; i
< len
; i
++)
5877 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5882 /* Set up IT->dpvec and return first character from it. */
5883 it
->dpvec_char_len
= it
->len
;
5884 it
->dpvec
= it
->ctl_chars
;
5885 it
->dpend
= it
->dpvec
+ ctl_len
;
5886 it
->current
.dpvec_index
= 0;
5887 it
->dpvec_face_id
= face_id
;
5888 it
->saved_face_id
= it
->face_id
;
5889 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5893 it
->char_to_display
= c
;
5897 it
->char_to_display
= it
->c
;
5901 #ifdef HAVE_WINDOW_SYSTEM
5902 /* Adjust face id for a multibyte character. There are no multibyte
5903 character in unibyte text. */
5904 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5907 && FRAME_WINDOW_P (it
->f
))
5909 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5911 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5913 /* Automatic composition with glyph-string. */
5914 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5916 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5920 EMACS_INT pos
= (it
->s
? -1
5921 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5922 : IT_CHARPOS (*it
));
5924 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5931 /* Is this character the last one of a run of characters with
5932 box? If yes, set IT->end_of_box_run_p to 1. */
5936 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5938 int face_id
= underlying_face_id (it
);
5939 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5943 if (face
->box
== FACE_NO_BOX
)
5945 /* If the box comes from face properties in a
5946 display string, check faces in that string. */
5947 int string_face_id
= face_after_it_pos (it
);
5948 it
->end_of_box_run_p
5949 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5952 /* Otherwise, the box comes from the underlying face.
5953 If this is the last string character displayed, check
5954 the next buffer location. */
5955 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5956 && (it
->current
.overlay_string_index
5957 == it
->n_overlay_strings
- 1))
5961 struct text_pos pos
= it
->current
.pos
;
5962 INC_TEXT_POS (pos
, it
->multibyte_p
);
5964 next_face_id
= face_at_buffer_position
5965 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5966 it
->region_end_charpos
, &ignore
,
5967 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5969 it
->end_of_box_run_p
5970 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5977 int face_id
= face_after_it_pos (it
);
5978 it
->end_of_box_run_p
5979 = (face_id
!= it
->face_id
5980 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5984 /* Value is 0 if end of buffer or string reached. */
5989 /* Move IT to the next display element.
5991 RESEAT_P non-zero means if called on a newline in buffer text,
5992 skip to the next visible line start.
5994 Functions get_next_display_element and set_iterator_to_next are
5995 separate because I find this arrangement easier to handle than a
5996 get_next_display_element function that also increments IT's
5997 position. The way it is we can first look at an iterator's current
5998 display element, decide whether it fits on a line, and if it does,
5999 increment the iterator position. The other way around we probably
6000 would either need a flag indicating whether the iterator has to be
6001 incremented the next time, or we would have to implement a
6002 decrement position function which would not be easy to write. */
6005 set_iterator_to_next (struct it
*it
, int reseat_p
)
6007 /* Reset flags indicating start and end of a sequence of characters
6008 with box. Reset them at the start of this function because
6009 moving the iterator to a new position might set them. */
6010 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6014 case GET_FROM_BUFFER
:
6015 /* The current display element of IT is a character from
6016 current_buffer. Advance in the buffer, and maybe skip over
6017 invisible lines that are so because of selective display. */
6018 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6019 reseat_at_next_visible_line_start (it
, 0);
6020 else if (it
->cmp_it
.id
>= 0)
6022 /* We are currently getting glyphs from a composition. */
6027 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6028 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6029 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6031 it
->cmp_it
.from
= it
->cmp_it
.to
;
6036 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6038 it
->end_charpos
, Qnil
);
6041 else if (! it
->cmp_it
.reversed_p
)
6043 /* Composition created while scanning forward. */
6044 /* Update IT's char/byte positions to point to the first
6045 character of the next grapheme cluster, or to the
6046 character visually after the current composition. */
6047 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6048 bidi_move_to_visually_next (&it
->bidi_it
);
6049 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6050 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6052 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6054 /* Proceed to the next grapheme cluster. */
6055 it
->cmp_it
.from
= it
->cmp_it
.to
;
6059 /* No more grapheme clusters in this composition.
6060 Find the next stop position. */
6061 EMACS_INT stop
= it
->end_charpos
;
6062 if (it
->bidi_it
.scan_dir
< 0)
6063 /* Now we are scanning backward and don't know
6066 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6067 IT_BYTEPOS (*it
), stop
, Qnil
);
6072 /* Composition created while scanning backward. */
6073 /* Update IT's char/byte positions to point to the last
6074 character of the previous grapheme cluster, or the
6075 character visually after the current composition. */
6076 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6077 bidi_move_to_visually_next (&it
->bidi_it
);
6078 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6079 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6080 if (it
->cmp_it
.from
> 0)
6082 /* Proceed to the previous grapheme cluster. */
6083 it
->cmp_it
.to
= it
->cmp_it
.from
;
6087 /* No more grapheme clusters in this composition.
6088 Find the next stop position. */
6089 EMACS_INT stop
= it
->end_charpos
;
6090 if (it
->bidi_it
.scan_dir
< 0)
6091 /* Now we are scanning backward and don't know
6094 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6095 IT_BYTEPOS (*it
), stop
, Qnil
);
6101 xassert (it
->len
!= 0);
6105 IT_BYTEPOS (*it
) += it
->len
;
6106 IT_CHARPOS (*it
) += 1;
6110 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6111 /* If this is a new paragraph, determine its base
6112 direction (a.k.a. its base embedding level). */
6113 if (it
->bidi_it
.new_paragraph
)
6114 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6115 bidi_move_to_visually_next (&it
->bidi_it
);
6116 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6117 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6118 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6120 /* As the scan direction was changed, we must
6121 re-compute the stop position for composition. */
6122 EMACS_INT stop
= it
->end_charpos
;
6123 if (it
->bidi_it
.scan_dir
< 0)
6125 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6126 IT_BYTEPOS (*it
), stop
, Qnil
);
6129 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6133 case GET_FROM_C_STRING
:
6134 /* Current display element of IT is from a C string. */
6135 IT_BYTEPOS (*it
) += it
->len
;
6136 IT_CHARPOS (*it
) += 1;
6139 case GET_FROM_DISPLAY_VECTOR
:
6140 /* Current display element of IT is from a display table entry.
6141 Advance in the display table definition. Reset it to null if
6142 end reached, and continue with characters from buffers/
6144 ++it
->current
.dpvec_index
;
6146 /* Restore face of the iterator to what they were before the
6147 display vector entry (these entries may contain faces). */
6148 it
->face_id
= it
->saved_face_id
;
6150 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6152 int recheck_faces
= it
->ellipsis_p
;
6155 it
->method
= GET_FROM_C_STRING
;
6156 else if (STRINGP (it
->string
))
6157 it
->method
= GET_FROM_STRING
;
6160 it
->method
= GET_FROM_BUFFER
;
6161 it
->object
= it
->w
->buffer
;
6165 it
->current
.dpvec_index
= -1;
6167 /* Skip over characters which were displayed via IT->dpvec. */
6168 if (it
->dpvec_char_len
< 0)
6169 reseat_at_next_visible_line_start (it
, 1);
6170 else if (it
->dpvec_char_len
> 0)
6172 if (it
->method
== GET_FROM_STRING
6173 && it
->n_overlay_strings
> 0)
6174 it
->ignore_overlay_strings_at_pos_p
= 1;
6175 it
->len
= it
->dpvec_char_len
;
6176 set_iterator_to_next (it
, reseat_p
);
6179 /* Maybe recheck faces after display vector */
6181 it
->stop_charpos
= IT_CHARPOS (*it
);
6185 case GET_FROM_STRING
:
6186 /* Current display element is a character from a Lisp string. */
6187 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6188 if (it
->cmp_it
.id
>= 0)
6190 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6191 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6192 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6193 it
->cmp_it
.from
= it
->cmp_it
.to
;
6197 composition_compute_stop_pos (&it
->cmp_it
,
6198 IT_STRING_CHARPOS (*it
),
6199 IT_STRING_BYTEPOS (*it
),
6200 it
->end_charpos
, it
->string
);
6205 IT_STRING_BYTEPOS (*it
) += it
->len
;
6206 IT_STRING_CHARPOS (*it
) += 1;
6209 consider_string_end
:
6211 if (it
->current
.overlay_string_index
>= 0)
6213 /* IT->string is an overlay string. Advance to the
6214 next, if there is one. */
6215 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6218 next_overlay_string (it
);
6220 setup_for_ellipsis (it
, 0);
6225 /* IT->string is not an overlay string. If we reached
6226 its end, and there is something on IT->stack, proceed
6227 with what is on the stack. This can be either another
6228 string, this time an overlay string, or a buffer. */
6229 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6233 if (it
->method
== GET_FROM_STRING
)
6234 goto consider_string_end
;
6239 case GET_FROM_IMAGE
:
6240 case GET_FROM_STRETCH
:
6241 /* The position etc with which we have to proceed are on
6242 the stack. The position may be at the end of a string,
6243 if the `display' property takes up the whole string. */
6244 xassert (it
->sp
> 0);
6246 if (it
->method
== GET_FROM_STRING
)
6247 goto consider_string_end
;
6251 /* There are no other methods defined, so this should be a bug. */
6255 xassert (it
->method
!= GET_FROM_STRING
6256 || (STRINGP (it
->string
)
6257 && IT_STRING_CHARPOS (*it
) >= 0));
6260 /* Load IT's display element fields with information about the next
6261 display element which comes from a display table entry or from the
6262 result of translating a control character to one of the forms `^C'
6265 IT->dpvec holds the glyphs to return as characters.
6266 IT->saved_face_id holds the face id before the display vector--it
6267 is restored into IT->face_id in set_iterator_to_next. */
6270 next_element_from_display_vector (struct it
*it
)
6275 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6277 it
->face_id
= it
->saved_face_id
;
6279 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6280 That seemed totally bogus - so I changed it... */
6281 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6283 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6285 it
->c
= GLYPH_CODE_CHAR (gc
);
6286 it
->len
= CHAR_BYTES (it
->c
);
6288 /* The entry may contain a face id to use. Such a face id is
6289 the id of a Lisp face, not a realized face. A face id of
6290 zero means no face is specified. */
6291 if (it
->dpvec_face_id
>= 0)
6292 it
->face_id
= it
->dpvec_face_id
;
6295 int lface_id
= GLYPH_CODE_FACE (gc
);
6297 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6302 /* Display table entry is invalid. Return a space. */
6303 it
->c
= ' ', it
->len
= 1;
6305 /* Don't change position and object of the iterator here. They are
6306 still the values of the character that had this display table
6307 entry or was translated, and that's what we want. */
6308 it
->what
= IT_CHARACTER
;
6313 /* Load IT with the next display element from Lisp string IT->string.
6314 IT->current.string_pos is the current position within the string.
6315 If IT->current.overlay_string_index >= 0, the Lisp string is an
6319 next_element_from_string (struct it
*it
)
6321 struct text_pos position
;
6323 xassert (STRINGP (it
->string
));
6324 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6325 position
= it
->current
.string_pos
;
6327 /* Time to check for invisible text? */
6328 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6329 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6333 /* Since a handler may have changed IT->method, we must
6335 return GET_NEXT_DISPLAY_ELEMENT (it
);
6338 if (it
->current
.overlay_string_index
>= 0)
6340 /* Get the next character from an overlay string. In overlay
6341 strings, There is no field width or padding with spaces to
6343 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6348 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6349 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6350 && next_element_from_composition (it
))
6354 else if (STRING_MULTIBYTE (it
->string
))
6356 const unsigned char *s
= (SDATA (it
->string
)
6357 + IT_STRING_BYTEPOS (*it
));
6358 it
->c
= string_char_and_length (s
, &it
->len
);
6362 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6368 /* Get the next character from a Lisp string that is not an
6369 overlay string. Such strings come from the mode line, for
6370 example. We may have to pad with spaces, or truncate the
6371 string. See also next_element_from_c_string. */
6372 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6377 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6379 /* Pad with spaces. */
6380 it
->c
= ' ', it
->len
= 1;
6381 CHARPOS (position
) = BYTEPOS (position
) = -1;
6383 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6384 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6385 && next_element_from_composition (it
))
6389 else if (STRING_MULTIBYTE (it
->string
))
6391 const unsigned char *s
= (SDATA (it
->string
)
6392 + IT_STRING_BYTEPOS (*it
));
6393 it
->c
= string_char_and_length (s
, &it
->len
);
6397 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6402 /* Record what we have and where it came from. */
6403 it
->what
= IT_CHARACTER
;
6404 it
->object
= it
->string
;
6405 it
->position
= position
;
6410 /* Load IT with next display element from C string IT->s.
6411 IT->string_nchars is the maximum number of characters to return
6412 from the string. IT->end_charpos may be greater than
6413 IT->string_nchars when this function is called, in which case we
6414 may have to return padding spaces. Value is zero if end of string
6415 reached, including padding spaces. */
6418 next_element_from_c_string (struct it
*it
)
6423 it
->what
= IT_CHARACTER
;
6424 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6427 /* IT's position can be greater IT->string_nchars in case a field
6428 width or precision has been specified when the iterator was
6430 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6432 /* End of the game. */
6436 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6438 /* Pad with spaces. */
6439 it
->c
= ' ', it
->len
= 1;
6440 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6442 else if (it
->multibyte_p
)
6443 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6445 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6451 /* Set up IT to return characters from an ellipsis, if appropriate.
6452 The definition of the ellipsis glyphs may come from a display table
6453 entry. This function fills IT with the first glyph from the
6454 ellipsis if an ellipsis is to be displayed. */
6457 next_element_from_ellipsis (struct it
*it
)
6459 if (it
->selective_display_ellipsis_p
)
6460 setup_for_ellipsis (it
, it
->len
);
6463 /* The face at the current position may be different from the
6464 face we find after the invisible text. Remember what it
6465 was in IT->saved_face_id, and signal that it's there by
6466 setting face_before_selective_p. */
6467 it
->saved_face_id
= it
->face_id
;
6468 it
->method
= GET_FROM_BUFFER
;
6469 it
->object
= it
->w
->buffer
;
6470 reseat_at_next_visible_line_start (it
, 1);
6471 it
->face_before_selective_p
= 1;
6474 return GET_NEXT_DISPLAY_ELEMENT (it
);
6478 /* Deliver an image display element. The iterator IT is already
6479 filled with image information (done in handle_display_prop). Value
6484 next_element_from_image (struct it
*it
)
6486 it
->what
= IT_IMAGE
;
6487 it
->ignore_overlay_strings_at_pos_p
= 0;
6492 /* Fill iterator IT with next display element from a stretch glyph
6493 property. IT->object is the value of the text property. Value is
6497 next_element_from_stretch (struct it
*it
)
6499 it
->what
= IT_STRETCH
;
6503 /* Scan forward from CHARPOS in the current buffer, until we find a
6504 stop position > current IT's position. Then handle the stop
6505 position before that. This is called when we bump into a stop
6506 position while reordering bidirectional text. CHARPOS should be
6507 the last previously processed stop_pos (or BEGV, if none were
6508 processed yet) whose position is less that IT's current
6512 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6514 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6515 struct display_pos save_current
= it
->current
;
6516 struct text_pos save_position
= it
->position
;
6517 struct text_pos pos1
;
6518 EMACS_INT next_stop
;
6520 /* Scan in strict logical order. */
6524 it
->prev_stop
= charpos
;
6525 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6526 reseat_1 (it
, pos1
, 0);
6527 compute_stop_pos (it
);
6528 /* We must advance forward, right? */
6529 if (it
->stop_charpos
<= it
->prev_stop
)
6531 charpos
= it
->stop_charpos
;
6533 while (charpos
<= where_we_are
);
6535 next_stop
= it
->stop_charpos
;
6536 it
->stop_charpos
= it
->prev_stop
;
6538 it
->current
= save_current
;
6539 it
->position
= save_position
;
6541 it
->stop_charpos
= next_stop
;
6544 /* Load IT with the next display element from current_buffer. Value
6545 is zero if end of buffer reached. IT->stop_charpos is the next
6546 position at which to stop and check for text properties or buffer
6550 next_element_from_buffer (struct it
*it
)
6554 xassert (IT_CHARPOS (*it
) >= BEGV
);
6556 /* With bidi reordering, the character to display might not be the
6557 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6558 we were reseat()ed to a new buffer position, which is potentially
6559 a different paragraph. */
6560 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6562 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6563 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6564 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6566 /* Nothing to do, but reset the FIRST_ELT flag, like
6567 bidi_paragraph_init does, because we are not going to
6569 it
->bidi_it
.first_elt
= 0;
6571 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6572 /* FIXME: Should support all Unicode line separators. */
6573 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6574 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6576 /* If we are at the beginning of a line, we can produce the
6577 next element right away. */
6578 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6579 bidi_move_to_visually_next (&it
->bidi_it
);
6583 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6585 /* We need to prime the bidi iterator starting at the line's
6586 beginning, before we will be able to produce the next
6588 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6589 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6590 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6591 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6592 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6595 /* Now return to buffer position where we were asked to
6596 get the next display element, and produce that. */
6597 bidi_move_to_visually_next (&it
->bidi_it
);
6599 while (it
->bidi_it
.bytepos
!= orig_bytepos
6600 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6603 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6604 /* Adjust IT's position information to where we ended up. */
6605 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6606 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6607 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6609 EMACS_INT stop
= it
->end_charpos
;
6610 if (it
->bidi_it
.scan_dir
< 0)
6612 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6613 IT_BYTEPOS (*it
), stop
, Qnil
);
6617 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6619 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6621 int overlay_strings_follow_p
;
6623 /* End of the game, except when overlay strings follow that
6624 haven't been returned yet. */
6625 if (it
->overlay_strings_at_end_processed_p
)
6626 overlay_strings_follow_p
= 0;
6629 it
->overlay_strings_at_end_processed_p
= 1;
6630 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6633 if (overlay_strings_follow_p
)
6634 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6638 it
->position
= it
->current
.pos
;
6642 else if (!(!it
->bidi_p
6643 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6644 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6646 /* With bidi non-linear iteration, we could find ourselves
6647 far beyond the last computed stop_charpos, with several
6648 other stop positions in between that we missed. Scan
6649 them all now, in buffer's logical order, until we find
6650 and handle the last stop_charpos that precedes our
6651 current position. */
6652 handle_stop_backwards (it
, it
->stop_charpos
);
6653 return GET_NEXT_DISPLAY_ELEMENT (it
);
6659 /* Take note of the stop position we just moved across,
6660 for when we will move back across it. */
6661 it
->prev_stop
= it
->stop_charpos
;
6662 /* If we are at base paragraph embedding level, take
6663 note of the last stop position seen at this
6665 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6666 it
->base_level_stop
= it
->stop_charpos
;
6669 return GET_NEXT_DISPLAY_ELEMENT (it
);
6673 /* We can sometimes back up for reasons that have nothing
6674 to do with bidi reordering. E.g., compositions. The
6675 code below is only needed when we are above the base
6676 embedding level, so test for that explicitly. */
6677 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6678 && IT_CHARPOS (*it
) < it
->prev_stop
)
6680 if (it
->base_level_stop
<= 0)
6681 it
->base_level_stop
= BEGV
;
6682 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6684 handle_stop_backwards (it
, it
->base_level_stop
);
6685 return GET_NEXT_DISPLAY_ELEMENT (it
);
6689 /* No face changes, overlays etc. in sight, so just return a
6690 character from current_buffer. */
6694 /* Maybe run the redisplay end trigger hook. Performance note:
6695 This doesn't seem to cost measurable time. */
6696 if (it
->redisplay_end_trigger_charpos
6698 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6699 run_redisplay_end_trigger_hook (it
);
6701 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6702 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6704 && next_element_from_composition (it
))
6709 /* Get the next character, maybe multibyte. */
6710 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6711 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6712 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6714 it
->c
= *p
, it
->len
= 1;
6716 /* Record what we have and where it came from. */
6717 it
->what
= IT_CHARACTER
;
6718 it
->object
= it
->w
->buffer
;
6719 it
->position
= it
->current
.pos
;
6721 /* Normally we return the character found above, except when we
6722 really want to return an ellipsis for selective display. */
6727 /* A value of selective > 0 means hide lines indented more
6728 than that number of columns. */
6729 if (it
->selective
> 0
6730 && IT_CHARPOS (*it
) + 1 < ZV
6731 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6732 IT_BYTEPOS (*it
) + 1,
6733 (double) it
->selective
)) /* iftc */
6735 success_p
= next_element_from_ellipsis (it
);
6736 it
->dpvec_char_len
= -1;
6739 else if (it
->c
== '\r' && it
->selective
== -1)
6741 /* A value of selective == -1 means that everything from the
6742 CR to the end of the line is invisible, with maybe an
6743 ellipsis displayed for it. */
6744 success_p
= next_element_from_ellipsis (it
);
6745 it
->dpvec_char_len
= -1;
6750 /* Value is zero if end of buffer reached. */
6751 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6756 /* Run the redisplay end trigger hook for IT. */
6759 run_redisplay_end_trigger_hook (struct it
*it
)
6761 Lisp_Object args
[3];
6763 /* IT->glyph_row should be non-null, i.e. we should be actually
6764 displaying something, or otherwise we should not run the hook. */
6765 xassert (it
->glyph_row
);
6767 /* Set up hook arguments. */
6768 args
[0] = Qredisplay_end_trigger_functions
;
6769 args
[1] = it
->window
;
6770 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6771 it
->redisplay_end_trigger_charpos
= 0;
6773 /* Since we are *trying* to run these functions, don't try to run
6774 them again, even if they get an error. */
6775 it
->w
->redisplay_end_trigger
= Qnil
;
6776 Frun_hook_with_args (3, args
);
6778 /* Notice if it changed the face of the character we are on. */
6779 handle_face_prop (it
);
6783 /* Deliver a composition display element. Unlike the other
6784 next_element_from_XXX, this function is not registered in the array
6785 get_next_element[]. It is called from next_element_from_buffer and
6786 next_element_from_string when necessary. */
6789 next_element_from_composition (struct it
*it
)
6791 it
->what
= IT_COMPOSITION
;
6792 it
->len
= it
->cmp_it
.nbytes
;
6793 if (STRINGP (it
->string
))
6797 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6798 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6801 it
->position
= it
->current
.string_pos
;
6802 it
->object
= it
->string
;
6803 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6804 IT_STRING_BYTEPOS (*it
), it
->string
);
6810 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6811 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6814 if (it
->bidi_it
.new_paragraph
)
6815 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6816 /* Resync the bidi iterator with IT's new position.
6817 FIXME: this doesn't support bidirectional text. */
6818 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6819 bidi_move_to_visually_next (&it
->bidi_it
);
6823 it
->position
= it
->current
.pos
;
6824 it
->object
= it
->w
->buffer
;
6825 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6826 IT_BYTEPOS (*it
), Qnil
);
6833 /***********************************************************************
6834 Moving an iterator without producing glyphs
6835 ***********************************************************************/
6837 /* Check if iterator is at a position corresponding to a valid buffer
6838 position after some move_it_ call. */
6840 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6841 ((it)->method == GET_FROM_STRING \
6842 ? IT_STRING_CHARPOS (*it) == 0 \
6846 /* Move iterator IT to a specified buffer or X position within one
6847 line on the display without producing glyphs.
6849 OP should be a bit mask including some or all of these bits:
6850 MOVE_TO_X: Stop upon reaching x-position TO_X.
6851 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6852 Regardless of OP's value, stop upon reaching the end of the display line.
6854 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6855 This means, in particular, that TO_X includes window's horizontal
6858 The return value has several possible values that
6859 say what condition caused the scan to stop:
6861 MOVE_POS_MATCH_OR_ZV
6862 - when TO_POS or ZV was reached.
6865 -when TO_X was reached before TO_POS or ZV were reached.
6868 - when we reached the end of the display area and the line must
6872 - when we reached the end of the display area and the line is
6876 - when we stopped at a line end, i.e. a newline or a CR and selective
6879 static enum move_it_result
6880 move_it_in_display_line_to (struct it
*it
,
6881 EMACS_INT to_charpos
, int to_x
,
6882 enum move_operation_enum op
)
6884 enum move_it_result result
= MOVE_UNDEFINED
;
6885 struct glyph_row
*saved_glyph_row
;
6886 struct it wrap_it
, atpos_it
, atx_it
;
6888 enum it_method prev_method
= it
->method
;
6889 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6891 /* Don't produce glyphs in produce_glyphs. */
6892 saved_glyph_row
= it
->glyph_row
;
6893 it
->glyph_row
= NULL
;
6895 /* Use wrap_it to save a copy of IT wherever a word wrap could
6896 occur. Use atpos_it to save a copy of IT at the desired buffer
6897 position, if found, so that we can scan ahead and check if the
6898 word later overshoots the window edge. Use atx_it similarly, for
6904 #define BUFFER_POS_REACHED_P() \
6905 ((op & MOVE_TO_POS) != 0 \
6906 && BUFFERP (it->object) \
6907 && (IT_CHARPOS (*it) == to_charpos \
6908 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6909 && (it->method == GET_FROM_BUFFER \
6910 || (it->method == GET_FROM_DISPLAY_VECTOR \
6911 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6913 /* If there's a line-/wrap-prefix, handle it. */
6914 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6915 && it
->current_y
< it
->last_visible_y
)
6916 handle_line_prefix (it
);
6918 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6919 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6923 int x
, i
, ascent
= 0, descent
= 0;
6925 /* Utility macro to reset an iterator with x, ascent, and descent. */
6926 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6927 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6928 (IT)->max_descent = descent)
6930 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6932 if ((op
& MOVE_TO_POS
) != 0
6933 && BUFFERP (it
->object
)
6934 && it
->method
== GET_FROM_BUFFER
6935 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6937 && (prev_method
== GET_FROM_IMAGE
6938 || prev_method
== GET_FROM_STRETCH
)
6939 /* Passed TO_CHARPOS from left to right. */
6940 && ((prev_pos
< to_charpos
6941 && IT_CHARPOS (*it
) > to_charpos
)
6942 /* Passed TO_CHARPOS from right to left. */
6943 || (prev_pos
> to_charpos
6944 && IT_CHARPOS (*it
) < to_charpos
)))))
6946 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6948 result
= MOVE_POS_MATCH_OR_ZV
;
6951 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6952 /* If wrap_it is valid, the current position might be in a
6953 word that is wrapped. So, save the iterator in
6954 atpos_it and continue to see if wrapping happens. */
6958 prev_method
= it
->method
;
6959 if (it
->method
== GET_FROM_BUFFER
)
6960 prev_pos
= IT_CHARPOS (*it
);
6961 /* Stop when ZV reached.
6962 We used to stop here when TO_CHARPOS reached as well, but that is
6963 too soon if this glyph does not fit on this line. So we handle it
6964 explicitly below. */
6965 if (!get_next_display_element (it
))
6967 result
= MOVE_POS_MATCH_OR_ZV
;
6971 if (it
->line_wrap
== TRUNCATE
)
6973 if (BUFFER_POS_REACHED_P ())
6975 result
= MOVE_POS_MATCH_OR_ZV
;
6981 if (it
->line_wrap
== WORD_WRAP
)
6983 if (IT_DISPLAYING_WHITESPACE (it
))
6987 /* We have reached a glyph that follows one or more
6988 whitespace characters. If the position is
6989 already found, we are done. */
6990 if (atpos_it
.sp
>= 0)
6993 result
= MOVE_POS_MATCH_OR_ZV
;
6999 result
= MOVE_X_REACHED
;
7002 /* Otherwise, we can wrap here. */
7009 /* Remember the line height for the current line, in case
7010 the next element doesn't fit on the line. */
7011 ascent
= it
->max_ascent
;
7012 descent
= it
->max_descent
;
7014 /* The call to produce_glyphs will get the metrics of the
7015 display element IT is loaded with. Record the x-position
7016 before this display element, in case it doesn't fit on the
7020 PRODUCE_GLYPHS (it
);
7022 if (it
->area
!= TEXT_AREA
)
7024 set_iterator_to_next (it
, 1);
7025 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7026 SET_TEXT_POS (this_line_min_pos
,
7027 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7031 /* The number of glyphs we get back in IT->nglyphs will normally
7032 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7033 character on a terminal frame, or (iii) a line end. For the
7034 second case, IT->nglyphs - 1 padding glyphs will be present.
7035 (On X frames, there is only one glyph produced for a
7036 composite character.)
7038 The behavior implemented below means, for continuation lines,
7039 that as many spaces of a TAB as fit on the current line are
7040 displayed there. For terminal frames, as many glyphs of a
7041 multi-glyph character are displayed in the current line, too.
7042 This is what the old redisplay code did, and we keep it that
7043 way. Under X, the whole shape of a complex character must
7044 fit on the line or it will be completely displayed in the
7047 Note that both for tabs and padding glyphs, all glyphs have
7051 /* More than one glyph or glyph doesn't fit on line. All
7052 glyphs have the same width. */
7053 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7055 int x_before_this_char
= x
;
7056 int hpos_before_this_char
= it
->hpos
;
7058 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7060 new_x
= x
+ single_glyph_width
;
7062 /* We want to leave anything reaching TO_X to the caller. */
7063 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7065 if (BUFFER_POS_REACHED_P ())
7067 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7068 goto buffer_pos_reached
;
7069 if (atpos_it
.sp
< 0)
7072 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7077 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7080 result
= MOVE_X_REACHED
;
7086 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7091 if (/* Lines are continued. */
7092 it
->line_wrap
!= TRUNCATE
7093 && (/* And glyph doesn't fit on the line. */
7094 new_x
> it
->last_visible_x
7095 /* Or it fits exactly and we're on a window
7097 || (new_x
== it
->last_visible_x
7098 && FRAME_WINDOW_P (it
->f
))))
7100 if (/* IT->hpos == 0 means the very first glyph
7101 doesn't fit on the line, e.g. a wide image. */
7103 || (new_x
== it
->last_visible_x
7104 && FRAME_WINDOW_P (it
->f
)))
7107 it
->current_x
= new_x
;
7109 /* The character's last glyph just barely fits
7111 if (i
== it
->nglyphs
- 1)
7113 /* If this is the destination position,
7114 return a position *before* it in this row,
7115 now that we know it fits in this row. */
7116 if (BUFFER_POS_REACHED_P ())
7118 if (it
->line_wrap
!= WORD_WRAP
7121 it
->hpos
= hpos_before_this_char
;
7122 it
->current_x
= x_before_this_char
;
7123 result
= MOVE_POS_MATCH_OR_ZV
;
7126 if (it
->line_wrap
== WORD_WRAP
7130 atpos_it
.current_x
= x_before_this_char
;
7131 atpos_it
.hpos
= hpos_before_this_char
;
7135 set_iterator_to_next (it
, 1);
7136 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7137 SET_TEXT_POS (this_line_min_pos
,
7138 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7139 /* On graphical terminals, newlines may
7140 "overflow" into the fringe if
7141 overflow-newline-into-fringe is non-nil.
7142 On text-only terminals, newlines may
7143 overflow into the last glyph on the
7145 if (!FRAME_WINDOW_P (it
->f
)
7146 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7148 if (!get_next_display_element (it
))
7150 result
= MOVE_POS_MATCH_OR_ZV
;
7153 if (BUFFER_POS_REACHED_P ())
7155 if (ITERATOR_AT_END_OF_LINE_P (it
))
7156 result
= MOVE_POS_MATCH_OR_ZV
;
7158 result
= MOVE_LINE_CONTINUED
;
7161 if (ITERATOR_AT_END_OF_LINE_P (it
))
7163 result
= MOVE_NEWLINE_OR_CR
;
7170 IT_RESET_X_ASCENT_DESCENT (it
);
7172 if (wrap_it
.sp
>= 0)
7179 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7181 result
= MOVE_LINE_CONTINUED
;
7185 if (BUFFER_POS_REACHED_P ())
7187 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7188 goto buffer_pos_reached
;
7189 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7192 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7196 if (new_x
> it
->first_visible_x
)
7198 /* Glyph is visible. Increment number of glyphs that
7199 would be displayed. */
7204 if (result
!= MOVE_UNDEFINED
)
7207 else if (BUFFER_POS_REACHED_P ())
7210 IT_RESET_X_ASCENT_DESCENT (it
);
7211 result
= MOVE_POS_MATCH_OR_ZV
;
7214 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7216 /* Stop when TO_X specified and reached. This check is
7217 necessary here because of lines consisting of a line end,
7218 only. The line end will not produce any glyphs and we
7219 would never get MOVE_X_REACHED. */
7220 xassert (it
->nglyphs
== 0);
7221 result
= MOVE_X_REACHED
;
7225 /* Is this a line end? If yes, we're done. */
7226 if (ITERATOR_AT_END_OF_LINE_P (it
))
7228 result
= MOVE_NEWLINE_OR_CR
;
7232 if (it
->method
== GET_FROM_BUFFER
)
7233 prev_pos
= IT_CHARPOS (*it
);
7234 /* The current display element has been consumed. Advance
7236 set_iterator_to_next (it
, 1);
7237 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7238 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7240 /* Stop if lines are truncated and IT's current x-position is
7241 past the right edge of the window now. */
7242 if (it
->line_wrap
== TRUNCATE
7243 && it
->current_x
>= it
->last_visible_x
)
7245 if (!FRAME_WINDOW_P (it
->f
)
7246 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7248 if (!get_next_display_element (it
)
7249 || BUFFER_POS_REACHED_P ())
7251 result
= MOVE_POS_MATCH_OR_ZV
;
7254 if (ITERATOR_AT_END_OF_LINE_P (it
))
7256 result
= MOVE_NEWLINE_OR_CR
;
7260 result
= MOVE_LINE_TRUNCATED
;
7263 #undef IT_RESET_X_ASCENT_DESCENT
7266 #undef BUFFER_POS_REACHED_P
7268 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7269 restore the saved iterator. */
7270 if (atpos_it
.sp
>= 0)
7272 else if (atx_it
.sp
>= 0)
7277 /* Restore the iterator settings altered at the beginning of this
7279 it
->glyph_row
= saved_glyph_row
;
7283 /* For external use. */
7285 move_it_in_display_line (struct it
*it
,
7286 EMACS_INT to_charpos
, int to_x
,
7287 enum move_operation_enum op
)
7289 if (it
->line_wrap
== WORD_WRAP
7290 && (op
& MOVE_TO_X
))
7292 struct it save_it
= *it
;
7293 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7294 /* When word-wrap is on, TO_X may lie past the end
7295 of a wrapped line. Then it->current is the
7296 character on the next line, so backtrack to the
7297 space before the wrap point. */
7298 if (skip
== MOVE_LINE_CONTINUED
)
7300 int prev_x
= max (it
->current_x
- 1, 0);
7302 move_it_in_display_line_to
7303 (it
, -1, prev_x
, MOVE_TO_X
);
7307 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7311 /* Move IT forward until it satisfies one or more of the criteria in
7312 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7314 OP is a bit-mask that specifies where to stop, and in particular,
7315 which of those four position arguments makes a difference. See the
7316 description of enum move_operation_enum.
7318 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7319 screen line, this function will set IT to the next position >
7323 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7325 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7326 int line_height
, line_start_x
= 0, reached
= 0;
7330 if (op
& MOVE_TO_VPOS
)
7332 /* If no TO_CHARPOS and no TO_X specified, stop at the
7333 start of the line TO_VPOS. */
7334 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7336 if (it
->vpos
== to_vpos
)
7342 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7346 /* TO_VPOS >= 0 means stop at TO_X in the line at
7347 TO_VPOS, or at TO_POS, whichever comes first. */
7348 if (it
->vpos
== to_vpos
)
7354 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7356 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7361 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7363 /* We have reached TO_X but not in the line we want. */
7364 skip
= move_it_in_display_line_to (it
, to_charpos
,
7366 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7374 else if (op
& MOVE_TO_Y
)
7376 struct it it_backup
;
7378 if (it
->line_wrap
== WORD_WRAP
)
7381 /* TO_Y specified means stop at TO_X in the line containing
7382 TO_Y---or at TO_CHARPOS if this is reached first. The
7383 problem is that we can't really tell whether the line
7384 contains TO_Y before we have completely scanned it, and
7385 this may skip past TO_X. What we do is to first scan to
7388 If TO_X is not specified, use a TO_X of zero. The reason
7389 is to make the outcome of this function more predictable.
7390 If we didn't use TO_X == 0, we would stop at the end of
7391 the line which is probably not what a caller would expect
7393 skip
= move_it_in_display_line_to
7394 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7395 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7397 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7398 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7400 else if (skip
== MOVE_X_REACHED
)
7402 /* If TO_X was reached, we want to know whether TO_Y is
7403 in the line. We know this is the case if the already
7404 scanned glyphs make the line tall enough. Otherwise,
7405 we must check by scanning the rest of the line. */
7406 line_height
= it
->max_ascent
+ it
->max_descent
;
7407 if (to_y
>= it
->current_y
7408 && to_y
< it
->current_y
+ line_height
)
7414 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7415 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7417 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7418 line_height
= it
->max_ascent
+ it
->max_descent
;
7419 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7421 if (to_y
>= it
->current_y
7422 && to_y
< it
->current_y
+ line_height
)
7424 /* If TO_Y is in this line and TO_X was reached
7425 above, we scanned too far. We have to restore
7426 IT's settings to the ones before skipping. */
7433 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7439 /* Check whether TO_Y is in this line. */
7440 line_height
= it
->max_ascent
+ it
->max_descent
;
7441 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7443 if (to_y
>= it
->current_y
7444 && to_y
< it
->current_y
+ line_height
)
7446 /* When word-wrap is on, TO_X may lie past the end
7447 of a wrapped line. Then it->current is the
7448 character on the next line, so backtrack to the
7449 space before the wrap point. */
7450 if (skip
== MOVE_LINE_CONTINUED
7451 && it
->line_wrap
== WORD_WRAP
)
7453 int prev_x
= max (it
->current_x
- 1, 0);
7455 skip
= move_it_in_display_line_to
7456 (it
, -1, prev_x
, MOVE_TO_X
);
7465 else if (BUFFERP (it
->object
)
7466 && (it
->method
== GET_FROM_BUFFER
7467 || it
->method
== GET_FROM_STRETCH
)
7468 && IT_CHARPOS (*it
) >= to_charpos
)
7469 skip
= MOVE_POS_MATCH_OR_ZV
;
7471 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7475 case MOVE_POS_MATCH_OR_ZV
:
7479 case MOVE_NEWLINE_OR_CR
:
7480 set_iterator_to_next (it
, 1);
7481 it
->continuation_lines_width
= 0;
7484 case MOVE_LINE_TRUNCATED
:
7485 it
->continuation_lines_width
= 0;
7486 reseat_at_next_visible_line_start (it
, 0);
7487 if ((op
& MOVE_TO_POS
) != 0
7488 && IT_CHARPOS (*it
) > to_charpos
)
7495 case MOVE_LINE_CONTINUED
:
7496 /* For continued lines ending in a tab, some of the glyphs
7497 associated with the tab are displayed on the current
7498 line. Since it->current_x does not include these glyphs,
7499 we use it->last_visible_x instead. */
7502 it
->continuation_lines_width
+= it
->last_visible_x
;
7503 /* When moving by vpos, ensure that the iterator really
7504 advances to the next line (bug#847, bug#969). Fixme:
7505 do we need to do this in other circumstances? */
7506 if (it
->current_x
!= it
->last_visible_x
7507 && (op
& MOVE_TO_VPOS
)
7508 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7510 line_start_x
= it
->current_x
+ it
->pixel_width
7511 - it
->last_visible_x
;
7512 set_iterator_to_next (it
, 0);
7516 it
->continuation_lines_width
+= it
->current_x
;
7523 /* Reset/increment for the next run. */
7524 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7525 it
->current_x
= line_start_x
;
7528 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7530 last_height
= it
->max_ascent
+ it
->max_descent
;
7531 last_max_ascent
= it
->max_ascent
;
7532 it
->max_ascent
= it
->max_descent
= 0;
7537 /* On text terminals, we may stop at the end of a line in the middle
7538 of a multi-character glyph. If the glyph itself is continued,
7539 i.e. it is actually displayed on the next line, don't treat this
7540 stopping point as valid; move to the next line instead (unless
7541 that brings us offscreen). */
7542 if (!FRAME_WINDOW_P (it
->f
)
7544 && IT_CHARPOS (*it
) == to_charpos
7545 && it
->what
== IT_CHARACTER
7547 && it
->line_wrap
== WINDOW_WRAP
7548 && it
->current_x
== it
->last_visible_x
- 1
7551 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7553 it
->continuation_lines_width
+= it
->current_x
;
7554 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7555 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7557 last_height
= it
->max_ascent
+ it
->max_descent
;
7558 last_max_ascent
= it
->max_ascent
;
7561 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7565 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7567 If DY > 0, move IT backward at least that many pixels. DY = 0
7568 means move IT backward to the preceding line start or BEGV. This
7569 function may move over more than DY pixels if IT->current_y - DY
7570 ends up in the middle of a line; in this case IT->current_y will be
7571 set to the top of the line moved to. */
7574 move_it_vertically_backward (struct it
*it
, int dy
)
7578 EMACS_INT start_pos
;
7583 start_pos
= IT_CHARPOS (*it
);
7585 /* Estimate how many newlines we must move back. */
7586 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7588 /* Set the iterator's position that many lines back. */
7589 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7590 back_to_previous_visible_line_start (it
);
7592 /* Reseat the iterator here. When moving backward, we don't want
7593 reseat to skip forward over invisible text, set up the iterator
7594 to deliver from overlay strings at the new position etc. So,
7595 use reseat_1 here. */
7596 reseat_1 (it
, it
->current
.pos
, 1);
7598 /* We are now surely at a line start. */
7599 it
->current_x
= it
->hpos
= 0;
7600 it
->continuation_lines_width
= 0;
7602 /* Move forward and see what y-distance we moved. First move to the
7603 start of the next line so that we get its height. We need this
7604 height to be able to tell whether we reached the specified
7607 it2
.max_ascent
= it2
.max_descent
= 0;
7610 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7611 MOVE_TO_POS
| MOVE_TO_VPOS
);
7613 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7614 xassert (IT_CHARPOS (*it
) >= BEGV
);
7617 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7618 xassert (IT_CHARPOS (*it
) >= BEGV
);
7619 /* H is the actual vertical distance from the position in *IT
7620 and the starting position. */
7621 h
= it2
.current_y
- it
->current_y
;
7622 /* NLINES is the distance in number of lines. */
7623 nlines
= it2
.vpos
- it
->vpos
;
7625 /* Correct IT's y and vpos position
7626 so that they are relative to the starting point. */
7632 /* DY == 0 means move to the start of the screen line. The
7633 value of nlines is > 0 if continuation lines were involved. */
7635 move_it_by_lines (it
, nlines
, 1);
7639 /* The y-position we try to reach, relative to *IT.
7640 Note that H has been subtracted in front of the if-statement. */
7641 int target_y
= it
->current_y
+ h
- dy
;
7642 int y0
= it3
.current_y
;
7643 int y1
= line_bottom_y (&it3
);
7644 int line_height
= y1
- y0
;
7646 /* If we did not reach target_y, try to move further backward if
7647 we can. If we moved too far backward, try to move forward. */
7648 if (target_y
< it
->current_y
7649 /* This is heuristic. In a window that's 3 lines high, with
7650 a line height of 13 pixels each, recentering with point
7651 on the bottom line will try to move -39/2 = 19 pixels
7652 backward. Try to avoid moving into the first line. */
7653 && (it
->current_y
- target_y
7654 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7655 && IT_CHARPOS (*it
) > BEGV
)
7657 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7658 target_y
- it
->current_y
));
7659 dy
= it
->current_y
- target_y
;
7660 goto move_further_back
;
7662 else if (target_y
>= it
->current_y
+ line_height
7663 && IT_CHARPOS (*it
) < ZV
)
7665 /* Should move forward by at least one line, maybe more.
7667 Note: Calling move_it_by_lines can be expensive on
7668 terminal frames, where compute_motion is used (via
7669 vmotion) to do the job, when there are very long lines
7670 and truncate-lines is nil. That's the reason for
7671 treating terminal frames specially here. */
7673 if (!FRAME_WINDOW_P (it
->f
))
7674 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7679 move_it_by_lines (it
, 1, 1);
7681 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7688 /* Move IT by a specified amount of pixel lines DY. DY negative means
7689 move backwards. DY = 0 means move to start of screen line. At the
7690 end, IT will be on the start of a screen line. */
7693 move_it_vertically (struct it
*it
, int dy
)
7696 move_it_vertically_backward (it
, -dy
);
7699 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7700 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7701 MOVE_TO_POS
| MOVE_TO_Y
);
7702 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7704 /* If buffer ends in ZV without a newline, move to the start of
7705 the line to satisfy the post-condition. */
7706 if (IT_CHARPOS (*it
) == ZV
7708 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7709 move_it_by_lines (it
, 0, 0);
7714 /* Move iterator IT past the end of the text line it is in. */
7717 move_it_past_eol (struct it
*it
)
7719 enum move_it_result rc
;
7721 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7722 if (rc
== MOVE_NEWLINE_OR_CR
)
7723 set_iterator_to_next (it
, 0);
7727 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7728 negative means move up. DVPOS == 0 means move to the start of the
7729 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7730 NEED_Y_P is zero, IT->current_y will be left unchanged.
7732 Further optimization ideas: If we would know that IT->f doesn't use
7733 a face with proportional font, we could be faster for
7734 truncate-lines nil. */
7737 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7740 /* The commented-out optimization uses vmotion on terminals. This
7741 gives bad results, because elements like it->what, on which
7742 callers such as pos_visible_p rely, aren't updated. */
7743 /* struct position pos;
7744 if (!FRAME_WINDOW_P (it->f))
7746 struct text_pos textpos;
7748 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7749 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7750 reseat (it, textpos, 1);
7751 it->vpos += pos.vpos;
7752 it->current_y += pos.vpos;
7758 /* DVPOS == 0 means move to the start of the screen line. */
7759 move_it_vertically_backward (it
, 0);
7760 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7761 /* Let next call to line_bottom_y calculate real line height */
7766 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7767 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7768 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7773 EMACS_INT start_charpos
, i
;
7775 /* Start at the beginning of the screen line containing IT's
7776 position. This may actually move vertically backwards,
7777 in case of overlays, so adjust dvpos accordingly. */
7779 move_it_vertically_backward (it
, 0);
7782 /* Go back -DVPOS visible lines and reseat the iterator there. */
7783 start_charpos
= IT_CHARPOS (*it
);
7784 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7785 back_to_previous_visible_line_start (it
);
7786 reseat (it
, it
->current
.pos
, 1);
7788 /* Move further back if we end up in a string or an image. */
7789 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7791 /* First try to move to start of display line. */
7793 move_it_vertically_backward (it
, 0);
7795 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7797 /* If start of line is still in string or image,
7798 move further back. */
7799 back_to_previous_visible_line_start (it
);
7800 reseat (it
, it
->current
.pos
, 1);
7804 it
->current_x
= it
->hpos
= 0;
7806 /* Above call may have moved too far if continuation lines
7807 are involved. Scan forward and see if it did. */
7809 it2
.vpos
= it2
.current_y
= 0;
7810 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7811 it
->vpos
-= it2
.vpos
;
7812 it
->current_y
-= it2
.current_y
;
7813 it
->current_x
= it
->hpos
= 0;
7815 /* If we moved too far back, move IT some lines forward. */
7816 if (it2
.vpos
> -dvpos
)
7818 int delta
= it2
.vpos
+ dvpos
;
7820 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7821 /* Move back again if we got too far ahead. */
7822 if (IT_CHARPOS (*it
) >= start_charpos
)
7828 /* Return 1 if IT points into the middle of a display vector. */
7831 in_display_vector_p (struct it
*it
)
7833 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7834 && it
->current
.dpvec_index
> 0
7835 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7839 /***********************************************************************
7841 ***********************************************************************/
7844 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7848 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7850 Lisp_Object args
[3];
7851 Lisp_Object msg
, fmt
;
7854 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7857 /* Do nothing if called asynchronously. Inserting text into
7858 a buffer may call after-change-functions and alike and
7859 that would means running Lisp asynchronously. */
7860 if (handling_signal
)
7864 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7866 args
[0] = fmt
= build_string (format
);
7869 msg
= Fformat (3, args
);
7871 len
= SBYTES (msg
) + 1;
7872 SAFE_ALLOCA (buffer
, char *, len
);
7873 memcpy (buffer
, SDATA (msg
), len
);
7875 message_dolog (buffer
, len
- 1, 1, 0);
7882 /* Output a newline in the *Messages* buffer if "needs" one. */
7885 message_log_maybe_newline (void)
7887 if (message_log_need_newline
)
7888 message_dolog ("", 0, 1, 0);
7892 /* Add a string M of length NBYTES to the message log, optionally
7893 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7894 nonzero, means interpret the contents of M as multibyte. This
7895 function calls low-level routines in order to bypass text property
7896 hooks, etc. which might not be safe to run.
7898 This may GC (insert may run before/after change hooks),
7899 so the buffer M must NOT point to a Lisp string. */
7902 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7904 const unsigned char *msg
= (const unsigned char *) m
;
7906 if (!NILP (Vmemory_full
))
7909 if (!NILP (Vmessage_log_max
))
7911 struct buffer
*oldbuf
;
7912 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7913 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7914 EMACS_INT point_at_end
= 0;
7915 EMACS_INT zv_at_end
= 0;
7916 Lisp_Object old_deactivate_mark
, tem
;
7917 struct gcpro gcpro1
;
7919 old_deactivate_mark
= Vdeactivate_mark
;
7920 oldbuf
= current_buffer
;
7921 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7922 BVAR (current_buffer
, undo_list
) = Qt
;
7924 oldpoint
= message_dolog_marker1
;
7925 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7926 oldbegv
= message_dolog_marker2
;
7927 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7928 oldzv
= message_dolog_marker3
;
7929 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7930 GCPRO1 (old_deactivate_mark
);
7938 BEGV_BYTE
= BEG_BYTE
;
7941 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7943 /* Insert the string--maybe converting multibyte to single byte
7944 or vice versa, so that all the text fits the buffer. */
7946 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7952 /* Convert a multibyte string to single-byte
7953 for the *Message* buffer. */
7954 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7956 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7957 work
[0] = (ASCII_CHAR_P (c
)
7959 : multibyte_char_to_unibyte (c
, Qnil
));
7960 insert_1_both (work
, 1, 1, 1, 0, 0);
7963 else if (! multibyte
7964 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7968 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7969 /* Convert a single-byte string to multibyte
7970 for the *Message* buffer. */
7971 for (i
= 0; i
< nbytes
; i
++)
7974 MAKE_CHAR_MULTIBYTE (c
);
7975 char_bytes
= CHAR_STRING (c
, str
);
7976 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7980 insert_1 (m
, nbytes
, 1, 0, 0);
7984 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7986 insert_1 ("\n", 1, 1, 0, 0);
7988 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7990 this_bol_byte
= PT_BYTE
;
7992 /* See if this line duplicates the previous one.
7993 If so, combine duplicates. */
7996 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7998 prev_bol_byte
= PT_BYTE
;
8000 dups
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8001 this_bol
, this_bol_byte
);
8004 del_range_both (prev_bol
, prev_bol_byte
,
8005 this_bol
, this_bol_byte
, 0);
8011 /* If you change this format, don't forget to also
8012 change message_log_check_duplicate. */
8013 sprintf (dupstr
, " [%d times]", dups
);
8014 duplen
= strlen (dupstr
);
8015 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8016 insert_1 (dupstr
, duplen
, 1, 0, 1);
8021 /* If we have more than the desired maximum number of lines
8022 in the *Messages* buffer now, delete the oldest ones.
8023 This is safe because we don't have undo in this buffer. */
8025 if (NATNUMP (Vmessage_log_max
))
8027 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8028 -XFASTINT (Vmessage_log_max
) - 1, 0);
8029 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8032 BEGV
= XMARKER (oldbegv
)->charpos
;
8033 BEGV_BYTE
= marker_byte_position (oldbegv
);
8042 ZV
= XMARKER (oldzv
)->charpos
;
8043 ZV_BYTE
= marker_byte_position (oldzv
);
8047 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8049 /* We can't do Fgoto_char (oldpoint) because it will run some
8051 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8052 XMARKER (oldpoint
)->bytepos
);
8055 unchain_marker (XMARKER (oldpoint
));
8056 unchain_marker (XMARKER (oldbegv
));
8057 unchain_marker (XMARKER (oldzv
));
8059 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8060 set_buffer_internal (oldbuf
);
8062 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8063 message_log_need_newline
= !nlflag
;
8064 Vdeactivate_mark
= old_deactivate_mark
;
8069 /* We are at the end of the buffer after just having inserted a newline.
8070 (Note: We depend on the fact we won't be crossing the gap.)
8071 Check to see if the most recent message looks a lot like the previous one.
8072 Return 0 if different, 1 if the new one should just replace it, or a
8073 value N > 1 if we should also append " [N times]". */
8076 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8077 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8080 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8082 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8083 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8085 for (i
= 0; i
< len
; i
++)
8087 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8095 if (*p1
++ == ' ' && *p1
++ == '[')
8098 while (*p1
>= '0' && *p1
<= '9')
8099 n
= n
* 10 + *p1
++ - '0';
8100 if (strncmp ((char *) p1
, " times]\n", 8) == 0)
8107 /* Display an echo area message M with a specified length of NBYTES
8108 bytes. The string may include null characters. If M is 0, clear
8109 out any existing message, and let the mini-buffer text show
8112 This may GC, so the buffer M must NOT point to a Lisp string. */
8115 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8117 /* First flush out any partial line written with print. */
8118 message_log_maybe_newline ();
8120 message_dolog (m
, nbytes
, 1, multibyte
);
8121 message2_nolog (m
, nbytes
, multibyte
);
8125 /* The non-logging counterpart of message2. */
8128 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8130 struct frame
*sf
= SELECTED_FRAME ();
8131 message_enable_multibyte
= multibyte
;
8133 if (FRAME_INITIAL_P (sf
))
8135 if (noninteractive_need_newline
)
8136 putc ('\n', stderr
);
8137 noninteractive_need_newline
= 0;
8139 fwrite (m
, nbytes
, 1, stderr
);
8140 if (cursor_in_echo_area
== 0)
8141 fprintf (stderr
, "\n");
8144 /* A null message buffer means that the frame hasn't really been
8145 initialized yet. Error messages get reported properly by
8146 cmd_error, so this must be just an informative message; toss it. */
8147 else if (INTERACTIVE
8148 && sf
->glyphs_initialized_p
8149 && FRAME_MESSAGE_BUF (sf
))
8151 Lisp_Object mini_window
;
8154 /* Get the frame containing the mini-buffer
8155 that the selected frame is using. */
8156 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8157 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8159 FRAME_SAMPLE_VISIBILITY (f
);
8160 if (FRAME_VISIBLE_P (sf
)
8161 && ! FRAME_VISIBLE_P (f
))
8162 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8166 set_message (m
, Qnil
, nbytes
, multibyte
);
8167 if (minibuffer_auto_raise
)
8168 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8171 clear_message (1, 1);
8173 do_pending_window_change (0);
8174 echo_area_display (1);
8175 do_pending_window_change (0);
8176 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8177 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8182 /* Display an echo area message M with a specified length of NBYTES
8183 bytes. The string may include null characters. If M is not a
8184 string, clear out any existing message, and let the mini-buffer
8187 This function cancels echoing. */
8190 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8192 struct gcpro gcpro1
;
8195 clear_message (1,1);
8198 /* First flush out any partial line written with print. */
8199 message_log_maybe_newline ();
8205 SAFE_ALLOCA (buffer
, char *, nbytes
);
8206 memcpy (buffer
, SDATA (m
), nbytes
);
8207 message_dolog (buffer
, nbytes
, 1, multibyte
);
8210 message3_nolog (m
, nbytes
, multibyte
);
8216 /* The non-logging version of message3.
8217 This does not cancel echoing, because it is used for echoing.
8218 Perhaps we need to make a separate function for echoing
8219 and make this cancel echoing. */
8222 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8224 struct frame
*sf
= SELECTED_FRAME ();
8225 message_enable_multibyte
= multibyte
;
8227 if (FRAME_INITIAL_P (sf
))
8229 if (noninteractive_need_newline
)
8230 putc ('\n', stderr
);
8231 noninteractive_need_newline
= 0;
8233 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8234 if (cursor_in_echo_area
== 0)
8235 fprintf (stderr
, "\n");
8238 /* A null message buffer means that the frame hasn't really been
8239 initialized yet. Error messages get reported properly by
8240 cmd_error, so this must be just an informative message; toss it. */
8241 else if (INTERACTIVE
8242 && sf
->glyphs_initialized_p
8243 && FRAME_MESSAGE_BUF (sf
))
8245 Lisp_Object mini_window
;
8249 /* Get the frame containing the mini-buffer
8250 that the selected frame is using. */
8251 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8252 frame
= XWINDOW (mini_window
)->frame
;
8255 FRAME_SAMPLE_VISIBILITY (f
);
8256 if (FRAME_VISIBLE_P (sf
)
8257 && !FRAME_VISIBLE_P (f
))
8258 Fmake_frame_visible (frame
);
8260 if (STRINGP (m
) && SCHARS (m
) > 0)
8262 set_message (NULL
, m
, nbytes
, multibyte
);
8263 if (minibuffer_auto_raise
)
8264 Fraise_frame (frame
);
8265 /* Assume we are not echoing.
8266 (If we are, echo_now will override this.) */
8267 echo_message_buffer
= Qnil
;
8270 clear_message (1, 1);
8272 do_pending_window_change (0);
8273 echo_area_display (1);
8274 do_pending_window_change (0);
8275 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8276 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8281 /* Display a null-terminated echo area message M. If M is 0, clear
8282 out any existing message, and let the mini-buffer text show through.
8284 The buffer M must continue to exist until after the echo area gets
8285 cleared or some other message gets displayed there. Do not pass
8286 text that is stored in a Lisp string. Do not pass text in a buffer
8287 that was alloca'd. */
8290 message1 (const char *m
)
8292 message2 (m
, (m
? strlen (m
) : 0), 0);
8296 /* The non-logging counterpart of message1. */
8299 message1_nolog (const char *m
)
8301 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8304 /* Display a message M which contains a single %s
8305 which gets replaced with STRING. */
8308 message_with_string (const char *m
, Lisp_Object string
, int log
)
8310 CHECK_STRING (string
);
8316 if (noninteractive_need_newline
)
8317 putc ('\n', stderr
);
8318 noninteractive_need_newline
= 0;
8319 fprintf (stderr
, m
, SDATA (string
));
8320 if (!cursor_in_echo_area
)
8321 fprintf (stderr
, "\n");
8325 else if (INTERACTIVE
)
8327 /* The frame whose minibuffer we're going to display the message on.
8328 It may be larger than the selected frame, so we need
8329 to use its buffer, not the selected frame's buffer. */
8330 Lisp_Object mini_window
;
8331 struct frame
*f
, *sf
= SELECTED_FRAME ();
8333 /* Get the frame containing the minibuffer
8334 that the selected frame is using. */
8335 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8336 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8338 /* A null message buffer means that the frame hasn't really been
8339 initialized yet. Error messages get reported properly by
8340 cmd_error, so this must be just an informative message; toss it. */
8341 if (FRAME_MESSAGE_BUF (f
))
8343 Lisp_Object args
[2], msg
;
8344 struct gcpro gcpro1
, gcpro2
;
8346 args
[0] = build_string (m
);
8347 args
[1] = msg
= string
;
8348 GCPRO2 (args
[0], msg
);
8351 msg
= Fformat (2, args
);
8354 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8356 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8360 /* Print should start at the beginning of the message
8361 buffer next time. */
8362 message_buf_print
= 0;
8368 /* Dump an informative message to the minibuf. If M is 0, clear out
8369 any existing message, and let the mini-buffer text show through. */
8372 vmessage (const char *m
, va_list ap
)
8378 if (noninteractive_need_newline
)
8379 putc ('\n', stderr
);
8380 noninteractive_need_newline
= 0;
8381 vfprintf (stderr
, m
, ap
);
8382 if (cursor_in_echo_area
== 0)
8383 fprintf (stderr
, "\n");
8387 else if (INTERACTIVE
)
8389 /* The frame whose mini-buffer we're going to display the message
8390 on. It may be larger than the selected frame, so we need to
8391 use its buffer, not the selected frame's buffer. */
8392 Lisp_Object mini_window
;
8393 struct frame
*f
, *sf
= SELECTED_FRAME ();
8395 /* Get the frame containing the mini-buffer
8396 that the selected frame is using. */
8397 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8398 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8400 /* A null message buffer means that the frame hasn't really been
8401 initialized yet. Error messages get reported properly by
8402 cmd_error, so this must be just an informative message; toss
8404 if (FRAME_MESSAGE_BUF (f
))
8410 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8411 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8413 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8418 /* Print should start at the beginning of the message
8419 buffer next time. */
8420 message_buf_print
= 0;
8426 message (const char *m
, ...)
8435 /* The non-logging version of message. */
8438 message_nolog (const char *m
, ...)
8440 Lisp_Object old_log_max
;
8443 old_log_max
= Vmessage_log_max
;
8444 Vmessage_log_max
= Qnil
;
8446 Vmessage_log_max
= old_log_max
;
8451 /* Display the current message in the current mini-buffer. This is
8452 only called from error handlers in process.c, and is not time
8456 update_echo_area (void)
8458 if (!NILP (echo_area_buffer
[0]))
8461 string
= Fcurrent_message ();
8462 message3 (string
, SBYTES (string
),
8463 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8468 /* Make sure echo area buffers in `echo_buffers' are live.
8469 If they aren't, make new ones. */
8472 ensure_echo_area_buffers (void)
8476 for (i
= 0; i
< 2; ++i
)
8477 if (!BUFFERP (echo_buffer
[i
])
8478 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8481 Lisp_Object old_buffer
;
8484 old_buffer
= echo_buffer
[i
];
8485 sprintf (name
, " *Echo Area %d*", i
);
8486 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8487 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8488 /* to force word wrap in echo area -
8489 it was decided to postpone this*/
8490 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8492 for (j
= 0; j
< 2; ++j
)
8493 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8494 echo_area_buffer
[j
] = echo_buffer
[i
];
8499 /* Call FN with args A1..A4 with either the current or last displayed
8500 echo_area_buffer as current buffer.
8502 WHICH zero means use the current message buffer
8503 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8504 from echo_buffer[] and clear it.
8506 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8507 suitable buffer from echo_buffer[] and clear it.
8509 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8510 that the current message becomes the last displayed one, make
8511 choose a suitable buffer for echo_area_buffer[0], and clear it.
8513 Value is what FN returns. */
8516 with_echo_area_buffer (struct window
*w
, int which
,
8517 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8518 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8521 int this_one
, the_other
, clear_buffer_p
, rc
;
8522 int count
= SPECPDL_INDEX ();
8524 /* If buffers aren't live, make new ones. */
8525 ensure_echo_area_buffers ();
8530 this_one
= 0, the_other
= 1;
8532 this_one
= 1, the_other
= 0;
8535 this_one
= 0, the_other
= 1;
8538 /* We need a fresh one in case the current echo buffer equals
8539 the one containing the last displayed echo area message. */
8540 if (!NILP (echo_area_buffer
[this_one
])
8541 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8542 echo_area_buffer
[this_one
] = Qnil
;
8545 /* Choose a suitable buffer from echo_buffer[] is we don't
8547 if (NILP (echo_area_buffer
[this_one
]))
8549 echo_area_buffer
[this_one
]
8550 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8551 ? echo_buffer
[the_other
]
8552 : echo_buffer
[this_one
]);
8556 buffer
= echo_area_buffer
[this_one
];
8558 /* Don't get confused by reusing the buffer used for echoing
8559 for a different purpose. */
8560 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8563 record_unwind_protect (unwind_with_echo_area_buffer
,
8564 with_echo_area_buffer_unwind_data (w
));
8566 /* Make the echo area buffer current. Note that for display
8567 purposes, it is not necessary that the displayed window's buffer
8568 == current_buffer, except for text property lookup. So, let's
8569 only set that buffer temporarily here without doing a full
8570 Fset_window_buffer. We must also change w->pointm, though,
8571 because otherwise an assertions in unshow_buffer fails, and Emacs
8573 set_buffer_internal_1 (XBUFFER (buffer
));
8577 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8580 BVAR (current_buffer
, undo_list
) = Qt
;
8581 BVAR (current_buffer
, read_only
) = Qnil
;
8582 specbind (Qinhibit_read_only
, Qt
);
8583 specbind (Qinhibit_modification_hooks
, Qt
);
8585 if (clear_buffer_p
&& Z
> BEG
)
8588 xassert (BEGV
>= BEG
);
8589 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8591 rc
= fn (a1
, a2
, a3
, a4
);
8593 xassert (BEGV
>= BEG
);
8594 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8596 unbind_to (count
, Qnil
);
8601 /* Save state that should be preserved around the call to the function
8602 FN called in with_echo_area_buffer. */
8605 with_echo_area_buffer_unwind_data (struct window
*w
)
8608 Lisp_Object vector
, tmp
;
8610 /* Reduce consing by keeping one vector in
8611 Vwith_echo_area_save_vector. */
8612 vector
= Vwith_echo_area_save_vector
;
8613 Vwith_echo_area_save_vector
= Qnil
;
8616 vector
= Fmake_vector (make_number (7), Qnil
);
8618 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8619 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8620 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8624 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8625 ASET (vector
, i
, w
->buffer
); ++i
;
8626 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8627 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8632 for (; i
< end
; ++i
)
8633 ASET (vector
, i
, Qnil
);
8636 xassert (i
== ASIZE (vector
));
8641 /* Restore global state from VECTOR which was created by
8642 with_echo_area_buffer_unwind_data. */
8645 unwind_with_echo_area_buffer (Lisp_Object vector
)
8647 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8648 Vdeactivate_mark
= AREF (vector
, 1);
8649 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8651 if (WINDOWP (AREF (vector
, 3)))
8654 Lisp_Object buffer
, charpos
, bytepos
;
8656 w
= XWINDOW (AREF (vector
, 3));
8657 buffer
= AREF (vector
, 4);
8658 charpos
= AREF (vector
, 5);
8659 bytepos
= AREF (vector
, 6);
8662 set_marker_both (w
->pointm
, buffer
,
8663 XFASTINT (charpos
), XFASTINT (bytepos
));
8666 Vwith_echo_area_save_vector
= vector
;
8671 /* Set up the echo area for use by print functions. MULTIBYTE_P
8672 non-zero means we will print multibyte. */
8675 setup_echo_area_for_printing (int multibyte_p
)
8677 /* If we can't find an echo area any more, exit. */
8678 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8681 ensure_echo_area_buffers ();
8683 if (!message_buf_print
)
8685 /* A message has been output since the last time we printed.
8686 Choose a fresh echo area buffer. */
8687 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8688 echo_area_buffer
[0] = echo_buffer
[1];
8690 echo_area_buffer
[0] = echo_buffer
[0];
8692 /* Switch to that buffer and clear it. */
8693 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8694 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8698 int count
= SPECPDL_INDEX ();
8699 specbind (Qinhibit_read_only
, Qt
);
8700 /* Note that undo recording is always disabled. */
8702 unbind_to (count
, Qnil
);
8704 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8706 /* Set up the buffer for the multibyteness we need. */
8708 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8709 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8711 /* Raise the frame containing the echo area. */
8712 if (minibuffer_auto_raise
)
8714 struct frame
*sf
= SELECTED_FRAME ();
8715 Lisp_Object mini_window
;
8716 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8717 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8720 message_log_maybe_newline ();
8721 message_buf_print
= 1;
8725 if (NILP (echo_area_buffer
[0]))
8727 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8728 echo_area_buffer
[0] = echo_buffer
[1];
8730 echo_area_buffer
[0] = echo_buffer
[0];
8733 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8735 /* Someone switched buffers between print requests. */
8736 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8737 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8743 /* Display an echo area message in window W. Value is non-zero if W's
8744 height is changed. If display_last_displayed_message_p is
8745 non-zero, display the message that was last displayed, otherwise
8746 display the current message. */
8749 display_echo_area (struct window
*w
)
8751 int i
, no_message_p
, window_height_changed_p
, count
;
8753 /* Temporarily disable garbage collections while displaying the echo
8754 area. This is done because a GC can print a message itself.
8755 That message would modify the echo area buffer's contents while a
8756 redisplay of the buffer is going on, and seriously confuse
8758 count
= inhibit_garbage_collection ();
8760 /* If there is no message, we must call display_echo_area_1
8761 nevertheless because it resizes the window. But we will have to
8762 reset the echo_area_buffer in question to nil at the end because
8763 with_echo_area_buffer will sets it to an empty buffer. */
8764 i
= display_last_displayed_message_p
? 1 : 0;
8765 no_message_p
= NILP (echo_area_buffer
[i
]);
8767 window_height_changed_p
8768 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8769 display_echo_area_1
,
8770 (EMACS_INT
) w
, Qnil
, 0, 0);
8773 echo_area_buffer
[i
] = Qnil
;
8775 unbind_to (count
, Qnil
);
8776 return window_height_changed_p
;
8780 /* Helper for display_echo_area. Display the current buffer which
8781 contains the current echo area message in window W, a mini-window,
8782 a pointer to which is passed in A1. A2..A4 are currently not used.
8783 Change the height of W so that all of the message is displayed.
8784 Value is non-zero if height of W was changed. */
8787 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8789 struct window
*w
= (struct window
*) a1
;
8791 struct text_pos start
;
8792 int window_height_changed_p
= 0;
8794 /* Do this before displaying, so that we have a large enough glyph
8795 matrix for the display. If we can't get enough space for the
8796 whole text, display the last N lines. That works by setting w->start. */
8797 window_height_changed_p
= resize_mini_window (w
, 0);
8799 /* Use the starting position chosen by resize_mini_window. */
8800 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8803 clear_glyph_matrix (w
->desired_matrix
);
8804 XSETWINDOW (window
, w
);
8805 try_window (window
, start
, 0);
8807 return window_height_changed_p
;
8811 /* Resize the echo area window to exactly the size needed for the
8812 currently displayed message, if there is one. If a mini-buffer
8813 is active, don't shrink it. */
8816 resize_echo_area_exactly (void)
8818 if (BUFFERP (echo_area_buffer
[0])
8819 && WINDOWP (echo_area_window
))
8821 struct window
*w
= XWINDOW (echo_area_window
);
8823 Lisp_Object resize_exactly
;
8825 if (minibuf_level
== 0)
8826 resize_exactly
= Qt
;
8828 resize_exactly
= Qnil
;
8830 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8831 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8834 ++windows_or_buffers_changed
;
8835 ++update_mode_lines
;
8836 redisplay_internal (0);
8842 /* Callback function for with_echo_area_buffer, when used from
8843 resize_echo_area_exactly. A1 contains a pointer to the window to
8844 resize, EXACTLY non-nil means resize the mini-window exactly to the
8845 size of the text displayed. A3 and A4 are not used. Value is what
8846 resize_mini_window returns. */
8849 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8851 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8855 /* Resize mini-window W to fit the size of its contents. EXACT_P
8856 means size the window exactly to the size needed. Otherwise, it's
8857 only enlarged until W's buffer is empty.
8859 Set W->start to the right place to begin display. If the whole
8860 contents fit, start at the beginning. Otherwise, start so as
8861 to make the end of the contents appear. This is particularly
8862 important for y-or-n-p, but seems desirable generally.
8864 Value is non-zero if the window height has been changed. */
8867 resize_mini_window (struct window
*w
, int exact_p
)
8869 struct frame
*f
= XFRAME (w
->frame
);
8870 int window_height_changed_p
= 0;
8872 xassert (MINI_WINDOW_P (w
));
8874 /* By default, start display at the beginning. */
8875 set_marker_both (w
->start
, w
->buffer
,
8876 BUF_BEGV (XBUFFER (w
->buffer
)),
8877 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8879 /* Don't resize windows while redisplaying a window; it would
8880 confuse redisplay functions when the size of the window they are
8881 displaying changes from under them. Such a resizing can happen,
8882 for instance, when which-func prints a long message while
8883 we are running fontification-functions. We're running these
8884 functions with safe_call which binds inhibit-redisplay to t. */
8885 if (!NILP (Vinhibit_redisplay
))
8888 /* Nil means don't try to resize. */
8889 if (NILP (Vresize_mini_windows
)
8890 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8893 if (!FRAME_MINIBUF_ONLY_P (f
))
8896 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8897 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8898 int height
, max_height
;
8899 int unit
= FRAME_LINE_HEIGHT (f
);
8900 struct text_pos start
;
8901 struct buffer
*old_current_buffer
= NULL
;
8903 if (current_buffer
!= XBUFFER (w
->buffer
))
8905 old_current_buffer
= current_buffer
;
8906 set_buffer_internal (XBUFFER (w
->buffer
));
8909 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8911 /* Compute the max. number of lines specified by the user. */
8912 if (FLOATP (Vmax_mini_window_height
))
8913 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8914 else if (INTEGERP (Vmax_mini_window_height
))
8915 max_height
= XINT (Vmax_mini_window_height
);
8917 max_height
= total_height
/ 4;
8919 /* Correct that max. height if it's bogus. */
8920 max_height
= max (1, max_height
);
8921 max_height
= min (total_height
, max_height
);
8923 /* Find out the height of the text in the window. */
8924 if (it
.line_wrap
== TRUNCATE
)
8929 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8930 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8931 height
= it
.current_y
+ last_height
;
8933 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8934 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8935 height
= (height
+ unit
- 1) / unit
;
8938 /* Compute a suitable window start. */
8939 if (height
> max_height
)
8941 height
= max_height
;
8942 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8943 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8944 start
= it
.current
.pos
;
8947 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8948 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8950 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8952 /* Let it grow only, until we display an empty message, in which
8953 case the window shrinks again. */
8954 if (height
> WINDOW_TOTAL_LINES (w
))
8956 int old_height
= WINDOW_TOTAL_LINES (w
);
8957 freeze_window_starts (f
, 1);
8958 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8959 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8961 else if (height
< WINDOW_TOTAL_LINES (w
)
8962 && (exact_p
|| BEGV
== ZV
))
8964 int old_height
= WINDOW_TOTAL_LINES (w
);
8965 freeze_window_starts (f
, 0);
8966 shrink_mini_window (w
);
8967 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8972 /* Always resize to exact size needed. */
8973 if (height
> WINDOW_TOTAL_LINES (w
))
8975 int old_height
= WINDOW_TOTAL_LINES (w
);
8976 freeze_window_starts (f
, 1);
8977 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8978 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8980 else if (height
< WINDOW_TOTAL_LINES (w
))
8982 int old_height
= WINDOW_TOTAL_LINES (w
);
8983 freeze_window_starts (f
, 0);
8984 shrink_mini_window (w
);
8988 freeze_window_starts (f
, 1);
8989 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8992 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8996 if (old_current_buffer
)
8997 set_buffer_internal (old_current_buffer
);
9000 return window_height_changed_p
;
9004 /* Value is the current message, a string, or nil if there is no
9008 current_message (void)
9012 if (!BUFFERP (echo_area_buffer
[0]))
9016 with_echo_area_buffer (0, 0, current_message_1
,
9017 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9019 echo_area_buffer
[0] = Qnil
;
9027 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9029 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9032 *msg
= make_buffer_string (BEG
, Z
, 1);
9039 /* Push the current message on Vmessage_stack for later restauration
9040 by restore_message. Value is non-zero if the current message isn't
9041 empty. This is a relatively infrequent operation, so it's not
9042 worth optimizing. */
9048 msg
= current_message ();
9049 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9050 return STRINGP (msg
);
9054 /* Restore message display from the top of Vmessage_stack. */
9057 restore_message (void)
9061 xassert (CONSP (Vmessage_stack
));
9062 msg
= XCAR (Vmessage_stack
);
9064 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9066 message3_nolog (msg
, 0, 0);
9070 /* Handler for record_unwind_protect calling pop_message. */
9073 pop_message_unwind (Lisp_Object dummy
)
9079 /* Pop the top-most entry off Vmessage_stack. */
9084 xassert (CONSP (Vmessage_stack
));
9085 Vmessage_stack
= XCDR (Vmessage_stack
);
9089 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9090 exits. If the stack is not empty, we have a missing pop_message
9094 check_message_stack (void)
9096 if (!NILP (Vmessage_stack
))
9101 /* Truncate to NCHARS what will be displayed in the echo area the next
9102 time we display it---but don't redisplay it now. */
9105 truncate_echo_area (EMACS_INT nchars
)
9108 echo_area_buffer
[0] = Qnil
;
9109 /* A null message buffer means that the frame hasn't really been
9110 initialized yet. Error messages get reported properly by
9111 cmd_error, so this must be just an informative message; toss it. */
9112 else if (!noninteractive
9114 && !NILP (echo_area_buffer
[0]))
9116 struct frame
*sf
= SELECTED_FRAME ();
9117 if (FRAME_MESSAGE_BUF (sf
))
9118 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9123 /* Helper function for truncate_echo_area. Truncate the current
9124 message to at most NCHARS characters. */
9127 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9129 if (BEG
+ nchars
< Z
)
9130 del_range (BEG
+ nchars
, Z
);
9132 echo_area_buffer
[0] = Qnil
;
9137 /* Set the current message to a substring of S or STRING.
9139 If STRING is a Lisp string, set the message to the first NBYTES
9140 bytes from STRING. NBYTES zero means use the whole string. If
9141 STRING is multibyte, the message will be displayed multibyte.
9143 If S is not null, set the message to the first LEN bytes of S. LEN
9144 zero means use the whole string. MULTIBYTE_P non-zero means S is
9145 multibyte. Display the message multibyte in that case.
9147 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9148 to t before calling set_message_1 (which calls insert).
9152 set_message (const char *s
, Lisp_Object string
,
9153 EMACS_INT nbytes
, int multibyte_p
)
9155 message_enable_multibyte
9156 = ((s
&& multibyte_p
)
9157 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9159 with_echo_area_buffer (0, -1, set_message_1
,
9160 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9161 message_buf_print
= 0;
9162 help_echo_showing_p
= 0;
9166 /* Helper function for set_message. Arguments have the same meaning
9167 as there, with A1 corresponding to S and A2 corresponding to STRING
9168 This function is called with the echo area buffer being
9172 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9174 const char *s
= (const char *) a1
;
9175 const unsigned char *msg
= (const unsigned char *) s
;
9176 Lisp_Object string
= a2
;
9178 /* Change multibyteness of the echo buffer appropriately. */
9179 if (message_enable_multibyte
9180 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9181 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9183 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9184 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9185 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9187 /* Insert new message at BEG. */
9188 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9190 if (STRINGP (string
))
9195 nbytes
= SBYTES (string
);
9196 nchars
= string_byte_to_char (string
, nbytes
);
9198 /* This function takes care of single/multibyte conversion. We
9199 just have to ensure that the echo area buffer has the right
9200 setting of enable_multibyte_characters. */
9201 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9206 nbytes
= strlen (s
);
9208 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9210 /* Convert from multi-byte to single-byte. */
9215 /* Convert a multibyte string to single-byte. */
9216 for (i
= 0; i
< nbytes
; i
+= n
)
9218 c
= string_char_and_length (msg
+ i
, &n
);
9219 work
[0] = (ASCII_CHAR_P (c
)
9221 : multibyte_char_to_unibyte (c
, Qnil
));
9222 insert_1_both (work
, 1, 1, 1, 0, 0);
9225 else if (!multibyte_p
9226 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9228 /* Convert from single-byte to multi-byte. */
9231 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9233 /* Convert a single-byte string to multibyte. */
9234 for (i
= 0; i
< nbytes
; i
++)
9237 MAKE_CHAR_MULTIBYTE (c
);
9238 n
= CHAR_STRING (c
, str
);
9239 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9243 insert_1 (s
, nbytes
, 1, 0, 0);
9250 /* Clear messages. CURRENT_P non-zero means clear the current
9251 message. LAST_DISPLAYED_P non-zero means clear the message
9255 clear_message (int current_p
, int last_displayed_p
)
9259 echo_area_buffer
[0] = Qnil
;
9260 message_cleared_p
= 1;
9263 if (last_displayed_p
)
9264 echo_area_buffer
[1] = Qnil
;
9266 message_buf_print
= 0;
9269 /* Clear garbaged frames.
9271 This function is used where the old redisplay called
9272 redraw_garbaged_frames which in turn called redraw_frame which in
9273 turn called clear_frame. The call to clear_frame was a source of
9274 flickering. I believe a clear_frame is not necessary. It should
9275 suffice in the new redisplay to invalidate all current matrices,
9276 and ensure a complete redisplay of all windows. */
9279 clear_garbaged_frames (void)
9283 Lisp_Object tail
, frame
;
9284 int changed_count
= 0;
9286 FOR_EACH_FRAME (tail
, frame
)
9288 struct frame
*f
= XFRAME (frame
);
9290 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9294 Fredraw_frame (frame
);
9295 f
->force_flush_display_p
= 1;
9297 clear_current_matrices (f
);
9306 ++windows_or_buffers_changed
;
9311 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9312 is non-zero update selected_frame. Value is non-zero if the
9313 mini-windows height has been changed. */
9316 echo_area_display (int update_frame_p
)
9318 Lisp_Object mini_window
;
9321 int window_height_changed_p
= 0;
9322 struct frame
*sf
= SELECTED_FRAME ();
9324 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9325 w
= XWINDOW (mini_window
);
9326 f
= XFRAME (WINDOW_FRAME (w
));
9328 /* Don't display if frame is invisible or not yet initialized. */
9329 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9332 #ifdef HAVE_WINDOW_SYSTEM
9333 /* When Emacs starts, selected_frame may be the initial terminal
9334 frame. If we let this through, a message would be displayed on
9336 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9338 #endif /* HAVE_WINDOW_SYSTEM */
9340 /* Redraw garbaged frames. */
9342 clear_garbaged_frames ();
9344 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9346 echo_area_window
= mini_window
;
9347 window_height_changed_p
= display_echo_area (w
);
9348 w
->must_be_updated_p
= 1;
9350 /* Update the display, unless called from redisplay_internal.
9351 Also don't update the screen during redisplay itself. The
9352 update will happen at the end of redisplay, and an update
9353 here could cause confusion. */
9354 if (update_frame_p
&& !redisplaying_p
)
9358 /* If the display update has been interrupted by pending
9359 input, update mode lines in the frame. Due to the
9360 pending input, it might have been that redisplay hasn't
9361 been called, so that mode lines above the echo area are
9362 garbaged. This looks odd, so we prevent it here. */
9363 if (!display_completed
)
9364 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9366 if (window_height_changed_p
9367 /* Don't do this if Emacs is shutting down. Redisplay
9368 needs to run hooks. */
9369 && !NILP (Vrun_hooks
))
9371 /* Must update other windows. Likewise as in other
9372 cases, don't let this update be interrupted by
9374 int count
= SPECPDL_INDEX ();
9375 specbind (Qredisplay_dont_pause
, Qt
);
9376 windows_or_buffers_changed
= 1;
9377 redisplay_internal (0);
9378 unbind_to (count
, Qnil
);
9380 else if (FRAME_WINDOW_P (f
) && n
== 0)
9382 /* Window configuration is the same as before.
9383 Can do with a display update of the echo area,
9384 unless we displayed some mode lines. */
9385 update_single_window (w
, 1);
9386 FRAME_RIF (f
)->flush_display (f
);
9389 update_frame (f
, 1, 1);
9391 /* If cursor is in the echo area, make sure that the next
9392 redisplay displays the minibuffer, so that the cursor will
9393 be replaced with what the minibuffer wants. */
9394 if (cursor_in_echo_area
)
9395 ++windows_or_buffers_changed
;
9398 else if (!EQ (mini_window
, selected_window
))
9399 windows_or_buffers_changed
++;
9401 /* Last displayed message is now the current message. */
9402 echo_area_buffer
[1] = echo_area_buffer
[0];
9403 /* Inform read_char that we're not echoing. */
9404 echo_message_buffer
= Qnil
;
9406 /* Prevent redisplay optimization in redisplay_internal by resetting
9407 this_line_start_pos. This is done because the mini-buffer now
9408 displays the message instead of its buffer text. */
9409 if (EQ (mini_window
, selected_window
))
9410 CHARPOS (this_line_start_pos
) = 0;
9412 return window_height_changed_p
;
9417 /***********************************************************************
9418 Mode Lines and Frame Titles
9419 ***********************************************************************/
9421 /* A buffer for constructing non-propertized mode-line strings and
9422 frame titles in it; allocated from the heap in init_xdisp and
9423 resized as needed in store_mode_line_noprop_char. */
9425 static char *mode_line_noprop_buf
;
9427 /* The buffer's end, and a current output position in it. */
9429 static char *mode_line_noprop_buf_end
;
9430 static char *mode_line_noprop_ptr
;
9432 #define MODE_LINE_NOPROP_LEN(start) \
9433 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9436 MODE_LINE_DISPLAY
= 0,
9442 /* Alist that caches the results of :propertize.
9443 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9444 static Lisp_Object mode_line_proptrans_alist
;
9446 /* List of strings making up the mode-line. */
9447 static Lisp_Object mode_line_string_list
;
9449 /* Base face property when building propertized mode line string. */
9450 static Lisp_Object mode_line_string_face
;
9451 static Lisp_Object mode_line_string_face_prop
;
9454 /* Unwind data for mode line strings */
9456 static Lisp_Object Vmode_line_unwind_vector
;
9459 format_mode_line_unwind_data (struct buffer
*obuf
,
9463 Lisp_Object vector
, tmp
;
9465 /* Reduce consing by keeping one vector in
9466 Vwith_echo_area_save_vector. */
9467 vector
= Vmode_line_unwind_vector
;
9468 Vmode_line_unwind_vector
= Qnil
;
9471 vector
= Fmake_vector (make_number (8), Qnil
);
9473 ASET (vector
, 0, make_number (mode_line_target
));
9474 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9475 ASET (vector
, 2, mode_line_string_list
);
9476 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9477 ASET (vector
, 4, mode_line_string_face
);
9478 ASET (vector
, 5, mode_line_string_face_prop
);
9481 XSETBUFFER (tmp
, obuf
);
9484 ASET (vector
, 6, tmp
);
9485 ASET (vector
, 7, owin
);
9491 unwind_format_mode_line (Lisp_Object vector
)
9493 mode_line_target
= XINT (AREF (vector
, 0));
9494 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9495 mode_line_string_list
= AREF (vector
, 2);
9496 if (! EQ (AREF (vector
, 3), Qt
))
9497 mode_line_proptrans_alist
= AREF (vector
, 3);
9498 mode_line_string_face
= AREF (vector
, 4);
9499 mode_line_string_face_prop
= AREF (vector
, 5);
9501 if (!NILP (AREF (vector
, 7)))
9502 /* Select window before buffer, since it may change the buffer. */
9503 Fselect_window (AREF (vector
, 7), Qt
);
9505 if (!NILP (AREF (vector
, 6)))
9507 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9508 ASET (vector
, 6, Qnil
);
9511 Vmode_line_unwind_vector
= vector
;
9516 /* Store a single character C for the frame title in mode_line_noprop_buf.
9517 Re-allocate mode_line_noprop_buf if necessary. */
9520 store_mode_line_noprop_char (char c
)
9522 /* If output position has reached the end of the allocated buffer,
9523 double the buffer's size. */
9524 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9526 int len
= MODE_LINE_NOPROP_LEN (0);
9527 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9528 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9529 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9530 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9533 *mode_line_noprop_ptr
++ = c
;
9537 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9538 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9539 characters that yield more columns than PRECISION; PRECISION <= 0
9540 means copy the whole string. Pad with spaces until FIELD_WIDTH
9541 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9542 pad. Called from display_mode_element when it is used to build a
9546 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9548 const unsigned char *str
= (const unsigned char *) string
;
9550 EMACS_INT dummy
, nbytes
;
9552 /* Copy at most PRECISION chars from STR. */
9553 nbytes
= strlen (string
);
9554 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9556 store_mode_line_noprop_char (*str
++);
9558 /* Fill up with spaces until FIELD_WIDTH reached. */
9559 while (field_width
> 0
9562 store_mode_line_noprop_char (' ');
9569 /***********************************************************************
9571 ***********************************************************************/
9573 #ifdef HAVE_WINDOW_SYSTEM
9575 /* Set the title of FRAME, if it has changed. The title format is
9576 Vicon_title_format if FRAME is iconified, otherwise it is
9577 frame_title_format. */
9580 x_consider_frame_title (Lisp_Object frame
)
9582 struct frame
*f
= XFRAME (frame
);
9584 if (FRAME_WINDOW_P (f
)
9585 || FRAME_MINIBUF_ONLY_P (f
)
9586 || f
->explicit_name
)
9588 /* Do we have more than one visible frame on this X display? */
9595 int count
= SPECPDL_INDEX ();
9597 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9599 Lisp_Object other_frame
= XCAR (tail
);
9600 struct frame
*tf
= XFRAME (other_frame
);
9603 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9604 && !FRAME_MINIBUF_ONLY_P (tf
)
9605 && !EQ (other_frame
, tip_frame
)
9606 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9610 /* Set global variable indicating that multiple frames exist. */
9611 multiple_frames
= CONSP (tail
);
9613 /* Switch to the buffer of selected window of the frame. Set up
9614 mode_line_target so that display_mode_element will output into
9615 mode_line_noprop_buf; then display the title. */
9616 record_unwind_protect (unwind_format_mode_line
,
9617 format_mode_line_unwind_data
9618 (current_buffer
, selected_window
, 0));
9620 Fselect_window (f
->selected_window
, Qt
);
9621 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9622 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9624 mode_line_target
= MODE_LINE_TITLE
;
9625 title_start
= MODE_LINE_NOPROP_LEN (0);
9626 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9627 NULL
, DEFAULT_FACE_ID
);
9628 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9629 len
= MODE_LINE_NOPROP_LEN (title_start
);
9630 title
= mode_line_noprop_buf
+ title_start
;
9631 unbind_to (count
, Qnil
);
9633 /* Set the title only if it's changed. This avoids consing in
9634 the common case where it hasn't. (If it turns out that we've
9635 already wasted too much time by walking through the list with
9636 display_mode_element, then we might need to optimize at a
9637 higher level than this.) */
9638 if (! STRINGP (f
->name
)
9639 || SBYTES (f
->name
) != len
9640 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9641 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9645 #endif /* not HAVE_WINDOW_SYSTEM */
9650 /***********************************************************************
9652 ***********************************************************************/
9655 /* Prepare for redisplay by updating menu-bar item lists when
9656 appropriate. This can call eval. */
9659 prepare_menu_bars (void)
9662 struct gcpro gcpro1
, gcpro2
;
9664 Lisp_Object tooltip_frame
;
9666 #ifdef HAVE_WINDOW_SYSTEM
9667 tooltip_frame
= tip_frame
;
9669 tooltip_frame
= Qnil
;
9672 /* Update all frame titles based on their buffer names, etc. We do
9673 this before the menu bars so that the buffer-menu will show the
9674 up-to-date frame titles. */
9675 #ifdef HAVE_WINDOW_SYSTEM
9676 if (windows_or_buffers_changed
|| update_mode_lines
)
9678 Lisp_Object tail
, frame
;
9680 FOR_EACH_FRAME (tail
, frame
)
9683 if (!EQ (frame
, tooltip_frame
)
9684 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9685 x_consider_frame_title (frame
);
9688 #endif /* HAVE_WINDOW_SYSTEM */
9690 /* Update the menu bar item lists, if appropriate. This has to be
9691 done before any actual redisplay or generation of display lines. */
9692 all_windows
= (update_mode_lines
9693 || buffer_shared
> 1
9694 || windows_or_buffers_changed
);
9697 Lisp_Object tail
, frame
;
9698 int count
= SPECPDL_INDEX ();
9699 /* 1 means that update_menu_bar has run its hooks
9700 so any further calls to update_menu_bar shouldn't do so again. */
9701 int menu_bar_hooks_run
= 0;
9703 record_unwind_save_match_data ();
9705 FOR_EACH_FRAME (tail
, frame
)
9709 /* Ignore tooltip frame. */
9710 if (EQ (frame
, tooltip_frame
))
9713 /* If a window on this frame changed size, report that to
9714 the user and clear the size-change flag. */
9715 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9717 Lisp_Object functions
;
9719 /* Clear flag first in case we get an error below. */
9720 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9721 functions
= Vwindow_size_change_functions
;
9722 GCPRO2 (tail
, functions
);
9724 while (CONSP (functions
))
9726 if (!EQ (XCAR (functions
), Qt
))
9727 call1 (XCAR (functions
), frame
);
9728 functions
= XCDR (functions
);
9734 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9735 #ifdef HAVE_WINDOW_SYSTEM
9736 update_tool_bar (f
, 0);
9739 if (windows_or_buffers_changed
9741 ns_set_doc_edited (f
, Fbuffer_modified_p
9742 (XWINDOW (f
->selected_window
)->buffer
));
9747 unbind_to (count
, Qnil
);
9751 struct frame
*sf
= SELECTED_FRAME ();
9752 update_menu_bar (sf
, 1, 0);
9753 #ifdef HAVE_WINDOW_SYSTEM
9754 update_tool_bar (sf
, 1);
9760 /* Update the menu bar item list for frame F. This has to be done
9761 before we start to fill in any display lines, because it can call
9764 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9766 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9767 already ran the menu bar hooks for this redisplay, so there
9768 is no need to run them again. The return value is the
9769 updated value of this flag, to pass to the next call. */
9772 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9775 register struct window
*w
;
9777 /* If called recursively during a menu update, do nothing. This can
9778 happen when, for instance, an activate-menubar-hook causes a
9780 if (inhibit_menubar_update
)
9783 window
= FRAME_SELECTED_WINDOW (f
);
9784 w
= XWINDOW (window
);
9786 if (FRAME_WINDOW_P (f
)
9788 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9789 || defined (HAVE_NS) || defined (USE_GTK)
9790 FRAME_EXTERNAL_MENU_BAR (f
)
9792 FRAME_MENU_BAR_LINES (f
) > 0
9794 : FRAME_MENU_BAR_LINES (f
) > 0)
9796 /* If the user has switched buffers or windows, we need to
9797 recompute to reflect the new bindings. But we'll
9798 recompute when update_mode_lines is set too; that means
9799 that people can use force-mode-line-update to request
9800 that the menu bar be recomputed. The adverse effect on
9801 the rest of the redisplay algorithm is about the same as
9802 windows_or_buffers_changed anyway. */
9803 if (windows_or_buffers_changed
9804 /* This used to test w->update_mode_line, but we believe
9805 there is no need to recompute the menu in that case. */
9806 || update_mode_lines
9807 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9808 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9809 != !NILP (w
->last_had_star
))
9810 || ((!NILP (Vtransient_mark_mode
)
9811 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9812 != !NILP (w
->region_showing
)))
9814 struct buffer
*prev
= current_buffer
;
9815 int count
= SPECPDL_INDEX ();
9817 specbind (Qinhibit_menubar_update
, Qt
);
9819 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9820 if (save_match_data
)
9821 record_unwind_save_match_data ();
9822 if (NILP (Voverriding_local_map_menu_flag
))
9824 specbind (Qoverriding_terminal_local_map
, Qnil
);
9825 specbind (Qoverriding_local_map
, Qnil
);
9830 /* Run the Lucid hook. */
9831 safe_run_hooks (Qactivate_menubar_hook
);
9833 /* If it has changed current-menubar from previous value,
9834 really recompute the menu-bar from the value. */
9835 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9836 call0 (Qrecompute_lucid_menubar
);
9838 safe_run_hooks (Qmenu_bar_update_hook
);
9843 XSETFRAME (Vmenu_updating_frame
, f
);
9844 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9846 /* Redisplay the menu bar in case we changed it. */
9847 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9848 || defined (HAVE_NS) || defined (USE_GTK)
9849 if (FRAME_WINDOW_P (f
))
9851 #if defined (HAVE_NS)
9852 /* All frames on Mac OS share the same menubar. So only
9853 the selected frame should be allowed to set it. */
9854 if (f
== SELECTED_FRAME ())
9856 set_frame_menubar (f
, 0, 0);
9859 /* On a terminal screen, the menu bar is an ordinary screen
9860 line, and this makes it get updated. */
9861 w
->update_mode_line
= Qt
;
9862 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9863 /* In the non-toolkit version, the menu bar is an ordinary screen
9864 line, and this makes it get updated. */
9865 w
->update_mode_line
= Qt
;
9866 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9868 unbind_to (count
, Qnil
);
9869 set_buffer_internal_1 (prev
);
9878 /***********************************************************************
9880 ***********************************************************************/
9882 #ifdef HAVE_WINDOW_SYSTEM
9885 Nominal cursor position -- where to draw output.
9886 HPOS and VPOS are window relative glyph matrix coordinates.
9887 X and Y are window relative pixel coordinates. */
9889 struct cursor_pos output_cursor
;
9893 Set the global variable output_cursor to CURSOR. All cursor
9894 positions are relative to updated_window. */
9897 set_output_cursor (struct cursor_pos
*cursor
)
9899 output_cursor
.hpos
= cursor
->hpos
;
9900 output_cursor
.vpos
= cursor
->vpos
;
9901 output_cursor
.x
= cursor
->x
;
9902 output_cursor
.y
= cursor
->y
;
9907 Set a nominal cursor position.
9909 HPOS and VPOS are column/row positions in a window glyph matrix. X
9910 and Y are window text area relative pixel positions.
9912 If this is done during an update, updated_window will contain the
9913 window that is being updated and the position is the future output
9914 cursor position for that window. If updated_window is null, use
9915 selected_window and display the cursor at the given position. */
9918 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9922 /* If updated_window is not set, work on selected_window. */
9926 w
= XWINDOW (selected_window
);
9928 /* Set the output cursor. */
9929 output_cursor
.hpos
= hpos
;
9930 output_cursor
.vpos
= vpos
;
9931 output_cursor
.x
= x
;
9932 output_cursor
.y
= y
;
9934 /* If not called as part of an update, really display the cursor.
9935 This will also set the cursor position of W. */
9936 if (updated_window
== NULL
)
9939 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9940 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9941 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9946 #endif /* HAVE_WINDOW_SYSTEM */
9949 /***********************************************************************
9951 ***********************************************************************/
9953 #ifdef HAVE_WINDOW_SYSTEM
9955 /* Where the mouse was last time we reported a mouse event. */
9957 FRAME_PTR last_mouse_frame
;
9959 /* Tool-bar item index of the item on which a mouse button was pressed
9962 int last_tool_bar_item
;
9966 update_tool_bar_unwind (Lisp_Object frame
)
9968 selected_frame
= frame
;
9972 /* Update the tool-bar item list for frame F. This has to be done
9973 before we start to fill in any display lines. Called from
9974 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9975 and restore it here. */
9978 update_tool_bar (struct frame
*f
, int save_match_data
)
9980 #if defined (USE_GTK) || defined (HAVE_NS)
9981 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9983 int do_update
= WINDOWP (f
->tool_bar_window
)
9984 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9992 window
= FRAME_SELECTED_WINDOW (f
);
9993 w
= XWINDOW (window
);
9995 /* If the user has switched buffers or windows, we need to
9996 recompute to reflect the new bindings. But we'll
9997 recompute when update_mode_lines is set too; that means
9998 that people can use force-mode-line-update to request
9999 that the menu bar be recomputed. The adverse effect on
10000 the rest of the redisplay algorithm is about the same as
10001 windows_or_buffers_changed anyway. */
10002 if (windows_or_buffers_changed
10003 || !NILP (w
->update_mode_line
)
10004 || update_mode_lines
10005 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10006 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10007 != !NILP (w
->last_had_star
))
10008 || ((!NILP (Vtransient_mark_mode
)
10009 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10010 != !NILP (w
->region_showing
)))
10012 struct buffer
*prev
= current_buffer
;
10013 int count
= SPECPDL_INDEX ();
10014 Lisp_Object frame
, new_tool_bar
;
10015 int new_n_tool_bar
;
10016 struct gcpro gcpro1
;
10018 /* Set current_buffer to the buffer of the selected
10019 window of the frame, so that we get the right local
10021 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10023 /* Save match data, if we must. */
10024 if (save_match_data
)
10025 record_unwind_save_match_data ();
10027 /* Make sure that we don't accidentally use bogus keymaps. */
10028 if (NILP (Voverriding_local_map_menu_flag
))
10030 specbind (Qoverriding_terminal_local_map
, Qnil
);
10031 specbind (Qoverriding_local_map
, Qnil
);
10034 GCPRO1 (new_tool_bar
);
10036 /* We must temporarily set the selected frame to this frame
10037 before calling tool_bar_items, because the calculation of
10038 the tool-bar keymap uses the selected frame (see
10039 `tool-bar-make-keymap' in tool-bar.el). */
10040 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10041 XSETFRAME (frame
, f
);
10042 selected_frame
= frame
;
10044 /* Build desired tool-bar items from keymaps. */
10045 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10048 /* Redisplay the tool-bar if we changed it. */
10049 if (new_n_tool_bar
!= f
->n_tool_bar_items
10050 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10052 /* Redisplay that happens asynchronously due to an expose event
10053 may access f->tool_bar_items. Make sure we update both
10054 variables within BLOCK_INPUT so no such event interrupts. */
10056 f
->tool_bar_items
= new_tool_bar
;
10057 f
->n_tool_bar_items
= new_n_tool_bar
;
10058 w
->update_mode_line
= Qt
;
10064 unbind_to (count
, Qnil
);
10065 set_buffer_internal_1 (prev
);
10071 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10072 F's desired tool-bar contents. F->tool_bar_items must have
10073 been set up previously by calling prepare_menu_bars. */
10076 build_desired_tool_bar_string (struct frame
*f
)
10078 int i
, size
, size_needed
;
10079 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10080 Lisp_Object image
, plist
, props
;
10082 image
= plist
= props
= Qnil
;
10083 GCPRO3 (image
, plist
, props
);
10085 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10086 Otherwise, make a new string. */
10088 /* The size of the string we might be able to reuse. */
10089 size
= (STRINGP (f
->desired_tool_bar_string
)
10090 ? SCHARS (f
->desired_tool_bar_string
)
10093 /* We need one space in the string for each image. */
10094 size_needed
= f
->n_tool_bar_items
;
10096 /* Reuse f->desired_tool_bar_string, if possible. */
10097 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10098 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10099 make_number (' '));
10102 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10103 Fremove_text_properties (make_number (0), make_number (size
),
10104 props
, f
->desired_tool_bar_string
);
10107 /* Put a `display' property on the string for the images to display,
10108 put a `menu_item' property on tool-bar items with a value that
10109 is the index of the item in F's tool-bar item vector. */
10110 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10112 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10114 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10115 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10116 int hmargin
, vmargin
, relief
, idx
, end
;
10118 /* If image is a vector, choose the image according to the
10120 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10121 if (VECTORP (image
))
10125 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10126 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10129 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10130 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10132 xassert (ASIZE (image
) >= idx
);
10133 image
= AREF (image
, idx
);
10138 /* Ignore invalid image specifications. */
10139 if (!valid_image_p (image
))
10142 /* Display the tool-bar button pressed, or depressed. */
10143 plist
= Fcopy_sequence (XCDR (image
));
10145 /* Compute margin and relief to draw. */
10146 relief
= (tool_bar_button_relief
>= 0
10147 ? tool_bar_button_relief
10148 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10149 hmargin
= vmargin
= relief
;
10151 if (INTEGERP (Vtool_bar_button_margin
)
10152 && XINT (Vtool_bar_button_margin
) > 0)
10154 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10155 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10157 else if (CONSP (Vtool_bar_button_margin
))
10159 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10160 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10161 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10163 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10164 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10165 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10168 if (auto_raise_tool_bar_buttons_p
)
10170 /* Add a `:relief' property to the image spec if the item is
10174 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10181 /* If image is selected, display it pressed, i.e. with a
10182 negative relief. If it's not selected, display it with a
10184 plist
= Fplist_put (plist
, QCrelief
,
10186 ? make_number (-relief
)
10187 : make_number (relief
)));
10192 /* Put a margin around the image. */
10193 if (hmargin
|| vmargin
)
10195 if (hmargin
== vmargin
)
10196 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10198 plist
= Fplist_put (plist
, QCmargin
,
10199 Fcons (make_number (hmargin
),
10200 make_number (vmargin
)));
10203 /* If button is not enabled, and we don't have special images
10204 for the disabled state, make the image appear disabled by
10205 applying an appropriate algorithm to it. */
10206 if (!enabled_p
&& idx
< 0)
10207 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10209 /* Put a `display' text property on the string for the image to
10210 display. Put a `menu-item' property on the string that gives
10211 the start of this item's properties in the tool-bar items
10213 image
= Fcons (Qimage
, plist
);
10214 props
= list4 (Qdisplay
, image
,
10215 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10217 /* Let the last image hide all remaining spaces in the tool bar
10218 string. The string can be longer than needed when we reuse a
10219 previous string. */
10220 if (i
+ 1 == f
->n_tool_bar_items
)
10221 end
= SCHARS (f
->desired_tool_bar_string
);
10224 Fadd_text_properties (make_number (i
), make_number (end
),
10225 props
, f
->desired_tool_bar_string
);
10233 /* Display one line of the tool-bar of frame IT->f.
10235 HEIGHT specifies the desired height of the tool-bar line.
10236 If the actual height of the glyph row is less than HEIGHT, the
10237 row's height is increased to HEIGHT, and the icons are centered
10238 vertically in the new height.
10240 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10241 count a final empty row in case the tool-bar width exactly matches
10246 display_tool_bar_line (struct it
*it
, int height
)
10248 struct glyph_row
*row
= it
->glyph_row
;
10249 int max_x
= it
->last_visible_x
;
10250 struct glyph
*last
;
10252 prepare_desired_row (row
);
10253 row
->y
= it
->current_y
;
10255 /* Note that this isn't made use of if the face hasn't a box,
10256 so there's no need to check the face here. */
10257 it
->start_of_box_run_p
= 1;
10259 while (it
->current_x
< max_x
)
10261 int x
, n_glyphs_before
, i
, nglyphs
;
10262 struct it it_before
;
10264 /* Get the next display element. */
10265 if (!get_next_display_element (it
))
10267 /* Don't count empty row if we are counting needed tool-bar lines. */
10268 if (height
< 0 && !it
->hpos
)
10273 /* Produce glyphs. */
10274 n_glyphs_before
= row
->used
[TEXT_AREA
];
10277 PRODUCE_GLYPHS (it
);
10279 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10281 x
= it_before
.current_x
;
10282 while (i
< nglyphs
)
10284 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10286 if (x
+ glyph
->pixel_width
> max_x
)
10288 /* Glyph doesn't fit on line. Backtrack. */
10289 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10291 /* If this is the only glyph on this line, it will never fit on the
10292 tool-bar, so skip it. But ensure there is at least one glyph,
10293 so we don't accidentally disable the tool-bar. */
10294 if (n_glyphs_before
== 0
10295 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10301 x
+= glyph
->pixel_width
;
10305 /* Stop at line ends. */
10306 if (ITERATOR_AT_END_OF_LINE_P (it
))
10309 set_iterator_to_next (it
, 1);
10314 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10316 /* Use default face for the border below the tool bar.
10318 FIXME: When auto-resize-tool-bars is grow-only, there is
10319 no additional border below the possibly empty tool-bar lines.
10320 So to make the extra empty lines look "normal", we have to
10321 use the tool-bar face for the border too. */
10322 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10323 it
->face_id
= DEFAULT_FACE_ID
;
10325 extend_face_to_end_of_line (it
);
10326 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10327 last
->right_box_line_p
= 1;
10328 if (last
== row
->glyphs
[TEXT_AREA
])
10329 last
->left_box_line_p
= 1;
10331 /* Make line the desired height and center it vertically. */
10332 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10334 /* Don't add more than one line height. */
10335 height
%= FRAME_LINE_HEIGHT (it
->f
);
10336 it
->max_ascent
+= height
/ 2;
10337 it
->max_descent
+= (height
+ 1) / 2;
10340 compute_line_metrics (it
);
10342 /* If line is empty, make it occupy the rest of the tool-bar. */
10343 if (!row
->displays_text_p
)
10345 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10346 row
->visible_height
= row
->height
;
10347 row
->ascent
= row
->phys_ascent
= 0;
10348 row
->extra_line_spacing
= 0;
10351 row
->full_width_p
= 1;
10352 row
->continued_p
= 0;
10353 row
->truncated_on_left_p
= 0;
10354 row
->truncated_on_right_p
= 0;
10356 it
->current_x
= it
->hpos
= 0;
10357 it
->current_y
+= row
->height
;
10363 /* Max tool-bar height. */
10365 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10366 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10368 /* Value is the number of screen lines needed to make all tool-bar
10369 items of frame F visible. The number of actual rows needed is
10370 returned in *N_ROWS if non-NULL. */
10373 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10375 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10377 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10378 the desired matrix, so use (unused) mode-line row as temporary row to
10379 avoid destroying the first tool-bar row. */
10380 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10382 /* Initialize an iterator for iteration over
10383 F->desired_tool_bar_string in the tool-bar window of frame F. */
10384 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10385 it
.first_visible_x
= 0;
10386 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10387 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10389 while (!ITERATOR_AT_END_P (&it
))
10391 clear_glyph_row (temp_row
);
10392 it
.glyph_row
= temp_row
;
10393 display_tool_bar_line (&it
, -1);
10395 clear_glyph_row (temp_row
);
10397 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10399 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10401 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10405 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10407 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10408 (Lisp_Object frame
)
10415 frame
= selected_frame
;
10417 CHECK_FRAME (frame
);
10418 f
= XFRAME (frame
);
10420 if (WINDOWP (f
->tool_bar_window
)
10421 || (w
= XWINDOW (f
->tool_bar_window
),
10422 WINDOW_TOTAL_LINES (w
) > 0))
10424 update_tool_bar (f
, 1);
10425 if (f
->n_tool_bar_items
)
10427 build_desired_tool_bar_string (f
);
10428 nlines
= tool_bar_lines_needed (f
, NULL
);
10432 return make_number (nlines
);
10436 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10437 height should be changed. */
10440 redisplay_tool_bar (struct frame
*f
)
10444 struct glyph_row
*row
;
10446 #if defined (USE_GTK) || defined (HAVE_NS)
10447 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10448 update_frame_tool_bar (f
);
10452 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10453 do anything. This means you must start with tool-bar-lines
10454 non-zero to get the auto-sizing effect. Or in other words, you
10455 can turn off tool-bars by specifying tool-bar-lines zero. */
10456 if (!WINDOWP (f
->tool_bar_window
)
10457 || (w
= XWINDOW (f
->tool_bar_window
),
10458 WINDOW_TOTAL_LINES (w
) == 0))
10461 /* Set up an iterator for the tool-bar window. */
10462 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10463 it
.first_visible_x
= 0;
10464 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10465 row
= it
.glyph_row
;
10467 /* Build a string that represents the contents of the tool-bar. */
10468 build_desired_tool_bar_string (f
);
10469 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10471 if (f
->n_tool_bar_rows
== 0)
10475 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10476 nlines
!= WINDOW_TOTAL_LINES (w
)))
10479 int old_height
= WINDOW_TOTAL_LINES (w
);
10481 XSETFRAME (frame
, f
);
10482 Fmodify_frame_parameters (frame
,
10483 Fcons (Fcons (Qtool_bar_lines
,
10484 make_number (nlines
)),
10486 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10488 clear_glyph_matrix (w
->desired_matrix
);
10489 fonts_changed_p
= 1;
10495 /* Display as many lines as needed to display all tool-bar items. */
10497 if (f
->n_tool_bar_rows
> 0)
10499 int border
, rows
, height
, extra
;
10501 if (INTEGERP (Vtool_bar_border
))
10502 border
= XINT (Vtool_bar_border
);
10503 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10504 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10505 else if (EQ (Vtool_bar_border
, Qborder_width
))
10506 border
= f
->border_width
;
10512 rows
= f
->n_tool_bar_rows
;
10513 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10514 extra
= it
.last_visible_y
- border
- height
* rows
;
10516 while (it
.current_y
< it
.last_visible_y
)
10519 if (extra
> 0 && rows
-- > 0)
10521 h
= (extra
+ rows
- 1) / rows
;
10524 display_tool_bar_line (&it
, height
+ h
);
10529 while (it
.current_y
< it
.last_visible_y
)
10530 display_tool_bar_line (&it
, 0);
10533 /* It doesn't make much sense to try scrolling in the tool-bar
10534 window, so don't do it. */
10535 w
->desired_matrix
->no_scrolling_p
= 1;
10536 w
->must_be_updated_p
= 1;
10538 if (!NILP (Vauto_resize_tool_bars
))
10540 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10541 int change_height_p
= 0;
10543 /* If we couldn't display everything, change the tool-bar's
10544 height if there is room for more. */
10545 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10546 && it
.current_y
< max_tool_bar_height
)
10547 change_height_p
= 1;
10549 row
= it
.glyph_row
- 1;
10551 /* If there are blank lines at the end, except for a partially
10552 visible blank line at the end that is smaller than
10553 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10554 if (!row
->displays_text_p
10555 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10556 change_height_p
= 1;
10558 /* If row displays tool-bar items, but is partially visible,
10559 change the tool-bar's height. */
10560 if (row
->displays_text_p
10561 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10562 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10563 change_height_p
= 1;
10565 /* Resize windows as needed by changing the `tool-bar-lines'
10566 frame parameter. */
10567 if (change_height_p
)
10570 int old_height
= WINDOW_TOTAL_LINES (w
);
10572 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10574 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10575 && !f
->minimize_tool_bar_window_p
)
10576 ? (nlines
> old_height
)
10577 : (nlines
!= old_height
));
10578 f
->minimize_tool_bar_window_p
= 0;
10580 if (change_height_p
)
10582 XSETFRAME (frame
, f
);
10583 Fmodify_frame_parameters (frame
,
10584 Fcons (Fcons (Qtool_bar_lines
,
10585 make_number (nlines
)),
10587 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10589 clear_glyph_matrix (w
->desired_matrix
);
10590 f
->n_tool_bar_rows
= nrows
;
10591 fonts_changed_p
= 1;
10598 f
->minimize_tool_bar_window_p
= 0;
10603 /* Get information about the tool-bar item which is displayed in GLYPH
10604 on frame F. Return in *PROP_IDX the index where tool-bar item
10605 properties start in F->tool_bar_items. Value is zero if
10606 GLYPH doesn't display a tool-bar item. */
10609 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10615 /* This function can be called asynchronously, which means we must
10616 exclude any possibility that Fget_text_property signals an
10618 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10619 charpos
= max (0, charpos
);
10621 /* Get the text property `menu-item' at pos. The value of that
10622 property is the start index of this item's properties in
10623 F->tool_bar_items. */
10624 prop
= Fget_text_property (make_number (charpos
),
10625 Qmenu_item
, f
->current_tool_bar_string
);
10626 if (INTEGERP (prop
))
10628 *prop_idx
= XINT (prop
);
10638 /* Get information about the tool-bar item at position X/Y on frame F.
10639 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10640 the current matrix of the tool-bar window of F, or NULL if not
10641 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10642 item in F->tool_bar_items. Value is
10644 -1 if X/Y is not on a tool-bar item
10645 0 if X/Y is on the same item that was highlighted before.
10649 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10650 int *hpos
, int *vpos
, int *prop_idx
)
10652 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10653 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10656 /* Find the glyph under X/Y. */
10657 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10658 if (*glyph
== NULL
)
10661 /* Get the start of this tool-bar item's properties in
10662 f->tool_bar_items. */
10663 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10666 /* Is mouse on the highlighted item? */
10667 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10668 && *vpos
>= hlinfo
->mouse_face_beg_row
10669 && *vpos
<= hlinfo
->mouse_face_end_row
10670 && (*vpos
> hlinfo
->mouse_face_beg_row
10671 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10672 && (*vpos
< hlinfo
->mouse_face_end_row
10673 || *hpos
< hlinfo
->mouse_face_end_col
10674 || hlinfo
->mouse_face_past_end
))
10682 Handle mouse button event on the tool-bar of frame F, at
10683 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10684 0 for button release. MODIFIERS is event modifiers for button
10688 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10689 unsigned int modifiers
)
10691 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10692 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10693 int hpos
, vpos
, prop_idx
;
10694 struct glyph
*glyph
;
10695 Lisp_Object enabled_p
;
10697 /* If not on the highlighted tool-bar item, return. */
10698 frame_to_window_pixel_xy (w
, &x
, &y
);
10699 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10702 /* If item is disabled, do nothing. */
10703 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10704 if (NILP (enabled_p
))
10709 /* Show item in pressed state. */
10710 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10711 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10712 last_tool_bar_item
= prop_idx
;
10716 Lisp_Object key
, frame
;
10717 struct input_event event
;
10718 EVENT_INIT (event
);
10720 /* Show item in released state. */
10721 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10722 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10724 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10726 XSETFRAME (frame
, f
);
10727 event
.kind
= TOOL_BAR_EVENT
;
10728 event
.frame_or_window
= frame
;
10730 kbd_buffer_store_event (&event
);
10732 event
.kind
= TOOL_BAR_EVENT
;
10733 event
.frame_or_window
= frame
;
10735 event
.modifiers
= modifiers
;
10736 kbd_buffer_store_event (&event
);
10737 last_tool_bar_item
= -1;
10742 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10743 tool-bar window-relative coordinates X/Y. Called from
10744 note_mouse_highlight. */
10747 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10749 Lisp_Object window
= f
->tool_bar_window
;
10750 struct window
*w
= XWINDOW (window
);
10751 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10752 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10754 struct glyph
*glyph
;
10755 struct glyph_row
*row
;
10757 Lisp_Object enabled_p
;
10759 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10760 int mouse_down_p
, rc
;
10762 /* Function note_mouse_highlight is called with negative X/Y
10763 values when mouse moves outside of the frame. */
10764 if (x
<= 0 || y
<= 0)
10766 clear_mouse_face (hlinfo
);
10770 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10773 /* Not on tool-bar item. */
10774 clear_mouse_face (hlinfo
);
10778 /* On same tool-bar item as before. */
10779 goto set_help_echo
;
10781 clear_mouse_face (hlinfo
);
10783 /* Mouse is down, but on different tool-bar item? */
10784 mouse_down_p
= (dpyinfo
->grabbed
10785 && f
== last_mouse_frame
10786 && FRAME_LIVE_P (f
));
10788 && last_tool_bar_item
!= prop_idx
)
10791 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10792 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10794 /* If tool-bar item is not enabled, don't highlight it. */
10795 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10796 if (!NILP (enabled_p
))
10798 /* Compute the x-position of the glyph. In front and past the
10799 image is a space. We include this in the highlighted area. */
10800 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10801 for (i
= x
= 0; i
< hpos
; ++i
)
10802 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10804 /* Record this as the current active region. */
10805 hlinfo
->mouse_face_beg_col
= hpos
;
10806 hlinfo
->mouse_face_beg_row
= vpos
;
10807 hlinfo
->mouse_face_beg_x
= x
;
10808 hlinfo
->mouse_face_beg_y
= row
->y
;
10809 hlinfo
->mouse_face_past_end
= 0;
10811 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10812 hlinfo
->mouse_face_end_row
= vpos
;
10813 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10814 hlinfo
->mouse_face_end_y
= row
->y
;
10815 hlinfo
->mouse_face_window
= window
;
10816 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10818 /* Display it as active. */
10819 show_mouse_face (hlinfo
, draw
);
10820 hlinfo
->mouse_face_image_state
= draw
;
10825 /* Set help_echo_string to a help string to display for this tool-bar item.
10826 XTread_socket does the rest. */
10827 help_echo_object
= help_echo_window
= Qnil
;
10828 help_echo_pos
= -1;
10829 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10830 if (NILP (help_echo_string
))
10831 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10834 #endif /* HAVE_WINDOW_SYSTEM */
10838 /************************************************************************
10839 Horizontal scrolling
10840 ************************************************************************/
10842 static int hscroll_window_tree (Lisp_Object
);
10843 static int hscroll_windows (Lisp_Object
);
10845 /* For all leaf windows in the window tree rooted at WINDOW, set their
10846 hscroll value so that PT is (i) visible in the window, and (ii) so
10847 that it is not within a certain margin at the window's left and
10848 right border. Value is non-zero if any window's hscroll has been
10852 hscroll_window_tree (Lisp_Object window
)
10854 int hscrolled_p
= 0;
10855 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10856 int hscroll_step_abs
= 0;
10857 double hscroll_step_rel
= 0;
10859 if (hscroll_relative_p
)
10861 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10862 if (hscroll_step_rel
< 0)
10864 hscroll_relative_p
= 0;
10865 hscroll_step_abs
= 0;
10868 else if (INTEGERP (Vhscroll_step
))
10870 hscroll_step_abs
= XINT (Vhscroll_step
);
10871 if (hscroll_step_abs
< 0)
10872 hscroll_step_abs
= 0;
10875 hscroll_step_abs
= 0;
10877 while (WINDOWP (window
))
10879 struct window
*w
= XWINDOW (window
);
10881 if (WINDOWP (w
->hchild
))
10882 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10883 else if (WINDOWP (w
->vchild
))
10884 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10885 else if (w
->cursor
.vpos
>= 0)
10888 int text_area_width
;
10889 struct glyph_row
*current_cursor_row
10890 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10891 struct glyph_row
*desired_cursor_row
10892 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10893 struct glyph_row
*cursor_row
10894 = (desired_cursor_row
->enabled_p
10895 ? desired_cursor_row
10896 : current_cursor_row
);
10898 text_area_width
= window_box_width (w
, TEXT_AREA
);
10900 /* Scroll when cursor is inside this scroll margin. */
10901 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10903 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10904 && ((XFASTINT (w
->hscroll
)
10905 && w
->cursor
.x
<= h_margin
)
10906 || (cursor_row
->enabled_p
10907 && cursor_row
->truncated_on_right_p
10908 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10912 struct buffer
*saved_current_buffer
;
10916 /* Find point in a display of infinite width. */
10917 saved_current_buffer
= current_buffer
;
10918 current_buffer
= XBUFFER (w
->buffer
);
10920 if (w
== XWINDOW (selected_window
))
10921 pt
= BUF_PT (current_buffer
);
10924 pt
= marker_position (w
->pointm
);
10925 pt
= max (BEGV
, pt
);
10929 /* Move iterator to pt starting at cursor_row->start in
10930 a line with infinite width. */
10931 init_to_row_start (&it
, w
, cursor_row
);
10932 it
.last_visible_x
= INFINITY
;
10933 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10934 current_buffer
= saved_current_buffer
;
10936 /* Position cursor in window. */
10937 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10938 hscroll
= max (0, (it
.current_x
10939 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10940 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10941 : (text_area_width
/ 2))))
10942 / FRAME_COLUMN_WIDTH (it
.f
);
10943 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10945 if (hscroll_relative_p
)
10946 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10949 wanted_x
= text_area_width
10950 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10953 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10957 if (hscroll_relative_p
)
10958 wanted_x
= text_area_width
* hscroll_step_rel
10961 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10964 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10966 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10968 /* Don't call Fset_window_hscroll if value hasn't
10969 changed because it will prevent redisplay
10971 if (XFASTINT (w
->hscroll
) != hscroll
)
10973 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10974 w
->hscroll
= make_number (hscroll
);
10983 /* Value is non-zero if hscroll of any leaf window has been changed. */
10984 return hscrolled_p
;
10988 /* Set hscroll so that cursor is visible and not inside horizontal
10989 scroll margins for all windows in the tree rooted at WINDOW. See
10990 also hscroll_window_tree above. Value is non-zero if any window's
10991 hscroll has been changed. If it has, desired matrices on the frame
10992 of WINDOW are cleared. */
10995 hscroll_windows (Lisp_Object window
)
10997 int hscrolled_p
= hscroll_window_tree (window
);
10999 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11000 return hscrolled_p
;
11005 /************************************************************************
11007 ************************************************************************/
11009 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11010 to a non-zero value. This is sometimes handy to have in a debugger
11015 /* First and last unchanged row for try_window_id. */
11017 int debug_first_unchanged_at_end_vpos
;
11018 int debug_last_unchanged_at_beg_vpos
;
11020 /* Delta vpos and y. */
11022 int debug_dvpos
, debug_dy
;
11024 /* Delta in characters and bytes for try_window_id. */
11026 EMACS_INT debug_delta
, debug_delta_bytes
;
11028 /* Values of window_end_pos and window_end_vpos at the end of
11031 EMACS_INT debug_end_vpos
;
11033 /* Append a string to W->desired_matrix->method. FMT is a printf
11034 format string. A1...A9 are a supplement for a variable-length
11035 argument list. If trace_redisplay_p is non-zero also printf the
11036 resulting string to stderr. */
11039 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11042 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11045 char *method
= w
->desired_matrix
->method
;
11046 int len
= strlen (method
);
11047 int size
= sizeof w
->desired_matrix
->method
;
11048 int remaining
= size
- len
- 1;
11050 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11051 if (len
&& remaining
)
11054 --remaining
, ++len
;
11057 strncpy (method
+ len
, buffer
, remaining
);
11059 if (trace_redisplay_p
)
11060 fprintf (stderr
, "%p (%s): %s\n",
11062 ((BUFFERP (w
->buffer
)
11063 && STRINGP (XBUFFER (w
->buffer
)->name
))
11064 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11069 #endif /* GLYPH_DEBUG */
11072 /* Value is non-zero if all changes in window W, which displays
11073 current_buffer, are in the text between START and END. START is a
11074 buffer position, END is given as a distance from Z. Used in
11075 redisplay_internal for display optimization. */
11078 text_outside_line_unchanged_p (struct window
*w
,
11079 EMACS_INT start
, EMACS_INT end
)
11081 int unchanged_p
= 1;
11083 /* If text or overlays have changed, see where. */
11084 if (XFASTINT (w
->last_modified
) < MODIFF
11085 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11087 /* Gap in the line? */
11088 if (GPT
< start
|| Z
- GPT
< end
)
11091 /* Changes start in front of the line, or end after it? */
11093 && (BEG_UNCHANGED
< start
- 1
11094 || END_UNCHANGED
< end
))
11097 /* If selective display, can't optimize if changes start at the
11098 beginning of the line. */
11100 && INTEGERP (BVAR (current_buffer
, selective_display
))
11101 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11102 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11105 /* If there are overlays at the start or end of the line, these
11106 may have overlay strings with newlines in them. A change at
11107 START, for instance, may actually concern the display of such
11108 overlay strings as well, and they are displayed on different
11109 lines. So, quickly rule out this case. (For the future, it
11110 might be desirable to implement something more telling than
11111 just BEG/END_UNCHANGED.) */
11114 if (BEG
+ BEG_UNCHANGED
== start
11115 && overlay_touches_p (start
))
11117 if (END_UNCHANGED
== end
11118 && overlay_touches_p (Z
- end
))
11122 /* Under bidi reordering, adding or deleting a character in the
11123 beginning of a paragraph, before the first strong directional
11124 character, can change the base direction of the paragraph (unless
11125 the buffer specifies a fixed paragraph direction), which will
11126 require to redisplay the whole paragraph. It might be worthwhile
11127 to find the paragraph limits and widen the range of redisplayed
11128 lines to that, but for now just give up this optimization. */
11129 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11130 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11134 return unchanged_p
;
11138 /* Do a frame update, taking possible shortcuts into account. This is
11139 the main external entry point for redisplay.
11141 If the last redisplay displayed an echo area message and that message
11142 is no longer requested, we clear the echo area or bring back the
11143 mini-buffer if that is in use. */
11148 redisplay_internal (0);
11153 overlay_arrow_string_or_property (Lisp_Object var
)
11157 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11160 return Voverlay_arrow_string
;
11163 /* Return 1 if there are any overlay-arrows in current_buffer. */
11165 overlay_arrow_in_current_buffer_p (void)
11169 for (vlist
= Voverlay_arrow_variable_list
;
11171 vlist
= XCDR (vlist
))
11173 Lisp_Object var
= XCAR (vlist
);
11176 if (!SYMBOLP (var
))
11178 val
= find_symbol_value (var
);
11180 && current_buffer
== XMARKER (val
)->buffer
)
11187 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11191 overlay_arrows_changed_p (void)
11195 for (vlist
= Voverlay_arrow_variable_list
;
11197 vlist
= XCDR (vlist
))
11199 Lisp_Object var
= XCAR (vlist
);
11200 Lisp_Object val
, pstr
;
11202 if (!SYMBOLP (var
))
11204 val
= find_symbol_value (var
);
11205 if (!MARKERP (val
))
11207 if (! EQ (COERCE_MARKER (val
),
11208 Fget (var
, Qlast_arrow_position
))
11209 || ! (pstr
= overlay_arrow_string_or_property (var
),
11210 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11216 /* Mark overlay arrows to be updated on next redisplay. */
11219 update_overlay_arrows (int up_to_date
)
11223 for (vlist
= Voverlay_arrow_variable_list
;
11225 vlist
= XCDR (vlist
))
11227 Lisp_Object var
= XCAR (vlist
);
11229 if (!SYMBOLP (var
))
11232 if (up_to_date
> 0)
11234 Lisp_Object val
= find_symbol_value (var
);
11235 Fput (var
, Qlast_arrow_position
,
11236 COERCE_MARKER (val
));
11237 Fput (var
, Qlast_arrow_string
,
11238 overlay_arrow_string_or_property (var
));
11240 else if (up_to_date
< 0
11241 || !NILP (Fget (var
, Qlast_arrow_position
)))
11243 Fput (var
, Qlast_arrow_position
, Qt
);
11244 Fput (var
, Qlast_arrow_string
, Qt
);
11250 /* Return overlay arrow string to display at row.
11251 Return integer (bitmap number) for arrow bitmap in left fringe.
11252 Return nil if no overlay arrow. */
11255 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11259 for (vlist
= Voverlay_arrow_variable_list
;
11261 vlist
= XCDR (vlist
))
11263 Lisp_Object var
= XCAR (vlist
);
11266 if (!SYMBOLP (var
))
11269 val
= find_symbol_value (var
);
11272 && current_buffer
== XMARKER (val
)->buffer
11273 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11275 if (FRAME_WINDOW_P (it
->f
)
11276 /* FIXME: if ROW->reversed_p is set, this should test
11277 the right fringe, not the left one. */
11278 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11280 #ifdef HAVE_WINDOW_SYSTEM
11281 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11284 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11285 return make_number (fringe_bitmap
);
11288 return make_number (-1); /* Use default arrow bitmap */
11290 return overlay_arrow_string_or_property (var
);
11297 /* Return 1 if point moved out of or into a composition. Otherwise
11298 return 0. PREV_BUF and PREV_PT are the last point buffer and
11299 position. BUF and PT are the current point buffer and position. */
11302 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11303 struct buffer
*buf
, EMACS_INT pt
)
11305 EMACS_INT start
, end
;
11307 Lisp_Object buffer
;
11309 XSETBUFFER (buffer
, buf
);
11310 /* Check a composition at the last point if point moved within the
11312 if (prev_buf
== buf
)
11315 /* Point didn't move. */
11318 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11319 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11320 && COMPOSITION_VALID_P (start
, end
, prop
)
11321 && start
< prev_pt
&& end
> prev_pt
)
11322 /* The last point was within the composition. Return 1 iff
11323 point moved out of the composition. */
11324 return (pt
<= start
|| pt
>= end
);
11327 /* Check a composition at the current point. */
11328 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11329 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11330 && COMPOSITION_VALID_P (start
, end
, prop
)
11331 && start
< pt
&& end
> pt
);
11335 /* Reconsider the setting of B->clip_changed which is displayed
11339 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11341 if (b
->clip_changed
11342 && !NILP (w
->window_end_valid
)
11343 && w
->current_matrix
->buffer
== b
11344 && w
->current_matrix
->zv
== BUF_ZV (b
)
11345 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11346 b
->clip_changed
= 0;
11348 /* If display wasn't paused, and W is not a tool bar window, see if
11349 point has been moved into or out of a composition. In that case,
11350 we set b->clip_changed to 1 to force updating the screen. If
11351 b->clip_changed has already been set to 1, we can skip this
11353 if (!b
->clip_changed
11354 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11358 if (w
== XWINDOW (selected_window
))
11359 pt
= BUF_PT (current_buffer
);
11361 pt
= marker_position (w
->pointm
);
11363 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11364 || pt
!= XINT (w
->last_point
))
11365 && check_point_in_composition (w
->current_matrix
->buffer
,
11366 XINT (w
->last_point
),
11367 XBUFFER (w
->buffer
), pt
))
11368 b
->clip_changed
= 1;
11373 /* Select FRAME to forward the values of frame-local variables into C
11374 variables so that the redisplay routines can access those values
11378 select_frame_for_redisplay (Lisp_Object frame
)
11380 Lisp_Object tail
, tem
;
11381 Lisp_Object old
= selected_frame
;
11382 struct Lisp_Symbol
*sym
;
11384 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11386 selected_frame
= frame
;
11389 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11390 if (CONSP (XCAR (tail
))
11391 && (tem
= XCAR (XCAR (tail
)),
11393 && (sym
= indirect_variable (XSYMBOL (tem
)),
11394 sym
->redirect
== SYMBOL_LOCALIZED
)
11395 && sym
->val
.blv
->frame_local
)
11396 /* Use find_symbol_value rather than Fsymbol_value
11397 to avoid an error if it is void. */
11398 find_symbol_value (tem
);
11399 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11403 #define STOP_POLLING \
11404 do { if (! polling_stopped_here) stop_polling (); \
11405 polling_stopped_here = 1; } while (0)
11407 #define RESUME_POLLING \
11408 do { if (polling_stopped_here) start_polling (); \
11409 polling_stopped_here = 0; } while (0)
11412 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11413 response to any user action; therefore, we should preserve the echo
11414 area. (Actually, our caller does that job.) Perhaps in the future
11415 avoid recentering windows if it is not necessary; currently that
11416 causes some problems. */
11419 redisplay_internal (int preserve_echo_area
)
11421 struct window
*w
= XWINDOW (selected_window
);
11425 int must_finish
= 0;
11426 struct text_pos tlbufpos
, tlendpos
;
11427 int number_of_visible_frames
;
11430 int polling_stopped_here
= 0;
11431 Lisp_Object old_frame
= selected_frame
;
11433 /* Non-zero means redisplay has to consider all windows on all
11434 frames. Zero means, only selected_window is considered. */
11435 int consider_all_windows_p
;
11437 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11439 /* No redisplay if running in batch mode or frame is not yet fully
11440 initialized, or redisplay is explicitly turned off by setting
11441 Vinhibit_redisplay. */
11442 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11443 || !NILP (Vinhibit_redisplay
))
11446 /* Don't examine these until after testing Vinhibit_redisplay.
11447 When Emacs is shutting down, perhaps because its connection to
11448 X has dropped, we should not look at them at all. */
11449 fr
= XFRAME (w
->frame
);
11450 sf
= SELECTED_FRAME ();
11452 if (!fr
->glyphs_initialized_p
)
11455 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11456 if (popup_activated ())
11460 /* I don't think this happens but let's be paranoid. */
11461 if (redisplaying_p
)
11464 /* Record a function that resets redisplaying_p to its old value
11465 when we leave this function. */
11466 count
= SPECPDL_INDEX ();
11467 record_unwind_protect (unwind_redisplay
,
11468 Fcons (make_number (redisplaying_p
), selected_frame
));
11470 specbind (Qinhibit_free_realized_faces
, Qnil
);
11473 Lisp_Object tail
, frame
;
11475 FOR_EACH_FRAME (tail
, frame
)
11477 struct frame
*f
= XFRAME (frame
);
11478 f
->already_hscrolled_p
= 0;
11483 /* Remember the currently selected window. */
11486 if (!EQ (old_frame
, selected_frame
)
11487 && FRAME_LIVE_P (XFRAME (old_frame
)))
11488 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11489 selected_frame and selected_window to be temporarily out-of-sync so
11490 when we come back here via `goto retry', we need to resync because we
11491 may need to run Elisp code (via prepare_menu_bars). */
11492 select_frame_for_redisplay (old_frame
);
11495 reconsider_clip_changes (w
, current_buffer
);
11496 last_escape_glyph_frame
= NULL
;
11497 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11498 last_glyphless_glyph_frame
= NULL
;
11499 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11501 /* If new fonts have been loaded that make a glyph matrix adjustment
11502 necessary, do it. */
11503 if (fonts_changed_p
)
11505 adjust_glyphs (NULL
);
11506 ++windows_or_buffers_changed
;
11507 fonts_changed_p
= 0;
11510 /* If face_change_count is non-zero, init_iterator will free all
11511 realized faces, which includes the faces referenced from current
11512 matrices. So, we can't reuse current matrices in this case. */
11513 if (face_change_count
)
11514 ++windows_or_buffers_changed
;
11516 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11517 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11519 /* Since frames on a single ASCII terminal share the same
11520 display area, displaying a different frame means redisplay
11521 the whole thing. */
11522 windows_or_buffers_changed
++;
11523 SET_FRAME_GARBAGED (sf
);
11525 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11527 FRAME_TTY (sf
)->previous_frame
= sf
;
11530 /* Set the visible flags for all frames. Do this before checking
11531 for resized or garbaged frames; they want to know if their frames
11532 are visible. See the comment in frame.h for
11533 FRAME_SAMPLE_VISIBILITY. */
11535 Lisp_Object tail
, frame
;
11537 number_of_visible_frames
= 0;
11539 FOR_EACH_FRAME (tail
, frame
)
11541 struct frame
*f
= XFRAME (frame
);
11543 FRAME_SAMPLE_VISIBILITY (f
);
11544 if (FRAME_VISIBLE_P (f
))
11545 ++number_of_visible_frames
;
11546 clear_desired_matrices (f
);
11550 /* Notice any pending interrupt request to change frame size. */
11551 do_pending_window_change (1);
11553 /* do_pending_window_change could change the selected_window due to
11554 frame resizing which makes the selected window too small. */
11555 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11558 reconsider_clip_changes (w
, current_buffer
);
11561 /* Clear frames marked as garbaged. */
11562 if (frame_garbaged
)
11563 clear_garbaged_frames ();
11565 /* Build menubar and tool-bar items. */
11566 if (NILP (Vmemory_full
))
11567 prepare_menu_bars ();
11569 if (windows_or_buffers_changed
)
11570 update_mode_lines
++;
11572 /* Detect case that we need to write or remove a star in the mode line. */
11573 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11575 w
->update_mode_line
= Qt
;
11576 if (buffer_shared
> 1)
11577 update_mode_lines
++;
11580 /* Avoid invocation of point motion hooks by `current_column' below. */
11581 count1
= SPECPDL_INDEX ();
11582 specbind (Qinhibit_point_motion_hooks
, Qt
);
11584 /* If %c is in the mode line, update it if needed. */
11585 if (!NILP (w
->column_number_displayed
)
11586 /* This alternative quickly identifies a common case
11587 where no change is needed. */
11588 && !(PT
== XFASTINT (w
->last_point
)
11589 && XFASTINT (w
->last_modified
) >= MODIFF
11590 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11591 && (XFASTINT (w
->column_number_displayed
)
11592 != (int) current_column ())) /* iftc */
11593 w
->update_mode_line
= Qt
;
11595 unbind_to (count1
, Qnil
);
11597 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11599 /* The variable buffer_shared is set in redisplay_window and
11600 indicates that we redisplay a buffer in different windows. See
11602 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11603 || cursor_type_changed
);
11605 /* If specs for an arrow have changed, do thorough redisplay
11606 to ensure we remove any arrow that should no longer exist. */
11607 if (overlay_arrows_changed_p ())
11608 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11610 /* Normally the message* functions will have already displayed and
11611 updated the echo area, but the frame may have been trashed, or
11612 the update may have been preempted, so display the echo area
11613 again here. Checking message_cleared_p captures the case that
11614 the echo area should be cleared. */
11615 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11616 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11617 || (message_cleared_p
11618 && minibuf_level
== 0
11619 /* If the mini-window is currently selected, this means the
11620 echo-area doesn't show through. */
11621 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11623 int window_height_changed_p
= echo_area_display (0);
11626 /* If we don't display the current message, don't clear the
11627 message_cleared_p flag, because, if we did, we wouldn't clear
11628 the echo area in the next redisplay which doesn't preserve
11630 if (!display_last_displayed_message_p
)
11631 message_cleared_p
= 0;
11633 if (fonts_changed_p
)
11635 else if (window_height_changed_p
)
11637 consider_all_windows_p
= 1;
11638 ++update_mode_lines
;
11639 ++windows_or_buffers_changed
;
11641 /* If window configuration was changed, frames may have been
11642 marked garbaged. Clear them or we will experience
11643 surprises wrt scrolling. */
11644 if (frame_garbaged
)
11645 clear_garbaged_frames ();
11648 else if (EQ (selected_window
, minibuf_window
)
11649 && (current_buffer
->clip_changed
11650 || XFASTINT (w
->last_modified
) < MODIFF
11651 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11652 && resize_mini_window (w
, 0))
11654 /* Resized active mini-window to fit the size of what it is
11655 showing if its contents might have changed. */
11657 /* FIXME: this causes all frames to be updated, which seems unnecessary
11658 since only the current frame needs to be considered. This function needs
11659 to be rewritten with two variables, consider_all_windows and
11660 consider_all_frames. */
11661 consider_all_windows_p
= 1;
11662 ++windows_or_buffers_changed
;
11663 ++update_mode_lines
;
11665 /* If window configuration was changed, frames may have been
11666 marked garbaged. Clear them or we will experience
11667 surprises wrt scrolling. */
11668 if (frame_garbaged
)
11669 clear_garbaged_frames ();
11673 /* If showing the region, and mark has changed, we must redisplay
11674 the whole window. The assignment to this_line_start_pos prevents
11675 the optimization directly below this if-statement. */
11676 if (((!NILP (Vtransient_mark_mode
)
11677 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11678 != !NILP (w
->region_showing
))
11679 || (!NILP (w
->region_showing
)
11680 && !EQ (w
->region_showing
,
11681 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11682 CHARPOS (this_line_start_pos
) = 0;
11684 /* Optimize the case that only the line containing the cursor in the
11685 selected window has changed. Variables starting with this_ are
11686 set in display_line and record information about the line
11687 containing the cursor. */
11688 tlbufpos
= this_line_start_pos
;
11689 tlendpos
= this_line_end_pos
;
11690 if (!consider_all_windows_p
11691 && CHARPOS (tlbufpos
) > 0
11692 && NILP (w
->update_mode_line
)
11693 && !current_buffer
->clip_changed
11694 && !current_buffer
->prevent_redisplay_optimizations_p
11695 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11696 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11697 /* Make sure recorded data applies to current buffer, etc. */
11698 && this_line_buffer
== current_buffer
11699 && current_buffer
== XBUFFER (w
->buffer
)
11700 && NILP (w
->force_start
)
11701 && NILP (w
->optional_new_start
)
11702 /* Point must be on the line that we have info recorded about. */
11703 && PT
>= CHARPOS (tlbufpos
)
11704 && PT
<= Z
- CHARPOS (tlendpos
)
11705 /* All text outside that line, including its final newline,
11706 must be unchanged. */
11707 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11708 CHARPOS (tlendpos
)))
11710 if (CHARPOS (tlbufpos
) > BEGV
11711 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11712 && (CHARPOS (tlbufpos
) == ZV
11713 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11714 /* Former continuation line has disappeared by becoming empty. */
11716 else if (XFASTINT (w
->last_modified
) < MODIFF
11717 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11718 || MINI_WINDOW_P (w
))
11720 /* We have to handle the case of continuation around a
11721 wide-column character (see the comment in indent.c around
11724 For instance, in the following case:
11726 -------- Insert --------
11727 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11728 J_I_ ==> J_I_ `^^' are cursors.
11732 As we have to redraw the line above, we cannot use this
11736 int line_height_before
= this_line_pixel_height
;
11738 /* Note that start_display will handle the case that the
11739 line starting at tlbufpos is a continuation line. */
11740 start_display (&it
, w
, tlbufpos
);
11742 /* Implementation note: It this still necessary? */
11743 if (it
.current_x
!= this_line_start_x
)
11746 TRACE ((stderr
, "trying display optimization 1\n"));
11747 w
->cursor
.vpos
= -1;
11748 overlay_arrow_seen
= 0;
11749 it
.vpos
= this_line_vpos
;
11750 it
.current_y
= this_line_y
;
11751 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11752 display_line (&it
);
11754 /* If line contains point, is not continued,
11755 and ends at same distance from eob as before, we win. */
11756 if (w
->cursor
.vpos
>= 0
11757 /* Line is not continued, otherwise this_line_start_pos
11758 would have been set to 0 in display_line. */
11759 && CHARPOS (this_line_start_pos
)
11760 /* Line ends as before. */
11761 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11762 /* Line has same height as before. Otherwise other lines
11763 would have to be shifted up or down. */
11764 && this_line_pixel_height
== line_height_before
)
11766 /* If this is not the window's last line, we must adjust
11767 the charstarts of the lines below. */
11768 if (it
.current_y
< it
.last_visible_y
)
11770 struct glyph_row
*row
11771 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11772 EMACS_INT delta
, delta_bytes
;
11774 /* We used to distinguish between two cases here,
11775 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11776 when the line ends in a newline or the end of the
11777 buffer's accessible portion. But both cases did
11778 the same, so they were collapsed. */
11780 - CHARPOS (tlendpos
)
11781 - MATRIX_ROW_START_CHARPOS (row
));
11782 delta_bytes
= (Z_BYTE
11783 - BYTEPOS (tlendpos
)
11784 - MATRIX_ROW_START_BYTEPOS (row
));
11786 increment_matrix_positions (w
->current_matrix
,
11787 this_line_vpos
+ 1,
11788 w
->current_matrix
->nrows
,
11789 delta
, delta_bytes
);
11792 /* If this row displays text now but previously didn't,
11793 or vice versa, w->window_end_vpos may have to be
11795 if ((it
.glyph_row
- 1)->displays_text_p
)
11797 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11798 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11800 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11801 && this_line_vpos
> 0)
11802 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11803 w
->window_end_valid
= Qnil
;
11805 /* Update hint: No need to try to scroll in update_window. */
11806 w
->desired_matrix
->no_scrolling_p
= 1;
11809 *w
->desired_matrix
->method
= 0;
11810 debug_method_add (w
, "optimization 1");
11812 #ifdef HAVE_WINDOW_SYSTEM
11813 update_window_fringes (w
, 0);
11820 else if (/* Cursor position hasn't changed. */
11821 PT
== XFASTINT (w
->last_point
)
11822 /* Make sure the cursor was last displayed
11823 in this window. Otherwise we have to reposition it. */
11824 && 0 <= w
->cursor
.vpos
11825 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11829 do_pending_window_change (1);
11830 /* If selected_window changed, redisplay again. */
11831 if (WINDOWP (selected_window
)
11832 && (w
= XWINDOW (selected_window
)) != sw
)
11835 /* We used to always goto end_of_redisplay here, but this
11836 isn't enough if we have a blinking cursor. */
11837 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11838 goto end_of_redisplay
;
11842 /* If highlighting the region, or if the cursor is in the echo area,
11843 then we can't just move the cursor. */
11844 else if (! (!NILP (Vtransient_mark_mode
)
11845 && !NILP (BVAR (current_buffer
, mark_active
)))
11846 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11847 || highlight_nonselected_windows
)
11848 && NILP (w
->region_showing
)
11849 && NILP (Vshow_trailing_whitespace
)
11850 && !cursor_in_echo_area
)
11853 struct glyph_row
*row
;
11855 /* Skip from tlbufpos to PT and see where it is. Note that
11856 PT may be in invisible text. If so, we will end at the
11857 next visible position. */
11858 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11859 NULL
, DEFAULT_FACE_ID
);
11860 it
.current_x
= this_line_start_x
;
11861 it
.current_y
= this_line_y
;
11862 it
.vpos
= this_line_vpos
;
11864 /* The call to move_it_to stops in front of PT, but
11865 moves over before-strings. */
11866 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11868 if (it
.vpos
== this_line_vpos
11869 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11872 xassert (this_line_vpos
== it
.vpos
);
11873 xassert (this_line_y
== it
.current_y
);
11874 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11876 *w
->desired_matrix
->method
= 0;
11877 debug_method_add (w
, "optimization 3");
11886 /* Text changed drastically or point moved off of line. */
11887 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11890 CHARPOS (this_line_start_pos
) = 0;
11891 consider_all_windows_p
|= buffer_shared
> 1;
11892 ++clear_face_cache_count
;
11893 #ifdef HAVE_WINDOW_SYSTEM
11894 ++clear_image_cache_count
;
11897 /* Build desired matrices, and update the display. If
11898 consider_all_windows_p is non-zero, do it for all windows on all
11899 frames. Otherwise do it for selected_window, only. */
11901 if (consider_all_windows_p
)
11903 Lisp_Object tail
, frame
;
11905 FOR_EACH_FRAME (tail
, frame
)
11906 XFRAME (frame
)->updated_p
= 0;
11908 /* Recompute # windows showing selected buffer. This will be
11909 incremented each time such a window is displayed. */
11912 FOR_EACH_FRAME (tail
, frame
)
11914 struct frame
*f
= XFRAME (frame
);
11916 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11918 if (! EQ (frame
, selected_frame
))
11919 /* Select the frame, for the sake of frame-local
11921 select_frame_for_redisplay (frame
);
11923 /* Mark all the scroll bars to be removed; we'll redeem
11924 the ones we want when we redisplay their windows. */
11925 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11926 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11928 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11929 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11931 /* The X error handler may have deleted that frame. */
11932 if (!FRAME_LIVE_P (f
))
11935 /* Any scroll bars which redisplay_windows should have
11936 nuked should now go away. */
11937 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11938 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11940 /* If fonts changed, display again. */
11941 /* ??? rms: I suspect it is a mistake to jump all the way
11942 back to retry here. It should just retry this frame. */
11943 if (fonts_changed_p
)
11946 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11948 /* See if we have to hscroll. */
11949 if (!f
->already_hscrolled_p
)
11951 f
->already_hscrolled_p
= 1;
11952 if (hscroll_windows (f
->root_window
))
11956 /* Prevent various kinds of signals during display
11957 update. stdio is not robust about handling
11958 signals, which can cause an apparent I/O
11960 if (interrupt_input
)
11961 unrequest_sigio ();
11964 /* Update the display. */
11965 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11966 pending
|= update_frame (f
, 0, 0);
11972 if (!EQ (old_frame
, selected_frame
)
11973 && FRAME_LIVE_P (XFRAME (old_frame
)))
11974 /* We played a bit fast-and-loose above and allowed selected_frame
11975 and selected_window to be temporarily out-of-sync but let's make
11976 sure this stays contained. */
11977 select_frame_for_redisplay (old_frame
);
11978 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11982 /* Do the mark_window_display_accurate after all windows have
11983 been redisplayed because this call resets flags in buffers
11984 which are needed for proper redisplay. */
11985 FOR_EACH_FRAME (tail
, frame
)
11987 struct frame
*f
= XFRAME (frame
);
11990 mark_window_display_accurate (f
->root_window
, 1);
11991 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11992 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11997 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11999 Lisp_Object mini_window
;
12000 struct frame
*mini_frame
;
12002 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12003 /* Use list_of_error, not Qerror, so that
12004 we catch only errors and don't run the debugger. */
12005 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12007 redisplay_window_error
);
12009 /* Compare desired and current matrices, perform output. */
12012 /* If fonts changed, display again. */
12013 if (fonts_changed_p
)
12016 /* Prevent various kinds of signals during display update.
12017 stdio is not robust about handling signals,
12018 which can cause an apparent I/O error. */
12019 if (interrupt_input
)
12020 unrequest_sigio ();
12023 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12025 if (hscroll_windows (selected_window
))
12028 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12029 pending
= update_frame (sf
, 0, 0);
12032 /* We may have called echo_area_display at the top of this
12033 function. If the echo area is on another frame, that may
12034 have put text on a frame other than the selected one, so the
12035 above call to update_frame would not have caught it. Catch
12037 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12038 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12040 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12042 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12043 pending
|= update_frame (mini_frame
, 0, 0);
12044 if (!pending
&& hscroll_windows (mini_window
))
12049 /* If display was paused because of pending input, make sure we do a
12050 thorough update the next time. */
12053 /* Prevent the optimization at the beginning of
12054 redisplay_internal that tries a single-line update of the
12055 line containing the cursor in the selected window. */
12056 CHARPOS (this_line_start_pos
) = 0;
12058 /* Let the overlay arrow be updated the next time. */
12059 update_overlay_arrows (0);
12061 /* If we pause after scrolling, some rows in the current
12062 matrices of some windows are not valid. */
12063 if (!WINDOW_FULL_WIDTH_P (w
)
12064 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12065 update_mode_lines
= 1;
12069 if (!consider_all_windows_p
)
12071 /* This has already been done above if
12072 consider_all_windows_p is set. */
12073 mark_window_display_accurate_1 (w
, 1);
12075 /* Say overlay arrows are up to date. */
12076 update_overlay_arrows (1);
12078 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12079 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12082 update_mode_lines
= 0;
12083 windows_or_buffers_changed
= 0;
12084 cursor_type_changed
= 0;
12087 /* Start SIGIO interrupts coming again. Having them off during the
12088 code above makes it less likely one will discard output, but not
12089 impossible, since there might be stuff in the system buffer here.
12090 But it is much hairier to try to do anything about that. */
12091 if (interrupt_input
)
12095 /* If a frame has become visible which was not before, redisplay
12096 again, so that we display it. Expose events for such a frame
12097 (which it gets when becoming visible) don't call the parts of
12098 redisplay constructing glyphs, so simply exposing a frame won't
12099 display anything in this case. So, we have to display these
12100 frames here explicitly. */
12103 Lisp_Object tail
, frame
;
12106 FOR_EACH_FRAME (tail
, frame
)
12108 int this_is_visible
= 0;
12110 if (XFRAME (frame
)->visible
)
12111 this_is_visible
= 1;
12112 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12113 if (XFRAME (frame
)->visible
)
12114 this_is_visible
= 1;
12116 if (this_is_visible
)
12120 if (new_count
!= number_of_visible_frames
)
12121 windows_or_buffers_changed
++;
12124 /* Change frame size now if a change is pending. */
12125 do_pending_window_change (1);
12127 /* If we just did a pending size change, or have additional
12128 visible frames, or selected_window changed, redisplay again. */
12129 if ((windows_or_buffers_changed
&& !pending
)
12130 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12133 /* Clear the face and image caches.
12135 We used to do this only if consider_all_windows_p. But the cache
12136 needs to be cleared if a timer creates images in the current
12137 buffer (e.g. the test case in Bug#6230). */
12139 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12141 clear_face_cache (0);
12142 clear_face_cache_count
= 0;
12145 #ifdef HAVE_WINDOW_SYSTEM
12146 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12148 clear_image_caches (Qnil
);
12149 clear_image_cache_count
= 0;
12151 #endif /* HAVE_WINDOW_SYSTEM */
12154 unbind_to (count
, Qnil
);
12159 /* Redisplay, but leave alone any recent echo area message unless
12160 another message has been requested in its place.
12162 This is useful in situations where you need to redisplay but no
12163 user action has occurred, making it inappropriate for the message
12164 area to be cleared. See tracking_off and
12165 wait_reading_process_output for examples of these situations.
12167 FROM_WHERE is an integer saying from where this function was
12168 called. This is useful for debugging. */
12171 redisplay_preserve_echo_area (int from_where
)
12173 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12175 if (!NILP (echo_area_buffer
[1]))
12177 /* We have a previously displayed message, but no current
12178 message. Redisplay the previous message. */
12179 display_last_displayed_message_p
= 1;
12180 redisplay_internal (1);
12181 display_last_displayed_message_p
= 0;
12184 redisplay_internal (1);
12186 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12187 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12188 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12192 /* Function registered with record_unwind_protect in
12193 redisplay_internal. Reset redisplaying_p to the value it had
12194 before redisplay_internal was called, and clear
12195 prevent_freeing_realized_faces_p. It also selects the previously
12196 selected frame, unless it has been deleted (by an X connection
12197 failure during redisplay, for example). */
12200 unwind_redisplay (Lisp_Object val
)
12202 Lisp_Object old_redisplaying_p
, old_frame
;
12204 old_redisplaying_p
= XCAR (val
);
12205 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12206 old_frame
= XCDR (val
);
12207 if (! EQ (old_frame
, selected_frame
)
12208 && FRAME_LIVE_P (XFRAME (old_frame
)))
12209 select_frame_for_redisplay (old_frame
);
12214 /* Mark the display of window W as accurate or inaccurate. If
12215 ACCURATE_P is non-zero mark display of W as accurate. If
12216 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12217 redisplay_internal is called. */
12220 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12222 if (BUFFERP (w
->buffer
))
12224 struct buffer
*b
= XBUFFER (w
->buffer
);
12227 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12228 w
->last_overlay_modified
12229 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12231 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12235 b
->clip_changed
= 0;
12236 b
->prevent_redisplay_optimizations_p
= 0;
12238 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12239 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12240 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12241 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12243 w
->current_matrix
->buffer
= b
;
12244 w
->current_matrix
->begv
= BUF_BEGV (b
);
12245 w
->current_matrix
->zv
= BUF_ZV (b
);
12247 w
->last_cursor
= w
->cursor
;
12248 w
->last_cursor_off_p
= w
->cursor_off_p
;
12250 if (w
== XWINDOW (selected_window
))
12251 w
->last_point
= make_number (BUF_PT (b
));
12253 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12259 w
->window_end_valid
= w
->buffer
;
12260 w
->update_mode_line
= Qnil
;
12265 /* Mark the display of windows in the window tree rooted at WINDOW as
12266 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12267 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12268 be redisplayed the next time redisplay_internal is called. */
12271 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12275 for (; !NILP (window
); window
= w
->next
)
12277 w
= XWINDOW (window
);
12278 mark_window_display_accurate_1 (w
, accurate_p
);
12280 if (!NILP (w
->vchild
))
12281 mark_window_display_accurate (w
->vchild
, accurate_p
);
12282 if (!NILP (w
->hchild
))
12283 mark_window_display_accurate (w
->hchild
, accurate_p
);
12288 update_overlay_arrows (1);
12292 /* Force a thorough redisplay the next time by setting
12293 last_arrow_position and last_arrow_string to t, which is
12294 unequal to any useful value of Voverlay_arrow_... */
12295 update_overlay_arrows (-1);
12300 /* Return value in display table DP (Lisp_Char_Table *) for character
12301 C. Since a display table doesn't have any parent, we don't have to
12302 follow parent. Do not call this function directly but use the
12303 macro DISP_CHAR_VECTOR. */
12306 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12310 if (ASCII_CHAR_P (c
))
12313 if (SUB_CHAR_TABLE_P (val
))
12314 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12320 XSETCHAR_TABLE (table
, dp
);
12321 val
= char_table_ref (table
, c
);
12330 /***********************************************************************
12332 ***********************************************************************/
12334 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12337 redisplay_windows (Lisp_Object window
)
12339 while (!NILP (window
))
12341 struct window
*w
= XWINDOW (window
);
12343 if (!NILP (w
->hchild
))
12344 redisplay_windows (w
->hchild
);
12345 else if (!NILP (w
->vchild
))
12346 redisplay_windows (w
->vchild
);
12347 else if (!NILP (w
->buffer
))
12349 displayed_buffer
= XBUFFER (w
->buffer
);
12350 /* Use list_of_error, not Qerror, so that
12351 we catch only errors and don't run the debugger. */
12352 internal_condition_case_1 (redisplay_window_0
, window
,
12354 redisplay_window_error
);
12362 redisplay_window_error (Lisp_Object ignore
)
12364 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12369 redisplay_window_0 (Lisp_Object window
)
12371 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12372 redisplay_window (window
, 0);
12377 redisplay_window_1 (Lisp_Object window
)
12379 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12380 redisplay_window (window
, 1);
12385 /* Increment GLYPH until it reaches END or CONDITION fails while
12386 adding (GLYPH)->pixel_width to X. */
12388 #define SKIP_GLYPHS(glyph, end, x, condition) \
12391 (x) += (glyph)->pixel_width; \
12394 while ((glyph) < (end) && (condition))
12397 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12398 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12399 which positions recorded in ROW differ from current buffer
12402 Return 0 if cursor is not on this row, 1 otherwise. */
12405 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12406 struct glyph_matrix
*matrix
,
12407 EMACS_INT delta
, EMACS_INT delta_bytes
,
12410 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12411 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12412 struct glyph
*cursor
= NULL
;
12413 /* The last known character position in row. */
12414 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12416 EMACS_INT pt_old
= PT
- delta
;
12417 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12418 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12419 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12420 /* A glyph beyond the edge of TEXT_AREA which we should never
12422 struct glyph
*glyphs_end
= end
;
12423 /* Non-zero means we've found a match for cursor position, but that
12424 glyph has the avoid_cursor_p flag set. */
12425 int match_with_avoid_cursor
= 0;
12426 /* Non-zero means we've seen at least one glyph that came from a
12428 int string_seen
= 0;
12429 /* Largest and smalles buffer positions seen so far during scan of
12431 EMACS_INT bpos_max
= pos_before
;
12432 EMACS_INT bpos_min
= pos_after
;
12433 /* Last buffer position covered by an overlay string with an integer
12434 `cursor' property. */
12435 EMACS_INT bpos_covered
= 0;
12437 /* Skip over glyphs not having an object at the start and the end of
12438 the row. These are special glyphs like truncation marks on
12439 terminal frames. */
12440 if (row
->displays_text_p
)
12442 if (!row
->reversed_p
)
12445 && INTEGERP (glyph
->object
)
12446 && glyph
->charpos
< 0)
12448 x
+= glyph
->pixel_width
;
12452 && INTEGERP ((end
- 1)->object
)
12453 /* CHARPOS is zero for blanks and stretch glyphs
12454 inserted by extend_face_to_end_of_line. */
12455 && (end
- 1)->charpos
<= 0)
12457 glyph_before
= glyph
- 1;
12464 /* If the glyph row is reversed, we need to process it from back
12465 to front, so swap the edge pointers. */
12466 glyphs_end
= end
= glyph
- 1;
12467 glyph
+= row
->used
[TEXT_AREA
] - 1;
12469 while (glyph
> end
+ 1
12470 && INTEGERP (glyph
->object
)
12471 && glyph
->charpos
< 0)
12474 x
-= glyph
->pixel_width
;
12476 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12478 /* By default, in reversed rows we put the cursor on the
12479 rightmost (first in the reading order) glyph. */
12480 for (g
= end
+ 1; g
< glyph
; g
++)
12481 x
+= g
->pixel_width
;
12483 && INTEGERP ((end
+ 1)->object
)
12484 && (end
+ 1)->charpos
<= 0)
12486 glyph_before
= glyph
+ 1;
12490 else if (row
->reversed_p
)
12492 /* In R2L rows that don't display text, put the cursor on the
12493 rightmost glyph. Case in point: an empty last line that is
12494 part of an R2L paragraph. */
12496 /* Avoid placing the cursor on the last glyph of the row, where
12497 on terminal frames we hold the vertical border between
12498 adjacent windows. */
12499 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12500 && !WINDOW_RIGHTMOST_P (w
)
12501 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12503 x
= -1; /* will be computed below, at label compute_x */
12506 /* Step 1: Try to find the glyph whose character position
12507 corresponds to point. If that's not possible, find 2 glyphs
12508 whose character positions are the closest to point, one before
12509 point, the other after it. */
12510 if (!row
->reversed_p
)
12511 while (/* not marched to end of glyph row */
12513 /* glyph was not inserted by redisplay for internal purposes */
12514 && !INTEGERP (glyph
->object
))
12516 if (BUFFERP (glyph
->object
))
12518 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12520 if (glyph
->charpos
> bpos_max
)
12521 bpos_max
= glyph
->charpos
;
12522 if (glyph
->charpos
< bpos_min
)
12523 bpos_min
= glyph
->charpos
;
12524 if (!glyph
->avoid_cursor_p
)
12526 /* If we hit point, we've found the glyph on which to
12527 display the cursor. */
12530 match_with_avoid_cursor
= 0;
12533 /* See if we've found a better approximation to
12534 POS_BEFORE or to POS_AFTER. Note that we want the
12535 first (leftmost) glyph of all those that are the
12536 closest from below, and the last (rightmost) of all
12537 those from above. */
12538 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12540 pos_before
= glyph
->charpos
;
12541 glyph_before
= glyph
;
12543 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12545 pos_after
= glyph
->charpos
;
12546 glyph_after
= glyph
;
12549 else if (dpos
== 0)
12550 match_with_avoid_cursor
= 1;
12552 else if (STRINGP (glyph
->object
))
12554 Lisp_Object chprop
;
12555 EMACS_INT glyph_pos
= glyph
->charpos
;
12557 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12559 if (INTEGERP (chprop
))
12561 bpos_covered
= bpos_max
+ XINT (chprop
);
12562 /* If the `cursor' property covers buffer positions up
12563 to and including point, we should display cursor on
12564 this glyph. Note that overlays and text properties
12565 with string values stop bidi reordering, so every
12566 buffer position to the left of the string is always
12567 smaller than any position to the right of the
12568 string. Therefore, if a `cursor' property on one
12569 of the string's characters has an integer value, we
12570 will break out of the loop below _before_ we get to
12571 the position match above. IOW, integer values of
12572 the `cursor' property override the "exact match for
12573 point" strategy of positioning the cursor. */
12574 /* Implementation note: bpos_max == pt_old when, e.g.,
12575 we are in an empty line, where bpos_max is set to
12576 MATRIX_ROW_START_CHARPOS, see above. */
12577 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12586 x
+= glyph
->pixel_width
;
12589 else if (glyph
> end
) /* row is reversed */
12590 while (!INTEGERP (glyph
->object
))
12592 if (BUFFERP (glyph
->object
))
12594 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12596 if (glyph
->charpos
> bpos_max
)
12597 bpos_max
= glyph
->charpos
;
12598 if (glyph
->charpos
< bpos_min
)
12599 bpos_min
= glyph
->charpos
;
12600 if (!glyph
->avoid_cursor_p
)
12604 match_with_avoid_cursor
= 0;
12607 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12609 pos_before
= glyph
->charpos
;
12610 glyph_before
= glyph
;
12612 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12614 pos_after
= glyph
->charpos
;
12615 glyph_after
= glyph
;
12618 else if (dpos
== 0)
12619 match_with_avoid_cursor
= 1;
12621 else if (STRINGP (glyph
->object
))
12623 Lisp_Object chprop
;
12624 EMACS_INT glyph_pos
= glyph
->charpos
;
12626 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12628 if (INTEGERP (chprop
))
12630 bpos_covered
= bpos_max
+ XINT (chprop
);
12631 /* If the `cursor' property covers buffer positions up
12632 to and including point, we should display cursor on
12634 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12643 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12645 x
--; /* can't use any pixel_width */
12648 x
-= glyph
->pixel_width
;
12651 /* Step 2: If we didn't find an exact match for point, we need to
12652 look for a proper place to put the cursor among glyphs between
12653 GLYPH_BEFORE and GLYPH_AFTER. */
12654 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12655 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12656 && bpos_covered
< pt_old
)
12658 /* An empty line has a single glyph whose OBJECT is zero and
12659 whose CHARPOS is the position of a newline on that line.
12660 Note that on a TTY, there are more glyphs after that, which
12661 were produced by extend_face_to_end_of_line, but their
12662 CHARPOS is zero or negative. */
12664 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12665 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12667 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12669 EMACS_INT ellipsis_pos
;
12671 /* Scan back over the ellipsis glyphs. */
12672 if (!row
->reversed_p
)
12674 ellipsis_pos
= (glyph
- 1)->charpos
;
12675 while (glyph
> row
->glyphs
[TEXT_AREA
]
12676 && (glyph
- 1)->charpos
== ellipsis_pos
)
12677 glyph
--, x
-= glyph
->pixel_width
;
12678 /* That loop always goes one position too far, including
12679 the glyph before the ellipsis. So scan forward over
12681 x
+= glyph
->pixel_width
;
12684 else /* row is reversed */
12686 ellipsis_pos
= (glyph
+ 1)->charpos
;
12687 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12688 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12689 glyph
++, x
+= glyph
->pixel_width
;
12690 x
-= glyph
->pixel_width
;
12694 else if (match_with_avoid_cursor
12695 /* A truncated row may not include PT among its
12696 character positions. Setting the cursor inside the
12697 scroll margin will trigger recalculation of hscroll
12698 in hscroll_window_tree. */
12699 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12700 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12701 /* Zero-width characters produce no glyphs. */
12704 && (row
->reversed_p
12705 ? glyph_after
> glyphs_end
12706 : glyph_after
< glyphs_end
)))
12708 cursor
= glyph_after
;
12711 else if (string_seen
)
12713 int incr
= row
->reversed_p
? -1 : +1;
12715 /* Need to find the glyph that came out of a string which is
12716 present at point. That glyph is somewhere between
12717 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12718 positioned between POS_BEFORE and POS_AFTER in the
12720 struct glyph
*stop
= glyph_after
;
12721 EMACS_INT pos
= pos_before
;
12724 for (glyph
= glyph_before
+ incr
;
12725 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12728 /* Any glyphs that come from the buffer are here because
12729 of bidi reordering. Skip them, and only pay
12730 attention to glyphs that came from some string. */
12731 if (STRINGP (glyph
->object
))
12736 str
= glyph
->object
;
12737 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12738 if (tem
== 0 /* from overlay */
12741 /* If the string from which this glyph came is
12742 found in the buffer at point, then we've
12743 found the glyph we've been looking for. If
12744 it comes from an overlay (tem == 0), and it
12745 has the `cursor' property on one of its
12746 glyphs, record that glyph as a candidate for
12747 displaying the cursor. (As in the
12748 unidirectional version, we will display the
12749 cursor on the last candidate we find.) */
12750 if (tem
== 0 || tem
== pt_old
)
12752 /* The glyphs from this string could have
12753 been reordered. Find the one with the
12754 smallest string position. Or there could
12755 be a character in the string with the
12756 `cursor' property, which means display
12757 cursor on that character's glyph. */
12758 EMACS_INT strpos
= glyph
->charpos
;
12763 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12764 && EQ (glyph
->object
, str
);
12768 EMACS_INT gpos
= glyph
->charpos
;
12770 cprop
= Fget_char_property (make_number (gpos
),
12778 if (tem
&& glyph
->charpos
< strpos
)
12780 strpos
= glyph
->charpos
;
12789 pos
= tem
+ 1; /* don't find previous instances */
12791 /* This string is not what we want; skip all of the
12792 glyphs that came from it. */
12793 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12794 && EQ (glyph
->object
, str
))
12801 /* If we reached the end of the line, and END was from a string,
12802 the cursor is not on this line. */
12804 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12805 && STRINGP (end
->object
)
12806 && row
->continued_p
)
12812 if (cursor
!= NULL
)
12818 /* Need to compute x that corresponds to GLYPH. */
12819 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12821 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12823 x
+= g
->pixel_width
;
12827 /* ROW could be part of a continued line, which, under bidi
12828 reordering, might have other rows whose start and end charpos
12829 occlude point. Only set w->cursor if we found a better
12830 approximation to the cursor position than we have from previously
12831 examined candidate rows belonging to the same continued line. */
12832 if (/* we already have a candidate row */
12833 w
->cursor
.vpos
>= 0
12834 /* that candidate is not the row we are processing */
12835 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12836 /* the row we are processing is part of a continued line */
12837 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12838 /* Make sure cursor.vpos specifies a row whose start and end
12839 charpos occlude point. This is because some callers of this
12840 function leave cursor.vpos at the row where the cursor was
12841 displayed during the last redisplay cycle. */
12842 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12843 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12846 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12848 /* Don't consider glyphs that are outside TEXT_AREA. */
12849 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12851 /* Keep the candidate whose buffer position is the closest to
12853 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12854 w
->cursor
.hpos
>= 0
12855 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12856 && BUFFERP (g1
->object
)
12857 && (g1
->charpos
== pt_old
/* an exact match always wins */
12858 || (BUFFERP (glyph
->object
)
12859 && eabs (g1
->charpos
- pt_old
)
12860 < eabs (glyph
->charpos
- pt_old
))))
12862 /* If this candidate gives an exact match, use that. */
12863 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12864 /* Otherwise, keep the candidate that comes from a row
12865 spanning less buffer positions. This may win when one or
12866 both candidate positions are on glyphs that came from
12867 display strings, for which we cannot compare buffer
12869 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12870 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12871 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12874 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12876 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12877 w
->cursor
.y
= row
->y
+ dy
;
12879 if (w
== XWINDOW (selected_window
))
12881 if (!row
->continued_p
12882 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12885 this_line_buffer
= XBUFFER (w
->buffer
);
12887 CHARPOS (this_line_start_pos
)
12888 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12889 BYTEPOS (this_line_start_pos
)
12890 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12892 CHARPOS (this_line_end_pos
)
12893 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12894 BYTEPOS (this_line_end_pos
)
12895 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12897 this_line_y
= w
->cursor
.y
;
12898 this_line_pixel_height
= row
->height
;
12899 this_line_vpos
= w
->cursor
.vpos
;
12900 this_line_start_x
= row
->x
;
12903 CHARPOS (this_line_start_pos
) = 0;
12910 /* Run window scroll functions, if any, for WINDOW with new window
12911 start STARTP. Sets the window start of WINDOW to that position.
12913 We assume that the window's buffer is really current. */
12915 static INLINE
struct text_pos
12916 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12918 struct window
*w
= XWINDOW (window
);
12919 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12921 if (current_buffer
!= XBUFFER (w
->buffer
))
12924 if (!NILP (Vwindow_scroll_functions
))
12926 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12927 make_number (CHARPOS (startp
)));
12928 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12929 /* In case the hook functions switch buffers. */
12930 if (current_buffer
!= XBUFFER (w
->buffer
))
12931 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12938 /* Make sure the line containing the cursor is fully visible.
12939 A value of 1 means there is nothing to be done.
12940 (Either the line is fully visible, or it cannot be made so,
12941 or we cannot tell.)
12943 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12944 is higher than window.
12946 A value of 0 means the caller should do scrolling
12947 as if point had gone off the screen. */
12950 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12952 struct glyph_matrix
*matrix
;
12953 struct glyph_row
*row
;
12956 if (!make_cursor_line_fully_visible_p
)
12959 /* It's not always possible to find the cursor, e.g, when a window
12960 is full of overlay strings. Don't do anything in that case. */
12961 if (w
->cursor
.vpos
< 0)
12964 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12965 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12967 /* If the cursor row is not partially visible, there's nothing to do. */
12968 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12971 /* If the row the cursor is in is taller than the window's height,
12972 it's not clear what to do, so do nothing. */
12973 window_height
= window_box_height (w
);
12974 if (row
->height
>= window_height
)
12976 if (!force_p
|| MINI_WINDOW_P (w
)
12977 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12984 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12985 non-zero means only WINDOW is redisplayed in redisplay_internal.
12986 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12987 in redisplay_window to bring a partially visible line into view in
12988 the case that only the cursor has moved.
12990 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12991 last screen line's vertical height extends past the end of the screen.
12995 1 if scrolling succeeded
12997 0 if scrolling didn't find point.
12999 -1 if new fonts have been loaded so that we must interrupt
13000 redisplay, adjust glyph matrices, and try again. */
13006 SCROLLING_NEED_LARGER_MATRICES
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 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13025 debug_method_add (w
, "try_scrolling");
13028 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13030 /* Compute scroll margin height in pixels. We scroll when point is
13031 within this distance from the top or bottom of the window. */
13032 if (scroll_margin
> 0)
13033 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13034 * FRAME_LINE_HEIGHT (f
);
13036 this_scroll_margin
= 0;
13038 /* Force arg_scroll_conservatively to have a reasonable value, to avoid
13039 overflow while computing how much to scroll. Note that the user
13040 can supply scroll-conservatively equal to `most-positive-fixnum',
13041 which can be larger than INT_MAX. */
13042 if (arg_scroll_conservatively
> scroll_limit
)
13044 arg_scroll_conservatively
= scroll_limit
;
13045 scroll_max
= INT_MAX
;
13047 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13048 /* Compute how much we should try to scroll maximally to bring
13049 point into view. */
13050 scroll_max
= (max (scroll_step
,
13051 max (arg_scroll_conservatively
, temp_scroll_step
))
13052 * FRAME_LINE_HEIGHT (f
));
13053 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13054 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13055 /* We're trying to scroll because of aggressive scrolling but no
13056 scroll_step is set. Choose an arbitrary one. */
13057 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13063 /* Decide whether to scroll down. */
13064 if (PT
> CHARPOS (startp
))
13066 int scroll_margin_y
;
13068 /* Compute the pixel ypos of the scroll margin, then move it to
13069 either that ypos or PT, whichever comes first. */
13070 start_display (&it
, w
, startp
);
13071 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13072 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13073 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13074 (MOVE_TO_POS
| MOVE_TO_Y
));
13076 if (PT
> CHARPOS (it
.current
.pos
))
13078 int y0
= line_bottom_y (&it
);
13079 /* Compute how many pixels below window bottom to stop searching
13080 for PT. This avoids costly search for PT that is far away if
13081 the user limited scrolling by a small number of lines, but
13082 always finds PT if arg_scroll_conservatively is set to a large
13083 number, such as most-positive-fixnum. */
13084 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13086 slack
>= INT_MAX
- it
.last_visible_y
13088 : it
.last_visible_y
+ slack
;
13090 /* Compute the distance from the scroll margin to PT or to
13091 the scroll limit, whichever comes first. This should
13092 include the height of the cursor line, to make that line
13094 move_it_to (&it
, PT
, -1, y_to_move
,
13095 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13096 dy
= line_bottom_y (&it
) - y0
;
13098 if (dy
> scroll_max
)
13099 return SCROLLING_FAILED
;
13107 /* Point is in or below the bottom scroll margin, so move the
13108 window start down. If scrolling conservatively, move it just
13109 enough down to make point visible. If scroll_step is set,
13110 move it down by scroll_step. */
13111 if (arg_scroll_conservatively
)
13113 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13114 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13115 else if (scroll_step
|| temp_scroll_step
)
13116 amount_to_scroll
= scroll_max
;
13119 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13120 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13121 if (NUMBERP (aggressive
))
13123 double float_amount
= XFLOATINT (aggressive
) * height
;
13124 amount_to_scroll
= float_amount
;
13125 if (amount_to_scroll
== 0 && float_amount
> 0)
13126 amount_to_scroll
= 1;
13130 if (amount_to_scroll
<= 0)
13131 return SCROLLING_FAILED
;
13133 start_display (&it
, w
, startp
);
13134 if (scroll_max
< INT_MAX
)
13135 move_it_vertically (&it
, amount_to_scroll
);
13138 /* Extra precision for users who set scroll-conservatively
13139 to most-positive-fixnum: make sure the amount we scroll
13140 the window start is never less than amount_to_scroll,
13141 which was computed as distance from window bottom to
13142 point. This matters when lines at window top and lines
13143 below window bottom have different height. */
13144 struct it it1
= it
;
13145 /* We use a temporary it1 because line_bottom_y can modify
13146 its argument, if it moves one line down; see there. */
13147 int start_y
= line_bottom_y (&it1
);
13150 move_it_by_lines (&it
, 1, 1);
13152 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13155 /* If STARTP is unchanged, move it down another screen line. */
13156 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13157 move_it_by_lines (&it
, 1, 1);
13158 startp
= it
.current
.pos
;
13162 struct text_pos scroll_margin_pos
= startp
;
13164 /* See if point is inside the scroll margin at the top of the
13166 if (this_scroll_margin
)
13168 start_display (&it
, w
, startp
);
13169 move_it_vertically (&it
, this_scroll_margin
);
13170 scroll_margin_pos
= it
.current
.pos
;
13173 if (PT
< CHARPOS (scroll_margin_pos
))
13175 /* Point is in the scroll margin at the top of the window or
13176 above what is displayed in the window. */
13179 /* Compute the vertical distance from PT to the scroll
13180 margin position. Give up if distance is greater than
13182 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13183 start_display (&it
, w
, pos
);
13185 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13186 it
.last_visible_y
, -1,
13187 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13188 dy
= it
.current_y
- y0
;
13189 if (dy
> scroll_max
)
13190 return SCROLLING_FAILED
;
13192 /* Compute new window start. */
13193 start_display (&it
, w
, startp
);
13195 if (arg_scroll_conservatively
)
13197 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13198 else if (scroll_step
|| temp_scroll_step
)
13199 amount_to_scroll
= scroll_max
;
13202 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13203 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13204 if (NUMBERP (aggressive
))
13206 double float_amount
= XFLOATINT (aggressive
) * height
;
13207 amount_to_scroll
= float_amount
;
13208 if (amount_to_scroll
== 0 && float_amount
> 0)
13209 amount_to_scroll
= 1;
13213 if (amount_to_scroll
<= 0)
13214 return SCROLLING_FAILED
;
13216 move_it_vertically_backward (&it
, amount_to_scroll
);
13217 startp
= it
.current
.pos
;
13221 /* Run window scroll functions. */
13222 startp
= run_window_scroll_functions (window
, startp
);
13224 /* Display the window. Give up if new fonts are loaded, or if point
13226 if (!try_window (window
, startp
, 0))
13227 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13228 else if (w
->cursor
.vpos
< 0)
13230 clear_glyph_matrix (w
->desired_matrix
);
13231 rc
= SCROLLING_FAILED
;
13235 /* Maybe forget recorded base line for line number display. */
13236 if (!just_this_one_p
13237 || current_buffer
->clip_changed
13238 || BEG_UNCHANGED
< CHARPOS (startp
))
13239 w
->base_line_number
= Qnil
;
13241 /* If cursor ends up on a partially visible line,
13242 treat that as being off the bottom of the screen. */
13243 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13244 /* It's possible that the cursor is on the first line of the
13245 buffer, which is partially obscured due to a vscroll
13246 (Bug#7537). In that case, avoid looping forever . */
13247 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13249 clear_glyph_matrix (w
->desired_matrix
);
13250 ++extra_scroll_margin_lines
;
13253 rc
= SCROLLING_SUCCESS
;
13260 /* Compute a suitable window start for window W if display of W starts
13261 on a continuation line. Value is non-zero if a new window start
13264 The new window start will be computed, based on W's width, starting
13265 from the start of the continued line. It is the start of the
13266 screen line with the minimum distance from the old start W->start. */
13269 compute_window_start_on_continuation_line (struct window
*w
)
13271 struct text_pos pos
, start_pos
;
13272 int window_start_changed_p
= 0;
13274 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13276 /* If window start is on a continuation line... Window start may be
13277 < BEGV in case there's invisible text at the start of the
13278 buffer (M-x rmail, for example). */
13279 if (CHARPOS (start_pos
) > BEGV
13280 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13283 struct glyph_row
*row
;
13285 /* Handle the case that the window start is out of range. */
13286 if (CHARPOS (start_pos
) < BEGV
)
13287 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13288 else if (CHARPOS (start_pos
) > ZV
)
13289 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13291 /* Find the start of the continued line. This should be fast
13292 because scan_buffer is fast (newline cache). */
13293 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13294 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13295 row
, DEFAULT_FACE_ID
);
13296 reseat_at_previous_visible_line_start (&it
);
13298 /* If the line start is "too far" away from the window start,
13299 say it takes too much time to compute a new window start. */
13300 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13301 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13303 int min_distance
, distance
;
13305 /* Move forward by display lines to find the new window
13306 start. If window width was enlarged, the new start can
13307 be expected to be > the old start. If window width was
13308 decreased, the new window start will be < the old start.
13309 So, we're looking for the display line start with the
13310 minimum distance from the old window start. */
13311 pos
= it
.current
.pos
;
13312 min_distance
= INFINITY
;
13313 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13314 distance
< min_distance
)
13316 min_distance
= distance
;
13317 pos
= it
.current
.pos
;
13318 move_it_by_lines (&it
, 1, 0);
13321 /* Set the window start there. */
13322 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13323 window_start_changed_p
= 1;
13327 return window_start_changed_p
;
13331 /* Try cursor movement in case text has not changed in window WINDOW,
13332 with window start STARTP. Value is
13334 CURSOR_MOVEMENT_SUCCESS if successful
13336 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13338 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13339 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13340 we want to scroll as if scroll-step were set to 1. See the code.
13342 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13343 which case we have to abort this redisplay, and adjust matrices
13348 CURSOR_MOVEMENT_SUCCESS
,
13349 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13350 CURSOR_MOVEMENT_MUST_SCROLL
,
13351 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13355 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13357 struct window
*w
= XWINDOW (window
);
13358 struct frame
*f
= XFRAME (w
->frame
);
13359 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13362 if (inhibit_try_cursor_movement
)
13366 /* Handle case where text has not changed, only point, and it has
13367 not moved off the frame. */
13368 if (/* Point may be in this window. */
13369 PT
>= CHARPOS (startp
)
13370 /* Selective display hasn't changed. */
13371 && !current_buffer
->clip_changed
13372 /* Function force-mode-line-update is used to force a thorough
13373 redisplay. It sets either windows_or_buffers_changed or
13374 update_mode_lines. So don't take a shortcut here for these
13376 && !update_mode_lines
13377 && !windows_or_buffers_changed
13378 && !cursor_type_changed
13379 /* Can't use this case if highlighting a region. When a
13380 region exists, cursor movement has to do more than just
13382 && !(!NILP (Vtransient_mark_mode
)
13383 && !NILP (BVAR (current_buffer
, mark_active
)))
13384 && NILP (w
->region_showing
)
13385 && NILP (Vshow_trailing_whitespace
)
13386 /* Right after splitting windows, last_point may be nil. */
13387 && INTEGERP (w
->last_point
)
13388 /* This code is not used for mini-buffer for the sake of the case
13389 of redisplaying to replace an echo area message; since in
13390 that case the mini-buffer contents per se are usually
13391 unchanged. This code is of no real use in the mini-buffer
13392 since the handling of this_line_start_pos, etc., in redisplay
13393 handles the same cases. */
13394 && !EQ (window
, minibuf_window
)
13395 /* When splitting windows or for new windows, it happens that
13396 redisplay is called with a nil window_end_vpos or one being
13397 larger than the window. This should really be fixed in
13398 window.c. I don't have this on my list, now, so we do
13399 approximately the same as the old redisplay code. --gerd. */
13400 && INTEGERP (w
->window_end_vpos
)
13401 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13402 && (FRAME_WINDOW_P (f
)
13403 || !overlay_arrow_in_current_buffer_p ()))
13405 int this_scroll_margin
, top_scroll_margin
;
13406 struct glyph_row
*row
= NULL
;
13409 debug_method_add (w
, "cursor movement");
13412 /* Scroll if point within this distance from the top or bottom
13413 of the window. This is a pixel value. */
13414 if (scroll_margin
> 0)
13416 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13417 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13420 this_scroll_margin
= 0;
13422 top_scroll_margin
= this_scroll_margin
;
13423 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13424 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13426 /* Start with the row the cursor was displayed during the last
13427 not paused redisplay. Give up if that row is not valid. */
13428 if (w
->last_cursor
.vpos
< 0
13429 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13430 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13433 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13434 if (row
->mode_line_p
)
13436 if (!row
->enabled_p
)
13437 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13440 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13442 int scroll_p
= 0, must_scroll
= 0;
13443 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13445 if (PT
> XFASTINT (w
->last_point
))
13447 /* Point has moved forward. */
13448 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13449 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13451 xassert (row
->enabled_p
);
13455 /* If the end position of a row equals the start
13456 position of the next row, and PT is at that position,
13457 we would rather display cursor in the next line. */
13458 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13459 && MATRIX_ROW_END_CHARPOS (row
) == PT
13460 && row
< w
->current_matrix
->rows
13461 + w
->current_matrix
->nrows
- 1
13462 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13463 && !cursor_row_p (w
, row
))
13466 /* If within the scroll margin, scroll. Note that
13467 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13468 the next line would be drawn, and that
13469 this_scroll_margin can be zero. */
13470 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13471 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13472 /* Line is completely visible last line in window
13473 and PT is to be set in the next line. */
13474 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13475 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13476 && !row
->ends_at_zv_p
13477 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13480 else if (PT
< XFASTINT (w
->last_point
))
13482 /* Cursor has to be moved backward. Note that PT >=
13483 CHARPOS (startp) because of the outer if-statement. */
13484 while (!row
->mode_line_p
13485 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13486 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13487 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13488 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13489 row
> w
->current_matrix
->rows
13490 && (row
-1)->ends_in_newline_from_string_p
))))
13491 && (row
->y
> top_scroll_margin
13492 || CHARPOS (startp
) == BEGV
))
13494 xassert (row
->enabled_p
);
13498 /* Consider the following case: Window starts at BEGV,
13499 there is invisible, intangible text at BEGV, so that
13500 display starts at some point START > BEGV. It can
13501 happen that we are called with PT somewhere between
13502 BEGV and START. Try to handle that case. */
13503 if (row
< w
->current_matrix
->rows
13504 || row
->mode_line_p
)
13506 row
= w
->current_matrix
->rows
;
13507 if (row
->mode_line_p
)
13511 /* Due to newlines in overlay strings, we may have to
13512 skip forward over overlay strings. */
13513 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13514 && MATRIX_ROW_END_CHARPOS (row
) == PT
13515 && !cursor_row_p (w
, row
))
13518 /* If within the scroll margin, scroll. */
13519 if (row
->y
< top_scroll_margin
13520 && CHARPOS (startp
) != BEGV
)
13525 /* Cursor did not move. So don't scroll even if cursor line
13526 is partially visible, as it was so before. */
13527 rc
= CURSOR_MOVEMENT_SUCCESS
;
13530 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13531 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13533 /* if PT is not in the glyph row, give up. */
13534 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13537 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13538 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13540 /* If rows are bidi-reordered and point moved, back up
13541 until we find a row that does not belong to a
13542 continuation line. This is because we must consider
13543 all rows of a continued line as candidates for the
13544 new cursor positioning, since row start and end
13545 positions change non-linearly with vertical position
13547 /* FIXME: Revisit this when glyph ``spilling'' in
13548 continuation lines' rows is implemented for
13549 bidi-reordered rows. */
13550 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13552 xassert (row
->enabled_p
);
13554 /* If we hit the beginning of the displayed portion
13555 without finding the first row of a continued
13557 if (row
<= w
->current_matrix
->rows
)
13559 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13567 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13568 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13569 && make_cursor_line_fully_visible_p
)
13571 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13572 && !row
->ends_at_zv_p
13573 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13574 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13575 else if (row
->height
> window_box_height (w
))
13577 /* If we end up in a partially visible line, let's
13578 make it fully visible, except when it's taller
13579 than the window, in which case we can't do much
13582 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13586 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13587 if (!cursor_row_fully_visible_p (w
, 0, 1))
13588 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13590 rc
= CURSOR_MOVEMENT_SUCCESS
;
13594 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13595 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13596 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13598 /* With bidi-reordered rows, there could be more than
13599 one candidate row whose start and end positions
13600 occlude point. We need to let set_cursor_from_row
13601 find the best candidate. */
13602 /* FIXME: Revisit this when glyph ``spilling'' in
13603 continuation lines' rows is implemented for
13604 bidi-reordered rows. */
13609 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13610 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13611 && cursor_row_p (w
, row
))
13612 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13614 /* As soon as we've found the first suitable row
13615 whose ends_at_zv_p flag is set, we are done. */
13617 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13619 rc
= CURSOR_MOVEMENT_SUCCESS
;
13624 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13625 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13626 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13627 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13628 /* If we didn't find any candidate rows, or exited the
13629 loop before all the candidates were examined, signal
13630 to the caller that this method failed. */
13631 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13632 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13633 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13635 rc
= CURSOR_MOVEMENT_SUCCESS
;
13641 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13643 rc
= CURSOR_MOVEMENT_SUCCESS
;
13648 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13649 && MATRIX_ROW_START_CHARPOS (row
) == PT
13650 && cursor_row_p (w
, row
));
13659 set_vertical_scroll_bar (struct window
*w
)
13661 EMACS_INT start
, end
, whole
;
13663 /* Calculate the start and end positions for the current window.
13664 At some point, it would be nice to choose between scrollbars
13665 which reflect the whole buffer size, with special markers
13666 indicating narrowing, and scrollbars which reflect only the
13669 Note that mini-buffers sometimes aren't displaying any text. */
13670 if (!MINI_WINDOW_P (w
)
13671 || (w
== XWINDOW (minibuf_window
)
13672 && NILP (echo_area_buffer
[0])))
13674 struct buffer
*buf
= XBUFFER (w
->buffer
);
13675 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13676 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13677 /* I don't think this is guaranteed to be right. For the
13678 moment, we'll pretend it is. */
13679 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13683 if (whole
< (end
- start
))
13684 whole
= end
- start
;
13687 start
= end
= whole
= 0;
13689 /* Indicate what this scroll bar ought to be displaying now. */
13690 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13691 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13692 (w
, end
- start
, whole
, start
);
13696 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13697 selected_window is redisplayed.
13699 We can return without actually redisplaying the window if
13700 fonts_changed_p is nonzero. In that case, redisplay_internal will
13704 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13706 struct window
*w
= XWINDOW (window
);
13707 struct frame
*f
= XFRAME (w
->frame
);
13708 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13709 struct buffer
*old
= current_buffer
;
13710 struct text_pos lpoint
, opoint
, startp
;
13711 int update_mode_line
;
13714 /* Record it now because it's overwritten. */
13715 int current_matrix_up_to_date_p
= 0;
13716 int used_current_matrix_p
= 0;
13717 /* This is less strict than current_matrix_up_to_date_p.
13718 It indictes that the buffer contents and narrowing are unchanged. */
13719 int buffer_unchanged_p
= 0;
13720 int temp_scroll_step
= 0;
13721 int count
= SPECPDL_INDEX ();
13722 int centering_position
= -1;
13723 int last_line_misfit
= 0;
13724 EMACS_INT beg_unchanged
, end_unchanged
;
13726 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13729 /* W must be a leaf window here. */
13730 xassert (!NILP (w
->buffer
));
13732 *w
->desired_matrix
->method
= 0;
13736 reconsider_clip_changes (w
, buffer
);
13738 /* Has the mode line to be updated? */
13739 update_mode_line
= (!NILP (w
->update_mode_line
)
13740 || update_mode_lines
13741 || buffer
->clip_changed
13742 || buffer
->prevent_redisplay_optimizations_p
);
13744 if (MINI_WINDOW_P (w
))
13746 if (w
== XWINDOW (echo_area_window
)
13747 && !NILP (echo_area_buffer
[0]))
13749 if (update_mode_line
)
13750 /* We may have to update a tty frame's menu bar or a
13751 tool-bar. Example `M-x C-h C-h C-g'. */
13752 goto finish_menu_bars
;
13754 /* We've already displayed the echo area glyphs in this window. */
13755 goto finish_scroll_bars
;
13757 else if ((w
!= XWINDOW (minibuf_window
)
13758 || minibuf_level
== 0)
13759 /* When buffer is nonempty, redisplay window normally. */
13760 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13761 /* Quail displays non-mini buffers in minibuffer window.
13762 In that case, redisplay the window normally. */
13763 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13765 /* W is a mini-buffer window, but it's not active, so clear
13767 int yb
= window_text_bottom_y (w
);
13768 struct glyph_row
*row
;
13771 for (y
= 0, row
= w
->desired_matrix
->rows
;
13773 y
+= row
->height
, ++row
)
13774 blank_row (w
, row
, y
);
13775 goto finish_scroll_bars
;
13778 clear_glyph_matrix (w
->desired_matrix
);
13781 /* Otherwise set up data on this window; select its buffer and point
13783 /* Really select the buffer, for the sake of buffer-local
13785 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13787 current_matrix_up_to_date_p
13788 = (!NILP (w
->window_end_valid
)
13789 && !current_buffer
->clip_changed
13790 && !current_buffer
->prevent_redisplay_optimizations_p
13791 && XFASTINT (w
->last_modified
) >= MODIFF
13792 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13794 /* Run the window-bottom-change-functions
13795 if it is possible that the text on the screen has changed
13796 (either due to modification of the text, or any other reason). */
13797 if (!current_matrix_up_to_date_p
13798 && !NILP (Vwindow_text_change_functions
))
13800 safe_run_hooks (Qwindow_text_change_functions
);
13804 beg_unchanged
= BEG_UNCHANGED
;
13805 end_unchanged
= END_UNCHANGED
;
13807 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13809 specbind (Qinhibit_point_motion_hooks
, Qt
);
13812 = (!NILP (w
->window_end_valid
)
13813 && !current_buffer
->clip_changed
13814 && XFASTINT (w
->last_modified
) >= MODIFF
13815 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13817 /* When windows_or_buffers_changed is non-zero, we can't rely on
13818 the window end being valid, so set it to nil there. */
13819 if (windows_or_buffers_changed
)
13821 /* If window starts on a continuation line, maybe adjust the
13822 window start in case the window's width changed. */
13823 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13824 compute_window_start_on_continuation_line (w
);
13826 w
->window_end_valid
= Qnil
;
13829 /* Some sanity checks. */
13830 CHECK_WINDOW_END (w
);
13831 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13833 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13836 /* If %c is in mode line, update it if needed. */
13837 if (!NILP (w
->column_number_displayed
)
13838 /* This alternative quickly identifies a common case
13839 where no change is needed. */
13840 && !(PT
== XFASTINT (w
->last_point
)
13841 && XFASTINT (w
->last_modified
) >= MODIFF
13842 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13843 && (XFASTINT (w
->column_number_displayed
)
13844 != (int) current_column ())) /* iftc */
13845 update_mode_line
= 1;
13847 /* Count number of windows showing the selected buffer. An indirect
13848 buffer counts as its base buffer. */
13849 if (!just_this_one_p
)
13851 struct buffer
*current_base
, *window_base
;
13852 current_base
= current_buffer
;
13853 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13854 if (current_base
->base_buffer
)
13855 current_base
= current_base
->base_buffer
;
13856 if (window_base
->base_buffer
)
13857 window_base
= window_base
->base_buffer
;
13858 if (current_base
== window_base
)
13862 /* Point refers normally to the selected window. For any other
13863 window, set up appropriate value. */
13864 if (!EQ (window
, selected_window
))
13866 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13867 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13871 new_pt_byte
= BEGV_BYTE
;
13872 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13874 else if (new_pt
> (ZV
- 1))
13877 new_pt_byte
= ZV_BYTE
;
13878 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13881 /* We don't use SET_PT so that the point-motion hooks don't run. */
13882 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13885 /* If any of the character widths specified in the display table
13886 have changed, invalidate the width run cache. It's true that
13887 this may be a bit late to catch such changes, but the rest of
13888 redisplay goes (non-fatally) haywire when the display table is
13889 changed, so why should we worry about doing any better? */
13890 if (current_buffer
->width_run_cache
)
13892 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13894 if (! disptab_matches_widthtab (disptab
,
13895 XVECTOR (BVAR (current_buffer
, width_table
))))
13897 invalidate_region_cache (current_buffer
,
13898 current_buffer
->width_run_cache
,
13900 recompute_width_table (current_buffer
, disptab
);
13904 /* If window-start is screwed up, choose a new one. */
13905 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13908 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13910 /* If someone specified a new starting point but did not insist,
13911 check whether it can be used. */
13912 if (!NILP (w
->optional_new_start
)
13913 && CHARPOS (startp
) >= BEGV
13914 && CHARPOS (startp
) <= ZV
)
13916 w
->optional_new_start
= Qnil
;
13917 start_display (&it
, w
, startp
);
13918 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13919 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13920 if (IT_CHARPOS (it
) == PT
)
13921 w
->force_start
= Qt
;
13922 /* IT may overshoot PT if text at PT is invisible. */
13923 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13924 w
->force_start
= Qt
;
13929 /* Handle case where place to start displaying has been specified,
13930 unless the specified location is outside the accessible range. */
13931 if (!NILP (w
->force_start
)
13932 || w
->frozen_window_start_p
)
13934 /* We set this later on if we have to adjust point. */
13937 w
->force_start
= Qnil
;
13939 w
->window_end_valid
= Qnil
;
13941 /* Forget any recorded base line for line number display. */
13942 if (!buffer_unchanged_p
)
13943 w
->base_line_number
= Qnil
;
13945 /* Redisplay the mode line. Select the buffer properly for that.
13946 Also, run the hook window-scroll-functions
13947 because we have scrolled. */
13948 /* Note, we do this after clearing force_start because
13949 if there's an error, it is better to forget about force_start
13950 than to get into an infinite loop calling the hook functions
13951 and having them get more errors. */
13952 if (!update_mode_line
13953 || ! NILP (Vwindow_scroll_functions
))
13955 update_mode_line
= 1;
13956 w
->update_mode_line
= Qt
;
13957 startp
= run_window_scroll_functions (window
, startp
);
13960 w
->last_modified
= make_number (0);
13961 w
->last_overlay_modified
= make_number (0);
13962 if (CHARPOS (startp
) < BEGV
)
13963 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13964 else if (CHARPOS (startp
) > ZV
)
13965 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13967 /* Redisplay, then check if cursor has been set during the
13968 redisplay. Give up if new fonts were loaded. */
13969 /* We used to issue a CHECK_MARGINS argument to try_window here,
13970 but this causes scrolling to fail when point begins inside
13971 the scroll margin (bug#148) -- cyd */
13972 if (!try_window (window
, startp
, 0))
13974 w
->force_start
= Qt
;
13975 clear_glyph_matrix (w
->desired_matrix
);
13976 goto need_larger_matrices
;
13979 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13981 /* If point does not appear, try to move point so it does
13982 appear. The desired matrix has been built above, so we
13983 can use it here. */
13984 new_vpos
= window_box_height (w
) / 2;
13987 if (!cursor_row_fully_visible_p (w
, 0, 0))
13989 /* Point does appear, but on a line partly visible at end of window.
13990 Move it back to a fully-visible line. */
13991 new_vpos
= window_box_height (w
);
13994 /* If we need to move point for either of the above reasons,
13995 now actually do it. */
13998 struct glyph_row
*row
;
14000 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14001 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14004 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14005 MATRIX_ROW_START_BYTEPOS (row
));
14007 if (w
!= XWINDOW (selected_window
))
14008 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14009 else if (current_buffer
== old
)
14010 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14012 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14014 /* If we are highlighting the region, then we just changed
14015 the region, so redisplay to show it. */
14016 if (!NILP (Vtransient_mark_mode
)
14017 && !NILP (BVAR (current_buffer
, mark_active
)))
14019 clear_glyph_matrix (w
->desired_matrix
);
14020 if (!try_window (window
, startp
, 0))
14021 goto need_larger_matrices
;
14026 debug_method_add (w
, "forced window start");
14031 /* Handle case where text has not changed, only point, and it has
14032 not moved off the frame, and we are not retrying after hscroll.
14033 (current_matrix_up_to_date_p is nonzero when retrying.) */
14034 if (current_matrix_up_to_date_p
)
14036 int rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
);
14040 case CURSOR_MOVEMENT_CANNOT_BE_USED
:
14043 case CURSOR_MOVEMENT_SUCCESS
:
14044 used_current_matrix_p
= 1;
14047 case CURSOR_MOVEMENT_MUST_SCROLL
:
14048 goto try_to_scroll
;
14054 /* If current starting point was originally the beginning of a line
14055 but no longer is, find a new starting point. */
14056 else if (!NILP (w
->start_at_line_beg
)
14057 && !(CHARPOS (startp
) <= BEGV
14058 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14061 debug_method_add (w
, "recenter 1");
14066 /* Try scrolling with try_window_id. Value is > 0 if update has
14067 been done, it is -1 if we know that the same window start will
14068 not work. It is 0 if unsuccessful for some other reason. */
14069 else if ((tem
= try_window_id (w
)) != 0)
14072 debug_method_add (w
, "try_window_id %d", tem
);
14075 if (fonts_changed_p
)
14076 goto need_larger_matrices
;
14080 /* Otherwise try_window_id has returned -1 which means that we
14081 don't want the alternative below this comment to execute. */
14083 else if (CHARPOS (startp
) >= BEGV
14084 && CHARPOS (startp
) <= ZV
14085 && PT
>= CHARPOS (startp
)
14086 && (CHARPOS (startp
) < ZV
14087 /* Avoid starting at end of buffer. */
14088 || CHARPOS (startp
) == BEGV
14089 || (XFASTINT (w
->last_modified
) >= MODIFF
14090 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14093 /* If first window line is a continuation line, and window start
14094 is inside the modified region, but the first change is before
14095 current window start, we must select a new window start.
14097 However, if this is the result of a down-mouse event (e.g. by
14098 extending the mouse-drag-overlay), we don't want to select a
14099 new window start, since that would change the position under
14100 the mouse, resulting in an unwanted mouse-movement rather
14101 than a simple mouse-click. */
14102 if (NILP (w
->start_at_line_beg
)
14103 && NILP (do_mouse_tracking
)
14104 && CHARPOS (startp
) > BEGV
14105 && CHARPOS (startp
) > BEG
+ beg_unchanged
14106 && CHARPOS (startp
) <= Z
- end_unchanged
14107 /* Even if w->start_at_line_beg is nil, a new window may
14108 start at a line_beg, since that's how set_buffer_window
14109 sets it. So, we need to check the return value of
14110 compute_window_start_on_continuation_line. (See also
14112 && XMARKER (w
->start
)->buffer
== current_buffer
14113 && compute_window_start_on_continuation_line (w
))
14115 w
->force_start
= Qt
;
14116 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14121 debug_method_add (w
, "same window start");
14124 /* Try to redisplay starting at same place as before.
14125 If point has not moved off frame, accept the results. */
14126 if (!current_matrix_up_to_date_p
14127 /* Don't use try_window_reusing_current_matrix in this case
14128 because a window scroll function can have changed the
14130 || !NILP (Vwindow_scroll_functions
)
14131 || MINI_WINDOW_P (w
)
14132 || !(used_current_matrix_p
14133 = try_window_reusing_current_matrix (w
)))
14135 IF_DEBUG (debug_method_add (w
, "1"));
14136 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14137 /* -1 means we need to scroll.
14138 0 means we need new matrices, but fonts_changed_p
14139 is set in that case, so we will detect it below. */
14140 goto try_to_scroll
;
14143 if (fonts_changed_p
)
14144 goto need_larger_matrices
;
14146 if (w
->cursor
.vpos
>= 0)
14148 if (!just_this_one_p
14149 || current_buffer
->clip_changed
14150 || BEG_UNCHANGED
< CHARPOS (startp
))
14151 /* Forget any recorded base line for line number display. */
14152 w
->base_line_number
= Qnil
;
14154 if (!cursor_row_fully_visible_p (w
, 1, 0))
14156 clear_glyph_matrix (w
->desired_matrix
);
14157 last_line_misfit
= 1;
14159 /* Drop through and scroll. */
14164 clear_glyph_matrix (w
->desired_matrix
);
14169 w
->last_modified
= make_number (0);
14170 w
->last_overlay_modified
= make_number (0);
14172 /* Redisplay the mode line. Select the buffer properly for that. */
14173 if (!update_mode_line
)
14175 update_mode_line
= 1;
14176 w
->update_mode_line
= Qt
;
14179 /* Try to scroll by specified few lines. */
14180 if ((scroll_conservatively
14181 || emacs_scroll_step
14182 || temp_scroll_step
14183 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14184 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14185 && !current_buffer
->clip_changed
14186 && CHARPOS (startp
) >= BEGV
14187 && CHARPOS (startp
) <= ZV
)
14189 /* The function returns -1 if new fonts were loaded, 1 if
14190 successful, 0 if not successful. */
14191 int rc
= try_scrolling (window
, just_this_one_p
,
14192 scroll_conservatively
,
14194 temp_scroll_step
, last_line_misfit
);
14197 case SCROLLING_SUCCESS
:
14200 case SCROLLING_NEED_LARGER_MATRICES
:
14201 goto need_larger_matrices
;
14203 case SCROLLING_FAILED
:
14211 /* Finally, just choose place to start which centers point */
14214 if (centering_position
< 0)
14215 centering_position
= window_box_height (w
) / 2;
14218 debug_method_add (w
, "recenter");
14221 /* w->vscroll = 0; */
14223 /* Forget any previously recorded base line for line number display. */
14224 if (!buffer_unchanged_p
)
14225 w
->base_line_number
= Qnil
;
14227 /* Move backward half the height of the window. */
14228 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14229 it
.current_y
= it
.last_visible_y
;
14230 move_it_vertically_backward (&it
, centering_position
);
14231 xassert (IT_CHARPOS (it
) >= BEGV
);
14233 /* The function move_it_vertically_backward may move over more
14234 than the specified y-distance. If it->w is small, e.g. a
14235 mini-buffer window, we may end up in front of the window's
14236 display area. Start displaying at the start of the line
14237 containing PT in this case. */
14238 if (it
.current_y
<= 0)
14240 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14241 move_it_vertically_backward (&it
, 0);
14245 it
.current_x
= it
.hpos
= 0;
14247 /* Set startp here explicitly in case that helps avoid an infinite loop
14248 in case the window-scroll-functions functions get errors. */
14249 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14251 /* Run scroll hooks. */
14252 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14254 /* Redisplay the window. */
14255 if (!current_matrix_up_to_date_p
14256 || windows_or_buffers_changed
14257 || cursor_type_changed
14258 /* Don't use try_window_reusing_current_matrix in this case
14259 because it can have changed the buffer. */
14260 || !NILP (Vwindow_scroll_functions
)
14261 || !just_this_one_p
14262 || MINI_WINDOW_P (w
)
14263 || !(used_current_matrix_p
14264 = try_window_reusing_current_matrix (w
)))
14265 try_window (window
, startp
, 0);
14267 /* If new fonts have been loaded (due to fontsets), give up. We
14268 have to start a new redisplay since we need to re-adjust glyph
14270 if (fonts_changed_p
)
14271 goto need_larger_matrices
;
14273 /* If cursor did not appear assume that the middle of the window is
14274 in the first line of the window. Do it again with the next line.
14275 (Imagine a window of height 100, displaying two lines of height
14276 60. Moving back 50 from it->last_visible_y will end in the first
14278 if (w
->cursor
.vpos
< 0)
14280 if (!NILP (w
->window_end_valid
)
14281 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14283 clear_glyph_matrix (w
->desired_matrix
);
14284 move_it_by_lines (&it
, 1, 0);
14285 try_window (window
, it
.current
.pos
, 0);
14287 else if (PT
< IT_CHARPOS (it
))
14289 clear_glyph_matrix (w
->desired_matrix
);
14290 move_it_by_lines (&it
, -1, 0);
14291 try_window (window
, it
.current
.pos
, 0);
14295 /* Not much we can do about it. */
14299 /* Consider the following case: Window starts at BEGV, there is
14300 invisible, intangible text at BEGV, so that display starts at
14301 some point START > BEGV. It can happen that we are called with
14302 PT somewhere between BEGV and START. Try to handle that case. */
14303 if (w
->cursor
.vpos
< 0)
14305 struct glyph_row
*row
= w
->current_matrix
->rows
;
14306 if (row
->mode_line_p
)
14308 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14311 if (!cursor_row_fully_visible_p (w
, 0, 0))
14313 /* If vscroll is enabled, disable it and try again. */
14317 clear_glyph_matrix (w
->desired_matrix
);
14321 /* If centering point failed to make the whole line visible,
14322 put point at the top instead. That has to make the whole line
14323 visible, if it can be done. */
14324 if (centering_position
== 0)
14327 clear_glyph_matrix (w
->desired_matrix
);
14328 centering_position
= 0;
14334 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14335 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14336 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14339 /* Display the mode line, if we must. */
14340 if ((update_mode_line
14341 /* If window not full width, must redo its mode line
14342 if (a) the window to its side is being redone and
14343 (b) we do a frame-based redisplay. This is a consequence
14344 of how inverted lines are drawn in frame-based redisplay. */
14345 || (!just_this_one_p
14346 && !FRAME_WINDOW_P (f
)
14347 && !WINDOW_FULL_WIDTH_P (w
))
14348 /* Line number to display. */
14349 || INTEGERP (w
->base_line_pos
)
14350 /* Column number is displayed and different from the one displayed. */
14351 || (!NILP (w
->column_number_displayed
)
14352 && (XFASTINT (w
->column_number_displayed
)
14353 != (int) current_column ()))) /* iftc */
14354 /* This means that the window has a mode line. */
14355 && (WINDOW_WANTS_MODELINE_P (w
)
14356 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14358 display_mode_lines (w
);
14360 /* If mode line height has changed, arrange for a thorough
14361 immediate redisplay using the correct mode line height. */
14362 if (WINDOW_WANTS_MODELINE_P (w
)
14363 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14365 fonts_changed_p
= 1;
14366 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14367 = DESIRED_MODE_LINE_HEIGHT (w
);
14370 /* If header line height has changed, arrange for a thorough
14371 immediate redisplay using the correct header line height. */
14372 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14373 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14375 fonts_changed_p
= 1;
14376 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14377 = DESIRED_HEADER_LINE_HEIGHT (w
);
14380 if (fonts_changed_p
)
14381 goto need_larger_matrices
;
14384 if (!line_number_displayed
14385 && !BUFFERP (w
->base_line_pos
))
14387 w
->base_line_pos
= Qnil
;
14388 w
->base_line_number
= Qnil
;
14393 /* When we reach a frame's selected window, redo the frame's menu bar. */
14394 if (update_mode_line
14395 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14397 int redisplay_menu_p
= 0;
14398 int redisplay_tool_bar_p
= 0;
14400 if (FRAME_WINDOW_P (f
))
14402 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14403 || defined (HAVE_NS) || defined (USE_GTK)
14404 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14406 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14410 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14412 if (redisplay_menu_p
)
14413 display_menu_bar (w
);
14415 #ifdef HAVE_WINDOW_SYSTEM
14416 if (FRAME_WINDOW_P (f
))
14418 #if defined (USE_GTK) || defined (HAVE_NS)
14419 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14421 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14422 && (FRAME_TOOL_BAR_LINES (f
) > 0
14423 || !NILP (Vauto_resize_tool_bars
));
14426 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14428 ignore_mouse_drag_p
= 1;
14434 #ifdef HAVE_WINDOW_SYSTEM
14435 if (FRAME_WINDOW_P (f
)
14436 && update_window_fringes (w
, (just_this_one_p
14437 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14438 || w
->pseudo_window_p
)))
14442 if (draw_window_fringes (w
, 1))
14443 x_draw_vertical_border (w
);
14447 #endif /* HAVE_WINDOW_SYSTEM */
14449 /* We go to this label, with fonts_changed_p nonzero,
14450 if it is necessary to try again using larger glyph matrices.
14451 We have to redeem the scroll bar even in this case,
14452 because the loop in redisplay_internal expects that. */
14453 need_larger_matrices
:
14455 finish_scroll_bars
:
14457 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14459 /* Set the thumb's position and size. */
14460 set_vertical_scroll_bar (w
);
14462 /* Note that we actually used the scroll bar attached to this
14463 window, so it shouldn't be deleted at the end of redisplay. */
14464 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14465 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14468 /* Restore current_buffer and value of point in it. The window
14469 update may have changed the buffer, so first make sure `opoint'
14470 is still valid (Bug#6177). */
14471 if (CHARPOS (opoint
) < BEGV
)
14472 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14473 else if (CHARPOS (opoint
) > ZV
)
14474 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14476 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14478 set_buffer_internal_1 (old
);
14479 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14480 shorter. This can be caused by log truncation in *Messages*. */
14481 if (CHARPOS (lpoint
) <= ZV
)
14482 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14484 unbind_to (count
, Qnil
);
14488 /* Build the complete desired matrix of WINDOW with a window start
14489 buffer position POS.
14491 Value is 1 if successful. It is zero if fonts were loaded during
14492 redisplay which makes re-adjusting glyph matrices necessary, and -1
14493 if point would appear in the scroll margins.
14494 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14495 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14499 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14501 struct window
*w
= XWINDOW (window
);
14503 struct glyph_row
*last_text_row
= NULL
;
14504 struct frame
*f
= XFRAME (w
->frame
);
14506 /* Make POS the new window start. */
14507 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14509 /* Mark cursor position as unknown. No overlay arrow seen. */
14510 w
->cursor
.vpos
= -1;
14511 overlay_arrow_seen
= 0;
14513 /* Initialize iterator and info to start at POS. */
14514 start_display (&it
, w
, pos
);
14516 /* Display all lines of W. */
14517 while (it
.current_y
< it
.last_visible_y
)
14519 if (display_line (&it
))
14520 last_text_row
= it
.glyph_row
- 1;
14521 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14525 /* Don't let the cursor end in the scroll margins. */
14526 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14527 && !MINI_WINDOW_P (w
))
14529 int this_scroll_margin
;
14531 if (scroll_margin
> 0)
14533 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14534 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14537 this_scroll_margin
= 0;
14539 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14540 && w
->cursor
.y
< this_scroll_margin
14541 && CHARPOS (pos
) > BEGV
14542 && IT_CHARPOS (it
) < ZV
)
14543 /* rms: considering make_cursor_line_fully_visible_p here
14544 seems to give wrong results. We don't want to recenter
14545 when the last line is partly visible, we want to allow
14546 that case to be handled in the usual way. */
14547 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14549 w
->cursor
.vpos
= -1;
14550 clear_glyph_matrix (w
->desired_matrix
);
14555 /* If bottom moved off end of frame, change mode line percentage. */
14556 if (XFASTINT (w
->window_end_pos
) <= 0
14557 && Z
!= IT_CHARPOS (it
))
14558 w
->update_mode_line
= Qt
;
14560 /* Set window_end_pos to the offset of the last character displayed
14561 on the window from the end of current_buffer. Set
14562 window_end_vpos to its row number. */
14565 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14566 w
->window_end_bytepos
14567 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14569 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14571 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14572 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14573 ->displays_text_p
);
14577 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14578 w
->window_end_pos
= make_number (Z
- ZV
);
14579 w
->window_end_vpos
= make_number (0);
14582 /* But that is not valid info until redisplay finishes. */
14583 w
->window_end_valid
= Qnil
;
14589 /************************************************************************
14590 Window redisplay reusing current matrix when buffer has not changed
14591 ************************************************************************/
14593 /* Try redisplay of window W showing an unchanged buffer with a
14594 different window start than the last time it was displayed by
14595 reusing its current matrix. Value is non-zero if successful.
14596 W->start is the new window start. */
14599 try_window_reusing_current_matrix (struct window
*w
)
14601 struct frame
*f
= XFRAME (w
->frame
);
14602 struct glyph_row
*bottom_row
;
14605 struct text_pos start
, new_start
;
14606 int nrows_scrolled
, i
;
14607 struct glyph_row
*last_text_row
;
14608 struct glyph_row
*last_reused_text_row
;
14609 struct glyph_row
*start_row
;
14610 int start_vpos
, min_y
, max_y
;
14613 if (inhibit_try_window_reusing
)
14617 if (/* This function doesn't handle terminal frames. */
14618 !FRAME_WINDOW_P (f
)
14619 /* Don't try to reuse the display if windows have been split
14621 || windows_or_buffers_changed
14622 || cursor_type_changed
)
14625 /* Can't do this if region may have changed. */
14626 if ((!NILP (Vtransient_mark_mode
)
14627 && !NILP (BVAR (current_buffer
, mark_active
)))
14628 || !NILP (w
->region_showing
)
14629 || !NILP (Vshow_trailing_whitespace
))
14632 /* If top-line visibility has changed, give up. */
14633 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14634 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14637 /* Give up if old or new display is scrolled vertically. We could
14638 make this function handle this, but right now it doesn't. */
14639 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14640 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14643 /* The variable new_start now holds the new window start. The old
14644 start `start' can be determined from the current matrix. */
14645 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14646 start
= start_row
->minpos
;
14647 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14649 /* Clear the desired matrix for the display below. */
14650 clear_glyph_matrix (w
->desired_matrix
);
14652 if (CHARPOS (new_start
) <= CHARPOS (start
))
14656 /* Don't use this method if the display starts with an ellipsis
14657 displayed for invisible text. It's not easy to handle that case
14658 below, and it's certainly not worth the effort since this is
14659 not a frequent case. */
14660 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14663 IF_DEBUG (debug_method_add (w
, "twu1"));
14665 /* Display up to a row that can be reused. The variable
14666 last_text_row is set to the last row displayed that displays
14667 text. Note that it.vpos == 0 if or if not there is a
14668 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14669 start_display (&it
, w
, new_start
);
14670 first_row_y
= it
.current_y
;
14671 w
->cursor
.vpos
= -1;
14672 last_text_row
= last_reused_text_row
= NULL
;
14674 while (it
.current_y
< it
.last_visible_y
14675 && !fonts_changed_p
)
14677 /* If we have reached into the characters in the START row,
14678 that means the line boundaries have changed. So we
14679 can't start copying with the row START. Maybe it will
14680 work to start copying with the following row. */
14681 while (IT_CHARPOS (it
) > CHARPOS (start
))
14683 /* Advance to the next row as the "start". */
14685 start
= start_row
->minpos
;
14686 /* If there are no more rows to try, or just one, give up. */
14687 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14688 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14689 || CHARPOS (start
) == ZV
)
14691 clear_glyph_matrix (w
->desired_matrix
);
14695 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14697 /* If we have reached alignment,
14698 we can copy the rest of the rows. */
14699 if (IT_CHARPOS (it
) == CHARPOS (start
))
14702 if (display_line (&it
))
14703 last_text_row
= it
.glyph_row
- 1;
14706 /* A value of current_y < last_visible_y means that we stopped
14707 at the previous window start, which in turn means that we
14708 have at least one reusable row. */
14709 if (it
.current_y
< it
.last_visible_y
)
14711 struct glyph_row
*row
;
14713 /* IT.vpos always starts from 0; it counts text lines. */
14714 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14716 /* Find PT if not already found in the lines displayed. */
14717 if (w
->cursor
.vpos
< 0)
14719 int dy
= it
.current_y
- start_row
->y
;
14721 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14722 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14724 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14725 dy
, nrows_scrolled
);
14728 clear_glyph_matrix (w
->desired_matrix
);
14733 /* Scroll the display. Do it before the current matrix is
14734 changed. The problem here is that update has not yet
14735 run, i.e. part of the current matrix is not up to date.
14736 scroll_run_hook will clear the cursor, and use the
14737 current matrix to get the height of the row the cursor is
14739 run
.current_y
= start_row
->y
;
14740 run
.desired_y
= it
.current_y
;
14741 run
.height
= it
.last_visible_y
- it
.current_y
;
14743 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14746 FRAME_RIF (f
)->update_window_begin_hook (w
);
14747 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14748 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14749 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14753 /* Shift current matrix down by nrows_scrolled lines. */
14754 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14755 rotate_matrix (w
->current_matrix
,
14757 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14760 /* Disable lines that must be updated. */
14761 for (i
= 0; i
< nrows_scrolled
; ++i
)
14762 (start_row
+ i
)->enabled_p
= 0;
14764 /* Re-compute Y positions. */
14765 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14766 max_y
= it
.last_visible_y
;
14767 for (row
= start_row
+ nrows_scrolled
;
14771 row
->y
= it
.current_y
;
14772 row
->visible_height
= row
->height
;
14774 if (row
->y
< min_y
)
14775 row
->visible_height
-= min_y
- row
->y
;
14776 if (row
->y
+ row
->height
> max_y
)
14777 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14778 row
->redraw_fringe_bitmaps_p
= 1;
14780 it
.current_y
+= row
->height
;
14782 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14783 last_reused_text_row
= row
;
14784 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14788 /* Disable lines in the current matrix which are now
14789 below the window. */
14790 for (++row
; row
< bottom_row
; ++row
)
14791 row
->enabled_p
= row
->mode_line_p
= 0;
14794 /* Update window_end_pos etc.; last_reused_text_row is the last
14795 reused row from the current matrix containing text, if any.
14796 The value of last_text_row is the last displayed line
14797 containing text. */
14798 if (last_reused_text_row
)
14800 w
->window_end_bytepos
14801 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14803 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14805 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14806 w
->current_matrix
));
14808 else if (last_text_row
)
14810 w
->window_end_bytepos
14811 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14813 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14815 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14819 /* This window must be completely empty. */
14820 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14821 w
->window_end_pos
= make_number (Z
- ZV
);
14822 w
->window_end_vpos
= make_number (0);
14824 w
->window_end_valid
= Qnil
;
14826 /* Update hint: don't try scrolling again in update_window. */
14827 w
->desired_matrix
->no_scrolling_p
= 1;
14830 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14834 else if (CHARPOS (new_start
) > CHARPOS (start
))
14836 struct glyph_row
*pt_row
, *row
;
14837 struct glyph_row
*first_reusable_row
;
14838 struct glyph_row
*first_row_to_display
;
14840 int yb
= window_text_bottom_y (w
);
14842 /* Find the row starting at new_start, if there is one. Don't
14843 reuse a partially visible line at the end. */
14844 first_reusable_row
= start_row
;
14845 while (first_reusable_row
->enabled_p
14846 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14847 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14848 < CHARPOS (new_start
)))
14849 ++first_reusable_row
;
14851 /* Give up if there is no row to reuse. */
14852 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14853 || !first_reusable_row
->enabled_p
14854 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14855 != CHARPOS (new_start
)))
14858 /* We can reuse fully visible rows beginning with
14859 first_reusable_row to the end of the window. Set
14860 first_row_to_display to the first row that cannot be reused.
14861 Set pt_row to the row containing point, if there is any. */
14863 for (first_row_to_display
= first_reusable_row
;
14864 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14865 ++first_row_to_display
)
14867 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14868 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14869 pt_row
= first_row_to_display
;
14872 /* Start displaying at the start of first_row_to_display. */
14873 xassert (first_row_to_display
->y
< yb
);
14874 init_to_row_start (&it
, w
, first_row_to_display
);
14876 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14878 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14880 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14881 + WINDOW_HEADER_LINE_HEIGHT (w
));
14883 /* Display lines beginning with first_row_to_display in the
14884 desired matrix. Set last_text_row to the last row displayed
14885 that displays text. */
14886 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14887 if (pt_row
== NULL
)
14888 w
->cursor
.vpos
= -1;
14889 last_text_row
= NULL
;
14890 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14891 if (display_line (&it
))
14892 last_text_row
= it
.glyph_row
- 1;
14894 /* If point is in a reused row, adjust y and vpos of the cursor
14898 w
->cursor
.vpos
-= nrows_scrolled
;
14899 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14902 /* Give up if point isn't in a row displayed or reused. (This
14903 also handles the case where w->cursor.vpos < nrows_scrolled
14904 after the calls to display_line, which can happen with scroll
14905 margins. See bug#1295.) */
14906 if (w
->cursor
.vpos
< 0)
14908 clear_glyph_matrix (w
->desired_matrix
);
14912 /* Scroll the display. */
14913 run
.current_y
= first_reusable_row
->y
;
14914 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14915 run
.height
= it
.last_visible_y
- run
.current_y
;
14916 dy
= run
.current_y
- run
.desired_y
;
14921 FRAME_RIF (f
)->update_window_begin_hook (w
);
14922 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14923 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14924 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14928 /* Adjust Y positions of reused rows. */
14929 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14930 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14931 max_y
= it
.last_visible_y
;
14932 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14935 row
->visible_height
= row
->height
;
14936 if (row
->y
< min_y
)
14937 row
->visible_height
-= min_y
- row
->y
;
14938 if (row
->y
+ row
->height
> max_y
)
14939 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14940 row
->redraw_fringe_bitmaps_p
= 1;
14943 /* Scroll the current matrix. */
14944 xassert (nrows_scrolled
> 0);
14945 rotate_matrix (w
->current_matrix
,
14947 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14950 /* Disable rows not reused. */
14951 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14952 row
->enabled_p
= 0;
14954 /* Point may have moved to a different line, so we cannot assume that
14955 the previous cursor position is valid; locate the correct row. */
14958 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14959 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14963 w
->cursor
.y
= row
->y
;
14965 if (row
< bottom_row
)
14967 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14968 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14970 /* Can't use this optimization with bidi-reordered glyph
14971 rows, unless cursor is already at point. */
14972 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14974 if (!(w
->cursor
.hpos
>= 0
14975 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
14976 && BUFFERP (glyph
->object
)
14977 && glyph
->charpos
== PT
))
14982 && (!BUFFERP (glyph
->object
)
14983 || glyph
->charpos
< PT
);
14987 w
->cursor
.x
+= glyph
->pixel_width
;
14992 /* Adjust window end. A null value of last_text_row means that
14993 the window end is in reused rows which in turn means that
14994 only its vpos can have changed. */
14997 w
->window_end_bytepos
14998 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15000 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15002 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15007 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15010 w
->window_end_valid
= Qnil
;
15011 w
->desired_matrix
->no_scrolling_p
= 1;
15014 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15024 /************************************************************************
15025 Window redisplay reusing current matrix when buffer has changed
15026 ************************************************************************/
15028 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15029 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15030 EMACS_INT
*, EMACS_INT
*);
15031 static struct glyph_row
*
15032 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15033 struct glyph_row
*);
15036 /* Return the last row in MATRIX displaying text. If row START is
15037 non-null, start searching with that row. IT gives the dimensions
15038 of the display. Value is null if matrix is empty; otherwise it is
15039 a pointer to the row found. */
15041 static struct glyph_row
*
15042 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15043 struct glyph_row
*start
)
15045 struct glyph_row
*row
, *row_found
;
15047 /* Set row_found to the last row in IT->w's current matrix
15048 displaying text. The loop looks funny but think of partially
15051 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15052 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15054 xassert (row
->enabled_p
);
15056 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15065 /* Return the last row in the current matrix of W that is not affected
15066 by changes at the start of current_buffer that occurred since W's
15067 current matrix was built. Value is null if no such row exists.
15069 BEG_UNCHANGED us the number of characters unchanged at the start of
15070 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15071 first changed character in current_buffer. Characters at positions <
15072 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15073 when the current matrix was built. */
15075 static struct glyph_row
*
15076 find_last_unchanged_at_beg_row (struct window
*w
)
15078 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15079 struct glyph_row
*row
;
15080 struct glyph_row
*row_found
= NULL
;
15081 int yb
= window_text_bottom_y (w
);
15083 /* Find the last row displaying unchanged text. */
15084 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15085 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15086 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15089 if (/* If row ends before first_changed_pos, it is unchanged,
15090 except in some case. */
15091 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15092 /* When row ends in ZV and we write at ZV it is not
15094 && !row
->ends_at_zv_p
15095 /* When first_changed_pos is the end of a continued line,
15096 row is not unchanged because it may be no longer
15098 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15099 && (row
->continued_p
15100 || row
->exact_window_width_line_p
)))
15103 /* Stop if last visible row. */
15104 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15112 /* Find the first glyph row in the current matrix of W that is not
15113 affected by changes at the end of current_buffer since the
15114 time W's current matrix was built.
15116 Return in *DELTA the number of chars by which buffer positions in
15117 unchanged text at the end of current_buffer must be adjusted.
15119 Return in *DELTA_BYTES the corresponding number of bytes.
15121 Value is null if no such row exists, i.e. all rows are affected by
15124 static struct glyph_row
*
15125 find_first_unchanged_at_end_row (struct window
*w
,
15126 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15128 struct glyph_row
*row
;
15129 struct glyph_row
*row_found
= NULL
;
15131 *delta
= *delta_bytes
= 0;
15133 /* Display must not have been paused, otherwise the current matrix
15134 is not up to date. */
15135 eassert (!NILP (w
->window_end_valid
));
15137 /* A value of window_end_pos >= END_UNCHANGED means that the window
15138 end is in the range of changed text. If so, there is no
15139 unchanged row at the end of W's current matrix. */
15140 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15143 /* Set row to the last row in W's current matrix displaying text. */
15144 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15146 /* If matrix is entirely empty, no unchanged row exists. */
15147 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15149 /* The value of row is the last glyph row in the matrix having a
15150 meaningful buffer position in it. The end position of row
15151 corresponds to window_end_pos. This allows us to translate
15152 buffer positions in the current matrix to current buffer
15153 positions for characters not in changed text. */
15155 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15156 EMACS_INT Z_BYTE_old
=
15157 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15158 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15159 struct glyph_row
*first_text_row
15160 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15162 *delta
= Z
- Z_old
;
15163 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15165 /* Set last_unchanged_pos to the buffer position of the last
15166 character in the buffer that has not been changed. Z is the
15167 index + 1 of the last character in current_buffer, i.e. by
15168 subtracting END_UNCHANGED we get the index of the last
15169 unchanged character, and we have to add BEG to get its buffer
15171 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15172 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15174 /* Search backward from ROW for a row displaying a line that
15175 starts at a minimum position >= last_unchanged_pos_old. */
15176 for (; row
> first_text_row
; --row
)
15178 /* This used to abort, but it can happen.
15179 It is ok to just stop the search instead here. KFS. */
15180 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15183 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15188 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15194 /* Make sure that glyph rows in the current matrix of window W
15195 reference the same glyph memory as corresponding rows in the
15196 frame's frame matrix. This function is called after scrolling W's
15197 current matrix on a terminal frame in try_window_id and
15198 try_window_reusing_current_matrix. */
15201 sync_frame_with_window_matrix_rows (struct window
*w
)
15203 struct frame
*f
= XFRAME (w
->frame
);
15204 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15206 /* Preconditions: W must be a leaf window and full-width. Its frame
15207 must have a frame matrix. */
15208 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15209 xassert (WINDOW_FULL_WIDTH_P (w
));
15210 xassert (!FRAME_WINDOW_P (f
));
15212 /* If W is a full-width window, glyph pointers in W's current matrix
15213 have, by definition, to be the same as glyph pointers in the
15214 corresponding frame matrix. Note that frame matrices have no
15215 marginal areas (see build_frame_matrix). */
15216 window_row
= w
->current_matrix
->rows
;
15217 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15218 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15219 while (window_row
< window_row_end
)
15221 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15222 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15224 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15225 frame_row
->glyphs
[TEXT_AREA
] = start
;
15226 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15227 frame_row
->glyphs
[LAST_AREA
] = end
;
15229 /* Disable frame rows whose corresponding window rows have
15230 been disabled in try_window_id. */
15231 if (!window_row
->enabled_p
)
15232 frame_row
->enabled_p
= 0;
15234 ++window_row
, ++frame_row
;
15239 /* Find the glyph row in window W containing CHARPOS. Consider all
15240 rows between START and END (not inclusive). END null means search
15241 all rows to the end of the display area of W. Value is the row
15242 containing CHARPOS or null. */
15245 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15246 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15248 struct glyph_row
*row
= start
;
15249 struct glyph_row
*best_row
= NULL
;
15250 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15253 /* If we happen to start on a header-line, skip that. */
15254 if (row
->mode_line_p
)
15257 if ((end
&& row
>= end
) || !row
->enabled_p
)
15260 last_y
= window_text_bottom_y (w
) - dy
;
15264 /* Give up if we have gone too far. */
15265 if (end
&& row
>= end
)
15267 /* This formerly returned if they were equal.
15268 I think that both quantities are of a "last plus one" type;
15269 if so, when they are equal, the row is within the screen. -- rms. */
15270 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15273 /* If it is in this row, return this row. */
15274 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15275 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15276 /* The end position of a row equals the start
15277 position of the next row. If CHARPOS is there, we
15278 would rather display it in the next line, except
15279 when this line ends in ZV. */
15280 && !row
->ends_at_zv_p
15281 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15282 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15286 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15287 || (!best_row
&& !row
->continued_p
))
15289 /* In bidi-reordered rows, there could be several rows
15290 occluding point, all of them belonging to the same
15291 continued line. We need to find the row which fits
15292 CHARPOS the best. */
15293 for (g
= row
->glyphs
[TEXT_AREA
];
15294 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15297 if (!STRINGP (g
->object
))
15299 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15301 mindif
= eabs (g
->charpos
- charpos
);
15303 /* Exact match always wins. */
15310 else if (best_row
&& !row
->continued_p
)
15317 /* Try to redisplay window W by reusing its existing display. W's
15318 current matrix must be up to date when this function is called,
15319 i.e. window_end_valid must not be nil.
15323 1 if display has been updated
15324 0 if otherwise unsuccessful
15325 -1 if redisplay with same window start is known not to succeed
15327 The following steps are performed:
15329 1. Find the last row in the current matrix of W that is not
15330 affected by changes at the start of current_buffer. If no such row
15333 2. Find the first row in W's current matrix that is not affected by
15334 changes at the end of current_buffer. Maybe there is no such row.
15336 3. Display lines beginning with the row + 1 found in step 1 to the
15337 row found in step 2 or, if step 2 didn't find a row, to the end of
15340 4. If cursor is not known to appear on the window, give up.
15342 5. If display stopped at the row found in step 2, scroll the
15343 display and current matrix as needed.
15345 6. Maybe display some lines at the end of W, if we must. This can
15346 happen under various circumstances, like a partially visible line
15347 becoming fully visible, or because newly displayed lines are displayed
15348 in smaller font sizes.
15350 7. Update W's window end information. */
15353 try_window_id (struct window
*w
)
15355 struct frame
*f
= XFRAME (w
->frame
);
15356 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15357 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15358 struct glyph_row
*last_unchanged_at_beg_row
;
15359 struct glyph_row
*first_unchanged_at_end_row
;
15360 struct glyph_row
*row
;
15361 struct glyph_row
*bottom_row
;
15364 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15366 struct text_pos start_pos
;
15368 int first_unchanged_at_end_vpos
= 0;
15369 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15370 struct text_pos start
;
15371 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15374 if (inhibit_try_window_id
)
15378 /* This is handy for debugging. */
15380 #define GIVE_UP(X) \
15382 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15386 #define GIVE_UP(X) return 0
15389 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15391 /* Don't use this for mini-windows because these can show
15392 messages and mini-buffers, and we don't handle that here. */
15393 if (MINI_WINDOW_P (w
))
15396 /* This flag is used to prevent redisplay optimizations. */
15397 if (windows_or_buffers_changed
|| cursor_type_changed
)
15400 /* Verify that narrowing has not changed.
15401 Also verify that we were not told to prevent redisplay optimizations.
15402 It would be nice to further
15403 reduce the number of cases where this prevents try_window_id. */
15404 if (current_buffer
->clip_changed
15405 || current_buffer
->prevent_redisplay_optimizations_p
)
15408 /* Window must either use window-based redisplay or be full width. */
15409 if (!FRAME_WINDOW_P (f
)
15410 && (!FRAME_LINE_INS_DEL_OK (f
)
15411 || !WINDOW_FULL_WIDTH_P (w
)))
15414 /* Give up if point is known NOT to appear in W. */
15415 if (PT
< CHARPOS (start
))
15418 /* Another way to prevent redisplay optimizations. */
15419 if (XFASTINT (w
->last_modified
) == 0)
15422 /* Verify that window is not hscrolled. */
15423 if (XFASTINT (w
->hscroll
) != 0)
15426 /* Verify that display wasn't paused. */
15427 if (NILP (w
->window_end_valid
))
15430 /* Can't use this if highlighting a region because a cursor movement
15431 will do more than just set the cursor. */
15432 if (!NILP (Vtransient_mark_mode
)
15433 && !NILP (BVAR (current_buffer
, mark_active
)))
15436 /* Likewise if highlighting trailing whitespace. */
15437 if (!NILP (Vshow_trailing_whitespace
))
15440 /* Likewise if showing a region. */
15441 if (!NILP (w
->region_showing
))
15444 /* Can't use this if overlay arrow position and/or string have
15446 if (overlay_arrows_changed_p ())
15449 /* When word-wrap is on, adding a space to the first word of a
15450 wrapped line can change the wrap position, altering the line
15451 above it. It might be worthwhile to handle this more
15452 intelligently, but for now just redisplay from scratch. */
15453 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15456 /* Under bidi reordering, adding or deleting a character in the
15457 beginning of a paragraph, before the first strong directional
15458 character, can change the base direction of the paragraph (unless
15459 the buffer specifies a fixed paragraph direction), which will
15460 require to redisplay the whole paragraph. It might be worthwhile
15461 to find the paragraph limits and widen the range of redisplayed
15462 lines to that, but for now just give up this optimization and
15463 redisplay from scratch. */
15464 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15465 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15468 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15469 only if buffer has really changed. The reason is that the gap is
15470 initially at Z for freshly visited files. The code below would
15471 set end_unchanged to 0 in that case. */
15472 if (MODIFF
> SAVE_MODIFF
15473 /* This seems to happen sometimes after saving a buffer. */
15474 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15476 if (GPT
- BEG
< BEG_UNCHANGED
)
15477 BEG_UNCHANGED
= GPT
- BEG
;
15478 if (Z
- GPT
< END_UNCHANGED
)
15479 END_UNCHANGED
= Z
- GPT
;
15482 /* The position of the first and last character that has been changed. */
15483 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15484 last_changed_charpos
= Z
- END_UNCHANGED
;
15486 /* If window starts after a line end, and the last change is in
15487 front of that newline, then changes don't affect the display.
15488 This case happens with stealth-fontification. Note that although
15489 the display is unchanged, glyph positions in the matrix have to
15490 be adjusted, of course. */
15491 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15492 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15493 && ((last_changed_charpos
< CHARPOS (start
)
15494 && CHARPOS (start
) == BEGV
)
15495 || (last_changed_charpos
< CHARPOS (start
) - 1
15496 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15498 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15499 struct glyph_row
*r0
;
15501 /* Compute how many chars/bytes have been added to or removed
15502 from the buffer. */
15503 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15504 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15505 Z_delta
= Z
- Z_old
;
15506 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15508 /* Give up if PT is not in the window. Note that it already has
15509 been checked at the start of try_window_id that PT is not in
15510 front of the window start. */
15511 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15514 /* If window start is unchanged, we can reuse the whole matrix
15515 as is, after adjusting glyph positions. No need to compute
15516 the window end again, since its offset from Z hasn't changed. */
15517 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15518 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15519 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15520 /* PT must not be in a partially visible line. */
15521 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15522 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15524 /* Adjust positions in the glyph matrix. */
15525 if (Z_delta
|| Z_delta_bytes
)
15527 struct glyph_row
*r1
15528 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15529 increment_matrix_positions (w
->current_matrix
,
15530 MATRIX_ROW_VPOS (r0
, current_matrix
),
15531 MATRIX_ROW_VPOS (r1
, current_matrix
),
15532 Z_delta
, Z_delta_bytes
);
15535 /* Set the cursor. */
15536 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15538 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15545 /* Handle the case that changes are all below what is displayed in
15546 the window, and that PT is in the window. This shortcut cannot
15547 be taken if ZV is visible in the window, and text has been added
15548 there that is visible in the window. */
15549 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15550 /* ZV is not visible in the window, or there are no
15551 changes at ZV, actually. */
15552 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15553 || first_changed_charpos
== last_changed_charpos
))
15555 struct glyph_row
*r0
;
15557 /* Give up if PT is not in the window. Note that it already has
15558 been checked at the start of try_window_id that PT is not in
15559 front of the window start. */
15560 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15563 /* If window start is unchanged, we can reuse the whole matrix
15564 as is, without changing glyph positions since no text has
15565 been added/removed in front of the window end. */
15566 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15567 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15568 /* PT must not be in a partially visible line. */
15569 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15570 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15572 /* We have to compute the window end anew since text
15573 could have been added/removed after it. */
15575 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15576 w
->window_end_bytepos
15577 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15579 /* Set the cursor. */
15580 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15582 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15589 /* Give up if window start is in the changed area.
15591 The condition used to read
15593 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15595 but why that was tested escapes me at the moment. */
15596 if (CHARPOS (start
) >= first_changed_charpos
15597 && CHARPOS (start
) <= last_changed_charpos
)
15600 /* Check that window start agrees with the start of the first glyph
15601 row in its current matrix. Check this after we know the window
15602 start is not in changed text, otherwise positions would not be
15604 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15605 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15608 /* Give up if the window ends in strings. Overlay strings
15609 at the end are difficult to handle, so don't try. */
15610 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15611 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15614 /* Compute the position at which we have to start displaying new
15615 lines. Some of the lines at the top of the window might be
15616 reusable because they are not displaying changed text. Find the
15617 last row in W's current matrix not affected by changes at the
15618 start of current_buffer. Value is null if changes start in the
15619 first line of window. */
15620 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15621 if (last_unchanged_at_beg_row
)
15623 /* Avoid starting to display in the moddle of a character, a TAB
15624 for instance. This is easier than to set up the iterator
15625 exactly, and it's not a frequent case, so the additional
15626 effort wouldn't really pay off. */
15627 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15628 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15629 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15630 --last_unchanged_at_beg_row
;
15632 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15635 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15637 start_pos
= it
.current
.pos
;
15639 /* Start displaying new lines in the desired matrix at the same
15640 vpos we would use in the current matrix, i.e. below
15641 last_unchanged_at_beg_row. */
15642 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15644 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15645 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15647 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15651 /* There are no reusable lines at the start of the window.
15652 Start displaying in the first text line. */
15653 start_display (&it
, w
, start
);
15654 it
.vpos
= it
.first_vpos
;
15655 start_pos
= it
.current
.pos
;
15658 /* Find the first row that is not affected by changes at the end of
15659 the buffer. Value will be null if there is no unchanged row, in
15660 which case we must redisplay to the end of the window. delta
15661 will be set to the value by which buffer positions beginning with
15662 first_unchanged_at_end_row have to be adjusted due to text
15664 first_unchanged_at_end_row
15665 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15666 IF_DEBUG (debug_delta
= delta
);
15667 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15669 /* Set stop_pos to the buffer position up to which we will have to
15670 display new lines. If first_unchanged_at_end_row != NULL, this
15671 is the buffer position of the start of the line displayed in that
15672 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15673 that we don't stop at a buffer position. */
15675 if (first_unchanged_at_end_row
)
15677 xassert (last_unchanged_at_beg_row
== NULL
15678 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15680 /* If this is a continuation line, move forward to the next one
15681 that isn't. Changes in lines above affect this line.
15682 Caution: this may move first_unchanged_at_end_row to a row
15683 not displaying text. */
15684 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15685 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15686 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15687 < it
.last_visible_y
))
15688 ++first_unchanged_at_end_row
;
15690 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15691 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15692 >= it
.last_visible_y
))
15693 first_unchanged_at_end_row
= NULL
;
15696 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15698 first_unchanged_at_end_vpos
15699 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15700 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15703 else if (last_unchanged_at_beg_row
== NULL
)
15709 /* Either there is no unchanged row at the end, or the one we have
15710 now displays text. This is a necessary condition for the window
15711 end pos calculation at the end of this function. */
15712 xassert (first_unchanged_at_end_row
== NULL
15713 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15715 debug_last_unchanged_at_beg_vpos
15716 = (last_unchanged_at_beg_row
15717 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15719 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15721 #endif /* GLYPH_DEBUG != 0 */
15724 /* Display new lines. Set last_text_row to the last new line
15725 displayed which has text on it, i.e. might end up as being the
15726 line where the window_end_vpos is. */
15727 w
->cursor
.vpos
= -1;
15728 last_text_row
= NULL
;
15729 overlay_arrow_seen
= 0;
15730 while (it
.current_y
< it
.last_visible_y
15731 && !fonts_changed_p
15732 && (first_unchanged_at_end_row
== NULL
15733 || IT_CHARPOS (it
) < stop_pos
))
15735 if (display_line (&it
))
15736 last_text_row
= it
.glyph_row
- 1;
15739 if (fonts_changed_p
)
15743 /* Compute differences in buffer positions, y-positions etc. for
15744 lines reused at the bottom of the window. Compute what we can
15746 if (first_unchanged_at_end_row
15747 /* No lines reused because we displayed everything up to the
15748 bottom of the window. */
15749 && it
.current_y
< it
.last_visible_y
)
15752 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15754 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15755 run
.current_y
= first_unchanged_at_end_row
->y
;
15756 run
.desired_y
= run
.current_y
+ dy
;
15757 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15761 delta
= delta_bytes
= dvpos
= dy
15762 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15763 first_unchanged_at_end_row
= NULL
;
15765 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15768 /* Find the cursor if not already found. We have to decide whether
15769 PT will appear on this window (it sometimes doesn't, but this is
15770 not a very frequent case.) This decision has to be made before
15771 the current matrix is altered. A value of cursor.vpos < 0 means
15772 that PT is either in one of the lines beginning at
15773 first_unchanged_at_end_row or below the window. Don't care for
15774 lines that might be displayed later at the window end; as
15775 mentioned, this is not a frequent case. */
15776 if (w
->cursor
.vpos
< 0)
15778 /* Cursor in unchanged rows at the top? */
15779 if (PT
< CHARPOS (start_pos
)
15780 && last_unchanged_at_beg_row
)
15782 row
= row_containing_pos (w
, PT
,
15783 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15784 last_unchanged_at_beg_row
+ 1, 0);
15786 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15789 /* Start from first_unchanged_at_end_row looking for PT. */
15790 else if (first_unchanged_at_end_row
)
15792 row
= row_containing_pos (w
, PT
- delta
,
15793 first_unchanged_at_end_row
, NULL
, 0);
15795 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15796 delta_bytes
, dy
, dvpos
);
15799 /* Give up if cursor was not found. */
15800 if (w
->cursor
.vpos
< 0)
15802 clear_glyph_matrix (w
->desired_matrix
);
15807 /* Don't let the cursor end in the scroll margins. */
15809 int this_scroll_margin
, cursor_height
;
15811 this_scroll_margin
= max (0, scroll_margin
);
15812 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15813 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15814 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15816 if ((w
->cursor
.y
< this_scroll_margin
15817 && CHARPOS (start
) > BEGV
)
15818 /* Old redisplay didn't take scroll margin into account at the bottom,
15819 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15820 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15821 ? cursor_height
+ this_scroll_margin
15822 : 1)) > it
.last_visible_y
)
15824 w
->cursor
.vpos
= -1;
15825 clear_glyph_matrix (w
->desired_matrix
);
15830 /* Scroll the display. Do it before changing the current matrix so
15831 that xterm.c doesn't get confused about where the cursor glyph is
15833 if (dy
&& run
.height
)
15837 if (FRAME_WINDOW_P (f
))
15839 FRAME_RIF (f
)->update_window_begin_hook (w
);
15840 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15841 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15842 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15846 /* Terminal frame. In this case, dvpos gives the number of
15847 lines to scroll by; dvpos < 0 means scroll up. */
15849 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15850 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15851 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15852 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15853 + window_internal_height (w
));
15855 #if defined (HAVE_GPM) || defined (MSDOS)
15856 x_clear_window_mouse_face (w
);
15858 /* Perform the operation on the screen. */
15861 /* Scroll last_unchanged_at_beg_row to the end of the
15862 window down dvpos lines. */
15863 set_terminal_window (f
, end
);
15865 /* On dumb terminals delete dvpos lines at the end
15866 before inserting dvpos empty lines. */
15867 if (!FRAME_SCROLL_REGION_OK (f
))
15868 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15870 /* Insert dvpos empty lines in front of
15871 last_unchanged_at_beg_row. */
15872 ins_del_lines (f
, from
, dvpos
);
15874 else if (dvpos
< 0)
15876 /* Scroll up last_unchanged_at_beg_vpos to the end of
15877 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15878 set_terminal_window (f
, end
);
15880 /* Delete dvpos lines in front of
15881 last_unchanged_at_beg_vpos. ins_del_lines will set
15882 the cursor to the given vpos and emit |dvpos| delete
15884 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15886 /* On a dumb terminal insert dvpos empty lines at the
15888 if (!FRAME_SCROLL_REGION_OK (f
))
15889 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15892 set_terminal_window (f
, 0);
15898 /* Shift reused rows of the current matrix to the right position.
15899 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15901 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15902 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15905 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15906 bottom_vpos
, dvpos
);
15907 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15910 else if (dvpos
> 0)
15912 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15913 bottom_vpos
, dvpos
);
15914 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15915 first_unchanged_at_end_vpos
+ dvpos
, 0);
15918 /* For frame-based redisplay, make sure that current frame and window
15919 matrix are in sync with respect to glyph memory. */
15920 if (!FRAME_WINDOW_P (f
))
15921 sync_frame_with_window_matrix_rows (w
);
15923 /* Adjust buffer positions in reused rows. */
15924 if (delta
|| delta_bytes
)
15925 increment_matrix_positions (current_matrix
,
15926 first_unchanged_at_end_vpos
+ dvpos
,
15927 bottom_vpos
, delta
, delta_bytes
);
15929 /* Adjust Y positions. */
15931 shift_glyph_matrix (w
, current_matrix
,
15932 first_unchanged_at_end_vpos
+ dvpos
,
15935 if (first_unchanged_at_end_row
)
15937 first_unchanged_at_end_row
+= dvpos
;
15938 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15939 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15940 first_unchanged_at_end_row
= NULL
;
15943 /* If scrolling up, there may be some lines to display at the end of
15945 last_text_row_at_end
= NULL
;
15948 /* Scrolling up can leave for example a partially visible line
15949 at the end of the window to be redisplayed. */
15950 /* Set last_row to the glyph row in the current matrix where the
15951 window end line is found. It has been moved up or down in
15952 the matrix by dvpos. */
15953 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15954 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15956 /* If last_row is the window end line, it should display text. */
15957 xassert (last_row
->displays_text_p
);
15959 /* If window end line was partially visible before, begin
15960 displaying at that line. Otherwise begin displaying with the
15961 line following it. */
15962 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15964 init_to_row_start (&it
, w
, last_row
);
15965 it
.vpos
= last_vpos
;
15966 it
.current_y
= last_row
->y
;
15970 init_to_row_end (&it
, w
, last_row
);
15971 it
.vpos
= 1 + last_vpos
;
15972 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15976 /* We may start in a continuation line. If so, we have to
15977 get the right continuation_lines_width and current_x. */
15978 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15979 it
.hpos
= it
.current_x
= 0;
15981 /* Display the rest of the lines at the window end. */
15982 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15983 while (it
.current_y
< it
.last_visible_y
15984 && !fonts_changed_p
)
15986 /* Is it always sure that the display agrees with lines in
15987 the current matrix? I don't think so, so we mark rows
15988 displayed invalid in the current matrix by setting their
15989 enabled_p flag to zero. */
15990 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15991 if (display_line (&it
))
15992 last_text_row_at_end
= it
.glyph_row
- 1;
15996 /* Update window_end_pos and window_end_vpos. */
15997 if (first_unchanged_at_end_row
15998 && !last_text_row_at_end
)
16000 /* Window end line if one of the preserved rows from the current
16001 matrix. Set row to the last row displaying text in current
16002 matrix starting at first_unchanged_at_end_row, after
16004 xassert (first_unchanged_at_end_row
->displays_text_p
);
16005 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16006 first_unchanged_at_end_row
);
16007 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16009 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16010 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16012 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16013 xassert (w
->window_end_bytepos
>= 0);
16014 IF_DEBUG (debug_method_add (w
, "A"));
16016 else if (last_text_row_at_end
)
16019 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16020 w
->window_end_bytepos
16021 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16023 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16024 xassert (w
->window_end_bytepos
>= 0);
16025 IF_DEBUG (debug_method_add (w
, "B"));
16027 else if (last_text_row
)
16029 /* We have displayed either to the end of the window or at the
16030 end of the window, i.e. the last row with text is to be found
16031 in the desired matrix. */
16033 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16034 w
->window_end_bytepos
16035 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16037 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16038 xassert (w
->window_end_bytepos
>= 0);
16040 else if (first_unchanged_at_end_row
== NULL
16041 && last_text_row
== NULL
16042 && last_text_row_at_end
== NULL
)
16044 /* Displayed to end of window, but no line containing text was
16045 displayed. Lines were deleted at the end of the window. */
16046 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16047 int vpos
= XFASTINT (w
->window_end_vpos
);
16048 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16049 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16052 row
== NULL
&& vpos
>= first_vpos
;
16053 --vpos
, --current_row
, --desired_row
)
16055 if (desired_row
->enabled_p
)
16057 if (desired_row
->displays_text_p
)
16060 else if (current_row
->displays_text_p
)
16064 xassert (row
!= NULL
);
16065 w
->window_end_vpos
= make_number (vpos
+ 1);
16066 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16067 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16068 xassert (w
->window_end_bytepos
>= 0);
16069 IF_DEBUG (debug_method_add (w
, "C"));
16074 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16075 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16077 /* Record that display has not been completed. */
16078 w
->window_end_valid
= Qnil
;
16079 w
->desired_matrix
->no_scrolling_p
= 1;
16087 /***********************************************************************
16088 More debugging support
16089 ***********************************************************************/
16093 void dump_glyph_row (struct glyph_row
*, int, int);
16094 void dump_glyph_matrix (struct glyph_matrix
*, int);
16095 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16098 /* Dump the contents of glyph matrix MATRIX on stderr.
16100 GLYPHS 0 means don't show glyph contents.
16101 GLYPHS 1 means show glyphs in short form
16102 GLYPHS > 1 means show glyphs in long form. */
16105 dump_glyph_matrix (matrix
, glyphs
)
16106 struct glyph_matrix
*matrix
;
16110 for (i
= 0; i
< matrix
->nrows
; ++i
)
16111 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16115 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16116 the glyph row and area where the glyph comes from. */
16119 dump_glyph (row
, glyph
, area
)
16120 struct glyph_row
*row
;
16121 struct glyph
*glyph
;
16124 if (glyph
->type
== CHAR_GLYPH
)
16127 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16128 glyph
- row
->glyphs
[TEXT_AREA
],
16131 (BUFFERP (glyph
->object
)
16133 : (STRINGP (glyph
->object
)
16136 glyph
->pixel_width
,
16138 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16142 glyph
->left_box_line_p
,
16143 glyph
->right_box_line_p
);
16145 else if (glyph
->type
== STRETCH_GLYPH
)
16148 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16149 glyph
- row
->glyphs
[TEXT_AREA
],
16152 (BUFFERP (glyph
->object
)
16154 : (STRINGP (glyph
->object
)
16157 glyph
->pixel_width
,
16161 glyph
->left_box_line_p
,
16162 glyph
->right_box_line_p
);
16164 else if (glyph
->type
== IMAGE_GLYPH
)
16167 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16168 glyph
- row
->glyphs
[TEXT_AREA
],
16171 (BUFFERP (glyph
->object
)
16173 : (STRINGP (glyph
->object
)
16176 glyph
->pixel_width
,
16180 glyph
->left_box_line_p
,
16181 glyph
->right_box_line_p
);
16183 else if (glyph
->type
== COMPOSITE_GLYPH
)
16186 " %5d %4c %6d %c %3d 0x%05x",
16187 glyph
- row
->glyphs
[TEXT_AREA
],
16190 (BUFFERP (glyph
->object
)
16192 : (STRINGP (glyph
->object
)
16195 glyph
->pixel_width
,
16197 if (glyph
->u
.cmp
.automatic
)
16200 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16201 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16203 glyph
->left_box_line_p
,
16204 glyph
->right_box_line_p
);
16209 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16210 GLYPHS 0 means don't show glyph contents.
16211 GLYPHS 1 means show glyphs in short form
16212 GLYPHS > 1 means show glyphs in long form. */
16215 dump_glyph_row (row
, vpos
, glyphs
)
16216 struct glyph_row
*row
;
16221 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16222 fprintf (stderr
, "======================================================================\n");
16224 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16225 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16227 MATRIX_ROW_START_CHARPOS (row
),
16228 MATRIX_ROW_END_CHARPOS (row
),
16229 row
->used
[TEXT_AREA
],
16230 row
->contains_overlapping_glyphs_p
,
16232 row
->truncated_on_left_p
,
16233 row
->truncated_on_right_p
,
16235 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16236 row
->displays_text_p
,
16239 row
->ends_in_middle_of_char_p
,
16240 row
->starts_in_middle_of_char_p
,
16246 row
->visible_height
,
16249 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16250 row
->end
.overlay_string_index
,
16251 row
->continuation_lines_width
);
16252 fprintf (stderr
, "%9d %5d\n",
16253 CHARPOS (row
->start
.string_pos
),
16254 CHARPOS (row
->end
.string_pos
));
16255 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16256 row
->end
.dpvec_index
);
16263 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16265 struct glyph
*glyph
= row
->glyphs
[area
];
16266 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16268 /* Glyph for a line end in text. */
16269 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16272 if (glyph
< glyph_end
)
16273 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16275 for (; glyph
< glyph_end
; ++glyph
)
16276 dump_glyph (row
, glyph
, area
);
16279 else if (glyphs
== 1)
16283 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16285 char *s
= (char *) alloca (row
->used
[area
] + 1);
16288 for (i
= 0; i
< row
->used
[area
]; ++i
)
16290 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16291 if (glyph
->type
== CHAR_GLYPH
16292 && glyph
->u
.ch
< 0x80
16293 && glyph
->u
.ch
>= ' ')
16294 s
[i
] = glyph
->u
.ch
;
16300 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16306 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16307 Sdump_glyph_matrix
, 0, 1, "p",
16308 doc
: /* Dump the current matrix of the selected window to stderr.
16309 Shows contents of glyph row structures. With non-nil
16310 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16311 glyphs in short form, otherwise show glyphs in long form. */)
16312 (Lisp_Object glyphs
)
16314 struct window
*w
= XWINDOW (selected_window
);
16315 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16317 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16318 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16319 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16320 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16321 fprintf (stderr
, "=============================================\n");
16322 dump_glyph_matrix (w
->current_matrix
,
16323 NILP (glyphs
) ? 0 : XINT (glyphs
));
16328 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16329 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16332 struct frame
*f
= XFRAME (selected_frame
);
16333 dump_glyph_matrix (f
->current_matrix
, 1);
16338 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16339 doc
: /* Dump glyph row ROW to stderr.
16340 GLYPH 0 means don't dump glyphs.
16341 GLYPH 1 means dump glyphs in short form.
16342 GLYPH > 1 or omitted means dump glyphs in long form. */)
16343 (Lisp_Object row
, Lisp_Object glyphs
)
16345 struct glyph_matrix
*matrix
;
16348 CHECK_NUMBER (row
);
16349 matrix
= XWINDOW (selected_window
)->current_matrix
;
16351 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16352 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16354 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16359 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16360 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16361 GLYPH 0 means don't dump glyphs.
16362 GLYPH 1 means dump glyphs in short form.
16363 GLYPH > 1 or omitted means dump glyphs in long form. */)
16364 (Lisp_Object row
, Lisp_Object glyphs
)
16366 struct frame
*sf
= SELECTED_FRAME ();
16367 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16370 CHECK_NUMBER (row
);
16372 if (vpos
>= 0 && vpos
< m
->nrows
)
16373 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16374 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16379 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16380 doc
: /* Toggle tracing of redisplay.
16381 With ARG, turn tracing on if and only if ARG is positive. */)
16385 trace_redisplay_p
= !trace_redisplay_p
;
16388 arg
= Fprefix_numeric_value (arg
);
16389 trace_redisplay_p
= XINT (arg
) > 0;
16396 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16397 doc
: /* Like `format', but print result to stderr.
16398 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16399 (int nargs
, Lisp_Object
*args
)
16401 Lisp_Object s
= Fformat (nargs
, args
);
16402 fprintf (stderr
, "%s", SDATA (s
));
16406 #endif /* GLYPH_DEBUG */
16410 /***********************************************************************
16411 Building Desired Matrix Rows
16412 ***********************************************************************/
16414 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16415 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16417 static struct glyph_row
*
16418 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16420 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16421 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16422 struct buffer
*old
= current_buffer
;
16423 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16424 int arrow_len
= SCHARS (overlay_arrow_string
);
16425 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16426 const unsigned char *p
;
16429 int n_glyphs_before
;
16431 set_buffer_temp (buffer
);
16432 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16433 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16434 SET_TEXT_POS (it
.position
, 0, 0);
16436 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16438 while (p
< arrow_end
)
16440 Lisp_Object face
, ilisp
;
16442 /* Get the next character. */
16444 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16447 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16448 if (! ASCII_CHAR_P (it
.c
))
16449 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16453 /* Get its face. */
16454 ilisp
= make_number (p
- arrow_string
);
16455 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16456 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16458 /* Compute its width, get its glyphs. */
16459 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16460 SET_TEXT_POS (it
.position
, -1, -1);
16461 PRODUCE_GLYPHS (&it
);
16463 /* If this character doesn't fit any more in the line, we have
16464 to remove some glyphs. */
16465 if (it
.current_x
> it
.last_visible_x
)
16467 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16472 set_buffer_temp (old
);
16473 return it
.glyph_row
;
16477 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16478 glyphs are only inserted for terminal frames since we can't really
16479 win with truncation glyphs when partially visible glyphs are
16480 involved. Which glyphs to insert is determined by
16481 produce_special_glyphs. */
16484 insert_left_trunc_glyphs (struct it
*it
)
16486 struct it truncate_it
;
16487 struct glyph
*from
, *end
, *to
, *toend
;
16489 xassert (!FRAME_WINDOW_P (it
->f
));
16491 /* Get the truncation glyphs. */
16493 truncate_it
.current_x
= 0;
16494 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16495 truncate_it
.glyph_row
= &scratch_glyph_row
;
16496 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16497 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16498 truncate_it
.object
= make_number (0);
16499 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16501 /* Overwrite glyphs from IT with truncation glyphs. */
16502 if (!it
->glyph_row
->reversed_p
)
16504 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16505 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16506 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16507 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16512 /* There may be padding glyphs left over. Overwrite them too. */
16513 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16515 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16521 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16525 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16526 that back to front. */
16527 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16528 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16529 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16530 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16532 while (from
>= end
&& to
>= toend
)
16534 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16537 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16538 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16539 while (from
>= end
&& to
>= toend
)
16544 /* Need to free some room before prepending additional
16546 int move_by
= from
- end
+ 1;
16547 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16548 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16550 for ( ; g
>= g0
; g
--)
16552 while (from
>= end
)
16554 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16560 /* Compute the pixel height and width of IT->glyph_row.
16562 Most of the time, ascent and height of a display line will be equal
16563 to the max_ascent and max_height values of the display iterator
16564 structure. This is not the case if
16566 1. We hit ZV without displaying anything. In this case, max_ascent
16567 and max_height will be zero.
16569 2. We have some glyphs that don't contribute to the line height.
16570 (The glyph row flag contributes_to_line_height_p is for future
16571 pixmap extensions).
16573 The first case is easily covered by using default values because in
16574 these cases, the line height does not really matter, except that it
16575 must not be zero. */
16578 compute_line_metrics (struct it
*it
)
16580 struct glyph_row
*row
= it
->glyph_row
;
16582 if (FRAME_WINDOW_P (it
->f
))
16584 int i
, min_y
, max_y
;
16586 /* The line may consist of one space only, that was added to
16587 place the cursor on it. If so, the row's height hasn't been
16589 if (row
->height
== 0)
16591 if (it
->max_ascent
+ it
->max_descent
== 0)
16592 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16593 row
->ascent
= it
->max_ascent
;
16594 row
->height
= it
->max_ascent
+ it
->max_descent
;
16595 row
->phys_ascent
= it
->max_phys_ascent
;
16596 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16597 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16600 /* Compute the width of this line. */
16601 row
->pixel_width
= row
->x
;
16602 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16603 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16605 xassert (row
->pixel_width
>= 0);
16606 xassert (row
->ascent
>= 0 && row
->height
> 0);
16608 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16609 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16611 /* If first line's physical ascent is larger than its logical
16612 ascent, use the physical ascent, and make the row taller.
16613 This makes accented characters fully visible. */
16614 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16615 && row
->phys_ascent
> row
->ascent
)
16617 row
->height
+= row
->phys_ascent
- row
->ascent
;
16618 row
->ascent
= row
->phys_ascent
;
16621 /* Compute how much of the line is visible. */
16622 row
->visible_height
= row
->height
;
16624 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16625 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16627 if (row
->y
< min_y
)
16628 row
->visible_height
-= min_y
- row
->y
;
16629 if (row
->y
+ row
->height
> max_y
)
16630 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16634 row
->pixel_width
= row
->used
[TEXT_AREA
];
16635 if (row
->continued_p
)
16636 row
->pixel_width
-= it
->continuation_pixel_width
;
16637 else if (row
->truncated_on_right_p
)
16638 row
->pixel_width
-= it
->truncation_pixel_width
;
16639 row
->ascent
= row
->phys_ascent
= 0;
16640 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16641 row
->extra_line_spacing
= 0;
16644 /* Compute a hash code for this row. */
16648 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16649 for (i
= 0; i
< row
->used
[area
]; ++i
)
16650 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16651 + row
->glyphs
[area
][i
].u
.val
16652 + row
->glyphs
[area
][i
].face_id
16653 + row
->glyphs
[area
][i
].padding_p
16654 + (row
->glyphs
[area
][i
].type
<< 2));
16657 it
->max_ascent
= it
->max_descent
= 0;
16658 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16662 /* Append one space to the glyph row of iterator IT if doing a
16663 window-based redisplay. The space has the same face as
16664 IT->face_id. Value is non-zero if a space was added.
16666 This function is called to make sure that there is always one glyph
16667 at the end of a glyph row that the cursor can be set on under
16668 window-systems. (If there weren't such a glyph we would not know
16669 how wide and tall a box cursor should be displayed).
16671 At the same time this space let's a nicely handle clearing to the
16672 end of the line if the row ends in italic text. */
16675 append_space_for_newline (struct it
*it
, int default_face_p
)
16677 if (FRAME_WINDOW_P (it
->f
))
16679 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16681 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16682 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16684 /* Save some values that must not be changed.
16685 Must save IT->c and IT->len because otherwise
16686 ITERATOR_AT_END_P wouldn't work anymore after
16687 append_space_for_newline has been called. */
16688 enum display_element_type saved_what
= it
->what
;
16689 int saved_c
= it
->c
, saved_len
= it
->len
;
16690 int saved_char_to_display
= it
->char_to_display
;
16691 int saved_x
= it
->current_x
;
16692 int saved_face_id
= it
->face_id
;
16693 struct text_pos saved_pos
;
16694 Lisp_Object saved_object
;
16697 saved_object
= it
->object
;
16698 saved_pos
= it
->position
;
16700 it
->what
= IT_CHARACTER
;
16701 memset (&it
->position
, 0, sizeof it
->position
);
16702 it
->object
= make_number (0);
16703 it
->c
= it
->char_to_display
= ' ';
16706 if (default_face_p
)
16707 it
->face_id
= DEFAULT_FACE_ID
;
16708 else if (it
->face_before_selective_p
)
16709 it
->face_id
= it
->saved_face_id
;
16710 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16711 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16713 PRODUCE_GLYPHS (it
);
16715 it
->override_ascent
= -1;
16716 it
->constrain_row_ascent_descent_p
= 0;
16717 it
->current_x
= saved_x
;
16718 it
->object
= saved_object
;
16719 it
->position
= saved_pos
;
16720 it
->what
= saved_what
;
16721 it
->face_id
= saved_face_id
;
16722 it
->len
= saved_len
;
16724 it
->char_to_display
= saved_char_to_display
;
16733 /* Extend the face of the last glyph in the text area of IT->glyph_row
16734 to the end of the display line. Called from display_line. If the
16735 glyph row is empty, add a space glyph to it so that we know the
16736 face to draw. Set the glyph row flag fill_line_p. If the glyph
16737 row is R2L, prepend a stretch glyph to cover the empty space to the
16738 left of the leftmost glyph. */
16741 extend_face_to_end_of_line (struct it
*it
)
16744 struct frame
*f
= it
->f
;
16746 /* If line is already filled, do nothing. Non window-system frames
16747 get a grace of one more ``pixel'' because their characters are
16748 1-``pixel'' wide, so they hit the equality too early. This grace
16749 is needed only for R2L rows that are not continued, to produce
16750 one extra blank where we could display the cursor. */
16751 if (it
->current_x
>= it
->last_visible_x
16752 + (!FRAME_WINDOW_P (f
)
16753 && it
->glyph_row
->reversed_p
16754 && !it
->glyph_row
->continued_p
))
16757 /* Face extension extends the background and box of IT->face_id
16758 to the end of the line. If the background equals the background
16759 of the frame, we don't have to do anything. */
16760 if (it
->face_before_selective_p
)
16761 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16763 face
= FACE_FROM_ID (f
, it
->face_id
);
16765 if (FRAME_WINDOW_P (f
)
16766 && it
->glyph_row
->displays_text_p
16767 && face
->box
== FACE_NO_BOX
16768 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16770 && !it
->glyph_row
->reversed_p
)
16773 /* Set the glyph row flag indicating that the face of the last glyph
16774 in the text area has to be drawn to the end of the text area. */
16775 it
->glyph_row
->fill_line_p
= 1;
16777 /* If current character of IT is not ASCII, make sure we have the
16778 ASCII face. This will be automatically undone the next time
16779 get_next_display_element returns a multibyte character. Note
16780 that the character will always be single byte in unibyte
16782 if (!ASCII_CHAR_P (it
->c
))
16784 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16787 if (FRAME_WINDOW_P (f
))
16789 /* If the row is empty, add a space with the current face of IT,
16790 so that we know which face to draw. */
16791 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16793 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16794 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16795 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16797 #ifdef HAVE_WINDOW_SYSTEM
16798 if (it
->glyph_row
->reversed_p
)
16800 /* Prepend a stretch glyph to the row, such that the
16801 rightmost glyph will be drawn flushed all the way to the
16802 right margin of the window. The stretch glyph that will
16803 occupy the empty space, if any, to the left of the
16805 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16806 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16807 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16809 int row_width
, stretch_ascent
, stretch_width
;
16810 struct text_pos saved_pos
;
16811 int saved_face_id
, saved_avoid_cursor
;
16813 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16814 row_width
+= g
->pixel_width
;
16815 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16816 if (stretch_width
> 0)
16819 (((it
->ascent
+ it
->descent
)
16820 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16821 saved_pos
= it
->position
;
16822 memset (&it
->position
, 0, sizeof it
->position
);
16823 saved_avoid_cursor
= it
->avoid_cursor_p
;
16824 it
->avoid_cursor_p
= 1;
16825 saved_face_id
= it
->face_id
;
16826 /* The last row's stretch glyph should get the default
16827 face, to avoid painting the rest of the window with
16828 the region face, if the region ends at ZV. */
16829 if (it
->glyph_row
->ends_at_zv_p
)
16830 it
->face_id
= DEFAULT_FACE_ID
;
16832 it
->face_id
= face
->id
;
16833 append_stretch_glyph (it
, make_number (0), stretch_width
,
16834 it
->ascent
+ it
->descent
, stretch_ascent
);
16835 it
->position
= saved_pos
;
16836 it
->avoid_cursor_p
= saved_avoid_cursor
;
16837 it
->face_id
= saved_face_id
;
16840 #endif /* HAVE_WINDOW_SYSTEM */
16844 /* Save some values that must not be changed. */
16845 int saved_x
= it
->current_x
;
16846 struct text_pos saved_pos
;
16847 Lisp_Object saved_object
;
16848 enum display_element_type saved_what
= it
->what
;
16849 int saved_face_id
= it
->face_id
;
16851 saved_object
= it
->object
;
16852 saved_pos
= it
->position
;
16854 it
->what
= IT_CHARACTER
;
16855 memset (&it
->position
, 0, sizeof it
->position
);
16856 it
->object
= make_number (0);
16857 it
->c
= it
->char_to_display
= ' ';
16859 /* The last row's blank glyphs should get the default face, to
16860 avoid painting the rest of the window with the region face,
16861 if the region ends at ZV. */
16862 if (it
->glyph_row
->ends_at_zv_p
)
16863 it
->face_id
= DEFAULT_FACE_ID
;
16865 it
->face_id
= face
->id
;
16867 PRODUCE_GLYPHS (it
);
16869 while (it
->current_x
<= it
->last_visible_x
)
16870 PRODUCE_GLYPHS (it
);
16872 /* Don't count these blanks really. It would let us insert a left
16873 truncation glyph below and make us set the cursor on them, maybe. */
16874 it
->current_x
= saved_x
;
16875 it
->object
= saved_object
;
16876 it
->position
= saved_pos
;
16877 it
->what
= saved_what
;
16878 it
->face_id
= saved_face_id
;
16883 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16884 trailing whitespace. */
16887 trailing_whitespace_p (EMACS_INT charpos
)
16889 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16892 while (bytepos
< ZV_BYTE
16893 && (c
= FETCH_CHAR (bytepos
),
16894 c
== ' ' || c
== '\t'))
16897 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16899 if (bytepos
!= PT_BYTE
)
16906 /* Highlight trailing whitespace, if any, in ROW. */
16909 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16911 int used
= row
->used
[TEXT_AREA
];
16915 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16916 struct glyph
*glyph
= start
+ used
- 1;
16918 if (row
->reversed_p
)
16920 /* Right-to-left rows need to be processed in the opposite
16921 direction, so swap the edge pointers. */
16923 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16926 /* Skip over glyphs inserted to display the cursor at the
16927 end of a line, for extending the face of the last glyph
16928 to the end of the line on terminals, and for truncation
16929 and continuation glyphs. */
16930 if (!row
->reversed_p
)
16932 while (glyph
>= start
16933 && glyph
->type
== CHAR_GLYPH
16934 && INTEGERP (glyph
->object
))
16939 while (glyph
<= start
16940 && glyph
->type
== CHAR_GLYPH
16941 && INTEGERP (glyph
->object
))
16945 /* If last glyph is a space or stretch, and it's trailing
16946 whitespace, set the face of all trailing whitespace glyphs in
16947 IT->glyph_row to `trailing-whitespace'. */
16948 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16949 && BUFFERP (glyph
->object
)
16950 && (glyph
->type
== STRETCH_GLYPH
16951 || (glyph
->type
== CHAR_GLYPH
16952 && glyph
->u
.ch
== ' '))
16953 && trailing_whitespace_p (glyph
->charpos
))
16955 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16959 if (!row
->reversed_p
)
16961 while (glyph
>= start
16962 && BUFFERP (glyph
->object
)
16963 && (glyph
->type
== STRETCH_GLYPH
16964 || (glyph
->type
== CHAR_GLYPH
16965 && glyph
->u
.ch
== ' ')))
16966 (glyph
--)->face_id
= face_id
;
16970 while (glyph
<= start
16971 && BUFFERP (glyph
->object
)
16972 && (glyph
->type
== STRETCH_GLYPH
16973 || (glyph
->type
== CHAR_GLYPH
16974 && glyph
->u
.ch
== ' ')))
16975 (glyph
++)->face_id
= face_id
;
16982 /* Value is non-zero if glyph row ROW in window W should be
16983 used to hold the cursor. */
16986 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
16990 if (PT
== CHARPOS (row
->end
.pos
))
16992 /* Suppose the row ends on a string.
16993 Unless the row is continued, that means it ends on a newline
16994 in the string. If it's anything other than a display string
16995 (e.g. a before-string from an overlay), we don't want the
16996 cursor there. (This heuristic seems to give the optimal
16997 behavior for the various types of multi-line strings.) */
16998 if (CHARPOS (row
->end
.string_pos
) >= 0)
17000 if (row
->continued_p
)
17004 /* Check for `display' property. */
17005 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17006 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17007 struct glyph
*glyph
;
17010 for (glyph
= end
; glyph
>= beg
; --glyph
)
17011 if (STRINGP (glyph
->object
))
17014 = Fget_char_property (make_number (PT
),
17018 && display_prop_string_p (prop
, glyph
->object
));
17023 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17025 /* If the row ends in middle of a real character,
17026 and the line is continued, we want the cursor here.
17027 That's because CHARPOS (ROW->end.pos) would equal
17028 PT if PT is before the character. */
17029 if (!row
->ends_in_ellipsis_p
)
17030 result
= row
->continued_p
;
17032 /* If the row ends in an ellipsis, then
17033 CHARPOS (ROW->end.pos) will equal point after the
17034 invisible text. We want that position to be displayed
17035 after the ellipsis. */
17038 /* If the row ends at ZV, display the cursor at the end of that
17039 row instead of at the start of the row below. */
17040 else if (row
->ends_at_zv_p
)
17051 /* Push the display property PROP so that it will be rendered at the
17052 current position in IT. Return 1 if PROP was successfully pushed,
17056 push_display_prop (struct it
*it
, Lisp_Object prop
)
17060 if (STRINGP (prop
))
17062 if (SCHARS (prop
) == 0)
17069 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17070 it
->current
.overlay_string_index
= -1;
17071 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17072 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17073 it
->method
= GET_FROM_STRING
;
17074 it
->stop_charpos
= 0;
17076 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17078 it
->method
= GET_FROM_STRETCH
;
17081 #ifdef HAVE_WINDOW_SYSTEM
17082 else if (IMAGEP (prop
))
17084 it
->what
= IT_IMAGE
;
17085 it
->image_id
= lookup_image (it
->f
, prop
);
17086 it
->method
= GET_FROM_IMAGE
;
17088 #endif /* HAVE_WINDOW_SYSTEM */
17091 pop_it (it
); /* bogus display property, give up */
17098 /* Return the character-property PROP at the current position in IT. */
17101 get_it_property (struct it
*it
, Lisp_Object prop
)
17103 Lisp_Object position
;
17105 if (STRINGP (it
->object
))
17106 position
= make_number (IT_STRING_CHARPOS (*it
));
17107 else if (BUFFERP (it
->object
))
17108 position
= make_number (IT_CHARPOS (*it
));
17112 return Fget_char_property (position
, prop
, it
->object
);
17115 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17118 handle_line_prefix (struct it
*it
)
17120 Lisp_Object prefix
;
17121 if (it
->continuation_lines_width
> 0)
17123 prefix
= get_it_property (it
, Qwrap_prefix
);
17125 prefix
= Vwrap_prefix
;
17129 prefix
= get_it_property (it
, Qline_prefix
);
17131 prefix
= Vline_prefix
;
17133 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17135 /* If the prefix is wider than the window, and we try to wrap
17136 it, it would acquire its own wrap prefix, and so on till the
17137 iterator stack overflows. So, don't wrap the prefix. */
17138 it
->line_wrap
= TRUNCATE
;
17139 it
->avoid_cursor_p
= 1;
17145 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17146 only for R2L lines from display_line, when it decides that too many
17147 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17150 unproduce_glyphs (struct it
*it
, int n
)
17152 struct glyph
*glyph
, *end
;
17154 xassert (it
->glyph_row
);
17155 xassert (it
->glyph_row
->reversed_p
);
17156 xassert (it
->area
== TEXT_AREA
);
17157 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17159 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17160 n
= it
->glyph_row
->used
[TEXT_AREA
];
17161 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17162 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17163 for ( ; glyph
< end
; glyph
++)
17164 glyph
[-n
] = *glyph
;
17167 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17168 and ROW->maxpos. */
17170 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17171 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17172 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17174 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17175 lines' rows is implemented for bidi-reordered rows. */
17177 /* ROW->minpos is the value of min_pos, the minimal buffer position
17180 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17182 /* We didn't find _any_ valid buffer positions in any of the
17183 glyphs, so we must trust the iterator's computed positions. */
17184 row
->minpos
= row
->start
.pos
;
17187 max_pos
= CHARPOS (it
->current
.pos
);
17188 max_bpos
= BYTEPOS (it
->current
.pos
);
17191 /* Here are the various use-cases for ending the row, and the
17192 corresponding values for ROW->maxpos:
17194 Line ends in a newline from buffer eol_pos + 1
17195 Line is continued from buffer max_pos + 1
17196 Line is truncated on right it->current.pos
17197 Line ends in a newline from string max_pos
17198 Line is continued from string max_pos
17199 Line is continued from display vector max_pos
17200 Line is entirely from a string min_pos == max_pos
17201 Line is entirely from a display vector min_pos == max_pos
17202 Line that ends at ZV ZV
17204 If you discover other use-cases, please add them here as
17206 if (row
->ends_at_zv_p
)
17207 row
->maxpos
= it
->current
.pos
;
17208 else if (row
->used
[TEXT_AREA
])
17210 if (row
->ends_in_newline_from_string_p
)
17211 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17212 else if (CHARPOS (it
->eol_pos
) > 0)
17213 SET_TEXT_POS (row
->maxpos
,
17214 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17215 else if (row
->continued_p
)
17217 /* If max_pos is different from IT's current position, it
17218 means IT->method does not belong to the display element
17219 at max_pos. However, it also means that the display
17220 element at max_pos was displayed in its entirety on this
17221 line, which is equivalent to saying that the next line
17222 starts at the next buffer position. */
17223 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17224 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17227 INC_BOTH (max_pos
, max_bpos
);
17228 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17231 else if (row
->truncated_on_right_p
)
17232 /* display_line already called reseat_at_next_visible_line_start,
17233 which puts the iterator at the beginning of the next line, in
17234 the logical order. */
17235 row
->maxpos
= it
->current
.pos
;
17236 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17237 /* A line that is entirely from a string/image/stretch... */
17238 row
->maxpos
= row
->minpos
;
17243 row
->maxpos
= it
->current
.pos
;
17246 /* Construct the glyph row IT->glyph_row in the desired matrix of
17247 IT->w from text at the current position of IT. See dispextern.h
17248 for an overview of struct it. Value is non-zero if
17249 IT->glyph_row displays text, as opposed to a line displaying ZV
17253 display_line (struct it
*it
)
17255 struct glyph_row
*row
= it
->glyph_row
;
17256 Lisp_Object overlay_arrow_string
;
17258 int may_wrap
= 0, wrap_x
;
17259 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17260 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17261 int wrap_row_extra_line_spacing
;
17262 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17263 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17265 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17267 /* We always start displaying at hpos zero even if hscrolled. */
17268 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17270 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17271 >= it
->w
->desired_matrix
->nrows
)
17273 it
->w
->nrows_scale_factor
++;
17274 fonts_changed_p
= 1;
17278 /* Is IT->w showing the region? */
17279 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17281 /* Clear the result glyph row and enable it. */
17282 prepare_desired_row (row
);
17284 row
->y
= it
->current_y
;
17285 row
->start
= it
->start
;
17286 row
->continuation_lines_width
= it
->continuation_lines_width
;
17287 row
->displays_text_p
= 1;
17288 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17289 it
->starts_in_middle_of_char_p
= 0;
17291 /* Arrange the overlays nicely for our purposes. Usually, we call
17292 display_line on only one line at a time, in which case this
17293 can't really hurt too much, or we call it on lines which appear
17294 one after another in the buffer, in which case all calls to
17295 recenter_overlay_lists but the first will be pretty cheap. */
17296 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17298 /* Move over display elements that are not visible because we are
17299 hscrolled. This may stop at an x-position < IT->first_visible_x
17300 if the first glyph is partially visible or if we hit a line end. */
17301 if (it
->current_x
< it
->first_visible_x
)
17303 this_line_min_pos
= row
->start
.pos
;
17304 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17305 MOVE_TO_POS
| MOVE_TO_X
);
17306 /* Record the smallest positions seen while we moved over
17307 display elements that are not visible. This is needed by
17308 redisplay_internal for optimizing the case where the cursor
17309 stays inside the same line. The rest of this function only
17310 considers positions that are actually displayed, so
17311 RECORD_MAX_MIN_POS will not otherwise record positions that
17312 are hscrolled to the left of the left edge of the window. */
17313 min_pos
= CHARPOS (this_line_min_pos
);
17314 min_bpos
= BYTEPOS (this_line_min_pos
);
17318 /* We only do this when not calling `move_it_in_display_line_to'
17319 above, because move_it_in_display_line_to calls
17320 handle_line_prefix itself. */
17321 handle_line_prefix (it
);
17324 /* Get the initial row height. This is either the height of the
17325 text hscrolled, if there is any, or zero. */
17326 row
->ascent
= it
->max_ascent
;
17327 row
->height
= it
->max_ascent
+ it
->max_descent
;
17328 row
->phys_ascent
= it
->max_phys_ascent
;
17329 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17330 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17332 /* Utility macro to record max and min buffer positions seen until now. */
17333 #define RECORD_MAX_MIN_POS(IT) \
17336 if (IT_CHARPOS (*(IT)) < min_pos) \
17338 min_pos = IT_CHARPOS (*(IT)); \
17339 min_bpos = IT_BYTEPOS (*(IT)); \
17341 if (IT_CHARPOS (*(IT)) > max_pos) \
17343 max_pos = IT_CHARPOS (*(IT)); \
17344 max_bpos = IT_BYTEPOS (*(IT)); \
17349 /* Loop generating characters. The loop is left with IT on the next
17350 character to display. */
17353 int n_glyphs_before
, hpos_before
, x_before
;
17355 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17357 /* Retrieve the next thing to display. Value is zero if end of
17359 if (!get_next_display_element (it
))
17361 /* Maybe add a space at the end of this line that is used to
17362 display the cursor there under X. Set the charpos of the
17363 first glyph of blank lines not corresponding to any text
17365 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17366 row
->exact_window_width_line_p
= 1;
17367 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17368 || row
->used
[TEXT_AREA
] == 0)
17370 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17371 row
->displays_text_p
= 0;
17373 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17374 && (!MINI_WINDOW_P (it
->w
)
17375 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17376 row
->indicate_empty_line_p
= 1;
17379 it
->continuation_lines_width
= 0;
17380 row
->ends_at_zv_p
= 1;
17381 /* A row that displays right-to-left text must always have
17382 its last face extended all the way to the end of line,
17383 even if this row ends in ZV, because we still write to
17384 the screen left to right. */
17385 if (row
->reversed_p
)
17386 extend_face_to_end_of_line (it
);
17390 /* Now, get the metrics of what we want to display. This also
17391 generates glyphs in `row' (which is IT->glyph_row). */
17392 n_glyphs_before
= row
->used
[TEXT_AREA
];
17395 /* Remember the line height so far in case the next element doesn't
17396 fit on the line. */
17397 if (it
->line_wrap
!= TRUNCATE
)
17399 ascent
= it
->max_ascent
;
17400 descent
= it
->max_descent
;
17401 phys_ascent
= it
->max_phys_ascent
;
17402 phys_descent
= it
->max_phys_descent
;
17404 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17406 if (IT_DISPLAYING_WHITESPACE (it
))
17412 wrap_row_used
= row
->used
[TEXT_AREA
];
17413 wrap_row_ascent
= row
->ascent
;
17414 wrap_row_height
= row
->height
;
17415 wrap_row_phys_ascent
= row
->phys_ascent
;
17416 wrap_row_phys_height
= row
->phys_height
;
17417 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17418 wrap_row_min_pos
= min_pos
;
17419 wrap_row_min_bpos
= min_bpos
;
17420 wrap_row_max_pos
= max_pos
;
17421 wrap_row_max_bpos
= max_bpos
;
17427 PRODUCE_GLYPHS (it
);
17429 /* If this display element was in marginal areas, continue with
17431 if (it
->area
!= TEXT_AREA
)
17433 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17434 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17435 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17436 row
->phys_height
= max (row
->phys_height
,
17437 it
->max_phys_ascent
+ it
->max_phys_descent
);
17438 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17439 it
->max_extra_line_spacing
);
17440 set_iterator_to_next (it
, 1);
17444 /* Does the display element fit on the line? If we truncate
17445 lines, we should draw past the right edge of the window. If
17446 we don't truncate, we want to stop so that we can display the
17447 continuation glyph before the right margin. If lines are
17448 continued, there are two possible strategies for characters
17449 resulting in more than 1 glyph (e.g. tabs): Display as many
17450 glyphs as possible in this line and leave the rest for the
17451 continuation line, or display the whole element in the next
17452 line. Original redisplay did the former, so we do it also. */
17453 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17454 hpos_before
= it
->hpos
;
17457 if (/* Not a newline. */
17459 /* Glyphs produced fit entirely in the line. */
17460 && it
->current_x
< it
->last_visible_x
)
17462 it
->hpos
+= nglyphs
;
17463 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17464 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17465 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17466 row
->phys_height
= max (row
->phys_height
,
17467 it
->max_phys_ascent
+ it
->max_phys_descent
);
17468 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17469 it
->max_extra_line_spacing
);
17470 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17471 row
->x
= x
- it
->first_visible_x
;
17472 /* Record the maximum and minimum buffer positions seen so
17473 far in glyphs that will be displayed by this row. */
17475 RECORD_MAX_MIN_POS (it
);
17480 struct glyph
*glyph
;
17482 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17484 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17485 new_x
= x
+ glyph
->pixel_width
;
17487 if (/* Lines are continued. */
17488 it
->line_wrap
!= TRUNCATE
17489 && (/* Glyph doesn't fit on the line. */
17490 new_x
> it
->last_visible_x
17491 /* Or it fits exactly on a window system frame. */
17492 || (new_x
== it
->last_visible_x
17493 && FRAME_WINDOW_P (it
->f
))))
17495 /* End of a continued line. */
17498 || (new_x
== it
->last_visible_x
17499 && FRAME_WINDOW_P (it
->f
)))
17501 /* Current glyph is the only one on the line or
17502 fits exactly on the line. We must continue
17503 the line because we can't draw the cursor
17504 after the glyph. */
17505 row
->continued_p
= 1;
17506 it
->current_x
= new_x
;
17507 it
->continuation_lines_width
+= new_x
;
17509 /* Record the maximum and minimum buffer
17510 positions seen so far in glyphs that will be
17511 displayed by this row. */
17513 RECORD_MAX_MIN_POS (it
);
17514 if (i
== nglyphs
- 1)
17516 /* If line-wrap is on, check if a previous
17517 wrap point was found. */
17518 if (wrap_row_used
> 0
17519 /* Even if there is a previous wrap
17520 point, continue the line here as
17521 usual, if (i) the previous character
17522 was a space or tab AND (ii) the
17523 current character is not. */
17525 || IT_DISPLAYING_WHITESPACE (it
)))
17528 set_iterator_to_next (it
, 1);
17529 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17531 if (!get_next_display_element (it
))
17533 row
->exact_window_width_line_p
= 1;
17534 it
->continuation_lines_width
= 0;
17535 row
->continued_p
= 0;
17536 row
->ends_at_zv_p
= 1;
17538 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17540 row
->continued_p
= 0;
17541 row
->exact_window_width_line_p
= 1;
17546 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17547 && !FRAME_WINDOW_P (it
->f
))
17549 /* A padding glyph that doesn't fit on this line.
17550 This means the whole character doesn't fit
17552 if (row
->reversed_p
)
17553 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17554 - n_glyphs_before
);
17555 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17557 /* Fill the rest of the row with continuation
17558 glyphs like in 20.x. */
17559 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17560 < row
->glyphs
[1 + TEXT_AREA
])
17561 produce_special_glyphs (it
, IT_CONTINUATION
);
17563 row
->continued_p
= 1;
17564 it
->current_x
= x_before
;
17565 it
->continuation_lines_width
+= x_before
;
17567 /* Restore the height to what it was before the
17568 element not fitting on the line. */
17569 it
->max_ascent
= ascent
;
17570 it
->max_descent
= descent
;
17571 it
->max_phys_ascent
= phys_ascent
;
17572 it
->max_phys_descent
= phys_descent
;
17574 else if (wrap_row_used
> 0)
17577 if (row
->reversed_p
)
17578 unproduce_glyphs (it
,
17579 row
->used
[TEXT_AREA
] - wrap_row_used
);
17581 it
->continuation_lines_width
+= wrap_x
;
17582 row
->used
[TEXT_AREA
] = wrap_row_used
;
17583 row
->ascent
= wrap_row_ascent
;
17584 row
->height
= wrap_row_height
;
17585 row
->phys_ascent
= wrap_row_phys_ascent
;
17586 row
->phys_height
= wrap_row_phys_height
;
17587 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17588 min_pos
= wrap_row_min_pos
;
17589 min_bpos
= wrap_row_min_bpos
;
17590 max_pos
= wrap_row_max_pos
;
17591 max_bpos
= wrap_row_max_bpos
;
17592 row
->continued_p
= 1;
17593 row
->ends_at_zv_p
= 0;
17594 row
->exact_window_width_line_p
= 0;
17595 it
->continuation_lines_width
+= x
;
17597 /* Make sure that a non-default face is extended
17598 up to the right margin of the window. */
17599 extend_face_to_end_of_line (it
);
17601 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17603 /* A TAB that extends past the right edge of the
17604 window. This produces a single glyph on
17605 window system frames. We leave the glyph in
17606 this row and let it fill the row, but don't
17607 consume the TAB. */
17608 it
->continuation_lines_width
+= it
->last_visible_x
;
17609 row
->ends_in_middle_of_char_p
= 1;
17610 row
->continued_p
= 1;
17611 glyph
->pixel_width
= it
->last_visible_x
- x
;
17612 it
->starts_in_middle_of_char_p
= 1;
17616 /* Something other than a TAB that draws past
17617 the right edge of the window. Restore
17618 positions to values before the element. */
17619 if (row
->reversed_p
)
17620 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17621 - (n_glyphs_before
+ i
));
17622 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17624 /* Display continuation glyphs. */
17625 if (!FRAME_WINDOW_P (it
->f
))
17626 produce_special_glyphs (it
, IT_CONTINUATION
);
17627 row
->continued_p
= 1;
17629 it
->current_x
= x_before
;
17630 it
->continuation_lines_width
+= x
;
17631 extend_face_to_end_of_line (it
);
17633 if (nglyphs
> 1 && i
> 0)
17635 row
->ends_in_middle_of_char_p
= 1;
17636 it
->starts_in_middle_of_char_p
= 1;
17639 /* Restore the height to what it was before the
17640 element not fitting on the line. */
17641 it
->max_ascent
= ascent
;
17642 it
->max_descent
= descent
;
17643 it
->max_phys_ascent
= phys_ascent
;
17644 it
->max_phys_descent
= phys_descent
;
17649 else if (new_x
> it
->first_visible_x
)
17651 /* Increment number of glyphs actually displayed. */
17654 /* Record the maximum and minimum buffer positions
17655 seen so far in glyphs that will be displayed by
17658 RECORD_MAX_MIN_POS (it
);
17660 if (x
< it
->first_visible_x
)
17661 /* Glyph is partially visible, i.e. row starts at
17662 negative X position. */
17663 row
->x
= x
- it
->first_visible_x
;
17667 /* Glyph is completely off the left margin of the
17668 window. This should not happen because of the
17669 move_it_in_display_line at the start of this
17670 function, unless the text display area of the
17671 window is empty. */
17672 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17676 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17677 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17678 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17679 row
->phys_height
= max (row
->phys_height
,
17680 it
->max_phys_ascent
+ it
->max_phys_descent
);
17681 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17682 it
->max_extra_line_spacing
);
17684 /* End of this display line if row is continued. */
17685 if (row
->continued_p
|| row
->ends_at_zv_p
)
17690 /* Is this a line end? If yes, we're also done, after making
17691 sure that a non-default face is extended up to the right
17692 margin of the window. */
17693 if (ITERATOR_AT_END_OF_LINE_P (it
))
17695 int used_before
= row
->used
[TEXT_AREA
];
17697 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17699 /* Add a space at the end of the line that is used to
17700 display the cursor there. */
17701 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17702 append_space_for_newline (it
, 0);
17704 /* Extend the face to the end of the line. */
17705 extend_face_to_end_of_line (it
);
17707 /* Make sure we have the position. */
17708 if (used_before
== 0)
17709 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17711 /* Record the position of the newline, for use in
17713 it
->eol_pos
= it
->current
.pos
;
17715 /* Consume the line end. This skips over invisible lines. */
17716 set_iterator_to_next (it
, 1);
17717 it
->continuation_lines_width
= 0;
17721 /* Proceed with next display element. Note that this skips
17722 over lines invisible because of selective display. */
17723 set_iterator_to_next (it
, 1);
17725 /* If we truncate lines, we are done when the last displayed
17726 glyphs reach past the right margin of the window. */
17727 if (it
->line_wrap
== TRUNCATE
17728 && (FRAME_WINDOW_P (it
->f
)
17729 ? (it
->current_x
>= it
->last_visible_x
)
17730 : (it
->current_x
> it
->last_visible_x
)))
17732 /* Maybe add truncation glyphs. */
17733 if (!FRAME_WINDOW_P (it
->f
))
17737 if (!row
->reversed_p
)
17739 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17740 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17745 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17746 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17748 /* Remove any padding glyphs at the front of ROW, to
17749 make room for the truncation glyphs we will be
17750 adding below. The loop below always inserts at
17751 least one truncation glyph, so also remove the
17752 last glyph added to ROW. */
17753 unproduce_glyphs (it
, i
+ 1);
17754 /* Adjust i for the loop below. */
17755 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17758 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17760 row
->used
[TEXT_AREA
] = i
;
17761 produce_special_glyphs (it
, IT_TRUNCATION
);
17764 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17766 /* Don't truncate if we can overflow newline into fringe. */
17767 if (!get_next_display_element (it
))
17769 it
->continuation_lines_width
= 0;
17770 row
->ends_at_zv_p
= 1;
17771 row
->exact_window_width_line_p
= 1;
17774 if (ITERATOR_AT_END_OF_LINE_P (it
))
17776 row
->exact_window_width_line_p
= 1;
17777 goto at_end_of_line
;
17781 row
->truncated_on_right_p
= 1;
17782 it
->continuation_lines_width
= 0;
17783 reseat_at_next_visible_line_start (it
, 0);
17784 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17785 it
->hpos
= hpos_before
;
17786 it
->current_x
= x_before
;
17791 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17792 at the left window margin. */
17793 if (it
->first_visible_x
17794 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17796 if (!FRAME_WINDOW_P (it
->f
))
17797 insert_left_trunc_glyphs (it
);
17798 row
->truncated_on_left_p
= 1;
17801 /* Remember the position at which this line ends.
17803 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17804 cannot be before the call to find_row_edges below, since that is
17805 where these positions are determined. */
17806 row
->end
= it
->current
;
17809 row
->minpos
= row
->start
.pos
;
17810 row
->maxpos
= row
->end
.pos
;
17814 /* ROW->minpos and ROW->maxpos must be the smallest and
17815 `1 + the largest' buffer positions in ROW. But if ROW was
17816 bidi-reordered, these two positions can be anywhere in the
17817 row, so we must determine them now. */
17818 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17821 /* If the start of this line is the overlay arrow-position, then
17822 mark this glyph row as the one containing the overlay arrow.
17823 This is clearly a mess with variable size fonts. It would be
17824 better to let it be displayed like cursors under X. */
17825 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17826 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17827 !NILP (overlay_arrow_string
)))
17829 /* Overlay arrow in window redisplay is a fringe bitmap. */
17830 if (STRINGP (overlay_arrow_string
))
17832 struct glyph_row
*arrow_row
17833 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17834 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17835 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17836 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17837 struct glyph
*p2
, *end
;
17839 /* Copy the arrow glyphs. */
17840 while (glyph
< arrow_end
)
17843 /* Throw away padding glyphs. */
17845 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17846 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17852 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17857 xassert (INTEGERP (overlay_arrow_string
));
17858 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17860 overlay_arrow_seen
= 1;
17863 /* Compute pixel dimensions of this line. */
17864 compute_line_metrics (it
);
17866 /* Record whether this row ends inside an ellipsis. */
17867 row
->ends_in_ellipsis_p
17868 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17869 && it
->ellipsis_p
);
17871 /* Save fringe bitmaps in this row. */
17872 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17873 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17874 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17875 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17877 it
->left_user_fringe_bitmap
= 0;
17878 it
->left_user_fringe_face_id
= 0;
17879 it
->right_user_fringe_bitmap
= 0;
17880 it
->right_user_fringe_face_id
= 0;
17882 /* Maybe set the cursor. */
17883 cvpos
= it
->w
->cursor
.vpos
;
17885 /* In bidi-reordered rows, keep checking for proper cursor
17886 position even if one has been found already, because buffer
17887 positions in such rows change non-linearly with ROW->VPOS,
17888 when a line is continued. One exception: when we are at ZV,
17889 display cursor on the first suitable glyph row, since all
17890 the empty rows after that also have their position set to ZV. */
17891 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17892 lines' rows is implemented for bidi-reordered rows. */
17894 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17895 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17896 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17897 && cursor_row_p (it
->w
, row
))
17898 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17900 /* Highlight trailing whitespace. */
17901 if (!NILP (Vshow_trailing_whitespace
))
17902 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17904 /* Prepare for the next line. This line starts horizontally at (X
17905 HPOS) = (0 0). Vertical positions are incremented. As a
17906 convenience for the caller, IT->glyph_row is set to the next
17908 it
->current_x
= it
->hpos
= 0;
17909 it
->current_y
+= row
->height
;
17910 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17913 /* The next row should by default use the same value of the
17914 reversed_p flag as this one. set_iterator_to_next decides when
17915 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17916 the flag accordingly. */
17917 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17918 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17919 it
->start
= row
->end
;
17920 return row
->displays_text_p
;
17922 #undef RECORD_MAX_MIN_POS
17925 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17926 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17927 doc
: /* Return paragraph direction at point in BUFFER.
17928 Value is either `left-to-right' or `right-to-left'.
17929 If BUFFER is omitted or nil, it defaults to the current buffer.
17931 Paragraph direction determines how the text in the paragraph is displayed.
17932 In left-to-right paragraphs, text begins at the left margin of the window
17933 and the reading direction is generally left to right. In right-to-left
17934 paragraphs, text begins at the right margin and is read from right to left.
17936 See also `bidi-paragraph-direction'. */)
17937 (Lisp_Object buffer
)
17939 struct buffer
*buf
;
17940 struct buffer
*old
;
17943 buf
= current_buffer
;
17946 CHECK_BUFFER (buffer
);
17947 buf
= XBUFFER (buffer
);
17948 old
= current_buffer
;
17951 if (NILP (BVAR (buf
, bidi_display_reordering
)))
17952 return Qleft_to_right
;
17953 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
17954 return BVAR (buf
, bidi_paragraph_direction
);
17957 /* Determine the direction from buffer text. We could try to
17958 use current_matrix if it is up to date, but this seems fast
17959 enough as it is. */
17960 struct bidi_it itb
;
17961 EMACS_INT pos
= BUF_PT (buf
);
17962 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17965 if (buf
!= current_buffer
)
17966 set_buffer_temp (buf
);
17967 /* bidi_paragraph_init finds the base direction of the paragraph
17968 by searching forward from paragraph start. We need the base
17969 direction of the current or _previous_ paragraph, so we need
17970 to make sure we are within that paragraph. To that end, find
17971 the previous non-empty line. */
17972 if (pos
>= ZV
&& pos
> BEGV
)
17975 bytepos
= CHAR_TO_BYTE (pos
);
17977 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17978 || c
== ' ' || c
== '\t' || c
== '\f')
17980 if (bytepos
<= BEGV_BYTE
)
17985 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17988 itb
.bytepos
= bytepos
;
17990 itb
.separator_limit
= -1;
17991 itb
.paragraph_dir
= NEUTRAL_DIR
;
17993 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
17994 if (buf
!= current_buffer
)
17995 set_buffer_temp (old
);
17996 switch (itb
.paragraph_dir
)
17999 return Qleft_to_right
;
18002 return Qright_to_left
;
18012 /***********************************************************************
18014 ***********************************************************************/
18016 /* Redisplay the menu bar in the frame for window W.
18018 The menu bar of X frames that don't have X toolkit support is
18019 displayed in a special window W->frame->menu_bar_window.
18021 The menu bar of terminal frames is treated specially as far as
18022 glyph matrices are concerned. Menu bar lines are not part of
18023 windows, so the update is done directly on the frame matrix rows
18024 for the menu bar. */
18027 display_menu_bar (struct window
*w
)
18029 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18034 /* Don't do all this for graphical frames. */
18036 if (FRAME_W32_P (f
))
18039 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18045 if (FRAME_NS_P (f
))
18047 #endif /* HAVE_NS */
18049 #ifdef USE_X_TOOLKIT
18050 xassert (!FRAME_WINDOW_P (f
));
18051 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18052 it
.first_visible_x
= 0;
18053 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18054 #else /* not USE_X_TOOLKIT */
18055 if (FRAME_WINDOW_P (f
))
18057 /* Menu bar lines are displayed in the desired matrix of the
18058 dummy window menu_bar_window. */
18059 struct window
*menu_w
;
18060 xassert (WINDOWP (f
->menu_bar_window
));
18061 menu_w
= XWINDOW (f
->menu_bar_window
);
18062 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18064 it
.first_visible_x
= 0;
18065 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18069 /* This is a TTY frame, i.e. character hpos/vpos are used as
18071 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18073 it
.first_visible_x
= 0;
18074 it
.last_visible_x
= FRAME_COLS (f
);
18076 #endif /* not USE_X_TOOLKIT */
18078 if (! mode_line_inverse_video
)
18079 /* Force the menu-bar to be displayed in the default face. */
18080 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18082 /* Clear all rows of the menu bar. */
18083 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18085 struct glyph_row
*row
= it
.glyph_row
+ i
;
18086 clear_glyph_row (row
);
18087 row
->enabled_p
= 1;
18088 row
->full_width_p
= 1;
18091 /* Display all items of the menu bar. */
18092 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18093 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18095 Lisp_Object string
;
18097 /* Stop at nil string. */
18098 string
= AREF (items
, i
+ 1);
18102 /* Remember where item was displayed. */
18103 ASET (items
, i
+ 3, make_number (it
.hpos
));
18105 /* Display the item, pad with one space. */
18106 if (it
.current_x
< it
.last_visible_x
)
18107 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18108 SCHARS (string
) + 1, 0, 0, -1);
18111 /* Fill out the line with spaces. */
18112 if (it
.current_x
< it
.last_visible_x
)
18113 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18115 /* Compute the total height of the lines. */
18116 compute_line_metrics (&it
);
18121 /***********************************************************************
18123 ***********************************************************************/
18125 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18126 FORCE is non-zero, redisplay mode lines unconditionally.
18127 Otherwise, redisplay only mode lines that are garbaged. Value is
18128 the number of windows whose mode lines were redisplayed. */
18131 redisplay_mode_lines (Lisp_Object window
, int force
)
18135 while (!NILP (window
))
18137 struct window
*w
= XWINDOW (window
);
18139 if (WINDOWP (w
->hchild
))
18140 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18141 else if (WINDOWP (w
->vchild
))
18142 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18144 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18145 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18147 struct text_pos lpoint
;
18148 struct buffer
*old
= current_buffer
;
18150 /* Set the window's buffer for the mode line display. */
18151 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18152 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18154 /* Point refers normally to the selected window. For any
18155 other window, set up appropriate value. */
18156 if (!EQ (window
, selected_window
))
18158 struct text_pos pt
;
18160 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18161 if (CHARPOS (pt
) < BEGV
)
18162 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18163 else if (CHARPOS (pt
) > (ZV
- 1))
18164 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18166 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18169 /* Display mode lines. */
18170 clear_glyph_matrix (w
->desired_matrix
);
18171 if (display_mode_lines (w
))
18174 w
->must_be_updated_p
= 1;
18177 /* Restore old settings. */
18178 set_buffer_internal_1 (old
);
18179 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18189 /* Display the mode and/or header line of window W. Value is the
18190 sum number of mode lines and header lines displayed. */
18193 display_mode_lines (struct window
*w
)
18195 Lisp_Object old_selected_window
, old_selected_frame
;
18198 old_selected_frame
= selected_frame
;
18199 selected_frame
= w
->frame
;
18200 old_selected_window
= selected_window
;
18201 XSETWINDOW (selected_window
, w
);
18203 /* These will be set while the mode line specs are processed. */
18204 line_number_displayed
= 0;
18205 w
->column_number_displayed
= Qnil
;
18207 if (WINDOW_WANTS_MODELINE_P (w
))
18209 struct window
*sel_w
= XWINDOW (old_selected_window
);
18211 /* Select mode line face based on the real selected window. */
18212 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18213 BVAR (current_buffer
, mode_line_format
));
18217 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18219 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18220 BVAR (current_buffer
, header_line_format
));
18224 selected_frame
= old_selected_frame
;
18225 selected_window
= old_selected_window
;
18230 /* Display mode or header line of window W. FACE_ID specifies which
18231 line to display; it is either MODE_LINE_FACE_ID or
18232 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18233 display. Value is the pixel height of the mode/header line
18237 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18241 int count
= SPECPDL_INDEX ();
18243 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18244 /* Don't extend on a previously drawn mode-line.
18245 This may happen if called from pos_visible_p. */
18246 it
.glyph_row
->enabled_p
= 0;
18247 prepare_desired_row (it
.glyph_row
);
18249 it
.glyph_row
->mode_line_p
= 1;
18251 if (! mode_line_inverse_video
)
18252 /* Force the mode-line to be displayed in the default face. */
18253 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18255 record_unwind_protect (unwind_format_mode_line
,
18256 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18258 mode_line_target
= MODE_LINE_DISPLAY
;
18260 /* Temporarily make frame's keyboard the current kboard so that
18261 kboard-local variables in the mode_line_format will get the right
18263 push_kboard (FRAME_KBOARD (it
.f
));
18264 record_unwind_save_match_data ();
18265 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18268 unbind_to (count
, Qnil
);
18270 /* Fill up with spaces. */
18271 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18273 compute_line_metrics (&it
);
18274 it
.glyph_row
->full_width_p
= 1;
18275 it
.glyph_row
->continued_p
= 0;
18276 it
.glyph_row
->truncated_on_left_p
= 0;
18277 it
.glyph_row
->truncated_on_right_p
= 0;
18279 /* Make a 3D mode-line have a shadow at its right end. */
18280 face
= FACE_FROM_ID (it
.f
, face_id
);
18281 extend_face_to_end_of_line (&it
);
18282 if (face
->box
!= FACE_NO_BOX
)
18284 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18285 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18286 last
->right_box_line_p
= 1;
18289 return it
.glyph_row
->height
;
18292 /* Move element ELT in LIST to the front of LIST.
18293 Return the updated list. */
18296 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18298 register Lisp_Object tail
, prev
;
18299 register Lisp_Object tem
;
18303 while (CONSP (tail
))
18309 /* Splice out the link TAIL. */
18311 list
= XCDR (tail
);
18313 Fsetcdr (prev
, XCDR (tail
));
18315 /* Now make it the first. */
18316 Fsetcdr (tail
, list
);
18321 tail
= XCDR (tail
);
18325 /* Not found--return unchanged LIST. */
18329 /* Contribute ELT to the mode line for window IT->w. How it
18330 translates into text depends on its data type.
18332 IT describes the display environment in which we display, as usual.
18334 DEPTH is the depth in recursion. It is used to prevent
18335 infinite recursion here.
18337 FIELD_WIDTH is the number of characters the display of ELT should
18338 occupy in the mode line, and PRECISION is the maximum number of
18339 characters to display from ELT's representation. See
18340 display_string for details.
18342 Returns the hpos of the end of the text generated by ELT.
18344 PROPS is a property list to add to any string we encounter.
18346 If RISKY is nonzero, remove (disregard) any properties in any string
18347 we encounter, and ignore :eval and :propertize.
18349 The global variable `mode_line_target' determines whether the
18350 output is passed to `store_mode_line_noprop',
18351 `store_mode_line_string', or `display_string'. */
18354 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18355 Lisp_Object elt
, Lisp_Object props
, int risky
)
18357 int n
= 0, field
, prec
;
18362 elt
= build_string ("*too-deep*");
18366 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18370 /* A string: output it and check for %-constructs within it. */
18372 EMACS_INT offset
= 0;
18374 if (SCHARS (elt
) > 0
18375 && (!NILP (props
) || risky
))
18377 Lisp_Object oprops
, aelt
;
18378 oprops
= Ftext_properties_at (make_number (0), elt
);
18380 /* If the starting string's properties are not what
18381 we want, translate the string. Also, if the string
18382 is risky, do that anyway. */
18384 if (NILP (Fequal (props
, oprops
)) || risky
)
18386 /* If the starting string has properties,
18387 merge the specified ones onto the existing ones. */
18388 if (! NILP (oprops
) && !risky
)
18392 oprops
= Fcopy_sequence (oprops
);
18394 while (CONSP (tem
))
18396 oprops
= Fplist_put (oprops
, XCAR (tem
),
18397 XCAR (XCDR (tem
)));
18398 tem
= XCDR (XCDR (tem
));
18403 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18404 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18406 /* AELT is what we want. Move it to the front
18407 without consing. */
18409 mode_line_proptrans_alist
18410 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18416 /* If AELT has the wrong props, it is useless.
18417 so get rid of it. */
18419 mode_line_proptrans_alist
18420 = Fdelq (aelt
, mode_line_proptrans_alist
);
18422 elt
= Fcopy_sequence (elt
);
18423 Fset_text_properties (make_number (0), Flength (elt
),
18425 /* Add this item to mode_line_proptrans_alist. */
18426 mode_line_proptrans_alist
18427 = Fcons (Fcons (elt
, props
),
18428 mode_line_proptrans_alist
);
18429 /* Truncate mode_line_proptrans_alist
18430 to at most 50 elements. */
18431 tem
= Fnthcdr (make_number (50),
18432 mode_line_proptrans_alist
);
18434 XSETCDR (tem
, Qnil
);
18443 prec
= precision
- n
;
18444 switch (mode_line_target
)
18446 case MODE_LINE_NOPROP
:
18447 case MODE_LINE_TITLE
:
18448 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18450 case MODE_LINE_STRING
:
18451 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18453 case MODE_LINE_DISPLAY
:
18454 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18455 0, prec
, 0, STRING_MULTIBYTE (elt
));
18462 /* Handle the non-literal case. */
18464 while ((precision
<= 0 || n
< precision
)
18465 && SREF (elt
, offset
) != 0
18466 && (mode_line_target
!= MODE_LINE_DISPLAY
18467 || it
->current_x
< it
->last_visible_x
))
18469 EMACS_INT last_offset
= offset
;
18471 /* Advance to end of string or next format specifier. */
18472 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18475 if (offset
- 1 != last_offset
)
18477 EMACS_INT nchars
, nbytes
;
18479 /* Output to end of string or up to '%'. Field width
18480 is length of string. Don't output more than
18481 PRECISION allows us. */
18484 prec
= c_string_width (SDATA (elt
) + last_offset
,
18485 offset
- last_offset
, precision
- n
,
18488 switch (mode_line_target
)
18490 case MODE_LINE_NOPROP
:
18491 case MODE_LINE_TITLE
:
18492 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18494 case MODE_LINE_STRING
:
18496 EMACS_INT bytepos
= last_offset
;
18497 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18498 EMACS_INT endpos
= (precision
<= 0
18499 ? string_byte_to_char (elt
, offset
)
18500 : charpos
+ nchars
);
18502 n
+= store_mode_line_string (NULL
,
18503 Fsubstring (elt
, make_number (charpos
),
18504 make_number (endpos
)),
18508 case MODE_LINE_DISPLAY
:
18510 EMACS_INT bytepos
= last_offset
;
18511 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18513 if (precision
<= 0)
18514 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18515 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18517 STRING_MULTIBYTE (elt
));
18522 else /* c == '%' */
18524 EMACS_INT percent_position
= offset
;
18526 /* Get the specified minimum width. Zero means
18529 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18530 field
= field
* 10 + c
- '0';
18532 /* Don't pad beyond the total padding allowed. */
18533 if (field_width
- n
> 0 && field
> field_width
- n
)
18534 field
= field_width
- n
;
18536 /* Note that either PRECISION <= 0 or N < PRECISION. */
18537 prec
= precision
- n
;
18540 n
+= display_mode_element (it
, depth
, field
, prec
,
18541 Vglobal_mode_string
, props
,
18546 EMACS_INT bytepos
, charpos
;
18548 Lisp_Object string
;
18550 bytepos
= percent_position
;
18551 charpos
= (STRING_MULTIBYTE (elt
)
18552 ? string_byte_to_char (elt
, bytepos
)
18554 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18555 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18557 switch (mode_line_target
)
18559 case MODE_LINE_NOPROP
:
18560 case MODE_LINE_TITLE
:
18561 n
+= store_mode_line_noprop (spec
, field
, prec
);
18563 case MODE_LINE_STRING
:
18565 int len
= strlen (spec
);
18566 Lisp_Object tem
= make_string (spec
, len
);
18567 props
= Ftext_properties_at (make_number (charpos
), elt
);
18568 /* Should only keep face property in props */
18569 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18572 case MODE_LINE_DISPLAY
:
18574 int nglyphs_before
, nwritten
;
18576 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18577 nwritten
= display_string (spec
, string
, elt
,
18582 /* Assign to the glyphs written above the
18583 string where the `%x' came from, position
18587 struct glyph
*glyph
18588 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18592 for (i
= 0; i
< nwritten
; ++i
)
18594 glyph
[i
].object
= elt
;
18595 glyph
[i
].charpos
= charpos
;
18612 /* A symbol: process the value of the symbol recursively
18613 as if it appeared here directly. Avoid error if symbol void.
18614 Special case: if value of symbol is a string, output the string
18617 register Lisp_Object tem
;
18619 /* If the variable is not marked as risky to set
18620 then its contents are risky to use. */
18621 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18624 tem
= Fboundp (elt
);
18627 tem
= Fsymbol_value (elt
);
18628 /* If value is a string, output that string literally:
18629 don't check for % within it. */
18633 if (!EQ (tem
, elt
))
18635 /* Give up right away for nil or t. */
18645 register Lisp_Object car
, tem
;
18647 /* A cons cell: five distinct cases.
18648 If first element is :eval or :propertize, do something special.
18649 If first element is a string or a cons, process all the elements
18650 and effectively concatenate them.
18651 If first element is a negative number, truncate displaying cdr to
18652 at most that many characters. If positive, pad (with spaces)
18653 to at least that many characters.
18654 If first element is a symbol, process the cadr or caddr recursively
18655 according to whether the symbol's value is non-nil or nil. */
18657 if (EQ (car
, QCeval
))
18659 /* An element of the form (:eval FORM) means evaluate FORM
18660 and use the result as mode line elements. */
18665 if (CONSP (XCDR (elt
)))
18668 spec
= safe_eval (XCAR (XCDR (elt
)));
18669 n
+= display_mode_element (it
, depth
, field_width
- n
,
18670 precision
- n
, spec
, props
,
18674 else if (EQ (car
, QCpropertize
))
18676 /* An element of the form (:propertize ELT PROPS...)
18677 means display ELT but applying properties PROPS. */
18682 if (CONSP (XCDR (elt
)))
18683 n
+= display_mode_element (it
, depth
, field_width
- n
,
18684 precision
- n
, XCAR (XCDR (elt
)),
18685 XCDR (XCDR (elt
)), risky
);
18687 else if (SYMBOLP (car
))
18689 tem
= Fboundp (car
);
18693 /* elt is now the cdr, and we know it is a cons cell.
18694 Use its car if CAR has a non-nil value. */
18697 tem
= Fsymbol_value (car
);
18704 /* Symbol's value is nil (or symbol is unbound)
18705 Get the cddr of the original list
18706 and if possible find the caddr and use that. */
18710 else if (!CONSP (elt
))
18715 else if (INTEGERP (car
))
18717 register int lim
= XINT (car
);
18721 /* Negative int means reduce maximum width. */
18722 if (precision
<= 0)
18725 precision
= min (precision
, -lim
);
18729 /* Padding specified. Don't let it be more than
18730 current maximum. */
18732 lim
= min (precision
, lim
);
18734 /* If that's more padding than already wanted, queue it.
18735 But don't reduce padding already specified even if
18736 that is beyond the current truncation point. */
18737 field_width
= max (lim
, field_width
);
18741 else if (STRINGP (car
) || CONSP (car
))
18743 Lisp_Object halftail
= elt
;
18747 && (precision
<= 0 || n
< precision
))
18749 n
+= display_mode_element (it
, depth
,
18750 /* Do padding only after the last
18751 element in the list. */
18752 (! CONSP (XCDR (elt
))
18755 precision
- n
, XCAR (elt
),
18759 if ((len
& 1) == 0)
18760 halftail
= XCDR (halftail
);
18761 /* Check for cycle. */
18762 if (EQ (halftail
, elt
))
18771 elt
= build_string ("*invalid*");
18775 /* Pad to FIELD_WIDTH. */
18776 if (field_width
> 0 && n
< field_width
)
18778 switch (mode_line_target
)
18780 case MODE_LINE_NOPROP
:
18781 case MODE_LINE_TITLE
:
18782 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18784 case MODE_LINE_STRING
:
18785 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18787 case MODE_LINE_DISPLAY
:
18788 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18797 /* Store a mode-line string element in mode_line_string_list.
18799 If STRING is non-null, display that C string. Otherwise, the Lisp
18800 string LISP_STRING is displayed.
18802 FIELD_WIDTH is the minimum number of output glyphs to produce.
18803 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18804 with spaces. FIELD_WIDTH <= 0 means don't pad.
18806 PRECISION is the maximum number of characters to output from
18807 STRING. PRECISION <= 0 means don't truncate the string.
18809 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18810 properties to the string.
18812 PROPS are the properties to add to the string.
18813 The mode_line_string_face face property is always added to the string.
18817 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18818 int field_width
, int precision
, Lisp_Object props
)
18823 if (string
!= NULL
)
18825 len
= strlen (string
);
18826 if (precision
> 0 && len
> precision
)
18828 lisp_string
= make_string (string
, len
);
18830 props
= mode_line_string_face_prop
;
18831 else if (!NILP (mode_line_string_face
))
18833 Lisp_Object face
= Fplist_get (props
, Qface
);
18834 props
= Fcopy_sequence (props
);
18836 face
= mode_line_string_face
;
18838 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18839 props
= Fplist_put (props
, Qface
, face
);
18841 Fadd_text_properties (make_number (0), make_number (len
),
18842 props
, lisp_string
);
18846 len
= XFASTINT (Flength (lisp_string
));
18847 if (precision
> 0 && len
> precision
)
18850 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18853 if (!NILP (mode_line_string_face
))
18857 props
= Ftext_properties_at (make_number (0), lisp_string
);
18858 face
= Fplist_get (props
, Qface
);
18860 face
= mode_line_string_face
;
18862 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18863 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18865 lisp_string
= Fcopy_sequence (lisp_string
);
18868 Fadd_text_properties (make_number (0), make_number (len
),
18869 props
, lisp_string
);
18874 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18878 if (field_width
> len
)
18880 field_width
-= len
;
18881 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18883 Fadd_text_properties (make_number (0), make_number (field_width
),
18884 props
, lisp_string
);
18885 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18893 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18895 doc
: /* Format a string out of a mode line format specification.
18896 First arg FORMAT specifies the mode line format (see `mode-line-format'
18897 for details) to use.
18899 By default, the format is evaluated for the currently selected window.
18901 Optional second arg FACE specifies the face property to put on all
18902 characters for which no face is specified. The value nil means the
18903 default face. The value t means whatever face the window's mode line
18904 currently uses (either `mode-line' or `mode-line-inactive',
18905 depending on whether the window is the selected window or not).
18906 An integer value means the value string has no text
18909 Optional third and fourth args WINDOW and BUFFER specify the window
18910 and buffer to use as the context for the formatting (defaults
18911 are the selected window and the WINDOW's buffer). */)
18912 (Lisp_Object format
, Lisp_Object face
,
18913 Lisp_Object window
, Lisp_Object buffer
)
18918 struct buffer
*old_buffer
= NULL
;
18920 int no_props
= INTEGERP (face
);
18921 int count
= SPECPDL_INDEX ();
18923 int string_start
= 0;
18926 window
= selected_window
;
18927 CHECK_WINDOW (window
);
18928 w
= XWINDOW (window
);
18931 buffer
= w
->buffer
;
18932 CHECK_BUFFER (buffer
);
18934 /* Make formatting the modeline a non-op when noninteractive, otherwise
18935 there will be problems later caused by a partially initialized frame. */
18936 if (NILP (format
) || noninteractive
)
18937 return empty_unibyte_string
;
18942 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18943 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18944 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18945 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18946 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18947 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18948 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18951 if (XBUFFER (buffer
) != current_buffer
)
18952 old_buffer
= current_buffer
;
18954 /* Save things including mode_line_proptrans_alist,
18955 and set that to nil so that we don't alter the outer value. */
18956 record_unwind_protect (unwind_format_mode_line
,
18957 format_mode_line_unwind_data
18958 (old_buffer
, selected_window
, 1));
18959 mode_line_proptrans_alist
= Qnil
;
18961 Fselect_window (window
, Qt
);
18963 set_buffer_internal_1 (XBUFFER (buffer
));
18965 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18969 mode_line_target
= MODE_LINE_NOPROP
;
18970 mode_line_string_face_prop
= Qnil
;
18971 mode_line_string_list
= Qnil
;
18972 string_start
= MODE_LINE_NOPROP_LEN (0);
18976 mode_line_target
= MODE_LINE_STRING
;
18977 mode_line_string_list
= Qnil
;
18978 mode_line_string_face
= face
;
18979 mode_line_string_face_prop
18980 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18983 push_kboard (FRAME_KBOARD (it
.f
));
18984 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18989 len
= MODE_LINE_NOPROP_LEN (string_start
);
18990 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18994 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18995 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18996 empty_unibyte_string
);
18999 unbind_to (count
, Qnil
);
19003 /* Write a null-terminated, right justified decimal representation of
19004 the positive integer D to BUF using a minimal field width WIDTH. */
19007 pint2str (register char *buf
, register int width
, register int d
)
19009 register char *p
= buf
;
19017 *p
++ = d
% 10 + '0';
19022 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19033 /* Write a null-terminated, right justified decimal and "human
19034 readable" representation of the nonnegative integer D to BUF using
19035 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19037 static const char power_letter
[] =
19051 pint2hrstr (char *buf
, int width
, int d
)
19053 /* We aim to represent the nonnegative integer D as
19054 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19057 /* -1 means: do not use TENTHS. */
19061 /* Length of QUOTIENT.TENTHS as a string. */
19067 if (1000 <= quotient
)
19069 /* Scale to the appropriate EXPONENT. */
19072 remainder
= quotient
% 1000;
19076 while (1000 <= quotient
);
19078 /* Round to nearest and decide whether to use TENTHS or not. */
19081 tenths
= remainder
/ 100;
19082 if (50 <= remainder
% 100)
19089 if (quotient
== 10)
19097 if (500 <= remainder
)
19099 if (quotient
< 999)
19110 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19111 if (tenths
== -1 && quotient
<= 99)
19118 p
= psuffix
= buf
+ max (width
, length
);
19120 /* Print EXPONENT. */
19122 *psuffix
++ = power_letter
[exponent
];
19125 /* Print TENTHS. */
19128 *--p
= '0' + tenths
;
19132 /* Print QUOTIENT. */
19135 int digit
= quotient
% 10;
19136 *--p
= '0' + digit
;
19138 while ((quotient
/= 10) != 0);
19140 /* Print leading spaces. */
19145 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19146 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19147 type of CODING_SYSTEM. Return updated pointer into BUF. */
19149 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19152 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19155 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19156 const unsigned char *eol_str
;
19158 /* The EOL conversion we are using. */
19159 Lisp_Object eoltype
;
19161 val
= CODING_SYSTEM_SPEC (coding_system
);
19164 if (!VECTORP (val
)) /* Not yet decided. */
19169 eoltype
= eol_mnemonic_undecided
;
19170 /* Don't mention EOL conversion if it isn't decided. */
19175 Lisp_Object eolvalue
;
19177 attrs
= AREF (val
, 0);
19178 eolvalue
= AREF (val
, 2);
19181 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19185 /* The EOL conversion that is normal on this system. */
19187 if (NILP (eolvalue
)) /* Not yet decided. */
19188 eoltype
= eol_mnemonic_undecided
;
19189 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19190 eoltype
= eol_mnemonic_undecided
;
19191 else /* eolvalue is Qunix, Qdos, or Qmac. */
19192 eoltype
= (EQ (eolvalue
, Qunix
)
19193 ? eol_mnemonic_unix
19194 : (EQ (eolvalue
, Qdos
) == 1
19195 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19201 /* Mention the EOL conversion if it is not the usual one. */
19202 if (STRINGP (eoltype
))
19204 eol_str
= SDATA (eoltype
);
19205 eol_str_len
= SBYTES (eoltype
);
19207 else if (CHARACTERP (eoltype
))
19209 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19210 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19215 eol_str
= invalid_eol_type
;
19216 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19218 memcpy (buf
, eol_str
, eol_str_len
);
19219 buf
+= eol_str_len
;
19225 /* Return a string for the output of a mode line %-spec for window W,
19226 generated by character C. PRECISION >= 0 means don't return a
19227 string longer than that value. FIELD_WIDTH > 0 means pad the
19228 string returned with spaces to that value. Return a Lisp string in
19229 *STRING if the resulting string is taken from that Lisp string.
19231 Note we operate on the current buffer for most purposes,
19232 the exception being w->base_line_pos. */
19234 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19236 static const char *
19237 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19238 int precision
, Lisp_Object
*string
)
19241 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19242 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19243 struct buffer
*b
= current_buffer
;
19251 if (!NILP (BVAR (b
, read_only
)))
19253 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19258 /* This differs from %* only for a modified read-only buffer. */
19259 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19261 if (!NILP (BVAR (b
, read_only
)))
19266 /* This differs from %* in ignoring read-only-ness. */
19267 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19279 if (command_loop_level
> 5)
19281 p
= decode_mode_spec_buf
;
19282 for (i
= 0; i
< command_loop_level
; i
++)
19285 return decode_mode_spec_buf
;
19293 if (command_loop_level
> 5)
19295 p
= decode_mode_spec_buf
;
19296 for (i
= 0; i
< command_loop_level
; i
++)
19299 return decode_mode_spec_buf
;
19306 /* Let lots_of_dashes be a string of infinite length. */
19307 if (mode_line_target
== MODE_LINE_NOPROP
||
19308 mode_line_target
== MODE_LINE_STRING
)
19310 if (field_width
<= 0
19311 || field_width
> sizeof (lots_of_dashes
))
19313 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19314 decode_mode_spec_buf
[i
] = '-';
19315 decode_mode_spec_buf
[i
] = '\0';
19316 return decode_mode_spec_buf
;
19319 return lots_of_dashes
;
19323 obj
= BVAR (b
, name
);
19327 /* %c and %l are ignored in `frame-title-format'.
19328 (In redisplay_internal, the frame title is drawn _before_ the
19329 windows are updated, so the stuff which depends on actual
19330 window contents (such as %l) may fail to render properly, or
19331 even crash emacs.) */
19332 if (mode_line_target
== MODE_LINE_TITLE
)
19336 int col
= (int) current_column (); /* iftc */
19337 w
->column_number_displayed
= make_number (col
);
19338 pint2str (decode_mode_spec_buf
, field_width
, col
);
19339 return decode_mode_spec_buf
;
19343 #ifndef SYSTEM_MALLOC
19345 if (NILP (Vmemory_full
))
19348 return "!MEM FULL! ";
19355 /* %F displays the frame name. */
19356 if (!NILP (f
->title
))
19357 return SSDATA (f
->title
);
19358 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19359 return SSDATA (f
->name
);
19363 obj
= BVAR (b
, filename
);
19368 EMACS_INT size
= ZV
- BEGV
;
19369 pint2str (decode_mode_spec_buf
, field_width
, size
);
19370 return decode_mode_spec_buf
;
19375 EMACS_INT size
= ZV
- BEGV
;
19376 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19377 return decode_mode_spec_buf
;
19382 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19383 int topline
, nlines
, height
;
19386 /* %c and %l are ignored in `frame-title-format'. */
19387 if (mode_line_target
== MODE_LINE_TITLE
)
19390 startpos
= XMARKER (w
->start
)->charpos
;
19391 startpos_byte
= marker_byte_position (w
->start
);
19392 height
= WINDOW_TOTAL_LINES (w
);
19394 /* If we decided that this buffer isn't suitable for line numbers,
19395 don't forget that too fast. */
19396 if (EQ (w
->base_line_pos
, w
->buffer
))
19398 /* But do forget it, if the window shows a different buffer now. */
19399 else if (BUFFERP (w
->base_line_pos
))
19400 w
->base_line_pos
= Qnil
;
19402 /* If the buffer is very big, don't waste time. */
19403 if (INTEGERP (Vline_number_display_limit
)
19404 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19406 w
->base_line_pos
= Qnil
;
19407 w
->base_line_number
= Qnil
;
19411 if (INTEGERP (w
->base_line_number
)
19412 && INTEGERP (w
->base_line_pos
)
19413 && XFASTINT (w
->base_line_pos
) <= startpos
)
19415 line
= XFASTINT (w
->base_line_number
);
19416 linepos
= XFASTINT (w
->base_line_pos
);
19417 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19422 linepos
= BUF_BEGV (b
);
19423 linepos_byte
= BUF_BEGV_BYTE (b
);
19426 /* Count lines from base line to window start position. */
19427 nlines
= display_count_lines (linepos
, linepos_byte
,
19431 topline
= nlines
+ line
;
19433 /* Determine a new base line, if the old one is too close
19434 or too far away, or if we did not have one.
19435 "Too close" means it's plausible a scroll-down would
19436 go back past it. */
19437 if (startpos
== BUF_BEGV (b
))
19439 w
->base_line_number
= make_number (topline
);
19440 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19442 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19443 || linepos
== BUF_BEGV (b
))
19445 EMACS_INT limit
= BUF_BEGV (b
);
19446 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19447 EMACS_INT position
;
19448 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19450 if (startpos
- distance
> limit
)
19452 limit
= startpos
- distance
;
19453 limit_byte
= CHAR_TO_BYTE (limit
);
19456 nlines
= display_count_lines (startpos
, startpos_byte
,
19458 - (height
* 2 + 30),
19460 /* If we couldn't find the lines we wanted within
19461 line_number_display_limit_width chars per line,
19462 give up on line numbers for this window. */
19463 if (position
== limit_byte
&& limit
== startpos
- distance
)
19465 w
->base_line_pos
= w
->buffer
;
19466 w
->base_line_number
= Qnil
;
19470 w
->base_line_number
= make_number (topline
- nlines
);
19471 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19474 /* Now count lines from the start pos to point. */
19475 nlines
= display_count_lines (startpos
, startpos_byte
,
19476 PT_BYTE
, PT
, &junk
);
19478 /* Record that we did display the line number. */
19479 line_number_displayed
= 1;
19481 /* Make the string to show. */
19482 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19483 return decode_mode_spec_buf
;
19486 char* p
= decode_mode_spec_buf
;
19487 int pad
= field_width
- 2;
19493 return decode_mode_spec_buf
;
19499 obj
= BVAR (b
, mode_name
);
19503 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19509 EMACS_INT pos
= marker_position (w
->start
);
19510 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19512 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19514 if (pos
<= BUF_BEGV (b
))
19519 else if (pos
<= BUF_BEGV (b
))
19523 if (total
> 1000000)
19524 /* Do it differently for a large value, to avoid overflow. */
19525 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19527 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19528 /* We can't normally display a 3-digit number,
19529 so get us a 2-digit number that is close. */
19532 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19533 return decode_mode_spec_buf
;
19537 /* Display percentage of size above the bottom of the screen. */
19540 EMACS_INT toppos
= marker_position (w
->start
);
19541 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19542 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19544 if (botpos
>= BUF_ZV (b
))
19546 if (toppos
<= BUF_BEGV (b
))
19553 if (total
> 1000000)
19554 /* Do it differently for a large value, to avoid overflow. */
19555 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19557 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19558 /* We can't normally display a 3-digit number,
19559 so get us a 2-digit number that is close. */
19562 if (toppos
<= BUF_BEGV (b
))
19563 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19565 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19566 return decode_mode_spec_buf
;
19571 /* status of process */
19572 obj
= Fget_buffer_process (Fcurrent_buffer ());
19574 return "no process";
19576 obj
= Fsymbol_name (Fprocess_status (obj
));
19582 int count
= inhibit_garbage_collection ();
19583 Lisp_Object val
= call1 (intern ("file-remote-p"),
19584 BVAR (current_buffer
, directory
));
19585 unbind_to (count
, Qnil
);
19593 case 't': /* indicate TEXT or BINARY */
19597 /* coding-system (not including end-of-line format) */
19599 /* coding-system (including end-of-line type) */
19601 int eol_flag
= (c
== 'Z');
19602 char *p
= decode_mode_spec_buf
;
19604 if (! FRAME_WINDOW_P (f
))
19606 /* No need to mention EOL here--the terminal never needs
19607 to do EOL conversion. */
19608 p
= decode_mode_spec_coding (CODING_ID_NAME
19609 (FRAME_KEYBOARD_CODING (f
)->id
),
19611 p
= decode_mode_spec_coding (CODING_ID_NAME
19612 (FRAME_TERMINAL_CODING (f
)->id
),
19615 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19618 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19619 #ifdef subprocesses
19620 obj
= Fget_buffer_process (Fcurrent_buffer ());
19621 if (PROCESSP (obj
))
19623 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19625 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19628 #endif /* subprocesses */
19631 return decode_mode_spec_buf
;
19638 return SSDATA (obj
);
19645 /* Count up to COUNT lines starting from START / START_BYTE.
19646 But don't go beyond LIMIT_BYTE.
19647 Return the number of lines thus found (always nonnegative).
19649 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19652 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19653 EMACS_INT limit_byte
, int count
,
19654 EMACS_INT
*byte_pos_ptr
)
19656 register unsigned char *cursor
;
19657 unsigned char *base
;
19659 register int ceiling
;
19660 register unsigned char *ceiling_addr
;
19661 int orig_count
= count
;
19663 /* If we are not in selective display mode,
19664 check only for newlines. */
19665 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19666 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19670 while (start_byte
< limit_byte
)
19672 ceiling
= BUFFER_CEILING_OF (start_byte
);
19673 ceiling
= min (limit_byte
- 1, ceiling
);
19674 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19675 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19678 if (selective_display
)
19679 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19682 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19685 if (cursor
!= ceiling_addr
)
19689 start_byte
+= cursor
- base
+ 1;
19690 *byte_pos_ptr
= start_byte
;
19694 if (++cursor
== ceiling_addr
)
19700 start_byte
+= cursor
- base
;
19705 while (start_byte
> limit_byte
)
19707 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19708 ceiling
= max (limit_byte
, ceiling
);
19709 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19710 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19713 if (selective_display
)
19714 while (--cursor
!= ceiling_addr
19715 && *cursor
!= '\n' && *cursor
!= 015)
19718 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19721 if (cursor
!= ceiling_addr
)
19725 start_byte
+= cursor
- base
+ 1;
19726 *byte_pos_ptr
= start_byte
;
19727 /* When scanning backwards, we should
19728 not count the newline posterior to which we stop. */
19729 return - orig_count
- 1;
19735 /* Here we add 1 to compensate for the last decrement
19736 of CURSOR, which took it past the valid range. */
19737 start_byte
+= cursor
- base
+ 1;
19741 *byte_pos_ptr
= limit_byte
;
19744 return - orig_count
+ count
;
19745 return orig_count
- count
;
19751 /***********************************************************************
19753 ***********************************************************************/
19755 /* Display a NUL-terminated string, starting with index START.
19757 If STRING is non-null, display that C string. Otherwise, the Lisp
19758 string LISP_STRING is displayed. There's a case that STRING is
19759 non-null and LISP_STRING is not nil. It means STRING is a string
19760 data of LISP_STRING. In that case, we display LISP_STRING while
19761 ignoring its text properties.
19763 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19764 FACE_STRING. Display STRING or LISP_STRING with the face at
19765 FACE_STRING_POS in FACE_STRING:
19767 Display the string in the environment given by IT, but use the
19768 standard display table, temporarily.
19770 FIELD_WIDTH is the minimum number of output glyphs to produce.
19771 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19772 with spaces. If STRING has more characters, more than FIELD_WIDTH
19773 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19775 PRECISION is the maximum number of characters to output from
19776 STRING. PRECISION < 0 means don't truncate the string.
19778 This is roughly equivalent to printf format specifiers:
19780 FIELD_WIDTH PRECISION PRINTF
19781 ----------------------------------------
19787 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19788 display them, and < 0 means obey the current buffer's value of
19789 enable_multibyte_characters.
19791 Value is the number of columns displayed. */
19794 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19795 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19796 int field_width
, int precision
, int max_x
, int multibyte
)
19798 int hpos_at_start
= it
->hpos
;
19799 int saved_face_id
= it
->face_id
;
19800 struct glyph_row
*row
= it
->glyph_row
;
19802 /* Initialize the iterator IT for iteration over STRING beginning
19803 with index START. */
19804 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19805 precision
, field_width
, multibyte
);
19806 if (string
&& STRINGP (lisp_string
))
19807 /* LISP_STRING is the one returned by decode_mode_spec. We should
19808 ignore its text properties. */
19809 it
->stop_charpos
= -1;
19811 /* If displaying STRING, set up the face of the iterator
19812 from LISP_STRING, if that's given. */
19813 if (STRINGP (face_string
))
19819 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19820 0, it
->region_beg_charpos
,
19821 it
->region_end_charpos
,
19822 &endptr
, it
->base_face_id
, 0);
19823 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19824 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19827 /* Set max_x to the maximum allowed X position. Don't let it go
19828 beyond the right edge of the window. */
19830 max_x
= it
->last_visible_x
;
19832 max_x
= min (max_x
, it
->last_visible_x
);
19834 /* Skip over display elements that are not visible. because IT->w is
19836 if (it
->current_x
< it
->first_visible_x
)
19837 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19838 MOVE_TO_POS
| MOVE_TO_X
);
19840 row
->ascent
= it
->max_ascent
;
19841 row
->height
= it
->max_ascent
+ it
->max_descent
;
19842 row
->phys_ascent
= it
->max_phys_ascent
;
19843 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19844 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19846 /* This condition is for the case that we are called with current_x
19847 past last_visible_x. */
19848 while (it
->current_x
< max_x
)
19850 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19852 /* Get the next display element. */
19853 if (!get_next_display_element (it
))
19856 /* Produce glyphs. */
19857 x_before
= it
->current_x
;
19858 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19859 PRODUCE_GLYPHS (it
);
19861 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19864 while (i
< nglyphs
)
19866 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19868 if (it
->line_wrap
!= TRUNCATE
19869 && x
+ glyph
->pixel_width
> max_x
)
19871 /* End of continued line or max_x reached. */
19872 if (CHAR_GLYPH_PADDING_P (*glyph
))
19874 /* A wide character is unbreakable. */
19875 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19876 it
->current_x
= x_before
;
19880 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19885 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19887 /* Glyph is at least partially visible. */
19889 if (x
< it
->first_visible_x
)
19890 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19894 /* Glyph is off the left margin of the display area.
19895 Should not happen. */
19899 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19900 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19901 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19902 row
->phys_height
= max (row
->phys_height
,
19903 it
->max_phys_ascent
+ it
->max_phys_descent
);
19904 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19905 it
->max_extra_line_spacing
);
19906 x
+= glyph
->pixel_width
;
19910 /* Stop if max_x reached. */
19914 /* Stop at line ends. */
19915 if (ITERATOR_AT_END_OF_LINE_P (it
))
19917 it
->continuation_lines_width
= 0;
19921 set_iterator_to_next (it
, 1);
19923 /* Stop if truncating at the right edge. */
19924 if (it
->line_wrap
== TRUNCATE
19925 && it
->current_x
>= it
->last_visible_x
)
19927 /* Add truncation mark, but don't do it if the line is
19928 truncated at a padding space. */
19929 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19931 if (!FRAME_WINDOW_P (it
->f
))
19935 if (it
->current_x
> it
->last_visible_x
)
19937 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19938 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19940 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19942 row
->used
[TEXT_AREA
] = ii
;
19943 produce_special_glyphs (it
, IT_TRUNCATION
);
19946 produce_special_glyphs (it
, IT_TRUNCATION
);
19948 it
->glyph_row
->truncated_on_right_p
= 1;
19954 /* Maybe insert a truncation at the left. */
19955 if (it
->first_visible_x
19956 && IT_CHARPOS (*it
) > 0)
19958 if (!FRAME_WINDOW_P (it
->f
))
19959 insert_left_trunc_glyphs (it
);
19960 it
->glyph_row
->truncated_on_left_p
= 1;
19963 it
->face_id
= saved_face_id
;
19965 /* Value is number of columns displayed. */
19966 return it
->hpos
- hpos_at_start
;
19971 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19972 appears as an element of LIST or as the car of an element of LIST.
19973 If PROPVAL is a list, compare each element against LIST in that
19974 way, and return 1/2 if any element of PROPVAL is found in LIST.
19975 Otherwise return 0. This function cannot quit.
19976 The return value is 2 if the text is invisible but with an ellipsis
19977 and 1 if it's invisible and without an ellipsis. */
19980 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19982 register Lisp_Object tail
, proptail
;
19984 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19986 register Lisp_Object tem
;
19988 if (EQ (propval
, tem
))
19990 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19991 return NILP (XCDR (tem
)) ? 1 : 2;
19994 if (CONSP (propval
))
19996 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19998 Lisp_Object propelt
;
19999 propelt
= XCAR (proptail
);
20000 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20002 register Lisp_Object tem
;
20004 if (EQ (propelt
, tem
))
20006 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20007 return NILP (XCDR (tem
)) ? 1 : 2;
20015 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20016 doc
: /* Non-nil if the property makes the text invisible.
20017 POS-OR-PROP can be a marker or number, in which case it is taken to be
20018 a position in the current buffer and the value of the `invisible' property
20019 is checked; or it can be some other value, which is then presumed to be the
20020 value of the `invisible' property of the text of interest.
20021 The non-nil value returned can be t for truly invisible text or something
20022 else if the text is replaced by an ellipsis. */)
20023 (Lisp_Object pos_or_prop
)
20026 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20027 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20029 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20030 return (invis
== 0 ? Qnil
20032 : make_number (invis
));
20035 /* Calculate a width or height in pixels from a specification using
20036 the following elements:
20039 NUM - a (fractional) multiple of the default font width/height
20040 (NUM) - specifies exactly NUM pixels
20041 UNIT - a fixed number of pixels, see below.
20042 ELEMENT - size of a display element in pixels, see below.
20043 (NUM . SPEC) - equals NUM * SPEC
20044 (+ SPEC SPEC ...) - add pixel values
20045 (- SPEC SPEC ...) - subtract pixel values
20046 (- SPEC) - negate pixel value
20049 INT or FLOAT - a number constant
20050 SYMBOL - use symbol's (buffer local) variable binding.
20053 in - pixels per inch *)
20054 mm - pixels per 1/1000 meter *)
20055 cm - pixels per 1/100 meter *)
20056 width - width of current font in pixels.
20057 height - height of current font in pixels.
20059 *) using the ratio(s) defined in display-pixels-per-inch.
20063 left-fringe - left fringe width in pixels
20064 right-fringe - right fringe width in pixels
20066 left-margin - left margin width in pixels
20067 right-margin - right margin width in pixels
20069 scroll-bar - scroll-bar area width in pixels
20073 Pixels corresponding to 5 inches:
20076 Total width of non-text areas on left side of window (if scroll-bar is on left):
20077 '(space :width (+ left-fringe left-margin scroll-bar))
20079 Align to first text column (in header line):
20080 '(space :align-to 0)
20082 Align to middle of text area minus half the width of variable `my-image'
20083 containing a loaded image:
20084 '(space :align-to (0.5 . (- text my-image)))
20086 Width of left margin minus width of 1 character in the default font:
20087 '(space :width (- left-margin 1))
20089 Width of left margin minus width of 2 characters in the current font:
20090 '(space :width (- left-margin (2 . width)))
20092 Center 1 character over left-margin (in header line):
20093 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20095 Different ways to express width of left fringe plus left margin minus one pixel:
20096 '(space :width (- (+ left-fringe left-margin) (1)))
20097 '(space :width (+ left-fringe left-margin (- (1))))
20098 '(space :width (+ left-fringe left-margin (-1)))
20102 #define NUMVAL(X) \
20103 ((INTEGERP (X) || FLOATP (X)) \
20108 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20109 struct font
*font
, int width_p
, int *align_to
)
20113 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20114 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20117 return OK_PIXELS (0);
20119 xassert (FRAME_LIVE_P (it
->f
));
20121 if (SYMBOLP (prop
))
20123 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20125 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20127 if (unit
[0] == 'i' && unit
[1] == 'n')
20129 else if (unit
[0] == 'm' && unit
[1] == 'm')
20131 else if (unit
[0] == 'c' && unit
[1] == 'm')
20138 #ifdef HAVE_WINDOW_SYSTEM
20139 if (FRAME_WINDOW_P (it
->f
)
20141 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20142 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20144 return OK_PIXELS (ppi
/ pixels
);
20147 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20148 || (CONSP (Vdisplay_pixels_per_inch
)
20150 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20151 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20153 return OK_PIXELS (ppi
/ pixels
);
20159 #ifdef HAVE_WINDOW_SYSTEM
20160 if (EQ (prop
, Qheight
))
20161 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20162 if (EQ (prop
, Qwidth
))
20163 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20165 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20166 return OK_PIXELS (1);
20169 if (EQ (prop
, Qtext
))
20170 return OK_PIXELS (width_p
20171 ? window_box_width (it
->w
, TEXT_AREA
)
20172 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20174 if (align_to
&& *align_to
< 0)
20177 if (EQ (prop
, Qleft
))
20178 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20179 if (EQ (prop
, Qright
))
20180 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20181 if (EQ (prop
, Qcenter
))
20182 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20183 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20184 if (EQ (prop
, Qleft_fringe
))
20185 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20186 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20187 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20188 if (EQ (prop
, Qright_fringe
))
20189 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20190 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20191 : window_box_right_offset (it
->w
, TEXT_AREA
));
20192 if (EQ (prop
, Qleft_margin
))
20193 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20194 if (EQ (prop
, Qright_margin
))
20195 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20196 if (EQ (prop
, Qscroll_bar
))
20197 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20199 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20200 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20201 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20206 if (EQ (prop
, Qleft_fringe
))
20207 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20208 if (EQ (prop
, Qright_fringe
))
20209 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20210 if (EQ (prop
, Qleft_margin
))
20211 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20212 if (EQ (prop
, Qright_margin
))
20213 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20214 if (EQ (prop
, Qscroll_bar
))
20215 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20218 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20221 if (INTEGERP (prop
) || FLOATP (prop
))
20223 int base_unit
= (width_p
20224 ? FRAME_COLUMN_WIDTH (it
->f
)
20225 : FRAME_LINE_HEIGHT (it
->f
));
20226 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20231 Lisp_Object car
= XCAR (prop
);
20232 Lisp_Object cdr
= XCDR (prop
);
20236 #ifdef HAVE_WINDOW_SYSTEM
20237 if (FRAME_WINDOW_P (it
->f
)
20238 && valid_image_p (prop
))
20240 int id
= lookup_image (it
->f
, prop
);
20241 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20243 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20246 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20252 while (CONSP (cdr
))
20254 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20255 font
, width_p
, align_to
))
20258 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20263 if (EQ (car
, Qminus
))
20265 return OK_PIXELS (pixels
);
20268 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20271 if (INTEGERP (car
) || FLOATP (car
))
20274 pixels
= XFLOATINT (car
);
20276 return OK_PIXELS (pixels
);
20277 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20278 font
, width_p
, align_to
))
20279 return OK_PIXELS (pixels
* fact
);
20290 /***********************************************************************
20292 ***********************************************************************/
20294 #ifdef HAVE_WINDOW_SYSTEM
20299 dump_glyph_string (s
)
20300 struct glyph_string
*s
;
20302 fprintf (stderr
, "glyph string\n");
20303 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20304 s
->x
, s
->y
, s
->width
, s
->height
);
20305 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20306 fprintf (stderr
, " hl = %d\n", s
->hl
);
20307 fprintf (stderr
, " left overhang = %d, right = %d\n",
20308 s
->left_overhang
, s
->right_overhang
);
20309 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20310 fprintf (stderr
, " extends to end of line = %d\n",
20311 s
->extends_to_end_of_line_p
);
20312 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20313 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20316 #endif /* GLYPH_DEBUG */
20318 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20319 of XChar2b structures for S; it can't be allocated in
20320 init_glyph_string because it must be allocated via `alloca'. W
20321 is the window on which S is drawn. ROW and AREA are the glyph row
20322 and area within the row from which S is constructed. START is the
20323 index of the first glyph structure covered by S. HL is a
20324 face-override for drawing S. */
20327 #define OPTIONAL_HDC(hdc) HDC hdc,
20328 #define DECLARE_HDC(hdc) HDC hdc;
20329 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20330 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20333 #ifndef OPTIONAL_HDC
20334 #define OPTIONAL_HDC(hdc)
20335 #define DECLARE_HDC(hdc)
20336 #define ALLOCATE_HDC(hdc, f)
20337 #define RELEASE_HDC(hdc, f)
20341 init_glyph_string (struct glyph_string
*s
,
20343 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20344 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20346 memset (s
, 0, sizeof *s
);
20348 s
->f
= XFRAME (w
->frame
);
20352 s
->display
= FRAME_X_DISPLAY (s
->f
);
20353 s
->window
= FRAME_X_WINDOW (s
->f
);
20354 s
->char2b
= char2b
;
20358 s
->first_glyph
= row
->glyphs
[area
] + start
;
20359 s
->height
= row
->height
;
20360 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20361 s
->ybase
= s
->y
+ row
->ascent
;
20365 /* Append the list of glyph strings with head H and tail T to the list
20366 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20369 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20370 struct glyph_string
*h
, struct glyph_string
*t
)
20384 /* Prepend the list of glyph strings with head H and tail T to the
20385 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20389 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20390 struct glyph_string
*h
, struct glyph_string
*t
)
20404 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20405 Set *HEAD and *TAIL to the resulting list. */
20408 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20409 struct glyph_string
*s
)
20411 s
->next
= s
->prev
= NULL
;
20412 append_glyph_string_lists (head
, tail
, s
, s
);
20416 /* Get face and two-byte form of character C in face FACE_ID on frame
20417 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20418 means we want to display multibyte text. DISPLAY_P non-zero means
20419 make sure that X resources for the face returned are allocated.
20420 Value is a pointer to a realized face that is ready for display if
20421 DISPLAY_P is non-zero. */
20423 static INLINE
struct face
*
20424 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20425 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20427 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20431 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20433 if (code
!= FONT_INVALID_CODE
)
20434 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20436 STORE_XCHAR2B (char2b
, 0, 0);
20439 /* Make sure X resources of the face are allocated. */
20440 #ifdef HAVE_X_WINDOWS
20444 xassert (face
!= NULL
);
20445 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20452 /* Get face and two-byte form of character glyph GLYPH on frame F.
20453 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20454 a pointer to a realized face that is ready for display. */
20456 static INLINE
struct face
*
20457 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20458 XChar2b
*char2b
, int *two_byte_p
)
20462 xassert (glyph
->type
== CHAR_GLYPH
);
20463 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20472 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20473 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20475 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
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 xassert (face
!= NULL
);
20485 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20490 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20491 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20494 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20498 if (CHAR_BYTE8_P (c
))
20499 code
= CHAR_TO_BYTE8 (c
);
20501 code
= font
->driver
->encode_char (font
, c
);
20503 if (code
== FONT_INVALID_CODE
)
20505 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20510 /* Fill glyph string S with composition components specified by S->cmp.
20512 BASE_FACE is the base face of the composition.
20513 S->cmp_from is the index of the first component for S.
20515 OVERLAPS non-zero means S should draw the foreground only, and use
20516 its physical height for clipping. See also draw_glyphs.
20518 Value is the index of a component not in S. */
20521 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20525 /* For all glyphs of this composition, starting at the offset
20526 S->cmp_from, until we reach the end of the definition or encounter a
20527 glyph that requires the different face, add it to S. */
20532 s
->for_overlaps
= overlaps
;
20535 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20537 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20541 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20544 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20545 s
->char2b
+ i
, 1, 1);
20551 s
->font
= s
->face
->font
;
20553 else if (s
->face
!= face
)
20561 /* All glyph strings for the same composition has the same width,
20562 i.e. the width set for the first component of the composition. */
20563 s
->width
= s
->first_glyph
->pixel_width
;
20565 /* If the specified font could not be loaded, use the frame's
20566 default font, but record the fact that we couldn't load it in
20567 the glyph string so that we can draw rectangles for the
20568 characters of the glyph string. */
20569 if (s
->font
== NULL
)
20571 s
->font_not_found_p
= 1;
20572 s
->font
= FRAME_FONT (s
->f
);
20575 /* Adjust base line for subscript/superscript text. */
20576 s
->ybase
+= s
->first_glyph
->voffset
;
20578 /* This glyph string must always be drawn with 16-bit functions. */
20585 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20586 int start
, int end
, int overlaps
)
20588 struct glyph
*glyph
, *last
;
20589 Lisp_Object lgstring
;
20592 s
->for_overlaps
= overlaps
;
20593 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20594 last
= s
->row
->glyphs
[s
->area
] + end
;
20595 s
->cmp_id
= glyph
->u
.cmp
.id
;
20596 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20597 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20598 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20599 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20600 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20602 while (glyph
< last
20603 && glyph
->u
.cmp
.automatic
20604 && glyph
->u
.cmp
.id
== s
->cmp_id
20605 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20606 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20608 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20610 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20611 unsigned code
= LGLYPH_CODE (lglyph
);
20613 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20615 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20616 return glyph
- s
->row
->glyphs
[s
->area
];
20620 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20621 See the comment of fill_glyph_string for arguments.
20622 Value is the index of the first glyph not in S. */
20626 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20627 int start
, int end
, int overlaps
)
20629 struct glyph
*glyph
, *last
;
20632 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20633 s
->for_overlaps
= overlaps
;
20634 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20635 last
= s
->row
->glyphs
[s
->area
] + end
;
20636 voffset
= glyph
->voffset
;
20637 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20638 s
->font
= s
->face
->font
;
20640 s
->width
= glyph
->pixel_width
;
20642 while (glyph
< last
20643 && glyph
->type
== GLYPHLESS_GLYPH
20644 && glyph
->voffset
== voffset
20645 && glyph
->face_id
== face_id
)
20648 s
->width
+= glyph
->pixel_width
;
20651 s
->ybase
+= voffset
;
20652 return glyph
- s
->row
->glyphs
[s
->area
];
20656 /* Fill glyph string S from a sequence of character glyphs.
20658 FACE_ID is the face id of the string. START is the index of the
20659 first glyph to consider, END is the index of the last + 1.
20660 OVERLAPS non-zero means S should draw the foreground only, and use
20661 its physical height for clipping. See also draw_glyphs.
20663 Value is the index of the first glyph not in S. */
20666 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20667 int start
, int end
, int overlaps
)
20669 struct glyph
*glyph
, *last
;
20671 int glyph_not_available_p
;
20673 xassert (s
->f
== XFRAME (s
->w
->frame
));
20674 xassert (s
->nchars
== 0);
20675 xassert (start
>= 0 && end
> start
);
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
->padding_p
= glyph
->padding_p
;
20682 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20684 while (glyph
< last
20685 && glyph
->type
== CHAR_GLYPH
20686 && glyph
->voffset
== voffset
20687 /* Same face id implies same font, nowadays. */
20688 && glyph
->face_id
== face_id
20689 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20693 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20694 s
->char2b
+ s
->nchars
,
20696 s
->two_byte_p
= two_byte_p
;
20698 xassert (s
->nchars
<= end
- start
);
20699 s
->width
+= glyph
->pixel_width
;
20700 if (glyph
++->padding_p
!= s
->padding_p
)
20704 s
->font
= s
->face
->font
;
20706 /* If the specified font could not be loaded, use the frame's font,
20707 but record the fact that we couldn't load it in
20708 S->font_not_found_p so that we can draw rectangles for the
20709 characters of the glyph string. */
20710 if (s
->font
== NULL
|| glyph_not_available_p
)
20712 s
->font_not_found_p
= 1;
20713 s
->font
= FRAME_FONT (s
->f
);
20716 /* Adjust base line for subscript/superscript text. */
20717 s
->ybase
+= voffset
;
20719 xassert (s
->face
&& s
->face
->gc
);
20720 return glyph
- s
->row
->glyphs
[s
->area
];
20724 /* Fill glyph string S from image glyph S->first_glyph. */
20727 fill_image_glyph_string (struct glyph_string
*s
)
20729 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20730 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20732 s
->slice
= s
->first_glyph
->slice
.img
;
20733 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20734 s
->font
= s
->face
->font
;
20735 s
->width
= s
->first_glyph
->pixel_width
;
20737 /* Adjust base line for subscript/superscript text. */
20738 s
->ybase
+= s
->first_glyph
->voffset
;
20742 /* Fill glyph string S from a sequence of stretch glyphs.
20744 ROW is the glyph row in which the glyphs are found, AREA is the
20745 area within the row. START is the index of the first glyph to
20746 consider, END is the index of the last + 1.
20748 Value is the index of the first glyph not in S. */
20751 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20752 enum glyph_row_area area
, int start
, int end
)
20754 struct glyph
*glyph
, *last
;
20755 int voffset
, face_id
;
20757 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20759 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20760 last
= s
->row
->glyphs
[s
->area
] + end
;
20761 face_id
= glyph
->face_id
;
20762 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20763 s
->font
= s
->face
->font
;
20764 s
->width
= glyph
->pixel_width
;
20766 voffset
= glyph
->voffset
;
20770 && glyph
->type
== STRETCH_GLYPH
20771 && glyph
->voffset
== voffset
20772 && glyph
->face_id
== face_id
);
20774 s
->width
+= glyph
->pixel_width
;
20776 /* Adjust base line for subscript/superscript text. */
20777 s
->ybase
+= voffset
;
20779 /* The case that face->gc == 0 is handled when drawing the glyph
20780 string by calling PREPARE_FACE_FOR_DISPLAY. */
20782 return glyph
- s
->row
->glyphs
[s
->area
];
20785 static struct font_metrics
*
20786 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20788 static struct font_metrics metrics
;
20789 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20791 if (! font
|| code
== FONT_INVALID_CODE
)
20793 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20798 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20799 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20800 assumed to be zero. */
20803 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20805 *left
= *right
= 0;
20807 if (glyph
->type
== CHAR_GLYPH
)
20811 struct font_metrics
*pcm
;
20813 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20814 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20816 if (pcm
->rbearing
> pcm
->width
)
20817 *right
= pcm
->rbearing
- pcm
->width
;
20818 if (pcm
->lbearing
< 0)
20819 *left
= -pcm
->lbearing
;
20822 else if (glyph
->type
== COMPOSITE_GLYPH
)
20824 if (! glyph
->u
.cmp
.automatic
)
20826 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20828 if (cmp
->rbearing
> cmp
->pixel_width
)
20829 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20830 if (cmp
->lbearing
< 0)
20831 *left
= - cmp
->lbearing
;
20835 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20836 struct font_metrics metrics
;
20838 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20839 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20840 if (metrics
.rbearing
> metrics
.width
)
20841 *right
= metrics
.rbearing
- metrics
.width
;
20842 if (metrics
.lbearing
< 0)
20843 *left
= - metrics
.lbearing
;
20849 /* Return the index of the first glyph preceding glyph string S that
20850 is overwritten by S because of S's left overhang. Value is -1
20851 if no glyphs are overwritten. */
20854 left_overwritten (struct glyph_string
*s
)
20858 if (s
->left_overhang
)
20861 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20862 int first
= s
->first_glyph
- glyphs
;
20864 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20865 x
-= glyphs
[i
].pixel_width
;
20876 /* Return the index of the first glyph preceding glyph string S that
20877 is overwriting S because of its right overhang. Value is -1 if no
20878 glyph in front of S overwrites S. */
20881 left_overwriting (struct glyph_string
*s
)
20884 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20885 int first
= s
->first_glyph
- glyphs
;
20889 for (i
= first
- 1; i
>= 0; --i
)
20892 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20895 x
-= glyphs
[i
].pixel_width
;
20902 /* Return the index of the last glyph following glyph string S that is
20903 overwritten by S because of S's right overhang. Value is -1 if
20904 no such glyph is found. */
20907 right_overwritten (struct glyph_string
*s
)
20911 if (s
->right_overhang
)
20914 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20915 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20916 int end
= s
->row
->used
[s
->area
];
20918 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20919 x
+= glyphs
[i
].pixel_width
;
20928 /* Return the index of the last glyph following glyph string S that
20929 overwrites S because of its left overhang. Value is negative
20930 if no such glyph is found. */
20933 right_overwriting (struct glyph_string
*s
)
20936 int end
= s
->row
->used
[s
->area
];
20937 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20938 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20942 for (i
= first
; i
< end
; ++i
)
20945 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20948 x
+= glyphs
[i
].pixel_width
;
20955 /* Set background width of glyph string S. START is the index of the
20956 first glyph following S. LAST_X is the right-most x-position + 1
20957 in the drawing area. */
20960 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20962 /* If the face of this glyph string has to be drawn to the end of
20963 the drawing area, set S->extends_to_end_of_line_p. */
20965 if (start
== s
->row
->used
[s
->area
]
20966 && s
->area
== TEXT_AREA
20967 && ((s
->row
->fill_line_p
20968 && (s
->hl
== DRAW_NORMAL_TEXT
20969 || s
->hl
== DRAW_IMAGE_RAISED
20970 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20971 || s
->hl
== DRAW_MOUSE_FACE
))
20972 s
->extends_to_end_of_line_p
= 1;
20974 /* If S extends its face to the end of the line, set its
20975 background_width to the distance to the right edge of the drawing
20977 if (s
->extends_to_end_of_line_p
)
20978 s
->background_width
= last_x
- s
->x
+ 1;
20980 s
->background_width
= s
->width
;
20984 /* Compute overhangs and x-positions for glyph string S and its
20985 predecessors, or successors. X is the starting x-position for S.
20986 BACKWARD_P non-zero means process predecessors. */
20989 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20995 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20996 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21006 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21007 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21017 /* The following macros are only called from draw_glyphs below.
21018 They reference the following parameters of that function directly:
21019 `w', `row', `area', and `overlap_p'
21020 as well as the following local variables:
21021 `s', `f', and `hdc' (in W32) */
21024 /* On W32, silently add local `hdc' variable to argument list of
21025 init_glyph_string. */
21026 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21027 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21029 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21030 init_glyph_string (s, char2b, w, row, area, start, hl)
21033 /* Add a glyph string for a stretch glyph to the list of strings
21034 between HEAD and TAIL. START is the index of the stretch glyph in
21035 row area AREA of glyph row ROW. END is the index of the last glyph
21036 in that glyph row area. X is the current output position assigned
21037 to the new glyph string constructed. HL overrides that face of the
21038 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21039 is the right-most x-position of the drawing area. */
21041 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21042 and below -- keep them on one line. */
21043 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21046 s = (struct glyph_string *) alloca (sizeof *s); \
21047 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21048 START = fill_stretch_glyph_string (s, row, area, START, END); \
21049 append_glyph_string (&HEAD, &TAIL, s); \
21055 /* Add a glyph string for an image glyph to the list of strings
21056 between HEAD and TAIL. START is the index of the image glyph in
21057 row area AREA of glyph row ROW. END is the index of the last glyph
21058 in that glyph row area. X is the current output position assigned
21059 to the new glyph string constructed. HL overrides that face of the
21060 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21061 is the right-most x-position of the drawing area. */
21063 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21066 s = (struct glyph_string *) alloca (sizeof *s); \
21067 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21068 fill_image_glyph_string (s); \
21069 append_glyph_string (&HEAD, &TAIL, s); \
21076 /* Add a glyph string for a sequence of character glyphs to the list
21077 of strings between HEAD and TAIL. START is the index of the first
21078 glyph in row area AREA of glyph row ROW that is part of the new
21079 glyph string. END is the index of the last glyph in that glyph row
21080 area. X is the current output position assigned to the new glyph
21081 string constructed. HL overrides that face of the glyph; e.g. it
21082 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21083 right-most x-position of the drawing area. */
21085 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21091 face_id = (row)->glyphs[area][START].face_id; \
21093 s = (struct glyph_string *) alloca (sizeof *s); \
21094 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21095 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21096 append_glyph_string (&HEAD, &TAIL, s); \
21098 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21103 /* Add a glyph string for a composite sequence to the list of strings
21104 between HEAD and TAIL. START is the index of the first glyph in
21105 row area AREA of glyph row ROW that is part of the new glyph
21106 string. END is the index of the last glyph in that glyph row area.
21107 X is the current output position assigned to the new glyph string
21108 constructed. HL overrides that face of the glyph; e.g. it is
21109 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21110 x-position of the drawing area. */
21112 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21114 int face_id = (row)->glyphs[area][START].face_id; \
21115 struct face *base_face = FACE_FROM_ID (f, face_id); \
21116 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21117 struct composition *cmp = composition_table[cmp_id]; \
21119 struct glyph_string *first_s; \
21122 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21124 /* Make glyph_strings for each glyph sequence that is drawable by \
21125 the same face, and append them to HEAD/TAIL. */ \
21126 for (n = 0; n < cmp->glyph_len;) \
21128 s = (struct glyph_string *) alloca (sizeof *s); \
21129 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21130 append_glyph_string (&(HEAD), &(TAIL), s); \
21136 n = fill_composite_glyph_string (s, base_face, overlaps); \
21144 /* Add a glyph string for a glyph-string sequence to the list of strings
21145 between HEAD and TAIL. */
21147 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21151 Lisp_Object gstring; \
21153 face_id = (row)->glyphs[area][START].face_id; \
21154 gstring = (composition_gstring_from_id \
21155 ((row)->glyphs[area][START].u.cmp.id)); \
21156 s = (struct glyph_string *) alloca (sizeof *s); \
21157 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21158 * LGSTRING_GLYPH_LEN (gstring)); \
21159 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21160 append_glyph_string (&(HEAD), &(TAIL), s); \
21162 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21166 /* Add a glyph string for a sequence of glyphless character's glyphs
21167 to the list of strings between HEAD and TAIL. The meanings of
21168 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21170 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21176 face_id = (row)->glyphs[area][START].face_id; \
21178 s = (struct glyph_string *) alloca (sizeof *s); \
21179 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21180 append_glyph_string (&HEAD, &TAIL, s); \
21182 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21188 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21189 of AREA of glyph row ROW on window W between indices START and END.
21190 HL overrides the face for drawing glyph strings, e.g. it is
21191 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21192 x-positions of the drawing area.
21194 This is an ugly monster macro construct because we must use alloca
21195 to allocate glyph strings (because draw_glyphs can be called
21196 asynchronously). */
21198 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21201 HEAD = TAIL = NULL; \
21202 while (START < END) \
21204 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21205 switch (first_glyph->type) \
21208 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21212 case COMPOSITE_GLYPH: \
21213 if (first_glyph->u.cmp.automatic) \
21214 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21217 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21221 case STRETCH_GLYPH: \
21222 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21226 case IMAGE_GLYPH: \
21227 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21231 case GLYPHLESS_GLYPH: \
21232 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21242 set_glyph_string_background_width (s, START, LAST_X); \
21249 /* Draw glyphs between START and END in AREA of ROW on window W,
21250 starting at x-position X. X is relative to AREA in W. HL is a
21251 face-override with the following meaning:
21253 DRAW_NORMAL_TEXT draw normally
21254 DRAW_CURSOR draw in cursor face
21255 DRAW_MOUSE_FACE draw in mouse face.
21256 DRAW_INVERSE_VIDEO draw in mode line face
21257 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21258 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21260 If OVERLAPS is non-zero, draw only the foreground of characters and
21261 clip to the physical height of ROW. Non-zero value also defines
21262 the overlapping part to be drawn:
21264 OVERLAPS_PRED overlap with preceding rows
21265 OVERLAPS_SUCC overlap with succeeding rows
21266 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21267 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21269 Value is the x-position reached, relative to AREA of W. */
21272 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21273 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21274 enum draw_glyphs_face hl
, int overlaps
)
21276 struct glyph_string
*head
, *tail
;
21277 struct glyph_string
*s
;
21278 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21279 int i
, j
, x_reached
, last_x
, area_left
= 0;
21280 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21283 ALLOCATE_HDC (hdc
, f
);
21285 /* Let's rather be paranoid than getting a SEGV. */
21286 end
= min (end
, row
->used
[area
]);
21287 start
= max (0, start
);
21288 start
= min (end
, start
);
21290 /* Translate X to frame coordinates. Set last_x to the right
21291 end of the drawing area. */
21292 if (row
->full_width_p
)
21294 /* X is relative to the left edge of W, without scroll bars
21296 area_left
= WINDOW_LEFT_EDGE_X (w
);
21297 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21301 area_left
= window_box_left (w
, area
);
21302 last_x
= area_left
+ window_box_width (w
, area
);
21306 /* Build a doubly-linked list of glyph_string structures between
21307 head and tail from what we have to draw. Note that the macro
21308 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21309 the reason we use a separate variable `i'. */
21311 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21313 x_reached
= tail
->x
+ tail
->background_width
;
21317 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21318 the row, redraw some glyphs in front or following the glyph
21319 strings built above. */
21320 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21322 struct glyph_string
*h
, *t
;
21323 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21324 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21327 /* If mouse highlighting is on, we may need to draw adjacent
21328 glyphs using mouse-face highlighting. */
21329 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21331 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21333 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21334 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21336 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21338 check_mouse_face
= 1;
21339 mouse_beg_col
= (row
== mouse_beg_row
)
21340 ? hlinfo
->mouse_face_beg_col
: 0;
21341 mouse_end_col
= (row
== mouse_end_row
)
21342 ? hlinfo
->mouse_face_end_col
21343 : row
->used
[TEXT_AREA
];
21347 /* Compute overhangs for all glyph strings. */
21348 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21349 for (s
= head
; s
; s
= s
->next
)
21350 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21352 /* Prepend glyph strings for glyphs in front of the first glyph
21353 string that are overwritten because of the first glyph
21354 string's left overhang. The background of all strings
21355 prepended must be drawn because the first glyph string
21357 i
= left_overwritten (head
);
21360 enum draw_glyphs_face overlap_hl
;
21362 /* If this row contains mouse highlighting, attempt to draw
21363 the overlapped glyphs with the correct highlight. This
21364 code fails if the overlap encompasses more than one glyph
21365 and mouse-highlight spans only some of these glyphs.
21366 However, making it work perfectly involves a lot more
21367 code, and I don't know if the pathological case occurs in
21368 practice, so we'll stick to this for now. --- cyd */
21369 if (check_mouse_face
21370 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21371 overlap_hl
= DRAW_MOUSE_FACE
;
21373 overlap_hl
= DRAW_NORMAL_TEXT
;
21376 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21377 overlap_hl
, dummy_x
, last_x
);
21379 compute_overhangs_and_x (t
, head
->x
, 1);
21380 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21384 /* Prepend glyph strings for glyphs in front of the first glyph
21385 string that overwrite that glyph string because of their
21386 right overhang. For these strings, only the foreground must
21387 be drawn, because it draws over the glyph string at `head'.
21388 The background must not be drawn because this would overwrite
21389 right overhangs of preceding glyphs for which no glyph
21391 i
= left_overwriting (head
);
21394 enum draw_glyphs_face overlap_hl
;
21396 if (check_mouse_face
21397 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21398 overlap_hl
= DRAW_MOUSE_FACE
;
21400 overlap_hl
= DRAW_NORMAL_TEXT
;
21403 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21404 overlap_hl
, dummy_x
, last_x
);
21405 for (s
= h
; s
; s
= s
->next
)
21406 s
->background_filled_p
= 1;
21407 compute_overhangs_and_x (t
, head
->x
, 1);
21408 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21411 /* Append glyphs strings for glyphs following the last glyph
21412 string tail that are overwritten by tail. The background of
21413 these strings has to be drawn because tail's foreground draws
21415 i
= right_overwritten (tail
);
21418 enum draw_glyphs_face overlap_hl
;
21420 if (check_mouse_face
21421 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21422 overlap_hl
= DRAW_MOUSE_FACE
;
21424 overlap_hl
= DRAW_NORMAL_TEXT
;
21426 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21427 overlap_hl
, x
, last_x
);
21428 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21429 we don't have `end = i;' here. */
21430 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21431 append_glyph_string_lists (&head
, &tail
, h
, t
);
21435 /* Append glyph strings for glyphs following the last glyph
21436 string tail that overwrite tail. The foreground of such
21437 glyphs has to be drawn because it writes into the background
21438 of tail. The background must not be drawn because it could
21439 paint over the foreground of following glyphs. */
21440 i
= right_overwriting (tail
);
21443 enum draw_glyphs_face overlap_hl
;
21444 if (check_mouse_face
21445 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21446 overlap_hl
= DRAW_MOUSE_FACE
;
21448 overlap_hl
= DRAW_NORMAL_TEXT
;
21451 i
++; /* We must include the Ith glyph. */
21452 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21453 overlap_hl
, x
, last_x
);
21454 for (s
= h
; s
; s
= s
->next
)
21455 s
->background_filled_p
= 1;
21456 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21457 append_glyph_string_lists (&head
, &tail
, h
, t
);
21459 if (clip_head
|| clip_tail
)
21460 for (s
= head
; s
; s
= s
->next
)
21462 s
->clip_head
= clip_head
;
21463 s
->clip_tail
= clip_tail
;
21467 /* Draw all strings. */
21468 for (s
= head
; s
; s
= s
->next
)
21469 FRAME_RIF (f
)->draw_glyph_string (s
);
21472 /* When focus a sole frame and move horizontally, this sets on_p to 0
21473 causing a failure to erase prev cursor position. */
21474 if (area
== TEXT_AREA
21475 && !row
->full_width_p
21476 /* When drawing overlapping rows, only the glyph strings'
21477 foreground is drawn, which doesn't erase a cursor
21481 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21482 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21483 : (tail
? tail
->x
+ tail
->background_width
: x
));
21487 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21488 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21492 /* Value is the x-position up to which drawn, relative to AREA of W.
21493 This doesn't include parts drawn because of overhangs. */
21494 if (row
->full_width_p
)
21495 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21497 x_reached
-= area_left
;
21499 RELEASE_HDC (hdc
, f
);
21504 /* Expand row matrix if too narrow. Don't expand if area
21507 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21509 if (!fonts_changed_p \
21510 && (it->glyph_row->glyphs[area] \
21511 < it->glyph_row->glyphs[area + 1])) \
21513 it->w->ncols_scale_factor++; \
21514 fonts_changed_p = 1; \
21518 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21519 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21522 append_glyph (struct it
*it
)
21524 struct glyph
*glyph
;
21525 enum glyph_row_area area
= it
->area
;
21527 xassert (it
->glyph_row
);
21528 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21530 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21531 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21533 /* If the glyph row is reversed, we need to prepend the glyph
21534 rather than append it. */
21535 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21539 /* Make room for the additional glyph. */
21540 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21542 glyph
= it
->glyph_row
->glyphs
[area
];
21544 glyph
->charpos
= CHARPOS (it
->position
);
21545 glyph
->object
= it
->object
;
21546 if (it
->pixel_width
> 0)
21548 glyph
->pixel_width
= it
->pixel_width
;
21549 glyph
->padding_p
= 0;
21553 /* Assure at least 1-pixel width. Otherwise, cursor can't
21554 be displayed correctly. */
21555 glyph
->pixel_width
= 1;
21556 glyph
->padding_p
= 1;
21558 glyph
->ascent
= it
->ascent
;
21559 glyph
->descent
= it
->descent
;
21560 glyph
->voffset
= it
->voffset
;
21561 glyph
->type
= CHAR_GLYPH
;
21562 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21563 glyph
->multibyte_p
= it
->multibyte_p
;
21564 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21565 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21566 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21567 || it
->phys_descent
> it
->descent
);
21568 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21569 glyph
->face_id
= it
->face_id
;
21570 glyph
->u
.ch
= it
->char_to_display
;
21571 glyph
->slice
.img
= null_glyph_slice
;
21572 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21575 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21576 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21578 glyph
->bidi_type
= it
->bidi_it
.type
;
21582 glyph
->resolved_level
= 0;
21583 glyph
->bidi_type
= UNKNOWN_BT
;
21585 ++it
->glyph_row
->used
[area
];
21588 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21591 /* Store one glyph for the composition IT->cmp_it.id in
21592 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21596 append_composite_glyph (struct it
*it
)
21598 struct glyph
*glyph
;
21599 enum glyph_row_area area
= it
->area
;
21601 xassert (it
->glyph_row
);
21603 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21604 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21606 /* If the glyph row is reversed, we need to prepend the glyph
21607 rather than append it. */
21608 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21612 /* Make room for the new glyph. */
21613 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21615 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21617 glyph
->charpos
= it
->cmp_it
.charpos
;
21618 glyph
->object
= it
->object
;
21619 glyph
->pixel_width
= it
->pixel_width
;
21620 glyph
->ascent
= it
->ascent
;
21621 glyph
->descent
= it
->descent
;
21622 glyph
->voffset
= it
->voffset
;
21623 glyph
->type
= COMPOSITE_GLYPH
;
21624 if (it
->cmp_it
.ch
< 0)
21626 glyph
->u
.cmp
.automatic
= 0;
21627 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21628 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21632 glyph
->u
.cmp
.automatic
= 1;
21633 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21634 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21635 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21637 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21638 glyph
->multibyte_p
= it
->multibyte_p
;
21639 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21640 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21641 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21642 || it
->phys_descent
> it
->descent
);
21643 glyph
->padding_p
= 0;
21644 glyph
->glyph_not_available_p
= 0;
21645 glyph
->face_id
= it
->face_id
;
21646 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21649 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21650 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21652 glyph
->bidi_type
= it
->bidi_it
.type
;
21654 ++it
->glyph_row
->used
[area
];
21657 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21661 /* Change IT->ascent and IT->height according to the setting of
21665 take_vertical_position_into_account (struct it
*it
)
21669 if (it
->voffset
< 0)
21670 /* Increase the ascent so that we can display the text higher
21672 it
->ascent
-= it
->voffset
;
21674 /* Increase the descent so that we can display the text lower
21676 it
->descent
+= it
->voffset
;
21681 /* Produce glyphs/get display metrics for the image IT is loaded with.
21682 See the description of struct display_iterator in dispextern.h for
21683 an overview of struct display_iterator. */
21686 produce_image_glyph (struct it
*it
)
21690 int glyph_ascent
, crop
;
21691 struct glyph_slice slice
;
21693 xassert (it
->what
== IT_IMAGE
);
21695 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21697 /* Make sure X resources of the face is loaded. */
21698 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21700 if (it
->image_id
< 0)
21702 /* Fringe bitmap. */
21703 it
->ascent
= it
->phys_ascent
= 0;
21704 it
->descent
= it
->phys_descent
= 0;
21705 it
->pixel_width
= 0;
21710 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21712 /* Make sure X resources of the image is loaded. */
21713 prepare_image_for_display (it
->f
, img
);
21715 slice
.x
= slice
.y
= 0;
21716 slice
.width
= img
->width
;
21717 slice
.height
= img
->height
;
21719 if (INTEGERP (it
->slice
.x
))
21720 slice
.x
= XINT (it
->slice
.x
);
21721 else if (FLOATP (it
->slice
.x
))
21722 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21724 if (INTEGERP (it
->slice
.y
))
21725 slice
.y
= XINT (it
->slice
.y
);
21726 else if (FLOATP (it
->slice
.y
))
21727 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21729 if (INTEGERP (it
->slice
.width
))
21730 slice
.width
= XINT (it
->slice
.width
);
21731 else if (FLOATP (it
->slice
.width
))
21732 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21734 if (INTEGERP (it
->slice
.height
))
21735 slice
.height
= XINT (it
->slice
.height
);
21736 else if (FLOATP (it
->slice
.height
))
21737 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21739 if (slice
.x
>= img
->width
)
21740 slice
.x
= img
->width
;
21741 if (slice
.y
>= img
->height
)
21742 slice
.y
= img
->height
;
21743 if (slice
.x
+ slice
.width
>= img
->width
)
21744 slice
.width
= img
->width
- slice
.x
;
21745 if (slice
.y
+ slice
.height
> img
->height
)
21746 slice
.height
= img
->height
- slice
.y
;
21748 if (slice
.width
== 0 || slice
.height
== 0)
21751 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21753 it
->descent
= slice
.height
- glyph_ascent
;
21755 it
->descent
+= img
->vmargin
;
21756 if (slice
.y
+ slice
.height
== img
->height
)
21757 it
->descent
+= img
->vmargin
;
21758 it
->phys_descent
= it
->descent
;
21760 it
->pixel_width
= slice
.width
;
21762 it
->pixel_width
+= img
->hmargin
;
21763 if (slice
.x
+ slice
.width
== img
->width
)
21764 it
->pixel_width
+= img
->hmargin
;
21766 /* It's quite possible for images to have an ascent greater than
21767 their height, so don't get confused in that case. */
21768 if (it
->descent
< 0)
21773 if (face
->box
!= FACE_NO_BOX
)
21775 if (face
->box_line_width
> 0)
21778 it
->ascent
+= face
->box_line_width
;
21779 if (slice
.y
+ slice
.height
== img
->height
)
21780 it
->descent
+= face
->box_line_width
;
21783 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21784 it
->pixel_width
+= eabs (face
->box_line_width
);
21785 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21786 it
->pixel_width
+= eabs (face
->box_line_width
);
21789 take_vertical_position_into_account (it
);
21791 /* Automatically crop wide image glyphs at right edge so we can
21792 draw the cursor on same display row. */
21793 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21794 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21796 it
->pixel_width
-= crop
;
21797 slice
.width
-= crop
;
21802 struct glyph
*glyph
;
21803 enum glyph_row_area area
= it
->area
;
21805 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21806 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21808 glyph
->charpos
= CHARPOS (it
->position
);
21809 glyph
->object
= it
->object
;
21810 glyph
->pixel_width
= it
->pixel_width
;
21811 glyph
->ascent
= glyph_ascent
;
21812 glyph
->descent
= it
->descent
;
21813 glyph
->voffset
= it
->voffset
;
21814 glyph
->type
= IMAGE_GLYPH
;
21815 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21816 glyph
->multibyte_p
= it
->multibyte_p
;
21817 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21818 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21819 glyph
->overlaps_vertically_p
= 0;
21820 glyph
->padding_p
= 0;
21821 glyph
->glyph_not_available_p
= 0;
21822 glyph
->face_id
= it
->face_id
;
21823 glyph
->u
.img_id
= img
->id
;
21824 glyph
->slice
.img
= slice
;
21825 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21828 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21829 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21831 glyph
->bidi_type
= it
->bidi_it
.type
;
21833 ++it
->glyph_row
->used
[area
];
21836 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21841 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21842 of the glyph, WIDTH and HEIGHT are the width and height of the
21843 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21846 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21847 int width
, int height
, int ascent
)
21849 struct glyph
*glyph
;
21850 enum glyph_row_area area
= it
->area
;
21852 xassert (ascent
>= 0 && ascent
<= height
);
21854 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21855 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21857 /* If the glyph row is reversed, we need to prepend the glyph
21858 rather than append it. */
21859 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21863 /* Make room for the additional glyph. */
21864 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21866 glyph
= it
->glyph_row
->glyphs
[area
];
21868 glyph
->charpos
= CHARPOS (it
->position
);
21869 glyph
->object
= object
;
21870 glyph
->pixel_width
= width
;
21871 glyph
->ascent
= ascent
;
21872 glyph
->descent
= height
- ascent
;
21873 glyph
->voffset
= it
->voffset
;
21874 glyph
->type
= STRETCH_GLYPH
;
21875 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21876 glyph
->multibyte_p
= it
->multibyte_p
;
21877 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21878 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21879 glyph
->overlaps_vertically_p
= 0;
21880 glyph
->padding_p
= 0;
21881 glyph
->glyph_not_available_p
= 0;
21882 glyph
->face_id
= it
->face_id
;
21883 glyph
->u
.stretch
.ascent
= ascent
;
21884 glyph
->u
.stretch
.height
= height
;
21885 glyph
->slice
.img
= null_glyph_slice
;
21886 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21889 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21890 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21892 glyph
->bidi_type
= it
->bidi_it
.type
;
21896 glyph
->resolved_level
= 0;
21897 glyph
->bidi_type
= UNKNOWN_BT
;
21899 ++it
->glyph_row
->used
[area
];
21902 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21906 /* Produce a stretch glyph for iterator IT. IT->object is the value
21907 of the glyph property displayed. The value must be a list
21908 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21911 1. `:width WIDTH' specifies that the space should be WIDTH *
21912 canonical char width wide. WIDTH may be an integer or floating
21915 2. `:relative-width FACTOR' specifies that the width of the stretch
21916 should be computed from the width of the first character having the
21917 `glyph' property, and should be FACTOR times that width.
21919 3. `:align-to HPOS' specifies that the space should be wide enough
21920 to reach HPOS, a value in canonical character units.
21922 Exactly one of the above pairs must be present.
21924 4. `:height HEIGHT' specifies that the height of the stretch produced
21925 should be HEIGHT, measured in canonical character units.
21927 5. `:relative-height FACTOR' specifies that the height of the
21928 stretch should be FACTOR times the height of the characters having
21929 the glyph property.
21931 Either none or exactly one of 4 or 5 must be present.
21933 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21934 of the stretch should be used for the ascent of the stretch.
21935 ASCENT must be in the range 0 <= ASCENT <= 100. */
21938 produce_stretch_glyph (struct it
*it
)
21940 /* (space :width WIDTH :height HEIGHT ...) */
21941 Lisp_Object prop
, plist
;
21942 int width
= 0, height
= 0, align_to
= -1;
21943 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21946 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21947 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21949 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21951 /* List should start with `space'. */
21952 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21953 plist
= XCDR (it
->object
);
21955 /* Compute the width of the stretch. */
21956 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21957 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21959 /* Absolute width `:width WIDTH' specified and valid. */
21960 zero_width_ok_p
= 1;
21963 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21966 /* Relative width `:relative-width FACTOR' specified and valid.
21967 Compute the width of the characters having the `glyph'
21970 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21973 if (it
->multibyte_p
)
21974 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21977 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21978 if (! ASCII_CHAR_P (it2
.c
))
21979 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21982 it2
.glyph_row
= NULL
;
21983 it2
.what
= IT_CHARACTER
;
21984 x_produce_glyphs (&it2
);
21985 width
= NUMVAL (prop
) * it2
.pixel_width
;
21987 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21988 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21990 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21991 align_to
= (align_to
< 0
21993 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21994 else if (align_to
< 0)
21995 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21996 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21997 zero_width_ok_p
= 1;
22000 /* Nothing specified -> width defaults to canonical char width. */
22001 width
= FRAME_COLUMN_WIDTH (it
->f
);
22003 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22006 /* Compute height. */
22007 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22008 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22011 zero_height_ok_p
= 1;
22013 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22015 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22017 height
= FONT_HEIGHT (font
);
22019 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22022 /* Compute percentage of height used for ascent. If
22023 `:ascent ASCENT' is present and valid, use that. Otherwise,
22024 derive the ascent from the font in use. */
22025 if (prop
= Fplist_get (plist
, QCascent
),
22026 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22027 ascent
= height
* NUMVAL (prop
) / 100.0;
22028 else if (!NILP (prop
)
22029 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22030 ascent
= min (max (0, (int)tem
), height
);
22032 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22034 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22035 && it
->current_x
+ width
> it
->last_visible_x
)
22036 width
= it
->last_visible_x
- it
->current_x
- 1;
22038 if (width
> 0 && height
> 0 && it
->glyph_row
)
22040 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22041 if (!STRINGP (object
))
22042 object
= it
->w
->buffer
;
22043 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22046 it
->pixel_width
= width
;
22047 it
->ascent
= it
->phys_ascent
= ascent
;
22048 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22049 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22051 take_vertical_position_into_account (it
);
22054 /* Calculate line-height and line-spacing properties.
22055 An integer value specifies explicit pixel value.
22056 A float value specifies relative value to current face height.
22057 A cons (float . face-name) specifies relative value to
22058 height of specified face font.
22060 Returns height in pixels, or nil. */
22064 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22065 int boff
, int override
)
22067 Lisp_Object face_name
= Qnil
;
22068 int ascent
, descent
, height
;
22070 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22075 face_name
= XCAR (val
);
22077 if (!NUMBERP (val
))
22078 val
= make_number (1);
22079 if (NILP (face_name
))
22081 height
= it
->ascent
+ it
->descent
;
22086 if (NILP (face_name
))
22088 font
= FRAME_FONT (it
->f
);
22089 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22091 else if (EQ (face_name
, Qt
))
22100 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22102 return make_number (-1);
22104 face
= FACE_FROM_ID (it
->f
, face_id
);
22107 return make_number (-1);
22108 boff
= font
->baseline_offset
;
22109 if (font
->vertical_centering
)
22110 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22113 ascent
= FONT_BASE (font
) + boff
;
22114 descent
= FONT_DESCENT (font
) - boff
;
22118 it
->override_ascent
= ascent
;
22119 it
->override_descent
= descent
;
22120 it
->override_boff
= boff
;
22123 height
= ascent
+ descent
;
22127 height
= (int)(XFLOAT_DATA (val
) * height
);
22128 else if (INTEGERP (val
))
22129 height
*= XINT (val
);
22131 return make_number (height
);
22135 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22136 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22137 and only if this is for a character for which no font was found.
22139 If the display method (it->glyphless_method) is
22140 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22141 length of the acronym or the hexadecimal string, UPPER_XOFF and
22142 UPPER_YOFF are pixel offsets for the upper part of the string,
22143 LOWER_XOFF and LOWER_YOFF are for the lower part.
22145 For the other display methods, LEN through LOWER_YOFF are zero. */
22148 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22149 short upper_xoff
, short upper_yoff
,
22150 short lower_xoff
, short lower_yoff
)
22152 struct glyph
*glyph
;
22153 enum glyph_row_area area
= it
->area
;
22155 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22156 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22158 /* If the glyph row is reversed, we need to prepend the glyph
22159 rather than append it. */
22160 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22164 /* Make room for the additional glyph. */
22165 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22167 glyph
= it
->glyph_row
->glyphs
[area
];
22169 glyph
->charpos
= CHARPOS (it
->position
);
22170 glyph
->object
= it
->object
;
22171 glyph
->pixel_width
= it
->pixel_width
;
22172 glyph
->ascent
= it
->ascent
;
22173 glyph
->descent
= it
->descent
;
22174 glyph
->voffset
= it
->voffset
;
22175 glyph
->type
= GLYPHLESS_GLYPH
;
22176 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22177 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22178 glyph
->u
.glyphless
.len
= len
;
22179 glyph
->u
.glyphless
.ch
= it
->c
;
22180 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22181 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22182 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22183 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22184 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22185 glyph
->multibyte_p
= it
->multibyte_p
;
22186 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22187 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22188 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22189 || it
->phys_descent
> it
->descent
);
22190 glyph
->padding_p
= 0;
22191 glyph
->glyph_not_available_p
= 0;
22192 glyph
->face_id
= face_id
;
22193 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22196 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22197 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22199 glyph
->bidi_type
= it
->bidi_it
.type
;
22201 ++it
->glyph_row
->used
[area
];
22204 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22208 /* Produce a glyph for a glyphless character for iterator IT.
22209 IT->glyphless_method specifies which method to use for displaying
22210 the character. See the description of enum
22211 glyphless_display_method in dispextern.h for the detail.
22213 FOR_NO_FONT is nonzero if and only if this is for a character for
22214 which no font was found. ACRONYM, if non-nil, is an acronym string
22215 for the character. */
22218 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22223 int base_width
, base_height
, width
, height
;
22224 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22227 /* Get the metrics of the base font. We always refer to the current
22229 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22230 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22231 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22232 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22233 base_height
= it
->ascent
+ it
->descent
;
22234 base_width
= font
->average_width
;
22236 /* Get a face ID for the glyph by utilizing a cache (the same way as
22237 doen for `escape-glyph' in get_next_display_element). */
22238 if (it
->f
== last_glyphless_glyph_frame
22239 && it
->face_id
== last_glyphless_glyph_face_id
)
22241 face_id
= last_glyphless_glyph_merged_face_id
;
22245 /* Merge the `glyphless-char' face into the current face. */
22246 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22247 last_glyphless_glyph_frame
= it
->f
;
22248 last_glyphless_glyph_face_id
= it
->face_id
;
22249 last_glyphless_glyph_merged_face_id
= face_id
;
22252 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22254 it
->pixel_width
= THIN_SPACE_WIDTH
;
22256 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22258 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22260 width
= CHAR_WIDTH (it
->c
);
22263 else if (width
> 4)
22265 it
->pixel_width
= base_width
* width
;
22267 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22272 unsigned int code
[6];
22274 int ascent
, descent
;
22275 struct font_metrics metrics_upper
, metrics_lower
;
22277 face
= FACE_FROM_ID (it
->f
, face_id
);
22278 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22279 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22281 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22283 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22284 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22285 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22289 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22290 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22293 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22294 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22295 upper_len
= (len
+ 1) / 2;
22296 font
->driver
->text_extents (font
, code
, upper_len
,
22298 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22303 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22304 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22305 upper_xoff
= upper_yoff
= 2; /* the typical case */
22306 if (base_width
>= width
)
22308 /* Align the upper to the left, the lower to the right. */
22309 it
->pixel_width
= base_width
;
22310 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22314 /* Center the shorter one. */
22315 it
->pixel_width
= width
;
22316 if (metrics_upper
.width
>= metrics_lower
.width
)
22317 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22319 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22322 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22323 top, bottom, and between upper and lower strings. */
22324 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22325 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22326 /* Center vertically.
22327 H:base_height, D:base_descent
22328 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22330 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22331 descent = D - H/2 + h/2;
22332 lower_yoff = descent - 2 - ld;
22333 upper_yoff = lower_yoff - la - 1 - ud; */
22334 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22335 descent
= it
->descent
- (base_height
- height
) / 2;
22336 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22337 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22338 - metrics_upper
.descent
);
22339 /* Don't make the height shorter than the base height. */
22340 if (height
> base_height
)
22342 it
->ascent
= ascent
;
22343 it
->descent
= descent
;
22347 it
->phys_ascent
= it
->ascent
;
22348 it
->phys_descent
= it
->descent
;
22350 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22351 upper_xoff
, upper_yoff
,
22352 lower_xoff
, lower_yoff
);
22354 take_vertical_position_into_account (it
);
22359 Produce glyphs/get display metrics for the display element IT is
22360 loaded with. See the description of struct it in dispextern.h
22361 for an overview of struct it. */
22364 x_produce_glyphs (struct it
*it
)
22366 int extra_line_spacing
= it
->extra_line_spacing
;
22368 it
->glyph_not_available_p
= 0;
22370 if (it
->what
== IT_CHARACTER
)
22373 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22374 struct font
*font
= face
->font
;
22375 struct font_metrics
*pcm
= NULL
;
22376 int boff
; /* baseline offset */
22380 /* When no suitable font is found, display this character by
22381 the method specified in the first extra slot of
22382 Vglyphless_char_display. */
22383 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22385 xassert (it
->what
== IT_GLYPHLESS
);
22386 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22390 boff
= font
->baseline_offset
;
22391 if (font
->vertical_centering
)
22392 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22394 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22400 if (it
->override_ascent
>= 0)
22402 it
->ascent
= it
->override_ascent
;
22403 it
->descent
= it
->override_descent
;
22404 boff
= it
->override_boff
;
22408 it
->ascent
= FONT_BASE (font
) + boff
;
22409 it
->descent
= FONT_DESCENT (font
) - boff
;
22412 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22414 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22415 if (pcm
->width
== 0
22416 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22422 it
->phys_ascent
= pcm
->ascent
+ boff
;
22423 it
->phys_descent
= pcm
->descent
- boff
;
22424 it
->pixel_width
= pcm
->width
;
22428 it
->glyph_not_available_p
= 1;
22429 it
->phys_ascent
= it
->ascent
;
22430 it
->phys_descent
= it
->descent
;
22431 it
->pixel_width
= font
->space_width
;
22434 if (it
->constrain_row_ascent_descent_p
)
22436 if (it
->descent
> it
->max_descent
)
22438 it
->ascent
+= it
->descent
- it
->max_descent
;
22439 it
->descent
= it
->max_descent
;
22441 if (it
->ascent
> it
->max_ascent
)
22443 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22444 it
->ascent
= it
->max_ascent
;
22446 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22447 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22448 extra_line_spacing
= 0;
22451 /* If this is a space inside a region of text with
22452 `space-width' property, change its width. */
22453 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22455 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22457 /* If face has a box, add the box thickness to the character
22458 height. If character has a box line to the left and/or
22459 right, add the box line width to the character's width. */
22460 if (face
->box
!= FACE_NO_BOX
)
22462 int thick
= face
->box_line_width
;
22466 it
->ascent
+= thick
;
22467 it
->descent
+= thick
;
22472 if (it
->start_of_box_run_p
)
22473 it
->pixel_width
+= thick
;
22474 if (it
->end_of_box_run_p
)
22475 it
->pixel_width
+= thick
;
22478 /* If face has an overline, add the height of the overline
22479 (1 pixel) and a 1 pixel margin to the character height. */
22480 if (face
->overline_p
)
22481 it
->ascent
+= overline_margin
;
22483 if (it
->constrain_row_ascent_descent_p
)
22485 if (it
->ascent
> it
->max_ascent
)
22486 it
->ascent
= it
->max_ascent
;
22487 if (it
->descent
> it
->max_descent
)
22488 it
->descent
= it
->max_descent
;
22491 take_vertical_position_into_account (it
);
22493 /* If we have to actually produce glyphs, do it. */
22498 /* Translate a space with a `space-width' property
22499 into a stretch glyph. */
22500 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22501 / FONT_HEIGHT (font
));
22502 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22503 it
->ascent
+ it
->descent
, ascent
);
22508 /* If characters with lbearing or rbearing are displayed
22509 in this line, record that fact in a flag of the
22510 glyph row. This is used to optimize X output code. */
22511 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22512 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22514 if (! stretched_p
&& it
->pixel_width
== 0)
22515 /* We assure that all visible glyphs have at least 1-pixel
22517 it
->pixel_width
= 1;
22519 else if (it
->char_to_display
== '\n')
22521 /* A newline has no width, but we need the height of the
22522 line. But if previous part of the line sets a height,
22523 don't increase that height */
22525 Lisp_Object height
;
22526 Lisp_Object total_height
= Qnil
;
22528 it
->override_ascent
= -1;
22529 it
->pixel_width
= 0;
22532 height
= get_it_property (it
, Qline_height
);
22533 /* Split (line-height total-height) list */
22535 && CONSP (XCDR (height
))
22536 && NILP (XCDR (XCDR (height
))))
22538 total_height
= XCAR (XCDR (height
));
22539 height
= XCAR (height
);
22541 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22543 if (it
->override_ascent
>= 0)
22545 it
->ascent
= it
->override_ascent
;
22546 it
->descent
= it
->override_descent
;
22547 boff
= it
->override_boff
;
22551 it
->ascent
= FONT_BASE (font
) + boff
;
22552 it
->descent
= FONT_DESCENT (font
) - boff
;
22555 if (EQ (height
, Qt
))
22557 if (it
->descent
> it
->max_descent
)
22559 it
->ascent
+= it
->descent
- it
->max_descent
;
22560 it
->descent
= it
->max_descent
;
22562 if (it
->ascent
> it
->max_ascent
)
22564 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22565 it
->ascent
= it
->max_ascent
;
22567 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22568 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22569 it
->constrain_row_ascent_descent_p
= 1;
22570 extra_line_spacing
= 0;
22574 Lisp_Object spacing
;
22576 it
->phys_ascent
= it
->ascent
;
22577 it
->phys_descent
= it
->descent
;
22579 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22580 && face
->box
!= FACE_NO_BOX
22581 && face
->box_line_width
> 0)
22583 it
->ascent
+= face
->box_line_width
;
22584 it
->descent
+= face
->box_line_width
;
22587 && XINT (height
) > it
->ascent
+ it
->descent
)
22588 it
->ascent
= XINT (height
) - it
->descent
;
22590 if (!NILP (total_height
))
22591 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22594 spacing
= get_it_property (it
, Qline_spacing
);
22595 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22597 if (INTEGERP (spacing
))
22599 extra_line_spacing
= XINT (spacing
);
22600 if (!NILP (total_height
))
22601 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22605 else /* i.e. (it->char_to_display == '\t') */
22607 if (font
->space_width
> 0)
22609 int tab_width
= it
->tab_width
* font
->space_width
;
22610 int x
= it
->current_x
+ it
->continuation_lines_width
;
22611 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22613 /* If the distance from the current position to the next tab
22614 stop is less than a space character width, use the
22615 tab stop after that. */
22616 if (next_tab_x
- x
< font
->space_width
)
22617 next_tab_x
+= tab_width
;
22619 it
->pixel_width
= next_tab_x
- x
;
22621 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22622 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22626 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22627 it
->ascent
+ it
->descent
, it
->ascent
);
22632 it
->pixel_width
= 0;
22637 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22639 /* A static composition.
22641 Note: A composition is represented as one glyph in the
22642 glyph matrix. There are no padding glyphs.
22644 Important note: pixel_width, ascent, and descent are the
22645 values of what is drawn by draw_glyphs (i.e. the values of
22646 the overall glyphs composed). */
22647 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22648 int boff
; /* baseline offset */
22649 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22650 int glyph_len
= cmp
->glyph_len
;
22651 struct font
*font
= face
->font
;
22655 /* If we have not yet calculated pixel size data of glyphs of
22656 the composition for the current face font, calculate them
22657 now. Theoretically, we have to check all fonts for the
22658 glyphs, but that requires much time and memory space. So,
22659 here we check only the font of the first glyph. This may
22660 lead to incorrect display, but it's very rare, and C-l
22661 (recenter-top-bottom) can correct the display anyway. */
22662 if (! cmp
->font
|| cmp
->font
!= font
)
22664 /* Ascent and descent of the font of the first character
22665 of this composition (adjusted by baseline offset).
22666 Ascent and descent of overall glyphs should not be less
22667 than these, respectively. */
22668 int font_ascent
, font_descent
, font_height
;
22669 /* Bounding box of the overall glyphs. */
22670 int leftmost
, rightmost
, lowest
, highest
;
22671 int lbearing
, rbearing
;
22672 int i
, width
, ascent
, descent
;
22673 int left_padded
= 0, right_padded
= 0;
22676 struct font_metrics
*pcm
;
22677 int font_not_found_p
;
22680 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22681 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22683 if (glyph_len
< cmp
->glyph_len
)
22685 for (i
= 0; i
< glyph_len
; i
++)
22687 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22689 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22694 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22695 : IT_CHARPOS (*it
));
22696 /* If no suitable font is found, use the default font. */
22697 font_not_found_p
= font
== NULL
;
22698 if (font_not_found_p
)
22700 face
= face
->ascii_face
;
22703 boff
= font
->baseline_offset
;
22704 if (font
->vertical_centering
)
22705 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22706 font_ascent
= FONT_BASE (font
) + boff
;
22707 font_descent
= FONT_DESCENT (font
) - boff
;
22708 font_height
= FONT_HEIGHT (font
);
22710 cmp
->font
= (void *) font
;
22713 if (! font_not_found_p
)
22715 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22716 &char2b
, it
->multibyte_p
, 0);
22717 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22720 /* Initialize the bounding box. */
22723 width
= pcm
->width
;
22724 ascent
= pcm
->ascent
;
22725 descent
= pcm
->descent
;
22726 lbearing
= pcm
->lbearing
;
22727 rbearing
= pcm
->rbearing
;
22731 width
= font
->space_width
;
22732 ascent
= FONT_BASE (font
);
22733 descent
= FONT_DESCENT (font
);
22740 lowest
= - descent
+ boff
;
22741 highest
= ascent
+ boff
;
22743 if (! font_not_found_p
22744 && font
->default_ascent
22745 && CHAR_TABLE_P (Vuse_default_ascent
)
22746 && !NILP (Faref (Vuse_default_ascent
,
22747 make_number (it
->char_to_display
))))
22748 highest
= font
->default_ascent
+ boff
;
22750 /* Draw the first glyph at the normal position. It may be
22751 shifted to right later if some other glyphs are drawn
22753 cmp
->offsets
[i
* 2] = 0;
22754 cmp
->offsets
[i
* 2 + 1] = boff
;
22755 cmp
->lbearing
= lbearing
;
22756 cmp
->rbearing
= rbearing
;
22758 /* Set cmp->offsets for the remaining glyphs. */
22759 for (i
++; i
< glyph_len
; i
++)
22761 int left
, right
, btm
, top
;
22762 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22764 struct face
*this_face
;
22769 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22770 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22771 font
= this_face
->font
;
22777 this_boff
= font
->baseline_offset
;
22778 if (font
->vertical_centering
)
22779 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22780 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22781 &char2b
, it
->multibyte_p
, 0);
22782 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22785 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22788 width
= pcm
->width
;
22789 ascent
= pcm
->ascent
;
22790 descent
= pcm
->descent
;
22791 lbearing
= pcm
->lbearing
;
22792 rbearing
= pcm
->rbearing
;
22793 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22795 /* Relative composition with or without
22796 alternate chars. */
22797 left
= (leftmost
+ rightmost
- width
) / 2;
22798 btm
= - descent
+ boff
;
22799 if (font
->relative_compose
22800 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22801 || NILP (Faref (Vignore_relative_composition
,
22802 make_number (ch
)))))
22805 if (- descent
>= font
->relative_compose
)
22806 /* One extra pixel between two glyphs. */
22808 else if (ascent
<= 0)
22809 /* One extra pixel between two glyphs. */
22810 btm
= lowest
- 1 - ascent
- descent
;
22815 /* A composition rule is specified by an integer
22816 value that encodes global and new reference
22817 points (GREF and NREF). GREF and NREF are
22818 specified by numbers as below:
22820 0---1---2 -- ascent
22824 9--10--11 -- center
22826 ---3---4---5--- baseline
22828 6---7---8 -- descent
22830 int rule
= COMPOSITION_RULE (cmp
, i
);
22831 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22833 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22834 grefx
= gref
% 3, nrefx
= nref
% 3;
22835 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22837 xoff
= font_height
* (xoff
- 128) / 256;
22839 yoff
= font_height
* (yoff
- 128) / 256;
22842 + grefx
* (rightmost
- leftmost
) / 2
22843 - nrefx
* width
/ 2
22846 btm
= ((grefy
== 0 ? highest
22848 : grefy
== 2 ? lowest
22849 : (highest
+ lowest
) / 2)
22850 - (nrefy
== 0 ? ascent
+ descent
22851 : nrefy
== 1 ? descent
- boff
22853 : (ascent
+ descent
) / 2)
22857 cmp
->offsets
[i
* 2] = left
;
22858 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22860 /* Update the bounding box of the overall glyphs. */
22863 right
= left
+ width
;
22864 if (left
< leftmost
)
22866 if (right
> rightmost
)
22869 top
= btm
+ descent
+ ascent
;
22875 if (cmp
->lbearing
> left
+ lbearing
)
22876 cmp
->lbearing
= left
+ lbearing
;
22877 if (cmp
->rbearing
< left
+ rbearing
)
22878 cmp
->rbearing
= left
+ rbearing
;
22882 /* If there are glyphs whose x-offsets are negative,
22883 shift all glyphs to the right and make all x-offsets
22887 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22888 cmp
->offsets
[i
* 2] -= leftmost
;
22889 rightmost
-= leftmost
;
22890 cmp
->lbearing
-= leftmost
;
22891 cmp
->rbearing
-= leftmost
;
22894 if (left_padded
&& cmp
->lbearing
< 0)
22896 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22897 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22898 rightmost
-= cmp
->lbearing
;
22899 cmp
->rbearing
-= cmp
->lbearing
;
22902 if (right_padded
&& rightmost
< cmp
->rbearing
)
22904 rightmost
= cmp
->rbearing
;
22907 cmp
->pixel_width
= rightmost
;
22908 cmp
->ascent
= highest
;
22909 cmp
->descent
= - lowest
;
22910 if (cmp
->ascent
< font_ascent
)
22911 cmp
->ascent
= font_ascent
;
22912 if (cmp
->descent
< font_descent
)
22913 cmp
->descent
= font_descent
;
22917 && (cmp
->lbearing
< 0
22918 || cmp
->rbearing
> cmp
->pixel_width
))
22919 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22921 it
->pixel_width
= cmp
->pixel_width
;
22922 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22923 it
->descent
= it
->phys_descent
= cmp
->descent
;
22924 if (face
->box
!= FACE_NO_BOX
)
22926 int thick
= face
->box_line_width
;
22930 it
->ascent
+= thick
;
22931 it
->descent
+= thick
;
22936 if (it
->start_of_box_run_p
)
22937 it
->pixel_width
+= thick
;
22938 if (it
->end_of_box_run_p
)
22939 it
->pixel_width
+= thick
;
22942 /* If face has an overline, add the height of the overline
22943 (1 pixel) and a 1 pixel margin to the character height. */
22944 if (face
->overline_p
)
22945 it
->ascent
+= overline_margin
;
22947 take_vertical_position_into_account (it
);
22948 if (it
->ascent
< 0)
22950 if (it
->descent
< 0)
22954 append_composite_glyph (it
);
22956 else if (it
->what
== IT_COMPOSITION
)
22958 /* A dynamic (automatic) composition. */
22959 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22960 Lisp_Object gstring
;
22961 struct font_metrics metrics
;
22963 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22965 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22968 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22969 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22970 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22971 it
->descent
= it
->phys_descent
= metrics
.descent
;
22972 if (face
->box
!= FACE_NO_BOX
)
22974 int thick
= face
->box_line_width
;
22978 it
->ascent
+= thick
;
22979 it
->descent
+= thick
;
22984 if (it
->start_of_box_run_p
)
22985 it
->pixel_width
+= thick
;
22986 if (it
->end_of_box_run_p
)
22987 it
->pixel_width
+= thick
;
22989 /* If face has an overline, add the height of the overline
22990 (1 pixel) and a 1 pixel margin to the character height. */
22991 if (face
->overline_p
)
22992 it
->ascent
+= overline_margin
;
22993 take_vertical_position_into_account (it
);
22994 if (it
->ascent
< 0)
22996 if (it
->descent
< 0)
23000 append_composite_glyph (it
);
23002 else if (it
->what
== IT_GLYPHLESS
)
23003 produce_glyphless_glyph (it
, 0, Qnil
);
23004 else if (it
->what
== IT_IMAGE
)
23005 produce_image_glyph (it
);
23006 else if (it
->what
== IT_STRETCH
)
23007 produce_stretch_glyph (it
);
23010 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23011 because this isn't true for images with `:ascent 100'. */
23012 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23013 if (it
->area
== TEXT_AREA
)
23014 it
->current_x
+= it
->pixel_width
;
23016 if (extra_line_spacing
> 0)
23018 it
->descent
+= extra_line_spacing
;
23019 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23020 it
->max_extra_line_spacing
= extra_line_spacing
;
23023 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23024 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23025 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23026 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23030 Output LEN glyphs starting at START at the nominal cursor position.
23031 Advance the nominal cursor over the text. The global variable
23032 updated_window contains the window being updated, updated_row is
23033 the glyph row being updated, and updated_area is the area of that
23034 row being updated. */
23037 x_write_glyphs (struct glyph
*start
, int len
)
23041 xassert (updated_window
&& updated_row
);
23044 /* Write glyphs. */
23046 hpos
= start
- updated_row
->glyphs
[updated_area
];
23047 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23048 updated_row
, updated_area
,
23050 DRAW_NORMAL_TEXT
, 0);
23052 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23053 if (updated_area
== TEXT_AREA
23054 && updated_window
->phys_cursor_on_p
23055 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23056 && updated_window
->phys_cursor
.hpos
>= hpos
23057 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23058 updated_window
->phys_cursor_on_p
= 0;
23062 /* Advance the output cursor. */
23063 output_cursor
.hpos
+= len
;
23064 output_cursor
.x
= x
;
23069 Insert LEN glyphs from START at the nominal cursor position. */
23072 x_insert_glyphs (struct glyph
*start
, int len
)
23076 int line_height
, shift_by_width
, shifted_region_width
;
23077 struct glyph_row
*row
;
23078 struct glyph
*glyph
;
23079 int frame_x
, frame_y
;
23082 xassert (updated_window
&& updated_row
);
23084 w
= updated_window
;
23085 f
= XFRAME (WINDOW_FRAME (w
));
23087 /* Get the height of the line we are in. */
23089 line_height
= row
->height
;
23091 /* Get the width of the glyphs to insert. */
23092 shift_by_width
= 0;
23093 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23094 shift_by_width
+= glyph
->pixel_width
;
23096 /* Get the width of the region to shift right. */
23097 shifted_region_width
= (window_box_width (w
, updated_area
)
23102 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23103 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23105 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23106 line_height
, shift_by_width
);
23108 /* Write the glyphs. */
23109 hpos
= start
- row
->glyphs
[updated_area
];
23110 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23112 DRAW_NORMAL_TEXT
, 0);
23114 /* Advance the output cursor. */
23115 output_cursor
.hpos
+= len
;
23116 output_cursor
.x
+= shift_by_width
;
23122 Erase the current text line from the nominal cursor position
23123 (inclusive) to pixel column TO_X (exclusive). The idea is that
23124 everything from TO_X onward is already erased.
23126 TO_X is a pixel position relative to updated_area of
23127 updated_window. TO_X == -1 means clear to the end of this area. */
23130 x_clear_end_of_line (int to_x
)
23133 struct window
*w
= updated_window
;
23134 int max_x
, min_y
, max_y
;
23135 int from_x
, from_y
, to_y
;
23137 xassert (updated_window
&& updated_row
);
23138 f
= XFRAME (w
->frame
);
23140 if (updated_row
->full_width_p
)
23141 max_x
= WINDOW_TOTAL_WIDTH (w
);
23143 max_x
= window_box_width (w
, updated_area
);
23144 max_y
= window_text_bottom_y (w
);
23146 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23147 of window. For TO_X > 0, truncate to end of drawing area. */
23153 to_x
= min (to_x
, max_x
);
23155 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23157 /* Notice if the cursor will be cleared by this operation. */
23158 if (!updated_row
->full_width_p
)
23159 notice_overwritten_cursor (w
, updated_area
,
23160 output_cursor
.x
, -1,
23162 MATRIX_ROW_BOTTOM_Y (updated_row
));
23164 from_x
= output_cursor
.x
;
23166 /* Translate to frame coordinates. */
23167 if (updated_row
->full_width_p
)
23169 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23170 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23174 int area_left
= window_box_left (w
, updated_area
);
23175 from_x
+= area_left
;
23179 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23180 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23181 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23183 /* Prevent inadvertently clearing to end of the X window. */
23184 if (to_x
> from_x
&& to_y
> from_y
)
23187 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23188 to_x
- from_x
, to_y
- from_y
);
23193 #endif /* HAVE_WINDOW_SYSTEM */
23197 /***********************************************************************
23199 ***********************************************************************/
23201 /* Value is the internal representation of the specified cursor type
23202 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23203 of the bar cursor. */
23205 static enum text_cursor_kinds
23206 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23208 enum text_cursor_kinds type
;
23213 if (EQ (arg
, Qbox
))
23214 return FILLED_BOX_CURSOR
;
23216 if (EQ (arg
, Qhollow
))
23217 return HOLLOW_BOX_CURSOR
;
23219 if (EQ (arg
, Qbar
))
23226 && EQ (XCAR (arg
), Qbar
)
23227 && INTEGERP (XCDR (arg
))
23228 && XINT (XCDR (arg
)) >= 0)
23230 *width
= XINT (XCDR (arg
));
23234 if (EQ (arg
, Qhbar
))
23237 return HBAR_CURSOR
;
23241 && EQ (XCAR (arg
), Qhbar
)
23242 && INTEGERP (XCDR (arg
))
23243 && XINT (XCDR (arg
)) >= 0)
23245 *width
= XINT (XCDR (arg
));
23246 return HBAR_CURSOR
;
23249 /* Treat anything unknown as "hollow box cursor".
23250 It was bad to signal an error; people have trouble fixing
23251 .Xdefaults with Emacs, when it has something bad in it. */
23252 type
= HOLLOW_BOX_CURSOR
;
23257 /* Set the default cursor types for specified frame. */
23259 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23264 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23265 FRAME_CURSOR_WIDTH (f
) = width
;
23267 /* By default, set up the blink-off state depending on the on-state. */
23269 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23272 FRAME_BLINK_OFF_CURSOR (f
)
23273 = get_specified_cursor_type (XCDR (tem
), &width
);
23274 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23277 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23281 #ifdef HAVE_WINDOW_SYSTEM
23283 /* Return the cursor we want to be displayed in window W. Return
23284 width of bar/hbar cursor through WIDTH arg. Return with
23285 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23286 (i.e. if the `system caret' should track this cursor).
23288 In a mini-buffer window, we want the cursor only to appear if we
23289 are reading input from this window. For the selected window, we
23290 want the cursor type given by the frame parameter or buffer local
23291 setting of cursor-type. If explicitly marked off, draw no cursor.
23292 In all other cases, we want a hollow box cursor. */
23294 static enum text_cursor_kinds
23295 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23296 int *active_cursor
)
23298 struct frame
*f
= XFRAME (w
->frame
);
23299 struct buffer
*b
= XBUFFER (w
->buffer
);
23300 int cursor_type
= DEFAULT_CURSOR
;
23301 Lisp_Object alt_cursor
;
23302 int non_selected
= 0;
23304 *active_cursor
= 1;
23307 if (cursor_in_echo_area
23308 && FRAME_HAS_MINIBUF_P (f
)
23309 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23311 if (w
== XWINDOW (echo_area_window
))
23313 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23315 *width
= FRAME_CURSOR_WIDTH (f
);
23316 return FRAME_DESIRED_CURSOR (f
);
23319 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23322 *active_cursor
= 0;
23326 /* Detect a nonselected window or nonselected frame. */
23327 else if (w
!= XWINDOW (f
->selected_window
)
23328 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23330 *active_cursor
= 0;
23332 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23338 /* Never display a cursor in a window in which cursor-type is nil. */
23339 if (NILP (BVAR (b
, cursor_type
)))
23342 /* Get the normal cursor type for this window. */
23343 if (EQ (BVAR (b
, cursor_type
), Qt
))
23345 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23346 *width
= FRAME_CURSOR_WIDTH (f
);
23349 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23351 /* Use cursor-in-non-selected-windows instead
23352 for non-selected window or frame. */
23355 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23356 if (!EQ (Qt
, alt_cursor
))
23357 return get_specified_cursor_type (alt_cursor
, width
);
23358 /* t means modify the normal cursor type. */
23359 if (cursor_type
== FILLED_BOX_CURSOR
)
23360 cursor_type
= HOLLOW_BOX_CURSOR
;
23361 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23363 return cursor_type
;
23366 /* Use normal cursor if not blinked off. */
23367 if (!w
->cursor_off_p
)
23369 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23371 if (cursor_type
== FILLED_BOX_CURSOR
)
23373 /* Using a block cursor on large images can be very annoying.
23374 So use a hollow cursor for "large" images.
23375 If image is not transparent (no mask), also use hollow cursor. */
23376 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23377 if (img
!= NULL
&& IMAGEP (img
->spec
))
23379 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23380 where N = size of default frame font size.
23381 This should cover most of the "tiny" icons people may use. */
23383 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23384 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23385 cursor_type
= HOLLOW_BOX_CURSOR
;
23388 else if (cursor_type
!= NO_CURSOR
)
23390 /* Display current only supports BOX and HOLLOW cursors for images.
23391 So for now, unconditionally use a HOLLOW cursor when cursor is
23392 not a solid box cursor. */
23393 cursor_type
= HOLLOW_BOX_CURSOR
;
23396 return cursor_type
;
23399 /* Cursor is blinked off, so determine how to "toggle" it. */
23401 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23402 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23403 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23405 /* Then see if frame has specified a specific blink off cursor type. */
23406 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23408 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23409 return FRAME_BLINK_OFF_CURSOR (f
);
23413 /* Some people liked having a permanently visible blinking cursor,
23414 while others had very strong opinions against it. So it was
23415 decided to remove it. KFS 2003-09-03 */
23417 /* Finally perform built-in cursor blinking:
23418 filled box <-> hollow box
23419 wide [h]bar <-> narrow [h]bar
23420 narrow [h]bar <-> no cursor
23421 other type <-> no cursor */
23423 if (cursor_type
== FILLED_BOX_CURSOR
)
23424 return HOLLOW_BOX_CURSOR
;
23426 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23429 return cursor_type
;
23437 /* Notice when the text cursor of window W has been completely
23438 overwritten by a drawing operation that outputs glyphs in AREA
23439 starting at X0 and ending at X1 in the line starting at Y0 and
23440 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23441 the rest of the line after X0 has been written. Y coordinates
23442 are window-relative. */
23445 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23446 int x0
, int x1
, int y0
, int y1
)
23448 int cx0
, cx1
, cy0
, cy1
;
23449 struct glyph_row
*row
;
23451 if (!w
->phys_cursor_on_p
)
23453 if (area
!= TEXT_AREA
)
23456 if (w
->phys_cursor
.vpos
< 0
23457 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23458 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23459 !(row
->enabled_p
&& row
->displays_text_p
)))
23462 if (row
->cursor_in_fringe_p
)
23464 row
->cursor_in_fringe_p
= 0;
23465 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23466 w
->phys_cursor_on_p
= 0;
23470 cx0
= w
->phys_cursor
.x
;
23471 cx1
= cx0
+ w
->phys_cursor_width
;
23472 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23475 /* The cursor image will be completely removed from the
23476 screen if the output area intersects the cursor area in
23477 y-direction. When we draw in [y0 y1[, and some part of
23478 the cursor is at y < y0, that part must have been drawn
23479 before. When scrolling, the cursor is erased before
23480 actually scrolling, so we don't come here. When not
23481 scrolling, the rows above the old cursor row must have
23482 changed, and in this case these rows must have written
23483 over the cursor image.
23485 Likewise if part of the cursor is below y1, with the
23486 exception of the cursor being in the first blank row at
23487 the buffer and window end because update_text_area
23488 doesn't draw that row. (Except when it does, but
23489 that's handled in update_text_area.) */
23491 cy0
= w
->phys_cursor
.y
;
23492 cy1
= cy0
+ w
->phys_cursor_height
;
23493 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23496 w
->phys_cursor_on_p
= 0;
23499 #endif /* HAVE_WINDOW_SYSTEM */
23502 /************************************************************************
23504 ************************************************************************/
23506 #ifdef HAVE_WINDOW_SYSTEM
23509 Fix the display of area AREA of overlapping row ROW in window W
23510 with respect to the overlapping part OVERLAPS. */
23513 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23514 enum glyph_row_area area
, int overlaps
)
23521 for (i
= 0; i
< row
->used
[area
];)
23523 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23525 int start
= i
, start_x
= x
;
23529 x
+= row
->glyphs
[area
][i
].pixel_width
;
23532 while (i
< row
->used
[area
]
23533 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23535 draw_glyphs (w
, start_x
, row
, area
,
23537 DRAW_NORMAL_TEXT
, overlaps
);
23541 x
+= row
->glyphs
[area
][i
].pixel_width
;
23551 Draw the cursor glyph of window W in glyph row ROW. See the
23552 comment of draw_glyphs for the meaning of HL. */
23555 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23556 enum draw_glyphs_face hl
)
23558 /* If cursor hpos is out of bounds, don't draw garbage. This can
23559 happen in mini-buffer windows when switching between echo area
23560 glyphs and mini-buffer. */
23561 if ((row
->reversed_p
23562 ? (w
->phys_cursor
.hpos
>= 0)
23563 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23565 int on_p
= w
->phys_cursor_on_p
;
23567 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23568 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23570 w
->phys_cursor_on_p
= on_p
;
23572 if (hl
== DRAW_CURSOR
)
23573 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23574 /* When we erase the cursor, and ROW is overlapped by other
23575 rows, make sure that these overlapping parts of other rows
23577 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23579 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23581 if (row
> w
->current_matrix
->rows
23582 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23583 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23584 OVERLAPS_ERASED_CURSOR
);
23586 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23587 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23588 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23589 OVERLAPS_ERASED_CURSOR
);
23596 Erase the image of a cursor of window W from the screen. */
23599 erase_phys_cursor (struct window
*w
)
23601 struct frame
*f
= XFRAME (w
->frame
);
23602 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23603 int hpos
= w
->phys_cursor
.hpos
;
23604 int vpos
= w
->phys_cursor
.vpos
;
23605 int mouse_face_here_p
= 0;
23606 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23607 struct glyph_row
*cursor_row
;
23608 struct glyph
*cursor_glyph
;
23609 enum draw_glyphs_face hl
;
23611 /* No cursor displayed or row invalidated => nothing to do on the
23613 if (w
->phys_cursor_type
== NO_CURSOR
)
23614 goto mark_cursor_off
;
23616 /* VPOS >= active_glyphs->nrows means that window has been resized.
23617 Don't bother to erase the cursor. */
23618 if (vpos
>= active_glyphs
->nrows
)
23619 goto mark_cursor_off
;
23621 /* If row containing cursor is marked invalid, there is nothing we
23623 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23624 if (!cursor_row
->enabled_p
)
23625 goto mark_cursor_off
;
23627 /* If line spacing is > 0, old cursor may only be partially visible in
23628 window after split-window. So adjust visible height. */
23629 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23630 window_text_bottom_y (w
) - cursor_row
->y
);
23632 /* If row is completely invisible, don't attempt to delete a cursor which
23633 isn't there. This can happen if cursor is at top of a window, and
23634 we switch to a buffer with a header line in that window. */
23635 if (cursor_row
->visible_height
<= 0)
23636 goto mark_cursor_off
;
23638 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23639 if (cursor_row
->cursor_in_fringe_p
)
23641 cursor_row
->cursor_in_fringe_p
= 0;
23642 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23643 goto mark_cursor_off
;
23646 /* This can happen when the new row is shorter than the old one.
23647 In this case, either draw_glyphs or clear_end_of_line
23648 should have cleared the cursor. Note that we wouldn't be
23649 able to erase the cursor in this case because we don't have a
23650 cursor glyph at hand. */
23651 if ((cursor_row
->reversed_p
23652 ? (w
->phys_cursor
.hpos
< 0)
23653 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23654 goto mark_cursor_off
;
23656 /* If the cursor is in the mouse face area, redisplay that when
23657 we clear the cursor. */
23658 if (! NILP (hlinfo
->mouse_face_window
)
23659 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23660 /* Don't redraw the cursor's spot in mouse face if it is at the
23661 end of a line (on a newline). The cursor appears there, but
23662 mouse highlighting does not. */
23663 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23664 mouse_face_here_p
= 1;
23666 /* Maybe clear the display under the cursor. */
23667 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23670 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23673 cursor_glyph
= get_phys_cursor_glyph (w
);
23674 if (cursor_glyph
== NULL
)
23675 goto mark_cursor_off
;
23677 width
= cursor_glyph
->pixel_width
;
23678 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23679 x
= w
->phys_cursor
.x
;
23681 width
-= left_x
- x
;
23682 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23683 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23684 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23687 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23690 /* Erase the cursor by redrawing the character underneath it. */
23691 if (mouse_face_here_p
)
23692 hl
= DRAW_MOUSE_FACE
;
23694 hl
= DRAW_NORMAL_TEXT
;
23695 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23698 w
->phys_cursor_on_p
= 0;
23699 w
->phys_cursor_type
= NO_CURSOR
;
23704 Display or clear cursor of window W. If ON is zero, clear the
23705 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23706 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23709 display_and_set_cursor (struct window
*w
, int on
,
23710 int hpos
, int vpos
, int x
, int y
)
23712 struct frame
*f
= XFRAME (w
->frame
);
23713 int new_cursor_type
;
23714 int new_cursor_width
;
23716 struct glyph_row
*glyph_row
;
23717 struct glyph
*glyph
;
23719 /* This is pointless on invisible frames, and dangerous on garbaged
23720 windows and frames; in the latter case, the frame or window may
23721 be in the midst of changing its size, and x and y may be off the
23723 if (! FRAME_VISIBLE_P (f
)
23724 || FRAME_GARBAGED_P (f
)
23725 || vpos
>= w
->current_matrix
->nrows
23726 || hpos
>= w
->current_matrix
->matrix_w
)
23729 /* If cursor is off and we want it off, return quickly. */
23730 if (!on
&& !w
->phys_cursor_on_p
)
23733 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23734 /* If cursor row is not enabled, we don't really know where to
23735 display the cursor. */
23736 if (!glyph_row
->enabled_p
)
23738 w
->phys_cursor_on_p
= 0;
23743 if (!glyph_row
->exact_window_width_line_p
23744 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23745 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23747 xassert (interrupt_input_blocked
);
23749 /* Set new_cursor_type to the cursor we want to be displayed. */
23750 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23751 &new_cursor_width
, &active_cursor
);
23753 /* If cursor is currently being shown and we don't want it to be or
23754 it is in the wrong place, or the cursor type is not what we want,
23756 if (w
->phys_cursor_on_p
23758 || w
->phys_cursor
.x
!= x
23759 || w
->phys_cursor
.y
!= y
23760 || new_cursor_type
!= w
->phys_cursor_type
23761 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23762 && new_cursor_width
!= w
->phys_cursor_width
)))
23763 erase_phys_cursor (w
);
23765 /* Don't check phys_cursor_on_p here because that flag is only set
23766 to zero in some cases where we know that the cursor has been
23767 completely erased, to avoid the extra work of erasing the cursor
23768 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23769 still not be visible, or it has only been partly erased. */
23772 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23773 w
->phys_cursor_height
= glyph_row
->height
;
23775 /* Set phys_cursor_.* before x_draw_.* is called because some
23776 of them may need the information. */
23777 w
->phys_cursor
.x
= x
;
23778 w
->phys_cursor
.y
= glyph_row
->y
;
23779 w
->phys_cursor
.hpos
= hpos
;
23780 w
->phys_cursor
.vpos
= vpos
;
23783 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23784 new_cursor_type
, new_cursor_width
,
23785 on
, active_cursor
);
23789 /* Switch the display of W's cursor on or off, according to the value
23793 update_window_cursor (struct window
*w
, int on
)
23795 /* Don't update cursor in windows whose frame is in the process
23796 of being deleted. */
23797 if (w
->current_matrix
)
23800 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23801 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23807 /* Call update_window_cursor with parameter ON_P on all leaf windows
23808 in the window tree rooted at W. */
23811 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23815 if (!NILP (w
->hchild
))
23816 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23817 else if (!NILP (w
->vchild
))
23818 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23820 update_window_cursor (w
, on_p
);
23822 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23828 Display the cursor on window W, or clear it, according to ON_P.
23829 Don't change the cursor's position. */
23832 x_update_cursor (struct frame
*f
, int on_p
)
23834 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23839 Clear the cursor of window W to background color, and mark the
23840 cursor as not shown. This is used when the text where the cursor
23841 is about to be rewritten. */
23844 x_clear_cursor (struct window
*w
)
23846 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23847 update_window_cursor (w
, 0);
23850 #endif /* HAVE_WINDOW_SYSTEM */
23852 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23855 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23856 int start_hpos
, int end_hpos
,
23857 enum draw_glyphs_face draw
)
23859 #ifdef HAVE_WINDOW_SYSTEM
23860 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23862 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23866 #if defined (HAVE_GPM) || defined (MSDOS)
23867 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23872 Display the active region described by mouse_face_* according to DRAW. */
23875 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23877 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23878 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23880 if (/* If window is in the process of being destroyed, don't bother
23882 w
->current_matrix
!= NULL
23883 /* Don't update mouse highlight if hidden */
23884 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23885 /* Recognize when we are called to operate on rows that don't exist
23886 anymore. This can happen when a window is split. */
23887 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23889 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23890 struct glyph_row
*row
, *first
, *last
;
23892 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23893 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23895 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23897 int start_hpos
, end_hpos
, start_x
;
23899 /* For all but the first row, the highlight starts at column 0. */
23902 /* R2L rows have BEG and END in reversed order, but the
23903 screen drawing geometry is always left to right. So
23904 we need to mirror the beginning and end of the
23905 highlighted area in R2L rows. */
23906 if (!row
->reversed_p
)
23908 start_hpos
= hlinfo
->mouse_face_beg_col
;
23909 start_x
= hlinfo
->mouse_face_beg_x
;
23911 else if (row
== last
)
23913 start_hpos
= hlinfo
->mouse_face_end_col
;
23914 start_x
= hlinfo
->mouse_face_end_x
;
23922 else if (row
->reversed_p
&& row
== last
)
23924 start_hpos
= hlinfo
->mouse_face_end_col
;
23925 start_x
= hlinfo
->mouse_face_end_x
;
23935 if (!row
->reversed_p
)
23936 end_hpos
= hlinfo
->mouse_face_end_col
;
23937 else if (row
== first
)
23938 end_hpos
= hlinfo
->mouse_face_beg_col
;
23941 end_hpos
= row
->used
[TEXT_AREA
];
23942 if (draw
== DRAW_NORMAL_TEXT
)
23943 row
->fill_line_p
= 1; /* Clear to end of line */
23946 else if (row
->reversed_p
&& row
== first
)
23947 end_hpos
= hlinfo
->mouse_face_beg_col
;
23950 end_hpos
= row
->used
[TEXT_AREA
];
23951 if (draw
== DRAW_NORMAL_TEXT
)
23952 row
->fill_line_p
= 1; /* Clear to end of line */
23955 if (end_hpos
> start_hpos
)
23957 draw_row_with_mouse_face (w
, start_x
, row
,
23958 start_hpos
, end_hpos
, draw
);
23961 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23965 #ifdef HAVE_WINDOW_SYSTEM
23966 /* When we've written over the cursor, arrange for it to
23967 be displayed again. */
23968 if (FRAME_WINDOW_P (f
)
23969 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23972 display_and_set_cursor (w
, 1,
23973 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23974 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23977 #endif /* HAVE_WINDOW_SYSTEM */
23980 #ifdef HAVE_WINDOW_SYSTEM
23981 /* Change the mouse cursor. */
23982 if (FRAME_WINDOW_P (f
))
23984 if (draw
== DRAW_NORMAL_TEXT
23985 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
23986 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23987 else if (draw
== DRAW_MOUSE_FACE
)
23988 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23990 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23992 #endif /* HAVE_WINDOW_SYSTEM */
23996 Clear out the mouse-highlighted active region.
23997 Redraw it un-highlighted first. Value is non-zero if mouse
23998 face was actually drawn unhighlighted. */
24001 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24005 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24007 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24011 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24012 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24013 hlinfo
->mouse_face_window
= Qnil
;
24014 hlinfo
->mouse_face_overlay
= Qnil
;
24018 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24019 within the mouse face on that window. */
24021 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24023 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24025 /* Quickly resolve the easy cases. */
24026 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24027 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24029 if (vpos
< hlinfo
->mouse_face_beg_row
24030 || vpos
> hlinfo
->mouse_face_end_row
)
24032 if (vpos
> hlinfo
->mouse_face_beg_row
24033 && vpos
< hlinfo
->mouse_face_end_row
)
24036 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24038 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24040 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24043 else if ((vpos
== hlinfo
->mouse_face_beg_row
24044 && hpos
>= hlinfo
->mouse_face_beg_col
)
24045 || (vpos
== hlinfo
->mouse_face_end_row
24046 && hpos
< hlinfo
->mouse_face_end_col
))
24051 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24053 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24056 else if ((vpos
== hlinfo
->mouse_face_beg_row
24057 && hpos
<= hlinfo
->mouse_face_beg_col
)
24058 || (vpos
== hlinfo
->mouse_face_end_row
24059 && hpos
> hlinfo
->mouse_face_end_col
))
24067 Non-zero if physical cursor of window W is within mouse face. */
24070 cursor_in_mouse_face_p (struct window
*w
)
24072 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24077 /* Find the glyph rows START_ROW and END_ROW of window W that display
24078 characters between buffer positions START_CHARPOS and END_CHARPOS
24079 (excluding END_CHARPOS). This is similar to row_containing_pos,
24080 but is more accurate when bidi reordering makes buffer positions
24081 change non-linearly with glyph rows. */
24083 rows_from_pos_range (struct window
*w
,
24084 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24085 struct glyph_row
**start
, struct glyph_row
**end
)
24087 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24088 int last_y
= window_text_bottom_y (w
);
24089 struct glyph_row
*row
;
24094 while (!first
->enabled_p
24095 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24098 /* Find the START row. */
24100 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24103 /* A row can potentially be the START row if the range of the
24104 characters it displays intersects the range
24105 [START_CHARPOS..END_CHARPOS). */
24106 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24107 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24108 /* See the commentary in row_containing_pos, for the
24109 explanation of the complicated way to check whether
24110 some position is beyond the end of the characters
24111 displayed by a row. */
24112 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24113 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24114 && !row
->ends_at_zv_p
24115 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24116 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24117 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24118 && !row
->ends_at_zv_p
24119 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24121 /* Found a candidate row. Now make sure at least one of the
24122 glyphs it displays has a charpos from the range
24123 [START_CHARPOS..END_CHARPOS).
24125 This is not obvious because bidi reordering could make
24126 buffer positions of a row be 1,2,3,102,101,100, and if we
24127 want to highlight characters in [50..60), we don't want
24128 this row, even though [50..60) does intersect [1..103),
24129 the range of character positions given by the row's start
24130 and end positions. */
24131 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24132 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24136 if (BUFFERP (g
->object
)
24137 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24146 /* Find the END row. */
24148 /* If the last row is partially visible, start looking for END
24149 from that row, instead of starting from FIRST. */
24150 && !(row
->enabled_p
24151 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24153 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24155 struct glyph_row
*next
= row
+ 1;
24157 if (!next
->enabled_p
24158 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24159 /* The first row >= START whose range of displayed characters
24160 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24161 is the row END + 1. */
24162 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24163 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24164 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24165 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24166 && !next
->ends_at_zv_p
24167 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24168 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24169 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24170 && !next
->ends_at_zv_p
24171 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24178 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24179 but none of the characters it displays are in the range, it is
24181 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24182 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24186 if (BUFFERP (g
->object
)
24187 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24200 /* This function sets the mouse_face_* elements of HLINFO, assuming
24201 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24202 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24203 for the overlay or run of text properties specifying the mouse
24204 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24205 before-string and after-string that must also be highlighted.
24206 COVER_STRING, if non-nil, is a display string that may cover some
24207 or all of the highlighted text. */
24210 mouse_face_from_buffer_pos (Lisp_Object window
,
24211 Mouse_HLInfo
*hlinfo
,
24212 EMACS_INT mouse_charpos
,
24213 EMACS_INT start_charpos
,
24214 EMACS_INT end_charpos
,
24215 Lisp_Object before_string
,
24216 Lisp_Object after_string
,
24217 Lisp_Object cover_string
)
24219 struct window
*w
= XWINDOW (window
);
24220 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24221 struct glyph_row
*r1
, *r2
;
24222 struct glyph
*glyph
, *end
;
24223 EMACS_INT ignore
, pos
;
24226 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24227 xassert (NILP (before_string
) || STRINGP (before_string
));
24228 xassert (NILP (after_string
) || STRINGP (after_string
));
24230 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24231 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24233 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24234 /* If the before-string or display-string contains newlines,
24235 rows_from_pos_range skips to its last row. Move back. */
24236 if (!NILP (before_string
) || !NILP (cover_string
))
24238 struct glyph_row
*prev
;
24239 while ((prev
= r1
- 1, prev
>= first
)
24240 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24241 && prev
->used
[TEXT_AREA
] > 0)
24243 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24244 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24245 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24247 || !(EQ (glyph
->object
, before_string
)
24248 || EQ (glyph
->object
, cover_string
)))
24255 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24256 hlinfo
->mouse_face_past_end
= 1;
24258 else if (!NILP (after_string
))
24260 /* If the after-string has newlines, advance to its last row. */
24261 struct glyph_row
*next
;
24262 struct glyph_row
*last
24263 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24265 for (next
= r2
+ 1;
24267 && next
->used
[TEXT_AREA
] > 0
24268 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24272 /* The rest of the display engine assumes that mouse_face_beg_row is
24273 either above below mouse_face_end_row or identical to it. But
24274 with bidi-reordered continued lines, the row for START_CHARPOS
24275 could be below the row for END_CHARPOS. If so, swap the rows and
24276 store them in correct order. */
24279 struct glyph_row
*tem
= r2
;
24285 hlinfo
->mouse_face_beg_y
= r1
->y
;
24286 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24287 hlinfo
->mouse_face_end_y
= r2
->y
;
24288 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24290 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24291 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24292 could be anywhere in the row and in any order. The strategy
24293 below is to find the leftmost and the rightmost glyph that
24294 belongs to either of these 3 strings, or whose position is
24295 between START_CHARPOS and END_CHARPOS, and highlight all the
24296 glyphs between those two. This may cover more than just the text
24297 between START_CHARPOS and END_CHARPOS if the range of characters
24298 strides the bidi level boundary, e.g. if the beginning is in R2L
24299 text while the end is in L2R text or vice versa. */
24300 if (!r1
->reversed_p
)
24302 /* This row is in a left to right paragraph. Scan it left to
24304 glyph
= r1
->glyphs
[TEXT_AREA
];
24305 end
= glyph
+ r1
->used
[TEXT_AREA
];
24308 /* Skip truncation glyphs at the start of the glyph row. */
24309 if (r1
->displays_text_p
)
24311 && INTEGERP (glyph
->object
)
24312 && glyph
->charpos
< 0;
24314 x
+= glyph
->pixel_width
;
24316 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24317 or COVER_STRING, and the first glyph from buffer whose
24318 position is between START_CHARPOS and END_CHARPOS. */
24320 && !INTEGERP (glyph
->object
)
24321 && !EQ (glyph
->object
, cover_string
)
24322 && !(BUFFERP (glyph
->object
)
24323 && (glyph
->charpos
>= start_charpos
24324 && glyph
->charpos
< end_charpos
));
24327 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24328 are present at buffer positions between START_CHARPOS and
24329 END_CHARPOS, or if they come from an overlay. */
24330 if (EQ (glyph
->object
, before_string
))
24332 pos
= string_buffer_position (w
, before_string
,
24334 /* If pos == 0, it means before_string came from an
24335 overlay, not from a buffer position. */
24336 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24339 else if (EQ (glyph
->object
, after_string
))
24341 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24342 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24345 x
+= glyph
->pixel_width
;
24347 hlinfo
->mouse_face_beg_x
= x
;
24348 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24352 /* This row is in a right to left paragraph. Scan it right to
24356 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24357 glyph
= end
+ 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;
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
, start_charpos
);
24384 /* If pos == 0, it means before_string came from an
24385 overlay, not from a buffer position. */
24386 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24389 else if (EQ (glyph
->object
, after_string
))
24391 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24392 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24397 glyph
++; /* first glyph to the right of the highlighted area */
24398 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24399 x
+= g
->pixel_width
;
24400 hlinfo
->mouse_face_beg_x
= x
;
24401 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24404 /* If the highlight ends in a different row, compute GLYPH and END
24405 for the end row. Otherwise, reuse the values computed above for
24406 the row where the highlight begins. */
24409 if (!r2
->reversed_p
)
24411 glyph
= r2
->glyphs
[TEXT_AREA
];
24412 end
= glyph
+ r2
->used
[TEXT_AREA
];
24417 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24418 glyph
= end
+ r2
->used
[TEXT_AREA
];
24422 if (!r2
->reversed_p
)
24424 /* Skip truncation and continuation glyphs near the end of the
24425 row, and also blanks and stretch glyphs inserted by
24426 extend_face_to_end_of_line. */
24428 && INTEGERP ((end
- 1)->object
)
24429 && (end
- 1)->charpos
<= 0)
24431 /* Scan the rest of the glyph row from the end, looking for the
24432 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24433 COVER_STRING, or whose position is between START_CHARPOS
24437 && !INTEGERP (end
->object
)
24438 && !EQ (end
->object
, cover_string
)
24439 && !(BUFFERP (end
->object
)
24440 && (end
->charpos
>= start_charpos
24441 && end
->charpos
< end_charpos
));
24444 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24445 are present at buffer positions between START_CHARPOS and
24446 END_CHARPOS, or if they come from an overlay. */
24447 if (EQ (end
->object
, before_string
))
24449 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24450 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24453 else if (EQ (end
->object
, after_string
))
24455 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24456 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24460 /* Find the X coordinate of the last glyph to be highlighted. */
24461 for (; glyph
<= end
; ++glyph
)
24462 x
+= glyph
->pixel_width
;
24464 hlinfo
->mouse_face_end_x
= x
;
24465 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24469 /* Skip truncation and continuation glyphs near the end of the
24470 row, and also blanks and stretch glyphs inserted by
24471 extend_face_to_end_of_line. */
24475 && INTEGERP (end
->object
)
24476 && end
->charpos
<= 0)
24478 x
+= end
->pixel_width
;
24481 /* Scan the rest of the glyph row from the end, looking for the
24482 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24483 COVER_STRING, or whose position is between START_CHARPOS
24487 && !INTEGERP (end
->object
)
24488 && !EQ (end
->object
, cover_string
)
24489 && !(BUFFERP (end
->object
)
24490 && (end
->charpos
>= start_charpos
24491 && end
->charpos
< end_charpos
));
24494 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24495 are present at buffer positions between START_CHARPOS and
24496 END_CHARPOS, or if they come from an overlay. */
24497 if (EQ (end
->object
, before_string
))
24499 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24500 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24503 else if (EQ (end
->object
, after_string
))
24505 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24506 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24509 x
+= end
->pixel_width
;
24511 hlinfo
->mouse_face_end_x
= x
;
24512 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24515 hlinfo
->mouse_face_window
= window
;
24516 hlinfo
->mouse_face_face_id
24517 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24519 !hlinfo
->mouse_face_hidden
, -1);
24520 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24523 /* The following function is not used anymore (replaced with
24524 mouse_face_from_string_pos), but I leave it here for the time
24525 being, in case someone would. */
24527 #if 0 /* not used */
24529 /* Find the position of the glyph for position POS in OBJECT in
24530 window W's current matrix, and return in *X, *Y the pixel
24531 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24533 RIGHT_P non-zero means return the position of the right edge of the
24534 glyph, RIGHT_P zero means return the left edge position.
24536 If no glyph for POS exists in the matrix, return the position of
24537 the glyph with the next smaller position that is in the matrix, if
24538 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24539 exists in the matrix, return the position of the glyph with the
24540 next larger position in OBJECT.
24542 Value is non-zero if a glyph was found. */
24545 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24546 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24548 int yb
= window_text_bottom_y (w
);
24549 struct glyph_row
*r
;
24550 struct glyph
*best_glyph
= NULL
;
24551 struct glyph_row
*best_row
= NULL
;
24554 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24555 r
->enabled_p
&& r
->y
< yb
;
24558 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24559 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24562 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24563 if (EQ (g
->object
, object
))
24565 if (g
->charpos
== pos
)
24572 else if (best_glyph
== NULL
24573 || ((eabs (g
->charpos
- pos
)
24574 < eabs (best_glyph
->charpos
- pos
))
24577 : g
->charpos
> pos
)))
24591 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24595 *x
+= best_glyph
->pixel_width
;
24600 *vpos
= best_row
- w
->current_matrix
->rows
;
24603 return best_glyph
!= NULL
;
24605 #endif /* not used */
24607 /* Find the positions of the first and the last glyphs in window W's
24608 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24609 (assumed to be a string), and return in HLINFO's mouse_face_*
24610 members the pixel and column/row coordinates of those glyphs. */
24613 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24614 Lisp_Object object
,
24615 EMACS_INT startpos
, EMACS_INT endpos
)
24617 int yb
= window_text_bottom_y (w
);
24618 struct glyph_row
*r
;
24619 struct glyph
*g
, *e
;
24623 /* Find the glyph row with at least one position in the range
24624 [STARTPOS..ENDPOS], and the first glyph in that row whose
24625 position belongs to that range. */
24626 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24627 r
->enabled_p
&& r
->y
< yb
;
24630 if (!r
->reversed_p
)
24632 g
= r
->glyphs
[TEXT_AREA
];
24633 e
= g
+ r
->used
[TEXT_AREA
];
24634 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24635 if (EQ (g
->object
, object
)
24636 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24638 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24639 hlinfo
->mouse_face_beg_y
= r
->y
;
24640 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24641 hlinfo
->mouse_face_beg_x
= gx
;
24650 e
= r
->glyphs
[TEXT_AREA
];
24651 g
= e
+ r
->used
[TEXT_AREA
];
24652 for ( ; g
> e
; --g
)
24653 if (EQ ((g
-1)->object
, object
)
24654 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24656 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24657 hlinfo
->mouse_face_beg_y
= r
->y
;
24658 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24659 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24660 gx
+= g1
->pixel_width
;
24661 hlinfo
->mouse_face_beg_x
= gx
;
24673 /* Starting with the next row, look for the first row which does NOT
24674 include any glyphs whose positions are in the range. */
24675 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24677 g
= r
->glyphs
[TEXT_AREA
];
24678 e
= g
+ r
->used
[TEXT_AREA
];
24680 for ( ; g
< e
; ++g
)
24681 if (EQ (g
->object
, object
)
24682 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24691 /* The highlighted region ends on the previous row. */
24694 /* Set the end row and its vertical pixel coordinate. */
24695 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24696 hlinfo
->mouse_face_end_y
= r
->y
;
24698 /* Compute and set the end column and the end column's horizontal
24699 pixel coordinate. */
24700 if (!r
->reversed_p
)
24702 g
= r
->glyphs
[TEXT_AREA
];
24703 e
= g
+ r
->used
[TEXT_AREA
];
24704 for ( ; e
> g
; --e
)
24705 if (EQ ((e
-1)->object
, object
)
24706 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24708 hlinfo
->mouse_face_end_col
= e
- g
;
24710 for (gx
= r
->x
; g
< e
; ++g
)
24711 gx
+= g
->pixel_width
;
24712 hlinfo
->mouse_face_end_x
= gx
;
24716 e
= r
->glyphs
[TEXT_AREA
];
24717 g
= e
+ r
->used
[TEXT_AREA
];
24718 for (gx
= r
->x
; e
< g
; ++e
)
24720 if (EQ (e
->object
, object
)
24721 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24723 gx
+= e
->pixel_width
;
24725 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24726 hlinfo
->mouse_face_end_x
= gx
;
24730 #ifdef HAVE_WINDOW_SYSTEM
24732 /* See if position X, Y is within a hot-spot of an image. */
24735 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24737 if (!CONSP (hot_spot
))
24740 if (EQ (XCAR (hot_spot
), Qrect
))
24742 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24743 Lisp_Object rect
= XCDR (hot_spot
);
24747 if (!CONSP (XCAR (rect
)))
24749 if (!CONSP (XCDR (rect
)))
24751 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24753 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24755 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24757 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24761 else if (EQ (XCAR (hot_spot
), Qcircle
))
24763 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24764 Lisp_Object circ
= XCDR (hot_spot
);
24765 Lisp_Object lr
, lx0
, ly0
;
24767 && CONSP (XCAR (circ
))
24768 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24769 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24770 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24772 double r
= XFLOATINT (lr
);
24773 double dx
= XINT (lx0
) - x
;
24774 double dy
= XINT (ly0
) - y
;
24775 return (dx
* dx
+ dy
* dy
<= r
* r
);
24778 else if (EQ (XCAR (hot_spot
), Qpoly
))
24780 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24781 if (VECTORP (XCDR (hot_spot
)))
24783 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24784 Lisp_Object
*poly
= v
->contents
;
24788 Lisp_Object lx
, ly
;
24791 /* Need an even number of coordinates, and at least 3 edges. */
24792 if (n
< 6 || n
& 1)
24795 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24796 If count is odd, we are inside polygon. Pixels on edges
24797 may or may not be included depending on actual geometry of the
24799 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24800 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24802 x0
= XINT (lx
), y0
= XINT (ly
);
24803 for (i
= 0; i
< n
; i
+= 2)
24805 int x1
= x0
, y1
= y0
;
24806 if ((lx
= poly
[i
], !INTEGERP (lx
))
24807 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24809 x0
= XINT (lx
), y0
= XINT (ly
);
24811 /* Does this segment cross the X line? */
24819 if (y
> y0
&& y
> y1
)
24821 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24831 find_hot_spot (Lisp_Object map
, int x
, int y
)
24833 while (CONSP (map
))
24835 if (CONSP (XCAR (map
))
24836 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24844 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24846 doc
: /* Lookup in image map MAP coordinates X and Y.
24847 An image map is an alist where each element has the format (AREA ID PLIST).
24848 An AREA is specified as either a rectangle, a circle, or a polygon:
24849 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24850 pixel coordinates of the upper left and bottom right corners.
24851 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24852 and the radius of the circle; r may be a float or integer.
24853 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24854 vector describes one corner in the polygon.
24855 Returns the alist element for the first matching AREA in MAP. */)
24856 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24864 return find_hot_spot (map
, XINT (x
), XINT (y
));
24868 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24870 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24872 /* Do not change cursor shape while dragging mouse. */
24873 if (!NILP (do_mouse_tracking
))
24876 if (!NILP (pointer
))
24878 if (EQ (pointer
, Qarrow
))
24879 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24880 else if (EQ (pointer
, Qhand
))
24881 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24882 else if (EQ (pointer
, Qtext
))
24883 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24884 else if (EQ (pointer
, intern ("hdrag")))
24885 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24886 #ifdef HAVE_X_WINDOWS
24887 else if (EQ (pointer
, intern ("vdrag")))
24888 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24890 else if (EQ (pointer
, intern ("hourglass")))
24891 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24892 else if (EQ (pointer
, Qmodeline
))
24893 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24895 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24898 if (cursor
!= No_Cursor
)
24899 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24902 #endif /* HAVE_WINDOW_SYSTEM */
24904 /* Take proper action when mouse has moved to the mode or header line
24905 or marginal area AREA of window W, x-position X and y-position Y.
24906 X is relative to the start of the text display area of W, so the
24907 width of bitmap areas and scroll bars must be subtracted to get a
24908 position relative to the start of the mode line. */
24911 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24912 enum window_part area
)
24914 struct window
*w
= XWINDOW (window
);
24915 struct frame
*f
= XFRAME (w
->frame
);
24916 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24917 #ifdef HAVE_WINDOW_SYSTEM
24918 Display_Info
*dpyinfo
;
24920 Cursor cursor
= No_Cursor
;
24921 Lisp_Object pointer
= Qnil
;
24922 int dx
, dy
, width
, height
;
24924 Lisp_Object string
, object
= Qnil
;
24925 Lisp_Object pos
, help
;
24927 Lisp_Object mouse_face
;
24928 int original_x_pixel
= x
;
24929 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24930 struct glyph_row
*row
;
24932 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24937 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24938 returns them in row/column units! */
24939 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24940 &object
, &dx
, &dy
, &width
, &height
);
24942 row
= (area
== ON_MODE_LINE
24943 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24944 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24946 /* Find the glyph under the mouse pointer. */
24947 if (row
->mode_line_p
&& row
->enabled_p
)
24949 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24950 end
= glyph
+ row
->used
[TEXT_AREA
];
24952 for (x0
= original_x_pixel
;
24953 glyph
< end
&& x0
>= glyph
->pixel_width
;
24955 x0
-= glyph
->pixel_width
;
24963 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24964 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24965 returns them in row/column units! */
24966 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24967 &object
, &dx
, &dy
, &width
, &height
);
24972 #ifdef HAVE_WINDOW_SYSTEM
24973 if (IMAGEP (object
))
24975 Lisp_Object image_map
, hotspot
;
24976 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24978 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24980 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24982 Lisp_Object area_id
, plist
;
24984 area_id
= XCAR (hotspot
);
24985 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24986 If so, we could look for mouse-enter, mouse-leave
24987 properties in PLIST (and do something...). */
24988 hotspot
= XCDR (hotspot
);
24989 if (CONSP (hotspot
)
24990 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24992 pointer
= Fplist_get (plist
, Qpointer
);
24993 if (NILP (pointer
))
24995 help
= Fplist_get (plist
, Qhelp_echo
);
24998 help_echo_string
= help
;
24999 /* Is this correct? ++kfs */
25000 XSETWINDOW (help_echo_window
, w
);
25001 help_echo_object
= w
->buffer
;
25002 help_echo_pos
= charpos
;
25006 if (NILP (pointer
))
25007 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25009 #endif /* HAVE_WINDOW_SYSTEM */
25011 if (STRINGP (string
))
25013 pos
= make_number (charpos
);
25014 /* If we're on a string with `help-echo' text property, arrange
25015 for the help to be displayed. This is done by setting the
25016 global variable help_echo_string to the help string. */
25019 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25022 help_echo_string
= help
;
25023 XSETWINDOW (help_echo_window
, w
);
25024 help_echo_object
= string
;
25025 help_echo_pos
= charpos
;
25029 #ifdef HAVE_WINDOW_SYSTEM
25030 if (FRAME_WINDOW_P (f
))
25032 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25033 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25034 if (NILP (pointer
))
25035 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25037 /* Change the mouse pointer according to what is under X/Y. */
25039 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25042 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25043 if (!KEYMAPP (map
))
25044 map
= Fget_text_property (pos
, Qkeymap
, string
);
25045 if (!KEYMAPP (map
))
25046 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25051 /* Change the mouse face according to what is under X/Y. */
25052 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25053 if (!NILP (mouse_face
)
25054 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25059 struct glyph
* tmp_glyph
;
25063 int total_pixel_width
;
25064 EMACS_INT begpos
, endpos
, ignore
;
25068 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25069 Qmouse_face
, string
, Qnil
);
25075 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25077 endpos
= SCHARS (string
);
25081 /* Calculate the glyph position GPOS of GLYPH in the
25082 displayed string, relative to the beginning of the
25083 highlighted part of the string.
25085 Note: GPOS is different from CHARPOS. CHARPOS is the
25086 position of GLYPH in the internal string object. A mode
25087 line string format has structures which are converted to
25088 a flattened string by the Emacs Lisp interpreter. The
25089 internal string is an element of those structures. The
25090 displayed string is the flattened string. */
25091 tmp_glyph
= row_start_glyph
;
25092 while (tmp_glyph
< glyph
25093 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25094 && begpos
<= tmp_glyph
->charpos
25095 && tmp_glyph
->charpos
< endpos
)))
25097 gpos
= glyph
- tmp_glyph
;
25099 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25100 the highlighted part of the displayed string to which
25101 GLYPH belongs. Note: GSEQ_LENGTH is different from
25102 SCHARS (STRING), because the latter returns the length of
25103 the internal string. */
25104 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25106 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25107 && begpos
<= tmp_glyph
->charpos
25108 && tmp_glyph
->charpos
< endpos
));
25111 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25113 /* Calculate the total pixel width of all the glyphs between
25114 the beginning of the highlighted area and GLYPH. */
25115 total_pixel_width
= 0;
25116 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25117 total_pixel_width
+= tmp_glyph
->pixel_width
;
25119 /* Pre calculation of re-rendering position. Note: X is in
25120 column units here, after the call to mode_line_string or
25121 marginal_area_string. */
25123 vpos
= (area
== ON_MODE_LINE
25124 ? (w
->current_matrix
)->nrows
- 1
25127 /* If GLYPH's position is included in the region that is
25128 already drawn in mouse face, we have nothing to do. */
25129 if ( EQ (window
, hlinfo
->mouse_face_window
)
25130 && (!row
->reversed_p
25131 ? (hlinfo
->mouse_face_beg_col
<= hpos
25132 && hpos
< hlinfo
->mouse_face_end_col
)
25133 /* In R2L rows we swap BEG and END, see below. */
25134 : (hlinfo
->mouse_face_end_col
<= hpos
25135 && hpos
< hlinfo
->mouse_face_beg_col
))
25136 && hlinfo
->mouse_face_beg_row
== vpos
)
25139 if (clear_mouse_face (hlinfo
))
25140 cursor
= No_Cursor
;
25142 if (!row
->reversed_p
)
25144 hlinfo
->mouse_face_beg_col
= hpos
;
25145 hlinfo
->mouse_face_beg_x
= original_x_pixel
25146 - (total_pixel_width
+ dx
);
25147 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25148 hlinfo
->mouse_face_end_x
= 0;
25152 /* In R2L rows, show_mouse_face expects BEG and END
25153 coordinates to be swapped. */
25154 hlinfo
->mouse_face_end_col
= hpos
;
25155 hlinfo
->mouse_face_end_x
= original_x_pixel
25156 - (total_pixel_width
+ dx
);
25157 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25158 hlinfo
->mouse_face_beg_x
= 0;
25161 hlinfo
->mouse_face_beg_row
= vpos
;
25162 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25163 hlinfo
->mouse_face_beg_y
= 0;
25164 hlinfo
->mouse_face_end_y
= 0;
25165 hlinfo
->mouse_face_past_end
= 0;
25166 hlinfo
->mouse_face_window
= window
;
25168 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25174 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25176 if (NILP (pointer
))
25179 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25180 clear_mouse_face (hlinfo
);
25182 #ifdef HAVE_WINDOW_SYSTEM
25183 if (FRAME_WINDOW_P (f
))
25184 define_frame_cursor1 (f
, cursor
, pointer
);
25190 Take proper action when the mouse has moved to position X, Y on
25191 frame F as regards highlighting characters that have mouse-face
25192 properties. Also de-highlighting chars where the mouse was before.
25193 X and Y can be negative or out of range. */
25196 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25198 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25199 enum window_part part
;
25200 Lisp_Object window
;
25202 Cursor cursor
= No_Cursor
;
25203 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25206 /* When a menu is active, don't highlight because this looks odd. */
25207 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25208 if (popup_activated ())
25212 if (NILP (Vmouse_highlight
)
25213 || !f
->glyphs_initialized_p
25214 || f
->pointer_invisible
)
25217 hlinfo
->mouse_face_mouse_x
= x
;
25218 hlinfo
->mouse_face_mouse_y
= y
;
25219 hlinfo
->mouse_face_mouse_frame
= f
;
25221 if (hlinfo
->mouse_face_defer
)
25224 if (gc_in_progress
)
25226 hlinfo
->mouse_face_deferred_gc
= 1;
25230 /* Which window is that in? */
25231 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25233 /* If we were displaying active text in another window, clear that.
25234 Also clear if we move out of text area in same window. */
25235 if (! EQ (window
, hlinfo
->mouse_face_window
)
25236 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25237 && !NILP (hlinfo
->mouse_face_window
)))
25238 clear_mouse_face (hlinfo
);
25240 /* Not on a window -> return. */
25241 if (!WINDOWP (window
))
25244 /* Reset help_echo_string. It will get recomputed below. */
25245 help_echo_string
= Qnil
;
25247 /* Convert to window-relative pixel coordinates. */
25248 w
= XWINDOW (window
);
25249 frame_to_window_pixel_xy (w
, &x
, &y
);
25251 #ifdef HAVE_WINDOW_SYSTEM
25252 /* Handle tool-bar window differently since it doesn't display a
25254 if (EQ (window
, f
->tool_bar_window
))
25256 note_tool_bar_highlight (f
, x
, y
);
25261 /* Mouse is on the mode, header line or margin? */
25262 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25263 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25265 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25269 #ifdef HAVE_WINDOW_SYSTEM
25270 if (part
== ON_VERTICAL_BORDER
)
25272 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25273 help_echo_string
= build_string ("drag-mouse-1: resize");
25275 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25276 || part
== ON_SCROLL_BAR
)
25277 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25279 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25282 /* Are we in a window whose display is up to date?
25283 And verify the buffer's text has not changed. */
25284 b
= XBUFFER (w
->buffer
);
25285 if (part
== ON_TEXT
25286 && EQ (w
->window_end_valid
, w
->buffer
)
25287 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25288 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25290 int hpos
, vpos
, i
, dx
, dy
, area
;
25292 struct glyph
*glyph
;
25293 Lisp_Object object
;
25294 Lisp_Object mouse_face
= Qnil
, position
;
25295 Lisp_Object
*overlay_vec
= NULL
;
25297 struct buffer
*obuf
;
25298 EMACS_INT obegv
, ozv
;
25301 /* Find the glyph under X/Y. */
25302 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25304 #ifdef HAVE_WINDOW_SYSTEM
25305 /* Look for :pointer property on image. */
25306 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25308 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25309 if (img
!= NULL
&& IMAGEP (img
->spec
))
25311 Lisp_Object image_map
, hotspot
;
25312 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25314 && (hotspot
= find_hot_spot (image_map
,
25315 glyph
->slice
.img
.x
+ dx
,
25316 glyph
->slice
.img
.y
+ dy
),
25318 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25320 Lisp_Object area_id
, plist
;
25322 area_id
= XCAR (hotspot
);
25323 /* Could check AREA_ID to see if we enter/leave this hot-spot.
25324 If so, we could look for mouse-enter, mouse-leave
25325 properties in PLIST (and do something...). */
25326 hotspot
= XCDR (hotspot
);
25327 if (CONSP (hotspot
)
25328 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25330 pointer
= Fplist_get (plist
, Qpointer
);
25331 if (NILP (pointer
))
25333 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25334 if (!NILP (help_echo_string
))
25336 help_echo_window
= window
;
25337 help_echo_object
= glyph
->object
;
25338 help_echo_pos
= glyph
->charpos
;
25342 if (NILP (pointer
))
25343 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25346 #endif /* HAVE_WINDOW_SYSTEM */
25348 /* Clear mouse face if X/Y not over text. */
25350 || area
!= TEXT_AREA
25351 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25352 /* Glyph's OBJECT is an integer for glyphs inserted by the
25353 display engine for its internal purposes, like truncation
25354 and continuation glyphs and blanks beyond the end of
25355 line's text on text terminals. If we are over such a
25356 glyph, we are not over any text. */
25357 || INTEGERP (glyph
->object
)
25358 /* R2L rows have a stretch glyph at their front, which
25359 stands for no text, whereas L2R rows have no glyphs at
25360 all beyond the end of text. Treat such stretch glyphs
25361 like we do with NULL glyphs in L2R rows. */
25362 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25363 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25364 && glyph
->type
== STRETCH_GLYPH
25365 && glyph
->avoid_cursor_p
))
25367 if (clear_mouse_face (hlinfo
))
25368 cursor
= No_Cursor
;
25369 #ifdef HAVE_WINDOW_SYSTEM
25370 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25372 if (area
!= TEXT_AREA
)
25373 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25375 pointer
= Vvoid_text_area_pointer
;
25381 pos
= glyph
->charpos
;
25382 object
= glyph
->object
;
25383 if (!STRINGP (object
) && !BUFFERP (object
))
25386 /* If we get an out-of-range value, return now; avoid an error. */
25387 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25390 /* Make the window's buffer temporarily current for
25391 overlays_at and compute_char_face. */
25392 obuf
= current_buffer
;
25393 current_buffer
= b
;
25399 /* Is this char mouse-active or does it have help-echo? */
25400 position
= make_number (pos
);
25402 if (BUFFERP (object
))
25404 /* Put all the overlays we want in a vector in overlay_vec. */
25405 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25406 /* Sort overlays into increasing priority order. */
25407 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25412 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25415 cursor
= No_Cursor
;
25417 /* Check mouse-face highlighting. */
25419 /* If there exists an overlay with mouse-face overlapping
25420 the one we are currently highlighting, we have to
25421 check if we enter the overlapping overlay, and then
25422 highlight only that. */
25423 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25424 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25426 /* Find the highest priority overlay with a mouse-face. */
25427 Lisp_Object overlay
= Qnil
;
25428 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25430 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25431 if (!NILP (mouse_face
))
25432 overlay
= overlay_vec
[i
];
25435 /* If we're highlighting the same overlay as before, there's
25436 no need to do that again. */
25437 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25438 goto check_help_echo
;
25439 hlinfo
->mouse_face_overlay
= overlay
;
25441 /* Clear the display of the old active region, if any. */
25442 if (clear_mouse_face (hlinfo
))
25443 cursor
= No_Cursor
;
25445 /* If no overlay applies, get a text property. */
25446 if (NILP (overlay
))
25447 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25449 /* Next, compute the bounds of the mouse highlighting and
25451 if (!NILP (mouse_face
) && STRINGP (object
))
25453 /* The mouse-highlighting comes from a display string
25454 with a mouse-face. */
25458 s
= Fprevious_single_property_change
25459 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25460 e
= Fnext_single_property_change
25461 (position
, Qmouse_face
, object
, Qnil
);
25463 s
= make_number (0);
25465 e
= make_number (SCHARS (object
) - 1);
25466 mouse_face_from_string_pos (w
, hlinfo
, object
,
25467 XINT (s
), XINT (e
));
25468 hlinfo
->mouse_face_past_end
= 0;
25469 hlinfo
->mouse_face_window
= window
;
25470 hlinfo
->mouse_face_face_id
25471 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25472 glyph
->face_id
, 1);
25473 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25474 cursor
= No_Cursor
;
25478 /* The mouse-highlighting, if any, comes from an overlay
25479 or text property in the buffer. */
25480 Lisp_Object buffer
, cover_string
;
25482 if (STRINGP (object
))
25484 /* If we are on a display string with no mouse-face,
25485 check if the text under it has one. */
25486 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25487 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25488 pos
= string_buffer_position (w
, object
, start
);
25491 mouse_face
= get_char_property_and_overlay
25492 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25493 buffer
= w
->buffer
;
25494 cover_string
= object
;
25500 cover_string
= Qnil
;
25503 if (!NILP (mouse_face
))
25505 Lisp_Object before
, after
;
25506 Lisp_Object before_string
, after_string
;
25507 /* To correctly find the limits of mouse highlight
25508 in a bidi-reordered buffer, we must not use the
25509 optimization of limiting the search in
25510 previous-single-property-change and
25511 next-single-property-change, because
25512 rows_from_pos_range needs the real start and end
25513 positions to DTRT in this case. That's because
25514 the first row visible in a window does not
25515 necessarily display the character whose position
25516 is the smallest. */
25518 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25519 ? Fmarker_position (w
->start
)
25522 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25523 ? make_number (BUF_Z (XBUFFER (buffer
))
25524 - XFASTINT (w
->window_end_pos
))
25527 if (NILP (overlay
))
25529 /* Handle the text property case. */
25530 before
= Fprevious_single_property_change
25531 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25532 after
= Fnext_single_property_change
25533 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25534 before_string
= after_string
= Qnil
;
25538 /* Handle the overlay case. */
25539 before
= Foverlay_start (overlay
);
25540 after
= Foverlay_end (overlay
);
25541 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25542 after_string
= Foverlay_get (overlay
, Qafter_string
);
25544 if (!STRINGP (before_string
)) before_string
= Qnil
;
25545 if (!STRINGP (after_string
)) after_string
= Qnil
;
25548 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25551 before_string
, after_string
,
25553 cursor
= No_Cursor
;
25560 /* Look for a `help-echo' property. */
25561 if (NILP (help_echo_string
)) {
25562 Lisp_Object help
, overlay
;
25564 /* Check overlays first. */
25565 help
= overlay
= Qnil
;
25566 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25568 overlay
= overlay_vec
[i
];
25569 help
= Foverlay_get (overlay
, Qhelp_echo
);
25574 help_echo_string
= help
;
25575 help_echo_window
= window
;
25576 help_echo_object
= overlay
;
25577 help_echo_pos
= pos
;
25581 Lisp_Object obj
= glyph
->object
;
25582 EMACS_INT charpos
= glyph
->charpos
;
25584 /* Try text properties. */
25587 && charpos
< SCHARS (obj
))
25589 help
= Fget_text_property (make_number (charpos
),
25593 /* If the string itself doesn't specify a help-echo,
25594 see if the buffer text ``under'' it does. */
25595 struct glyph_row
*r
25596 = MATRIX_ROW (w
->current_matrix
, vpos
);
25597 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25598 EMACS_INT p
= string_buffer_position (w
, obj
, start
);
25601 help
= Fget_char_property (make_number (p
),
25602 Qhelp_echo
, w
->buffer
);
25611 else if (BUFFERP (obj
)
25614 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25619 help_echo_string
= help
;
25620 help_echo_window
= window
;
25621 help_echo_object
= obj
;
25622 help_echo_pos
= charpos
;
25627 #ifdef HAVE_WINDOW_SYSTEM
25628 /* Look for a `pointer' property. */
25629 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25631 /* Check overlays first. */
25632 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25633 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25635 if (NILP (pointer
))
25637 Lisp_Object obj
= glyph
->object
;
25638 EMACS_INT charpos
= glyph
->charpos
;
25640 /* Try text properties. */
25643 && charpos
< SCHARS (obj
))
25645 pointer
= Fget_text_property (make_number (charpos
),
25647 if (NILP (pointer
))
25649 /* If the string itself doesn't specify a pointer,
25650 see if the buffer text ``under'' it does. */
25651 struct glyph_row
*r
25652 = MATRIX_ROW (w
->current_matrix
, vpos
);
25653 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25654 EMACS_INT p
= string_buffer_position (w
, obj
, start
);
25656 pointer
= Fget_char_property (make_number (p
),
25657 Qpointer
, w
->buffer
);
25660 else if (BUFFERP (obj
)
25663 pointer
= Fget_text_property (make_number (charpos
),
25667 #endif /* HAVE_WINDOW_SYSTEM */
25671 current_buffer
= obuf
;
25676 #ifdef HAVE_WINDOW_SYSTEM
25677 if (FRAME_WINDOW_P (f
))
25678 define_frame_cursor1 (f
, cursor
, pointer
);
25680 /* This is here to prevent a compiler error, about "label at end of
25681 compound statement". */
25688 Clear any mouse-face on window W. This function is part of the
25689 redisplay interface, and is called from try_window_id and similar
25690 functions to ensure the mouse-highlight is off. */
25693 x_clear_window_mouse_face (struct window
*w
)
25695 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25696 Lisp_Object window
;
25699 XSETWINDOW (window
, w
);
25700 if (EQ (window
, hlinfo
->mouse_face_window
))
25701 clear_mouse_face (hlinfo
);
25707 Just discard the mouse face information for frame F, if any.
25708 This is used when the size of F is changed. */
25711 cancel_mouse_face (struct frame
*f
)
25713 Lisp_Object window
;
25714 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25716 window
= hlinfo
->mouse_face_window
;
25717 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25719 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25720 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25721 hlinfo
->mouse_face_window
= Qnil
;
25727 /***********************************************************************
25729 ***********************************************************************/
25731 #ifdef HAVE_WINDOW_SYSTEM
25733 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25734 which intersects rectangle R. R is in window-relative coordinates. */
25737 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25738 enum glyph_row_area area
)
25740 struct glyph
*first
= row
->glyphs
[area
];
25741 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25742 struct glyph
*last
;
25743 int first_x
, start_x
, x
;
25745 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25746 /* If row extends face to end of line write the whole line. */
25747 draw_glyphs (w
, 0, row
, area
,
25748 0, row
->used
[area
],
25749 DRAW_NORMAL_TEXT
, 0);
25752 /* Set START_X to the window-relative start position for drawing glyphs of
25753 AREA. The first glyph of the text area can be partially visible.
25754 The first glyphs of other areas cannot. */
25755 start_x
= window_box_left_offset (w
, area
);
25757 if (area
== TEXT_AREA
)
25760 /* Find the first glyph that must be redrawn. */
25762 && x
+ first
->pixel_width
< r
->x
)
25764 x
+= first
->pixel_width
;
25768 /* Find the last one. */
25772 && x
< r
->x
+ r
->width
)
25774 x
+= last
->pixel_width
;
25780 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25781 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25782 DRAW_NORMAL_TEXT
, 0);
25787 /* Redraw the parts of the glyph row ROW on window W intersecting
25788 rectangle R. R is in window-relative coordinates. Value is
25789 non-zero if mouse-face was overwritten. */
25792 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25794 xassert (row
->enabled_p
);
25796 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25797 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25798 0, row
->used
[TEXT_AREA
],
25799 DRAW_NORMAL_TEXT
, 0);
25802 if (row
->used
[LEFT_MARGIN_AREA
])
25803 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25804 if (row
->used
[TEXT_AREA
])
25805 expose_area (w
, row
, r
, TEXT_AREA
);
25806 if (row
->used
[RIGHT_MARGIN_AREA
])
25807 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25808 draw_row_fringe_bitmaps (w
, row
);
25811 return row
->mouse_face_p
;
25815 /* Redraw those parts of glyphs rows during expose event handling that
25816 overlap other rows. Redrawing of an exposed line writes over parts
25817 of lines overlapping that exposed line; this function fixes that.
25819 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25820 row in W's current matrix that is exposed and overlaps other rows.
25821 LAST_OVERLAPPING_ROW is the last such row. */
25824 expose_overlaps (struct window
*w
,
25825 struct glyph_row
*first_overlapping_row
,
25826 struct glyph_row
*last_overlapping_row
,
25829 struct glyph_row
*row
;
25831 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25832 if (row
->overlapping_p
)
25834 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25837 if (row
->used
[LEFT_MARGIN_AREA
])
25838 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25840 if (row
->used
[TEXT_AREA
])
25841 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25843 if (row
->used
[RIGHT_MARGIN_AREA
])
25844 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25850 /* Return non-zero if W's cursor intersects rectangle R. */
25853 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25855 XRectangle cr
, result
;
25856 struct glyph
*cursor_glyph
;
25857 struct glyph_row
*row
;
25859 if (w
->phys_cursor
.vpos
>= 0
25860 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25861 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25863 && row
->cursor_in_fringe_p
)
25865 /* Cursor is in the fringe. */
25866 cr
.x
= window_box_right_offset (w
,
25867 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25868 ? RIGHT_MARGIN_AREA
25871 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25872 cr
.height
= row
->height
;
25873 return x_intersect_rectangles (&cr
, r
, &result
);
25876 cursor_glyph
= get_phys_cursor_glyph (w
);
25879 /* r is relative to W's box, but w->phys_cursor.x is relative
25880 to left edge of W's TEXT area. Adjust it. */
25881 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25882 cr
.y
= w
->phys_cursor
.y
;
25883 cr
.width
= cursor_glyph
->pixel_width
;
25884 cr
.height
= w
->phys_cursor_height
;
25885 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25886 I assume the effect is the same -- and this is portable. */
25887 return x_intersect_rectangles (&cr
, r
, &result
);
25889 /* If we don't understand the format, pretend we're not in the hot-spot. */
25895 Draw a vertical window border to the right of window W if W doesn't
25896 have vertical scroll bars. */
25899 x_draw_vertical_border (struct window
*w
)
25901 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25903 /* We could do better, if we knew what type of scroll-bar the adjacent
25904 windows (on either side) have... But we don't :-(
25905 However, I think this works ok. ++KFS 2003-04-25 */
25907 /* Redraw borders between horizontally adjacent windows. Don't
25908 do it for frames with vertical scroll bars because either the
25909 right scroll bar of a window, or the left scroll bar of its
25910 neighbor will suffice as a border. */
25911 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25914 if (!WINDOW_RIGHTMOST_P (w
)
25915 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25917 int x0
, x1
, y0
, y1
;
25919 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25922 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25925 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25927 else if (!WINDOW_LEFTMOST_P (w
)
25928 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25930 int x0
, x1
, y0
, y1
;
25932 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25935 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25938 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25943 /* Redraw the part of window W intersection rectangle FR. Pixel
25944 coordinates in FR are frame-relative. Call this function with
25945 input blocked. Value is non-zero if the exposure overwrites
25949 expose_window (struct window
*w
, XRectangle
*fr
)
25951 struct frame
*f
= XFRAME (w
->frame
);
25953 int mouse_face_overwritten_p
= 0;
25955 /* If window is not yet fully initialized, do nothing. This can
25956 happen when toolkit scroll bars are used and a window is split.
25957 Reconfiguring the scroll bar will generate an expose for a newly
25959 if (w
->current_matrix
== NULL
)
25962 /* When we're currently updating the window, display and current
25963 matrix usually don't agree. Arrange for a thorough display
25965 if (w
== updated_window
)
25967 SET_FRAME_GARBAGED (f
);
25971 /* Frame-relative pixel rectangle of W. */
25972 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25973 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25974 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25975 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25977 if (x_intersect_rectangles (fr
, &wr
, &r
))
25979 int yb
= window_text_bottom_y (w
);
25980 struct glyph_row
*row
;
25981 int cursor_cleared_p
;
25982 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25984 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25985 r
.x
, r
.y
, r
.width
, r
.height
));
25987 /* Convert to window coordinates. */
25988 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25989 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25991 /* Turn off the cursor. */
25992 if (!w
->pseudo_window_p
25993 && phys_cursor_in_rect_p (w
, &r
))
25995 x_clear_cursor (w
);
25996 cursor_cleared_p
= 1;
25999 cursor_cleared_p
= 0;
26001 /* Update lines intersecting rectangle R. */
26002 first_overlapping_row
= last_overlapping_row
= NULL
;
26003 for (row
= w
->current_matrix
->rows
;
26008 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26010 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26011 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26012 || (r
.y
>= y0
&& r
.y
< y1
)
26013 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26015 /* A header line may be overlapping, but there is no need
26016 to fix overlapping areas for them. KFS 2005-02-12 */
26017 if (row
->overlapping_p
&& !row
->mode_line_p
)
26019 if (first_overlapping_row
== NULL
)
26020 first_overlapping_row
= row
;
26021 last_overlapping_row
= row
;
26025 if (expose_line (w
, row
, &r
))
26026 mouse_face_overwritten_p
= 1;
26029 else if (row
->overlapping_p
)
26031 /* We must redraw a row overlapping the exposed area. */
26033 ? y0
+ row
->phys_height
> r
.y
26034 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26036 if (first_overlapping_row
== NULL
)
26037 first_overlapping_row
= row
;
26038 last_overlapping_row
= row
;
26046 /* Display the mode line if there is one. */
26047 if (WINDOW_WANTS_MODELINE_P (w
)
26048 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26050 && row
->y
< r
.y
+ r
.height
)
26052 if (expose_line (w
, row
, &r
))
26053 mouse_face_overwritten_p
= 1;
26056 if (!w
->pseudo_window_p
)
26058 /* Fix the display of overlapping rows. */
26059 if (first_overlapping_row
)
26060 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26063 /* Draw border between windows. */
26064 x_draw_vertical_border (w
);
26066 /* Turn the cursor on again. */
26067 if (cursor_cleared_p
)
26068 update_window_cursor (w
, 1);
26072 return mouse_face_overwritten_p
;
26077 /* Redraw (parts) of all windows in the window tree rooted at W that
26078 intersect R. R contains frame pixel coordinates. Value is
26079 non-zero if the exposure overwrites mouse-face. */
26082 expose_window_tree (struct window
*w
, XRectangle
*r
)
26084 struct frame
*f
= XFRAME (w
->frame
);
26085 int mouse_face_overwritten_p
= 0;
26087 while (w
&& !FRAME_GARBAGED_P (f
))
26089 if (!NILP (w
->hchild
))
26090 mouse_face_overwritten_p
26091 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26092 else if (!NILP (w
->vchild
))
26093 mouse_face_overwritten_p
26094 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26096 mouse_face_overwritten_p
|= expose_window (w
, r
);
26098 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26101 return mouse_face_overwritten_p
;
26106 Redisplay an exposed area of frame F. X and Y are the upper-left
26107 corner of the exposed rectangle. W and H are width and height of
26108 the exposed area. All are pixel values. W or H zero means redraw
26109 the entire frame. */
26112 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26115 int mouse_face_overwritten_p
= 0;
26117 TRACE ((stderr
, "expose_frame "));
26119 /* No need to redraw if frame will be redrawn soon. */
26120 if (FRAME_GARBAGED_P (f
))
26122 TRACE ((stderr
, " garbaged\n"));
26126 /* If basic faces haven't been realized yet, there is no point in
26127 trying to redraw anything. This can happen when we get an expose
26128 event while Emacs is starting, e.g. by moving another window. */
26129 if (FRAME_FACE_CACHE (f
) == NULL
26130 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26132 TRACE ((stderr
, " no faces\n"));
26136 if (w
== 0 || h
== 0)
26139 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26140 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26150 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26151 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26153 if (WINDOWP (f
->tool_bar_window
))
26154 mouse_face_overwritten_p
26155 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26157 #ifdef HAVE_X_WINDOWS
26159 #ifndef USE_X_TOOLKIT
26160 if (WINDOWP (f
->menu_bar_window
))
26161 mouse_face_overwritten_p
26162 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26163 #endif /* not USE_X_TOOLKIT */
26167 /* Some window managers support a focus-follows-mouse style with
26168 delayed raising of frames. Imagine a partially obscured frame,
26169 and moving the mouse into partially obscured mouse-face on that
26170 frame. The visible part of the mouse-face will be highlighted,
26171 then the WM raises the obscured frame. With at least one WM, KDE
26172 2.1, Emacs is not getting any event for the raising of the frame
26173 (even tried with SubstructureRedirectMask), only Expose events.
26174 These expose events will draw text normally, i.e. not
26175 highlighted. Which means we must redo the highlight here.
26176 Subsume it under ``we love X''. --gerd 2001-08-15 */
26177 /* Included in Windows version because Windows most likely does not
26178 do the right thing if any third party tool offers
26179 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26180 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26182 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26183 if (f
== hlinfo
->mouse_face_mouse_frame
)
26185 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26186 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26187 clear_mouse_face (hlinfo
);
26188 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26195 Determine the intersection of two rectangles R1 and R2. Return
26196 the intersection in *RESULT. Value is non-zero if RESULT is not
26200 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26202 XRectangle
*left
, *right
;
26203 XRectangle
*upper
, *lower
;
26204 int intersection_p
= 0;
26206 /* Rearrange so that R1 is the left-most rectangle. */
26208 left
= r1
, right
= r2
;
26210 left
= r2
, right
= r1
;
26212 /* X0 of the intersection is right.x0, if this is inside R1,
26213 otherwise there is no intersection. */
26214 if (right
->x
<= left
->x
+ left
->width
)
26216 result
->x
= right
->x
;
26218 /* The right end of the intersection is the minimum of the
26219 the right ends of left and right. */
26220 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26223 /* Same game for Y. */
26225 upper
= r1
, lower
= r2
;
26227 upper
= r2
, lower
= r1
;
26229 /* The upper end of the intersection is lower.y0, if this is inside
26230 of upper. Otherwise, there is no intersection. */
26231 if (lower
->y
<= upper
->y
+ upper
->height
)
26233 result
->y
= lower
->y
;
26235 /* The lower end of the intersection is the minimum of the lower
26236 ends of upper and lower. */
26237 result
->height
= (min (lower
->y
+ lower
->height
,
26238 upper
->y
+ upper
->height
)
26240 intersection_p
= 1;
26244 return intersection_p
;
26247 #endif /* HAVE_WINDOW_SYSTEM */
26250 /***********************************************************************
26252 ***********************************************************************/
26255 syms_of_xdisp (void)
26257 Vwith_echo_area_save_vector
= Qnil
;
26258 staticpro (&Vwith_echo_area_save_vector
);
26260 Vmessage_stack
= Qnil
;
26261 staticpro (&Vmessage_stack
);
26263 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26264 staticpro (&Qinhibit_redisplay
);
26266 message_dolog_marker1
= Fmake_marker ();
26267 staticpro (&message_dolog_marker1
);
26268 message_dolog_marker2
= Fmake_marker ();
26269 staticpro (&message_dolog_marker2
);
26270 message_dolog_marker3
= Fmake_marker ();
26271 staticpro (&message_dolog_marker3
);
26274 defsubr (&Sdump_frame_glyph_matrix
);
26275 defsubr (&Sdump_glyph_matrix
);
26276 defsubr (&Sdump_glyph_row
);
26277 defsubr (&Sdump_tool_bar_row
);
26278 defsubr (&Strace_redisplay
);
26279 defsubr (&Strace_to_stderr
);
26281 #ifdef HAVE_WINDOW_SYSTEM
26282 defsubr (&Stool_bar_lines_needed
);
26283 defsubr (&Slookup_image_map
);
26285 defsubr (&Sformat_mode_line
);
26286 defsubr (&Sinvisible_p
);
26287 defsubr (&Scurrent_bidi_paragraph_direction
);
26289 staticpro (&Qmenu_bar_update_hook
);
26290 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26292 staticpro (&Qoverriding_terminal_local_map
);
26293 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26295 staticpro (&Qoverriding_local_map
);
26296 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26298 staticpro (&Qwindow_scroll_functions
);
26299 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26301 staticpro (&Qwindow_text_change_functions
);
26302 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26304 staticpro (&Qredisplay_end_trigger_functions
);
26305 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26307 staticpro (&Qinhibit_point_motion_hooks
);
26308 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26310 Qeval
= intern_c_string ("eval");
26311 staticpro (&Qeval
);
26313 QCdata
= intern_c_string (":data");
26314 staticpro (&QCdata
);
26315 Qdisplay
= intern_c_string ("display");
26316 staticpro (&Qdisplay
);
26317 Qspace_width
= intern_c_string ("space-width");
26318 staticpro (&Qspace_width
);
26319 Qraise
= intern_c_string ("raise");
26320 staticpro (&Qraise
);
26321 Qslice
= intern_c_string ("slice");
26322 staticpro (&Qslice
);
26323 Qspace
= intern_c_string ("space");
26324 staticpro (&Qspace
);
26325 Qmargin
= intern_c_string ("margin");
26326 staticpro (&Qmargin
);
26327 Qpointer
= intern_c_string ("pointer");
26328 staticpro (&Qpointer
);
26329 Qleft_margin
= intern_c_string ("left-margin");
26330 staticpro (&Qleft_margin
);
26331 Qright_margin
= intern_c_string ("right-margin");
26332 staticpro (&Qright_margin
);
26333 Qcenter
= intern_c_string ("center");
26334 staticpro (&Qcenter
);
26335 Qline_height
= intern_c_string ("line-height");
26336 staticpro (&Qline_height
);
26337 QCalign_to
= intern_c_string (":align-to");
26338 staticpro (&QCalign_to
);
26339 QCrelative_width
= intern_c_string (":relative-width");
26340 staticpro (&QCrelative_width
);
26341 QCrelative_height
= intern_c_string (":relative-height");
26342 staticpro (&QCrelative_height
);
26343 QCeval
= intern_c_string (":eval");
26344 staticpro (&QCeval
);
26345 QCpropertize
= intern_c_string (":propertize");
26346 staticpro (&QCpropertize
);
26347 QCfile
= intern_c_string (":file");
26348 staticpro (&QCfile
);
26349 Qfontified
= intern_c_string ("fontified");
26350 staticpro (&Qfontified
);
26351 Qfontification_functions
= intern_c_string ("fontification-functions");
26352 staticpro (&Qfontification_functions
);
26353 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26354 staticpro (&Qtrailing_whitespace
);
26355 Qescape_glyph
= intern_c_string ("escape-glyph");
26356 staticpro (&Qescape_glyph
);
26357 Qnobreak_space
= intern_c_string ("nobreak-space");
26358 staticpro (&Qnobreak_space
);
26359 Qimage
= intern_c_string ("image");
26360 staticpro (&Qimage
);
26361 Qtext
= intern_c_string ("text");
26362 staticpro (&Qtext
);
26363 Qboth
= intern_c_string ("both");
26364 staticpro (&Qboth
);
26365 Qboth_horiz
= intern_c_string ("both-horiz");
26366 staticpro (&Qboth_horiz
);
26367 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26368 staticpro (&Qtext_image_horiz
);
26369 QCmap
= intern_c_string (":map");
26370 staticpro (&QCmap
);
26371 QCpointer
= intern_c_string (":pointer");
26372 staticpro (&QCpointer
);
26373 Qrect
= intern_c_string ("rect");
26374 staticpro (&Qrect
);
26375 Qcircle
= intern_c_string ("circle");
26376 staticpro (&Qcircle
);
26377 Qpoly
= intern_c_string ("poly");
26378 staticpro (&Qpoly
);
26379 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26380 staticpro (&Qmessage_truncate_lines
);
26381 Qgrow_only
= intern_c_string ("grow-only");
26382 staticpro (&Qgrow_only
);
26383 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26384 staticpro (&Qinhibit_menubar_update
);
26385 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26386 staticpro (&Qinhibit_eval_during_redisplay
);
26387 Qposition
= intern_c_string ("position");
26388 staticpro (&Qposition
);
26389 Qbuffer_position
= intern_c_string ("buffer-position");
26390 staticpro (&Qbuffer_position
);
26391 Qobject
= intern_c_string ("object");
26392 staticpro (&Qobject
);
26393 Qbar
= intern_c_string ("bar");
26395 Qhbar
= intern_c_string ("hbar");
26396 staticpro (&Qhbar
);
26397 Qbox
= intern_c_string ("box");
26399 Qhollow
= intern_c_string ("hollow");
26400 staticpro (&Qhollow
);
26401 Qhand
= intern_c_string ("hand");
26402 staticpro (&Qhand
);
26403 Qarrow
= intern_c_string ("arrow");
26404 staticpro (&Qarrow
);
26405 Qtext
= intern_c_string ("text");
26406 staticpro (&Qtext
);
26407 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26408 staticpro (&Qinhibit_free_realized_faces
);
26410 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26411 Fcons (intern_c_string ("void-variable"), Qnil
)),
26413 staticpro (&list_of_error
);
26415 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26416 staticpro (&Qlast_arrow_position
);
26417 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26418 staticpro (&Qlast_arrow_string
);
26420 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26421 staticpro (&Qoverlay_arrow_string
);
26422 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26423 staticpro (&Qoverlay_arrow_bitmap
);
26425 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26426 staticpro (&echo_buffer
[0]);
26427 staticpro (&echo_buffer
[1]);
26429 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26430 staticpro (&echo_area_buffer
[0]);
26431 staticpro (&echo_area_buffer
[1]);
26433 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26434 staticpro (&Vmessages_buffer_name
);
26436 mode_line_proptrans_alist
= Qnil
;
26437 staticpro (&mode_line_proptrans_alist
);
26438 mode_line_string_list
= Qnil
;
26439 staticpro (&mode_line_string_list
);
26440 mode_line_string_face
= Qnil
;
26441 staticpro (&mode_line_string_face
);
26442 mode_line_string_face_prop
= Qnil
;
26443 staticpro (&mode_line_string_face_prop
);
26444 Vmode_line_unwind_vector
= Qnil
;
26445 staticpro (&Vmode_line_unwind_vector
);
26447 help_echo_string
= Qnil
;
26448 staticpro (&help_echo_string
);
26449 help_echo_object
= Qnil
;
26450 staticpro (&help_echo_object
);
26451 help_echo_window
= Qnil
;
26452 staticpro (&help_echo_window
);
26453 previous_help_echo_string
= Qnil
;
26454 staticpro (&previous_help_echo_string
);
26455 help_echo_pos
= -1;
26457 Qright_to_left
= intern_c_string ("right-to-left");
26458 staticpro (&Qright_to_left
);
26459 Qleft_to_right
= intern_c_string ("left-to-right");
26460 staticpro (&Qleft_to_right
);
26462 #ifdef HAVE_WINDOW_SYSTEM
26463 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26464 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26465 For example, if a block cursor is over a tab, it will be drawn as
26466 wide as that tab on the display. */);
26467 x_stretch_cursor_p
= 0;
26470 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26471 doc
: /* *Non-nil means highlight trailing whitespace.
26472 The face used for trailing whitespace is `trailing-whitespace'. */);
26473 Vshow_trailing_whitespace
= Qnil
;
26475 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26476 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26477 A value of t means highlight the character itself (for nobreak space,
26478 use face `nobreak-space').
26479 A value of nil means no highlighting.
26480 Other values mean display the escape glyph followed by an ordinary
26481 space or ordinary hyphen. */);
26482 Vnobreak_char_display
= Qt
;
26484 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26485 doc
: /* *The pointer shape to show in void text areas.
26486 A value of nil means to show the text pointer. Other options are `arrow',
26487 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26488 Vvoid_text_area_pointer
= Qarrow
;
26490 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26491 doc
: /* Non-nil means don't actually do any redisplay.
26492 This is used for internal purposes. */);
26493 Vinhibit_redisplay
= Qnil
;
26495 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26496 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26497 Vglobal_mode_string
= Qnil
;
26499 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26500 doc
: /* Marker for where to display an arrow on top of the buffer text.
26501 This must be the beginning of a line in order to work.
26502 See also `overlay-arrow-string'. */);
26503 Voverlay_arrow_position
= Qnil
;
26505 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26506 doc
: /* String to display as an arrow in non-window frames.
26507 See also `overlay-arrow-position'. */);
26508 Voverlay_arrow_string
= make_pure_c_string ("=>");
26510 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26511 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26512 The symbols on this list are examined during redisplay to determine
26513 where to display overlay arrows. */);
26514 Voverlay_arrow_variable_list
26515 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26517 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26518 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26519 If that fails to bring point back on frame, point is centered instead.
26520 If this is zero, point is always centered after it moves off frame.
26521 If you want scrolling to always be a line at a time, you should set
26522 `scroll-conservatively' to a large value rather than set this to 1. */);
26524 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26525 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26526 If point moves off-screen, redisplay will scroll by up to
26527 `scroll-conservatively' lines in order to bring point just barely
26528 onto the screen again. If that cannot be done, then redisplay
26529 recenters point as usual.
26531 A value of zero means always recenter point if it moves off screen. */);
26532 scroll_conservatively
= 0;
26534 DEFVAR_INT ("scroll-margin", scroll_margin
,
26535 doc
: /* *Number of lines of margin at the top and bottom of a window.
26536 Recenter the window whenever point gets within this many lines
26537 of the top or bottom of the window. */);
26540 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26541 doc
: /* Pixels per inch value for non-window system displays.
26542 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26543 Vdisplay_pixels_per_inch
= make_float (72.0);
26546 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26549 DEFVAR_LISP ("truncate-partial-width-windows",
26550 Vtruncate_partial_width_windows
,
26551 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26552 For an integer value, truncate lines in each window narrower than the
26553 full frame width, provided the window width is less than that integer;
26554 otherwise, respect the value of `truncate-lines'.
26556 For any other non-nil value, truncate lines in all windows that do
26557 not span the full frame width.
26559 A value of nil means to respect the value of `truncate-lines'.
26561 If `word-wrap' is enabled, you might want to reduce this. */);
26562 Vtruncate_partial_width_windows
= make_number (50);
26564 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26565 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26566 Any other value means to use the appropriate face, `mode-line',
26567 `header-line', or `menu' respectively. */);
26568 mode_line_inverse_video
= 1;
26570 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26571 doc
: /* *Maximum buffer size for which line number should be displayed.
26572 If the buffer is bigger than this, the line number does not appear
26573 in the mode line. A value of nil means no limit. */);
26574 Vline_number_display_limit
= Qnil
;
26576 DEFVAR_INT ("line-number-display-limit-width",
26577 line_number_display_limit_width
,
26578 doc
: /* *Maximum line width (in characters) for line number display.
26579 If the average length of the lines near point is bigger than this, then the
26580 line number may be omitted from the mode line. */);
26581 line_number_display_limit_width
= 200;
26583 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26584 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26585 highlight_nonselected_windows
= 0;
26587 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26588 doc
: /* Non-nil if more than one frame is visible on this display.
26589 Minibuffer-only frames don't count, but iconified frames do.
26590 This variable is not guaranteed to be accurate except while processing
26591 `frame-title-format' and `icon-title-format'. */);
26593 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26594 doc
: /* Template for displaying the title bar of visible frames.
26595 \(Assuming the window manager supports this feature.)
26597 This variable has the same structure as `mode-line-format', except that
26598 the %c and %l constructs are ignored. It is used only on frames for
26599 which no explicit name has been set \(see `modify-frame-parameters'). */);
26601 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26602 doc
: /* Template for displaying the title bar of an iconified frame.
26603 \(Assuming the window manager supports this feature.)
26604 This variable has the same structure as `mode-line-format' (which see),
26605 and is used only on frames for which no explicit name has been set
26606 \(see `modify-frame-parameters'). */);
26608 = Vframe_title_format
26609 = pure_cons (intern_c_string ("multiple-frames"),
26610 pure_cons (make_pure_c_string ("%b"),
26611 pure_cons (pure_cons (empty_unibyte_string
,
26612 pure_cons (intern_c_string ("invocation-name"),
26613 pure_cons (make_pure_c_string ("@"),
26614 pure_cons (intern_c_string ("system-name"),
26618 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26619 doc
: /* Maximum number of lines to keep in the message log buffer.
26620 If nil, disable message logging. If t, log messages but don't truncate
26621 the buffer when it becomes large. */);
26622 Vmessage_log_max
= make_number (100);
26624 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26625 doc
: /* Functions called before redisplay, if window sizes have changed.
26626 The value should be a list of functions that take one argument.
26627 Just before redisplay, for each frame, if any of its windows have changed
26628 size since the last redisplay, or have been split or deleted,
26629 all the functions in the list are called, with the frame as argument. */);
26630 Vwindow_size_change_functions
= Qnil
;
26632 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26633 doc
: /* List of functions to call before redisplaying a window with scrolling.
26634 Each function is called with two arguments, the window and its new
26635 display-start position. Note that these functions are also called by
26636 `set-window-buffer'. Also note that the value of `window-end' is not
26637 valid when these functions are called. */);
26638 Vwindow_scroll_functions
= Qnil
;
26640 DEFVAR_LISP ("window-text-change-functions",
26641 Vwindow_text_change_functions
,
26642 doc
: /* Functions to call in redisplay when text in the window might change. */);
26643 Vwindow_text_change_functions
= Qnil
;
26645 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26646 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26647 Each function is called with two arguments, the window and the end trigger value.
26648 See `set-window-redisplay-end-trigger'. */);
26649 Vredisplay_end_trigger_functions
= Qnil
;
26651 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26652 doc
: /* *Non-nil means autoselect window with mouse pointer.
26653 If nil, do not autoselect windows.
26654 A positive number means delay autoselection by that many seconds: a
26655 window is autoselected only after the mouse has remained in that
26656 window for the duration of the delay.
26657 A negative number has a similar effect, but causes windows to be
26658 autoselected only after the mouse has stopped moving. \(Because of
26659 the way Emacs compares mouse events, you will occasionally wait twice
26660 that time before the window gets selected.\)
26661 Any other value means to autoselect window instantaneously when the
26662 mouse pointer enters it.
26664 Autoselection selects the minibuffer only if it is active, and never
26665 unselects the minibuffer if it is active.
26667 When customizing this variable make sure that the actual value of
26668 `focus-follows-mouse' matches the behavior of your window manager. */);
26669 Vmouse_autoselect_window
= Qnil
;
26671 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26672 doc
: /* *Non-nil means automatically resize tool-bars.
26673 This dynamically changes the tool-bar's height to the minimum height
26674 that is needed to make all tool-bar items visible.
26675 If value is `grow-only', the tool-bar's height is only increased
26676 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26677 Vauto_resize_tool_bars
= Qt
;
26679 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26680 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26681 auto_raise_tool_bar_buttons_p
= 1;
26683 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26684 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26685 make_cursor_line_fully_visible_p
= 1;
26687 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26688 doc
: /* *Border below tool-bar in pixels.
26689 If an integer, use it as the height of the border.
26690 If it is one of `internal-border-width' or `border-width', use the
26691 value of the corresponding frame parameter.
26692 Otherwise, no border is added below the tool-bar. */);
26693 Vtool_bar_border
= Qinternal_border_width
;
26695 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26696 doc
: /* *Margin around tool-bar buttons in pixels.
26697 If an integer, use that for both horizontal and vertical margins.
26698 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26699 HORZ specifying the horizontal margin, and VERT specifying the
26700 vertical margin. */);
26701 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26703 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26704 doc
: /* *Relief thickness of tool-bar buttons. */);
26705 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26707 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26708 doc
: /* Tool bar style to use.
26710 image - show images only
26711 text - show text only
26712 both - show both, text below image
26713 both-horiz - show text to the right of the image
26714 text-image-horiz - show text to the left of the image
26715 any other - use system default or image if no system default. */);
26716 Vtool_bar_style
= Qnil
;
26718 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26719 doc
: /* *Maximum number of characters a label can have to be shown.
26720 The tool bar style must also show labels for this to have any effect, see
26721 `tool-bar-style'. */);
26722 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26724 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26725 doc
: /* List of functions to call to fontify regions of text.
26726 Each function is called with one argument POS. Functions must
26727 fontify a region starting at POS in the current buffer, and give
26728 fontified regions the property `fontified'. */);
26729 Vfontification_functions
= Qnil
;
26730 Fmake_variable_buffer_local (Qfontification_functions
);
26732 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26733 unibyte_display_via_language_environment
,
26734 doc
: /* *Non-nil means display unibyte text according to language environment.
26735 Specifically, this means that raw bytes in the range 160-255 decimal
26736 are displayed by converting them to the equivalent multibyte characters
26737 according to the current language environment. As a result, they are
26738 displayed according to the current fontset.
26740 Note that this variable affects only how these bytes are displayed,
26741 but does not change the fact they are interpreted as raw bytes. */);
26742 unibyte_display_via_language_environment
= 0;
26744 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26745 doc
: /* *Maximum height for resizing mini-windows.
26746 If a float, it specifies a fraction of the mini-window frame's height.
26747 If an integer, it specifies a number of lines. */);
26748 Vmax_mini_window_height
= make_float (0.25);
26750 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26751 doc
: /* *How to resize mini-windows.
26752 A value of nil means don't automatically resize mini-windows.
26753 A value of t means resize them to fit the text displayed in them.
26754 A value of `grow-only', the default, means let mini-windows grow
26755 only, until their display becomes empty, at which point the windows
26756 go back to their normal size. */);
26757 Vresize_mini_windows
= Qgrow_only
;
26759 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26760 doc
: /* Alist specifying how to blink the cursor off.
26761 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26762 `cursor-type' frame-parameter or variable equals ON-STATE,
26763 comparing using `equal', Emacs uses OFF-STATE to specify
26764 how to blink it off. ON-STATE and OFF-STATE are values for
26765 the `cursor-type' frame parameter.
26767 If a frame's ON-STATE has no entry in this list,
26768 the frame's other specifications determine how to blink the cursor off. */);
26769 Vblink_cursor_alist
= Qnil
;
26771 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26772 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26773 If non-nil, windows are automatically scrolled horizontally to make
26774 point visible. */);
26775 automatic_hscrolling_p
= 1;
26776 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26777 staticpro (&Qauto_hscroll_mode
);
26779 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26780 doc
: /* *How many columns away from the window edge point is allowed to get
26781 before automatic hscrolling will horizontally scroll the window. */);
26782 hscroll_margin
= 5;
26784 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26785 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26786 When point is less than `hscroll-margin' columns from the window
26787 edge, automatic hscrolling will scroll the window by the amount of columns
26788 determined by this variable. If its value is a positive integer, scroll that
26789 many columns. If it's a positive floating-point number, it specifies the
26790 fraction of the window's width to scroll. If it's nil or zero, point will be
26791 centered horizontally after the scroll. Any other value, including negative
26792 numbers, are treated as if the value were zero.
26794 Automatic hscrolling always moves point outside the scroll margin, so if
26795 point was more than scroll step columns inside the margin, the window will
26796 scroll more than the value given by the scroll step.
26798 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26799 and `scroll-right' overrides this variable's effect. */);
26800 Vhscroll_step
= make_number (0);
26802 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26803 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26804 Bind this around calls to `message' to let it take effect. */);
26805 message_truncate_lines
= 0;
26807 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26808 doc
: /* Normal hook run to update the menu bar definitions.
26809 Redisplay runs this hook before it redisplays the menu bar.
26810 This is used to update submenus such as Buffers,
26811 whose contents depend on various data. */);
26812 Vmenu_bar_update_hook
= Qnil
;
26814 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26815 doc
: /* Frame for which we are updating a menu.
26816 The enable predicate for a menu binding should check this variable. */);
26817 Vmenu_updating_frame
= Qnil
;
26819 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26820 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26821 inhibit_menubar_update
= 0;
26823 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26824 doc
: /* Prefix prepended to all continuation lines at display time.
26825 The value may be a string, an image, or a stretch-glyph; it is
26826 interpreted in the same way as the value of a `display' text property.
26828 This variable is overridden by any `wrap-prefix' text or overlay
26831 To add a prefix to non-continuation lines, use `line-prefix'. */);
26832 Vwrap_prefix
= Qnil
;
26833 staticpro (&Qwrap_prefix
);
26834 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26835 Fmake_variable_buffer_local (Qwrap_prefix
);
26837 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26838 doc
: /* Prefix prepended to all non-continuation lines at display time.
26839 The value may be a string, an image, or a stretch-glyph; it is
26840 interpreted in the same way as the value of a `display' text property.
26842 This variable is overridden by any `line-prefix' text or overlay
26845 To add a prefix to continuation lines, use `wrap-prefix'. */);
26846 Vline_prefix
= Qnil
;
26847 staticpro (&Qline_prefix
);
26848 Qline_prefix
= intern_c_string ("line-prefix");
26849 Fmake_variable_buffer_local (Qline_prefix
);
26851 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26852 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26853 inhibit_eval_during_redisplay
= 0;
26855 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26856 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26857 inhibit_free_realized_faces
= 0;
26860 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26861 doc
: /* Inhibit try_window_id display optimization. */);
26862 inhibit_try_window_id
= 0;
26864 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26865 doc
: /* Inhibit try_window_reusing display optimization. */);
26866 inhibit_try_window_reusing
= 0;
26868 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26869 doc
: /* Inhibit try_cursor_movement display optimization. */);
26870 inhibit_try_cursor_movement
= 0;
26871 #endif /* GLYPH_DEBUG */
26873 DEFVAR_INT ("overline-margin", overline_margin
,
26874 doc
: /* *Space between overline and text, in pixels.
26875 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26876 margin to the caracter height. */);
26877 overline_margin
= 2;
26879 DEFVAR_INT ("underline-minimum-offset",
26880 underline_minimum_offset
,
26881 doc
: /* Minimum distance between baseline and underline.
26882 This can improve legibility of underlined text at small font sizes,
26883 particularly when using variable `x-use-underline-position-properties'
26884 with fonts that specify an UNDERLINE_POSITION relatively close to the
26885 baseline. The default value is 1. */);
26886 underline_minimum_offset
= 1;
26888 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26889 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26890 This feature only works when on a window system that can change
26891 cursor shapes. */);
26892 display_hourglass_p
= 1;
26894 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26895 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26896 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26898 hourglass_atimer
= NULL
;
26899 hourglass_shown_p
= 0;
26901 DEFSYM (Qglyphless_char
, "glyphless-char");
26902 DEFSYM (Qhex_code
, "hex-code");
26903 DEFSYM (Qempty_box
, "empty-box");
26904 DEFSYM (Qthin_space
, "thin-space");
26905 DEFSYM (Qzero_width
, "zero-width");
26907 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26908 /* Intern this now in case it isn't already done.
26909 Setting this variable twice is harmless.
26910 But don't staticpro it here--that is done in alloc.c. */
26911 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26912 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26914 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26915 doc
: /* Char-table to control displaying of glyphless characters.
26916 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26917 or one of these symbols:
26918 hex-code: display the hexadecimal code of a character in a box
26919 empty-box: display as an empty box
26920 thin-space: display as 1-pixel width space
26921 zero-width: don't display
26923 It has one extra slot to control the display of a character for which
26924 no font is found. The value of the slot is `hex-code' or `empty-box'.
26925 The default is `empty-box'. */);
26926 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26927 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26932 /* Initialize this module when Emacs starts. */
26937 Lisp_Object root_window
;
26938 struct window
*mini_w
;
26940 current_header_line_height
= current_mode_line_height
= -1;
26942 CHARPOS (this_line_start_pos
) = 0;
26944 mini_w
= XWINDOW (minibuf_window
);
26945 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26947 if (!noninteractive
)
26949 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26952 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26953 set_window_height (root_window
,
26954 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26956 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26957 set_window_height (minibuf_window
, 1, 0);
26959 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26960 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26962 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26963 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26964 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26966 /* The default ellipsis glyphs `...'. */
26967 for (i
= 0; i
< 3; ++i
)
26968 default_invis_vector
[i
] = make_number ('.');
26972 /* Allocate the buffer for frame titles.
26973 Also used for `format-mode-line'. */
26975 mode_line_noprop_buf
= (char *) xmalloc (size
);
26976 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26977 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26978 mode_line_target
= MODE_LINE_DISPLAY
;
26981 help_echo_showing_p
= 0;
26984 /* Since w32 does not support atimers, it defines its own implementation of
26985 the following three functions in w32fns.c. */
26988 /* Platform-independent portion of hourglass implementation. */
26990 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26992 hourglass_started (void)
26994 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26997 /* Cancel a currently active hourglass timer, and start a new one. */
26999 start_hourglass (void)
27001 #if defined (HAVE_WINDOW_SYSTEM)
27003 int secs
, usecs
= 0;
27005 cancel_hourglass ();
27007 if (INTEGERP (Vhourglass_delay
)
27008 && XINT (Vhourglass_delay
) > 0)
27009 secs
= XFASTINT (Vhourglass_delay
);
27010 else if (FLOATP (Vhourglass_delay
)
27011 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27014 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27015 secs
= XFASTINT (tem
);
27016 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27019 secs
= DEFAULT_HOURGLASS_DELAY
;
27021 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27022 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27023 show_hourglass
, NULL
);
27028 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27031 cancel_hourglass (void)
27033 #if defined (HAVE_WINDOW_SYSTEM)
27034 if (hourglass_atimer
)
27036 cancel_atimer (hourglass_atimer
);
27037 hourglass_atimer
= NULL
;
27040 if (hourglass_shown_p
)
27044 #endif /* ! WINDOWSNT */